gocardless_pro 2.21.0 → 2.25.0

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.21.0'.freeze
+  VERSION = '2.25.0'.freeze
 end

data/spec/resources/payer_authorisation_spec.rb

@@ -0,0 +1,418 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::PayerAuthorisation do
+  let(:client) do
+    GoCardlessPro::Client.new(
+      access_token: 'SECRET_TOKEN'
+    )
+  end
+
+  let(:response_headers) { { 'Content-Type' => 'application/json' } }
+
+  describe '#get' do
+    let(:id) { 'ID123' }
+
+    subject(:get_response) { client.payer_authorisations.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      subject(:get_response) do
+        client.payer_authorisations.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 payer_authorisation to return' do
+      before do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payer_authorisations' => {
+
+              'bank_account' => 'bank_account-input',
+              'created_at' => 'created_at-input',
+              'customer' => 'customer-input',
+              'id' => 'id-input',
+              'incomplete_fields' => 'incomplete_fields-input',
+              'links' => 'links-input',
+              'mandate' => 'mandate-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+      end
+    end
+
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/payer_authorisations/: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
+
+  describe '#create' do
+    subject(:post_create_response) { client.payer_authorisations.create(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'bank_account' => 'bank_account-input',
+          'created_at' => 'created_at-input',
+          'customer' => 'customer-input',
+          'id' => 'id-input',
+          'incomplete_fields' => 'incomplete_fields-input',
+          'links' => 'links-input',
+          'mandate' => 'mandate-input',
+          'status' => 'status-input',
+        }
+      end
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).
+          with(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }
+          ).
+          to_return(
+            body: {
+              'payer_authorisations' =>
+
+                {
+
+                  'bank_account' => 'bank_account-input',
+                  'created_at' => 'created_at-input',
+                  'customer' => 'customer-input',
+                  'id' => 'id-input',
+                  'incomplete_fields' => 'incomplete_fields-input',
+                  'links' => 'links-input',
+                  'mandate' => 'mandate-input',
+                  'status' => 'status-input',
+                },
+
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      it 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).to_return(
+          body: {
+            error: {
+              type: 'validation_failed',
+              code: 422,
+              errors: [
+                { message: 'test error message', field: 'test_field' },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 422
+        )
+      end
+
+      it 'throws the correct error' do
+        expect { post_create_response }.to raise_error(GoCardlessPro::ValidationError)
+      end
+    end
+
+    context 'with a request that returns an idempotent creation conflict error' do
+      let(:id) { 'ID123' }
+
+      let(:new_resource) do
+        {
+
+          'bank_account' => 'bank_account-input',
+          'created_at' => 'created_at-input',
+          'customer' => 'customer-input',
+          'id' => 'id-input',
+          'incomplete_fields' => 'incomplete_fields-input',
+          'links' => 'links-input',
+          'mandate' => 'mandate-input',
+          'status' => 'status-input',
+        }
+      end
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/payer_authorisations}).to_return(
+          body: {
+            error: {
+              type: 'invalid_state',
+              code: 409,
+              errors: [
+                {
+                  message: 'A resource has already been created with this idempotency key',
+                  reason: 'idempotent_creation_conflict',
+                  links: {
+                    conflicting_resource_id: id,
+                  },
+                },
+              ],
+            },
+          }.to_json,
+          headers: response_headers,
+          status: 409
+        )
+      end
+
+      let!(:get_stub) do
+        stub_url = "/payer_authorisations/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+
+      it 'fetches the already-created resource' do
+        post_create_response
+        expect(post_stub).to have_been_requested
+        expect(get_stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#update' do
+    subject(:put_update_response) { client.payer_authorisations.update(id, params: update_params) }
+    let(:id) { 'ABC123' }
+
+    context 'with a valid request' do
+      let(:update_params) { { 'hello' => 'world' } }
+
+      let!(:stub) do
+        stub_url = '/payer_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:put, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'payer_authorisations' => {
+
+              'bank_account' => 'bank_account-input',
+              'created_at' => 'created_at-input',
+              'customer' => 'customer-input',
+              'id' => 'id-input',
+              'incomplete_fields' => 'incomplete_fields-input',
+              'links' => 'links-input',
+              'mandate' => 'mandate-input',
+              'status' => 'status-input',
+            },
+          }.to_json,
+          headers: response_headers
+        )
+      end
+
+      it 'updates and returns the resource' do
+        expect(put_update_response).to be_a(GoCardlessPro::Resources::PayerAuthorisation)
+        expect(stub).to have_been_requested
+      end
+    end
+  end
+
+  describe '#submit' do
+    subject(:post_response) { client.payer_authorisations.submit(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /payer_authorisations/%v/actions/submit
+      stub_url = '/payer_authorisations/:identity/actions/submit'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'payer_authorisations' => {
+
+            'bank_account' => 'bank_account-input',
+            'created_at' => 'created_at-input',
+            'customer' => 'customer-input',
+            'id' => 'id-input',
+            'incomplete_fields' => 'incomplete_fields-input',
+            'links' => 'links-input',
+            'mandate' => 'mandate-input',
+            'status' => 'status-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::PayerAuthorisation)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.payer_authorisations.submit(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /payer_authorisations/%v/actions/submit
+        stub_url = '/payer_authorisations/:identity/actions/submit'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+
+  describe '#confirm' do
+    subject(:post_response) { client.payer_authorisations.confirm(resource_id) }
+
+    let(:resource_id) { 'ABC123' }
+
+    let!(:stub) do
+      # /payer_authorisations/%v/actions/confirm
+      stub_url = '/payer_authorisations/:identity/actions/confirm'.gsub(':identity', resource_id)
+      stub_request(:post, /.*api.gocardless.com#{stub_url}/).to_return(
+        body: {
+          'payer_authorisations' => {
+
+            'bank_account' => 'bank_account-input',
+            'created_at' => 'created_at-input',
+            'customer' => 'customer-input',
+            'id' => 'id-input',
+            'incomplete_fields' => 'incomplete_fields-input',
+            'links' => 'links-input',
+            'mandate' => 'mandate-input',
+            'status' => 'status-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::PayerAuthorisation)
+
+      expect(stub).to have_been_requested
+    end
+
+    context 'when the request needs a body and custom header' do
+      let(:body) { { foo: 'bar' } }
+      let(:headers) { { 'Foo' => 'Bar' } }
+      subject(:post_response) { client.payer_authorisations.confirm(resource_id, body, headers) }
+
+      let(:resource_id) { 'ABC123' }
+
+      let!(:stub) do
+        # /payer_authorisations/%v/actions/confirm
+        stub_url = '/payer_authorisations/:identity/actions/confirm'.gsub(':identity', resource_id)
+        stub_request(:post, /.*api.gocardless.com#{stub_url}/).
+          with(
+            body: { foo: 'bar' },
+            headers: { 'Foo' => 'Bar' }
+          ).to_return(
+            body: {
+              'payer_authorisations' => {
+
+                'bank_account' => 'bank_account-input',
+                'created_at' => 'created_at-input',
+                'customer' => 'customer-input',
+                'id' => 'id-input',
+                'incomplete_fields' => 'incomplete_fields-input',
+                'links' => 'links-input',
+                'mandate' => 'mandate-input',
+                'status' => 'status-input',
+              },
+            }.to_json,
+            headers: response_headers
+          )
+      end
+    end
+  end
+end