gocardless_pro 2.17.1 → 2.21.0

data/lib/gocardless_pro/services/mandates_service.rb

@@ -172,7 +172,7 @@ module GoCardlessPro
       # This will fail with a `mandate_not_inactive` error if the mandate is already
       # being submitted, or is active.
       #
-      # Mandates can be resubmitted up to 3 times.
+      # Mandates can be resubmitted up to 10 times.
       # Example URL: /mandates/:identity/actions/reinstate
       #
       # @param identity       # Unique identifier, beginning with "MD". Note that this prefix may not

data/lib/gocardless_pro/services/payouts_service.rb

@@ -59,6 +59,27 @@ module GoCardlessPro
         Resources::Payout.new(unenvelope_body(response.body), response)
       end
 
+      # Updates a payout object. This accepts only the metadata parameter.
+      # Example URL: /payouts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PO".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/payouts/:identity', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+
+        Resources::Payout.new(unenvelope_body(response.body), response)
+      end
+
       private
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -138,6 +138,135 @@ module GoCardlessPro
         Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
+      # Pause a subscription object.
+      # No payments will be created until it is resumed.
+      #
+      # This can only be used when a subscription collecting a fixed number of
+      # payments (created using `count`)
+      # or when they continue forever (created without `count` or `end_date`)
+      #
+      # When `pause_cycles` is omitted the subscription is paused until the [resume
+      # endpoint](#subscriptions-resume-a-subscription) is called.
+      # If the subscription is collecting a fixed number of payments, `end_date` will
+      # be set to `nil`.
+      # When paused indefinitely, `upcoming_payments` will be empty.
+      #
+      # When `pause_cycles` is provided the subscription will be paused for the number
+      # of cycles requested.
+      # If the subscription is collecting a fixed number of payments, `end_date` will
+      # be set to a new value.
+      # When paused for a number of cycles, `upcoming_payments` will still contain the
+      # upcoming charge dates.
+      #
+      # This fails with:
+      #
+      # - `forbidden` if the subscription was created by an app and you are not
+      # authenticated as that app, or if the subscription was not created by an app
+      # and you are authenticated as an app
+      #
+      # - `validation_failed` if invalid data is provided when attempting to pause a
+      # subscription.
+      #
+      # - `subscription_not_active` if the subscription is no longer active.
+      #
+      # - `subscription_already_ended` if the subscription has taken all payments.
+      #
+      # - `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
+      # `pause_cycles` cannot be satisfied.
+      #
+      # Example URL: /subscriptions/:identity/actions/pause
+      #
+      # @param identity       # Unique identifier, beginning with "SB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def pause(identity, options = {})
+        path = sub_url('/subscriptions/:identity/actions/pause', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          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
+
+        return if response.body.nil?
+
+        Resources::Subscription.new(unenvelope_body(response.body), response)
+      end
+
+      # Resume a subscription object.
+      # Payments will start to be created again based on the subscriptions recurrence
+      # rules.
+      # The `charge_date` on the next payment will be the same as the subscriptions
+      # `earliest_charge_date_after_resume`
+      #
+      # This fails with:
+      #
+      # - `forbidden` if the subscription was created by an app and you are not
+      # authenticated as that app, or if the subscription was not created by an app
+      # and you are authenticated as an app
+      #
+      # - `validation_failed` if invalid data is provided when attempting to resume a
+      # subscription.
+      #
+      # - `subscription_not_paused` if the subscription is not paused.
+      #
+      # Example URL: /subscriptions/:identity/actions/resume
+      #
+      # @param identity       # Unique identifier, beginning with "SB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def resume(identity, options = {})
+        path = sub_url('/subscriptions/:identity/actions/resume', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          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
+
+        return if response.body.nil?
+
+        Resources::Subscription.new(unenvelope_body(response.body), response)
+      end
+
       # Immediately cancels a subscription; no more payments will be created under it.
       # Any metadata supplied to this endpoint will be stored on the payment
       # cancellation event it causes.

data/lib/gocardless_pro/version.rb

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

data/spec/resources/currency_exchange_rate_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::CurrencyExchangeRate do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#list' do
+    describe 'with no filters' do
+      subject(:get_list_response) { client.currency_exchange_rates.list }
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).to_return(
+          body: {
+            'currency_exchange_rates' => [{
+
+              'rate' => 'rate-input',
+              'source' => 'source-input',
+              'target' => 'target-input',
+              'time' => 'time-input',
+            }],
+            meta: {
+              cursors: {
+                before: nil,
+                after: 'ABC123',
+              },
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps each item in the resource class' do
+        expect(get_list_response.records.map(&:class).uniq.first).to eq(GoCardlessPro::Resources::CurrencyExchangeRate)
+
+        expect(get_list_response.records.first.rate).to eq('rate-input')
+
+        expect(get_list_response.records.first.source).to eq('source-input')
+
+        expect(get_list_response.records.first.target).to eq('target-input')
+
+        expect(get_list_response.records.first.time).to eq('time-input')
+      end
+
+      it 'exposes the cursors for before and after' do
+        expect(get_list_response.before).to eq(nil)
+        expect(get_list_response.after).to eq('ABC123')
+      end
+
+      specify { expect(get_list_response.api_response.headers).to eql('content-type' => 'application/json') }
+    end
+  end
+
+  describe '#all' do
+    let!(:first_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates$}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            cursors: { after: 'AB345' },
+            limit: 1,
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    let!(:second_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).to_return(
+        body: {
+          'currency_exchange_rates' => [{
+
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'automatically makes the extra requests' do
+      expect(client.currency_exchange_rates.all.to_a.length).to eq(2)
+      expect(first_response_stub).to have_been_requested
+      expect(second_response_stub).to have_been_requested
+    end
+  end
+end

data/spec/resources/instalment_schedule_spec.rb

@@ -10,7 +10,164 @@ describe GoCardlessPro::Resources::InstalmentSchedule do
   let(:response_headers) { { 'Content-Type' => 'application/json' } }
 
   describe '#create' do
-    subject(:post_create_response) { client.instalment_schedules.create(params: new_resource) }
+    subject(:post_create_response) { client.instalment_schedules.create_with_dates(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'created_at' => 'created_at-input',
+          'currency' => 'currency-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'metadata' => 'metadata-input',
+          'name' => 'name-input',
+          'payment_errors' => 'payment_errors-input',
+          'status' => 'status-input',
+          'total_amount' => 'total_amount-input',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+          with(
+            body: {
+              'instalment_schedules' => {
+
+                'created_at' => 'created_at-input',
+                'currency' => 'currency-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'metadata' => 'metadata-input',
+                'name' => 'name-input',
+                'payment_errors' => 'payment_errors-input',
+                'status' => 'status-input',
+                'total_amount' => 'total_amount-input',
+              },
+            }
+          ).
+          to_return(
+            body: {
+              'instalment_schedules' =>
+
+                {
+
+                  'created_at' => 'created_at-input',
+                  'currency' => 'currency-input',
+                  'id' => 'id-input',
+                  'links' => 'links-input',
+                  'metadata' => 'metadata-input',
+                  'name' => 'name-input',
+                  'payment_errors' => 'payment_errors-input',
+                  'status' => 'status-input',
+                  'total_amount' => 'total_amount-input',
+                },
+
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      it 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'validation_failed',
+              code: 422,
+              errors: [
+                { message: 'test error message', field: 'test_field' },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 422
+        )
+      end
+
+      it 'throws the correct error' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
+
+    context 'with a request that returns an idempotent creation conflict error' do
+      let(:id) { 'ID123' }
+
+      let(:new_resource) do
+        {
+
+          'created_at' => 'created_at-input',
+          'currency' => 'currency-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'metadata' => 'metadata-input',
+          'name' => 'name-input',
+          'payment_errors' => 'payment_errors-input',
+          'status' => 'status-input',
+          'total_amount' => 'total_amount-input',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).to_return(
+          body: {
+            error: {
+              type: 'invalid_state',
+              code: 409,
+              errors: [
+                {
+                  message: 'A resource has already been created with this idempotency key',
+                  reason: 'idempotent_creation_conflict',
+                  links: {
+                    conflicting_resource_id: id,
+                  },
+                },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 409
+        )
+      end
+
+      let!(:get_stub) do
+        stub_url = "/instalment_schedules/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          to_return(
+            body: {
+              'instalment_schedules' => {
+
+                'created_at' => 'created_at-input',
+                'currency' => 'currency-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'metadata' => 'metadata-input',
+                'name' => 'name-input',
+                'payment_errors' => 'payment_errors-input',
+                'status' => 'status-input',
+                'total_amount' => 'total_amount-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      it 'fetches the already-created resource' do
+        post_create_response
+        expect(post_stub).to have_been_requested
+        expect(get_stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#create' do
+    subject(:post_create_response) { client.instalment_schedules.create_with_schedule(params: new_resource) }
     context 'with a valid request' do
       let(:new_resource) do
         {
@@ -372,6 +529,41 @@ describe GoCardlessPro::Resources::InstalmentSchedule do
     end
   end
 
+  describe '#update' do
+    subject(:put_update_response) { client.instalment_schedules.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'instalment_schedules' => {
+
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input',
+              'name' => 'name-input',
+              'payment_errors' => 'payment_errors-input',
+              'status' => 'status-input',
+              'total_amount' => 'total_amount-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }