ruby-trello 2.3.1 → 3.2.0

data/lib/trello/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Trello
   # A List is a container which holds cards. Lists are items on a board.
   #
@@ -11,10 +13,30 @@ module Trello
   #   @return [String] A 24-character hex string
   # @!attribute [rw] pos
   #   @return [Object]
+  # @!attribute [w] source_list_id
+  #   @return [String]
+  # @!attribute [w] subscribed
+  #   @return [Boolean]
   class List < BasicData
-    register_attributes :id, :name, :closed, :board_id, :pos, :source_list_id, readonly: [ :id, :board_id ]
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+
+      # Writable
+      attribute :name
+      attribute :pos
+      attribute :board_id, remote_key: 'idBoard'
+
+      # Writable but for create only
+      attribute :source_list_id, create_only: true, remote_key: 'idListSource'
+
+      # Writable but for update only
+      attribute :closed, update_only: true
+      attribute :subscribed, update_only: true
+    end
+
     validates_presence_of :id, :name, :board_id
-    validates_length_of   :name, in: 1..16384
+    validates_length_of   :name, in: 1..16_384
 
     include HasActions
 
@@ -26,48 +48,6 @@ module Trello
       def find(id, params = {})
         client.find(:list, id, params)
       end
-
-      def create(options)
-        client.create(:list,
-            'name'         => options[:name],
-            'idBoard'      => options[:board_id],
-            'pos'          => options[:pos],
-            'idListSource' => options[:source_list_id])
-      end
-    end
-
-    # Updates the fields of a list.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # a List.
-    def update_fields(fields)
-      attributes[:id]             = fields['id'] || attributes[:id]
-      attributes[:name]           = fields['name'] || fields[:name] || attributes[:name]
-      attributes[:closed]         = fields['closed'] if fields.has_key?('closed')
-      attributes[:board_id]       = fields['idBoard'] || fields[:board_id] || attributes[:board_id]
-      attributes[:pos]            = fields['pos'] || fields[:pos] || attributes[:pos]
-      attributes[:source_list_id] = fields['idListSource'] || fields[:source_list_id] || attributes[:source_list_id]
-      self
-    end
-
-    def save
-      return update! if id
-
-      from_response client.post("/lists", {
-        name: name,
-        closed: closed || false,
-        idBoard: board_id,
-        pos: pos,
-        idListSource: source_list_id
-      })
-    end
-
-    def update!
-      client.put("/lists/#{id}", {
-        name: name,
-        closed: closed,
-        pos: pos
-      })
     end
 
     # Check if the list is not active anymore.
@@ -101,6 +81,13 @@ module Trello
        })
     end
 
+    # Move list to another board. Accepts a `Trello::Board` or an id string.
+    def move_to_board(board)
+      board = board.id unless board.is_a?(String)
+
+      client.put("/lists/#{id}/idBoard", value: board)
+    end
+
     # Archives all the cards of the list
     def archive_all_cards
       client.post("/lists/#{id}/archiveAllCards")

data/lib/trello/member.rb

@@ -17,8 +17,84 @@ module Trello
   #   @return [String]
   # @!attribute [r] url
   #   @return [String]
+  # @!attribute [r] prefs
+  #   @return [Hash]
+  # @!attribute [r] activity_blocked
+  #   @return [Boolean]
+  # @!attribute [r] bio_data
+  #   @return [Hash]
+  # @!attribute [r] confirmed
+  #   @return [Boolean]
+  # @!attribute [r] enterprise_id
+  #   @return [String]
+  # @!attribute [r] deactivated_enterprise_ids
+  #   @return [String]
+  # @!attribute [r] referrer_member_id
+  #   @return [String]
+  # @!attribute [r] admin_orgs_perm_id
+  #   @return [String]
+  # @!attribute [r] member_type
+  #   @return [String]
+  # @!attribute [r] non_public
+  #   @return [Hash]
+  # @!attribute [r] non_public_available
+  #   @return [Hash]
+  # @!attribute [r] products
+  #   @return [Array]
+  # @!attribute [r] status
+  #   @return [String]
+  # @!attribute [r] board_ids
+  #   @return [Array<String>]
+  # @!attribute [r] organization_ids
+  #   @return [Array<String>]
+  # @!attribute [r] admin_enterprise_ids
+  #   @return [Array<String>]
+  # @!attribute [r] limits
+  #   @return [Hash]
+  # @!attribute [r] login_types
+  #   @return [Array<String>]
+  # @!attribute [r] marketing_opt_in
+  #   @return [Hash]
+  # @!attribute [r] pinned_board_ids
+  #   @return [String]
+  # @!attribute [w] avatar_source
+  #   @return [String]
   class Member < BasicData
