ruby-trello 2.3.1 → 3.0.0

data/lib/trello/json_utils.rb

@@ -7,7 +7,7 @@ module Trello
 
     module InstanceMethods
       def from_response(*args)
-        update_fields parse_json(*args)
+        initialize_fields parse_json(*args)
       end
 
       def parse_json(*args)

data/lib/trello/label.rb

@@ -6,121 +6,34 @@ module Trello
   #   @return [String]
   # @!attribute [rw] color
   #   @return [String]
+  # @!attribute [rw] name
+  #   @return [String]
+  # @!attribute [rw] board_id
+  #   @return [String]
   class Label < BasicData
-    register_attributes :id, :name, :board_id, :uses,
-      readonly: [ :id, :uses, :board_id ]
-    validates_presence_of :id, :board_id, :name
-    validates_length_of   :name,        in: 1..16384
-
-    SYMBOL_TO_STRING = {
-      id: 'id',
-      name: 'name',
-      board_id: 'idBoard',
-      color: 'color',
-      uses: 'uses'
-    }
-
-    class << self
-      VALID_LABEL_COLOURS = %w{green yellow orange red purple blue sky lime pink black} << ''
-
-      # Find a specific label by its id.
-      def find(id, params = {})
-        client.find(:label, id, params)
-      end
-
-      # Create a new label and save it on Trello.
-      def create(options)
-        client.create(:label,
-          'name' => options[:name],
-          'idBoard' => options[:board_id],
-          'color'   => options[:color],
-        )
-      end
-
-      # Label colours
-      def label_colours
-        VALID_LABEL_COLOURS
-      end
-    end
-
-    define_attribute_methods [:color]
-
-    def color
-      @__attributes[:color]
-    end
-
-    def color= colour
-      unless Label.label_colours.include? colour
-        errors.add(:label, "color '#{colour}' does not exist")
-        return Trello.logger.warn "The label colour '#{colour}' does not exist."
-      end
 
-      self.send(:"color_will_change!") unless colour == @__attributes[:color]
-      @__attributes[:color] = colour
-    end
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
 
-    # Update the fields of a label.
-    #
-    # Supply a hash of stringkeyed data retrieved from the Trello API representing
-    # a label.
-    def update_fields(fields)
-      send('name_will_change!') if fields_has_key?(fields, :name)
-      send('color_will_change!') if fields_has_key?(fields, :color)
+      # Writable
+      attribute :name
+      attribute :color
 
-      initialize_fields(fields)
+      # Writable but for create only
+      attribute :board_id, create_only: true, remote_key: 'idBoard'
     end
 
-    def initialize(fields = {})
-      initialize_fields(fields)
-    end
+    validates_presence_of :id, :board_id, :name
+    validates_length_of :name, in: 1..16384
 
     # Returns a reference to the board this label is currently connected.
     one :board, path: :boards, using: :board_id
 
-    # Saves a record.
-    def save
-      # If we have an id, just update our fields.
-      return update! if id
-
-      from_response client.post("/labels", {
-        name:   name,
-        color:   color,
-        idBoard: board_id,
-      })
-    end
-
-    # Update an existing record.
-    # Warning, this updates all fields using values already in memory. If
-    # an external resource has updated these fields, you should refresh!
-    # this object before making your changes, and before updating the record.
-    def update!
-      @previously_changed = changes
-      # extract only new values to build payload
-      payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }]
-      @changed_attributes.clear if @changed_attributes.respond_to?(:clear)
-      changes_applied if respond_to?(:changes_applied)
-
-      client.put("/labels/#{id}", payload)
-    end
-
     # Delete this label
     def delete
       client.delete("/labels/#{id}")
     end
 
-    private
-
-    def fields_has_key?(fields, key)
-      fields.key?(SYMBOL_TO_STRING[key]) || fields.key?(key)
-    end
-
-    def initialize_fields(fields)
-      attributes[:id] = fields['id'] || attributes[:id]
-      attributes[:name]  = fields['name'] || fields[:name] || attributes[:name]
-      attributes[:color] = fields['color'] || fields[:color] || attributes[:color]
-      attributes[:board_id] = fields['idBoard'] || fields[:board_id] || attributes[:board_id]
-      attributes[:uses] = fields['uses'] if fields.has_key?('uses')
-      self
-    end
   end
 end

data/lib/trello/label_name.rb

@@ -1,31 +1,28 @@
 module Trello
-
   # A colored Label attached to a card
+  #
+  # @!attribute [r] yellow
+  # @!attribute [r] red
+  # @!attribute [r] orange
+  # @!attribute [r] green
+  # @!attribute [r] purple
+  # @!attribute [r] blue
+  # @!attribute [r] sky
+  # @!attribute [r] pink
+  # @!attribute [r] lime
+  # @!attribute [r] black
   class LabelName < BasicData
-    register_attributes :yellow, :red, :orange, :green, :purple, :blue, :sky, :pink, :lime, :black
-
-    # Update the fields of a label.
-    #
-    # Supply a hash of stringkeyed data retrieved from the Trello API representing
-    # a label.
-    def update_fields(fields)
-      attributes[:yellow]  = fields['yellow'] || attributes[:yellow]
-      attributes[:red] = fields['red'] || attributes[:red]
-      attributes[:orange] = fields['orange'] || attributes[:orange]
-      attributes[:green] = fields['green'] || attributes[:green]
-      attributes[:purple] = fields['purple'] || attributes[:purple]
-      attributes[:blue] = fields['blue'] || attributes[:blue]
-      attributes[:sky] = fields['sky'] || attributes[:sky]
-      attributes[:pink] = fields['pink'] || attributes[:pink]
-      attributes[:lime] = fields['lime'] || attributes[:lime]
-      attributes[:black] = fields['black'] || attributes[:black]
-
-      self
+    schema do
+      attribute :yellow, readonly: true
+      attribute :red, readonly: true
+      attribute :orange, readonly: true
+      attribute :green, readonly: true
+      attribute :purple, readonly: true
+      attribute :blue, readonly: true
+      attribute :sky, readonly: true
+      attribute :pink, readonly: true
+      attribute :lime, readonly: true
+      attribute :black, readonly: true
     end
-
-    one :board, path: :boards, using: :board_id
-
-    many :cards, filter: :all
-
   end
 end

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