gocardless_pro 1.1.0 → 2.0.0

data/spec/response_spec.rb

@@ -2,11 +2,14 @@ require 'spec_helper'
 
 describe GoCardlessPro::Response do
   subject(:response) { described_class.new(raw_response) }
+
   let(:default_headers) do
     { 'Content-Type' => 'application/json' }
   end
 
-  context 'when the response is not an error' do
+  describe '#body' do
+    subject(:body) { response.body }
+
     let(:raw_response) do
       double('response',
              headers: default_headers,
@@ -16,87 +19,17 @@ describe GoCardlessPro::Response do
     end
 
     it 'returns the body parsed into a hash' do
-      expect(response.body).to eq('customers' => [])
+      expect(body).to eq('customers' => [])
     end
-  end
 
-  context 'when the response is empty' do
-    let(:raw_response) do
-      double('response', headers: default_headers, status: 204, body: '')
-    end
-
-    it 'returns nil' do
-      expect(response.body).to be_nil
-    end
-  end
-
-  context 'when the resonse is a validation error' do
-    let(:raw_response) do
-      double('response',
-             headers: default_headers,
-             status: 400,
-             body: { error: { type: 'validation_failed' } }.to_json
-            )
-    end
-
-    it 'raises a ValidationError' do
-      expect { response.body }.to raise_error(GoCardlessPro::ValidationError)
-    end
-  end
-
-  context 'when the resonse is a gocardless error' do
-    let(:raw_response) do
-      double('response',
-             headers: default_headers,
-             status: 400,
-             body: { error: { type: 'gocardless' } }.to_json
-            )
-    end
-
-    it 'raises a ValidationError' do
-      expect { response.body }.to raise_error(GoCardlessPro::GoCardlessError)
-    end
-  end
-
-  context 'when the resonse is an invalid api usage error' do
-    let(:raw_response) do
-      double('response',
-             headers: default_headers,
-             status: 400,
-             body: { error: { type: 'invalid_api_usage' } }.to_json
-            )
-    end
-
-    it 'raises a ValidationError' do
-      expect { response.body }.to raise_error(GoCardlessPro::InvalidApiUsageError)
-    end
-  end
-
-  context "when the response isn't JSON" do
-    let(:raw_response) do
-      double('response',
-             headers: {},
-             status: 400,
-             body: ''
-            )
-    end
-
-    it 'raises an ApiError' do
-      expect { response.body }.to raise_error(GoCardlessPro::ApiError)
-    end
-  end
-
-  context 'when the response is an invalid state error' do
-    let(:raw_response) do
-      double('response',
-             headers: default_headers,
-             status: 400,
-             body: { error: { type: 'invalid_state' } }.to_json
-            )
-    end
+    context 'when the response is empty' do
+      let(:raw_response) do
+        double('response', headers: default_headers, status: 204, body: '')
+      end
 
-    it 'raises a ValidationError' do
-      expect { response.body }.to raise_error(GoCardlessPro::InvalidStateError)
+      it 'returns nil' do
+        expect(body).to be_nil
+      end
     end
   end
 end

data/spec/services/bank_details_lookups_service_spec.rb

@@ -7,6 +7,8 @@ describe GoCardlessPro::Services::BankDetailsLookupsService do
     )
   end
 
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
   describe '#create' do
     subject(:post_create_response) { client.bank_details_lookups.create(params: new_resource) }
     context 'with a valid request' do
@@ -43,13 +45,36 @@ describe GoCardlessPro::Services::BankDetailsLookupsService do
                 }
 
             }.to_json,
-            headers: { 'Content-Type' => 'application/json' }
+            headers: response_headers
           )
       end
 
       it 'creates and returns the resource' do
         expect(post_create_response).to be_a(GoCardlessPro::Resources::BankDetailsLookup)
       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/bank_details_lookups})
+                 .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/bank_details_lookups})
+                 .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
@@ -66,7 +91,7 @@ describe GoCardlessPro::Services::BankDetailsLookupsService do
               ]
             }
           }.to_json,
-          headers: { 'Content-Type' => 'application/json' },
+          headers: response_headers,
           status: 422
         )
       end
@@ -75,5 +100,45 @@ describe GoCardlessPro::Services::BankDetailsLookupsService 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
+        {
+
+          'available_debit_schemes' => 'available_debit_schemes-input',
+          'bank_name' => 'bank_name-input',
+          'bic' => 'bic-input'
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/bank_details_lookups}).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
+
+      it 'raises an InvalidStateError' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::InvalidStateError)
+        expect(post_stub).to have_been_requested
+      end
+    end
   end
 end

data/spec/services/creditor_bank_accounts_service_spec.rb

@@ -7,6 +7,8 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
     )
   end
 
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
   describe '#create' do
     subject(:post_create_response) { client.creditor_bank_accounts.create(params: new_resource) }
     context 'with a valid request' do
@@ -64,13 +66,36 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
                 }
 
             }.to_json,
-            headers: { 'Content-Type' => 'application/json' }
+            headers: response_headers
           )
       end
 
       it 'creates and returns the resource' do
         expect(post_create_response).to be_a(GoCardlessPro::Resources::CreditorBankAccount)
       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/creditor_bank_accounts})
+                 .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/creditor_bank_accounts})
+                 .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
@@ -87,7 +112,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
               ]
             }
           }.to_json,
-          headers: { 'Content-Type' => 'application/json' },
+          headers: response_headers,
           status: 422
         )
       end
@@ -96,36 +121,111 @@ describe GoCardlessPro::Services::CreditorBankAccountsService 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
+        {
+
+          'account_holder_name' => 'account_holder_name-input',
+          'account_number_ending' => 'account_number_ending-input',
+          'bank_name' => 'bank_name-input',
+          'country_code' => 'country_code-input',
+          'created_at' => 'created_at-input',
+          'currency' => 'currency-input',
+          'enabled' => 'enabled-input',
+          'id' => 'id-input',
+          'links' => 'links-input',
+          'metadata' => 'metadata-input'
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/creditor_bank_accounts}).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 = "/creditor_bank_accounts/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/)
+          .to_return(
+            body: {
+              'creditor_bank_accounts' => {
+
+                'account_holder_name' => 'account_holder_name-input',
+                'account_number_ending' => 'account_number_ending-input',
+                'bank_name' => 'bank_name-input',
+                'country_code' => 'country_code-input',
+                'created_at' => 'created_at-input',
+                'currency' => 'currency-input',
+                'enabled' => 'enabled-input',
+                'id' => 'id-input',
+                'links' => 'links-input',
+                'metadata' => 'metadata-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 '#list' do
     describe 'with no filters' do
       subject(:get_list_response) { client.creditor_bank_accounts.list }
 
-      before do
-        stub_request(:get, %r{.*api.gocardless.com/creditor_bank_accounts}).to_return(
-          body: {
-            'creditor_bank_accounts' => [{
+      let(:body) do
+        {
+          'creditor_bank_accounts' => [{
 
-              'account_holder_name' => 'account_holder_name-input',
-              'account_number_ending' => 'account_number_ending-input',
-              'bank_name' => 'bank_name-input',
-              'country_code' => 'country_code-input',
-              'created_at' => 'created_at-input',
-              'currency' => 'currency-input',
-              'enabled' => 'enabled-input',
-              'id' => 'id-input',
-              'links' => 'links-input',
-              'metadata' => 'metadata-input'
-            }],
-            meta: {
-              cursors: {
-                before: nil,
-                after: 'ABC123'
-              }
+            'account_holder_name' => 'account_holder_name-input',
+            'account_number_ending' => 'account_number_ending-input',
+            'bank_name' => 'bank_name-input',
+            'country_code' => 'country_code-input',
+            'created_at' => 'created_at-input',
+            'currency' => 'currency-input',
+            'enabled' => 'enabled-input',
+            'id' => 'id-input',
+            'links' => 'links-input',
+            'metadata' => 'metadata-input'
+          }],
+          meta: {
+            cursors: {
+              before: nil,
+              after: 'ABC123'
             }
-          }.to_json,
-          headers: { 'Content-Type' => 'application/json' }
+          }
+        }.to_json
+      end
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/creditor_bank_accounts}).to_return(
+          body: body,
+          headers: response_headers
         )
       end
 
@@ -157,6 +257,29 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
       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/creditor_bank_accounts})
+                 .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/creditor_bank_accounts})
+                 .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
 
@@ -182,7 +305,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
             limit: 1
           }
         }.to_json,
-        headers: { 'Content-Type' => 'application/json' }
+        headers: response_headers
       )
     end
 
@@ -207,7 +330,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
             cursors: {}
           }
         }.to_json,
-        headers: { 'Content-Type' => 'application/json' }
+        headers: response_headers
       )
     end
 
