ruby-trello 2.3.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7396e189c2f3b43af4bf1eacbdd78ec358ef684d2526d7c3537c1af1ca4abd
-  data.tar.gz: c8e2c74d10eaedb521829b3598e4500119c8fbfdd8c8cd71758254580eee1079
+  metadata.gz: 46d6d62edf1eb8973cfea687f157402b32ab4741b4f5cf3c638dd3b2704d5ad8
+  data.tar.gz: a31459e8d18d04b759be5ec6385b9fa75e55250fb691b37c484a639a799f8ee6
 SHA512:
-  metadata.gz: 1d441be6f124b3dd47ff332da22ccbf71eb201ff90ddf82775fc3f208eb6621dd10acc2cff21c81d30231d9b50f4aa9cf867cf66d26e9c894e16f1a1596a11fa
-  data.tar.gz: 647e16d5104ba1cf8dc3a7811117f168d6e132503e4b0989e8316a8abd9b30f3401cc04814da202cb4fc74846c5b9dee88a80fc36358fa0cd9c5f65340aba97b
+  metadata.gz: ca3cffbb4c3e0b3ce88ec21dade8b5a21bf0b2bedb2cdb259523fac0986632d521eb04f3c607273192cd4ce617b73005152507dedfa42c370b51cf75e4d1ec45
+  data.tar.gz: 7b13d2e420d26fde4cdd62e09f7f199dd170102272f17c630554c2156aaee2ddc2f2f76a62a67707df23d252ce2723edd5de1b6697b64ca7ef2b9f30c6f56c15

data/README.md

@@ -1,7 +1,6 @@
 # Ruby Trello API
 
-[![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)
+[![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/).
@@ -16,9 +15,21 @@ to, please just [create an issue](https://github.com/jeremytregunna/ruby-trello/
 
 ## Requirements
 
+| 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 | ✅ | ✅ | ✅ | ✅ | ❌ |
+
 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
@@ -76,7 +87,19 @@ end
 
 All the calls this library makes to Trello require authentication using these keys. Be sure to protect them.
 
-#### Usage
+#### HTTP Client
+
+By default, ruby-trello uses [rest-client](https://rubygems.org/gems/rest-client) for network calls. You can configure ruby-trello to use either rest-client or [faraday](https://rubygems.org/gems/faraday), depending on your project's needs. In the next major version, ruby-trello will not require either gem in the gemspec and will default to faraday if both are present.
+
+```ruby
+Trello.configure do |config|
+  config.http_client = 'rest-client'
+  # OR
+  config.http_client = 'faraday'
+end
+```
+
+## Usage
 
 So let's say you want to get information about the user *bobtester*. We can do something like this:
 
@@ -92,7 +115,7 @@ puts bob.bio # A wonderfully delightful test user
 # How about a list of his boards?
 bob.boards
 
-# And then to read the lists of the first board do : 
+# And then to read the lists of the first board do :
 bob.boards.first.lists
 ```
 
@@ -119,10 +142,10 @@ pp Trello::Card.find( card_id ).checklists
 
 ##### Changing a checkbox state
 ```ruby
-# First get your checklist id 
+# First get your checklist id
 checklist = Trello::Checklist.find( checklist_id )
 
-# At this point, there is no more ids. To get your checklist item, 
+# At this point, there is no more ids. To get your checklist item,
 # you have to know it's position (same as in the trello interface).
 # Let's take the first
 checklist_item = checklist.items.first
@@ -185,38 +208,41 @@ Please see the `CONTRIBUTING.md` file for more information.
 
 ## Local Development
 
-Init all Gemfile.lock.* files
+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
-make init
+matrixeval --help
+# Or
+meval --help
 ```
 
-Bundle install for all Ruby versions
+### Some examples:
+
+Generate MatrixEval config file
 
 ```bash
-make bundle:all
+matrixeval init
 ```
 
-Run tests for all Ruby versions
+Run bundle install
 
 ```bash
-make test:all
+matrixeval --all bundle install
 ```
 
-Run tests for each Ruby versions individual
+Run tests
 
 ```bash
-make test:ruby_2_5
-make test:ruby_2_6
-make test:ruby_2_7
-make test:jruby_9_2
+matrixeval --all rspec
+matrixeval --ruby 3.0 rspec spec/a_spec.rb
+matrixeval --ruby 3.0 --active_model 7.0 rspec
 ```
 
-Do development for each Ruby versions individual
+Bash
 
 ```bash
-make dev:ruby_2_5
-make dev:ruby_2_6
-make dev:ruby_2_7
-make dev:jruby_9_2
-```
+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")

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

data/lib/trello/basic_data.rb

@@ -42,12 +42,21 @@ module Trello
       end
     end
 
-    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
+    def self.schema(&block)
+      @schema ||= Schema.new
+      return @schema unless block_given?
 
-      RegisterAttributes.execute(self, attributes, readonly_attributes)
+      @schema.instance_eval(&block)
+
+      register_attrs
+
+      @schema
+    end
+
+    def self.register_attrs
+      schema.attrs.values.each do |attribute|
+        attribute.register(self)
+      end
     end
 
     def self.one(name, opts = {})
@@ -62,16 +71,72 @@ module Trello
       Trello.client
     end
 
-    register_attributes :id, readonly: [ :id ]
-
     attr_writer :client
 
     def initialize(fields = {})
-      update_fields(fields)
+      initialize_fields(fields)
+    end
+
+    def save
+      return update! if id
+
+      payload = {}
+
+      schema.attrs.each do |_, attribute|
+        payload = attribute.build_payload_for_create(attributes, payload)
+      end
+
+      post(collection_path, payload)
+    end
+
+    def update!
+      fail "Cannot save new instance." unless id
+
+      @previously_changed = changes
+
+      payload = {}
+      changed_attrs = attributes.select {|name, _| changed.include?(name.to_s)}
+
+      schema.attrs.each do |_, attribute|
+        payload = attribute.build_payload_for_update(changed_attrs, payload)
+      end
+
+      from_response client.put(element_path, payload)
+
+      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
+      changes_applied if respond_to?(:changes_applied)
+
+      self
     end
 
     def update_fields(fields)
-      raise NotImplementedError, "#{self.class} does not implement update_fields."
+      attrs = {}
+
+      schema.attrs.each do |_, attribute|
+        attrs = attribute.build_pending_update_attributes(fields, attrs)
+      end
+
+      attrs.each do |name, value|
+        send("#{name}=", value)
+      end
+
+      self
+    end
+
+    def collection_path
+      "/#{collection_name}"
+    end
+
+    def element_path
+      "/#{collection_name}/#{id}"
+    end
+
+    def collection_name
+      @collection_path ||= ActiveSupport::Inflector.pluralize(element_name)
+    end
+
+    def element_name
+      @element_name ||= model_name.element
     end
 
     # Refresh the contents of our object.
@@ -95,5 +160,35 @@ module Trello
     def client
       @client ||= self.class.client
     end
+
+    def schema
+      self.class.schema
+    end
+
+    def attributes
+      @__attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+    end
+
+    private
+
+    def attributes=(attrs)
+      @__attributes = attrs
+    end
+
+    def initialize_fields(fields)
+      schema.attrs.each do |_, attribute|
+        self.attributes = attribute.build_attributes(fields, attributes)
+      end
+
+      self
+    end
+
+    def post(path, body)
+      from_response client.post(path, body)
+    end
+
+    def put(path, body)
+      from_response client.put(path, body)
+    end
   end
 end

data/lib/trello/board.rb

@@ -4,21 +4,100 @@ module Trello
   #
   # @!attribute [r] id
   #   @return [String]
-  # @!attribute [r] name
+  # @!attribute [r] starred
+  #   @return [Boolean]
+  # @!attribute [r] pinned
+  #   @return [Boolean]
+  # @!attribute [r] url
+  #   @return [String]
+  # @!attribute [r] short_url
+  #   @return [String]
+  # @!attribute [r] prefs
+  #   @return [Hash]
+  # @!attribute [r] last_activity_date
+  #   @return [Datetime]
+  # @!attribute [r] description_data
+  #   @return [Datetime]
+  # @!attribute [r] enterprise_id
+  #   @return [String]
+  # @!attribute [rw] name
   #   @return [String]
   # @!attribute [rw] description
   #   @return [String]
-  # @!attribute [rw] closed
+  # @!attribute [rw] organization_id
+  #   @return [String]
+  # @!attribute [rw] visibility_level
+  #   @return [String]
+  # @!attribute [rw] voting_permission_level
+  #   @return [String]
+  # @!attribute [rw] comment_permission_level
+  #   @return [String]
+  # @!attribute [rw] invitation_permission_level
+  #   @return [String]
+  # @!attribute [rw] enable_self_join
   #   @return [Boolean]
-  # @!attribute [r] url
+  # @!attribute [rw] enable_card_covers
+  #   @return [Boolean]
+  # @!attribute [rw] background_color
   #   @return [String]
-  # @!attribute [rw] organization_id
-  #   @return [String] A 24-character hex string
-  # @!attribute [r] prefs
-  #   @return [Hash] A 24-character hex string
+  # @!attribute [rw] background_image
+  #   @return [String]
+  # @!attribute [rw] card_aging_type
+  #   @return [String]
+  # @!attribute [w] use_default_labels
+  #   @return [Boolean]
+  # @!attribute [w] use_default_lists
+  #   @return [Boolean]
+  # @!attribute [w] source_board_id
+  #   @return [String]
+  # @!attribute [w] keep_cards_from_source
+  #   @return [String]
+  # @!attribute [w] power_ups
+  #   @return [String]
+  # @!attribute [rw] closed
+  #   @return [Boolean]
+  # @!attribute [w] subscribed
+  #   @return [Boolean]
   class Board < BasicData
-    register_attributes :id, :name, :description, :closed, :starred, :url, :organization_id, :prefs, :last_activity_date,
-      readonly: [ :id, :url, :last_activity_date ]
+    schema do
+      attribute :id, readonly: true, primary_key: true
+
+      # Readonly
+      attribute :starred, readonly: true
+      attribute :pinned, readonly: true
+      attribute :url, readonly: true
+      attribute :short_url, readonly: true, remote_key: 'shortUrl'
+      attribute :prefs, readonly: true, default: {}
+      attribute :last_activity_date, readonly: true, remote_key: 'dateLastActivity', serializer: 'Time'
+      attribute :description_data, readonly: true, remote_key: 'descData'
+      attribute :enterprise_id, readonly: true, remote_key: 'idEnterprise'
+
+      # Writable
+      attribute :name
+      attribute :description, remote_key: 'desc'
+      attribute :organization_id, remote_key: 'idOrganization'
+      attribute :visibility_level, remote_key: 'permissionLevel', class_name: 'BoardPref'
+      attribute :voting_permission_level, remote_key: 'voting', class_name: 'BoardPref'
+      attribute :comment_permission_level, remote_key: 'comments', class_name: 'BoardPref'
+      attribute :invitation_permission_level, remote_key: 'invitations', class_name: 'BoardPref'
+      attribute :enable_self_join, remote_key: 'selfJoin', class_name: 'BoardPref'
+      attribute :enable_card_covers, remote_key: 'cardCovers', class_name: 'BoardPref'
+      attribute :background_color, remote_key: 'background', class_name: 'BoardPref'
+      attribute :background_image, remote_key: 'backgroundImage', class_name: 'BoardPref'
+      attribute :card_aging_type, remote_key: 'cardAging', class_name: 'BoardPref'
+
+      # Writable but for create only
+      attribute :use_default_labels, create_only: true, remote_key: 'defaultLabels'
+      attribute :use_default_lists, create_only: true, remote_key: 'defaultLists'
+      attribute :source_board_id, create_only: true, remote_key: 'idBoardSource'
+      attribute :keep_cards_from_source, create_only: true, remote_key: 'keepFromSource'
+      attribute :power_ups, create_only: true, remote_key: 'powerUps'
+
+      # Writable but for update only
+      attribute :closed, update_only: true
+      attribute :subscribed, update_only: true
+    end
+
     validates_presence_of :id, :name
     validates_length_of   :name,        in: 1..16384
     validates_length_of   :description, maximum: 16384
@@ -26,82 +105,12 @@ module Trello
     include HasActions
 
     class << self
-      # Finds a board.
-      #
-      # @param [String] id Either the board's short ID (an alphanumeric string,
-      #     found e.g. in the board's URL) or its long ID (a 24-character hex
-      #     string.)
-      # @param [Hash] params
-      #
-      # @raise  [Trello::Board] if a board with the given ID could not be found.
-      #
-      # @return [Trello::Board]
-      def find(id, params = {})
-        client.find(:board, id, params)
-      end
-
-      def create(fields)
-        data = {
-          'name'   => fields[:name],
-          'desc'   => fields[:description],
-          'closed' => fields[:closed] || false,
-          'starred' => fields[:starred] || false }
-        data.merge!('idOrganization' => fields[:organization_id]) if fields[:organization_id]
-        data.merge!('prefs' => fields[:prefs]) if fields[:prefs]
-        client.create(:board, data)
-      end
-
       # @return [Array<Trello::Board>] all boards for the current user
       def all
         from_response client.get("/members/#{Member.find(:me).username}/boards")
       end
     end
 
-    def save
-      return update! if id
-
-      fields = { name: name }
-      fields.merge!(desc: description) if description
-      fields.merge!(idOrganization: organization_id) if organization_id
-      fields.merge!(flat_prefs)
-
-      from_response(client.post("/boards", fields))
-    end
-
-    def update!
-      fail "Cannot save new instance." unless self.id
-
-      @previously_changed = changes
-      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
-      changes_applied if respond_to?(:changes_applied)
-
-      fields = {
-        name: attributes[:name],
-        desc: attributes[:description],
-        closed: attributes[:closed],
-        starred: attributes[:starred],
-        idOrganization: attributes[:organization_id]
-      }
-      fields.merge!(flat_prefs)
-
-      from_response client.put("/boards/#{self.id}/", fields)
-    end
-
-    def update_fields(fields)
-      attributes[:id]              = fields['id'] || fields[:id]                          if fields['id']   || fields[:id]
-      attributes[:name]            = fields['name'] || fields[:name]                      if fields['name'] || fields[:name]
-      attributes[:description]     = fields['desc'] || fields[:desc]                      if fields['desc'] || fields[:desc]
-      attributes[:closed]          = fields['closed']                                     if fields.has_key?('closed')
-      attributes[:closed]          = fields[:closed]                                      if fields.has_key?(:closed)
-      attributes[:starred]         = fields['starred']                                    if fields.has_key?('starred')
-      attributes[:starred]         = fields[:starred]                                     if fields.has_key?(:starred)
-      attributes[:url]             = fields['url']                                        if fields['url']
-      attributes[:organization_id] = fields['idOrganization'] || fields[:organization_id] if fields['idOrganization'] || fields[:organization_id]
-      attributes[:prefs]           = fields['prefs'] || fields[:prefs] || {}
-      attributes[:last_activity_date] = Time.iso8601(fields['dateLastActivity']) rescue nil
-      self
-    end
-
     # @return [Boolean]
     def closed?
       attributes[:closed]
@@ -188,28 +197,5 @@ module Trello
       "/boards/#{id}"
     end
 
-    private
-
-    # On creation
-    # https://trello.com/docs/api/board/#post-1-boards
-    # - permissionLevel
-    # - voting
-    # - comments
-    # - invitations
-    # - selfJoin
-    # - cardCovers
-    # - background
-    # - cardAging
-    #
-    # On update
-    # https://trello.com/docs/api/board/#put-1-boards-board-id
-    # Same as above plus:
-    # - calendarFeedEnabled
-    def flat_prefs
-      separator = id ? "/" : "_"
-      attributes[:prefs].inject({}) do |hash, (pref, v)|
-        hash.merge("prefs#{separator}#{pref}" => v)
-      end
-    end
   end
 end