ruby-trello 2.0.0 → 2.3.1

data/lib/trello/association_fetcher/has_one.rb

@@ -0,0 +1,25 @@
+module Trello
+  module AssociationFetcher
+    class HasOne
+      autoload :Params, 'trello/association_fetcher/has_one/params'
+      autoload :Fetch, 'trello/association_fetcher/has_one/fetch'
+
+      attr_reader :model, :name, :options
+
+      def initialize(model, name, options)
+        @model = model
+        @name = name
+        @options = options
+      end
+
+      def fetch
+        params = Params.new(
+          association_owner: model,
+          association_name: name,
+          association_options: options
+        )
+        Fetch.execute(params)
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_one/fetch.rb

@@ -0,0 +1,49 @@
+module Trello
+  module AssociationFetcher
+    class HasOne
+      class Fetch
+        class << self
+          def execute(params)
+            new(params).execute
+          end
+        end
+
+        def initialize(params)
+          @params = params
+        end
+
+        def execute
+          if association_restful_name
+            client.find(association_restful_name, association_restful_id)
+          else
+            association_class.find(association_restful_id)
+          end
+        end
+
+        private
+
+        attr_reader :params
+
+        def client
+          association_owner.client
+        end
+
+        def association_owner
+          params.association_owner
+        end
+
+        def association_restful_name
+          params.association_restful_name
+        end
+
+        def association_restful_id
+          params.association_restful_id
+        end
+
+        def association_class
+          params.association_class
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_one/params.rb

@@ -0,0 +1,36 @@
+module Trello
+  module AssociationFetcher
+    class HasOne
+      class Params
+        attr_reader :association_owner
+
+        def initialize(association_owner:, association_name:, association_options:)
+          @association_owner = association_owner
+          @association_name = association_name
+          @association_options = association_options || {}
+        end
+
+        def association_class
+          association_options[:via] || infer_class_on(association_name)
+        end
+
+        def association_restful_name
+          association_options[:path]
+        end
+
+        def association_restful_id
+          id_field = association_options[:using] || :id
+          association_owner.send(id_field)
+        end
+
+        private
+
+        attr_reader :association_name, :association_options
+
+        def infer_class_on(name)
+          AssociationInferTool.infer_class_on_name(name)
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_infer_tool.rb

@@ -0,0 +1,13 @@
+module Trello
+  class AssociationInferTool
+    class << self
+      def infer_restful_resource_on_class(klass)
+        klass.to_s.split('::').last.downcase.pluralize
+      end
+
+      def infer_class_on_name(name)
+        Trello.const_get(name.to_s.singularize.camelize)
+      end
+    end
+  end
+end

data/lib/trello/association_proxy.rb

@@ -31,7 +31,7 @@ module Trello
     end
 
     def to_ary
-      proxy_assocation.dup
+      proxy_assocation.target.dup
     end
     alias_method :to_a, :to_ary
 

data/lib/trello/attachment.rb

@@ -7,6 +7,8 @@ module Trello
   #   @return [String]
   # @!attribute url
   #   @return [String]
+  # @!attribute pos
+  #   @return [Float]
   # @!attribute bytes
   #   @return [Fixnum]
   # @!attribute date
@@ -16,21 +18,22 @@ module Trello
   # @!attribute mime_type
   #   @return [String]
   class Attachment < BasicData
-    register_attributes :name, :id, :url, :bytes, :member_id, :date, :is_upload, :mime_type, :previews
+    register_attributes :name, :id, :pos, :url, :bytes, :member_id, :date, :is_upload, :mime_type, :previews
     # Update the fields of an attachment.
     #
     # Supply a hash of stringkeyed data retrieved from the Trello API representing
     # an attachment.
     def update_fields(fields)
-      attributes[:name]      = fields['name']
-      attributes[:id]        = fields['id']
-      attributes[:url]       = fields['url']
-      attributes[:bytes]     = fields['bytes'].to_i
-      attributes[:member_id] = fields['idMember']
-      attributes[:date]      = Time.parse(fields['date'])
-      attributes[:is_upload] = fields['isUpload']
-      attributes[:mime_type] = fields['mimeType']
-      attributes[:previews]  = fields['previews']
+      attributes[:name]      = fields['name'] || attributes[:name]
+      attributes[:id]        = fields['id'] || attributes[:id]
+      attributes[:pos]       = fields['pos'] || attributes[:pos]
+      attributes[:url]       = fields['url'] || attributes[:url]
+      attributes[:bytes]     = fields['bytes'].to_i || attributes[:bytes]
+      attributes[:member_id] = fields['idMember'] || attributes[:member_id]
+      attributes[:date]      = Time.parse(fields['date']).presence || attributes[:date]
+      attributes[:is_upload] = fields['isUpload'] if fields.has_key?('isUpload')
+      attributes[:mime_type] = fields['mimeType'] || attributes[:mime_type]
+      attributes[:previews]  = fields['previews'] if fields.has_key?('previews')
       self
     end
   end

