ruby-trello 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83302feba110fb6f1a0d44ef350f853bfbee2dda
-  data.tar.gz: d1130c82f391fc9ee317a27efcfa7e24cca4333c
+  metadata.gz: 81baf76d9e58785fa9dc51f1d712b882b92db245
+  data.tar.gz: a73d11ce0d6308962b78802fdca44e60d5d84fec
 SHA512:
-  metadata.gz: 6583fbca2e0d7e6c5ec70dab5128cc140c15292eefc4f793b0022fce03ea691d86bf38ad6651a44af924134d044b6a25c40cbcefbb3100cc0a116e04fa634eb4
-  data.tar.gz: 388cff3c894fb1ca3f6e42892a2df385792484967503da6cd7992a05520f1177457ceee486d040165a2c5ed4c3a9052b7fb2283f036abf6701fff9c9d2201a38
+  metadata.gz: 9d99de48aaf068f1bd67db5d5f39fe8aa8b0fe04c40285b5775a0409048f75e0d17ddee6fa98a3d14f79b2319dd607feb30e0742fb79c562070463b4d7d3f648
+  data.tar.gz: 62a787fc187af9d034103afd7331bc3f74155750777c07e67aef1838ddb6581af853aef33f7633def4385643b83ba55d4af593aa6b1688a2ea4861366e20deb1

data/README.md

