ruby-trello 1.1.3 → 1.2.0

data/lib/trello/checklist.rb

@@ -1,10 +1,31 @@
 module Trello
   # A Checklist holds items which are like a "task" list. Checklists are linked to a card.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] closed
+  #   @return [Boolean]
+  # @!attribute [rw] position
+  #   @return [Object]
+  # @!attribute [r] url
+  #   @return [String]
+  # @!attribute [r] check_items
+  #   @return [Object]
+  # @!attribute [r] board_id
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] list_id
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] member_ids
+  #   @return [Array<String>] An array of 24-character hex strings
   class Checklist < BasicData
     register_attributes :id, :name, :description, :closed, :position, :url, :check_items, :board_id, :list_id, :member_ids,
-                        :readonly => [:id, :description, :closed, :url, :check_items, :board_id, :list_id, :member_ids]
+                        readonly: [:id, :description, :closed, :url, :check_items, :board_id, :list_id, :member_ids]
     validates_presence_of :id, :board_id, :list_id
-    validates_length_of :name, :in => 1..16384
+    validates_length_of :name, in: 1..16384
 
     class << self
       # Locate a specific checklist by its id.
@@ -47,13 +68,13 @@ module Trello
       return update! if id
 
       client.post("/checklists", {
-          :name => name,
-          :idBoard => board_id
+          name: name,
+          idBoard: board_id
       }).json_into(self)
     end
 
     def update!
-      client.put("/checklists/#{id}", {:name => name, :pos => position}).json_into(self)
+      client.put("/checklists/#{id}", {name: name, pos: position}).json_into(self)
     end
 
     # Return a list of items on the checklist.
@@ -64,10 +85,10 @@ module Trello
     end
 
     # Return a reference to the board the checklist is on.
-    one :board, :path => :checklists, :using => :board_id
+    one :board, path: :checklists, using: :board_id
 
     # Return a reference to the list the checklist is on.
-    one :list, :path => :lists, :using => :list_id
+    one :list, path: :lists, using: :list_id
 
     # Return a list of members active in this checklist.
     def members
@@ -79,7 +100,7 @@ module Trello
 
     # Add an item to the checklist
     def add_item(name, checked=false, position='bottom')
-      client.post("/checklists/#{id}/checkItems", {:name => name, :checked => checked, :pos => position})
+      client.post("/checklists/#{id}/checkItems", {name: name, checked: checked, pos: position})
     end
 
     # Delete a checklist item

data/lib/trello/configuration.rb

@@ -48,19 +48,19 @@ module Trello
 
     def oauth_credentials
       {
-        :consumer_key => consumer_key,
-        :consumer_secret => consumer_secret,
-        :oauth_token => oauth_token,
-        :oauth_token_secret => oauth_token_secret,
-        :return_url => return_url,
-        :callback => callback,
+        consumer_key: consumer_key,
+        consumer_secret: consumer_secret,
+        oauth_token: oauth_token,
+        oauth_token_secret: oauth_token_secret,
+        return_url: return_url,
+        callback: callback,
       }.delete_if { |key, value| value.nil? }
     end
 
     def basic_credentials
       {
-        :developer_public_key => developer_public_key,
-        :member_token => member_token
+        developer_public_key: developer_public_key,
+        member_token: member_token
       }
     end
 

data/lib/trello/has_actions.rb

@@ -2,7 +2,7 @@ module Trello
   module HasActions
     # Returns a list of the actions associated with this object.
     def actions(options = {})
-      actions = client.get("#{request_prefix}/actions", { :filter => :all }.merge(options)).json_into(Action)
+      actions = client.get("#{request_prefix}/actions", { filter: :all }.merge(options)).json_into(Action)
       MultiAssociation.new(self, actions).proxy
     end
   end

data/lib/trello/item.rb

@@ -1,7 +1,18 @@
 module Trello
   # An Item is a basic task that can be checked off and marked as completed.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] name
+  #   @return [String]
+  # @!attribute [r] type
+  #   @return [Object]
+  # @!attribute [r] state
+  #   @return [Object]
+  # @!attribute [r] pos
+  #   @return [Object]
   class Item < BasicData
-    register_attributes :id, :name, :type, :state, :pos, :readonly => [ :id, :name, :type, :state, :pos ]
+    register_attributes :id, :name, :type, :state, :pos, readonly: [ :id, :name, :type, :state, :pos ]
     validates_presence_of :id, :type
 
     # Updates the fields of an item.
@@ -17,4 +28,4 @@ module Trello
       self
     end
   end
-end
+end

data/lib/trello/item_state.rb

@@ -1,7 +1,14 @@
 module Trello
   # Represents the state of an item.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] state
+  #   @return [Object]
+  # @!attribute [r] item_id
+  #   @return [String]
   class CheckItemState < BasicData
-    register_attributes :id, :state, :item_id, :readonly => [ :id, :state, :item_id ]
+    register_attributes :id, :state, :item_id, readonly: [ :id, :state, :item_id ]
     validates_presence_of :id, :item_id
 
     # Update the fields of an item state.

data/lib/trello/label.rb

@@ -1,6 +1,11 @@
 module Trello
 
   # A colored Label attached to a card
+  #
+  # @!attribute [rw] id
+  #   @return [String]
+  # @!attribute [rw] color
+  #   @return [String]
   class Label < BasicData
     register_attributes :name, :color
 

data/lib/trello/label_name.rb

@@ -2,7 +2,7 @@ module Trello
 
   # A colored Label attached to a card
   class LabelName < BasicData
-    register_attributes :yellow, :red, :orange, :green, :purple, :blue
+    register_attributes :yellow, :red, :orange, :green, :purple, :blue, :sky, :pink, :lime, :black
 
     # Update the fields of a label.
     #
@@ -15,12 +15,17 @@ module Trello
       attributes[:green] = fields['green']
       attributes[:purple] = fields['purple']
       attributes[:blue] = fields['blue']
+      attributes[:sky] = fields['sky']
+      attributes[:pink] = fields['pink']
+      attributes[:lime] = fields['lime']
+      attributes[:black] = fields['black']
+
       self
     end
 
-    one :board, :path => :boards, :using => :board_id
+    one :board, path: :boards, using: :board_id
 
-    many :cards, :filter => :all
+    many :cards, filter: :all
 
   end
 end

data/lib/trello/list.rb

@@ -1,14 +1,28 @@
 module Trello
   # A List is a container which holds cards. Lists are items on a board.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [rw] closed
+  #   @return [Boolean]
+  # @!attribute [r] board_id
+  #   @return [String] A 24-character hex string
+  # @!attribute [rw] pos
+  #   @return [Object]
   class List < BasicData
-    register_attributes :id, :name, :closed, :board_id, :pos, :readonly => [ :id, :board_id ]
+    register_attributes :id, :name, :closed, :board_id, :pos, readonly: [ :id, :board_id ]
     validates_presence_of :id, :name, :board_id
-    validates_length_of   :name, :in => 1..16384
+    validates_length_of   :name, in: 1..16384
 
     include HasActions
 
     class << self
       # Finds a specific list, given an id.
+      #
+      # @param [id] id the list's ID on Trello (24-character hex string).
+      # @param [Hash] params
       def find(id, params = {})
         client.find(:list, id, params)
       end
@@ -37,16 +51,16 @@ module Trello
       return update! if id
 
       client.post("/lists", {
-        :name    => name,
-        :closed  => closed || false,
-        :idBoard => board_id
+        name: name,
+        closed: closed || false,
+        idBoard: board_id
       }).json_into(self)
     end
 
     def update!
       client.put("/lists/#{id}", {
-        :name   => name,
-        :closed => closed
+        name: name,
+        closed: closed
       })
     end
 
@@ -65,14 +79,14 @@ module Trello
     end
 
     # Return the board the list is connected to.
-    one :board, :path => :boards, :using => :board_id
+    one :board, path: :boards, using: :board_id
 
     # Returns all the cards on this list.
     #
     # The options hash may have a filter key which can have its value set as any
     # of the following values:
     #    :filter => [ :none, :open, :closed, :all ] # default :open
-    many :cards, :filter => :open
+    many :cards, filter: :open
 
     # :nodoc:
     def request_prefix

