ruby-trello 2.0.1 → 3.0.0

data/lib/trello/card.rb

@@ -43,162 +43,54 @@ module Trello
   #   @return [Array<String>] Array of strings
 
   class Card < BasicData
-    register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url,
-      :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels,
-      :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties,
-      readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ]
+    schema do
+      # readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :short_id, readonly: true, remote_key: 'idShort'
+      attribute :url, readonly: true
+      attribute :short_url, readonly: true, remote_key: 'shortUrl'
+      attribute :last_activity_date, readonly: true, remote_key: 'dateLastActivity', serializer: 'Time'
+      attribute :labels, readonly: true, default: [], serializer: 'Labels'
+      attribute :badges, readonly: true
+      attribute :card_members, readonly: true, remote_key: 'members'
+
+      # Writable
+      attribute :name
+      attribute :desc
+      attribute :due, serializer: 'Time'
+      attribute :due_complete, remote_key: 'dueComplete'
+      attribute :member_ids, remote_key: 'idMembers'
+      attribute :list_id, remote_key: 'idList'
+      attribute :pos
+      attribute :card_labels, remote_key: 'idLabels'
+
+      # Writable but for create only
+      attribute :source_card_id, create_only: true, remote_key: 'idCardSource'
+      attribute :keep_from_source, create_only: true, remote_key: 'keepFromSource'
+
+      # Writable but for update only
+      attribute :closed, update_only: true
+      attribute :board_id, update_only: true, remote_key: 'idBoard'
+      attribute :cover_image_id, update_only: true, remote_key: 'idAttachmentCover'
+
+      # Deprecated
+      attribute :source_card_properties, create_only: true, remote_key: 'keepFromSource'
+    end
+
     validates_presence_of :id, :name, :list_id
     validates_length_of   :name, in: 1..16384
     validates_length_of   :desc, in: 0..16384
 
     include HasActions
 
-    SYMBOL_TO_STRING = {
-      id: 'id',
-      short_id: 'idShort',
-      name: 'name',
-      desc: 'desc',
-      due: 'due',
-      due_complete: 'dueComplete',
-      closed: 'closed',
-      url: 'url',
-      short_url: 'shortUrl',
-      board_id: 'idBoard',
-      member_ids: 'idMembers',
-      cover_image_id: 'idAttachmentCover',
-      list_id: 'idList',
-      pos: 'pos',
-      last_activity_date: 'dateLastActivity',
-      card_labels: 'idLabels',
-      labels: 'labels',
-      badges: 'badges',
-      card_members: 'members',
-      source_card_id: "idCardSource",
-      source_card_properties: "keepFromSource"
-    }
-
-    class << self
-      # Find a specific card by its id.
-      #
-      # @raise [Trello::Error] if the card could not be found.
-      #
-      # @return [Trello::Card]
-      def find(id, params = {})
-        client.find(:card, id, params)
-      end
-
-      # Create a new card and save it on Trello.
-      #
-      # If using source_card_id to duplicate a card, make sure to save
-      # the source card to Trello before calling this method to assure
-      # the correct data is used in the duplication.
-      #
-      # @param [Hash] options
-      # @option options [String] :name The name of the new card.
-      # @option options [String] :list_id ID of the list that the card should
-      #     be added to.
-      # @option options [String] :desc A string with a
-      #     length from 0 to 16384.
-      # @option options [String] :member_ids A comma-separated list of
-      #     objectIds (24-character hex strings).
-      # @option options [String] :card_labels A comma-separated list of
-      #     objectIds (24-character hex strings).
-      # @option options [Date] :due A date, or `nil`.
-      # @option options [String] :pos A position. `"top"`, `"bottom"`, or a
-      #     positive number. Defaults to `"bottom"`.
-      # @option options [String] :source_card_id ID of the card to copy
-      # @option options [String] :source_card_properties A single, or array of,
-      #     string properties to copy from source card.
-      #     `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`.
-      #     Defaults to `"all"`.
-      #
-      # @raise [Trello::Error] if the card could not be created.
-      #
-      # @return [Trello::Card]
-      def create(options)
-        client.create(:card,
-          'name' => options[:name],
-          'idList' => options[:list_id],
-          'desc'   => options[:desc],
-          'idMembers' => options[:member_ids],
-          'idLabels' => options[:card_labels],
-          'due' => options[:due],
-          'due_complete' => options[:due_complete] || false,
-          'pos' => options[:pos],
-          'idCardSource' => options[:source_card_id],
-          'keepFromSource' => options.key?(:source_card_properties) ? options[:source_card_properties] : 'all'
-        )
-      end
-    end
-
-    # Update the fields of a card.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # a card.
-    #
-    # Note that this this method does not save anything new to the Trello API,
-    # it just assigns the input attributes to your local object. If you use
-    # this method to assign attributes, call `save` or `update!` afterwards if
-    # you want to persist your changes to Trello.
-    #
-    # @param [Hash] fields
-    # @option fields [String] :id
-    # @option fields [String] :short_id
-    # @option fields [String] :name The new name of the card.
-    # @option fields [String] :desc A string with a length from 0 to
-    #     16384.
-    # @option fields [Date] :due A date, or `nil`.
-    # @option fields [Boolean] :due_complete
-    # @option fields [Boolean] :closed
-    # @option fields [String] :url
-    # @option fields [String] :short_url
-    # @option fields [String] :board_id
-    # @option fields [String] :member_ids A comma-separated list of objectIds
-    #     (24-character hex strings).
-    # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a
-    #     positive number. Defaults to `"bottom"`.
-    # @option fields [Array]  :labels An Array of Trello::Label objects
-    #     derived from the JSON response
-    # @option fields [String] :card_labels A comma-separated list of
-    #     objectIds (24-character hex strings).
-    # @option fields [Object] :cover_image_id
-    # @option fields [Object] :badges
-    # @option fields [Object] :card_members
-    # @option fields [String] :source_card_id
-    # @option fields [Array]  :source_card_properties
-    #
-    # @return [Trello::Card] self
-    def update_fields(fields)
-      attributes[:id]                     = fields[SYMBOL_TO_STRING[:id]] || attributes[:id]
-      attributes[:short_id]               = fields[SYMBOL_TO_STRING[:short_id]] || attributes[:short_id]
-      attributes[:name]                   = fields[SYMBOL_TO_STRING[:name]] || fields[:name] || attributes[:name]
-      attributes[:desc]                   = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] || attributes[:desc]
-      attributes[:due]                    = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil if fields.has_key?(SYMBOL_TO_STRING[:due])
-      attributes[:due]                    = fields[:due] if fields.has_key?(:due)
-      attributes[:due_complete]           = fields[SYMBOL_TO_STRING[:due_complete]] if fields.has_key?(SYMBOL_TO_STRING[:due_complete])
-      attributes[:due_complete]           ||= false
-      attributes[:closed]                 = fields[SYMBOL_TO_STRING[:closed]] if fields.has_key?(SYMBOL_TO_STRING[:closed])
-      attributes[:url]                    = fields[SYMBOL_TO_STRING[:url]] || attributes[:url]
-      attributes[:short_url]              = fields[SYMBOL_TO_STRING[:short_url]] || attributes[:short_url]
-      attributes[:board_id]               = fields[SYMBOL_TO_STRING[:board_id]] || attributes[:board_id]
-      attributes[:member_ids]             = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] || attributes[:member_ids]
-      attributes[:list_id]                = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] || attributes[:list_id]
-      attributes[:pos]                    = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] || attributes[:pos]
-      attributes[:labels]                 = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) }.presence || attributes[:labels].presence || []
-      attributes[:card_labels]            = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] || attributes[:card_labels]
-      attributes[:last_activity_date]     = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil if fields.has_key?(SYMBOL_TO_STRING[:last_activity_date])
-      attributes[:cover_image_id]         = fields[SYMBOL_TO_STRING[:cover_image_id]] || attributes[:cover_image_id]
-      attributes[:badges]                 = fields[SYMBOL_TO_STRING[:badges]] || attributes[:badges]
-      attributes[:card_members]           = fields[SYMBOL_TO_STRING[:card_members]] || attributes[:card_members]
-      attributes[:source_card_id]         = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] || attributes[:source_card_id]
-      attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] || attributes[:source_card_properties]
-      self
-    end
-
     # Returns a reference to the board this card is part of.
     one :board, path: :boards, using: :board_id
+
     # Returns a reference to the cover image attachment
-    one :cover_image, path: :attachments, using: :cover_image_id
+    def cover_image(params = {})
+      response = client.get("/cards/#{id}/attachments/#{cover_image_id}", params)
+      CoverImage.from_response(response)
+    end
 
     # Returns a list of checklists associated with the card.
     #
@@ -210,6 +102,9 @@ module Trello
     # Returns a list of plugins associated with the card
     many :plugin_data, path: "pluginData"
 
+    # List of custom field values on the card, only the ones that have been set
+    many :custom_field_items, path: 'customFieldItems'
+
     def check_item_states
       states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates")
       MultiAssociation.new(self, states).proxy
@@ -222,9 +117,7 @@ module Trello
     #
     # @return [Array<Trello::Member>]
     def members
-      members = member_ids.map do |member_id|
-        Member.from_response client.get("/members/#{member_id}")
-      end
+      members = Member.from_response client.get("/cards/#{self.id}/members")
       MultiAssociation.new(self, members).proxy
     end
 
@@ -238,49 +131,6 @@ module Trello
       Member.from_response client.get("/cards/#{id}/membersVoted")
     end
 
-    # Saves a record.
-    #
-    # @raise [Trello::Error] if the card could not be saved
-    #
-    # @return [String] The JSON representation of the saved card returned by
-    #     the Trello API.
-    def save
-      # If we have an id, just update our fields.
-      return update! if id
-
-      from_response client.post("/cards", {
-        name:   name,
-        desc:   desc,
-        idList: list_id,
-        idMembers: member_ids,
-        idLabels: card_labels,
-        pos: pos,
-        due: due,
-        dueComplete: due_complete,
-        idCardSource: source_card_id,
-        keepFromSource: source_card_properties
-      })
-    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.
-    #
-    # @raise [Trello::Error] if the card could not be updated.
-    #
-    # @return [String] The JSON representation of the updated card returned by
-    #     the Trello API.
-    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("/cards/#{id}", payload)
-    end
-
     # Delete this card
     #
     # @return [String] the JSON response from the Trello API
@@ -313,7 +163,7 @@ module Trello
 
     # Is the record valid?
     def valid?
-      name && list_id
+      !(name && list_id).nil?
     end
 
     # Add a comment with the supplied text.
@@ -322,10 +172,12 @@ module Trello
     end
 
     # Add a checklist to this card
-    def add_checklist(checklist)
-      client.post("/cards/#{id}/checklists", {
-        value: checklist.id
-      })
+    def add_checklist(checklist, name: nil, position: nil)
+      payload = { idChecklistSource: checklist.id }
+      payload[:name] = name if name 
+      payload[:pos] = position if position
+
+      client.post("/cards/#{id}/checklists", payload)
     end
 
     # create a new checklist and add it to this card
@@ -364,14 +216,14 @@ module Trello
 
     # Add a member to this card
     def add_member(member)
