ruby-trello 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45ec7bdcb469bf63f80f7291c787a4f4a8ec653f
-  data.tar.gz: cc4a463550cfe8036d1c4e4cef421389dd6535f8
+  metadata.gz: 129649aadb5faffaa3dd64361d4eeffc6f46dd8d
+  data.tar.gz: 2ec4ff6b8555542d5006e24557c776cf28aca1fa
 SHA512:
-  metadata.gz: fdd6a111315be371b94c6c84cd57742faea4519556136b2db601baed79ef46c670afde112408a1668563c4fdd513fc319221b72721b50f0103e240e69c6d5cfd
-  data.tar.gz: 002b5cca51dd9640a148968a685c25da8b7b627c9446c33e6cb87c4eadc800a5566a14aed9a4205931dc90881cc63093548865894dfb9860b3dca3b59ca02c29
+  metadata.gz: 3b3388b34a9830bf26cb48a705b45bb0e67a8c4314108b2013a389cf71ae607aba2a7bdde48cdf8a095f126c01eacf545f15177cc39a3e3c99b59d46a2086071
+  data.tar.gz: 7c5dc7a800406537edbbaab5f79eab36f11f73e84137562125775b8173896887d0762ecc3fb27f101e70d5ddb360e5a6ba9c35af8913a32d62f4c80bacbdfa56

data/README.md

@@ -24,7 +24,7 @@ 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:
@@ -32,8 +32,9 @@ Basic authorization:
     - `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.
+    - `scope`: "read,write" (optional) by default the API key will only give read access.  You must set the scope to "read,write" if you would like ruby-trello to have permissions to create and delete.
     - The URL will look like this:
-      `https://trello.com/1/authorize?key=YOURAPIKEY&response_type=token&expiration=never`
+      `https://trello.com/1/authorize?key=YOURAPIKEY&response_type=token&expiration=never&scope=read,write`
 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
@@ -45,7 +46,7 @@ Trello.configure do |config|
 end
 ```
 
-2-legged OAuth authorization
+####2-legged OAuth authorization
 
 ```ruby
 Trello.configure do |config|
@@ -56,7 +57,7 @@ Trello.configure do |config|
 end
 ```
 
-3-legged OAuth authorization
+####3-legged OAuth authorization
 
 ```ruby
 Trello.configure do |config|
@@ -123,6 +124,6 @@ of refactoring and functionality to be deserving of a beer and this special than
 
 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).
+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/board.rb

@@ -18,7 +18,7 @@ module Trello
   #   @return [Hash] A 24-character hex string
   class Board < BasicData
     register_attributes :id, :name, :description, :closed, :starred, :url, :organization_id, :prefs,
-      readonly: [ :id, :url, :prefs ]
+      readonly: [ :id, :url ]
     validates_presence_of :id, :name
     validates_length_of   :name,        in: 1..16384
     validates_length_of   :description, maximum: 16384
@@ -154,13 +154,11 @@ module Trello
     # Returns a reference to the organization this board belongs to.
     one :organization, path: :organizations, using: :organization_id
 
-    def labels names=true
-      if names
-        labels = client.get("/boards/#{id}/labelnames").json_into(LabelName)
-      else
-        labels = client.get("/boards/#{id}/labels").json_into(Label)
-      end
-      MultiAssociation.new(self, labels).proxy
+    many :labels
+
+    def label_names
+      label_names = client.get("/boards/#{id}/labelnames").json_into(LabelName)
+      MultiAssociation.new(self, label_names).proxy
     end
 
     # :nodoc:

data/lib/trello/card.rb

@@ -177,7 +177,8 @@ module Trello
       MultiAssociation.new(self, states).proxy
     end
 
-
+    many :labels
+    
     # Returns a reference to the list this card is currently in.
     one :list, path: :lists, using: :list_id
 
@@ -207,7 +208,8 @@ module Trello
         idList: list_id,
         idMembers: member_ids,
         labels: card_labels,
-        pos: pos
+        pos: pos,
+        due: due
       }).json_into(self)
     end
 
@@ -313,39 +315,23 @@ module Trello
     def remove_member(member)
       client.delete("/cards/#{id}/members/#{member.id}")
     end
-
-    # Retrieve a list of labels
-    def labels
-      labels = client.get("/cards/#{id}/labels").json_into(Label)
-      MultiAssociation.new(self, labels).proxy
-    end
     
     # Add a label
-    def add_label(value)
-      if value.is_a? String
-        colour = value 
-        unless Label.label_colours.include? colour
-          errors.add(:label, "colour '#{colour}' does not exist")
-          return Trello.logger.warn "The label colour '#{colour}' does not exist."
-        end
-        client.post("/cards/#{id}/labels", { value: colour })
-      elsif value.is_a? Label
-        client.post("/cards/#{id}/idLabels", {value: value.id})
+    def add_label(label)
+      unless label.valid?
+        errors.add(:label, "is not valid.")
+        return Trello.logger.warn "Label is not valid." unless label.valid?
       end
+      client.post("/cards/#{id}/idLabels", {value: label.id})
     end
 
     # Remove a label
-    def remove_label(value)
-      if value.is_a? String
-        colour = value 
-        unless Label.label_colours.include? colour
-          errors.add(:label, "colour '#{colour}' does not exist")
-          return Trello.logger.warn "The label colour '#{colour}' does not exist." unless Label.label_colours.include? colour
+    def remove_label(label)
+        unless label.valid?
+          errors.add(:label, "is not valid.")
+          return Trello.logger.warn "Label is not valid." unless label.valid?
         end
-        client.delete("/cards/#{id}/labels/#{colour}")
-      elsif value.is_a? Label
-        client.delete("/cards/#{id}/idLabels/#{value.id}")
-      end
+        client.delete("/cards/#{id}/idLabels/#{label.id}")
     end
 
     # Add an attachment to this card

data/lib/trello/checklist.rb

@@ -112,5 +112,19 @@ module Trello
     def delete
       client.delete("/checklists/#{id}")
     end
+
+    # Copy a checklist (i.e., same attributes, items, etc.)
+    def copy
+      checklist_copy = self.class.create(name: self.name, board_id: self.board_id)
+      copy_items_to(checklist_copy)
+      return checklist_copy
+    end
+
+    private
+    def copy_items_to(another_checklist)
+      items.each do |item|
+        another_checklist.add_item(item.name, item.complete?)
+      end
+    end
   end
 end

data/lib/trello/item.rb

@@ -27,5 +27,9 @@ module Trello
       attributes[:pos]   = fields['pos']
       self
     end
+
+    def complete?
+      state == "complete"
+    end
   end
 end

data/lib/trello/label.rb

@@ -11,7 +11,7 @@ module Trello
       readonly: [ :id, :uses, :board_id ]
     validates_presence_of :id, :uses, :board_id, :name
     validates_length_of   :name,        in: 1..16384
-        
+
     SYMBOL_TO_STRING = {
       id: 'id',
       name: 'name',
@@ -26,7 +26,7 @@ module Trello
         client.find(:label, id, params)
       end
 
-      # Create a new card and save it on Trello.
+      # Create a new label and save it on Trello.
       def create(options)
         client.create(:label,
           'name' => options[:name],
@@ -98,7 +98,7 @@ module Trello
       client.put("/labels/#{id}", payload)
     end
 
-    # Delete this card
+    # Delete this label
     def delete
       client.delete("/labels/#{id}")
     end

data/lib/trello/list.rb

@@ -30,7 +30,8 @@ module Trello
       def create(options)
         client.create(:list,
             'name'    => options[:name],
-            'idBoard' => options[:board_id])
+            'idBoard' => options[:board_id],
+            'pos'     => options[:pos])
       end
     end
 
@@ -53,14 +54,16 @@ module Trello
       client.post("/lists", {
         name: name,
         closed: closed || false,
-        idBoard: board_id
+        idBoard: board_id,
+        pos: pos
       }).json_into(self)
     end
 
     def update!
       client.put("/lists/#{id}", {
         name: name,
-        closed: closed
+        closed: closed,
+        pos: pos
       })
     end
 
@@ -88,6 +91,13 @@ module Trello
     #    :filter => [ :none, :open, :closed, :all ] # default :open
     many :cards, filter: :open
 
+    def move_all_cards(other_list)
+      client.post("/lists/#{id}/moveAllCards", {
+        idBoard: other_list.board_id,
+        idList: other_list.id
+       })
+    end
+
     # :nodoc:
     def request_prefix
       "/lists/#{id}"

data/lib/trello/organization.rb

@@ -12,8 +12,10 @@ module Trello
   # @!attribute [r] url
   #   @return [String]
   class Organization < BasicData
-    register_attributes :id, :name, :display_name, :description, :url,
-      readonly: [ :id, :name, :display_name, :description, :url ]
+    register_attributes :id, :name, :display_name, :description, :url, :invited,
+      :website, :logo_hash, :billable_member_count, :active_billable_member_count,
+      readonly: [ :id, :name, :display_name, :description, :url, :invited,
+        :website, :logo_hash, :billable_member_count, :active_billable_member_count ]
     validates_presence_of :id, :name
 
     include HasActions
@@ -30,11 +32,16 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # an Organization.
     def update_fields(fields)
-      attributes[:id]           = fields['id']
-      attributes[:name]         = fields['name']
-      attributes[:display_name] = fields['displayName']
-      attributes[:description]  = fields['description']
-      attributes[:url]          = fields['url']
+      attributes[:id]                           = fields['id']
+      attributes[:name]                         = fields['name']
+      attributes[:display_name]                 = fields['displayName']
+      attributes[:description]                  = fields['desc']
+      attributes[:url]                          = fields['url']
+      attributes[:invited]                      = fields['invited']
+      attributes[:website]                      = fields['website']
+      attributes[:logo_hash]                    = fields['logoHash']
+      attributes[:billable_member_count]        = fields['billableMemberCount']
+      attributes[:active_billable_member_count] = fields['activeBillableMemberCount']
       self
     end
 

data/spec/action_spec.rb

@@ -4,33 +4,44 @@ module Trello
   describe Action do
     include Helpers
 
-    let(:action) { client.find(:action, '4ee2482134a81a757a08af47') }
-    let(:client) { Client.new }
-
-    before(:each) do
-      client.stub(:get).with('/actions/4ee2482134a81a757a08af47', {}).
-        and_return JSON.generate(actions_details.first)
+    let(:client)  { Client.new }
+    let(:action)  { client.find(:action, '4ee2482134a81a757a08af47') }
+
+    before do
+      allow(client)
+        .to receive(:get)
+        .with('/actions/4ee2482134a81a757a08af47', {})
+        .and_return JSON.generate(actions_details.first)
     end
 
     context 'finding' do
       let(:client) { Trello.client }
 
       it 'delegates to Trello.client#find' do
-        client.should_receive(:find).with(:action, '4ee2482134a81a757a08af47', {})
+        expect(client)
+          .to receive(:find)
+          .with(:action, '4ee2482134a81a757a08af47', {})
+
         Action.find('4ee2482134a81a757a08af47')
       end
 
-      it 'is equivalent to client#find' do
-        Action.find('4ee2482134a81a757a08af47').should eq(action)
+      it do
+        expect(Action.find('4ee2482134a81a757a08af47')).to eq(action)
       end
     end
 
     context 'search' do
       let(:client) { Trello.client }
+      let(:payload) { JSON.generate({ "cards" => cards_details }) }
+
+      it "searches and get back a card object" do
+        expect(client)
+          .to receive(:get)
+          .with("/search/", { query: "something"})
+          .and_return payload
 
-      it "should search and get back a card object" do
-        client.should_receive(:get).with("/search/", { query: "something"}).and_return(JSON.generate({ "cards" => cards_details }))
-        Action.search("something").should eq({ "cards" => cards_details.jsoned_into(Card) })
+        expect(Action.search("something"))
+          .to eq({ "cards" => cards_details.jsoned_into(Card) })
       end
     end
 
@@ -38,54 +49,79 @@ module Trello
       let(:detail) { actions_details.first }
 
       it 'gets its id' do
-        action.id.should == detail['id']
+        expect(action.id).to eq detail['id']
       end
 
       it 'gets its type' do
-        action.type.should == detail['type']
+        expect(action.type).to eq detail['type']
       end
 
       it 'has the same data' do
-        action.data.should == detail['data']
+        expect(action.data).to eq detail['data']
       end
 
       it 'gets the date' do
-        action.date.utc.iso8601.should == detail['date']
+        expect(action.date.utc.iso8601).to eq detail['date']
       end
     end
 
     context 'boards' do
-      it 'has a board' do
-        client.stub(:get).with('/actions/4ee2482134a81a757a08af47/board').
-          and_return JSON.generate(boards_details.first)
+      let(:payload) { JSON.generate(boards_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/board')
+          .and_return payload
+      end
 
-        action.board.should_not be_nil
+      it 'has a board' do
+        expect(action.board).to_not be_nil
       end
     end
 
+
     context 'card' do
-      it 'has a card' do
-        client.stub(:get).with('/actions/4ee2482134a81a757a08af47/card').
-          and_return JSON.generate(cards_details.first)
+      let(:payload) { JSON.generate(cards_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/card')
+          .and_return payload
+      end
 
-        action.card.should_not be_nil
+      it 'has a card' do
+        expect(action.card).to_not be_nil
       end
     end
 
     context 'list' do
-      it 'has a list of lists' do
-        client.stub(:get).with('/actions/4ee2482134a81a757a08af47/list').
-          and_return JSON.generate(lists_details.first)
+      let(:payload) { JSON.generate(lists_details.first) }
+
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/actions/4ee2482134a81a757a08af47/list')
+          .and_return payload
+      end
 
-        action.list.should_not be_nil
+      it 'has a list of lists' do
+        expect(action.list).to_not be_nil
       end
     end
 
     context 'member creator' do
-      it 'knows its member creator' do
-        client.stub(:get).with('/members/abcdef123456789123456789', {}).and_return user_payload
 
-        action.member_creator.should_not be_nil
+      before do
+        allow(client)
+          .to receive(:get)
+          .with('/members/abcdef123456789123456789', {})
+          .and_return user_payload
+      end
+
+      it 'knows its member creator' do
+        expect(action.member_creator).to_not be_nil
       end
     end
   end