gocardless_pro 2.20.0 → 2.24.0

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -239,15 +238,6 @@ module GoCardlessPro
       def envelope_key
         'instalment_schedules'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/mandate_import_entries_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -85,15 +84,6 @@ module GoCardlessPro
       def envelope_key
         'mandate_import_entries'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/mandate_imports_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -176,15 +175,6 @@ module GoCardlessPro
       def envelope_key
         'mandate_imports'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/mandate_pdfs_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -85,15 +84,6 @@ module GoCardlessPro
       def envelope_key
         'mandate_pdfs'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/mandates_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -225,15 +224,6 @@ module GoCardlessPro
       def envelope_key
         'mandates'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payments_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -225,15 +224,6 @@ module GoCardlessPro
       def envelope_key
         'payments'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payout_items_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -54,15 +53,6 @@ module GoCardlessPro
       def envelope_key
         'payout_items'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/payouts_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -93,15 +92,6 @@ module GoCardlessPro
       def envelope_key
         'payouts'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -127,15 +126,6 @@ module GoCardlessPro
       def envelope_key
         'redirect_flows'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/refunds_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -14,7 +13,8 @@ module GoCardlessPro
       # Creates a new refund object.
       #
       # This fails with:<a name="total_amount_confirmation_invalid"></a><a
-      # name="number_of_refunds_exceeded"></a>
+      # name="number_of_refunds_exceeded"></a><a
+      # name="available_refund_amount_insufficient"></a>
       #
       # - `total_amount_confirmation_invalid` if the confirmation amount doesn't match
       # the total amount refunded for the payment. This safeguard is there to prevent
@@ -23,6 +23,10 @@ module GoCardlessPro
       # - `number_of_refunds_exceeded` if five or more refunds have already been
       # created against the payment.
       #
+      # - `available_refund_amount_insufficient` if the creditor does not have
+      # sufficient balance for refunds available to cover the cost of the requested
+      # refund.
+      #
       # Example URL: /refunds
       # @param options [Hash] parameters as a hash, under a params key.
       def create(options = {})
@@ -139,15 +143,6 @@ module GoCardlessPro
       def envelope_key
         'refunds'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -148,7 +147,7 @@ module GoCardlessPro
       # When `pause_cycles` is omitted the subscription is paused until the [resume
       # endpoint](#subscriptions-resume-a-subscription) is called.
       # If the subscription is collecting a fixed number of payments, `end_date` will
-      # be set to `nil`.
+      # be set to `null`.
       # When paused indefinitely, `upcoming_payments` will be empty.
       #
       # When `pause_cycles` is provided the subscription will be paused for the number
@@ -324,15 +323,6 @@ module GoCardlessPro
       def envelope_key
         'subscriptions'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      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.20.0'.freeze
+  VERSION = '2.24.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