gocardless_pro 2.27.0 → 2.30.0

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -52,8 +52,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -102,8 +100,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -133,7 +129,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.
@@ -212,8 +208,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/institutions_service.rb

@@ -10,7 +10,7 @@ module GoCardlessPro
   module Services
     # Service for making requests to the Institution endpoints
     class InstitutionsService < BaseService
-      # Returns a list of all supported institutions.
+      # Returns a list of supported institutions.
       # Example URL: /institutions
       # @param options [Hash] parameters as a hash, under a params key.
       def list(options = {})
@@ -27,7 +27,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/mandate_import_entries_service.rb

@@ -60,7 +60,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/mandate_imports_service.rb

@@ -38,8 +38,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -104,8 +102,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -149,8 +145,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/mandates_service.rb

@@ -34,8 +34,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -65,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.
@@ -148,8 +146,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -198,8 +194,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/payer_authorisations_service.rb

@@ -57,8 +57,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -128,8 +126,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -177,8 +173,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/payments_service.rb

@@ -39,8 +39,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -70,7 +68,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.
@@ -150,8 +148,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -198,8 +194,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/payout_items_service.rb

@@ -29,7 +29,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/payouts_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -35,8 +35,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -100,8 +98,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/refunds_service.rb

@@ -50,8 +50,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -81,7 +79,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/scenario_simulators_service.rb

@@ -27,6 +27,11 @@ module GoCardlessPro
       # <li>`creditor_verification_status_successful`: Sets a creditor's
       # `verification status` to `successful`, meaning that the creditor is
       # fully verified and can receive payouts.</li>
+      # <li>`payment_confirmed`: Transitions a payment through to `confirmed`.
+      # It must start in the `pending_submission` state, and its mandate must be
+      # in the `activated` state (unless it is a payment for ACH, BECS, BECS_NZ
+      # or SEPA, in which cases the mandate may be `pending_submission`, since
+      # their mandates are submitted with their first payment).</li>
       # <li>`payment_paid_out`: Transitions a payment through to `paid_out`,
       # having been collected successfully and paid out to you. It must start in
       # the `pending_submission` state, and its mandate must be in the
@@ -82,8 +87,8 @@ module GoCardlessPro
       # <li>`mandate_failed`: Transitions a mandate through to `failed`, having
       # been submitted to the banks but found to be invalid (for example due to
       # invalid bank details). It must start in the `pending_submission` or
-      # `submitted` states. Not compatible with ACH, BECS, BECS_NZ and SEPA
-      # mandates, which are submitted with their first payment.</li>
+      # `submitted` states. Not compatible with SEPA mandates, which are
+      # submitted with their first payment.</li>
       # <li>`mandate_expired`: Transitions a mandate through to `expired`,
       # having been submitted to the banks, set up successfully and then expired
       # because no collection attempts were made against it for longer than the
@@ -104,14 +109,31 @@ module GoCardlessPro
       # mandates.</li>
       # <li>`refund_paid`: Transitions a refund to `paid`. It must start in
       # either the `pending_submission` or `submitted` state.</li>
+      # <li>`refund_settled`: Transitions a refund to `paid`, if it's not
+      # already, then generates a payout that includes the refund, thereby
+      # settling the funds. It must start in one of `pending_submission`,
+      # `submitted` or `paid` states.</li>
       # <li>`refund_bounced`: Transitions a refund to `bounced`. It must start
       # in either the `pending_submission`, `submitted`, or `paid` state.</li>
+      # <li>`refund_returned`: Transitions a refund to `refund_returned`. The
+      # refund must start in `pending_submission`.</li>
       # <li>`payout_bounced`: Transitions a payout to `bounced`. It must start
       # in the `paid` state.</li>
