Ruby Trello
API¶ ↑
This library implements the Trello API.
Trello
is an awesome tool for organization. Not just aimed at developers, but everybody. Seriously, check it out.
Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it to, please just create an issue.
Requirements¶ ↑
Use the newest version for Ruby 2.5.0 or newer support. (Ruby 3 only works with ActiveModel 6 for now.)
Use version 2.2.1 or earlier for Ruby 2.1 ~ 2.4 support.
Use version 1.3.0 or earlier for Ruby 1.9.3 support.
Use version 1.4.x or earlier for Ruby 2.0.0 support.
Installation¶ ↑
# gem install ruby-trello
Configuration¶ ↑
Basic authorization:¶ ↑
-
Get your API public key from
Trello
via trello.com/app-key/ or the irb console as follows:
$ gem install ruby-trello $ irb -rubygems irb> require 'trello' irb> Trello.open_public_key_url # copy your public key irb> Trello.open_authorization_url key: 'yourpublickey' # copy your member token
-
You can now use the public key and member token in your app code:
require 'trello' Trello.configure do |config| config.developer_public_key = TRELLO_DEVELOPER_PUBLIC_KEY # The "key" from step 1 config.member_token = TRELLO_MEMBER_TOKEN # The token from step 2. end
2-legged OAuth authorization¶ ↑
Trello.configure do |config| config.consumer_key = TRELLO_CONSUMER_KEY config.consumer_secret = TRELLO_CONSUMER_SECRET config.oauth_token = TRELLO_OAUTH_TOKEN config.oauth_token_secret = TRELLO_OAUTH_TOKEN_SECRET end
3-legged OAuth authorization¶ ↑
Trello.configure do |config| config.consumer_key = TRELLO_CONSUMER_KEY config.consumer_secret = TRELLO_CONSUMER_SECRET config.return_url = "http://your.site.com/path/to/receive/post" config.callback = lambda { |request_token| DB.save(request_token.key, request_token.secret) } end
All the calls this library makes to Trello
require authentication using these keys. Be sure to protect them.
Usage¶ ↑
So let's say you want to get information about the user bobtester. We can do something like this:
bob = Trello::Member.find("bobtester") # Print out his name puts bob.full_name # "Bob Tester" # Print his bio puts bob.bio # A wonderfully delightful test user # How about a list of his boards? bob.boards # And then to read the lists of the first board do : bob.boards.first.lists
Accessing specific items¶ ↑
There is no find by name method in the trello API, to access a specific item, you have to know it's ID. The best way is to pretty print the elements and then find the id of the element you are looking for.
# With bob pp bob.boards # Will pretty print all boards, allowing us to find our board id # We can now access it's lists pp Trello::Board.find( board_id ).lists # will pretty print all lists. Let's get the list id # We can now access the cards of the list pp Trello::List.find( list_id ).cards # We can now access the checklists of the card pp Trello::Card.find( card_id ).checklists # and so on ...
Changing a checkbox state¶ ↑
# First get your checklist id checklist = Trello::Checklist.find( checklist_id ) # At this point, there is no more ids. To get your checklist item, # you have to know it's position (same as in the trello interface). # Let's take the first checklist_item = checklist.items.first # Then we can read the status checklist_item.state # return 'complete' or 'incomplete' # We can update it (note we call update_item_state from checklist, not from checklist_item) checklist.update_item_state( checklist_item.id, 'complete' ) # or 'incomplete' # You can also use true or false instead of 'complete' or 'incomplete' checklist.update_item_state( checklist_item.id, true ) # or false
Multiple Users¶ ↑
Applications that make requests on behalf of multiple Trello
users have an alternative to global configuration. For each user's access token/secret pair, instantiate a Trello::Client
:
@client_bob = Trello::Client.new( :consumer_key => YOUR_CONSUMER_KEY, :consumer_secret => YOUR_CONSUMER_SECRET, :oauth_token => "Bob's access token", :oauth_token_secret => "Bob's access secret" ) @client_alice = Trello::Client.new( :consumer_key => YOUR_CONSUMER_KEY, :consumer_secret => YOUR_CONSUMER_SECRET, :oauth_token => "Alice's access token", :oauth_token_secret => "Alice's access secret" )
You can now make threadsafe requests as the authenticated user:
Thread.new do @client_bob.find(:members, "bobtester") @client_bob.find(:boards, "bobs_board_id") end Thread.new do @client_alice.find(:members, "alicetester") @client_alice.find(:boards, "alices_board_id") end
Special thanks¶ ↑
A special thanks goes out to Ben Biddington who has contributed a significant amount of refactoring and functionality to be deserving of a beer and this special thanks.
Contributing¶ ↑
Several ways you can contribute. Documentation, code, tests, feature requests, bug reports.
If you submit a pull request that's accepted, you'll be given commit access to this repository.
Please see the CONTRIBUTING.md
file for more information.
Local Development¶ ↑
Init all Gemfile.lock.* files
make init
Bundle install for all Ruby versions
make bundle:all
Run tests for all Ruby versions
make test:all
Run tests for each Ruby versions individual
make test:ruby_2_5 make test:ruby_2_6 make test:ruby_2_7 make test:ruby_3_0 make test:jruby_9_2
Do development for each Ruby versions individual
make dev:ruby_2_5 make dev:ruby_2_6 make dev:ruby_2_7 make dev:ruby_3_0 make dev:jruby_9_2
Recreate all Gemfile.lock.*
make gemfile:refresh