ruby-trello 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b35b3b765d1056e69ec92a4d403439849c66edfdb01747d590d79026b7ac67
-  data.tar.gz: 35173e15c5deb8a4c8404831c2cb524e3b8283cc60ac69d0d9519b9b9b22d66c
+  metadata.gz: ae677a6fcb06809e76e329d2c56422280e7c6168f9c6951adb615b6e440fe3c5
+  data.tar.gz: 75bc42af47d3dd45252193f58fc120d6cf94d85984764a15e50c6fe4ad1c82da
 SHA512:
-  metadata.gz: 155bdc62579174c62bf3ade75dd2921cdfb29aa5ced74176d90ea62a94fa279f0e164a54cd0970392296fa04dec7d53a293d45bb188f9eeac3f662d23109f309
-  data.tar.gz: d4e75692b37cd6d1befa4d14dff5bce2acdca231a90287e898af1cadcaec4d5f006e8fb6ed05aeeb6982ab741a1f93e003bda3b8f3aa1eb9974fcdff9a6fd920
+  metadata.gz: da8feef2065ee82cb1c0b6ec35d6dd3be9dbca5e498cb1b1068360d985e91c1303c159b7c106b0f2bb0dfce3a109e6997ee19e31033d0e4e0ec22b53ccd5c00d
+  data.tar.gz: 955fe07038772f2419ff85d3eb126f45dc6ee454057aaba7fcbc5cbe240d322832a5eab8ab40082921d3c76f2b23d6e05d31a8737389d737ea56a28d4d75fcc8

data/README.md

@@ -1,7 +1,7 @@
 # Ruby Trello API
 
