gocardless_pro 2.19.0 → 2.23.0

data/spec/resources/tax_rate_spec.rb

@@ -0,0 +1,198 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::TaxRate 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.tax_rates.list }
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/tax_rates}).to_return(
+          body: {
+            'tax_rates' => [{
+
+              'end_date' => 'end_date-input',
+              'id' => 'id-input',
+              'jurisdiction' => 'jurisdiction-input',
+              'percentage' => 'percentage-input',
+              'start_date' => 'start_date-input',
+              'type' => 'type-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::TaxRate)
+
+        expect(get_list_response.records.first.end_date).to eq('end_date-input')
+
+        expect(get_list_response.records.first.id).to eq('id-input')
+
+        expect(get_list_response.records.first.jurisdiction).to eq('jurisdiction-input')
+
+        expect(get_list_response.records.first.percentage).to eq('percentage-input')
+
+        expect(get_list_response.records.first.start_date).to eq('start_date-input')
+
+        expect(get_list_response.records.first.type).to eq('type-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/tax_rates$}).to_return(
+        body: {
+          'tax_rates' => [{
+
+            'end_date' => 'end_date-input',
+            'id' => 'id-input',
+            'jurisdiction' => 'jurisdiction-input',
+            'percentage' => 'percentage-input',
+            'start_date' => 'start_date-input',
+            'type' => 'type-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/tax_rates\?after=AB345}).to_return(
+        body: {
+          'tax_rates' => [{
+
+            'end_date' => 'end_date-input',
+            'id' => 'id-input',
+            'jurisdiction' => 'jurisdiction-input',
+            'percentage' => 'percentage-input',
+            'start_date' => 'start_date-input',
+            'type' => 'type-input',
+          }],
+          meta: {
+            limit: 2,
+            cursors: {},
+          },
+        }.to_json,
+        headers: response_headers
+      )
+    end
+
+    it 'automatically makes the extra requests' do
+      expect(client.tax_rates.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 '#get' do
+    let(:id) { 'ID123' }
+
+    subject(:get_response) { client.tax_rates.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/tax_rates/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          to_return(
+            body: {
+              'tax_rates' => {
+
+                'end_date' => 'end_date-input',
+                'id' => 'id-input',
+                'jurisdiction' => 'jurisdiction-input',
+                'percentage' => 'percentage-input',
+                'start_date' => 'start_date-input',
+                'type' => 'type-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      subject(:get_response) do
+        client.tax_rates.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 tax_rate to return' do
+      before do
+        stub_url = '/tax_rates/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'tax_rates' => {
+
+              'end_date' => 'end_date-input',
+              'id' => 'id-input',
+              'jurisdiction' => 'jurisdiction-input',
+              'percentage' => 'percentage-input',
+              'start_date' => 'start_date-input',
+              'type' => 'type-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::TaxRate)
+      end
+    end
+
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/tax_rates/: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
+end

data/spec/services/creditor_bank_accounts_service_spec.rb

@@ -692,7 +692,7 @@ describe GoCardlessPro::Services::CreditorBankAccountsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customer_bank_accounts_service_spec.rb

@@ -754,7 +754,7 @@ describe GoCardlessPro::Services::CustomerBankAccountsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customer_notifications_service_spec.rb

@@ -45,7 +45,7 @@ describe GoCardlessPro::Services::CustomerNotificationsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/customers_service_spec.rb

@@ -882,7 +882,7 @@ describe GoCardlessPro::Services::CustomersService do
         stub = stub_request(:delete, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { delete_response }.to raise_error(Faraday::TimeoutError)
+        expect { delete_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/instalment_schedules_service_spec.rb

@@ -828,6 +828,66 @@ describe GoCardlessPro::Services::InstalmentSchedulesService do
     end
   end
 
+  describe '#update' do
+    subject(:put_update_response) { client.instalment_schedules.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*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 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::InstalmentSchedule)
+        expect(stub).to have_been_requested
+      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(:put, /.*api.gocardless.com#{stub_url}/).
+                 to_timeout.then.to_return(status: 200, headers: response_headers)
+
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+
+        it 'retries 5XX errors' do
+          stub_url = '/instalment_schedules/:identity'.gsub(':identity', id)
+          stub = stub_request(:put, /.*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)
+
+          put_update_response
+          expect(stub).to have_been_requested.twice
+        end
+      end
+    end
+  end
+
   describe '#cancel' do
     subject(:post_response) { client.instalment_schedules.cancel(resource_id) }
 
@@ -867,7 +927,7 @@ describe GoCardlessPro::Services::InstalmentSchedulesService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/mandate_imports_service_spec.rb

@@ -363,7 +363,7 @@ describe GoCardlessPro::Services::MandateImportsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end
@@ -432,7 +432,7 @@ describe GoCardlessPro::Services::MandateImportsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/mandates_service_spec.rb

@@ -718,7 +718,7 @@ describe GoCardlessPro::Services::MandatesService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end
@@ -797,7 +797,7 @@ describe GoCardlessPro::Services::MandatesService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/payments_service_spec.rb

@@ -790,7 +790,7 @@ describe GoCardlessPro::Services::PaymentsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end
@@ -877,7 +877,7 @@ describe GoCardlessPro::Services::PaymentsService do
         stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
                to_timeout
 
-        expect { post_response }.to raise_error(Faraday::TimeoutError)
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
         expect(stub).to have_been_requested
       end
     end

data/spec/services/payout_items_service_spec.rb

@@ -19,6 +19,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
             'amount' => 'amount-input',
             'links' => 'links-input',
+            'taxes' => 'taxes-input',
             'type' => 'type-input',
           }],
           meta: {
@@ -42,6 +43,8 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
         expect(get_list_response.records.first.amount).to eq('amount-input')
 
+        expect(get_list_response.records.first.taxes).to eq('taxes-input')
+
         expect(get_list_response.records.first.type).to eq('type-input')
       end
 
@@ -85,6 +88,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
             'amount' => 'amount-input',
             'links' => 'links-input',
+            'taxes' => 'taxes-input',
             'type' => 'type-input',
           }],
           meta: {
@@ -103,6 +107,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
             'amount' => 'amount-input',
             'links' => 'links-input',
+            'taxes' => 'taxes-input',
             'type' => 'type-input',
           }],
           meta: {
@@ -130,6 +135,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
               'amount' => 'amount-input',
               'links' => 'links-input',
+              'taxes' => 'taxes-input',
               'type' => 'type-input',
             }],
             meta: {
@@ -148,6 +154,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
                                      'amount' => 'amount-input',
                                      'links' => 'links-input',
+                                     'taxes' => 'taxes-input',
                                      'type' => 'type-input',
                                    }],
                                    meta: {
@@ -171,6 +178,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
               'amount' => 'amount-input',
               'links' => 'links-input',
+              'taxes' => 'taxes-input',
               'type' => 'type-input',
             }],
             meta: {
@@ -192,6 +200,7 @@ describe GoCardlessPro::Services::PayoutItemsService do
 
                                      'amount' => 'amount-input',
                                      'links' => 'links-input',
+                                     'taxes' => 'taxes-input',
                                      'type' => 'type-input',
                                    }],
                                    meta: {

data/spec/services/payouts_service_spec.rb

@@ -29,6 +29,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
+            'tax_currency' => 'tax_currency-input',
           }],
           meta: {
             cursors: {
@@ -70,6 +71,8 @@ describe GoCardlessPro::Services::PayoutsService do
         expect(get_list_response.records.first.reference).to eq('reference-input')
 
         expect(get_list_response.records.first.status).to eq('status-input')
+
+        expect(get_list_response.records.first.tax_currency).to eq('tax_currency-input')
       end
 
       it 'exposes the cursors for before and after' do
@@ -122,6 +125,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
+            'tax_currency' => 'tax_currency-input',
           }],
           meta: {
             cursors: { after: 'AB345' },
@@ -149,6 +153,7 @@ describe GoCardlessPro::Services::PayoutsService do
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
+            'tax_currency' => 'tax_currency-input',
           }],
           meta: {
             limit: 2,
@@ -185,6 +190,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             }],
             meta: {
               cursors: { after: 'AB345' },
@@ -212,6 +218,7 @@ describe GoCardlessPro::Services::PayoutsService do
                                      'payout_type' => 'payout_type-input',
                                      'reference' => 'reference-input',
                                      'status' => 'status-input',
+                                     'tax_currency' => 'tax_currency-input',
                                    }],
                                    meta: {
                                      limit: 2,
@@ -244,6 +251,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             }],
             meta: {
               cursors: { after: 'AB345' },
@@ -274,6 +282,7 @@ describe GoCardlessPro::Services::PayoutsService do
                                      'payout_type' => 'payout_type-input',
                                      'reference' => 'reference-input',
                                      'status' => 'status-input',
+                                     'tax_currency' => 'tax_currency-input',
                                    }],
                                    meta: {
                                      limit: 2,
@@ -317,6 +326,7 @@ describe GoCardlessPro::Services::PayoutsService do
                 'payout_type' => 'payout_type-input',
                 'reference' => 'reference-input',
                 'status' => 'status-input',
+                'tax_currency' => 'tax_currency-input',
               },
             }.to_json,
             headers: response_headers
@@ -354,6 +364,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             },
           }.to_json,
           headers: response_headers
@@ -468,6 +479,7 @@ describe GoCardlessPro::Services::PayoutsService do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             },
           }.to_json,
           headers: response_headers