-    register_attributes :id, :username, :email, :full_name, :initials, :avatar_id, :bio, :url, readonly: [ :id, :username, :avatar_id, :url ]
+    schema do
+      # readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :email, readonly: true
+      attribute :avatar_id, readonly: true, remote_key: 'avatarHash'
+      attribute :url, readonly: true
+      attribute :prefs, readonly: true
+      attribute :activity_blocked, readonly: true, remote_key: 'activityBlocked'
+      attribute :bio_data, readonly: true, remote_key: 'bioData'
+      attribute :confirmed, readonly: true
+      attribute :enterprise_id, readonly: true, remote_key: 'idEnterprise'
+      attribute :deactivated_enterprise_ids, readonly: true, remote_key: 'idEnterprisesDeactivated'
+      attribute :referrer_member_id, readonly: true, remote_key: 'idMemberReferrer'
+      attribute :admin_orgs_perm_id, readonly: true, remote_key: 'idPremOrgsAdmin'
+      attribute :member_type, readonly: true, remote_key: 'memberType'
+      attribute :non_public, readonly: true, remote_key: 'nonPublic'
+      attribute :non_public_available, readonly: true, remote_key: 'nonPublicAvailable'
+      attribute :products, readonly: true
+      attribute :status, readonly: true
+      attribute :board_ids, readonly: true, remote_key: 'idBoards'
+      attribute :organization_ids, readonly: true, remote_key: 'idOrganizations'
+      attribute :admin_enterprise_ids, readonly: true, remote_key: 'idEnterprisesAdmin'
+      attribute :limits, readonly: true
+      attribute :login_types, readonly: true, remote_key: 'loginTypes'
+      attribute :marketing_opt_in, readonly: true, remote_key: 'marketingOptIn'
+      attribute :pinned_board_ids, readonly: true, remote_key: 'idBoardsPinned'
+
+      # writable
+      attribute :username
+      attribute :full_name, remote_key: 'fullName'
+      attribute :initials
+      attribute :bio
+      attribute :avatar_source, remote_key: 'avatarSource'
+    end
+
     validates_presence_of :id, :username
     validates_length_of   :full_name, minimum: 4
     validates_length_of   :bio,       maximum: 16384
@@ -34,22 +110,6 @@ module Trello
       end
     end
 
-    # Update the fields of a member.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # an Member.
-    def update_fields(fields)
-      attributes[:id]        = fields['id'] || attributes[:id]
-      attributes[:full_name] = fields['fullName'] || attributes[:full_name]
-      attributes[:email]     = fields['email'] || attributes[:email]
-      attributes[:username]  = fields['username'] || attributes[:username]
-      attributes[:initials]  = fields['initials'] || attributes[:initials]
-      attributes[:avatar_id] = fields['avatarHash'] || attributes[:avatar_id]
-      attributes[:bio]       = fields['bio'] || attributes[:bio]
-      attributes[:url]       = fields['url'] || attributes[:url]
-      self
-    end
-
     # Retrieve a URL to the avatar.
     #
     # Valid values for options are:
@@ -90,21 +150,6 @@ module Trello
     # Returns a list of notifications for the user
     many :notifications
 
-    def save
-      @previously_changed = changes
-      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
-      changes_applied if respond_to?(:changes_applied)
-
-      return update! if id
-    end
-
-    def update!
-      from_response client.put(request_prefix, {
-        fullName: full_name,
-        bio: bio
-      })
-    end
-
     # :nodoc:
     def request_prefix
       "/members/#{id}"

data/lib/trello/net/faraday.rb