@@ -8,6 +8,8 @@ This library implements the [Trello](http://www.trello.com/) [API](http://trello
 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
 
 ```
@@ -22,14 +24,22 @@ illustrate that future versions may include ruby 1.9.3+ specific features.
 
 ## Configuration
 
-Basic authorization
+Basic authorization:
+
+1. Get your API keys from [trello.com/app-key](https://trello.com/app-key). 
+2. Visit the URL [trello.com/1/authorize], with the following GET parameters:
+    - `key`: the API key you got in step 1.
+    - `response_type`: "token"
+    - `expiration`: "never" if you don't want your token to ever expire. If you leave this blank,
+       your generated token will expire after 30 days.
+3. You should see a page asking you to authorize your Trello application. Click "allow" and you should see a second page with a long alphanumeric string. This is your member token.
 
 ```ruby
 require 'trello'
 
 Trello.configure do |config|
-  config.developer_public_key = TRELLO_DEVELOPER_PUBLIC_KEY
-  config.member_token = TRELLO_MEMBER_TOKEN
+  config.developer_public_key = TRELLO_DEVELOPER_PUBLIC_KEY # The "key" from step 1
+  config.member_token = TRELLO_MEMBER_TOKEN # The token from step 3.
 end
 ```
 

data/lib/trello/board.rb

@@ -10,6 +10,8 @@ module Trello
 
     class << self
       # Finds a board.
+      #
+      # @return [Trello::Board]
       def find(id, params = {})
         client.find(:board, id, params)
       end
@@ -23,6 +25,7 @@ module Trello
         client.create(:board, data)
       end
 
+      # @return [Array<Trello::Board>] all boards for the current user
       def all
         client.get("/members/#{Member.find(:me).username}/boards").json_into(self)
       end
@@ -45,9 +48,10 @@ module Trello
       @changed_attributes.clear
 
       client.put("/boards/#{self.id}/", {
-        :name        => attributes[:name],
-        :description => attributes[:description],
-        :closed      => attributes[:closed]
+        :name           => attributes[:name],
+        :description    => attributes[:description],
+        :closed         => attributes[:closed],
+        :idOrganization => attributes[:organization_id]
       }).json_into(self)
     end
 
@@ -62,14 +66,18 @@ module Trello
       self
     end
 
+    # @return [Boolean]
     def closed?
       attributes[:closed]
     end
 
+    # @return [Boolean]
     def has_lists?
       lists.size > 0
     end
 
+    # Find a card on this Board with the given ID.
+    # @return [Trello::Card]
     def find_card(card_id)
       client.get("/boards/#{self.id}/cards/#{card_id}").json_into(Card)
     end

data/lib/trello/card.rb

@@ -211,9 +211,14 @@ module Trello
       MultiAssociation.new(self, labels).proxy
     end
 
+    # Label colours
+    def label_colours
+      %w{green yellow orange red purple blue sky lime pink black}
+    end
+    
     # Add a label
     def add_label(colour)
-      unless %w{green yellow orange red purple blue}.include? colour
+      unless label_colours.include? colour
         errors.add(:label, "colour '#{colour}' does not exist")
         return Trello.logger.warn "The label colour '#{colour}' does not exist."
       end
@@ -222,9 +227,9 @@ module Trello
 
     # Remove a label
     def remove_label(colour)
-      unless %w{green yellow orange red purple blue}.include? colour
+      unless label_colours.include? colour
         errors.add(:label, "colour '#{colour}' does not exist")
-        return Trello.logger.warn "The label colour '#{colour}' does not exist." unless %w{green yellow orange red purple blue}.include? colour
+        return Trello.logger.warn "The label colour '#{colour}' does not exist." unless label_colours.include? colour
       end
       client.delete("/cards/#{id}/labels/#{colour}")
     end

data/lib/trello/webhook.rb

@@ -7,12 +7,21 @@ module Trello
     validates_length_of   :description,  :in => 1..16384
 
     class << self
-      # Find a specific webhook by its id.
+      # Find a specific webhook by its ID.
+      #
+      # @raise [Trello::Error] if a Webhook with the given ID can't be found.
+      # @return [Trello::Webhook] the Webhook with the given ID.
       def find(id, params = {})
         client.find(:webhook, id, params)
       end
 
-      # Create a new webhook and save it on Trello.
+      # Create a new webhook and save it to Trello.
+      #
+      # @param [Hash] options
+      # @option options [String] :description (optional) A string with a length from 0 to 16384
+      # @option options [String] :callback_url (required) A valid URL that is reachable with a HEAD request
+      # @option options [String] :id_model (required) id of the model that should be hooked
+      # @return [Trello::Webhook]
       def create(options)
         client.create(:webhook,
             'description' => options[:description],
@@ -21,6 +30,7 @@ module Trello
       end
     end
 
+    # return [Trello::Webhook] self
     def update_fields(fields)
       attributes[:id]              = fields['id']
       attributes[:description]     = fields['description']
@@ -56,6 +66,8 @@ module Trello
     end
 
     # Check if the webhook is activated
+    #
+    # @return [Boolean]
     def activated?
       active
     end

data/spec/board_spec.rb

@@ -169,7 +169,7 @@ module Trello
       end
 
       it "puts all fields except id" do
-        expected_fields = %w{ name description closed }.map { |s| s.to_sym }
+        expected_fields = %w{ name description closed idOrganization}.map { |s| s.to_sym }
 
         client.should_receive(:put) do |anything, body|
           body.keys.should =~ expected_fields
@@ -222,7 +222,8 @@ module Trello
         client.should_receive(:put).with("/boards/#{board.id}/", {
           :name => "new name",
           :description => "new description",
-          :closed => true
+          :closed => true,
+          :idOrganization => nil
         }).and_return any_board_json
         board.update!
       end

data/spec/card_spec.rb

@@ -51,7 +51,8 @@ module Trello
 
         result = JSON.generate(cards_details.first.merge(payload.merge(:idList => lists_details.first['id'])))
 
-        expected_payload = {name: "Test Card", desc: nil, idList: "abcdef123456789123456789", idMembers: nil, labels: nil }
+        expected_payload = {name: "Test Card", desc: nil, idList: "abcdef123456789123456789",
+                            idMembers: nil, labels: nil, pos: nil }
 
         client.should_receive(:post).with("/cards", expected_payload).and_return result
 
@@ -119,6 +120,10 @@ module Trello
       it "gets its cover image id" do
         card.cover_image_id.should_not be_nil
       end
+
+      it "gets its pos" do
+        card.pos.should_not be_nil
+      end
     end
 
     context "actions" do
@@ -250,41 +255,50 @@ module Trello
         client.stub(:get).with("/cards/abcdef123456789123456789/labels").
           and_return label_payload
         labels = card.labels
-        labels.size.should == 2
+        expect(labels.size).to  eq(2)
 
-        labels[0].color.should == 'yellow'
-        labels[0].name.should == 'iOS'
+        expect(labels[0].color).to  eq('yellow')
+        expect(labels[0].name).to  eq('iOS')
 
-        labels[1].color.should == 'purple'
-        labels[1].name.should == 'Issue or bug'
+        expect(labels[1].color).to  eq('purple')
+        expect(labels[1].name).to  eq('Issue or bug')
       end
 
       it "can add a label" do
         client.stub(:post).with("/cards/abcdef123456789123456789/labels", { :value => 'green' }).
           and_return "not important"
         card.add_label('green')
-        card.errors.should be_empty
+        expect(card.errors).to be_empty
       end
 
       it "can remove a label" do
         client.stub(:delete).with("/cards/abcdef123456789123456789/labels/green").
           and_return "not important"
         card.remove_label('green')
-        card.errors.should be_empty
+        expect(card.errors).to be_empty
+      end
+
+      it "can add a label of any valid color" do
+        %w(green yellow orange red purple blue sky lime pink black).each do |color|
+          client.stub(:post).with("/cards/abcdef123456789123456789/labels", { :value => color }).
+            and_return "not important"
+          card.add_label(color)
+          expect(card.errors).to be_empty
+        end
       end
 
       it "throws an error when trying to add a label with an unknown colour" do
         client.stub(:post).with("/cards/abcdef123456789123456789/labels", { :value => 'green' }).
           and_return "not important"
         card.add_label('mauve')
-        card.errors.full_messages.to_sentence.should == "Label colour 'mauve' does not exist"
+        expect(card.errors.full_messages.to_sentence).to eq("Label colour 'mauve' does not exist")
       end
 
       it "throws an error when trying to remove a label with an unknown colour" do
         client.stub(:delete).with("/cards/abcdef123456789123456789/labels/mauve").
           and_return "not important"
         card.remove_label('mauve')
-        card.errors.full_messages.to_sentence.should == "Label colour 'mauve' does not exist"
+        expect(card.errors.full_messages.to_sentence).to eq("Label colour 'mauve' does not exist")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-trello
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Jeremy Tregunna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2015-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel