ruby-trello 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05525435b0e8308a1adc45db693f314a91a17bb9f565efd8a87048b0dee6a4c6
-  data.tar.gz: 96229c421c262dba867848a91b23149bce1f947bb4ef7b4df36d8cf5d1693f3a
+  metadata.gz: c36f88684585632f2f1fc785ea06cd651b6ba61105c1326e49cc9e4cbf1f5080
+  data.tar.gz: 1aeafd0ed644ac395d71ea296feac980ebd013f1b915c1caa99845c86c24d2b3
 SHA512:
-  metadata.gz: fc91f9504c4666af90366c3b9cf18f49e50fd7afee11a9a1f9ff1bbbf70da7ab786ec1a56ffcaa3ff8f608012d439f7d9ee8fd5050a2f7ad609bc5a8941d8b09
-  data.tar.gz: c9034334cc3d962272dad40e9beb781108ee729d2f86137faab7695bd9da00bd94789ecf2c41fcb33e83ddc3151a9f33d449bc52cffd215360958ed33402b511
+  metadata.gz: 4305a964e59f049220842e64dbd9df87dc4f94ff3a43825700178d2efeeae069dd607f718c6d1e027556921b20b6a2e187e92076d5debd85e314c916a61c5845
+  data.tar.gz: ba6056ba114bfb48cae07fad2acc4742641c3ef9c0adecdfbf0ee7f6aa4e6e08375ebbff6978918e4f1979c9a2b6ed33d29c1a846b6e89446b848e0cfb84576d

data/README.md

@@ -1,8 +1,6 @@
 # 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)
-[![security](https://hakiri.io/github/jeremytregunna/ruby-trello/master.svg)](https://hakiri.io/github/jeremytregunna/ruby-trello/master)
+[![Ruby](https://github.com/jeremytregunna/ruby-trello/actions/workflows/main.yml/badge.svg)](https://github.com/jeremytregunna/ruby-trello/actions/workflows/main.yml)
 [![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/).
@@ -12,20 +10,34 @@ 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).
+| Ruby  \  ActiveModel | 4.2 | 5.2 | 6.0 | 6.1 | 7.0 |
+| ---- | ---- | ---- | ---- | ---- | ---- |
+| 2.5 | ✅ | ✅ | ✅ | ✅ | ❌ |
+| 2.6 | ✅ | ✅ | ✅ | ✅ | ❌ |
+| 2.7 | ❌ | ✅ | ✅ | ✅ | ✅ |
+| 3.0 | ❌ | ❌ | ✅ | ✅ | ✅ |
+| 3.1 | ❌ | ❌ | ✅ | ✅ | ✅ |
+| jRuby 9.3 | ✅ | ✅ | ✅ | ✅ | ❌ |
 
-Supports Ruby 2.1.0 or newer.
+Use the newest version for Ruby 2.5.0 or newer support.
+
+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:
@@ -181,3 +193,44 @@ 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
+
+Use [matrixeval-ruby](https://github.com/MatrixEval/matrixeval-ruby) to test code againsts different ruby and active_model versions on local.
+
+Check available commands with:
+
+```bash
+matrixeval --help
+# Or
+meval --help
+```
+
+### Some examples:
+
+Generate MatrixEval config file
+
+```bash
+matrixeval init
+```
+
+Run bundle install
+
+```bash
+matrixeval --all bundle install
+```
+
+Run tests
+
+```bash
+matrixeval --all rspec
+matrixeval --ruby 3.0 rspec spec/a_spec.rb
+matrixeval --ruby 3.0 --active_model 7.0 rspec
+```
+
+Bash
+
+```bash
+matrixeval bash
+matrixeval --ruby 3.0 --active_model 7.0 bash
+```

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/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

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_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_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_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

@@ -1,40 +1,53 @@
 module Trello
   # A file or url that is linked to a Trello card
   #
-  # @!attribute id
+  # @!attribute [r] id
   #   @return [String]
-  # @!attribute name
-  #   @return [String]
-  # @!attribute url
-  #   @return [String]
-  # @!attribute pos
+  # @!attribute [r] position
   #   @return [Float]
-  # @!attribute bytes
+  # @!attribute [r] bytes
   #   @return [Fixnum]
-  # @!attribute date
+  # @!attribute [r] member_id
+  #   @return [String]
+  # @!attribute [r] date
   #   @return [Datetime]
-  # @!attribute is_upload
+  # @!attribute [r] is_upload
   #   @return [Boolean]
-  # @!attribute mime_type
+  # @!attribute [r] previews
+  #   @return [Array]
+  # @!attribute [r] file_name
+  #   @return [String]
+  # @!attribute [r] edge_color
+  #   @return [String]
+  # @!attribute [rw] name
   #   @return [String]
+  # @!attribute [rw] url
+  #   @return [String]
+  # @!attribute [rw] mime_type
+  #   @return [String]
+  # @!attribute [w] file
+  #   @return [String]
+  # @!attribute [w] set_as_cover
+  #   @return [Boolean]
   class Attachment < BasicData
-    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[: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
+    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