gocardless_pro 2.24.0 → 2.29.0

data/spec/resources/payer_authorisation_spec.rb

@@ -0,0 +1,418 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::PayerAuthorisation do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#get' do
+    let(:id) { 'ID123' }
+
+    subject(:get_response) { client.payer_authorisations.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      subject(:get_response) do
+        client.payer_authorisations.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 payer_authorisation to return' do
+      before do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payer_authorisations' => {
+
+              'bank_account' => 'bank_account-input',
+              'created_at' => 'created_at-input',
+              'customer' => 'customer-input',
+              'id' => 'id-input',
+              'incomplete_fields' => 'incomplete_fields-input',
+              'links' => 'links-input',
+              'mandate' => 'mandate-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+      end
+    end
+
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/payer_authorisations/: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
+  end
+
+  describe '#create' do
+    subject(:post_create_response) { client.payer_authorisations.create(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'bank_account' => 'bank_account-input',
+          'created_at' => 'created_at-input',
+          'customer' => 'customer-input',
+          'id' => 'id-input',
+          'incomplete_fields' => 'incomplete_fields-input',
+          'links' => 'links-input',
+          'mandate' => 'mandate-input',
+          'status' => 'status-input',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).
+          with(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }
+          ).
+          to_return(
+            body: {
+              'payer_authorisations' =>
+
+                {
+
+                  'bank_account' => 'bank_account-input',
+                  'created_at' => 'created_at-input',
+                  'customer' => 'customer-input',
+                  'id' => 'id-input',
+                  'incomplete_fields' => 'incomplete_fields-input',
+                  'links' => 'links-input',
+                  'mandate' => 'mandate-input',
+                  'status' => 'status-input',
+                },
+
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      it 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).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
+        {
+
+          'bank_account' => 'bank_account-input',
+          'created_at' => 'created_at-input',
+          'customer' => 'customer-input',
+          'id' => 'id-input',
+          'incomplete_fields' => 'incomplete_fields-input',
+          'links' => 'links-input',
+          'mandate' => 'mandate-input',
+          'status' => 'status-input',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).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 = "/payer_authorisations/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-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 '#update' do
+    subject(:put_update_response) { client.payer_authorisations.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payer_authorisations' => {
+
+              'bank_account' => 'bank_account-input',
+              'created_at' => 'created_at-input',
+              'customer' => 'customer-input',
+              'id' => 'id-input',
+              'incomplete_fields' => 'incomplete_fields-input',
+              'links' => 'links-input',
+              'mandate' => 'mandate-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#submit' do
+    subject(:post_response) { client.payer_authorisations.submit(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /payer_authorisations/%v/actions/submit
+      stub_url = '/payer_authorisations/:identity/actions/submit'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'payer_authorisations' => {
+
+            'bank_account' => 'bank_account-input',
+            'created_at' => 'created_at-input',
+            'customer' => 'customer-input',
+            'id' => 'id-input',
+            'incomplete_fields' => 'incomplete_fields-input',
+            'links' => 'links-input',
+            'mandate' => 'mandate-input',
+            'status' => 'status-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::PayerAuthorisation)
+
+      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.payer_authorisations.submit(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /payer_authorisations/%v/actions/submit
+        stub_url = '/payer_authorisations/:identity/actions/submit'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#confirm' do
+    subject(:post_response) { client.payer_authorisations.confirm(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /payer_authorisations/%v/actions/confirm
+      stub_url = '/payer_authorisations/:identity/actions/confirm'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'payer_authorisations' => {
+
+            'bank_account' => 'bank_account-input',
+            'created_at' => 'created_at-input',
+            'customer' => 'customer-input',
+            'id' => 'id-input',
+            'incomplete_fields' => 'incomplete_fields-input',
+            'links' => 'links-input',
+            'mandate' => 'mandate-input',
+            'status' => 'status-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::PayerAuthorisation)
+
+      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.payer_authorisations.confirm(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /payer_authorisations/%v/actions/confirm
+        stub_url = '/payer_authorisations/:identity/actions/confirm'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+end

data/spec/resources/redirect_flow_spec.rb

@@ -20,6 +20,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'mandate_reference' => 'mandate_reference-input',
           'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
@@ -39,6 +40,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -58,6 +60,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                   'description' => 'description-input',
                   'id' => 'id-input',
                   'links' => 'links-input',
+                  'mandate_reference' => 'mandate_reference-input',
                   'metadata' => 'metadata-input',
                   'redirect_url' => 'redirect_url-input',
                   'scheme' => 'scheme-input',
@@ -110,6 +113,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
           'description' => 'description-input',
           'id' => 'id-input',
           'links' => 'links-input',
+          'mandate_reference' => 'mandate_reference-input',
           'metadata' => 'metadata-input',
           'redirect_url' => 'redirect_url-input',
           'scheme' => 'scheme-input',
@@ -152,6 +156,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -190,6 +195,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',
@@ -225,6 +231,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
               'description' => 'description-input',
               'id' => 'id-input',
               'links' => 'links-input',
+              'mandate_reference' => 'mandate_reference-input',
               'metadata' => 'metadata-input',
               'redirect_url' => 'redirect_url-input',
               'scheme' => 'scheme-input',
@@ -281,6 +288,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
             'description' => 'description-input',
             'id' => 'id-input',
             'links' => 'links-input',
+            'mandate_reference' => 'mandate_reference-input',
             'metadata' => 'metadata-input',
             'redirect_url' => 'redirect_url-input',
             'scheme' => 'scheme-input',
@@ -321,6 +329,7 @@ describe GoCardlessPro::Resources::RedirectFlow do
                 'description' => 'description-input',
                 'id' => 'id-input',
                 'links' => 'links-input',
+                'mandate_reference' => 'mandate_reference-input',
                 'metadata' => 'metadata-input',
                 'redirect_url' => 'redirect_url-input',
                 'scheme' => 'scheme-input',

data/spec/resources/scenario_simulator_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::ScenarioSimulator do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#run' do
+    subject(:post_response) { client.scenario_simulators.run(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /scenario_simulators/%v/actions/run
+      stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'scenario_simulators' => {
+
+            'id' => 'id-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::ScenarioSimulator)
+
+      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.scenario_simulators.run(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /scenario_simulators/%v/actions/run
+        stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'scenario_simulators' => {
+
+                'id' => 'id-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+end