data/lib/trello/member.rb

@@ -1,10 +1,27 @@
 module Trello
   # A Member is a user of the Trello service.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] username
+  #   @return [String]
+  # @!attribute [rw] email
+  #   @return [String]
+  # @!attribute [rw] full_name
+  #   @return [String]
+  # @!attribute [rw] initials
+  #   @return [String]
+  # @!attribute [r] avatar_id
+  #   @return [String]
+  # @!attribute [rw] bio
+  #   @return [String]
+  # @!attribute [r] url
+  #   @return [String]
   class Member < BasicData
-    register_attributes :id, :username, :email, :full_name, :initials, :avatar_id, :bio, :url, :readonly => [ :id, :username, :avatar_id, :url ]
+    register_attributes :id, :username, :email, :full_name, :initials, :avatar_id, :bio, :url, readonly: [ :id, :username, :avatar_id, :url ]
     validates_presence_of :id, :username
-    validates_length_of   :full_name, :minimum => 4
-    validates_length_of   :bio,       :maximum => 16384
+    validates_length_of   :full_name, minimum: 4
+    validates_length_of   :bio,       maximum: 16384
 
     include HasActions
 
@@ -38,7 +55,7 @@ module Trello
     # Valid values for options are:
     #   :large (170x170)
     #   :small (30x30)
-    def avatar_url(options = { :size => :large })
+    def avatar_url(options = { size: :large })
       size = options[:size] == :small ? 30 : 170
       "https://trello-avatars.s3.amazonaws.com/#{avatar_id}/#{size}.png"
     end
@@ -50,7 +67,7 @@ module Trello
     #   :filter => [ :none, :members, :organization, :public, :open, :closed, :all ] # default: :all
     # i.e.,
     #    me.boards(:filter => :closed) # retrieves all closed boards
-    many :boards, :filter => :all
+    many :boards, filter: :all
 
     # Returns a list of cards the member is assigned to.
     #
@@ -59,7 +76,7 @@ module Trello
     #    :filter => [ :none, :open, :closed, :all ] # default :open
     # i.e.,
     #    me.cards(:filter => :closed) # retrieves all closed cards
-    many :cards, :filter => :open
+    many :cards, filter: :open
 
     # Returns a list of the organizations this member is a part of.
     #
@@ -68,7 +85,7 @@ module Trello
     #   :filter => [ :none, :members, :public, :all ] # default: all
     # i.e.,
     #    me.organizations(:filter => :public) # retrieves all public organizations
-    many :organizations, :filter => :all
+    many :organizations, filter: :all
 
     # Returns a list of notifications for the user
     many :notifications
@@ -82,8 +99,8 @@ module Trello
 
     def update!
       client.put(request_prefix, {
-        :fullName => full_name,
-        :bio      => bio
+        fullName: full_name,
+        bio: bio
       }).json_into(self)
     end
 

data/lib/trello/net.rb

@@ -26,11 +26,11 @@ module Trello
       def execute_core(request)
         RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
         RestClient::Request.execute(
-          :method => request.verb, 
-          :url => request.uri.to_s, 
-          :headers => request.headers, 
-          :payload => request.body, 
-          :timeout => 10
+          method: request.verb,
+          url: request.uri.to_s,
+          headers: request.headers,
+          payload: request.body,
+          timeout: 10
         )
       end
     end

data/lib/trello/notification.rb

@@ -1,7 +1,20 @@
 module Trello
+
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] unread
+  #   @return [Boolean]
+  # @!attribute [r] type
+  #   @return [Object]
+  # @!attribute [r] date
+  #   @return [Datetime]
+  # @!attribute [rw] data
+  #   @return [Object]
+  # @!attribute [r] member_creator_id,
+  #   @return [String]
   class Notification < BasicData
     register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
-      :read_only => [ :id, :unread, :type, :date, :member_creator_id ]
+      read_only: [ :id, :unread, :type, :date, :member_creator_id ]
     validates_presence_of :id, :type, :date, :member_creator_id
 
     class << self
@@ -23,7 +36,7 @@ module Trello
 
     alias :unread? :unread
 
