gocardless_pro 2.12.0 → 2.13.0

data/lib/gocardless_pro/services/customers_service.rb

@@ -29,7 +29,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/mandate_imports_service.rb

@@ -33,7 +33,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -64,6 +73,13 @@ module GoCardlessPro
       # GoCardless team. Once the import has been submitted, it can no longer have
       # entries
       # added to it.
+      #
+      # In our sandbox environment, to aid development, we automatically process
+      # mandate
+      # imports approximately 10 seconds after they are submitted. This will allow you
+      # to
+      # test both the "submitted" response and wait for the webhook to confirm the
+      # processing has begun.
       # Example URL: /mandate_imports/:identity/actions/submit
       #
       # @param identity       # Unique identifier, beginning with "IM".
@@ -83,7 +99,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -97,9 +122,9 @@ module GoCardlessPro
       # mandates
       # being set up in GoCardless. Once the import has been cancelled, it can no
       # longer have
-      # entries added to it. Mandate imports which have already been submitted cannot
-      # be
-      # cancelled.
+      # entries added to it. Mandate imports which have already been submitted or
+      # processed
+      # cannot be cancelled.
       # Example URL: /mandate_imports/:identity/actions/cancel
       #
       # @param identity       # Unique identifier, beginning with "IM".
@@ -119,7 +144,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/mandates_service.rb

@@ -29,7 +29,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -131,7 +140,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -171,7 +189,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/payments_service.rb

@@ -34,7 +34,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -136,7 +145,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -175,7 +193,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -30,7 +30,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -86,7 +95,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -13,13 +13,9 @@ module GoCardlessPro
     class RefundsService < BaseService
       # Creates a new refund object.
       #
-      # This fails with:<a name="refund_payment_invalid_state"></a><a
-      # name="total_amount_confirmation_invalid"></a><a
+      # This fails with:<a name="total_amount_confirmation_invalid"></a><a
       # name="number_of_refunds_exceeded"></a>
       #
-      # - `refund_payment_invalid_state` error if the linked
-      # [payment](#core-endpoints-payments) isn't either `confirmed` or `paid_out`.
-      #
       # - `total_amount_confirmation_invalid` if the confirmation amount doesn't match
       # the total amount refunded for the payment. This safeguard is there to prevent
       # two processes from creating refunds without awareness of each other.
@@ -44,7 +40,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -29,7 +29,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end
@@ -154,7 +163,16 @@ module GoCardlessPro
           # Response doesn't raise any errors until #body is called
           response.tap(&:body)
         rescue InvalidStateError => e
-          return get(e.conflicting_resource_id) if e.idempotent_creation_conflict?
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
 
           raise e
         end

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.12.0'.freeze
+  VERSION = '2.13.0'.freeze
 end