@@ -0,0 +1,46 @@
+module Trello
+  module TFaraday
+    class TInternet
+      class << self
+        begin
+          require 'faraday'
+        rescue LoadError
+        end
+
+        def execute(request)
+          try_execute request
+        end
+
+        private
+
+        def try_execute(request)
+          begin
+            if request
+              result = execute_core request
+              Response.new(200, {}, result.body)
+            end
+          rescue Faraday::Error => e
+            raise if !e.respond_to?(:response) || e.response.nil? || e.response[:status].nil?
+            Response.new(e.response[:status], {}, e.response[:body])
+          end
+        end
+
+        def execute_core(request)
+          conn = Faraday.new(
+            request.uri.to_s,
+            headers: request.headers,
+            proxy: ENV['HTTP_PROXY'],
+            request: { timeout: 10 }
+          ) do |faraday|
+            faraday.response :raise_error
+            faraday.request :json
+          end
+
+          conn.send(request.verb) do |req|
+            req.body = request.body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trello/net/rest_client.rb

@@ -0,0 +1,41 @@
+module Trello
+  module TRestClient
+    class TInternet
+      class << self
+        begin
+          require 'rest-client'
+        rescue LoadError
+        end
+
+        def execute(request)
+          try_execute request
+        end
+
+        private
+
+        def try_execute(request)
+          begin
+            if request
+              result = execute_core request
+              Response.new(200, {}, result.body)
+            end
+          rescue RestClient::Exception => e
+            raise if !e.respond_to?(:http_code) || e.http_code.nil?
+            Response.new(e.http_code, {}, e.http_body)
+          end
+        end
+
+        def execute_core(request)
+          RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
+          RestClient::Request.execute(
+            method: request.verb,
+            url: request.uri.to_s,
+            headers: request.headers,
+            payload: request.body,
+            timeout: 10
+          )
+        end
+      end
+    end
+  end
+end

data/lib/trello/net.rb

@@ -4,35 +4,8 @@ module Trello
 
   class TInternet
     class << self
-      require "rest_client"
-
       def execute(request)
-        try_execute request
-      end
-
-      private
-
-      def try_execute(request)
-        begin
-          if request
-            result = execute_core request
-            Response.new(200, {}, result)
-          end
-        rescue RestClient::Exception => e
-          raise if !e.respond_to?(:http_code) || e.http_code.nil?
-          Response.new(e.http_code, {}, e.http_body)
-        end
-      end
-
-      def execute_core(request)
-        RestClient.proxy = ENV['HTTP_PROXY'] if ENV['HTTP_PROXY']
-        RestClient::Request.execute(
-          method: request.verb,
-          url: request.uri.to_s,
-          headers: request.headers,
-          payload: request.body,
-          timeout: 10
-        )
+        Trello.http_client.execute(request)
       end
     end
   end

data/lib/trello/notification.rb

@@ -10,33 +10,40 @@ module Trello
   #   @return [Datetime]
   # @!attribute [rw] data
   #   @return [Object]
-  # @!attribute [r] member_creator_id,
+  # @!attribute [r] creator_id
   #   @return [String]
+  # @!attribute [r] creator_app
+  #   @return [String]
+  # @!attribute [r] action_id
+  #   @return [String]
+  # @!attribute [r] is_reactable
+  #   @return [Boolean]
+  # @!attribute [r] read_at
+  #   @return [Datetime]
+  # @!attribute [r] reactions
+  #   @return [Array]
   class Notification < BasicData
-    register_attributes :id, :unread, :type, :date, :data, :member_creator_id,
-      read_only: [ :id, :unread, :type, :date, :member_creator_id ]
-    validates_presence_of :id, :type, :date, :member_creator_id
-
-    class << self
-      # Locate a notification by its id
-      def find(id, params = {})
-        client.find(:notification, id, params)
-      end
-    end
 
-    def update_fields(fields)
-      attributes[:id]                = fields['id'] || attributes[:id]
-      attributes[:unread]            = fields['unread'] if fields.has_key?('unread')
-      attributes[:type]              = fields['type'] || attributes[:type]
-      attributes[:date]              = fields['date'] || attributes[:date]
-      attributes[:data]              = fields['data'] || attributes[:data]
-      attributes[:member_creator_id] = fields['idMemberCreator'] || attributes[:member_creator_id]
-      self
+    schema do
+      # Readonly
+      attribute :id, read_only: true
+      attribute :type, read_only: true
+      attribute :date, read_only: true
+      attribute :data, read_only: true
+      attribute :creator_app, read_only: true, remote_key: 'appCreator'
+      attribute :creator_id, read_only: true, remote_key: 'idMemberCreator'
+      attribute :action_id, read_only: true, remote_key: 'idAction'
+      attribute :is_reactable, read_only: true, remote_key: 'isReactable'
+      attribute :unread, read_only: true
+      attribute :read_at, read_only: true, remote_key: 'dateRead'
+      attribute :reactions, read_only: true
     end
 