@@ -216,6 +339,123 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
       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/creditor_bank_accounts$}).to_return(
+          body: {
+            'creditor_bank_accounts' => [{
+
+              'account_holder_name' => 'account_holder_name-input',
+              'account_number_ending' => 'account_number_ending-input',
+              'bank_name' => 'bank_name-input',
+              'country_code' => 'country_code-input',
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'enabled' => 'enabled-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input'
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1
+            }
+          }.to_json,
+          headers: response_headers
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/creditor_bank_accounts\?after=AB345})
+                               .to_timeout.then
+                               .to_return(
+                                 body: {
+                                   'creditor_bank_accounts' => [{
+
+                                     'account_holder_name' => 'account_holder_name-input',
+                                     'account_number_ending' => 'account_number_ending-input',
+                                     'bank_name' => 'bank_name-input',
+                                     'country_code' => 'country_code-input',
+                                     'created_at' => 'created_at-input',
+                                     'currency' => 'currency-input',
+                                     'enabled' => 'enabled-input',
+                                     'id' => 'id-input',
+                                     'links' => 'links-input',
+                                     'metadata' => 'metadata-input'
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {}
+                                   }
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+
+        client.creditor_bank_accounts.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/creditor_bank_accounts$}).to_return(
+          body: {
+            'creditor_bank_accounts' => [{
+
+              'account_holder_name' => 'account_holder_name-input',
+              'account_number_ending' => 'account_number_ending-input',
+              'bank_name' => 'bank_name-input',
+              'country_code' => 'country_code-input',
+              'created_at' => 'created_at-input',
+              'currency' => 'currency-input',
+              'enabled' => 'enabled-input',
+              'id' => 'id-input',
+              'links' => 'links-input',
+              'metadata' => 'metadata-input'
+            }],
+            meta: {
+              cursors: { after: 'AB345' },
+              limit: 1
+            }
+          }.to_json,
+          headers: response_headers
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/creditor_bank_accounts\?after=AB345})
+                               .to_return(
+                                 status: 502,
+                                 body: '<html><body>Response from Cloudflare</body></html>',
+                                 headers: { 'Content-Type' => 'text/html' }
+                               ).then.to_return(
+                                 body: {
+                                   'creditor_bank_accounts' => [{
+
+                                     'account_holder_name' => 'account_holder_name-input',
+                                     'account_number_ending' => 'account_number_ending-input',
+                                     'bank_name' => 'bank_name-input',
+                                     'country_code' => 'country_code-input',
+                                     'created_at' => 'created_at-input',
+                                     'currency' => 'currency-input',
+                                     'enabled' => 'enabled-input',
+                                     'id' => 'id-input',
+                                     'links' => 'links-input',
+                                     'metadata' => 'metadata-input'
+                                   }],
+                                   meta: {
+                                     limit: 2,
+                                     cursors: {}
+                                   }
+                                 }.to_json,
+                                 headers: response_headers
+                               )
+
+        client.creditor_bank_accounts.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
@@ -244,7 +484,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
                 'metadata' => 'metadata-input'
               }
             }.to_json,
-            headers: { 'Content-Type' => 'application/json' }
+            headers: response_headers
           )
       end
 
@@ -279,7 +519,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
               'metadata' => 'metadata-input'
             }
           }.to_json,
-          headers: { 'Content-Type' => 'application/json' }
+          headers: response_headers
         )
       end
 
@@ -293,7 +533,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
         stub_url = '/creditor_bank_accounts/:identity'.gsub(':identity', id)
         stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
           body: '',
-          headers: { 'Content-Type' => 'application/json' }
+          headers: response_headers
         )
       end
 
@@ -309,6 +549,33 @@ describe GoCardlessPro::Services::CreditorBankAccountsService 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 = '/creditor_bank_accounts/: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' do
+        stub_url = '/creditor_bank_accounts/: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
+    end
   end
 
   describe '#disable' do
@@ -335,7 +602,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
             'metadata' => 'metadata-input'
           }
         }.to_json,
-        headers: { 'Content-Type' => 'application/json' }
+        headers: response_headers
       )
     end
 
@@ -345,6 +612,17 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
       expect(stub).to have_been_requested
     end
 
+    describe 'retry behaviour' do
+      it "doesn't retry errors" do
+        stub_url = '/creditor_bank_accounts/:identity/actions/disable'.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' } }
@@ -375,7 +653,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
                 'metadata' => 'metadata-input'
               }
             }.to_json,
-            headers: { 'Content-Type' => 'application/json' }
+            headers: response_headers
           )
       end
     end