ruby-trello-czuger 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90cf20663bfabaa746c5dd9bf073d1a4e43cf108
+  data.tar.gz: d77c1e852013936738f64840fd46ad4f5cd5efc4
+SHA512:
+  metadata.gz: 204f92e6c4540e905c94c4842b0142441c33ca62d0629aa16defdf21f9f150db7ed1e2010ea6816ee94847ab34e5044cbecf664afccc8f2c1a160ea85ee62a18
+  data.tar.gz: 165ce19bc465b5c6b844665f93838c4716e846e1e83e48dacb9c34de4ad7fb99d4f7130e79e9975830c7156ce587dd23e3282d498ec1c5615b59476f089fd56a

data/README.md

@@ -0,0 +1,182 @@
+# Ruby Trello API
+
+[![Stories in Ready](http://badge.waffle.io/jeremytregunna/ruby-trello.png)](http://waffle.io/jeremytregunna/ruby-trello)
+[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.png)](http://travis-ci.org/jeremytregunna/ruby-trello) [![Dependency Status](https://gemnasium.com/jeremytregunna/ruby-trello.png)](https://gemnasium.com/jeremytregunna/ruby-trello)
+[![Code Climate](https://codeclimate.com/github/jeremytregunna/ruby-trello/badges/gpa.svg)](https://codeclimate.com/github/jeremytregunna/ruby-trello)
+
+This library implements the [Trello](http://www.trello.com/) [API](https://developers.trello.com/).
+
+Trello is an awesome tool for organization. Not just aimed at developers, but everybody.
+Seriously, [check it out](http://www.trello.com/).
+
+[Full API documentation](http://www.rubydoc.info/gems/ruby-trello).
+
+## Installation
+
+```
+# gem install ruby-trello
+```
+
+Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it
+to, please [let us know](https://trello.com/card/spot-a-bug-report-it/4f092b2ee23cb6fe6d1aaabd/17).
+
+Supports Ruby 2.1.0 or newer.
+
+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.
+
+## Configuration
+
+#### Basic authorization:
+
+1. Get your API public key from Trello via the irb console:
+
+```
+$ 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
+```
+
+2. You can now use the public key and member token in your app code:
+
+```ruby
+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
+
+```ruby
+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
+
+```ruby
+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:
+
+```ruby
+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.
+
+```ruby
+# 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
+```ruby
+# 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`:
+
+```ruby
+@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:
+
+```ruby
+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](https://github.com/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.

data/lib/trello.rb

@@ -0,0 +1,163 @@
+require 'oauth'
+require 'json'
+require 'logger'
+require 'active_model'
+require 'addressable/uri'
+
+# Ruby wrapper around the Trello[http://trello.com] API
+#
+# First, set up your key information. You can get this information by {clicking here}[https://trello.com/1/appKey/generate].
+#
+# You can get the key by going to this url in your browser:
+# https://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}[https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd]. It's completely open to the public.
+module Trello
+  autoload :Action,            'trello/action'
+  autoload :Comment,           'trello/comment'
+  autoload :Association,       'trello/association'
+  autoload :AssociationProxy,  'trello/association_proxy'
+  autoload :Attachment,        'trello/attachment'
+  autoload :CoverImage,        'trello/cover_image'
+  autoload :BasicData,         'trello/basic_data'
+  autoload :Board,             'trello/board'
+  autoload :Card,              'trello/card'
+  autoload :Checklist,         'trello/checklist'
+  autoload :Client,            'trello/client'
+  autoload :Configuration,     'trello/configuration'
+  autoload :HasActions,        'trello/has_actions'
+  autoload :Item,              'trello/item'
+  autoload :CheckItemState,    'trello/item_state'
+  autoload :Label,             'trello/label'
+  autoload :LabelName,         'trello/label_name'
+  autoload :List,              'trello/list'
+  autoload :Member,            'trello/member'
+  autoload :MultiAssociation,  'trello/multi_association'
+  autoload :Notification,      'trello/notification'
+  autoload :Organization,      'trello/organization'
+  autoload :PluginDatum,       'trello/plugin_datum'
+  autoload :Request,           'trello/net'
+  autoload :TInternet,         'trello/net'
+  autoload :Token,             'trello/token'
+  autoload :Webhook,           'trello/webhook'
+  autoload :JsonUtils,         'trello/json_utils'
+
+  module Authorization
+    autoload :AuthPolicy,      'trello/authorization'
+    autoload :BasicAuthPolicy, 'trello/authorization'
+    autoload :OAuthPolicy,     'trello/authorization'
+  end
+
+  # Version of the Trello API that we use by default.
+  API_VERSION = 1
+
+  # Raise this when we hit a Trello error.
+  Error = Class.new(StandardError)
+
+  # This specific error is thrown when your access token is invalid. You should get a new one.
+  InvalidAccessToken = Class.new(Error)
+
+  # This error is thrown when your client has not been configured
+  ConfigurationError = Class.new(Error)
+
+  def self.logger
+    @logger ||= Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.configure(&block)
+    reset!
+    client.configure(&block)
+  end
+
+  def self.reset!
+    @client = nil
+  end
+
+  def self.auth_policy; client.auth_policy; end
+  def self.configuration; client.configuration; end
+
+  # Url to Trello API public key page
+  def self.public_key_url
+    'https://trello.com/app-key'
+  end
+
+  # Url to token for making authorized requests to the Trello API
+  #
+  # @param [String, #read] contents the contents to reverse
+  # @param options [Hash] Repository information to update
+  # @option options [String] :name Name of the application
+  # @option options [String] :key Application key
+  # @option options [String] :response_type 'token'
+  # @option options [String] :callback_method 'postMessage' or 'fragment'
+  # @option options [String] :return_url URL the token should be returned to
+  # @option options [String] :scope Comma-separated list of one or more of 'read', 'write', 'account'
+  # @option options [String] :expiration '1hour', '1day', '30days', 'never'
+  # @see https://developers.trello.com/authorize
+  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
+
+  # Visit the Trello API public key page
+  #
+  # @see https://trello.com/app-key
+  def self.open_public_key_url
+    open_url public_key_url
+  end
+
+  # Visit the Trello authorized token page
+  #
+  # @see https://developers.trello.com/authorize
+  def self.open_authorization_url(options = {})
+    open_url authorize_url(options)
+  end
+
+  # @private
+  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
+end

data/lib/trello/action.rb

@@ -0,0 +1,68 @@
+module Trello
+  # Action represents some event that occurred. For instance, when a card is created.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] type
+  #   @return [String]
+  # @!attribute [r] data
+  #   @return [Hash]
+  # @!attribute [r] date
+  #   @return [Datetime]
+  # @!attribute [r] member_creator_id
+  #   @return [String]
+  # @!attribute [r] member_participant
+  #   @return [Object]
+  class Action < BasicData
+    register_attributes :id, :type, :data, :date, :member_creator_id, :member_participant,
+      readonly: [ :id, :type, :data, :date, :member_creator_id, :member_participant ]
+    validates_presence_of :id, :type, :date, :member_creator_id
+
+    class << self
+      # Locate a specific action and return a new Action object.
+      def find(id, params = {})
+        client.find(:action, id, params)
+      end
+
+      def search(query, opts = {})
+        response = client.get("/search/", { query: query }.merge(opts))
+        parse_json(response).except("options").each_with_object({}) do |(key, data), result|
+          klass = "Trello::#{key.singularize.capitalize}".constantize
+          result[key] = klass.from_json(data)
+        end
+      end
+    end
+
+    # Update the attributes of an action
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an Action.
+    def update_fields(fields)
+      attributes[:id]                 = fields['id'] || attributes[:id]
+      attributes[:type]               = fields['type'] || attributes[:type]
+      attributes[:data]               = fields['data'] || attributes[:data]
+      attributes[:date]               = Time.iso8601(fields['date']) rescue nil if fields.has_key?('date')
+      attributes[:member_creator_id]  = fields['idMemberCreator'] || attributes[:member_creator_id]
+      attributes[:member_participant] = fields['member'] || attributes[:member_participant]
+      self
+    end
+
+    # Returns the board this action occurred on.
+    def board
+      Board.from_response client.get("/actions/#{id}/board")
+    end
+
+    # Returns the card the action occurred on.
+    def card
+      Card.from_response client.get("/actions/#{id}/card")
+    end
+
+    # Returns the list the action occurred on.
+    def list
+      List.from_response client.get("/actions/#{id}/list")
+    end
+
+    # Returns the member who created the action.
+    one :member_creator, via: Member, path: :members, using: :member_creator_id
+  end
+end

data/lib/trello/association.rb

@@ -0,0 +1,14 @@
+module Trello
+  class Association
+    attr_reader :owner, :target, :options, :proxy
+
+    def initialize(owner, target)
+      @owner  = owner
+      @target = target
+      @options = {}
+      if target.is_a?(Array)
+        target.each { |array_element| array_element.client = owner.client }
+      end
+    end
+  end
+end

data/lib/trello/association_proxy.rb

@@ -0,0 +1,42 @@
+require 'active_support/core_ext'
+
+module Trello
+  class AssociationProxy
+    extend Forwardable
+    alias :proxy_extend :extend
+
+    instance_methods.each { |m| undef_method m unless m.to_s =~ /^(?:nil\?|send|object_id|to_a)$|^__|^respond_to|proxy_/ }
+
+    def_delegators :@association, :owner, :target, :count
+
+    def initialize(association)
+      @association = association
+      Array(association.options[:extend]).each { |ext| proxy_extend(ext) }
+    end
+
+    def proxy_assocation
+      @association
+    end
+
+    def method_missing(method, *args, &block)
+      if target.respond_to? method
+        target.send(method, *args, &block)
+      else
+        super
+      end
+    end
+
+    def ===(other)
+      other === target
+    end
+
+    def to_ary
+      proxy_assocation.dup
+    end
+    alias_method :to_a, :to_ary
+
+    def <<(*records)
+      proxy_assocation.concat(records) && self
+    end
+  end
+end