ruby-trello 2.0.0 → 2.3.1

data/lib/trello/checklist.rb

@@ -45,17 +45,17 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # a checklist.
     def update_fields(fields)
-      attributes[:id] = fields['id']
-      attributes[:name] = fields['name'] || fields[:name]
-      attributes[:description] = fields['desc']
-      attributes[:closed] = fields['closed']
-      attributes[:url] = fields['url']
-      attributes[:check_items] = fields['checkItems']
-      attributes[:position] = fields['pos']
-      attributes[:board_id] = fields['idBoard']
-      attributes[:card_id] = fields['idCard'] || fields[:card_id]
-      attributes[:list_id] = fields['idList']
-      attributes[:member_ids] = fields['idMembers']
+      attributes[:id] = fields['id'] || attributes[:id]
+      attributes[:name] = fields['name'] || fields[:name] || attributes[:name]
+      attributes[:description] = fields['desc'] || attributes[:description]
+      attributes[:closed] = fields['closed'] if fields.has_key?('closed')
+      attributes[:url] = fields['url'] || attributes[:url]
+      attributes[:check_items] = fields['checkItems'] if fields.has_key?('checkItems')
+      attributes[:position] = fields['pos'] || attributes[:position]
+      attributes[:board_id] = fields['idBoard'] || attributes[:board_id]
+      attributes[:card_id] = fields['idCard'] || fields[:card_id] || attributes[:card_id]
+      attributes[:list_id] = fields['idList'] || attributes[:list_id]
+      attributes[:member_ids] = fields['idMembers'] || attributes[:member_ids]
       self
     end
 
@@ -109,9 +109,10 @@ module Trello
 
     # Update a checklist item's state, e.g.: "complete" or "incomplete"
     def update_item_state(item_id, state)
+      state = ( state ? 'complete' : 'incomplete' ) unless state.is_a?(String)
       client.put(
-        "/cards/#{card_id}/checklist/#{id}/checkItem/#{item_id}/state",
-        value: state,
+          "/cards/#{card_id}/checkItem/#{item_id}",
+          state: state
       )
     end
 

data/lib/trello/client.rb

@@ -96,7 +96,7 @@ module Trello
 
       unless [200, 201].include? response.code
         Trello.logger.error("[#{response.code} #{name.to_s.upcase} #{uri}]: #{response.body}")
-        raise Error, response.body
+        raise Error.new(response.body, response.code)
       end
 
       response.body

data/lib/trello/comment.rb

@@ -27,10 +27,10 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # a Comment.
     def update_fields(fields)
-      attributes[:action_id]          = fields['id']
-      attributes[:text]               = fields['data']['text']
-      attributes[:date]               = Time.iso8601(fields['date'])
-      attributes[:member_creator_id]  = fields['idMemberCreator']
+      attributes[:action_id]          = fields['id'] || attributes[:action_id]
+      attributes[:text]               = fields['data']['text'] || attributes[:text]
+      attributes[:date]               = Time.iso8601(fields['date']) if fields.has_key?('date')
+      attributes[:member_creator_id]  = fields['idMemberCreator'] || attributes[:member_creator_id]
       self
     end
 

data/lib/trello/custom_field.rb

