Module: Trello

Defined in:
lib/trello.rb,
lib/trello/net.rb,
lib/trello/card.rb,
lib/trello/item.rb,
lib/trello/list.rb,
lib/trello/board.rb,
lib/trello/error.rb,
lib/trello/label.rb,
lib/trello/token.rb,
lib/trello/action.rb,
lib/trello/client.rb,
lib/trello/member.rb,
lib/trello/comment.rb,
lib/trello/webhook.rb,
lib/trello/checklist.rb,
lib/trello/attachment.rb,
lib/trello/basic_data.rb,
lib/trello/item_state.rb,
lib/trello/json_utils.rb,
lib/trello/label_name.rb,
lib/trello/association.rb,
lib/trello/cover_image.rb,
lib/trello/has_actions.rb,
lib/trello/custom_field.rb,
lib/trello/notification.rb,
lib/trello/organization.rb,
lib/trello/plugin_datum.rb,
lib/trello/authorization.rb,
lib/trello/configuration.rb,
lib/trello/association_proxy.rb,
lib/trello/custom_field_item.rb,
lib/trello/multi_association.rb,
lib/trello/custom_field_option.rb,
lib/trello/register_attributes.rb,
lib/trello/association_infer_tool.rb,
lib/trello/association_builder/has_one.rb,
lib/trello/association_fetcher/has_one.rb,
lib/trello/association_builder/has_many.rb,
lib/trello/association_fetcher/has_many.rb,
lib/trello/association_fetcher/has_one/fetch.rb,
lib/trello/association_fetcher/has_many/fetch.rb,
lib/trello/association_fetcher/has_one/params.rb,
lib/trello/association_fetcher/has_many/params.rb

Overview

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.

Defined Under Namespace

Modules: AssociationBuilder, AssociationFetcher, Authorization, HasActions, JsonUtils Classes: Action, Association, AssociationInferTool, AssociationProxy, Attachment, BasicData, Board, Card, CheckItemState, Checklist, Client, Comment, Configuration, CoverImage, CustomField, CustomFieldItem, CustomFieldOption, Error, Item, Label, LabelName, List, Member, MultiAssociation, Notification, Organization, PluginDatum, RegisterAttributes, Request, Response, TInternet, Token, Webhook

Constant Summary collapse

API_VERSION =

Version of the Trello API that we use by default.

1
InvalidAccessToken =

This specific error is thrown when your access token is invalid. You should get a new one.

Class.new(Error)
ConfigurationError =

This error is thrown when your client has not been configured

Class.new(Error)

Class Method Summary collapse

Class Method Details

.auth_policy ⇒ Object 



121
 
# File 'lib/trello.rb', line 121

def self.auth_policy; client.auth_policy; end

.authorize_url(options = {}) ⇒ Object

Url to token for making authorized requests to the Trello API

Parameters:

  • contents (String, #read) —

    the contents to reverse

  • options (Hash) (defaults to: {}) —

    Repository information to update

Options Hash (options):

  • :name (String) —

    Name of the application

  • :key (String) —

    Application key

  • :response_type (String) —

    ‘token’

  • :callback_method (String) —

    ‘postMessage’ or ‘fragment’

  • :return_url (String) —

    URL the token should be returned to

  • :scope (String) —

    Comma-separated list of one or more of ‘read’, ‘write’, ‘account’

  • :expiration (String) —

    ‘1hour’, ‘1day’, ‘30days’, ‘never’

See Also:



141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/trello.rb', line 141

def self.authorize_url(options = {})
  params = options.dup
  params[:key] ||= configuration.developer_public_key or
    raise ArgumentError, 'Please configure your Trello public key'
  params[:name] ||= 'Ruby Trello'
  params[:scope] ||= 'read,write,account'
  params[:expiration] ||= 'never'
  params[:response_type] ||= 'token'
  uri = Addressable::URI.parse 'https://trello.com/1/authorize'
  uri.query_values = params
  uri
end

.client ⇒ Object 



108
109
110
 
# File 'lib/trello.rb', line 108

def self.client
  @client ||= Client.new
end

.configuration ⇒ Object 



122
 
# File 'lib/trello.rb', line 122

def self.configuration; client.configuration; end

.configure(&block) ⇒ Object 



112
113
114
115
 
# File 'lib/trello.rb', line 112

def self.configure(&block)
  reset!
  client.configure(&block)
end

.logger ⇒ Object 



100
101
102
 
# File 'lib/trello.rb', line 100

def self.logger
  @logger ||= Logger.new(STDOUT)
end

.logger=(logger) ⇒ Object 



104
105
106
 
# File 'lib/trello.rb', line 104

def self.logger=(logger)
  @logger = logger
end

.open_authorization_url(options = {}) ⇒ Object

Visit the Trello authorized token page

See Also:



164
165
166
 
# File 'lib/trello.rb', line 164

def self.open_authorization_url(options = {})
  open_url authorize_url(options)
end

.open_public_key_url ⇒ Object

Visit the Trello API public key page

See Also:



157
158
159
 
# File 'lib/trello.rb', line 157

def self.open_public_key_url
  open_url public_key_url
end

.open_url(url) ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/trello.rb', line 169

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

.public_key_url ⇒ Object

Url to Trello API public key page



125
126
127
 
# File 'lib/trello.rb', line 125

def self.public_key_url
  'https://trello.com/app-key'
end

.reset! ⇒ Object 



117
118
119
 
# File 'lib/trello.rb', line 117

def self.reset!
  @client = nil
end