ruby-trello 2.0.1 → 3.0.0

data/lib/trello/cover_image.rb

@@ -4,5 +4,25 @@ module Trello
   # This is normally an attachment that the user (or trello) has set
   # as the cover image
   class CoverImage < Attachment
+    # Same with Attachment may need refactor it to support inheritance
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :position, readonly: true, remote_key: 'pos'
+      attribute :bytes, readonly: true
+      attribute :member_id, remote_key: 'idMember', readonly: true
+      attribute :date, serializer: 'Time', readonly: true
+      attribute :is_upload, remote_key: 'isUpload', readonly: true
+      attribute :previews, readonly: true
+      attribute :file_name, remote_key: 'fileName', readonly: true
+      attribute :edge_color, remote_key: 'edgeColor', readonly: true
+
+      # Writable but create only
+      attribute :name, create_only: true
+      attribute :url, create_only: true
+      attribute :mime_type, remote_key: 'mimeType', create_only: true
+      attribute :file, create_only: true
+      attribute :set_as_cover, remote_key: 'setCover', create_only: true
+    end
   end
 end

data/lib/trello/custom_field.rb

@@ -0,0 +1,78 @@
+module Trello
+  # A Custom Field can be activated on a board. Values are stored at the card level.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [rw] model_id
+  #   @return [String]
+  # @!attribute [rw] model_type
+  #   @return [String]
+  # @!attribute [r] field_group
+  #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [rw] position
+  #   @return [Float]
+  # @!attribute [rw] type
+  #   @return [String]
+  # @!attribute [rw] checkbox_options
+  #   @return [Array<Hash>]
+  # @!attribute [w] enable_display_on_card
+  #   @return [Boolean]
+  class CustomField < BasicData
+
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :field_group, readonly: true, remote_key: 'fieldGroup'
+
+      # Writable
+      attribute :name
+      attribute :position, remote_key: 'pos'
+      attribute :enable_display_on_card, remote_key: 'cardFront', class_name: 'CustomFieldDisplay'
+
+      # Writable but for create only
+      attribute :model_id, remote_key: 'idModel', create_only: true
+      attribute :model_type, remote_key: 'modelType', create_only: true
+      attribute :type, create_only: true
+      attribute :checkbox_options, remote_key: 'options', create_only: true
+    end
+
+    validates_presence_of :id, :model_id, :model_type, :name, :type, :position
+
+    class << self
+      # Find a custom field by its id.
+      def find(id, params = {})
+        client.find('customFields', id, params)
+      end
+    end
+
+    def collection_name
+      'customFields'
+    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'
+
+    # 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
+  end
+end

data/lib/trello/custom_field_item.rb

@@ -0,0 +1,76 @@
+module Trello
+  # A custom field item contains the value for a custom field on a particular card.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] model_id
+  #   @return [String]
+  # @!attribute [r] model_type
+  #   @return [String]
+  # @!attribute [r] custom_field_id
+  #   @return [String]
+  # @!attribute [r] option_id
+  #   @return [String]
+  # @!attribute [rw] value
+  #   @return [Hash]
+  class CustomFieldItem < BasicData
+
+    schema do
+      attribute :id, readonly: true, primary_key: true
+      attribute :model_id, readonly: true, remote_key: 'idModel'
+      attribute :model_type, readonly: true, remote_key: 'modelType'
+      attribute :custom_field_id, readonly: true, remote_key: 'idCustomField'
+      attribute :option_id, readonly: true, remote_key: 'idValue'
+
+      attribute :value
+    end
+
+    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
+
+    def save
+      return update! if id
+
+      payload = {}
+
+      schema.attrs.each do |_, attribute|
+        payload = attribute.build_payload_for_create(attributes, payload)
+      end
+
+      put(element_path, payload)
+    end
+
+    def collection_path
+      "/cards/#{model_id}/#{collection_name}"
+    end
+
+    def element_path
+      "/cards/#{model_id}/customField/#{custom_field_id}/item"
+    end
+
+    # You can't "delete" a custom field item, you can only clear the value
+    def remove
+      params = { value: {} }
+      client.put(element_path, params)
+    end
+
+    # Type is saved at the CustomField level
+    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
+  end
+end

data/lib/trello/custom_field_option.rb

@@ -0,0 +1,49 @@
+module Trello
+  # A custom field option contains the individual items in a custom field dropdown menu.
+  #
+  # @!attribute [r] id
+  #   @return [String]
+  # @!attribute [r] custom_field_id
+  #   @return [String]
+  # @!attribute [rw] value
+  #   @return [Hash]
+  # @!attribute [rw] color
+  #   @return [String]
+  # @!attribute [rw] position
+  #   @return [Float]
+  class CustomFieldOption < BasicData
+
+    schema do
+      # Readonly
+      attribute :id, remote_key: '_id', readonly: true, primary_key: true
+      attribute :custom_field_id, remote_key: 'idCustomField', readonly: true
+
+      # Writable but for create only
+      attribute :value, create_only: true
+      attribute :color, create_only: true
+      attribute :position, remote_key: 'pos', create_only: true
+    end
+
+    validates_presence_of :id, :value
+
+    def self.find(id, params = {})
+      params = params.with_indifferent_access
+      custom_field_id = params.delete(:custom_field_id)
+      return if custom_field_id.nil?
+
+      from_response client.get("/customFields/#{custom_field_id}/options/#{id}")
+    end
+
+    def delete
+      client.delete(element_path)
+    end
+
+    def collection_path
+      "/customFields/#{custom_field_id}/options"
+    end
+
+    def element_path
+      "/customFields/#{custom_field_id}/options/#{id}"
+    end
+  end
+end

