ruby-trello 2.2.0 → 3.1.0

data/lib/trello/webhook.rb

@@ -5,86 +5,33 @@ module Trello
   #   @return [String]
   # @!attribute [r] description
   #   @return [String]
-  # @!attribute [r] id_model
+  # @!attribute [r] model_id
   #   @return [String] A 24-character hex string
   # @!attribute [r] callback_url
   #   @return [String]
   # @!attribute [r] active
   #   @return [Boolean]
+  # @!attribute [r] consecutive_failures
+  #   @return [Integer]
+  # @!attribute [r] first_consecutive_fail_date
+  #   @return [Datetime]
   class Webhook < BasicData
-    register_attributes :id, :description, :id_model, :callback_url, :active,
-      readonly: [ :id ]
-    validates_presence_of :id, :id_model, :callback_url
-    validates_length_of   :description,  in: 1..16384
 
-    class << self
-      # Find a specific webhook by its ID.
-      #
-      # @raise [Trello::Error] if a Webhook with the given ID can't be found.
-      # @return [Trello::Webhook] the Webhook with the given ID.
-      def find(id, params = {})
-        client.find(:webhook, id, params)
-      end
-
-      # Create a new webhook and save it to Trello.
-      #
-      # @param [Hash] options
-      #
-      # @option options [String] :description (optional) A string with a length from 0 to 16384
-      # @option options [String] :callback_url (required) A valid URL that is
-      #    reachable with a HEAD request
-      # @option options [String] :id_model (required) id of the model that should be hooked
-      #
-      # @raise [Trello::Error] if the Webhook could not be created.
-      #
-      # @return [Trello::Webhook]
-      def create(options)
-        client.create(:webhook,
-            'description' => options[:description],
-            'idModel'     => options[:id_model],
-            'callbackURL' => options[:callback_url])
-      end
-    end
-
-    # @return [Trello::Webhook] self
-    def update_fields(fields)
-      attributes[:id]              = fields['id'] || attributes[:id]
-      attributes[:description]     = fields['description'] || fields[:description] || attributes[:description]
-      attributes[:id_model]        = fields['idModel'] || fields[:id_model] || attributes[:id_model]
-      attributes[:callback_url]    = fields['callbackURL'] || fields[:callback_url] || attributes[:callback_url]
-      attributes[:active]          = fields['active'] if fields.has_key?('active')
-      self
+    schema do
+      # Readonly
+      attribute :id, readonly: true, primary_key: true
+      attribute :consecutive_failures, readonly: true, remote_key: 'consecutiveFailures'
+      attribute :first_consecutive_fail_date, readonly: true, remote_key: 'firstConsecutiveFailDate', serializer: 'Time'
+
+      # Writable
+      attribute :description
+      attribute :model_id, remote_key: 'idModel'
+      attribute :callback_url, remote_key: 'callbackURL'
+      attribute :active
     end
 
-    # Save the webhook.
-    #
-    # @raise  [Trello::Error] if the Webhook could not be saved.
-    #
-    # @return [String] the JSON representation of the saved webhook.
-    def save
-      # If we have an id, just update our fields.
-      return update! if id
-
-      from_response client.post("/webhooks", {
-        description: description,
-        idModel: id_model,
-        callbackURL: callback_url
-      })
-    end
-
-    # Update the webhook.
-    #
-    # @raise  [Trello::Error] if the Webhook could not be saved.
-    #
-    # @return [String] the JSON representation of the updated webhook.
-    def update!
-      client.put("/webhooks/#{id}", {
-        description: description,
-        idModel: id_model,
-        callbackURL: callback_url,
-        active: active
-      })
-    end
+    validates_presence_of :id, :model_id, :callback_url
+    validates_length_of :description, in: 1..16384
 
     # Delete this webhook
     #

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,45 +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 :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 :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.
@@ -116,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/spec/action_spec.rb

@@ -116,7 +116,7 @@ module Trello
       before do
         allow(client)
           .to receive(:get)
-          .with('/members/abcdef123456789123456789', {})
+          .with('/actions/4ee2482134a81a757a08af47/memberCreator')
           .and_return user_payload
       end
 
@@ -131,8 +131,7 @@ module Trello
           'id' => 'id',
           'type' => 'type',
           'data' => 'data',
-          'idMemberCreator' => 'member_creator_id',
-          'member' => 'member_participant'
+          'idMemberCreator' => 'creator_id'
         }
 
         action = Action.new(expected)

data/spec/board_spec.rb

@@ -6,7 +6,7 @@ module Trello
 
     let(:board) { client.find(:board, 'abcdef123456789123456789') }
     let(:client) { Client.new }
-    let(:member) { Member.new(user_payload) }
+    let(:member) { Member.new(JSON.parse(user_payload)) }
 
     before do
       allow(client)
@@ -21,7 +21,7 @@ module Trello
       it "delegates to client#find" do
         expect(client)
           .to receive(:find)
-          .with(:board, 'abcdef123456789123456789', {})
+          .with('board', 'abcdef123456789123456789', {})
 
         Board.find('abcdef123456789123456789')
       end
@@ -31,6 +31,35 @@ module Trello
       end
     end
 
+    describe '.create' do
+      before { allow(Board).to receive(:client).and_return(client) }
+
+      it 'will call create on client with correct parameters' do
+        params = {
+          name: 'Board Name',
+          use_default_labels: true,
+          use_default_lists: true,
+          description: 'description...',
+          organization_id: 11111,
+          source_board_id: 22222,
+          keep_cards_from_source: true,
+          power_ups: 'all',
+          visibility_level: 'org',
+          voting_permission_level: 'org',
+          comment_permission_level: 'org',
+          invitation_permission_level: 'admins',
+          enable_self_join: true,
+          enable_card_covers: true,
+          background_color: 'orange',
+          card_aging_type: 'pirate'
+        }
+
+        expect(client).to receive(:create).with('board', params)
+
+        Board.create(params)
+      end
+    end
+
     context "self.all" do
       let(:client) { Trello.client }
 
@@ -133,12 +162,10 @@ module Trello
         expect(labels[2].id).to  eq('cbcdef123456789123456789')
         expect(labels[2].board_id).to  eq('abcdef123456789123456789')
         expect(labels[2].name).to  eq('deploy')
-        expect(labels[2].uses).to  eq(2)
         expect(labels[3].color).to  eq('blue')
         expect(labels[3].id).to  eq('dbcdef123456789123456789')
         expect(labels[3].board_id).to  eq('abcdef123456789123456789')
         expect(labels[3].name).to  eq('on hold')
-        expect(labels[3].uses).to  eq(6)
       end
 
       it "passes the label limit" do
@@ -170,7 +197,7 @@ module Trello
       it "adds a member to the board as a normal user (default)" do
         expect(client)
           .to receive(:put)
-          .with("/boards/abcdef123456789123456789/members/id", type: :normal)
+          .with("/boards/abcdef123456789123456789/members/#{member.id}", type: :normal)
 
         board.add_member(member)
       end
@@ -178,7 +205,7 @@ module Trello
       it "adds a member to the board as an admin" do
         expect(client)
           .to receive(:put)
-          .with("/boards/abcdef123456789123456789/members/id", type: :admin)
+          .with("/boards/abcdef123456789123456789/members/#{member.id}", type: :admin)
 
         board.add_member(member, :admin)
       end
@@ -193,7 +220,7 @@ module Trello
       it "removes a member from the board" do
         expect(client)
           .to receive(:delete)
-          .with("/boards/abcdef123456789123456789/members/id")
+          .with("/boards/abcdef123456789123456789/members/#{member.id}")
 
         board.remove_member(member)
       end
@@ -264,62 +291,15 @@ module Trello
       end
     end
 
-    it "is not closed" do
-      expect(board).not_to be_closed
-    end
-
-    it "is not starred" do
-      expect(board).not_to be_starred
-    end
-
-    describe "#update_fields" do
-      it "does not set any fields when the fields argument is empty" do
-        expected = {
-         'id' => "id",
-         'name' => "name",
-         'desc' => "desc",
-         'closed' => false,
-         'starred' => false,
-         'url' => "url",
-         'idOrganization' => "org_id"
-        }
-
-        board = Board.new(expected)
-        board.client = client
-
-        board.update_fields({})
-
-        expected.each_pair do |key, value|
-          if board.respond_to?(key)
-            expect(board.send(key)).to eq value
-          end
-        end
-
-        expect(board.description).to eq expected['desc']
-        expect(board.organization_id).to eq expected['idOrganization']
-      end
-
-      it "initializes all fields from response-like formatted hash" do
-        board_details = boards_details.first
-        board = Board.new(board_details)
-        expect(board.id).to                 eq board_details['id']
-        expect(board.name).to               eq board_details['name']
-        expect(board.description).to        eq board_details['desc']
-        expect(board.closed).to             eq board_details['closed']
-        expect(board.starred).to            eq board_details['starred']
-        expect(board.organization_id).to    eq board_details['idOrganization']
-        expect(board.url).to                eq board_details['url']
-        expect(board.last_activity_date).to eq board_details['dateLastActivity']
+    describe '#closed?' do
+      it "returns the closed attribute" do
+        expect(board.closed?).to be_falsy
       end
+    end
 
-      it "initializes all fields from options-like formatted hash" do
-        board_details = boards_details[1]
-        board = Board.new(board_details)
-        expect(board.name).to            eq board_details[:name]
-        expect(board.description).to     eq board_details[:desc]
-        expect(board.closed).to          eq board_details[:closed]
-        expect(board.starred).to         eq board_details[:starred]
-        expect(board.organization_id).to eq board_details[:organization_id]
+    describe '#starred?' do
+      it "returns the starred attribute" do
+        expect(board.starred?).to be_falsy
       end
     end
 
@@ -342,17 +322,6 @@ module Trello
         }.to raise_error(Trello::ConfigurationError)
       end
 
-      it "puts all fields except id" do
-        expected_fields = %w{ name description closed starred idOrganization}.map { |s| s.to_sym }
-
-        expect(client).to receive(:put) do |anything, body|
-          expect(body.keys).to match expected_fields
-          any_board_json
-        end
-
-        Board.new('id' => "xxx").save
-      end
-
       it "mutates the current instance" do
         allow(client)
           .to receive(:put)
@@ -366,7 +335,7 @@ module Trello
         expected_resource_id = "xxx_board_id_xxx"
 
         expect(client).to receive(:put) do |path, anything|
-          expect(path).to match(/#{expected_resource_id}\/\z/)
+          expect(path).to match(/#{expected_resource_id}\z/)
           any_board_json
         end
 
@@ -376,35 +345,6 @@ module Trello
       it "saves OR updates depending on whether or not it has an id set"
     end
 
-    describe '#update!' do
-      let(:client) { Trello.client }
-
-      let(:any_board_json) do
-        JSON.generate(boards_details.first)
-      end
-
-      it "puts basic attributes" do
-        board = Board.new 'id' => "board_id"
-
-        board.name        = "new name"
-        board.description = "new description"
-        board.closed      = true
-        board.starred     = true
-
-        expect(client)
-          .to receive(:put)
-          .with("/boards/#{board.id}/", {
-            name: "new name",
-            description: "new description",
-            closed: true,
-            starred: true,
-            idOrganization: nil })
-          .and_return any_board_json
-
-        board.update!
-      end
-    end
-
     describe "Repository" do
       include Helpers
 
@@ -421,7 +361,7 @@ module Trello
 
       it "creates a new board with whatever attributes are supplied " do
         expected_attributes = { name: "Any new board name", description: "Any new board desription" }
-        sent_attributes = { name: expected_attributes[:name], desc: expected_attributes[:description] }
+        sent_attributes = { 'name' => expected_attributes[:name], 'desc' => expected_attributes[:description] }
 
         expect(client)
           .to receive(:post)