+    validates_presence_of :id, :type, :date, :creator_id
+
     alias :unread? :unread
 
-    one :member_creator, path: :members, via: Member, using: :member_creator_id
+    one :creator, path: :members, via: Member, using: :creator_id
 
     def board
       Board.from_response client.get("/notifications/#{id}/board")

data/lib/trello/organization.rb

@@ -11,13 +11,60 @@ module Trello
   #   @return [String]
   # @!attribute [r] url
   #   @return [String]
+  # @!attribute [r] team_type
+  #   @return [String]
+  # @!attribute [r] desc_data
+  #   @return [String]
+  # @!attribute [r] logo_hash
+  #   @return [String]
+  # @!attribute [r] logo_url
+  #   @return [String]
+  # @!attribute [r] power_ups
+  #   @return [Array]
+  # @!attribute [r] website
+  #   @return [String]
+  # @!attribute [w] google_app_domain
+  #   @return [String]
+  # @!attribute [w] google_app_version
+  #   @return [String]
+  # @!attribute [w] enable_add_external_members
+  #   @return [Boolean]
+  # @!attribute [w] private_board_creation_permission_level
+  #   @return [String]
+  # @!attribute [w] organization_visible_board_creation_permission_level
+  #   @return [String]
+  # @!attribute [w] public_board_creation_permission_level
+  #   @return [String]
+  # @!attribute [w] visibility_level
+  #   @return [String]
   class Organization < BasicData
-    register_attributes :id, :name, :display_name, :description, :url, :invited,
-      :website, :logo_hash, :billable_member_count, :active_billable_member_count,
-      :memberships,
-      readonly: [ :id, :name, :display_name, :description, :url, :invited,
-        :website, :logo_hash, :billable_member_count, :active_billable_member_count,
-        :memberships ]
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :team_type, readonly: true, remote_key: 'teamType'
+      attribute :url, readonly: true
+      attribute :desc_data, readonly: true, remote_key: 'descData'
+      attribute :logo_hash, readonly: true, remote_key: 'logoHash'
+      attribute :logo_url, readonly: true, remote_key: 'logoUrl'
+      attribute :products, readonly: true
+      attribute :power_ups, readonly: true, remote_key: 'powerUps'
+
+      # Writable
+      attribute :name
+      attribute :display_name, remote_key: 'displayName'
+      attribute :description, remote_key: 'desc'
+      attribute :website
+
+      # Writable but update only
+      attribute :google_app_domain, update_only: true, remote_key: 'associatedDomain', class_name: 'BoardPref'
+      attribute :google_app_version, update_only: true, remote_key: 'googleAppsVersion ', class_name: 'BoardPref'
+      attribute :enable_add_external_members, update_only: true, remote_key: 'externalMembersDisabled', class_name: 'BoardPref'
+      attribute :private_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/private', class_name: 'BoardPref'
+      attribute :organization_visible_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/org', class_name: 'BoardPref'
+      attribute :public_board_creation_permission_level, update_only: true, remote_key: 'boardVisibilityRestrict/public', class_name: 'BoardPref'
+      attribute :visibility_level, update_only: true, remote_key: 'permissionLevel ', class_name: 'BoardPref'
+    end
+
     validates_presence_of :id, :name
 
     include HasActions
@@ -29,25 +76,6 @@ module Trello
       end
     end
 
-    # Update the fields of an organization.
-    #
-    # Supply a hash of string keyed data retrieved from the Trello API representing
-    # an Organization.
-    def update_fields(fields)
-      attributes[:id]                           = fields['id'] || attributes[:id]
-      attributes[:name]                         = fields['name'] || attributes[:name]
-      attributes[:display_name]                 = fields['displayName'] || attributes[:display_name]
-      attributes[:description]                  = fields['desc'] || attributes[:description]
-      attributes[:url]                          = fields['url'] || attributes[:url]
-      attributes[:invited]                      = fields['invited'] if fields.has_key?('invited')
-      attributes[:website]                      = fields['website'] || attributes[:website]
-      attributes[:logo_hash]                    = fields['logoHash'] || attributes[:logo_hash]
-      attributes[:billable_member_count]        = fields['billableMemberCount'] || attributes[:billable_member_count]
-      attributes[:active_billable_member_count] = fields['activeBillableMemberCount'] || attributes[:active_billable_member_count]
-      attributes[:memberships]                  = fields['memberships'] || attributes[:memberships]
-      self
-    end
-
     # Returns a list of boards under this organization.
     def boards
       boards = Board.from_response client.get("/organizations/#{id}/boards/all")

