ruby-trello 0.2.1 → 0.3.0

data/README.md

@@ -15,6 +15,11 @@ Seriously, [check it out](http://www.trello.com/).
 
 Full Disclosure: This library is not complete, but it does function enough to be useful.
 
+## 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
 
 Pick up an editor, fix a test! (If you want to, of course.) Send a pull
@@ -24,4 +29,4 @@ request, and I'll look at it. I only ask a few things:
 2. Adding or refactoring existing features, ensure there are tests.
 
 Also, don't be afraid to send a pull request if your changes aren't done. Just
-let me know.
+let me know.

data/lib/trello.rb

@@ -1,5 +1,6 @@
 require 'oauth'
 require 'json'
+require 'logger'
 
 # Ruby wrapper around the Trello[http://trello.com] API
 #
@@ -28,6 +29,7 @@ module Trello
   autoload :BasicData,    'trello/basic_data'
   autoload :Board,        'trello/board'
   autoload :Card,         'trello/card'
+  autoload :Checklist,    'trello/checklist'
   autoload :Client,       'trello/client'
   autoload :Item,         'trello/item'
   autoload :ItemState,    'trello/item_state'
@@ -35,10 +37,28 @@ module Trello
   autoload :Member,       'trello/member'
   autoload :Notification, 'trello/notification'
   autoload :Organization, 'trello/organization'
+  autoload :Request,      'trello/net'
+  autoload :TInternet,    'trello/net'
 
   # Version of the Trello API that we use by default.
   API_VERSION = 1
 
-  # Raise this when we can't find a record.
-  class RecordNotFound < StandardError; end
-end
+  # Raise this when we hit a Trello error.
+  class Error < StandardError; end
+
+  def self.logger
+    @@logger || Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @@logger = logger
+  end
+end
+
+module Trello
+  module Authorization
+    autoload :AuthPolicy,      'trello/authorization'
+    autoload :BasicAuthPolicy, 'trello/authorization'
+    autoload :OAuthPolicy,     'trello/authorization'
+  end
+end

data/lib/trello/action.rb

@@ -19,6 +19,7 @@ module Trello
       @type              = fields['type']
       @data              = fields['data']
       @member_creator_id = fields['idMemberCreator']
+      self
     end
 
     # Returns the board this action occurred on.

data/lib/trello/authorization.rb

@@ -0,0 +1,77 @@
+require 'securerandom'
+
+module Trello
+  module Authorization
+
+    AuthPolicy = Class.new
+
+    class BasicAuthPolicy
+      class << self
+        attr_accessor :developer_public_key, :member_token
+
+        def authorize(request)
+          the_uri = Addressable::URI.parse(request.uri)
+          existing_values = the_uri.query_values.nil? ? {} : the_uri.query_values
+          new_values = { :key => @developer_public_key, :token => @member_token }
+          the_uri.query_values = new_values.merge existing_values
+
+          Request.new request.verb, the_uri, request.headers
+        end
+      end
+    end
+
+    class Clock
+      def self.timestamp; Time.now.to_i; end
+    end
+
+    class Nonce
+      def self.next
+        SecureRandom.hex()
+      end
+    end
+
+    OAuthCredential = Struct.new "OAuthCredential", :key, :secret
+
+    class OAuthPolicy
+      class << self
+        attr_accessor :consumer_credential, :token
+
+        def authorize(request)
+          fail "The consumer_credential has not been supplied." unless consumer_credential
+
+          request.headers = {"Authorization" => get_auth_header(request.uri, :get)}
+          request
+        end
+
+        private
+
+        def get_auth_header(url, verb)
+          require "oauth"
+
+          self.token ||= OAuthCredential.new 
+
+          consumer = OAuth::Consumer.new(
+            consumer_credential.key,
+            consumer_credential.secret,
+            {
+              :scheme      => :header,
+              :scope       => 'read,write,account',
+              :http_method => verb
+            }
+          )
+
+          request = Net::HTTP::Get.new Addressable::URI.parse(url).to_s
+
+          consumer.options[:signature_method] = 'HMAC-SHA1'
+          consumer.options[:nonce]            = Nonce.next
+          consumer.options[:timestamp] 	      = Clock.timestamp
+          consumer.options[:uri]              = url
+          
+          consumer.sign!(request, OAuth::Token.new(token.key, token.secret))
+
+          request['authorization']
+        end
+      end
+    end
+  end
+end

data/lib/trello/basic_data.rb

@@ -5,7 +5,6 @@ module Trello
     attr_reader :id
 
     class << self
-      # Perform a query to retrieve some information at a specific path for a specific id.
       def find(path, id)
         Client.get("/#{path}/#{id}").json_into(self)
       end
@@ -29,4 +28,4 @@ module Trello
       id == other.id
     end
   end
-end
+end

data/lib/trello/board.rb

@@ -1,31 +1,44 @@
 module Trello
-  # A board is a container which holds lists. This is where everything lives.
+
   class Board < BasicData
-    attr_reader :id, :name, :description, :closed, :url, :organization_id
+    attr_reader :id, :name, :description, :url, :organization_id
 
     class << self
-      # Locate a board given a specific id.
+
       def find(id)
         super(:boards, id)
       end
+
+      def create(attributes)
+        Client.post("/boards/", attributes).json_into Board
+      end
+    end
+
+    def save!
+      fail "Cannot save new instance." unless self.id
+
+      Client.put("/boards/#{self.id}/", {
+        :name            => @name,
+        :description     => @description,
+        :closed          => @closed,
+        :url             => @url,
+        :organisation_id => @organisation_id
+      }).json_into(self)
     end
 
-    # Update the fields of a board.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # a board.
     def update_fields(fields)
-      @id              = fields['id']
-      @name            = fields['name']
-      @description     = fields['desc']
-      @closed          = fields['closed']
-      @url             = fields['url']
-      @organization_id = fields['idOrganization']
+      @id              = fields['id']              if fields['id']
+      @name            = fields['name']            if fields['name']
+      @description     = fields['desc']            if fields['desc']
+      @closed          = fields['closed']          if fields.has_key?('closed')
+      @url             = fields['url']             if fields['url']
+      @organization_id = fields['idOrganization']  if fields['idOrganization']
+
+      self
     end
 
-    # Check if the board is active.
     def closed?
-      closed
+      @closed
     end
 
     # Return a timeline of actions related to this board.
@@ -44,6 +57,10 @@ module Trello
       @cards = Client.get("/boards/#{id}/cards").json_into(Card)
     end
 
+    def has_lists?
+      lists.size > 0
+    end
+
     # Returns all the lists on this board.
     #
     # The options hash may have a filter key which can have its value set as any
@@ -61,7 +78,7 @@ module Trello
     #    :filter => [ :none, :normal, :owners, :all ] # default :all
     def members(options = { :filter => :all })
       return @members if @members
-      @members = Client.get("/boards/#{id}/members").json_into(Member)
+      @members = Client.get("/boards/#{id}/members", options).json_into(Member)
     end
 
     # Returns a reference to the organization this board belongs to.

data/lib/trello/card.rb

@@ -14,7 +14,7 @@ module Trello
       def create(options)
         new('name'   => options[:name],
             'idList' => options[:list_id],
-            'desc' => options[:description]).save!
+            'desc'   => options[:description]).save!
       end
     end
 
@@ -31,6 +31,7 @@ module Trello
       @board_id    = fields['idBoard']
       @member_ids  = fields['idMembers']
       @list_id     = fields['idList']
+      self
     end
 
     # Returns a list of the actions associated with this card.
@@ -69,15 +70,35 @@ module Trello
       end
     end
 
+    # Change the name of the card
+    def name=(val)
+      Client.put("/card/#{id}/name", :value => val)
+      @name = val
+    end
+
+    # Change the description of the card
+    def description=(val)
+      Client.put("/card/#{id}/desc", :value => val)
+      @description = val
+    end
+
+    # Change the list this card is a part of
+    def list=(other)
+      Client.put("/card/#{id}/idList", :value => other.id)
+      @list_id = other.id
+      other
+    end
+
     # Saves a record.
     def save!
+      # If we have an id, just update our fields.
       return update! if id
 
       Client.post("/cards", {
         :name   => @name,
         :desc   => @description,
         :idList => @list_id
-      })
+      }).json_into(self)
     end
 
     # Update an existing record.
@@ -93,7 +114,7 @@ module Trello
 
     # Add a comment with the supplied text.
     def add_comment(text)
-      Client.put("/cards/#{id}/actions/comments", :text => text)
+      Client.post("/cards/#{id}/actions/comments", :text => text)
     end
   end
 end

data/lib/trello/checklist.rb

@@ -23,6 +23,7 @@ module Trello
       @check_items = fields['checkItems']
       @board_id    = fields['idBoard']
       @member_ids  = fields['idMembers']
+      self
     end
 
     # Check if the checklist is currently active.

data/lib/trello/client.rb

@@ -1,66 +1,51 @@
 require 'addressable/uri'
 
 module Trello
-  # Client is used to handle the OAuth connection to Trello as well as send requests over that authenticated socket.
   class Client
-    class EnterYourPublicKey < StandardError; end
-    class EnterYourSecret < StandardError; end
+    extend Authorization
 
     class << self
-      attr_writer :public_key, :secret
-
-      # call-seq:
-      #   get(path, params)
-      #   post(path, params)
-      #   put(path, params)
-      #   delete(path, params)
-      #   query(api_version, path, options)
-      #
-      # Makes a query to a specific path via one of the four HTTP methods, optionally
-      # with a hash specifying parameters to pass to Trello.
-      #
-      # You should use one of _.get_, _.post_, _.put_ or _.delete_ instead of this method.
-      def query(api_version, path, options = { :method => :get, :params => {} })
+      def get(path, params = {})
+        api_version = 1
+
         uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
-        uri.query_values = options[:params]
-
-        access_token.send(options[:method], uri.to_s)
-      rescue OAuth::Problem => e
-        headers = []
-        e.request.each_header do |k,v|
-          headers << [k, v]
-        end
-
-        logger.error("[#{@access_token}] Disposing of access token.\n#{e.inspect}")
-        logger.info("[#{@access_token}] Headers: #{headers.inspect}\nRequest Body: #{e.request.body}")
-        @access_token = nil
-      end
+        uri.query_values = params unless params.empty?
+
+        request = Request.new :get, uri, {}
+
+        response = TInternet.execute AuthPolicy.authorize(request)
 
-      %w{get post put delete}.each do |http_method|
-        send(:define_method, http_method) do |*args|
-          path = args[0]
-          params = args[1] || {}
-          query(API_VERSION, path, :method => http_method, :params => params).read_body
-        end
+        raise Error, response.body unless response.code.to_i == 200
+
+        response.body
       end
 
-      protected
+      def post(path, body = {})
+        api_version = 1
+
+        uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
+
+        request = Request.new :post, uri, {}, body
+
+        response = TInternet.execute AuthPolicy.authorize(request)
 
-      def consumer
-        raise EnterYourPublicKey if @public_key.to_s.empty?
-        raise EnterYourSecret if @secret.to_s.empty?
+        raise Error, response.body unless response.code.to_i == 200
 
-        OAuth::Consumer.new(@public_key, @secret, :site => 'https://trello.com',
-                                                  :request_token_path => '/1/OAuthGetRequestToken',
-                                                  :authorize_path => '/1/OAuthAuthorizeToken',
-                                                  :access_token_path => '/1/OAuthGetAccessToken',
-                                                  :http_method => :get)
+        response.body
       end
 
-      def access_token
-        return @access_token if @access_token
+      def put(path, body = {})
+        api_version = 1
+
+        uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
+
+        request = Request.new :put, uri, {}, body
+
+        response = TInternet.execute AuthPolicy.authorize(request)
+
+        raise Error, response.body unless response.code.to_i == 200
 
-        @access_token = OAuth::AccessToken.new(consumer)
+        response.body
       end
     end
   end

data/lib/trello/item.rb

@@ -11,6 +11,7 @@ module Trello
       @id   = fields['id']
       @name = fields['name']
       @type = fields['type']
+      self
     end
   end
 end

data/lib/trello/item_state.rb

@@ -11,6 +11,7 @@ module Trello
       @id      = fields['id']
       @state   = fields['state']
       @item_id = fields['idItem']
+      self
     end
 
     # Return the item this state belongs to.

data/lib/trello/list.rb

@@ -8,6 +8,11 @@ module Trello
       def find(id)
         super(:lists, id)
       end
+
+      def create(options)
+        new('name'    => options[:name],
+            'idBoard' => options[:board_id]).save!
+      end
     end
 
     # Updates the fields of a list.
@@ -19,6 +24,20 @@ module Trello
       @name     = fields['name']
       @closed   = fields['closed']
       @board_id = fields['idBoard']
+      self
+    end
+
+    def save!
+      return update! if id
+
+      Client.post("/lists", {
+        :name    => @name,
+        :closed  => @closed || false,
+        :idBoard => @board_id
+      }).json_into(self)
+    end
+
+    def update!
     end
 
     # Check if the list is not active anymore.