data/lib/trello/basic_data.rb

@@ -42,61 +42,20 @@ module Trello
       end
     end
 
-    def self.register_attributes(*names)
-      options = { readonly: [] }
-      options.merge!(names.pop) if names.last.kind_of? Hash
-
-      # Defines the attribute getter and setters.
-      class_eval do
-        define_method :attributes do
-          @attributes ||= names.reduce({}) { |hash, k| hash.merge(k.to_sym => nil) }
-        end
-
-        names.each do |key|
-          define_method(:"#{key}") { @attributes[key] }
+    def self.register_attributes(*names_and_options)
+      has_opts = names_and_options.last.kind_of?(Hash)
+      readonly_attributes = has_opts ? names_and_options.pop[:readonly] : []
+      attributes = names_and_options
 
-          unless options[:readonly].include?(key.to_sym)
-            define_method :"#{key}=" do |val|
-              send(:"#{key}_will_change!") unless val == @attributes[key]
-              @attributes[key] = val
-            end
-          end
-        end
-
-        define_attribute_methods names
-      end
+      RegisterAttributes.execute(self, attributes, readonly_attributes)
     end
 
     def self.one(name, opts = {})
-      class_eval do
-        define_method(:"#{name}") do |*args|
-          options = opts.dup
-          klass   = options.delete(:via) || Trello.const_get(name.to_s.camelize)
-          ident   = options.delete(:using) || :id
-          path    = options.delete(:path)
-
-          if path
-            client.find(path, self.send(ident))
-          else
-            klass.find(self.send(ident))
-          end
-        end
-      end
+      AssociationBuilder::HasOne.build(self, name, opts)
     end
 
     def self.many(name, opts = {})
-      class_eval do
-        define_method(:"#{name}") do |*args|
-          options   = opts.dup
-          resource  = options.delete(:in)  || self.class.to_s.split("::").last.downcase.pluralize
-          klass     = options.delete(:via) || Trello.const_get(name.to_s.singularize.camelize)
-          path = options.delete(:path) || name
-          params    = options.merge(args[0] || {})
-
-          resources = client.find_many(klass, "/#{resource}/#{id}/#{path}", params)
-          MultiAssociation.new(self, resources).proxy
-        end
-      end
+      AssociationBuilder::HasMany.build(self, name, opts)
     end
 
     def self.client
@@ -122,7 +81,15 @@ module Trello
 
     # Two objects are equal if their _id_ methods are equal.
     def ==(other)
-      id == other.id
+      self.class == other.class && id == other.id
+    end
+
+    # Alias hash equality to equality
+    alias eql? ==
+
+    # Delegate hash key computation to class and id pair
+    def hash
+      [self.class, id].hash
     end
 
     def client

data/lib/trello/board.rb

@@ -72,11 +72,12 @@ module Trello
       fail "Cannot save new instance." unless self.id
 
       @previously_changed = changes
