ruby-trello 2.3.1 → 3.2.0

data/lib/trello/schema/attribute/custom_field_display.rb

@@ -0,0 +1,45 @@
+module Trello
+  class Schema
+    module Attribute
+      class CustomFieldDisplay < Base
+
+        def build_attributes(params, attributes)
+          attrs = attributes.with_indifferent_access
+          params = params.with_indifferent_access
+
+          value = if params.key?(:display)
+                    params[:display][remote_key]
+                  else
+                    params[name]
+                  end
+
+          attrs[name] = serializer.deserialize(value, default)
+          attrs
+        end
+
+        def build_payload_for_create(attributes, payload)
+          payload ||= {}
+          return payload unless for_action?(:create)
+          return payload unless attributes.key?(name)
+
+          value = attributes[name]
+          return payload if value.nil?
+
+          payload["display_#{remote_key}"] = serializer.serialize(value)
+          payload
+        end
+
+        def build_payload_for_update(attributes, payload)
+          payload ||= {}
+          return payload unless for_action?(:update)
+          return payload unless attributes.key?(name)
+
+          value = attributes[name]
+          payload["display/#{remote_key}"] = serializer.serialize(value)
+          payload
+        end
+
+      end
+    end
+  end
+end

data/lib/trello/schema/attribute/default.rb

@@ -0,0 +1,45 @@
+module Trello
+  class Schema
+    module Attribute
+      class Default < Base
+
+        def build_attributes(params, attributes)
+          attrs = attributes.with_indifferent_access
+          params = params.with_indifferent_access
+
+          value = if params.key?(remote_key)
+                    params[remote_key]
+                  else
+                    params[name]
+                  end
+
+          attrs[name] = serializer.deserialize(value, default)
+          attrs
+        end
+
+        def build_payload_for_create(attributes, payload)
+          payload ||= {}
+          return payload unless for_action?(:create)
+          return payload unless attributes.key?(name)
+
+          value = attributes[name]
+          return payload if value.nil?
+
+          payload[remote_key] = serializer.serialize(value)
+          payload
+        end
+
+        def build_payload_for_update(attributes, payload)
+          payload ||= {}
+          return payload unless for_action?(:update)
+          return payload unless attributes.key?(name)
+
+          value = attributes[name]
+          payload[remote_key] = serializer.serialize(value)
+          payload
+        end
+
+      end
+    end
+  end
+end

data/lib/trello/schema/attribute_builder.rb

@@ -0,0 +1,42 @@
+module Trello
+  class Schema
+    class AttributeBuilder
+      class << self
+        def build(name, options = {})
+          new(name, options).build
+        end
+      end
+
+      attr_reader :name, :options
+
+      def initialize(name, options)
+        @name = name
+        @options = options
+      end
+
+      def build
+        attribute_class.new(
+          name: name,
+          options: options,
+          serializer: serializer
+        )
+      end
+
+      private
+
+      def attribute_class
+        class_name = options.delete(:class_name)
+        return Schema::Attribute::Default unless class_name
+
+        "Trello::Schema::Attribute::#{class_name}".constantize
+      end
+
+      def serializer
+        serializer_class_name = options.delete(:serializer)
+        return Schema::Serializer::Default unless serializer_class_name
+
+        "Trello::Schema::Serializer::#{serializer_class_name}".constantize
+      end
+    end
+  end
+end

data/lib/trello/schema/attribute_registration.rb

@@ -0,0 +1,47 @@
+module Trello
+  class Schema
+    class AttributeRegistration
+      class << self
+        def register(klass, attribute)
+          new(klass, attribute).register
+        end
+      end
+
+      attr_reader :klass, :attribute
+
+      def initialize(klass, attribute)
+        @klass = klass
+        @attribute = attribute
+      end
+
+      def register
+        define_getter
+        define_setter
+      end
+
+      private
+
+      def define_getter
+        attribute_name = attribute.name
+
+        klass.class_eval do
+          define_method(attribute_name) { @__attributes[attribute_name] }
+        end
+      end
+
+      def define_setter
+        return if attribute.readonly?
+
+        attribute_name = attribute.name
+
+        klass.class_eval do
+          define_method("#{attribute_name}=") do |value|
+            send("#{attribute_name}_will_change!") if value != @__attributes[attribute_name]
+            @__attributes[attribute_name] = value
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/trello/schema/serializer/default.rb

@@ -0,0 +1,17 @@
+module Trello
+  class Schema
+    module Serializer
+      class Default
+        class << self
+          def serialize(value)
+            value
+          end
+
+          def deserialize(value, default)
+            value == nil ? default : value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/schema/serializer/labels.rb

@@ -0,0 +1,23 @@
+module Trello
+  class Schema
+    module Serializer
+      class Labels
+        class << self
+          def serialize(labels)
+            labels.map(&:id)
+          end
+
+          def deserialize(labels, default)
+            return default unless labels
+
+            labels.map do |label|
+              next label if label.is_a?(Trello::Label)
+
+              Trello::Label.new(label)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/schema/serializer/time.rb

@@ -0,0 +1,25 @@
+module Trello
+  class Schema
+    module Serializer
+      class Time
+        class << self
+          def serialize(time)
+            return nil unless time.respond_to?(:iso8601)
+
+            time.strftime('%FT%T.%LZ')
+          end
+
+          def deserialize(time, default)
+            if time.is_a?(String)
+              ::Time.iso8601(time) rescue default
+            elsif time.respond_to?(:to_time)
+              time.to_time
+            else
+              default
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/schema/serializer/webhooks.rb

@@ -0,0 +1,25 @@
+module Trello
+  class Schema
+    module Serializer
+      class Webhooks
+        class << self
+          def serialize(webhooks)
+            webhooks ||= []
+
+            webhooks.map(&:id)
+          end
+
+          def deserialize(webhooks, default)
+            return default unless webhooks
+
+            webhooks.map do |webhook|
+              next webhook if webhook.is_a?(Trello::Webhook)
+
+              Trello::Webhook.new(webhook)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/schema.rb

@@ -0,0 +1,31 @@
+module Trello
+  class Schema
+    module Attribute
+      autoload :Base, 'trello/schema/attribute/base'
+      autoload :Default, 'trello/schema/attribute/default'
+      autoload :BoardPref, 'trello/schema/attribute/board_pref'
+      autoload :CustomFieldDisplay, 'trello/schema/attribute/custom_field_display'
+    end
+
+    module Serializer
+      autoload :Default, 'trello/schema/serializer/default'
+      autoload :Time, 'trello/schema/serializer/time'
+      autoload :Labels, 'trello/schema/serializer/labels'
+      autoload :Webhooks, 'trello/schema/serializer/webhooks'
+    end
+
+    autoload :AttributeBuilder, 'trello/schema/attribute_builder'
+    autoload :AttributeRegistration, 'trello/schema/attribute_registration'
+
+    attr_reader :attrs
+
+    def initialize
+      @attrs = ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    def attribute(name, options={})
+      @attrs[name] = AttributeBuilder.build(name, options)
+      self
+    end
+  end
+end

data/lib/trello/token.rb

@@ -2,17 +2,30 @@ module Trello
 
   # @!attribute [r] id
   #   @return [String]
+  # @!attribute [r] identifier
+  #   @return [String]
   # @!attribute [r] member_id
   #   @return [String]
   # @!attribute [r] created_at
   #   @return [Datetime]
+  # @!attribute [r] expires_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 ]
+
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :identifier, readonly: true
+      attribute :member_id, readonly: true, remote_key: 'idMember'
+      attribute :created_at, readonly: true, remote_key: 'dateCreated', serializer: 'Time'
+      attribute :expires_at, readonly: true, remote_key: 'dateExpires', serializer: 'Time'
+      attribute :permissions, readonly: true
+      attribute :webhooks, readonly: true, default: [], serializer: 'Webhooks'
+    end
 
     class << self
       # Finds a token
@@ -21,16 +34,6 @@ module Trello
       end
     end
 
-    # :nodoc:
-    def update_fields(fields)
-      attributes[:id]          = fields['id'] || attributes[:id]
-      attributes[:member_id]   = fields['idMember'] || attributes[:member_id]
-      attributes[:created_at]  = Time.iso8601(fields['dateCreated']) rescue nil if fields.has_key?('dateCreated')
-      attributes[:permissions] = fields['permissions'] || attributes[:permissions]
-      attributes[:permissions] ||= {}
-      attributes[:webhooks]    = fields['webhooks'] || attributes[:webhooks]
-    end
-
     # Returns a reference to the user who authorized the token.
     one :member, path: :members, using: :member_id
   end

data/lib/trello/webhook.rb

@@ -5,86 +5,33 @@ module Trello
   #   @return [String]
   # @!attribute [r] description
   #   @return [String]
-  # @!attribute [r] id_model
+  # @!attribute [r] model_id
   #   @return [String] A 24-character hex string
   # @!attribute [r] callback_url
   #   @return [String]
   # @!attribute [r] active
   #   @return [Boolean]
+  # @!attribute [r] consecutive_failures
+  #   @return [Integer]
+  # @!attribute [r] first_consecutive_fail_date
+  #   @return [Datetime]
   class Webhook < BasicData
-    register_attributes :id, :description, :id_model, :callback_url, :active,
-      readonly: [ :id ]
-    validates_presence_of :id, :id_model, :callback_url
-    validates_length_of   :description,  in: 1..16384
 
-    class << self
-      # Find a specific webhook by its ID.
-      #
-      # @raise [Trello::Error] if a Webhook with the given ID can't be found.
-      # @return [Trello::Webhook] the Webhook with the given ID.
-      def find(id, params = {})
-        client.find(:webhook, id, params)
-      end
-
-      # 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] :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,
-            'description' => options[:description],
-            'idModel'     => options[:id_model],
-            'callbackURL' => options[:callback_url])
-      end
-    end
-
-    # @return [Trello::Webhook] self
-    def update_fields(fields)
-      attributes[:id]              = fields['id'] || attributes[:id]
-      attributes[:description]     = fields['description'] || fields[:description] || attributes[:description]
-      attributes[:id_model]        = fields['idModel'] || fields[:id_model] || attributes[:id_model]
-      attributes[:callback_url]    = fields['callbackURL'] || fields[:callback_url] || attributes[:callback_url]
-      attributes[:active]          = fields['active'] if fields.has_key?('active')
-      self
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :consecutive_failures, readonly: true, remote_key: 'consecutiveFailures'
+      attribute :first_consecutive_fail_date, readonly: true, remote_key: 'firstConsecutiveFailDate', serializer: 'Time'
+
+      # Writable
+      attribute :description
+      attribute :model_id, remote_key: 'idModel'
+      attribute :callback_url, remote_key: 'callbackURL'
+      attribute :active
     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
-
-      from_response client.post("/webhooks", {
-        description: description,
-        idModel: id_model,
-        callbackURL: callback_url
-      })
-    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
-      })
-    end
+    validates_presence_of :id, :model_id, :callback_url
+    validates_length_of :description, in: 1..16384
 
     # Delete this webhook
     #

data/lib/trello.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 require 'oauth'
 require 'json'
 require 'logger'
 require 'active_model'
 require 'addressable/uri'
+require 'active_support/core_ext/hash/indifferent_access'
 
-# Ruby wrapper around the Trello[http://trello.com] API
+# Ruby wrapper around the [Trello] API
 #
-# First, set up your key information. You can get this information by {clicking here}[https://trello.com/1/appKey/generate].
+# First, set up your key information. You can get this information by [clicking here][trello-app-key].
 #
 # You can get the key by going to this url in your browser:
 # https://trello.com/1/authorize?key=TRELLO_CONSUMER_KEY_FROM_ABOVE&name=MyApp&response_type=token&scope=read,write,account&expiration=never
@@ -35,7 +38,11 @@ require 'addressable/uri'
 #
 # And so much more. Consult the rest of the documentation for more information.
 #
-# Feel free to {peruse and participate in our Trello board}[https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd]. It's completely open to the public.
+# Feel free to [peruse and participate in our Trello board][ruby-trello-board]. It's completely open to the public.
+#
+# [trello]: http://trello.com
+# [trello-app-key]: https://trello.com/app-key
+# [ruby-trello-board]: https://trello.com/board/ruby-trello/4f092b2ee23cb6fe6d1aaabd
 module Trello
   autoload :Error,                'trello/error'
   autoload :Action,               'trello/action'
@@ -65,12 +72,21 @@ module Trello
   autoload :Organization,         'trello/organization'
   autoload :PluginDatum,          'trello/plugin_datum'
   autoload :Request,              'trello/net'
+  autoload :Response,             'trello/net'
   autoload :TInternet,            'trello/net'
   autoload :Token,                'trello/token'
   autoload :Webhook,              'trello/webhook'
   autoload :JsonUtils,            'trello/json_utils'
   autoload :AssociationInferTool, 'trello/association_infer_tool'
-  autoload :RegisterAttributes,   'trello/register_attributes'
+  autoload :Schema,               'trello/schema'
+
+  module TFaraday
+    autoload :TInternet,          'trello/net/faraday'
+  end
+
+  module TRestClient
+    autoload :TInternet,          'trello/net/rest_client'
+  end
 
   module Authorization
     autoload :AuthPolicy,         'trello/authorization'
@@ -80,12 +96,12 @@ module Trello
 
   module AssociationFetcher
     autoload :HasMany,            'trello/association_fetcher/has_many'
-    autoload :HasOne,            'trello/association_fetcher/has_one'
+    autoload :HasOne,             'trello/association_fetcher/has_one'
   end
 
   module AssociationBuilder
     autoload :HasMany,            'trello/association_builder/has_many'
-    autoload :HasOne,            'trello/association_builder/has_one'
+    autoload :HasOne,             'trello/association_builder/has_one'
   end
 
   # Version of the Trello API that we use by default.
@@ -105,6 +121,45 @@ module Trello
     @logger = logger
   end
 
+  # The order in which we will try the http clients
+  HTTP_CLIENT_PRIORITY = %w(rest-client faraday)
+  HTTP_CLIENTS = {
+    'faraday' => Trello::TFaraday::TInternet,
+    'rest-client' => Trello::TRestClient::TInternet
+  }
+
+  def self.http_client
+    @http_client ||= begin
+      # No client has been set explicitly. Try to load each supported client.
+      # The first one that loads successfully will be used.
+      client = HTTP_CLIENT_PRIORITY.each do |key|
+        begin
+          require key
+          break HTTP_CLIENTS[key]
+        rescue LoadError
+          next
+        end
+      end
+
+      raise ConfigurationError, 'Trello requires either rest-client or faraday installed' unless client
+
+      client
+    end
+  end
+
+  def self.http_client=(http_client)
+    if HTTP_CLIENTS.include?(http_client)
+      begin
+        require http_client
+        @http_client = HTTP_CLIENTS[http_client]
+      rescue LoadError
+        raise ConfigurationError, "Trello tried to use #{http_client}, but that gem is not installed"
+      end
+    else
+      raise ArgumentError, "Unsupported HTTP client: #{http_client}"
+    end
+  end
+
   def self.client
     @client ||= Client.new
   end
@@ -116,6 +171,7 @@ module Trello
 
   def self.reset!
     @client = nil
+    @http_client = nil
   end
 
   def self.auth_policy; client.auth_policy; end
@@ -128,7 +184,6 @@ module Trello
 
   # Url to token for making authorized requests to the Trello API
   #
-  # @param [String, #read] contents the contents to reverse
   # @param options [Hash] Repository information to update
   # @option options [String] :name Name of the application
   # @option options [String] :key Application key

data/spec/action_spec.rb

@@ -131,8 +131,7 @@ module Trello
           'id' => 'id',
           'type' => 'type',
           'data' => 'data',
-          'idMemberCreator' => 'member_creator_id',
-          'member' => 'member_participant'
+          'idMemberCreator' => 'creator_id'
         }
 
         action = Action.new(expected)