RubyGems - gocardless_pro - Versions diffs - 2.17.1 → 2.21.0 - Mend

gocardless_pro 2.17.1 → 2.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

checksums.yaml +4 -4
data/lib/gocardless_pro.rb +3 -0
data/lib/gocardless_pro/client.rb +6 -1
data/lib/gocardless_pro/resources/creditor_bank_account.rb +1 -2
data/lib/gocardless_pro/resources/currency_exchange_rate.rb +44 -0
data/lib/gocardless_pro/resources/customer_notification.rb +3 -5
data/lib/gocardless_pro/resources/event.rb +2 -1
data/lib/gocardless_pro/resources/mandate_import.rb +5 -8
data/lib/gocardless_pro/resources/mandate_import_entry.rb +3 -5
data/lib/gocardless_pro/resources/payout.rb +2 -0
data/lib/gocardless_pro/resources/redirect_flow.rb +2 -0
data/lib/gocardless_pro/resources/subscription.rb +38 -29
data/lib/gocardless_pro/services/currency_exchange_rates_service.rb +67 -0
data/lib/gocardless_pro/services/customers_service.rb +1 -2
data/lib/gocardless_pro/services/instalment_schedules_service.rb +81 -5
data/lib/gocardless_pro/services/mandates_service.rb +1 -1
data/lib/gocardless_pro/services/payouts_service.rb +21 -0
data/lib/gocardless_pro/services/subscriptions_service.rb +129 -0
data/lib/gocardless_pro/version.rb +1 -1
data/spec/resources/currency_exchange_rate_spec.rb +103 -0
data/spec/resources/instalment_schedule_spec.rb +193 -1
data/spec/resources/payout_spec.rb +45 -0
data/spec/resources/redirect_flow_spec.rb +9 -0
data/spec/resources/subscription_spec.rb +210 -0
data/spec/services/currency_exchange_rates_service_spec.rb +223 -0
data/spec/services/instalment_schedules_service_spec.rb +270 -1
data/spec/services/payouts_service_spec.rb +74 -0
data/spec/services/redirect_flows_service_spec.rb +9 -0
data/spec/services/subscriptions_service_spec.rb +240 -0
metadata +9 -3

data/spec/services/currency_exchange_rates_service_spec.rb ADDED

@@ -0,0 +1,223 @@
+require 'spec_helper'
+describe GoCardlessPro::Services::CurrencyExchangeRatesService 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 }
+      let(:body) do
+        {
+          'currency_exchange_rates' => [{
+            'rate' => 'rate-input',
+            'source' => 'source-input',
+            'target' => 'target-input',
+            'time' => 'time-input',
+          }],
+          meta: {
+            cursors: {
+              before: nil,
+              after: 'ABC123',
+            },
+          },
+        }.to_json
+      end
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).to_return(
+          body: body,
+          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') }
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+        it 'retries timeouts' do
+          stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).
+                 to_timeout.then.to_return(status: 200, headers: response_headers, body: body)
+          get_list_response
+          expect(stub).to have_been_requested.twice
+        end
+        it 'retries 5XX errors' do
+          stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates}).
+                 to_return(status: 502,
+                           headers: { 'Content-Type' => 'text/html' },
+                           body: '<html><body>Response from Cloudflare</body></html>').
+                 then.to_return(status: 200, headers: response_headers, body: body)
+          get_list_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    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
+    describe 'retry behaviour' do
+      before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+      it 'retries timeouts' do
+        first_response_stub = 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
+        )
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).
+                               to_timeout.then.
+                               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
+                               )
+        client.currency_exchange_rates.all.to_a
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested.twice
+      end
+      it 'retries 5XX errors' do
+        first_response_stub = 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
+        )
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/currency_exchange_rates\?after=AB345}).
+                               to_return(
+                                 status: 502,
+                                 body: '<html><body>Response from Cloudflare</body></html>',
+                                 headers: { 'Content-Type' => 'text/html' }
+                               ).then.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
+                               )
+        client.currency_exchange_rates.all.to_a
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested.twice
+      end
+    end
+  end
+end

data/spec/services/instalment_schedules_service_spec.rb CHANGED

@@ -10,7 +10,216 @@ describe GoCardlessPro::Services::InstalmentSchedulesService 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
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+        it 'retries timeouts' do
+          stub = stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+                 to_timeout.then.to_return(status: 200, headers: response_headers)
+          post_create_response
+          expect(stub).to have_been_requested.twice
+        end
+        it 'retries 5XX errors' do
+          stub = stub_request(:post, %r{.*api.gocardless.com/instalment_schedules}).
+                 to_return(status: 502,
+                           headers: { 'Content-Type' => 'text/html' },
+                           body: '<html><body>Response from Cloudflare</body></html>').
+                 then.to_return(status: 200, headers: response_headers)
+          post_create_response
+          expect(stub).to have_been_requested.twice
+        end
+      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
+      context 'with default behaviour' do
+        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
+      context 'with on_idempotency_conflict: :raise' do
+        let(:client) do
+          GoCardlessPro::Client.new(
+            access_token: 'SECRET_TOKEN',
+            on_idempotency_conflict: :raise
+          )
+        end
+        it 'raises an IdempotencyConflict error' do
+          expect { post_create_response }.
+            to raise_error(GoCardlessPro::IdempotencyConflict)
+        end
+      end
+      context 'with on_idempotency_conflict: :unknown' do
+        let(:client) do
+          GoCardlessPro::Client.new(
+            access_token: 'SECRET_TOKEN',
+            on_idempotency_conflict: :unknown
+          )
+        end
+        it 'raises an ArgumentError' do
+          expect { post_create_response }.to raise_error(ArgumentError)
+        end
+      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
         {
@@ -619,6 +828,66 @@ describe GoCardlessPro::Services::InstalmentSchedulesService 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
+      describe 'retry behaviour' do
+        before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+        it 'retries timeouts' do
+          stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+          stub = stub_request(:put, /.*api.gocardless.com#{stub_url}/).
+                 to_timeout.then.to_return(status: 200, headers: response_headers)
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+        it 'retries 5XX errors' do
+          stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+          stub = stub_request(:put, /.*api.gocardless.com#{stub_url}/).
+                 to_return(status: 502,
+                           headers: { 'Content-Type' => 'text/html' },
+                           body: '<html><body>Response from Cloudflare</body></html>').
+                 then.to_return(status: 200, headers: response_headers)
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+  end
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }