ruby-trello 0.3.1 → 0.3.2

data/README.md

@@ -22,6 +22,10 @@ of refactoring and functionality to be deserving of a beer and this special than
 
 ## Contributing
 
+Several ways you can contribute. Documentation, code, tests, feature requests, bug reports.
+
+We develop ruby-trello using [Trello itself](https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd).
+
 Pick up an editor, fix a test! (If you want to, of course.) Send a pull
 request, and I'll look at it. I only ask a few things:
 

data/lib/trello.rb

@@ -40,25 +40,25 @@ module Trello
   autoload :Request,      'trello/net'
   autoload :TInternet,    'trello/net'
 
+  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.
   class Error < StandardError; end
+  # This specific error is thrown when your access token is invalid. You should get a new one.
+  class InvalidAccessToken < StandardError; end
 
   def self.logger
-    @@logger || Logger.new(STDOUT)
+    @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'
+    @logger = logger
   end
-end
+end

data/lib/trello/authorization.rb

@@ -37,7 +37,10 @@ module Trello
         attr_accessor :consumer_credential, :token
 
         def authorize(request)
-          fail "The consumer_credential has not been supplied." unless consumer_credential
+          unless consumer_credential
+            Trello.logger.error "The consumer_credential has not been supplied."
+            fail "The consumer_credential has not been supplied."
+          end
 
           request.headers = {"Authorization" => get_auth_header(request.uri, :get)}
           request
@@ -48,7 +51,7 @@ module Trello
         def get_auth_header(url, verb)
           require "oauth"
 
-          self.token ||= OAuthCredential.new 
+          self.token ||= OAuthCredential.new
 
           consumer = OAuth::Consumer.new(
             consumer_credential.key,

data/lib/trello/board.rb

@@ -10,19 +10,29 @@ module Trello
       end
 
       def create(attributes)
-        Client.post("/boards/", attributes).json_into Board
+        new('name'   => attributes[:name],
+            'desc'   => attributes[:description],
+            'closed' => attributes[:closed] || false).save!
       end
     end
 
     def save!
+      return update! if id
+
+      attributes = { :name => name }
+      attributes.merge!(:desc => description) if description
+      attributes.merge!(:idOrganization => organization_id) if organization_id
+
+      Client.post("/boards", attributes).json_into(self)
+    end
+
+    def update!
       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
+        :name        => @name,
+        :description => @description,
+        :closed      => @closed
       }).json_into(self)
     end
 

data/lib/trello/card.rb

@@ -132,5 +132,17 @@ module Trello
         :value => checklist.id
       })
     end
+
+    # Add a label
+    def add_label(colour)
+      return logger.warn "The label colour '#{colour}' does not exist." unless %w{green yellow orange red purple blue}.include? colour
+      Client.post("/cards/#{id}/labels", { :value => colour })
+    end
+
+    # Remove a label
+    def remove_label(colour)
+      return logger.warn "The label colour '#{colour}' does not exist." unless %w{green yellow orange red purple blue}.include? colour
+      Client.delete("/cards/#{id}/labels/#{colour}")
+    end
   end
 end

data/lib/trello/checklist.rb

@@ -1,5 +1,5 @@
 module Trello
-  # A Checklist holds items which are like a "todo" list. Checklists are linked to a card.
+  # A Checklist holds items which are like a "task" list. Checklists are linked to a card.
   class Checklist < BasicData
     attr_reader :id, :name, :description, :closed, :url, :check_items, :board_id, :list_id, :member_ids
 
@@ -43,10 +43,11 @@ module Trello
       Client.post("/checklists", {
         :name => @name,
         :idBoard => @board_id
-      })
+      }).json_into(self)
     end
 
     def update!
+      Client.put("/checklists", { :name => @name }).json_into(self)
     end
 
     # Return a list of items on the checklist.

data/lib/trello/client.rb

@@ -6,44 +6,39 @@ module Trello
 
     class << self
       def get(path, params = {})
-        api_version = 1
-
-        uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
         uri.query_values = params unless params.empty?
-
-        request = Request.new :get, uri, {}
-
-        response = TInternet.execute AuthPolicy.authorize(request)
-
-        raise Error, response.body unless response.code.to_i == 200
-
-        response.body
+        invoke_verb(:get, uri)
       end
 
       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)
-
-        raise Error, response.body unless response.code.to_i == 200
-
-        response.body
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:post, uri, body)
       end
 
       def put(path, body = {})
-        api_version = 1
-
-        uri = Addressable::URI.parse("https://api.trello.com/#{api_version}#{path}")
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:put, uri, body)
+      end
 
-        request = Request.new :put, uri, {}, body
+      def delete(path)
+        uri = Addressable::URI.parse("https://api.trello.com/#{API_VERSION}#{path}")
+        invoke_verb(:delete, uri)
+      end
 
+      def invoke_verb(name, uri, body = nil)
+        request = Request.new name, uri, {}, body
         response = TInternet.execute AuthPolicy.authorize(request)
 
-        raise Error, response.body unless response.code.to_i == 200
+        if response.code.to_i == 401 && response.body =~ /expired token/
+          Trello.logger.error("[401 #{name.to_s.upcase} #{uri}]: Your access token has expired.")
+          raise InvalidAccessToken, response.body
+        end
+
+        unless response.code.to_i == 200
+          Trello.logger.error("[#{response.code.to_i} #{name.to_s.upcase} #{uri}]: #{response.body}")
+          raise Error, response.body
+        end
 
         response.body
       end

data/lib/trello/list.rb

@@ -38,6 +38,10 @@ module Trello
     end
 
     def update!
+      Client.put("/lists", {
+        :name   => @name,
+        :closed => @closed
+      }).json_into(self)
     end
 
     # Check if the list is not active anymore.

data/lib/trello/notification.rb

@@ -1,11 +1,48 @@
 module Trello
-  # Notifications for members
-  #
-  # This class is not yet implemented as the feature set is not known yet.
   class Notification < BasicData
+    attr_reader :id, :unread, :type, :date, :data, :member_creator_id
+
+    class << self
+      # Locate a notification by its id
+      def find(id)
+        super(:notifications, id)
+      end
+    end
+
     def update_fields(fields)
-      @id = fields['id']
+      @id                = fields['id']
+      @unread            = fields['unread']
+      @type              = fields['type']
+      @date              = fields['date']
+      @data              = fields['data']
+      @member_creator_id = fields['idMemberCreator']
       self
     end
+
+    alias :unread? :unread
+
+    def member_creator
+      Member.find(member_creator_id)
+    end
+
+    def board
+      Client.get("/notifications/#{id}/board").json_into(Board)
+    end
+
+    def list
+      Client.get("/notifications/#{id}/list").json_into(List)
+    end
+
+    def card
+      Client.get("/notifications/#{id}/card").json_into(Card)
+    end
+
+    def member
+      Client.get("/notifications/#{id}/member").json_into(Member)
+    end
+
+    def organization
+      Client.get("/notifications/#{id}/organization").json_into(Organization)
+    end
   end
 end

data/lib/trello/string.rb

@@ -25,8 +25,10 @@ class String
     end
   rescue JSON::ParserError => json_error
     if json_error.message =~ /model not found/
+      logger.error "Could not find that record."
       raise Trello::Error, "Request could not be found."
     else
+      logger.error "Unknown error."
       raise
     end
   end

data/spec/board_spec.rb

@@ -122,11 +122,11 @@ module Trello
       Client.should_not_receive :put
       
       the_new_board = Board.new
-      lambda{the_new_board.save!}.should raise_error "Cannot save new instance."
+      lambda{the_new_board.save!}.should raise_error
     end
 
     it "puts all fields except id" do
-      expected_fields = %w{name description closed url organisation_id}.map{|s| s.to_sym}
+      expected_fields = %w{name description closed}.map{|s| s.to_sym}
         
       Client.should_receive(:put) do |anything, body|
         body.keys.should =~ expected_fields
@@ -171,20 +171,21 @@ module Trello
 
     it "creates a new board with whatever attributes are supplied " do
       expected_attributes = { :name => "Any new board name", :description => "Any new board desription" }
-      
-      Client.should_receive(:post).with(anything, expected_attributes).and_return any_board_json
+      sent_attributes = { :name => expected_attributes[:name], :desc => expected_attributes[:description] }
+
+      Client.should_receive(:post).with("/boards", sent_attributes).and_return any_board_json
 
       Board.create expected_attributes
     end
 
     it "posts to the boards collection" do
-      Client.should_receive(:post).with("/boards/", anything).and_return any_board_json
+      Client.should_receive(:post).with("/boards", anything).and_return any_board_json
 
       Board.create :xxx => ""
     end
 
     it "returns a board" do
-      Client.stub(:post).with("/boards/", anything).and_return any_board_json
+      Client.stub(:post).with("/boards", anything).and_return any_board_json
 
       the_new_board = Board.create :xxx => ""
       the_new_board.should be_a Board

data/spec/notification_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+module Trello
+  describe Notification do
+    include Helpers
+
+    before(:each) do
+      Client.stub(:get).with("/members/me").and_return user_payload
+      Client.stub(:get).with("/members/me/notifications").and_return "[" << notification_payload << "]"
+      @notification = Member.find("me").notifications.first
+    end
+
+    context "finding" do
+      it "can find a specific notification" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}").and_return notification_payload
+        Notification.find(notification_details['id']).should == @notification
+      end
+    end
+
+    context "boards" do
+      it "can retrieve the board" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/board").and_return JSON.generate(boards_details.first)
+        @notification.board.id.should == boards_details.first['id']
+      end
+    end
+
+    context "lists" do
+      it "can retrieve the list" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/list").and_return JSON.generate(lists_details.first)
+        @notification.list.id.should == lists_details.first['id']
+      end
+    end
+
+    context "cards" do
+      it "can retrieve the card" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/card").and_return JSON.generate(cards_details.first)
+        @notification.card.id.should == cards_details.first['id']
+      end
+    end
+
+    context "members" do
+      it "can retrieve the member" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/member").and_return user_payload
+        @notification.member.id.should == user_details['id']
+      end
+
+      it "can retrieve the member creator" do
+        Client.stub(:get).with("/members/#{user_details['id']}").and_return user_payload
+        @notification.member_creator.id.should == user_details['id']
+      end
+    end
+
+    context "organization" do
+      it "can retrieve the organization" do
+        Client.stub(:get).with("/notifications/#{notification_details['id']}/organization").and_return JSON.generate(orgs_details.first)
+        @notification.organization.id.should == orgs_details.first['id']
+      end
+    end
+
+    context "local" do
+      it "gets the read status" do
+        @notification.unread?.should == notification_details['unread']
+      end
+
+      it "gets the type" do
+        @notification.type.should == notification_details['type']
+      end
+
+      it "gets the date" do
+        @notification.date.should == notification_details['date']
+      end
+
+      it "gets the data" do
+        @notification.data.should == notification_details['data']
+      end
+
+      it "gets the member creator id" do
+        @notification.member_creator_id.should == notification_details['idMemberCreator']
+      end
+    end
+  end
+end

data/spec/oauth_policy_spec.rb

@@ -79,5 +79,4 @@ describe OAuthPolicy do
 
   it "adds correct signature for https uri"
   it "adds correct signature for verbs other than get"
-  it "can sign with access token too"
 end

data/spec/spec_helper.rb

@@ -142,4 +142,29 @@ module Helpers
   def actions_payload
     JSON.generate(actions_details)
   end
+
+  def notification_details
+    {
+      "id"              => "4f30d084d5b0f7ab453bee51",
+      "unread"          => false,
+      "type"            => "commentCard",
+      "date"            => "2012-02-07T07:19:32.393Z",
+      "data"            => {
+        "board"         => {
+          "id"          => "abcdef123456789123456789",
+          "name"        => "Test"
+        },
+        "card"=>{
+          "id"          => "abcdef123456789123456789",
+          "name"        => "Do something awesome"
+        },
+        "text"          => "test"
+      },
+      "idMemberCreator" => "abcdef123456789012345678"
+    }
+  end
+
+  def notification_payload
+    JSON.generate(notification_details)
+  end
 end

metadata

@@ -1,112 +1,78 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-trello
-version: !ruby/object:Gem::Version 
-  hash: 4135067353417607739
+version: !ruby/object:Gem::Version
+  version: 0.3.2
   prerelease: 
-  segments: 
-  - 0
-  - 3
-  - 1
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Jeremy Tregunna
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-07 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70172866550100 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3461773182973075480
-        segments: 
-        - 1
-        - 1
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: oauth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70172866550100
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70172866549140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3072838298281563226
-        segments: 
-        - 0
-        - 4
-        - 5
+      - !ruby/object:Gem::Version
         version: 0.4.5
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: addressable
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70172866549140
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: &70172866548200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1690824680571537449
-        segments: 
-        - 2
-        - 2
-        - 6
+      - !ruby/object:Gem::Version
         version: 2.2.6
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70172866548200
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70172866546920 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 4554157976602492668
-        segments: 
-        - 1
-        - 6
-        - 7
+      - !ruby/object:Gem::Version
         version: 1.6.7
   type: :runtime
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *70172866546920
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70172866545720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 2387456872237229630
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *70172866545720
 description: A wrapper around the trello.com API.
 email: jeremy@tregunna.ca
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
-- lib/trello.rb
+files:
 - lib/trello/action.rb
 - lib/trello/authorization.rb
 - lib/trello/basic_data.rb
@@ -122,6 +88,7 @@ files:
 - lib/trello/notification.rb
 - lib/trello/organization.rb
 - lib/trello/string.rb
+- lib/trello.rb
 - README.md
 - spec/action_spec.rb
 - spec/basic_auth_policy_spec.rb
@@ -129,67 +96,59 @@ files:
 - spec/card_spec.rb
 - spec/checklist_spec.rb
 - spec/client_spec.rb
+- spec/integration/how_to_authorize_spec.rb
+- spec/integration/how_to_use_boards_spec.rb
+- spec/integration/integration_test.rb
 - spec/item_spec.rb
 - spec/item_state_spec.rb
 - spec/list_spec.rb
 - spec/member_spec.rb
+- spec/notification_spec.rb
 - spec/oauth_policy_spec.rb
 - spec/organization_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
-- spec/integration/how_to_authorize_spec.rb
-- spec/integration/how_to_use_boards_spec.rb
-- spec/integration/integration_test.rb
 homepage: https://github.com/jeremytregunna/ruby-trello
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2002549777813010636
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 2387630629434237851
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: ruby-trello
-rubygems_version: 1.8.12
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A wrapper around the trello.com API.
-test_files: 
+test_files:
 - spec/action_spec.rb
 - spec/basic_auth_policy_spec.rb
 - spec/board_spec.rb
 - spec/card_spec.rb
 - spec/checklist_spec.rb
 - spec/client_spec.rb
+- spec/integration/how_to_authorize_spec.rb
+- spec/integration/how_to_use_boards_spec.rb
+- spec/integration/integration_test.rb
 - spec/item_spec.rb
 - spec/item_state_spec.rb
 - spec/list_spec.rb
 - spec/member_spec.rb
+- spec/notification_spec.rb
 - spec/oauth_policy_spec.rb
 - spec/organization_spec.rb
 - spec/spec_helper.rb
 - spec/string_spec.rb
-- spec/integration/how_to_authorize_spec.rb
-- spec/integration/how_to_use_boards_spec.rb
-- spec/integration/integration_test.rb