-    one :member_creator, :path => :members, :via => Member, :using => :member_creator_id
+    one :member_creator, path: :members, via: Member, using: :member_creator_id
 
     def board
       client.get("/notifications/#{id}/board").json_into(Board)

data/lib/trello/organization.rb

@@ -1,8 +1,19 @@
 module Trello
   # Organizations are useful for linking members together.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] name
+  #   @return [String]
+  # @!attribute [r] display_name
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] url
+  #   @return [String]
   class Organization < BasicData
     register_attributes :id, :name, :display_name, :description, :url,
-      :readonly => [ :id, :name, :display_name, :description, :url ]
+      readonly: [ :id, :name, :display_name, :description, :url ]
     validates_presence_of :id, :name
 
     include HasActions

data/lib/trello/token.rb

@@ -1,7 +1,18 @@
 module Trello
+
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] member_id
+  #   @return [String]
+  # @!attribute [r] created_at
+  #   @return [Datetime]
+  # @!attribute [r] permissions
+  #   @return [Object]
+  # @!attribute [r] webhooks
+  #   @return [Object]
   class Token < BasicData
     register_attributes :id, :member_id, :created_at, :permissions, :webhooks,
-      :readonly => [ :id, :member_id, :created_at, :permissions, :webhooks ]
+      readonly: [ :id, :member_id, :created_at, :permissions, :webhooks ]
 
     class << self
       # Finds a token
@@ -20,6 +31,6 @@ module Trello
     end
 
     # Returns a reference to the user who authorized the token.
-    one :member, :path => :members, :using => :member_id
+    one :member, path: :members, using: :member_id
   end
 end

data/lib/trello/webhook.rb

@@ -1,10 +1,21 @@
 module Trello
-  # A webhook is an url called each time a specified idModel is updated
+  # A webhook is a URL called each time a specified model is updated
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] description
+  #   @return [String]
+  # @!attribute [r] id_model
+  #   @return [String] A 24-character hex string
+  # @!attribute [r] callback_url
+  #   @return [String]
+  # @!attribute [r] active
+  #   @return [Boolean]
   class Webhook < BasicData
     register_attributes :id, :description, :id_model, :callback_url, :active,
-      :readonly => [ :id ]
+      readonly: [ :id ]
     validates_presence_of :id, :id_model, :callback_url
-    validates_length_of   :description,  :in => 1..16384
+    validates_length_of   :description,  in: 1..16384
 
     class << self
       # Find a specific webhook by its ID.
@@ -18,9 +29,14 @@ module 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] :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
+      #
+      # @raise [Trello::Error] if the Webhook could not be created.
+      #
       # @return [Trello::Webhook]
       def create(options)
         client.create(:webhook,
@@ -30,7 +46,7 @@ module Trello
       end
     end
 
-    # return [Trello::Webhook] self
+    # @return [Trello::Webhook] self
     def update_fields(fields)
       attributes[:id]              = fields['id']
       attributes[:description]     = fields['description']
@@ -40,27 +56,39 @@ module Trello
       self
     end
 
+    # Save the webhook.
+    #
+    # @raise  [Trello::Error] if the Webhook could not be saved.
+    #
+    # @return [String] the JSON representation of the saved webhook.
     def save
       # If we have an id, just update our fields.
       return update! if id
 
       client.post("/webhooks", {
-        :description => description,
-        :idModel     => id_model,
-        :callbackURL => callback_url
+        description: description,
+        idModel: id_model,
+        callbackURL: callback_url
       }).json_into(self)
     end
 
+    # Update the webhook.
+    #
+    # @raise  [Trello::Error] if the Webhook could not be saved.
+    #
+    # @return [String] the JSON representation of the updated webhook.
     def update!
       client.put("/webhooks/#{id}", {
-        :description => description,
-        :idModel     => id_model,
-        :callbackURL => callback_url,
-        :active      => active
+        description: description,
+        idModel: id_model,
+        callbackURL: callback_url,
+        active: active
       })
     end
 
     # Delete this webhook
+    #
+    # @return [String] the JSON response from the Trello API
     def delete
       client.delete("/webhooks/#{id}")
     end