@@ -0,0 +1,131 @@
+module Trello
+  # A Custom Field can be activated on a board. Values are stored at the card level.
+  #
+  # @!attribute id
+  #   @return [String]
+  # @!attribute model_id
+  #   @return [String]
+  # @!attribute model_type
+  #   @return [String]
+  # @!attribute field_group
+  #   @return [String]
+  # @!attribute name
+  #   @return [String]
+  # @!attribute pos
+  #   @return [Float]
+  # @!attribute type
+  #   @return [String]
+  # @!attribute options
+  #   @return [Array<Hash>]
+  class CustomField < BasicData
+    register_attributes :id, :model_id, :model_type, :field_group, :name, :pos, :type
+    validates_presence_of :id, :model_id, :model_type, :name, :type, :pos
+
+    SYMBOL_TO_STRING = {
+      id:          'id',
+      name:        'name',
+      model_id:    'idModel',
+      model_type:  'modelType',
+      field_group: 'fieldGroup',
+      type:        'type',
+      pos:         'pos'
+    }
+
+    class << self
+      # Find a custom field by its id.
+      def find(id, params = {})
+        client.find('customFields', id, params)
+      end
+
+      # Create a new custom field and save it on Trello.
+      def create(options)
+        client.create('customFields',
+          'name'       => options[:name],
+          'idModel'    => options[:model_id],
+          'modelType'  => options[:model_type],
+          'fieldGroup' => options[:field_group],
+          'type'       => options[:type],
+          'pos'        => options[:pos]
+        )
+      end
+    end
+
+    # References Board where this custom field is located
+    # Currently, model_type will always be "board" at the customFields endpoint
+    one :board, path: :boards, using: :model_id
+
+    # If type == 'list'
+    many :custom_field_options, path: 'options'
+
+    def update_fields(fields)
+      send('name_will_change!') if fields_has_key?(fields, :name)
+      send('pos_will_change!') if fields_has_key?(fields, :pos)
+
+      initialize_fields(fields)
+    end
+
+    def initialize(fields = {})
+      initialize_fields(fields)
+    end
+
+    # Saves a record.
+    def save
+      # If we have an id, just update our fields.
+      return update! if id
+
+      from_response client.post("/customFields", {
+        name:       name,
+        idModel:    model_id,
+        modelType:  model_type,
+        type:       type,
+        pos:        pos,
+        fieldGroup: field_group
+      })
+    end
+
+    # Update an existing custom field.
+    def update!
+      @previously_changed = changes
+      # extract only new values to build payload
+      payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }]
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
+
+      client.put("/customFields/#{id}", payload)
+    end
+
+    # Delete this custom field
+    # Also deletes all associated values across all cards
+    def delete
+      client.delete("/customFields/#{id}")
+    end
+
+    # If type == 'list', create a new option and add to this Custom Field
+    def create_new_option(value)
+      payload = { value: value }
+      client.post("/customFields/#{id}/options", payload)
+    end
+
+    # Will also clear it from individual cards that have this option selected
+    def delete_option(option_id)
+      client.delete("/customFields/#{id}/options/#{option_id}")
+    end
+
+    private
+
+    def fields_has_key?(fields, key)
+      fields.key?(SYMBOL_TO_STRING[key]) || fields.key?(key)
+    end
+
+    def initialize_fields(fields)
+      attributes[:id]          = fields[SYMBOL_TO_STRING[:id]] || fields[:id] || attributes[:id]
+      attributes[:name]        = fields[SYMBOL_TO_STRING[:name]] || fields[:name] || attributes[:name]
+      attributes[:model_id]    = fields[SYMBOL_TO_STRING[:model_id]] || fields[:model_id] || attributes[:model_id]
+      attributes[:model_type]  = fields[SYMBOL_TO_STRING[:model_type]] || fields[:model_type] || attributes[:model_type]
+      attributes[:field_group] = fields[SYMBOL_TO_STRING[:field_group]] || fields[:field_group] || attributes[:field_group]
+      attributes[:type]        = fields[SYMBOL_TO_STRING[:type]] || fields[:type] || attributes[:type]
+      attributes[:pos]         = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] || attributes[:pos]
+      self
+    end
+  end
+end

data/lib/trello/custom_field_item.rb