data/lib/trello/item.rb

@@ -5,31 +5,42 @@ module Trello
   #   @return [String]
   # @!attribute [r] name
   #   @return [String]
+  # @!attribute [r] name_data
+  #   @return [String]
   # @!attribute [r] type
   #   @return [Object]
   # @!attribute [r] state
   #   @return [Object]
-  # @!attribute [r] pos
+  # @!attribute [r] position
   #   @return [Object]
+  # @!attribute [r] due_date
+  #   @return [Datetime]
+  # @!attribute [r] member_id
+  #   @return [String]
+  # @!attribute [r] checklist_id
+  #   @return [String]
+  # @!attribute [w] checked
+  #   @return [Boolean]
   class Item < BasicData
-    register_attributes :id, :name, :type, :state, :pos, readonly: [ :id, :name, :type, :state, :pos ]
-    validates_presence_of :id, :type
 
-    # Updates the fields of an item.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # an item.
-    def update_fields(fields)
-      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
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :type, readonly: true
+      attribute :name_data, readonly: true, remote_key: 'nameData'
+      attribute :due_date, readonly: true, remote_key: 'due', serializer: 'Time'
+      attribute :member_id, readonly: true, remote_key: 'idMember'
+      attribute :state, readonly: true
+      attribute :checklist_id, readonly: true, remote_key: 'idChecklist'
+
+      # Writable and write only
+      attribute :name, write_only: true
+      attribute :position, write_only: true, remote_key: 'pos'
+      attribute :checked, write_only: true
     end
 
+    validates_presence_of :id
+
     def complete?
       state == "complete"
     end

data/lib/trello/item_state.rb

@@ -5,26 +5,18 @@ module Trello
   #   @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 ]
-    validates_presence_of :id, :item_id
-
-    # Update the fields of an item state.
-    #
-    # 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[:id]
-      attributes[:state]   = fields['state'] || attributes[:state]
-      attributes[:item_id] = fields['idCheckItem'] || attributes[:item_id]
-      self
+    schema do
+      #Readonly
+      attribute :id, remote_key: 'idCheckItem', readonly: true, primary_key: true
+      attribute :state
     end
 
+    validates_presence_of :id
+
     # Return the item this state belongs to.
     def item
-      Item.find(item_id)
+      Item.find(id)
     end
   end
 end

data/lib/trello/json_utils.rb

@@ -7,7 +7,7 @@ module Trello
 
     module InstanceMethods
       def from_response(*args)
-        update_fields parse_json(*args)
+        initialize_fields parse_json(*args)
       end
 
       def parse_json(*args)

data/lib/trello/label.rb

@@ -6,103 +6,34 @@ module Trello
   #   @return [String]
   # @!attribute [rw] color
   #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [rw] board_id
+  #   @return [String]
   class Label < BasicData
-    register_attributes :id, :name, :board_id, :uses,
-      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',
-      board_id: 'idBoard',
-      color: 'color',
-      uses: 'uses'
-    }
-
-    class << self
-      VALID_LABEL_COLOURS = %w{green yellow orange red purple blue sky lime pink black} << ''
-
-      # Find a specific card by its id.
-      def find(id, params = {})
-        client.find(:label, id, params)
-      end
-
-      # Create a new label and save it on Trello.
-      def create(options)
-        client.create(:label,
-          'name' => options[:name],
-          'idBoard' => options[:board_id],
-          'color'   => options[:color],
-        )
-      end
-
-      # Label colours
-      def label_colours
-        VALID_LABEL_COLOURS
-      end
-    end
-
-    define_attribute_methods [:color]
 
-    def color
-      @attributes[:color]
-    end
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
 
-    def color= colour
-      unless Label.label_colours.include? colour
-        errors.add(:label, "color '#{colour}' does not exist")
-        return Trello.logger.warn "The label colour '#{colour}' does not exist."
-      end
+      # Writable
+      attribute :name
+      attribute :color
 
-      self.send(:"color_will_change!") unless colour == @attributes[:color]
-      @attributes[:color] = colour
+      # Writable but for create only
+      attribute :board_id, create_only: true, remote_key: 'idBoard'
     end
 
-    # Update the fields of a label.
-    #
-    # Supply a hash of stringkeyed data retrieved from the Trello API representing
-    # a label.
-    def update_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
+    validates_presence_of :id, :board_id, :name
+    validates_length_of :name, in: 1..16384
 
     # Returns a reference to the board this label is currently connected.
     one :board, path: :boards, using: :board_id
 
-    # Saves a record.
-    def save
-      # If we have an id, just update our fields.
-      return update! if id
-
-      from_response client.post("/labels", {
-        name:   name,
-        color:   color,
-        idBoard: board_id,
-      })
-    end
-
-    # Update an existing record.
-    # Warning, this updates all fields using values already in memory. If
-    # an external resource has updated these fields, you should refresh!
-    # this object before making your changes, and before updating the record.
-    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
-
-      client.put("/labels/#{id}", payload)
-    end
-
     # Delete this label
     def delete
       client.delete("/labels/#{id}")
     end
+
   end
 end