RubyGems - gocardless_pro - Versions diffs - 2.15.1 → 2.16.0 - Mend

gocardless_pro 2.15.1 → 2.16.0

Files changed (15) hide show

checksums.yaml +4 -4
data/README.md +10 -0
data/lib/gocardless_pro/client.rb +6 -1
data/lib/gocardless_pro/resources/event.rb +4 -0
data/lib/gocardless_pro/resources/instalment_schedule.rb +92 -0
data/lib/gocardless_pro/resources/payment.rb +4 -0
data/lib/gocardless_pro/resources/refund.rb +2 -0
data/lib/gocardless_pro/services/instalment_schedules_service.rb +177 -0
data/lib/gocardless_pro/version.rb +1 -1
data/lib/gocardless_pro.rb +3 -0
data/spec/resources/instalment_schedule_spec.rb +442 -0
data/spec/resources/refund_spec.rb +13 -0
data/spec/services/instalment_schedules_service_spec.rb +700 -0
data/spec/services/refunds_service_spec.rb +17 -0
metadata +9 -4

data/spec/services/instalment_schedules_service_spec.rb ADDED Viewed

@@ -0,0 +1,700 @@
+require 'spec_helper'
+describe GoCardlessPro::Services::InstalmentSchedulesService do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+  describe '#create' do
+    subject(:post_create_response) { client.instalment_schedules.create(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 '#list' do
+    describe 'with no filters' do
+      subject(:get_list_response) { client.instalment_schedules.list }
+      let(:body) do
+        {
+          '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',
+          }],
+          meta: {
+            cursors: {
+              before: nil,
+              after: 'ABC123',
+            },
+          },
+        }.to_json
+      end
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/instalment_schedules}).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::InstalmentSchedule)
+        expect(get_list_response.records.first.created_at).to eq('created_at-input')
+        expect(get_list_response.records.first.currency).to eq('currency-input')
+        expect(get_list_response.records.first.id).to eq('id-input')
+        expect(get_list_response.records.first.metadata).to eq('metadata-input')
+        expect(get_list_response.records.first.name).to eq('name-input')
+        expect(get_list_response.records.first.payment_errors).to eq('payment_errors-input')
+        expect(get_list_response.records.first.status).to eq('status-input')
+        expect(get_list_response.records.first.total_amount).to eq('total_amount-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/instalment_schedules}).
+                 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/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, 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/instalment_schedules$}).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',
+          }],
+          meta: {
+            cursors: { after: 'AB345' },
+            limit: 1,
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+    let!(:second_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/instalment_schedules\?after=AB345}).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',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+    it 'automatically makes the extra requests' do
+      expect(client.instalment_schedules.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/instalment_schedules$}).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',
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1,
+            },
+          }.to_json,
+          headers: response_headers
+        )
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/instalment_schedules\?after=AB345}).
+                               to_timeout.then.
+                               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',
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {},
+                                   },
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+        client.instalment_schedules.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/instalment_schedules$}).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',
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1,
+            },
+          }.to_json,
+          headers: response_headers
+        )
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/instalment_schedules\?after=AB345}).
+                               to_return(
+                                 status: 502,
+                                 body: '<html><body>Response from Cloudflare</body></html>',
+                                 headers: { 'Content-Type' => 'text/html' }
+                               ).then.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',
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {},
+                                   },
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+        client.instalment_schedules.all.to_a
+        expect(first_response_stub).to have_been_requested
+        expect(second_response_stub).to have_been_requested.twice
+      end
+    end
+  end
+  describe '#get' do
+    let(:id) { 'ID123' }
+    subject(:get_response) { client.instalment_schedules.get(id) }
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          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
+      subject(:get_response) do
+        client.instalment_schedules.get(id, headers: {
+                                          'Foo' => 'Bar',
+                                        })
+      end
+      it 'includes the header' do
+        get_response
+        expect(stub).to have_been_requested
+      end
+    end
+    context 'when there is a instalment_schedule to return' do
+      before do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', 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 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+      end
+    end
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: '',
+          headers: response_headers
+        )
+      end
+      it 'returns nil' do
+        expect(get_response).to be_nil
+      end
+    end
+    context "when an ID is specified which can't be included in a valid URI" do
+      let(:id) { '`' }
+      it "doesn't raise an error" do
+        expect { get_response }.to_not raise_error(/bad URI/)
+      end
+    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(:get, /.*api.gocardless.com#{stub_url}/).
+               to_timeout.then.to_return(status: 200, headers: response_headers)
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
+      it 'retries 5XX errors, other than 500s' do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub = stub_request(:get, /.*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)
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
+    end
+  end
+  describe '#cancel' do
+    subject(:post_response) { client.instalment_schedules.cancel(resource_id) }
+    let(:resource_id) { 'ABC123' }
+    let!(:stub) do
+      # /instalment_schedules/%v/actions/cancel
+      stub_url = '/instalment_schedules/:identity/actions/cancel'.gsub(':identity', resource_id)
+      stub_request(:post, /.*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 'wraps the response and calls the right endpoint' do
+      expect(post_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+      expect(stub).to have_been_requested
+    end
+    describe 'retry behaviour' do
+      it "doesn't retry errors" do
+        stub_url = '/instalment_schedules/:identity/actions/cancel'.gsub(':identity', resource_id)
+        stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+               to_timeout
+        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect(stub).to have_been_requested
+      end
+    end
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.instalment_schedules.cancel(resource_id, body, headers) }
+      let(:resource_id) { 'ABC123' }
+      let!(:stub) do
+        # /instalment_schedules/%v/actions/cancel
+        stub_url = '/instalment_schedules/:identity/actions/cancel'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).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
+    end
+  end
+end