gocardless_pro 2.22.1 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2380802da7e32b788d03eb0ce5965cb79b27f310c7643bf40078880823dcb2f7
-  data.tar.gz: ad1ebf6cbec94675df50e0b4a0154fb2eea77f659993625c5d8a9bcb8bd9f7df
+  metadata.gz: 380e86ab83d0876327222f7966dbae08687e51cec34c468f2f57b9064a6de49b
+  data.tar.gz: 92a6001ee0d724bb218d3d4ef6e245389842391b8d251e7b79afe6210432367a
 SHA512:
-  metadata.gz: 54622b040fa474ef16f0431e439bef3603d45cdf74c6001bc175fc638057db41231eae81cd9c502e5d16f3a796d6c1e068d27907aeacc1b0bfceb15186bcce0b
-  data.tar.gz: e89435ce6a6da8761c8b113e93f34fe1c7268e462aeda83fe8183620334c35f939c362efc1027b7bf0e3bef1a0ab9d56bb1eacf09e3ab64fd6596f1cc0055ad1
+  metadata.gz: 6241d24b24dcf35224c87bf2c559c3a0c6f543ef4f3e2c73885e8aee1a4cccc9e8fb748d323df5768c9acd01510b0ae78cf8182d2d684a7feb119bd91ad0c5ac
+  data.tar.gz: 2981ece7e5ad7cef1056ed51a02dc805c5a4c3d41ec483604e2b0ae2a552ca6cd2d2da1e7a92fa1740c9ce61b55e3fecd27c9138817bcf87a8d830047acdd552

data/lib/gocardless_pro.rb

@@ -95,4 +95,7 @@ require_relative 'gocardless_pro/services/refunds_service'
 require_relative 'gocardless_pro/resources/subscription'
 require_relative 'gocardless_pro/services/subscriptions_service'
 
+require_relative 'gocardless_pro/resources/tax_rate'
+require_relative 'gocardless_pro/services/tax_rates_service'
+
 require_relative 'gocardless_pro/client.rb'

data/lib/gocardless_pro/client.rb

@@ -98,6 +98,11 @@ module GoCardlessPro
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
     end
 
+    # Access to the service for tax_rate to make API calls
+    def tax_rates
+      @tax_rates ||= Services::TaxRatesService.new(@api_service)
+    end
+
     # Get a Client configured to use HTTP Basic authentication with the GC Api
     #
     # @param options [Hash<Symbol,String>] configuration for creating the client
@@ -148,7 +153,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.22.1',
+          'GoCardless-Client-Version' => '2.23.0',
         },
       }
     end

data/lib/gocardless_pro/resources/payout.rb

@@ -30,6 +30,7 @@ module GoCardlessPro
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
+      attr_reader :tax_currency
 
       # Initialize a payout resource instance
       # @param object [Hash] an object returned from the API
@@ -48,6 +49,7 @@ module GoCardlessPro
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']
+        @tax_currency = object['tax_currency']
         @response = response
       end
 

data/lib/gocardless_pro/resources/payout_item.rb

@@ -32,6 +32,7 @@ module GoCardlessPro
     #
     class PayoutItem
       attr_reader :amount
+      attr_reader :taxes
       attr_reader :type
 
       # Initialize a payout_item resource instance
@@ -41,6 +42,7 @@ module GoCardlessPro
 
         @amount = object['amount']
         @links = object['links']
+        @taxes = object['taxes']
         @type = object['type']
         @response = response
       end

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a tax_rate resource returned from the API
+
+    # Tax rates from tax authority.
+    class TaxRate
+      attr_reader :end_date
+      attr_reader :id
+      attr_reader :jurisdiction
+      attr_reader :percentage
+      attr_reader :start_date
+      attr_reader :type
+
+      # Initialize a tax_rate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @end_date = object['end_date']
+        @id = object['id']
+        @jurisdiction = object['jurisdiction']
+        @percentage = object['percentage']
+        @start_date = object['start_date']
+        @type = object['type']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the tax_rate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/tax_rates_service.rb

@@ -0,0 +1,74 @@
+require_relative './base_service'
+
+# encoding: utf-8
+#
+# This client is automatically generated from a template and JSON schema definition.
+# See https://github.com/gocardless/gocardless-pro-ruby#contributing before editing.
+#
+
+module GoCardlessPro
+  module Services
+    # Service for making requests to the TaxRate endpoints
+    class TaxRatesService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of all tax
+      # rates.
+      # Example URL: /tax_rates
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/tax_rates'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::TaxRate
+        )
+      end
+
+      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      #
+      # @param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters.
+      # Otherwise they will be the body of the request.
+      def all(options = {})
+        Paginator.new(
+          service: self,
+          options: options
+        ).enumerator
+      end
+
+      # Retrieves the details of a tax rate.
+      # Example URL: /tax_rates/:identity
+      #
+      # @param identity       # The unique identifier created by the jurisdiction, tax type and version
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/tax_rates/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::TaxRate.new(unenvelope_body(response.body), response)
+      end
+
+      private
+
+      # Unenvelope the response of the body using the service's `envelope_key`
+      #
+      # @param body [Hash]
+      def unenvelope_body(body)
+        body[envelope_key] || body['data']
+      end
+
+      # return the key which API responses will envelope data under
+      def envelope_key
+        'tax_rates'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/version.rb

@@ -4,5 +4,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '2.22.1'.freeze
+  VERSION = '2.23.0'.freeze
 end

data/spec/resources/payout_item_spec.rb

@@ -20,6 +20,7 @@ describe GoCardlessPro::Resources::PayoutItem do
 
               'amount' => 'amount-input',
               'links' => 'links-input',
+              'taxes' => 'taxes-input',
               'type' => 'type-input',
             }],
             meta: {
@@ -38,6 +39,8 @@ describe GoCardlessPro::Resources::PayoutItem 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
 
@@ -58,6 +61,7 @@ describe GoCardlessPro::Resources::PayoutItem do
 
             'amount' => 'amount-input',
             'links' => 'links-input',
+            'taxes' => 'taxes-input',
             'type' => 'type-input',
           }],
           meta: {
@@ -76,6 +80,7 @@ describe GoCardlessPro::Resources::PayoutItem do
 
             'amount' => 'amount-input',
             'links' => 'links-input',
+            'taxes' => 'taxes-input',
             'type' => 'type-input',
           }],
           meta: {

data/spec/resources/payout_spec.rb

@@ -30,6 +30,7 @@ describe GoCardlessPro::Resources::Payout do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             }],
             meta: {
               cursors: {
@@ -66,6 +67,8 @@ describe GoCardlessPro::Resources::Payout 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
@@ -95,6 +98,7 @@ describe GoCardlessPro::Resources::Payout do
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
+            'tax_currency' => 'tax_currency-input',
           }],
           meta: {
             cursors: { after: 'AB345' },
@@ -122,6 +126,7 @@ describe GoCardlessPro::Resources::Payout do
             'payout_type' => 'payout_type-input',
             'reference' => 'reference-input',
             'status' => 'status-input',
+            'tax_currency' => 'tax_currency-input',
           }],
           meta: {
             limit: 2,
@@ -165,6 +170,7 @@ describe GoCardlessPro::Resources::Payout do
                 'payout_type' => 'payout_type-input',
                 'reference' => 'reference-input',
                 'status' => 'status-input',
+                'tax_currency' => 'tax_currency-input',
               },
             }.to_json,
             headers: response_headers
@@ -202,6 +208,7 @@ describe GoCardlessPro::Resources::Payout do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             },
           }.to_json,
           headers: response_headers
@@ -261,6 +268,7 @@ describe GoCardlessPro::Resources::Payout do
               'payout_type' => 'payout_type-input',
               'reference' => 'reference-input',
               'status' => 'status-input',
+              'tax_currency' => 'tax_currency-input',
             },
           }.to_json,
           headers: response_headers

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/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/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.22.1
+  version: 2.23.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-15 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -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.8
-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