module Trello
Ruby wrapper around the [Trello] API
First, set up your key information. You can get this information by [clicking here].
You can get the key by going to this url in your browser: trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never Only request the permissions you need; i.e., scope=read if you only need read, or scope=write if you only need write. Comma separate scopes you need. If you want your token to expire after 30 days, drop the &expiration=never. Then run the following code, where KEY denotes the key returned from the url above:
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
All the calls this library make to Trello
require authentication using these keys. Be sure to protect them.
So lets say you want to get information about the user bobtester. We can do something like this:
bob = 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 so much more. Consult the rest of the documentation for more information.
Feel free to [peruse and participate in our Trello
board]. It's completely open to the public.
[trello]: trello.com [trello-app-key]: trello.com/app-key [ruby-trello-board]: trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd
Constants
- API_VERSION
Version of the
Trello
API that we use by default.- ConfigurationError
This error is thrown when your client has not been configured
- InvalidAccessToken
This specific error is thrown when your access token is invalid. You should get a new one.
- Request
- Response
Public Class Methods
# File lib/trello.rb, line 128 def self.auth_policy; client.auth_policy; end
# File lib/trello.rb, line 115 def self.client @client ||= Client.new end
# File lib/trello.rb, line 129 def self.configuration; client.configuration; end
# File lib/trello.rb, line 119 def self.configure(&block) reset! client.configure(&block) end
# File lib/trello.rb, line 107 def self.logger @logger ||= Logger.new(STDOUT) end
# File lib/trello.rb, line 111 def self.logger=(logger) @logger = logger end
Visit the Trello
API public key page
@see trello.com/app-key
# File lib/trello.rb, line 163 def self.open_public_key_url open_url public_key_url end
@private
# File lib/trello.rb, line 175 def self.open_url(url) require 'launchy' Launchy.open(url.to_s) rescue LoadError warn 'Please install the launchy gem to open the url automatically.' url end
Url to Trello
API public key page
# File lib/trello.rb, line 132 def self.public_key_url 'https://trello.com/app-key' end
# File lib/trello.rb, line 124 def self.reset! @client = nil end