data/spec/resources/customer_notification_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::CustomerNotification do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#handle' do
+    subject(:post_response) { client.customer_notifications.handle(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /customer_notifications/%v/actions/handle
+      stub_url = '/customer_notifications/:identity/actions/handle'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'customer_notifications' => {
+
+            'action_taken' => 'action_taken-input',
+            'action_taken_at' => 'action_taken_at-input',
+            'action_taken_by' => 'action_taken_by-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'type' => 'type-input',
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::CustomerNotification)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.customer_notifications.handle(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /customer_notifications/%v/actions/handle
+        stub_url = '/customer_notifications/:identity/actions/handle'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'customer_notifications' => {
+
+                'action_taken' => 'action_taken-input',
+                'action_taken_at' => 'action_taken_at-input',
+                'action_taken_by' => 'action_taken_by-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'type' => 'type-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+end

data/spec/resources/customer_spec.rb

@@ -29,6 +29,7 @@ describe GoCardlessPro::Resources::Customer do
           'id' => 'id-input',
           'language' => 'language-input',
           'metadata' => 'metadata-input',
+          'phone_number' => 'phone_number-input',
           'postal_code' => 'postal_code-input',
           'region' => 'region-input',
           'swedish_identity_number' => 'swedish_identity_number-input',
@@ -55,6 +56,7 @@ describe GoCardlessPro::Resources::Customer do
                 'id' => 'id-input',
                 'language' => 'language-input',
                 'metadata' => 'metadata-input',
+                'phone_number' => 'phone_number-input',
                 'postal_code' => 'postal_code-input',
                 'region' => 'region-input',
                 'swedish_identity_number' => 'swedish_identity_number-input',
@@ -81,6 +83,7 @@ describe GoCardlessPro::Resources::Customer do
                   'id' => 'id-input',
                   'language' => 'language-input',
                   'metadata' => 'metadata-input',
+                  'phone_number' => 'phone_number-input',
                   'postal_code' => 'postal_code-input',
                   'region' => 'region-input',
                   'swedish_identity_number' => 'swedish_identity_number-input',
@@ -140,6 +143,7 @@ describe GoCardlessPro::Resources::Customer do
           'id' => 'id-input',
           'language' => 'language-input',
           'metadata' => 'metadata-input',
+          'phone_number' => 'phone_number-input',
           'postal_code' => 'postal_code-input',
           'region' => 'region-input',
           'swedish_identity_number' => 'swedish_identity_number-input',
@@ -189,6 +193,7 @@ describe GoCardlessPro::Resources::Customer do
                 'id' => 'id-input',
                 'language' => 'language-input',
                 'metadata' => 'metadata-input',
+                'phone_number' => 'phone_number-input',
                 'postal_code' => 'postal_code-input',
                 'region' => 'region-input',
                 'swedish_identity_number' => 'swedish_identity_number-input',
@@ -229,6 +234,7 @@ describe GoCardlessPro::Resources::Customer do
               'id' => 'id-input',
               'language' => 'language-input',
               'metadata' => 'metadata-input',
+              'phone_number' => 'phone_number-input',
               'postal_code' => 'postal_code-input',
               'region' => 'region-input',
               'swedish_identity_number' => 'swedish_identity_number-input',
@@ -275,6 +281,8 @@ describe GoCardlessPro::Resources::Customer do
 
         expect(get_list_response.records.first.metadata).to eq('metadata-input')
 
+        expect(get_list_response.records.first.phone_number).to eq('phone_number-input')
+
         expect(get_list_response.records.first.postal_code).to eq('postal_code-input')
 
         expect(get_list_response.records.first.region).to eq('region-input')
@@ -311,6 +319,7 @@ describe GoCardlessPro::Resources::Customer do
             'id' => 'id-input',
             'language' => 'language-input',
             'metadata' => 'metadata-input',
+            'phone_number' => 'phone_number-input',
             'postal_code' => 'postal_code-input',
             'region' => 'region-input',
             'swedish_identity_number' => 'swedish_identity_number-input',
@@ -343,6 +352,7 @@ describe GoCardlessPro::Resources::Customer do
             'id' => 'id-input',
             'language' => 'language-input',
             'metadata' => 'metadata-input',
+            'phone_number' => 'phone_number-input',
             'postal_code' => 'postal_code-input',
             'region' => 'region-input',
             'swedish_identity_number' => 'swedish_identity_number-input',
@@ -391,6 +401,7 @@ describe GoCardlessPro::Resources::Customer do
                 'id' => 'id-input',
                 'language' => 'language-input',
                 'metadata' => 'metadata-input',
+                'phone_number' => 'phone_number-input',
                 'postal_code' => 'postal_code-input',
                 'region' => 'region-input',
                 'swedish_identity_number' => 'swedish_identity_number-input',
@@ -433,6 +444,7 @@ describe GoCardlessPro::Resources::Customer do
               'id' => 'id-input',
               'language' => 'language-input',
               'metadata' => 'metadata-input',
+              'phone_number' => 'phone_number-input',
               'postal_code' => 'postal_code-input',
               'region' => 'region-input',
               'swedish_identity_number' => 'swedish_identity_number-input',
@@ -497,6 +509,7 @@ describe GoCardlessPro::Resources::Customer do
               'id' => 'id-input',
               'language' => 'language-input',
               'metadata' => 'metadata-input',
+              'phone_number' => 'phone_number-input',
               'postal_code' => 'postal_code-input',
               'region' => 'region-input',
               'swedish_identity_number' => 'swedish_identity_number-input',