-[![Stories in Ready](http://badge.waffle.io/jeremytregunna/ruby-trello.png)](http://waffle.io/jeremytregunna/ruby-trello)
-[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.png)](http://travis-ci.org/jeremytregunna/ruby-trello) [![Dependency Status](https://gemnasium.com/jeremytregunna/ruby-trello.png)](https://gemnasium.com/jeremytregunna/ruby-trello)
+[![Build Status](https://secure.travis-ci.org/jeremytregunna/ruby-trello.svg)](http://travis-ci.org/jeremytregunna/ruby-trello)
+[![security](https://hakiri.io/github/jeremytregunna/ruby-trello/master.svg)](https://hakiri.io/github/jeremytregunna/ruby-trello/master)
 [![Code Climate](https://codeclimate.com/github/jeremytregunna/ruby-trello/badges/gpa.svg)](https://codeclimate.com/github/jeremytregunna/ruby-trello)
 
 This library implements the [Trello](http://www.trello.com/) [API](https://developers.trello.com/).
@@ -11,25 +11,30 @@ Seriously, [check it out](http://www.trello.com/).
 
 [Full API documentation](http://www.rubydoc.info/gems/ruby-trello).
 
-## Installation
+Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it
+to, please just [create an issue](https://github.com/jeremytregunna/ruby-trello/issues/new).
 
-```
-# gem install ruby-trello
-```
+## Requirements
 
-Full Disclosure: This library is mostly complete, if you do find anything missing or not functioning as you expect it
-to, please [let us know](https://trello.com/card/spot-a-bug-report-it/4f092b2ee23cb6fe6d1aaabd/17).
+Use the newest version for Ruby 2.5.0 or newer support. (Ruby 3 only works with ActiveModel 6 for now.)
 
-Supports Ruby 2.1.0 or newer.
+Use version 2.2.1 or earlier for Ruby 2.1 ~ 2.4 support.
 
 Use version 1.3.0 or earlier for Ruby 1.9.3 support.
+
 Use version 1.4.x or earlier for Ruby 2.0.0 support.
 
+## Installation
+
+```
+# gem install ruby-trello
+```
+
 ## Configuration
 
 #### Basic authorization:
 
-1. Get your API public key from Trello via the irb console:
+1. Get your API public key from Trello via [trello.com/app-key/](https://trello.com/app-key/) or the irb console as follows:
 
 ```
 $ gem install ruby-trello
@@ -180,3 +185,49 @@ Several ways you can contribute. Documentation, code, tests, feature requests, b
 If you submit a pull request that's accepted, you'll be given commit access to this repository.
 
 Please see the `CONTRIBUTING.md` file for more information.
+
+## Local Development
+
+Init all Gemfile.lock.* files
+
+```bash
+make init
+```
+
+Bundle install for all Ruby versions
+
+```bash
+make bundle:all
+```
+
+Run tests for all Ruby versions
+
+```bash
+make test:all
+```
+
+Run tests for each Ruby versions individual
+
+```bash
+make test:ruby_2_5
+make test:ruby_2_6
+make test:ruby_2_7
+make test:ruby_3_0
+make test:jruby_9_2
+```
+
+Do development for each Ruby versions individual
+
+```bash
+make dev:ruby_2_5
+make dev:ruby_2_6
+make dev:ruby_2_7
+make dev:ruby_3_0
+make dev:jruby_9_2
+```
+
+Recreate all Gemfile.lock.*
+
+```bash
+make gemfile:refresh
+```

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,42 +38,61 @@ 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'
-  autoload :Comment,           'trello/comment'
-  autoload :Association,       'trello/association'
-  autoload :AssociationProxy,  'trello/association_proxy'
-  autoload :Attachment,        'trello/attachment'
-  autoload :CoverImage,        'trello/cover_image'
-  autoload :BasicData,         'trello/basic_data'
-  autoload :Board,             'trello/board'
-  autoload :Card,              'trello/card'
-  autoload :Checklist,         'trello/checklist'
-  autoload :Client,            'trello/client'
-  autoload :Configuration,     'trello/configuration'
-  autoload :HasActions,        'trello/has_actions'
-  autoload :Item,              'trello/item'
-  autoload :CheckItemState,    'trello/item_state'
-  autoload :Label,             'trello/label'
-  autoload :LabelName,         'trello/label_name'
-  autoload :List,              'trello/list'
-  autoload :Member,            'trello/member'
-  autoload :MultiAssociation,  'trello/multi_association'
-  autoload :Notification,      'trello/notification'
-  autoload :Organization,      'trello/organization'
-  autoload :PluginDatum,       'trello/plugin_datum'
-  autoload :Request,           'trello/net'
-  autoload :TInternet,         'trello/net'
-  autoload :Token,             'trello/token'
-  autoload :Webhook,           'trello/webhook'
-  autoload :JsonUtils,         'trello/json_utils'
+  autoload :Error,                'trello/error'
+  autoload :Action,               'trello/action'
+  autoload :Comment,              'trello/comment'
+  autoload :Association,          'trello/association'
+  autoload :AssociationProxy,     'trello/association_proxy'
+  autoload :Attachment,           'trello/attachment'
+  autoload :CoverImage,           'trello/cover_image'
+  autoload :BasicData,            'trello/basic_data'
+  autoload :Board,                'trello/board'
+  autoload :Card,                 'trello/card'
+  autoload :Checklist,            'trello/checklist'
+  autoload :Client,               'trello/client'
+  autoload :Configuration,        'trello/configuration'
+  autoload :CustomField,          'trello/custom_field'
+  autoload :CustomFieldItem,      'trello/custom_field_item'
+  autoload :CustomFieldOption,    'trello/custom_field_option'
+  autoload :HasActions,           'trello/has_actions'
+  autoload :Item,                 'trello/item'
+  autoload :CheckItemState,       'trello/item_state'
+  autoload :Label,                'trello/label'
+  autoload :LabelName,            'trello/label_name'
+  autoload :List,                 'trello/list'
+  autoload :Member,               'trello/member'
+  autoload :MultiAssociation,     'trello/multi_association'
+  autoload :Notification,         'trello/notification'
+  autoload :Organization,         'trello/organization'
+  autoload :PluginDatum,          'trello/plugin_datum'
+  autoload :Request,              '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 :Schema,               'trello/schema'
 
   module Authorization
-    autoload :AuthPolicy,      'trello/authorization'
-    autoload :BasicAuthPolicy, 'trello/authorization'
-    autoload :OAuthPolicy,     'trello/authorization'
+    autoload :AuthPolicy,         'trello/authorization'
+    autoload :BasicAuthPolicy,    'trello/authorization'
+    autoload :OAuthPolicy,        'trello/authorization'
+  end
+
+  module AssociationFetcher
+    autoload :HasMany,            'trello/association_fetcher/has_many'
+    autoload :HasOne,             'trello/association_fetcher/has_one'
+  end
+
+  module AssociationBuilder
+    autoload :HasMany,            'trello/association_builder/has_many'
+    autoload :HasOne,             'trello/association_builder/has_one'
   end
 
   # Version of the Trello API that we use by default.
@@ -113,7 +135,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/lib/trello/action.rb

@@ -3,20 +3,40 @@ module Trello
   #
   # @!attribute [r] id
   #   @return [String]
-  # @!attribute [r] type
+  # @!attribute [r] creator_id
   #   @return [String]
   # @!attribute [r] data
   #   @return [Hash]
+  # @!attribute [r] type
+  #   @return [String]
   # @!attribute [r] date
   #   @return [Datetime]
-  # @!attribute [r] member_creator_id
+  # @!attribute [r] limits
+  #   @return [Hash]
+  # @!attribute [r] app_creator
+  #   @return [String]
+  # @!attribute [r] display
+  #   @return [Hash]
+  # @!attribute [w] text
   #   @return [String]
-  # @!attribute [r] member_participant
-  #   @return [Object]
   class Action < BasicData
-    register_attributes :id, :type, :data, :date, :member_creator_id, :member_participant,
-      readonly: [ :id, :type, :data, :date, :member_creator_id, :member_participant ]
-    validates_presence_of :id, :type, :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 :id, :type, :date, :creator_id
 
     class << self
       # Locate a specific action and return a new Action object.
@@ -33,20 +53,6 @@ module Trello
       end
     end
 
-    # Update the attributes of an action
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # an Action.
-    def update_fields(fields)
-      attributes[:id]                 = fields['id'] || attributes[:id]
-      attributes[:type]               = fields['type'] || attributes[:type]
-      attributes[:data]               = fields['data'] || attributes[:data]
-      attributes[:date]               = Time.iso8601(fields['date']) rescue nil if fields.has_key?('date')
-      attributes[:member_creator_id]  = fields['idMemberCreator'] || attributes[:member_creator_id]
-      attributes[:member_participant] = fields['member'] || attributes[:member_participant]
-      self
-    end
-
     # Returns the board this action occurred on.
     def board
       Board.from_response client.get("/actions/#{id}/board")
@@ -62,7 +68,9 @@ module Trello
       List.from_response client.get("/actions/#{id}/list")
     end
 
-    # Returns the member who created the action.
-    one :member_creator, via: Member, path: :members, using: :member_creator_id
+    # Returns the list the action occurred on.
+    def member_creator
+      Member.from_response client.get("/actions/#{id}/memberCreator")
+    end
   end
 end

data/lib/trello/association_builder/has_many.rb

@@ -0,0 +1,17 @@
+module Trello
+  module AssociationBuilder
+    class HasMany
+      class << self
+        def build(model_klass, name, options)
+          model_klass.class_eval do
+            define_method(name) do |*args|
+              has_many_fetcher = AssociationFetcher::HasMany.new(self, name, options)
+              filter_params = args[0] || {}
+              has_many_fetcher.fetch(filter_params)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_builder/has_one.rb

@@ -0,0 +1,16 @@
+module Trello
+  module AssociationBuilder
+    class HasOne
+      class << self
+        def build(model_klass, name, options)
+          model_klass.class_eval do
+            define_method(name) do |*args|
+              has_one_fetcher = AssociationFetcher::HasOne.new(self, name, options)
+              has_one_fetcher.fetch
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/association_fetcher/has_many.rb

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

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

@@ -0,0 +1,47 @@
+module Trello
+  module AssociationFetcher
+    class HasMany
+      class Fetch
+        class << self
+          def execute(params)
+            new(params).execute
+          end
+        end
+
+        attr_reader :params
+
+        def initialize(params)
+          @params = params
+        end
+
+        def execute
+          resources = client.find_many(association_class, path, filter_params)
+
+          MultiAssociation.new(association_owner, resources).proxy
+        end
+
+        private
+
+        def client
+          association_owner.client
+        end
+
+        def association_class
+          params.association_class
+        end
+
+        def path
+          params.fetch_path
+        end
+
+        def filter_params
+          params.filter_params
+        end
+
+        def association_owner
+          params.association_owner
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module Trello
+  module AssociationFetcher
+    class HasMany
+      class Params
+        attr_reader :association_owner
+
+        def initialize(association_owner:, association_name:, association_options:, filter:)
+          @association_owner = association_owner
+          @association_name = association_name
+          @association_options = association_options || {}
+          @filter = filter || {}
+        end
+
+        def association_class
+          association_options[:via] || infer_class_on(association_name)
+        end
+
+        def fetch_path
+          "/#{parent_restful_resource}/#{parent_restful_resource_id}/#{target_restful_resource}"
+        end
+
+        def filter_params
+          default_filter.merge(filter)
+        end
+
+        private
+
+        attr_reader :association_name, :association_options, :filter
+
+        def default_filter
+          association_options.reject { |k, _| %w[via in path].include?(k.to_s) }
+        end
+
+        def parent_restful_resource
+          association_options[:in] || infer_restful_resource_on(association_owner.class)
+        end
+
+        def parent_restful_resource_id
+          association_owner.id
+        end
+
+        def target_restful_resource
+          association_options[:path] || association_name
+        end
+
+        def infer_restful_resource_on(klass)
+          AssociationInferTool.infer_restful_resource_on_class(klass)
+        end
+
+        def infer_class_on(name)
+          AssociationInferTool.infer_class_on_name(name)
+        end
+      end
+    end
+  end
+end