@@ -0,0 +1,98 @@
+module Trello
+  # A custom field item contains the value for a custom field on a particular card.
+  #
+  class CustomFieldItem < BasicData
+    register_attributes :id, :model_id, :model_type, :custom_field_id, :value, :option_id,
+                        readonly: [ :id, :custom_field_id, :model_id, :model_type, :option_id ]
+    validates_presence_of :id, :model_id, :custom_field_id
+
+    # References the card with this custom field value
+    one :card, path: :cards, using: :model_id
+
+    # References the parent custom field that this item is an instance of
+    one :custom_field, path: 'customFields', using: :custom_field_id
+
+    # Update the fields of a custom field item.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item state.
+    def update_fields(fields)
+      if fields_has_key?(fields, 'value')
+        send('value_will_change!')
+      elsif fields_has_key?(fields, 'idValue')
+        send('option_id_will_change!')
+      end
+
+      initialize_fields(fields)
+    end
+
+    def initialize(fields = {})
+      initialize_fields(fields)
+    end
+
+    def update!
+      @previously_changed = changes
+      # extract only new values to build payload
+      payload = Hash[changes.map { |key, values| [key.to_sym, values[1]] }]
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
+
+      client.put("/card/#{model_id}/customField/#{custom_field_id}/item", payload)
+    end
+
+    # Saves a record.
+    #
+    # @raise [Trello::Error] if the card could not be saved
+    #
+    # @return [String] The JSON representation of the saved custom field item returned by
+    # the Trello API.
+    def save
+      # If we have an id, just update our fields.
+      return update! if id
+
+      from_response client.put("/card/#{model_id}/customField/#{custom_field_id}/item", {
+        value: value
+      })
+    end
+
+    # You can't "delete" a custom field item, you can only clear the value
+    def remove
+      params = { value: {} }
+      client.put("/card/#{model_id}/customField/#{custom_field_id}/item", params)
+    end
+
+    # Type is saved at the CustomField level
+    # Can equally be derived from :value, with a little parsing work: {"number": 42}
+    def type
+      custom_field.type
+    end
+
+    # Need to make another call to get the actual value if the custom field type == 'list'
+    def option_value
+      if option_id
+        option_endpoint = "/customFields/#{custom_field_id}/options/#{option_id}"
+        option = CustomFieldOption.from_response client.get(option_endpoint)
+        option.value
+      end
+    end
+
+    private
+
+    def fields_has_key?(fields, key)
+      fields.key?(key.to_s) || fields.key?(key.to_sym)
+    end
+
+    def initialize_fields(fields)
+      attributes[:id]               = fields['id'] || fields[:id] || attributes[:id]
+      attributes[:model_id]         = fields['idModel'] || fields[:model_id] || attributes[:model_id]
+      attributes[:custom_field_id]  = fields['idCustomField'] || fields[:custom_field_id] || attributes[:custom_field_id]
+      attributes[:model_type]       = fields['modelType'] || fields[:model_type] || attributes[:model_type]
+      # Dropdown custom field items do not have a value, they have an ID that maps to
+      # a different endpoint to get the value
+      attributes[:option_id]       = fields['idValue'] || fields[:idValue] if fields_has_key?(fields, 'idValue')
+      # value format: { "text": "hello world" }
+      attributes[:value]            = fields['value'] || fields[:value] if fields_has_key?(fields, 'value')
+      self
+    end
+  end
+end

data/lib/trello/custom_field_option.rb

@@ -0,0 +1,22 @@
+module Trello
+  # A custom field option contains the individual items in a custom field dropdown menu.
+  #
+  class CustomFieldOption < BasicData
+    register_attributes :id, :value, :pos, :color,
+                        readonly: [:id]
+    validates_presence_of :id, :value
+
+    # Update the fields of a custom field option.
+    #
+    # Supply a hash of string keyed data retrieved from the Trello API representing
+    # an item state.
+    def update_fields(fields)
+      attributes[:id]               = fields['_id'] || fields[:id] || attributes[:id]
+      attributes[:color]            = fields['color'] || fields[:color] || attributes[:color]
+      attributes[:pos]              = fields['pos'] || fields[:pos] || attributes[:pos]
+      # value format: { "text": "hello world" }
+      attributes[:value]            = fields['value'] || fields[:value] || attributes[:value]
+      self
+    end
+  end
+end

data/lib/trello/error.rb

@@ -0,0 +1,12 @@
+module Trello
+  class Error < StandardError
+
+    attr_reader :status_code
+
+    def initialize(message, status_code=nil)
+      @status_code = status_code
+      super(message)
+    end
+
+  end
+end

data/lib/trello/item.rb

@@ -20,13 +20,13 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # an item.
     def update_fields(fields)
