gocardless_pro 1.1.0 → 2.0.0

data/spec/resources/creditor_spec.rb

@@ -1,99 +1,460 @@
 require 'spec_helper'
 
 describe GoCardlessPro::Resources::Creditor do
-  describe 'initialising' do
-    let(:data) do
-      {
-
-        'address_line1' => 'address_line1-input',
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
 
-        'address_line2' => 'address_line2-input',
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#create' do
+    subject(:post_create_response) { client.creditors.create(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'address_line1' => 'address_line1-input',
+          'address_line2' => 'address_line2-input',
+          'address_line3' => 'address_line3-input',
+          'city' => 'city-input',
+          'country_code' => 'country_code-input',
+          'created_at' => 'created_at-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'logo_url' => 'logo_url-input',
+          'name' => 'name-input',
+          'postal_code' => 'postal_code-input',
+          'region' => 'region-input',
+          'scheme_identifiers' => 'scheme_identifiers-input'
+        }
+      end
 
-        'address_line3' => 'address_line3-input',
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/creditors})
+          .with(
+            body: {
+              'creditors' => {
+
+                'address_line1' => 'address_line1-input',
+                'address_line2' => 'address_line2-input',
+                'address_line3' => 'address_line3-input',
+                'city' => 'city-input',
+                'country_code' => 'country_code-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'logo_url' => 'logo_url-input',
+                'name' => 'name-input',
+                'postal_code' => 'postal_code-input',
+                'region' => 'region-input',
+                'scheme_identifiers' => 'scheme_identifiers-input'
+              }
+            }
+          )
+          .to_return(
+            body: {
+              'creditors' =>
+
+                {
+
+                  'address_line1' => 'address_line1-input',
+                  'address_line2' => 'address_line2-input',
+                  'address_line3' => 'address_line3-input',
+                  'city' => 'city-input',
+                  'country_code' => 'country_code-input',
+                  'created_at' => 'created_at-input',
+                  'id' => 'id-input',
+                  'links' => 'links-input',
+                  'logo_url' => 'logo_url-input',
+                  'name' => 'name-input',
+                  'postal_code' => 'postal_code-input',
+                  'region' => 'region-input',
+                  'scheme_identifiers' => 'scheme_identifiers-input'
+                }
+
+            }.to_json,
+            headers: response_headers
+          )
+      end
 
-        'city' => 'city-input',
+      it 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::Creditor)
+      end
+    end
 
-        'country_code' => 'country_code-input',
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/creditors}).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
 
-        'created_at' => 'created_at-input',
+      it 'throws the correct error' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
 
-        'id' => 'id-input',
+    context 'with a request that returns an idempotent creation conflict error' do
+      let(:id) { 'ID123' }
+
+      let(:new_resource) do
+        {
+
+          'address_line1' => 'address_line1-input',
+          'address_line2' => 'address_line2-input',
+          'address_line3' => 'address_line3-input',
+          'city' => 'city-input',
+          'country_code' => 'country_code-input',
+          'created_at' => 'created_at-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'logo_url' => 'logo_url-input',
+          'name' => 'name-input',
+          'postal_code' => 'postal_code-input',
+          'region' => 'region-input',
+          'scheme_identifiers' => 'scheme_identifiers-input'
+        }
+      end
 
-        'links' => {
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/creditors}).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
 
-          'default_eur_payout_account' => 'default_eur_payout_account-input',
+      let!(:get_stub) do
+        stub_url = "/creditors/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/)
+          .to_return(
+            body: {
+              'creditors' => {
+
+                'address_line1' => 'address_line1-input',
+                'address_line2' => 'address_line2-input',
+                'address_line3' => 'address_line3-input',
+                'city' => 'city-input',
+                'country_code' => 'country_code-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'logo_url' => 'logo_url-input',
+                'name' => 'name-input',
+                'postal_code' => 'postal_code-input',
+                'region' => 'region-input',
+                'scheme_identifiers' => 'scheme_identifiers-input'
+              }
+            }.to_json,
+            headers: response_headers
+          )
+      end
 
-          'default_gbp_payout_account' => 'default_gbp_payout_account-input',
+      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
 
-          'default_sek_payout_account' => 'default_sek_payout_account-input'
+  describe '#list' do
+    describe 'with no filters' do
+      subject(:get_list_response) { client.creditors.list }
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/creditors}).to_return(
+          body: {
+            'creditors' => [{
+
+              'address_line1' => 'address_line1-input',
+              'address_line2' => 'address_line2-input',
+              'address_line3' => 'address_line3-input',
+              'city' => 'city-input',
+              'country_code' => 'country_code-input',
+              'created_at' => 'created_at-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'logo_url' => 'logo_url-input',
+              'name' => 'name-input',
+              'postal_code' => 'postal_code-input',
+              'region' => 'region-input',
+              'scheme_identifiers' => 'scheme_identifiers-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::Creditor)
 
-        'logo_url' => 'logo_url-input',
+        expect(get_list_response.records.first.address_line1).to eq('address_line1-input')
 
-        'name' => 'name-input',
+        expect(get_list_response.records.first.address_line2).to eq('address_line2-input')
 
-        'postal_code' => 'postal_code-input',
+        expect(get_list_response.records.first.address_line3).to eq('address_line3-input')
 
-        'region' => 'region-input',
+        expect(get_list_response.records.first.city).to eq('city-input')
 
-        'scheme_identifiers' => 'scheme_identifiers-input'
+        expect(get_list_response.records.first.country_code).to eq('country_code-input')
 
-      }
-    end
+        expect(get_list_response.records.first.created_at).to eq('created_at-input')
 
-    it 'can be initialized from an unenveloped response' do
-      resource = described_class.new(data)
+        expect(get_list_response.records.first.id).to eq('id-input')
 
-      expect(resource.address_line1).to eq('address_line1-input')
+        expect(get_list_response.records.first.logo_url).to eq('logo_url-input')
 
-      expect(resource.address_line2).to eq('address_line2-input')
+        expect(get_list_response.records.first.name).to eq('name-input')
 
-      expect(resource.address_line3).to eq('address_line3-input')
+        expect(get_list_response.records.first.postal_code).to eq('postal_code-input')
 
-      expect(resource.city).to eq('city-input')
+        expect(get_list_response.records.first.region).to eq('region-input')
 
-      expect(resource.country_code).to eq('country_code-input')
+        expect(get_list_response.records.first.scheme_identifiers).to eq('scheme_identifiers-input')
+      end
 
-      expect(resource.created_at).to eq('created_at-input')
+      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
 
-      expect(resource.id).to eq('id-input')
+      specify { expect(get_list_response.api_response.headers).to eql('content-type' => 'application/json') }
+    end
+  end
 
-      expect(resource.links.default_eur_payout_account).to eq('default_eur_payout_account-input')
+  describe '#all' do
+    let!(:first_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/creditors$}).to_return(
+        body: {
+          'creditors' => [{
+
+            'address_line1' => 'address_line1-input',
+            'address_line2' => 'address_line2-input',
+            'address_line3' => 'address_line3-input',
+            'city' => 'city-input',
+            'country_code' => 'country_code-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'logo_url' => 'logo_url-input',
+            'name' => 'name-input',
+            'postal_code' => 'postal_code-input',
+            'region' => 'region-input',
+            'scheme_identifiers' => 'scheme_identifiers-input'
+          }],
+          meta: {
+            cursors: { after: 'AB345' },
+            limit: 1
+          }
+        }.to_json,
+        headers: response_headers
+      )
+    end
 
-      expect(resource.links.default_gbp_payout_account).to eq('default_gbp_payout_account-input')
+    let!(:second_response_stub) do
+      stub_request(:get, %r{.*api.gocardless.com/creditors\?after=AB345}).to_return(
+        body: {
+          'creditors' => [{
+
+            'address_line1' => 'address_line1-input',
+            'address_line2' => 'address_line2-input',
+            'address_line3' => 'address_line3-input',
+            'city' => 'city-input',
+            'country_code' => 'country_code-input',
+            'created_at' => 'created_at-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'logo_url' => 'logo_url-input',
+            'name' => 'name-input',
+            'postal_code' => 'postal_code-input',
+            'region' => 'region-input',
+            'scheme_identifiers' => 'scheme_identifiers-input'
+          }],
+          meta: {
+            limit: 2,
+            cursors: {}
+          }
+        }.to_json,
+        headers: response_headers
+      )
+    end
 
-      expect(resource.links.default_sek_payout_account).to eq('default_sek_payout_account-input')
+    it 'automatically makes the extra requests' do
+      expect(client.creditors.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
 
-      expect(resource.logo_url).to eq('logo_url-input')
+  describe '#get' do
+    let(:id) { 'ID123' }
+
+    subject(:get_response) { client.creditors.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/creditors/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/)
+          .with(headers: { 'Foo' => 'Bar' })
+          .to_return(
+            body: {
+              'creditors' => {
+
+                'address_line1' => 'address_line1-input',
+                'address_line2' => 'address_line2-input',
+                'address_line3' => 'address_line3-input',
+                'city' => 'city-input',
+                'country_code' => 'country_code-input',
+                'created_at' => 'created_at-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'logo_url' => 'logo_url-input',
+                'name' => 'name-input',
+                'postal_code' => 'postal_code-input',
+                'region' => 'region-input',
+                'scheme_identifiers' => 'scheme_identifiers-input'
+              }
+            }.to_json,
+            headers: response_headers
+          )
+      end
 
-      expect(resource.name).to eq('name-input')
+      subject(:get_response) do
+        client.creditors.get(id, headers: {
+                               'Foo' => 'Bar'
+                             })
+      end
 
-      expect(resource.postal_code).to eq('postal_code-input')
+      it 'includes the header' do
+        get_response
+        expect(stub).to have_been_requested
+      end
+    end
 
-      expect(resource.region).to eq('region-input')
+    context 'when there is a creditor to return' do
+      before do
+        stub_url = '/creditors/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'creditors' => {
+
+              'address_line1' => 'address_line1-input',
+              'address_line2' => 'address_line2-input',
+              'address_line3' => 'address_line3-input',
+              'city' => 'city-input',
+              'country_code' => 'country_code-input',
+              'created_at' => 'created_at-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'logo_url' => 'logo_url-input',
+              'name' => 'name-input',
+              'postal_code' => 'postal_code-input',
+              'region' => 'region-input',
+              'scheme_identifiers' => 'scheme_identifiers-input'
+            }
+          }.to_json,
+          headers: response_headers
+        )
+      end
 
-      expect(resource.scheme_identifiers).to eq('scheme_identifiers-input')
+      it 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::Creditor)
+      end
     end
 
-    it 'can handle new attributes without erroring' do
-      data['foo'] = 'bar'
-      expect { described_class.new(data) }.to_not raise_error
-    end
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/creditors/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: '',
+          headers: response_headers
+        )
+      end
 
-    it 'can handle new link attributes without erroring' do
-      data['links']['foo'] = 'bar'
-      expect { described_class.new(data) }.to_not raise_error
+      it 'returns nil' do
+        expect(get_response).to be_nil
+      end
     end
 
-    it 'can handle a nil links value' do
-      data['links'] = nil
-      expect { described_class.new(data).links }.to_not raise_error
+    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 '#update' do
+    subject(:put_update_response) { client.creditors.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/creditors/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'creditors' => {
+
+              'address_line1' => 'address_line1-input',
+              'address_line2' => 'address_line2-input',
+              'address_line3' => 'address_line3-input',
+              'city' => 'city-input',
+              'country_code' => 'country_code-input',
+              'created_at' => 'created_at-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'logo_url' => 'logo_url-input',
+              'name' => 'name-input',
+              'postal_code' => 'postal_code-input',
+              'region' => 'region-input',
+              'scheme_identifiers' => 'scheme_identifiers-input'
+            }
+          }.to_json,
+          headers: response_headers
+        )
+      end
 
-    describe '#to_h' do
-      it 'returns a hash representing the resource' do
-        expect(described_class.new(data).to_h).to eq(data)
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::Creditor)
+        expect(stub).to have_been_requested
       end
     end
   end