gocardless_pro 2.22.1 → 2.27.0

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

data/spec/services/scenario_simulators_service_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Services::ScenarioSimulatorsService do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#run' do
+    subject(:post_response) { client.scenario_simulators.run(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /scenario_simulators/%v/actions/run
+      stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'scenario_simulators' => {
+
+            'id' => 'id-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::ScenarioSimulator)
+
+      expect(stub).to have_been_requested
+    end
+
+    describe 'retry behaviour' do
+      it "doesn't retry errors" do
+        stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
+        stub = stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+               to_timeout
+
+        expect { post_response }.to raise_error(Faraday::ConnectionFailed)
+        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' } }
+      subject(:post_response) { client.scenario_simulators.run(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /scenario_simulators/%v/actions/run
+        stub_url = '/scenario_simulators/:identity/actions/run'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'scenario_simulators' => {
+
+                'id' => 'id-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  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