gocardless_pro 2.19.0 → 2.23.0

data/spec/services/redirect_flows_service_spec.rb

@@ -411,7 +411,7 @@ describe GoCardlessPro::Services::RedirectFlowsService 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/subscriptions_service_spec.rb

@@ -916,7 +916,7 @@ describe GoCardlessPro::Services::SubscriptionsService 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
@@ -1017,7 +1017,7 @@ describe GoCardlessPro::Services::SubscriptionsService 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
@@ -1118,7 +1118,7 @@ describe GoCardlessPro::Services::SubscriptionsService 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/tax_rates_service_spec.rb

@@ -0,0 +1,381 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Services::TaxRatesService 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 }
+
+      let(:body) do
+        {
+          '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
+      end
+
+      before do
+        stub_request(:get, %r{.*api.gocardless.com/tax_rates}).to_return(
+          body: body,
+          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') }
+
+      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/tax_rates}).
+                 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/tax_rates}).
+                 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
+
+  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
+
+    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/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
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/tax_rates\?after=AB345}).
+                               to_timeout.then.
+                               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
+                               )
+
+        client.tax_rates.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/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
+        )
+
+        second_response_stub = stub_request(:get, %r{.*api.gocardless.com/tax_rates\?after=AB345}).
+                               to_return(
+                                 status: 502,
+                                 body: '<html><body>Response from Cloudflare</body></html>',
+                                 headers: { 'Content-Type' => 'text/html' }
+                               ).then.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
+                               )
+
+        client.tax_rates.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
+    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
+
+    describe 'retry behaviour' do
+      before { allow_any_instance_of(GoCardlessPro::Request).to receive(:sleep) }
+
+      it 'retries timeouts' do
+        stub_url = '/tax_rates/: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, other than 500s' do
+        stub_url = '/tax_rates/: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
+
+      it 'retries 500 errors returned by the API' do
+        stub_url = '/tax_rates/:identity'.gsub(':identity', id)
+
+        gocardless_error = {
+          'error' => {
+            'message' => 'Internal server error',
+            'documentation_url' => 'https://developer.gocardless.com/#gocardless',
+            'errors' => [{
+              'message' => 'Internal server error',
+              'reason' => 'internal_server_error',
+            }],
+            'type' => 'gocardless',
+            'code' => 500,
+            'request_id' => 'dummy_request_id',
+            'id' => 'dummy_exception_id',
+          },
+        }
+
+        stub = stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+               to_return(status: 500,
+                         headers: response_headers,
+                         body: gocardless_error.to_json).
+               then.to_return(status: 200, headers: response_headers)
+
+        get_response
+        expect(stub).to have_been_requested.twice
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 2.19.0
+  version: 2.23.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -19,7 +19,7 @@ dependencies:
         version: 0.9.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 0.9.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: 3.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: 3.8.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '13'
-description: 
+description:
 email:
 - engineering@gocardless.com
 executables: []
@@ -178,6 +178,7 @@ files:
 - lib/gocardless_pro/resources/redirect_flow.rb
 - lib/gocardless_pro/resources/refund.rb
 - lib/gocardless_pro/resources/subscription.rb
+- lib/gocardless_pro/resources/tax_rate.rb
 - lib/gocardless_pro/response.rb
 - lib/gocardless_pro/services/bank_details_lookups_service.rb
 - lib/gocardless_pro/services/base_service.rb
@@ -199,6 +200,7 @@ files:
 - lib/gocardless_pro/services/redirect_flows_service.rb
 - lib/gocardless_pro/services/refunds_service.rb
 - lib/gocardless_pro/services/subscriptions_service.rb
+- lib/gocardless_pro/services/tax_rates_service.rb
 - lib/gocardless_pro/version.rb
 - lib/gocardless_pro/webhook.rb
 - spec/api_response_spec.rb
@@ -225,6 +227,7 @@ files:
 - spec/resources/redirect_flow_spec.rb
 - spec/resources/refund_spec.rb
 - spec/resources/subscription_spec.rb
+- spec/resources/tax_rate_spec.rb
 - spec/response_spec.rb
 - spec/services/bank_details_lookups_service_spec.rb
 - spec/services/creditor_bank_accounts_service_spec.rb
@@ -245,13 +248,14 @@ files:
 - spec/services/redirect_flows_service_spec.rb
 - spec/services/refunds_service_spec.rb
 - spec/services/subscriptions_service_spec.rb
+- spec/services/tax_rates_service_spec.rb
 - spec/spec_helper.rb
 - spec/webhook_spec.rb
 homepage: https://github.com/gocardless/gocardless-pro-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -266,8 +270,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A gem for calling the GoCardless Pro API
 test_files:
@@ -295,6 +299,7 @@ test_files:
 - spec/resources/redirect_flow_spec.rb
 - spec/resources/refund_spec.rb
 - spec/resources/subscription_spec.rb
+- spec/resources/tax_rate_spec.rb
 - spec/response_spec.rb
 - spec/services/bank_details_lookups_service_spec.rb
 - spec/services/creditor_bank_accounts_service_spec.rb
@@ -315,5 +320,6 @@ test_files:
 - spec/services/redirect_flows_service_spec.rb
 - spec/services/refunds_service_spec.rb
 - spec/services/subscriptions_service_spec.rb
+- spec/services/tax_rates_service_spec.rb
 - spec/spec_helper.rb
 - spec/webhook_spec.rb