data/lib/trello/plugin_datum.rb

@@ -3,32 +3,27 @@ module Trello
   #
   # @!attribute id
   #   @return [String]
-  # @!attribute idPlugin
+  # @!attribute plugin_id
   #   @return [String]
   # @!attribute scope
   #   @return [String]
-  # @!attribute idModel
+  # @!attribute model_id
   #   @return [String]
   # @!attribute value
   #   @return [String]
   # @!attribute access
   #   @return [String]
-    class PluginDatum < BasicData
-    # Update the fields of a plugin.
-    register_attributes :id, :idPlugin, :scope, :idModel, :value, :access
+  class PluginDatum < BasicData
 
-
-    # Supply a hash of stringkeyed data retrieved from the Trello API representing
-    # an attachment.
-    def update_fields(fields)
-      attributes[:id]        = fields['id'] || attributes[:id]
-      attributes[:idPlugin]  = fields['idPlugin'] || attributes[:idPlugin]
-      attributes[:scope]     = fields['scope'] || attributes[:scope]
-      attributes[:value]     = JSON.parse(fields['value']).presence if fields.has_key?('value')
-      attributes[:idModel]   = fields['idModel'] || attributes[:idModel]
-      attributes[:access]    = fields['access'] || attributes[:access]
-      self
+    schema do
+      attribute :id, readonly: true
+      attribute :plugin_id, readonly: true, remote_key: 'idPlugin'
+      attribute :scope, readonly: true
+      attribute :model_id, readonly: true, remote_key: 'idModel'
+      attribute :value, readonly: true, remote_key: 'value'
+      attribute :access, readonly: true
     end
+
   end
 
 end

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

@@ -0,0 +1,79 @@
+module Trello
+  class Schema
+    module Attribute
+      class Base
+
+        attr_reader :name, :options, :serializer
+
+        def initialize(name:, options:, serializer:)
+          @name = name.to_sym
+          @options = options || {}
+          @serializer = serializer
+        end
+
+        def build_attributes(params, attributes)
+          raise 'Need override'
+        end
+
+        def build_pending_update_attributes(params, attributes)
+          params = params.with_indifferent_access
+
+          return attributes unless params.key?(remote_key) || params.key?(name)
+
+          build_attributes(params, attributes)
+        end
+
+        def build_payload_for_create(attributes, payload)
+          raise 'Need override'
+        end
+
+        def build_payload_for_update(attributes, payload)
+          raise 'Need override'
+        end
+
+        def readonly?
+          options[:readonly] == true
+        end
+
+        def update_only?
+          options[:update_only] == true
+        end
+
+        def create_only?
+          options[:create_only] == true
+        end
+
+        def primary_key?
+          return false unless options.key?(:primary_key)
+
+          options[:primary_key] 
+        end
+
+        def for_action?(action)
+          case action
+          when :create
+            create_only? || (!update_only? && !readonly? && !primary_key?)
+          when :update
+            update_only? || primary_key? || (!create_only? && !readonly?)
+          else
+            false
+          end
+        end
+
+        def remote_key
+          (options[:remote_key] || name).to_s
+        end
+
+        def default
+          return nil unless options.key?(:default)
+
+          options[:default]
+        end
+
+        def register(model_klass)
+          AttributeRegistration.register(model_klass, self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module Trello
+  class Schema
+    module Attribute
+      class BoardPref < Base
+
+        def build_attributes(params, attributes)
+          attrs = attributes.with_indifferent_access
+          params = params.with_indifferent_access
+
+          value = if params.key?(:prefs)
+                    params[:prefs][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["prefs_#{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["prefs/#{remote_key}"] = serializer.serialize(value)
+          payload
+        end
+
+      end
+    end
+  end
+end