-      @changed_attributes.clear
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
 
       fields = {
         name: attributes[:name],
-        description: attributes[:description],
+        desc: attributes[:description],
         closed: attributes[:closed],
         starred: attributes[:starred],
         idOrganization: attributes[:organization_id]
@@ -151,12 +152,25 @@ module Trello
     #
     # This method, when called, can take a hash table with a filter key containing any
     # of the following values:
-    #    :filter => [ :none, :normal, :owners, :all ] # default :all
+    #    :filter => [ :none, :normal, :owners, :admins, :all ] # default :all
     many :members, filter: :all
 
+    # Returns a list of checklists associated with the board.
+    #
+    # The options hash may have a filter key which can have its value set as any
+    # of the following values:
+    #    :filter => [ :none, :all ] # default :all
+    many :checklists, filter: :all
+
     # Returns a reference to the organization this board belongs to.
     one :organization, path: :organizations, using: :organization_id
 
+    # Returns a list of plugins associated with the board
+    many :plugin_data, path: "pluginData"
+
+    # Returns custom fields activated on this board
+    many :custom_fields, path: "customFields"
+
     def labels(params = {})
       # Set the limit to as high as possible given there is no pagination in this API.
       params[:limit] = 1000 unless params[:limit]

data/lib/trello/card.rb

@@ -169,35 +169,29 @@ module Trello
     #
     # @return [Trello::Card] self
     def update_fields(fields)
-      attributes[:id]                     = fields[SYMBOL_TO_STRING[:id]]
-      attributes[:short_id]               = fields[SYMBOL_TO_STRING[:short_id]]
-      attributes[:name]                   = fields[SYMBOL_TO_STRING[:name]] || fields[:name]
-      attributes[:desc]                   = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc]
-      attributes[:due]                    = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil
-      attributes[:due]                    ||= fields[:due]
-      attributes[:due_complete]           = fields[SYMBOL_TO_STRING[:due_complete]] || false
-      attributes[:closed]                 = fields[SYMBOL_TO_STRING[:closed]]
-      attributes[:url]                    = fields[SYMBOL_TO_STRING[:url]]
-      attributes[:short_url]              = fields[SYMBOL_TO_STRING[:short_url]]
-      attributes[:board_id]               = fields[SYMBOL_TO_STRING[:board_id]]
-      attributes[:member_ids]             = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids]
-      attributes[:list_id]                = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id]
-      attributes[:pos]                    = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos]
-      attributes[:labels]                 = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) }
-      attributes[:card_labels]            = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels]
-      attributes[:last_activity_date]     = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil
-      attributes[:cover_image_id]         = fields[SYMBOL_TO_STRING[:cover_image_id]]
-      attributes[:badges]                 = fields[SYMBOL_TO_STRING[:badges]]
-      attributes[:card_members]           = fields[SYMBOL_TO_STRING[:card_members]]
-      attributes[:source_card_id]         = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id]
-      attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties]
-      self
+      %i[
+        name desc due due_complete closed
+        board_id member_ids list_id pos
+        card_labels cover_image_id
+      ].each do |key|
+        send("#{key}_will_change!") if fields_has_key?(fields, key)
+      end
+
+      initialize_fields(fields)
+    end
+
+    def initialize(fields = {})
+      initialize_fields(fields)
     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.
     #
@@ -209,6 +203,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
@@ -221,9 +218,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
 
@@ -269,15 +264,41 @@ module Trello
     #
     # @raise [Trello::Error] if the card could not be updated.
     #
-    # @return [String] The JSON representation of the updated card returned by
-    #     the Trello API.
+    # @return [Trello::Card] updated self
     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)
+      response = client.put("/cards/#{id}", payload)
+      updated_card = from_response(response)
+
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
+
+      attributes[:id]                     = updated_card.id
+      attributes[:short_id]               = updated_card.short_id
+      attributes[:name]                   = updated_card.name
+      attributes[:desc]                   = updated_card.desc
+      attributes[:due]                    = updated_card.due
+      attributes[:due_complete]           = updated_card.due_complete
+      attributes[:closed]                 = updated_card.closed
+      attributes[:url]                    = updated_card.url
+      attributes[:short_url]              = updated_card.short_url
+      attributes[:board_id]               = updated_card.board_id
+      attributes[:member_ids]             = updated_card.member_ids
+      attributes[:list_id]                = updated_card.list_id
+      attributes[:pos]                    = updated_card.pos
+      attributes[:labels]                 = updated_card.labels
+      attributes[:card_labels]            = updated_card.card_labels
+      attributes[:last_activity_date]     = updated_card.last_activity_date
+      attributes[:cover_image_id]         = updated_card.cover_image_id
+      attributes[:badges]                 = updated_card.badges
+      attributes[:card_members]           = updated_card.card_members
+      attributes[:source_card_id]         = updated_card.source_card_id
+      attributes[:source_card_properties] = updated_card.source_card_properties
+
+      self
     end
 
     # Delete this card
@@ -312,7 +333,7 @@ module Trello
 
     # Is the record valid?
     def valid?
-      name && list_id
+      !(name && list_id).nil?
     end
 
     # Add a comment with the supplied text.
@@ -321,10 +342,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
@@ -342,6 +365,16 @@ module Trello
       end
     end
 
+    # Moves this card to the given list no matter which board it is on
+    def move_to_list_on_any_board(list_id)
+      list = List.find(list_id)
+      if board.id == list.board_id
+        move_to_list(list_id)
+      else
+        move_to_board(Board.find(list.board_id), list)
+      end
+    end
+
     # Move this card to the given board (and optional list on this board)
     def move_to_board(new_board, new_list = nil)
       unless board_id == new_board.id
@@ -353,14 +386,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
@@ -452,5 +485,37 @@ module Trello
     def me
       @me ||= Member.find(:me)
     end
+
+    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]] || 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
+
   end
 end