-      client.post("/cards/#{id}/members", {
+      client.post("/cards/#{id}/idMembers", {
         value: member.id
       })
     end
 
     # Remove a member from this card
     def remove_member(member)
-      client.delete("/cards/#{id}/members/#{member.id}")
+      client.delete("/cards/#{id}/idMembers/#{member.id}")
     end
 
     # Current authenticated user upvotes a card
@@ -463,5 +315,6 @@ module Trello
     def me
       @me ||= Member.find(:me)
     end
+
   end
 end

data/lib/trello/checklist.rb

@@ -5,78 +5,35 @@ module Trello
   #   @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
+  # @!attribute [rw] card_id
+  #   @return [String]
+  # @!attribute [w] source_checklist_id
+  #   @return [String]
   class Checklist < BasicData
-    register_attributes :id, :name, :description, :closed, :position, :url, :check_items, :board_id, :list_id, :card_id, :member_ids,
-                        readonly: [:id, :description, :closed, :url, :check_items, :board_id, :list_id, :card_id, :member_ids]
-    validates_presence_of :id, :board_id, :list_id
-    validates_length_of :name, in: 1..16384
-
-    class << self
-      # Locate a specific checklist by its id.
-      def find(id, params = {})
-        client.find(:checklist, id, params)
-      end
-
-      def create(options)
-        client.create(:checklist,
-                      'name' => options[:name],
-                      'idCard'  => options[:card_id])
-      end
-    end
+    schema do
+      attribute :id, readonly: true, primary_key: true
 
-    # Update the fields of a checklist.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # a checklist.
-    def update_fields(fields)
-      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
+      # Readonly
+      attribute :check_items, readonly: true, remote_key: 'checkItems'
+      attribute :board_id, readonly: true, remote_key: 'idBoard'
 
-    # Check if the checklist is currently active.
-    def closed?
-      closed
-    end
+      # Writable
+      attribute :name
+      attribute :position, remote_key: 'pos'
 
-    # Save a record.
-    def save
-      return update! if id
-
-      from_response(client.post("/checklists", {
-        name: name,
-        idCard: card_id
-      }))
+      # Writable but for update only
+      attribute :card_id, create_only: true, remote_key: 'idCard'
+      attribute :source_checklist_id, create_only: true, remote_key: 'idChecklistSource'
     end
 
-    def update!
-      from_response(client.put("/checklists/#{id}", {name: name, pos: position}))
-    end
+    validates_presence_of :id
+    validates_length_of :name, in: 1..16384
 
     # Return a list of items on the checklist.
     def items
@@ -91,17 +48,6 @@ module Trello
     # Return a reference to the card the checklist is on.
     one :card, path: :checklists, using: :card_id
 
-    # Return a reference to the list the checklist is on.
-    one :list, path: :lists, using: :list_id
-
-    # Return a list of members active in this checklist.
-    def members
-      members = member_ids.map do |member_id|
-        Member.find(member_id)
-      end
-      MultiAssociation.new(self, members).proxy
-    end
-
     # 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})

data/lib/trello/comment.rb

@@ -1,39 +1,50 @@
 module Trello
   # A Comment is a string with a creation date; it resides inside a Card and belongs to a User.
   #
-  # @!attribute [r] action_id
+  # @!attribute [r] id
   #   @return [String]
-  # @!attribute [r] text
+  # @!attribute [w] text
   #   @return [String]
   # @!attribute [r] date
   #   @return [Datetime]
-  # @!attribute [r] member_creator_id
+  # @!attribute [r] creator_id
   #   @return [String]
+  # @!attribute [r] data
+  #   @return [Hash]
+  # @!attribute [r] type
+  #   @return [String]
+  # @!attribute [r] limits
+  #   @return [Hash]
+  # @!attribute [r] app_creator
+  #   @return [String]
+  # @!attribute [r] display
+  #   @return [Hash]
   class Comment < BasicData
-    register_attributes :action_id, :text, :date, :member_creator_id,
-      readonly: [ :action_id, :text, :date, :member_creator_id ]
-    validates_presence_of :action_id, :text, :date, :member_creator_id
+
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :creator_id, readonly: true, remote_key: 'idMemberCreator'
+      attribute :data, readonly: true
+      attribute :type, readonly: true
+      attribute :date, readonly: true, serializer: 'Time'
+      attribute :limits, readonly: true
+      attribute :app_creator, readonly: true, remote_key: 'appCreator'
+      attribute :display, readonly: true
+
+      # Writable
+      attribute :text, update_only: true
+    end
+
+    validates_presence_of :action_id, :text, :date, :creator_id
     validates_length_of   :text,        in: 1..16384
 
     class << self
-      # Locate a specific action and return a new Comment object.
       def find(action_id)
-        client.find(:action, action_id, filter: commentCard)
+        client.find(:action, action_id)
       end
     end
 
-    # Update the attributes of a Comment
-    #
-    # 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[: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
-
     # Returns the board this comment is located
     def board
       Board.from_response client.get("/actions/#{action_id}/board")
@@ -55,8 +66,7 @@ module Trello
       client.delete(ruta)
     end
 
-
     # Returns the member who created the comment.
-    one :member_creator, via: Member, path: :members, using: :member_creator_id
+    one :member_creator, via: Member, path: :members, using: :creator_id
   end
 end