-      # <li>`payout_create`: Creates a payout containing payments in
-      # `confirmed`, `failed` & `charged_back` states; refunds in `submitted` &
-      # `bounced`; and all related fees. Can only be used with a positive total
-      # payout balance and when some eligible items exist.</li>
+      # <li>`billing_request_fulfilled`: Authorises the billing request, fulfils
+      # it, and moves the associated payment to `failed`. The billing request
+      # must be in the `pending` state, with all actions completed except for
+      # `bank_authorisation`. Only billing requests with a `payment_request` are
+      # supported.</li>
+      # <li>`billing_request_fulfilled_and_payment_failed`: Authorises the
+      # billing request, fulfils it, and moves the associated payment to
+      # `failed`. The billing request must be in the `pending` state, with all
+      # actions completed except for `bank_authorisation`. Only billing requests
+      # with a `payment_request` are supported.</li>
+      # <li>`billing_request_fulfilled_and_payment_paid_out`: Authorises the
+      # billing request, fulfils it, and moves the associated payment to
+      # `paid_out`. The billing request must be in the `pending` state, with all
+      # actions completed except for `bank_authorisation`. Only billing requests
+      # with a `payment_request` are supported.</li>
       # </ul>
       # @param options [Hash] parameters as a hash, under a params key.
       def run(identity, options = {})

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -34,8 +34,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -65,7 +63,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.
@@ -140,10 +138,10 @@ module GoCardlessPro
       # Pause a subscription object.
       # No payments will be created until it is resumed.
       #
-      # This can only be used when a subscription collecting a fixed number of
+      # This can only be used when a subscription is collecting a fixed number of
       # payments (created using `count`),
       # when they continue forever (created without `count` or `end_date`) or
-      # the subscription is paused for a number of cycles.
+      # the subscription is already paused for a number of cycles.
       #
       # When `pause_cycles` is omitted the subscription is paused until the [resume
       # endpoint](#subscriptions-resume-a-subscription) is called.
@@ -203,8 +201,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -258,8 +254,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 
@@ -302,8 +296,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/services/tax_rates_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.

data/lib/gocardless_pro/services/webhooks_service.rb

@@ -28,7 +28,7 @@ module GoCardlessPro
         )
       end
 
-      # Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.
+      # Get a lazily enumerated list of all the items returned. This is similar 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.
@@ -82,8 +82,6 @@ module GoCardlessPro
               raise IdempotencyConflict, e.error
             when :fetch
               return get(e.conflicting_resource_id)
-            else
-              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
             end
           end
 

data/lib/gocardless_pro/version.rb

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

data/lib/gocardless_pro.rb

@@ -32,6 +32,9 @@ require_relative 'gocardless_pro/error/gocardless_error'
 require_relative 'gocardless_pro/error/invalid_api_usage_error'
 require_relative 'gocardless_pro/error/invalid_state_error'
 require_relative 'gocardless_pro/error/api_error'
+require_relative 'gocardless_pro/error/permission_error'
+require_relative 'gocardless_pro/error/authentication_error'
+require_relative 'gocardless_pro/error/rate_limit_error'
 require_relative 'gocardless_pro/paginator'
 require_relative 'gocardless_pro/request'
 require_relative 'gocardless_pro/response'
@@ -50,6 +53,12 @@ require_relative 'gocardless_pro/services/billing_requests_service'
 require_relative 'gocardless_pro/resources/billing_request_flow'
 require_relative 'gocardless_pro/services/billing_request_flows_service'
 
+require_relative 'gocardless_pro/resources/billing_request_template'
+require_relative 'gocardless_pro/services/billing_request_templates_service'
+
+require_relative 'gocardless_pro/resources/block'
+require_relative 'gocardless_pro/services/blocks_service'
+
 require_relative 'gocardless_pro/resources/creditor'
 require_relative 'gocardless_pro/services/creditors_service'
 

data/spec/api_service_spec.rb

@@ -1,8 +1,11 @@
 require 'spec_helper'
 
 describe GoCardlessPro::ApiService do
-  subject(:service) { described_class.new('https://api.example.com', 'secret_token') }
+  subject(:service) do
+    described_class.new('https://api.example.com', 'secret_token', options)
+  end
 
+  let(:options) { {} }
   let(:default_response) do
     {
       status: 200,
@@ -174,4 +177,12 @@ describe GoCardlessPro::ApiService do
       expect(stub).to have_been_requested
     end
   end
+
+  describe 'when passing an invalid :on_idempotency_conflict' do
+    let(:options) { { on_idempotency_conflict: :junk } }
+
+    it 'raises an error' do
+      expect { service }.to raise_error(ArgumentError)
+    end
+  end
 end

data/spec/middlewares/raise_gocardless_errors_spec.rb

@@ -74,6 +74,36 @@ describe GoCardlessPro::Middlewares::RaiseGoCardlessErrors do
       end
     end
 
+    context 'for a Permission error' do
+      let(:status) { 403 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::PermissionError)
+      end
+    end
+
+    context 'for a RateLimit error' do
+      let(:status) { 429 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::RateLimitError)
+      end
+    end
+
+    context 'for a Authentication error' do
+      let(:status) { 401 }
+      let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }
+
+      it 'raises a GoCardlessError' do
+        expect { connection.post('https://api.gocardless.com/widgets') }.
+          to raise_error(GoCardlessPro::AuthenticationError)
+      end
+    end
+
     context 'for an invalid API usage error' do
       let(:status) { 400 }
       let(:body) { { error: { type: 'invalid_api_usage' } }.to_json }

data/spec/resources/bank_authorisation_spec.rb

@@ -24,13 +24,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }.to_json,
@@ -58,13 +58,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
             'bank_authorisations' => {
 
               'authorisation_type' => 'authorisation_type-input',
+              'authorised_at' => 'authorised_at-input',
               'created_at' => 'created_at-input',
               'expires_at' => 'expires_at-input',
               'id' => 'id-input',
               'last_visited_at' => 'last_visited_at-input',
               'links' => 'links-input',
               'redirect_uri' => 'redirect_uri-input',
-              'short_url' => 'short_url-input',
               'url' => 'url-input',
             },
           }.to_json,
@@ -107,13 +107,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
         {
 
           'authorisation_type' => 'authorisation_type-input',
+          'authorised_at' => 'authorised_at-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'last_visited_at' => 'last_visited_at-input',
           'links' => 'links-input',
           'redirect_uri' => 'redirect_uri-input',
-          'short_url' => 'short_url-input',
           'url' => 'url-input',
         }
       end
@@ -125,13 +125,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }
@@ -143,13 +143,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
                 {
 
                   'authorisation_type' => 'authorisation_type-input',
+                  'authorised_at' => 'authorised_at-input',
                   'created_at' => 'created_at-input',
                   'expires_at' => 'expires_at-input',
                   'id' => 'id-input',
                   'last_visited_at' => 'last_visited_at-input',
                   'links' => 'links-input',
                   'redirect_uri' => 'redirect_uri-input',
-                  'short_url' => 'short_url-input',
                   'url' => 'url-input',
                 },
 
@@ -194,13 +194,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
         {
 
           'authorisation_type' => 'authorisation_type-input',
+          'authorised_at' => 'authorised_at-input',
           'created_at' => 'created_at-input',
           'expires_at' => 'expires_at-input',
           'id' => 'id-input',
           'last_visited_at' => 'last_visited_at-input',
           'links' => 'links-input',
           'redirect_uri' => 'redirect_uri-input',
-          'short_url' => 'short_url-input',
           'url' => 'url-input',
         }
       end
@@ -235,13 +235,13 @@ describe GoCardlessPro::Resources::BankAuthorisation do
               'bank_authorisations' => {
 
                 'authorisation_type' => 'authorisation_type-input',
+                'authorised_at' => 'authorised_at-input',
                 'created_at' => 'created_at-input',
                 'expires_at' => 'expires_at-input',
                 'id' => 'id-input',
                 'last_visited_at' => 'last_visited_at-input',
                 'links' => 'links-input',
                 'redirect_uri' => 'redirect_uri-input',
-                'short_url' => 'short_url-input',
                 'url' => 'url-input',
               },
             }.to_json,