-      attributes[:id]           = fields['id']
-      attributes[:card_id]      = fields['idCard']
-      attributes[:checklist_id] = fields['idChecklist']
-      attributes[:name]         = fields['name']
-      attributes[:type]         = fields['type']
-      attributes[:state]        = fields['state']
-      attributes[:pos]          = fields['pos']
+      attributes[:id]           = fields['id'] || attributes[:id]
+      attributes[:card_id]      = fields['idCard'] || attributes[:card_id]
+      attributes[:checklist_id] = fields['idChecklist'] || attributes[:checklist_id]
+      attributes[:name]         = fields['name'] || attributes[:name]
+      attributes[:type]         = fields['type'] || attributes[:type]
+      attributes[:state]        = fields['state'] || attributes[:state]
+      attributes[:pos]          = fields['pos'] || attributes[:pos]
       self
     end
 

data/lib/trello/item_state.rb

@@ -16,9 +16,9 @@ module Trello
     # Supply a hash of string keyed data retrieved from the Trello API representing
     # an item state.
     def update_fields(fields)
-      attributes[:id]      = fields['id']
-      attributes[:state]   = fields['state']
-      attributes[:item_id] = fields['idCheckItem']
+      attributes[:id]      = fields['id'] || attributes[:id]
+      attributes[:state]   = fields['state'] || attributes[:state]
+      attributes[:item_id] = fields['idCheckItem'] || attributes[:item_id]
       self
     end
 

data/lib/trello/label.rb

@@ -9,7 +9,7 @@ module Trello
   class Label < BasicData
     register_attributes :id, :name, :board_id, :uses,
       readonly: [ :id, :uses, :board_id ]
-    validates_presence_of :id, :uses, :board_id, :name
+    validates_presence_of :id, :board_id, :name
     validates_length_of   :name,        in: 1..16384
 
     SYMBOL_TO_STRING = {
@@ -23,7 +23,7 @@ module Trello
     class << self
       VALID_LABEL_COLOURS = %w{green yellow orange red purple blue sky lime pink black} << ''
 
-      # Find a specific card by its id.
+      # Find a specific label by its id.
       def find(id, params = {})
         client.find(:label, id, params)
       end
@@ -46,7 +46,7 @@ module Trello
     define_attribute_methods [:color]
 
     def color
-      @attributes[:color]
+      @__attributes[:color]
     end
 
     def color= colour
@@ -55,8 +55,8 @@ module Trello
         return Trello.logger.warn "The label colour '#{colour}' does not exist."
       end
 
-      self.send(:"color_will_change!") unless colour == @attributes[:color]
-      @attributes[:color] = colour
+      self.send(:"color_will_change!") unless colour == @__attributes[:color]
+      @__attributes[:color] = colour
     end
 
     # Update the fields of a label.
@@ -64,12 +64,14 @@ module Trello
     # Supply a hash of stringkeyed data retrieved from the Trello API representing
     # a label.
     def update_fields(fields)
-      attributes[:id] = fields['id']
-      attributes[:name]  = fields['name'] || fields[:name]
-      attributes[:color] = fields['color'] || fields[:color]
-      attributes[:board_id] = fields['idBoard'] || fields[:board_id]
-      attributes[:uses] = fields['uses']
-      self
+      send('name_will_change!') if fields_has_key?(fields, :name)
+      send('color_will_change!') if fields_has_key?(fields, :color)
+
+      initialize_fields(fields)
+    end
+
+    def initialize(fields = {})
+      initialize_fields(fields)
     end
 
     # Returns a reference to the board this label is currently connected.
@@ -95,7 +97,8 @@ module Trello
       @previously_changed = changes
       # extract only new values to build payload
       payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }]
-      @changed_attributes.clear
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
 
       client.put("/labels/#{id}", payload)
     end
@@ -104,5 +107,20 @@ module Trello
     def delete
       client.delete("/labels/#{id}")
     end
+
+    private
+
+    def fields_has_key?(fields, key)
+      fields.key?(SYMBOL_TO_STRING[key]) || fields.key?(key)
+    end
+
+    def initialize_fields(fields)
+      attributes[:id] = fields['id'] || attributes[:id]
+      attributes[:name]  = fields['name'] || fields[:name] || attributes[:name]
+      attributes[:color] = fields['color'] || fields[:color] || attributes[:color]
+      attributes[:board_id] = fields['idBoard'] || fields[:board_id] || attributes[:board_id]
+      attributes[:uses] = fields['uses'] if fields.has_key?('uses')
+      self
+    end
   end
 end