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.
| Ruby \ ActiveModel | 6.0 | 6.1 | 7.0 | 7.1 |
|---|---|---|---|---|
| 2.7 | ✅ | ✅ | ✅ | ✅ |
| 3.0 | ✅ | ✅ | ✅ | ✅ |
| 3.1 | ✅ | ✅ | ✅ | ✅ |
| 3.2 | ✅ | ✅ | ✅ | ✅ |
- Use the newest version for Ruby 2.7.0 or newer support.
- Use version 3.2.0 or earlier for Ruby 2.5 ~ 2.6 support.
- 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.
gem install ruby-trello
- 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.
endTrello.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
endTrello.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) }
endAll the calls this library makes to Trello require authentication using these keys. Be sure to protect them.
ruby-trello requires either rest-client or faraday to be present for network calls. You can configure ruby-trello to use either one, depending on your project's needs. If both are present, ruby-trello defaults to using faraday.
Trello.configure do |config|
config.http_client = 'faraday'
# OR
config.http_client = 'rest-client'
endSo 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.listsThere 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 ...# 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 falseApplications 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")
endA 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.
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.
Use matrixeval-ruby to test code againsts different ruby and active_model versions on local.
Check available commands with:
matrixeval --help
# Or
meval --helpGenerate MatrixEval config file
matrixeval initRun bundle install
matrixeval --all bundle installRun tests
matrixeval --all rspec
matrixeval --ruby 3.0 rspec spec/a_spec.rb
matrixeval --ruby 3.0 --active_model 7.0 rspecBash
matrixeval bash
matrixeval --ruby 3.0 --active_model 7.0 bash
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
