gocardless_pro 2.24.0 → 2.29.0

data/spec/resources/billing_request_spec.rb

@@ -0,0 +1,782 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::BillingRequest 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.billing_requests.list }
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/billing_requests}).to_return(
+          body: {
+            'billing_requests' => [{
+
+              'actions' => 'actions-input',
+              'created_at' => 'created_at-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'mandate_request' => 'mandate_request-input',
+              'metadata' => 'metadata-input',
+              'payment_request' => 'payment_request-input',
+              'resources' => 'resources-input',
+              'status' => 'status-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::BillingRequest)
+
+        expect(get_list_response.records.first.actions).to eq('actions-input')
+
+        expect(get_list_response.records.first.created_at).to eq('created_at-input')
+
+        expect(get_list_response.records.first.id).to eq('id-input')
+
+        expect(get_list_response.records.first.mandate_request).to eq('mandate_request-input')
+
+        expect(get_list_response.records.first.metadata).to eq('metadata-input')
+
+        expect(get_list_response.records.first.payment_request).to eq('payment_request-input')
+
+        expect(get_list_response.records.first.resources).to eq('resources-input')
+
+        expect(get_list_response.records.first.status).to eq('status-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/billing_requests$}).to_return(
+        body: {
+          'billing_requests' => [{
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-input',
+            'status' => 'status-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/billing_requests\?after=AB345}).to_return(
+        body: {
+          'billing_requests' => [{
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-input',
+            'status' => 'status-input',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'automatically makes the extra requests' do
+      expect(client.billing_requests.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
+
+  describe '#create' do
+    subject(:post_create_response) { client.billing_requests.create(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'actions' => 'actions-input',
+          'created_at' => 'created_at-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'mandate_request' => 'mandate_request-input',
+          'metadata' => 'metadata-input',
+          'payment_request' => 'payment_request-input',
+          'resources' => 'resources-input',
+          'status' => 'status-input',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/billing_requests}).
+          with(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }
+          ).
+          to_return(
+            body: {
+              'billing_requests' =>
+
+                {
+
+                  'actions' => 'actions-input',
+                  'created_at' => 'created_at-input',
+                  'id' => 'id-input',
+                  'links' => 'links-input',
+                  'mandate_request' => 'mandate_request-input',
+                  'metadata' => 'metadata-input',
+                  'payment_request' => 'payment_request-input',
+                  'resources' => 'resources-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::BillingRequest)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/billing_requests}).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
+        {
+
+          'actions' => 'actions-input',
+          'created_at' => 'created_at-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'mandate_request' => 'mandate_request-input',
+          'metadata' => 'metadata-input',
+          'payment_request' => 'payment_request-input',
+          'resources' => 'resources-input',
+          'status' => 'status-input',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/billing_requests}).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 = "/billing_requests/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-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 '#get' do
+    let(:id) { 'ID123' }
+
+    subject(:get_response) { client.billing_requests.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/billing_requests/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      subject(:get_response) do
+        client.billing_requests.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 billing_request to return' do
+      before do
+        stub_url = '/billing_requests/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'billing_requests' => {
+
+              'actions' => 'actions-input',
+              'created_at' => 'created_at-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'mandate_request' => 'mandate_request-input',
+              'metadata' => 'metadata-input',
+              'payment_request' => 'payment_request-input',
+              'resources' => 'resources-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::BillingRequest)
+      end
+    end
+
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/billing_requests/: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 '#collect_customer_details' do
+    subject(:post_response) { client.billing_requests.collect_customer_details(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/collect_customer_details
+      stub_url = '/billing_requests/:identity/actions/collect_customer_details'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.collect_customer_details(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/collect_customer_details
+        stub_url = '/billing_requests/:identity/actions/collect_customer_details'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#collect_bank_account' do
+    subject(:post_response) { client.billing_requests.collect_bank_account(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/collect_bank_account
+      stub_url = '/billing_requests/:identity/actions/collect_bank_account'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.collect_bank_account(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/collect_bank_account
+        stub_url = '/billing_requests/:identity/actions/collect_bank_account'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#fulfil' do
+    subject(:post_response) { client.billing_requests.fulfil(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/fulfil
+      stub_url = '/billing_requests/:identity/actions/fulfil'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.fulfil(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/fulfil
+        stub_url = '/billing_requests/:identity/actions/fulfil'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#confirm_payer_details' do
+    subject(:post_response) { client.billing_requests.confirm_payer_details(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/confirm_payer_details
+      stub_url = '/billing_requests/:identity/actions/confirm_payer_details'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.confirm_payer_details(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/confirm_payer_details
+        stub_url = '/billing_requests/:identity/actions/confirm_payer_details'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#cancel' do
+    subject(:post_response) { client.billing_requests.cancel(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/cancel
+      stub_url = '/billing_requests/:identity/actions/cancel'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.cancel(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/cancel
+        stub_url = '/billing_requests/: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: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#notify' do
+    subject(:post_response) { client.billing_requests.notify(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /billing_requests/%v/actions/notify
+      stub_url = '/billing_requests/:identity/actions/notify'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'billing_requests' => {
+
+            'actions' => 'actions-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'mandate_request' => 'mandate_request-input',
+            'metadata' => 'metadata-input',
+            'payment_request' => 'payment_request-input',
+            'resources' => 'resources-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::BillingRequest)
+
+      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.billing_requests.notify(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /billing_requests/%v/actions/notify
+        stub_url = '/billing_requests/:identity/actions/notify'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'billing_requests' => {
+
+                'actions' => 'actions-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'mandate_request' => 'mandate_request-input',
+                'metadata' => 'metadata-input',
+                'payment_request' => 'payment_request-input',
+                'resources' => 'resources-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+end