gocardless_pro 2.25.0 → 2.27.0

data/lib/gocardless_pro/services/institutions_service.rb

@@ -0,0 +1,56 @@
+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 Institution endpoints
+    class InstitutionsService < BaseService
+      # Returns a list of all supported institutions.
+      # Example URL: /institutions
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/institutions'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Institution
+        )
+      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
+
+      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
+        'institutions'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/payer_authorisations_service.rb

@@ -71,7 +71,7 @@ module GoCardlessPro
       end
 
       # Updates a Payer Authorisation. Updates the Payer Authorisation with the
-      # request data.Can be invoked as many times as needed. Only fields present in
+      # request data. Can be invoked as many times as needed. Only fields present in
       # the request will be modified. An empty array of incomplete_fields means that
       # the resource is valid. This endpoint has been designed this way so you do not
       # need to save any payer data on your servers or the browser while still being
@@ -100,8 +100,8 @@ module GoCardlessPro
       end
 
       # Submits all the data previously pushed to this PayerAuthorisation for
-      # verification.This time, a 200 HTTP status is returned if the resource is valid
-      # and a 422 error response in case of validation errors. After it is
+      # verification. This time, a 200 HTTP status is returned if the resource is
+      # valid and a 422 error response in case of validation errors. After it is
       # successfully submitted, the Payer Authorisation can no longer be edited.
       # Example URL: /payer_authorisations/:identity/actions/submit
       #
@@ -149,8 +149,8 @@ module GoCardlessPro
       #   The main use of the confirm endpoint is to enable integrators to acknowledge
       # the end of the setup process.
       #   They might want to make the payers go through some other steps after they go
-      # through our flow or make them go through the necessary verification
-      # mechanism(upcomming feature).
+      # through our flow or make them go through the necessary verification mechanism
+      # (upcoming feature).
       # </p>
       # Example URL: /payer_authorisations/:identity/actions/confirm
       #

data/lib/gocardless_pro/services/scenario_simulators_service.rb

@@ -0,0 +1,148 @@
+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 ScenarioSimulator endpoints
+    class ScenarioSimulatorsService < BaseService
+      # Runs the specific scenario simulator against the specific resource
+      # Example URL: /scenario_simulators/:identity/actions/run
+      #
+      # @param identity       # The unique identifier of the simulator, used to initiate simulations.
+      # One of:
+      # <ul>
+      # <li>`creditor_verification_status_action_required`: Sets a creditor's
+      # `verification status` to `action required`, meaning that the creditor
+      # must provide further information to GoCardless in order to verify their
+      # account to receive payouts.</li>
+      # <li>`creditor_verification_status_in_review`: Sets a creditor's
+      # `verification status` to `in review`, meaning that the creditor has
+      # provided all of the information requested by GoCardless to verify their
+      # account, and is now awaiting review.</li>
+      # <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_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
+      # `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_failed`: Transitions a payment through to `failed`. 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_charged_back`: Behaves the same as the `payout_paid_out`
+      # simulator, except that the payment is transitioned to `charged_back`
+      # after it is paid out, having been charged back by the customer.</li>
+      # <li>`payment_chargeback_settled`: Behaves the same as the
+      # `payment_charged_back` simulator, except that the charged back payment
+      # is additionally included as a debit item in a payout, thereby settling
+      # the charged back payment.</li>
+      # <li>`payment_late_failure`: Transitions a payment through to
+      # `late_failure`, having been apparently collected successfully
+      # beforehand. 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). Not compatible with Autogiro mandates.</li>
+      # <li>`payment_late_failure_settled`: Behaves the same as the
+      # `payment_late_failure` simulator, except that the late failure is
+      # additionally included as a debit item in a payout, thereby settling the
+      # late failure.</li>
+      # <li>`payment_submitted`: Transitions a payment to `submitted`, without
+      # proceeding any further. It must start in the `pending_submission`
+      # state.</li>
+      # <li>`mandate_activated`: Transitions a mandate through to `activated`,
+      # having been submitted to the banks and set up successfully. It must
+      # start in the `pending_submission` state. Not compatible with ACH, BECS,
+      # BECS_NZ and SEPA mandates, which are submitted and activated with their
+      # first payment.</li>
+      # <li>`mandate_customer_approval_granted`: Transitions a mandate through
+      # to `pending_submission`, as if the customer approved the mandate
+      # creation. It must start in the `pending_customer_approval` state.
+      # Compatible only with Bacs and SEPA mandates, which support customer
+      # signatures on the mandate. All payments associated with the mandate will
+      # be transitioned to `pending_submission`. All subscriptions associated
+      # with the mandate will become `active`.</li>
+      # <li>`mandate_customer_approval_skipped`: Transitions a mandate through
+      # to `pending_submission`, as if the customer skipped the mandate approval
+      # during the mandate creation process. It must start in the
+      # `pending_customer_approval` state. Compatible only with Bacs and SEPA
+      # mandates, which support customer signatures on the mandate. All payments
+      # associated with the mandate will be transitioned to
+      # `pending_submission`. All subscriptions associated with the mandate will
+      # become `active`.</li>
+      # <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>
+      # <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
+      # scheme's dormancy period (13 months for Bacs, 3 years for SEPA, 15
+      # months for ACH, Betalingsservice, and BECS). It must start in the
+      # `pending_submission` state. Not compatible with Autogiro, BECS NZ, and
+      # PAD mandates, which do not expire.</li>
+      # <li>`mandate_transferred`: Transitions a mandate through to
+      # `transferred`, having been submitted to the banks, set up successfully
+      # and then moved to a new bank account due to the customer using the UK's
+      # Current Account Switching Service (CASS). It must start in the
+      # `pending_submission` state. Only compatible with Bacs mandates.</li>
+      # <li>`mandate_transferred_with_resubmission`: Transitions a mandate
+      # through `transferred` and resubmits it to the banks, can be caused be
+      # the UK's Current Account Switching Service (CASS) or when a customer
+      # contacts GoCardless to change their bank details. It must start in the
+      # `pending_submission` state. Only compatible with Bacs, SEPA and Autogiro
+      # mandates.</li>
+      # <li>`refund_paid`: Transitions a refund to `paid`. It must start in
+      # either the `pending_submission` or `submitted` state.</li>
+      # <li>`refund_bounced`: Transitions a refund to `bounced`. It must start
+      # in either the `pending_submission`, `submitted`, or `paid` state.</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>
+      # </ul>
+      # @param options [Hash] parameters as a hash, under a params key.
+      def run(identity, options = {})
+        path = sub_url('/scenario_simulators/:identity/actions/run', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        response = make_request(:post, path, options)
+
+        return if response.body.nil?
+
+        Resources::ScenarioSimulator.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
+        'scenario_simulators'
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -141,8 +141,9 @@ module GoCardlessPro
       # No payments will be created until it is resumed.
       #
       # This can only be used when a subscription collecting a fixed number of
-      # payments (created using `count`)
-      # or when they continue forever (created without `count` or `end_date`)
+      # payments (created using `count`),
+      # when they continue forever (created without `count` or `end_date`) or
+      # the subscription is 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.
@@ -166,7 +167,11 @@ module GoCardlessPro
       # - `validation_failed` if invalid data is provided when attempting to pause a
       # subscription.
       #
-      # - `subscription_not_active` if the subscription is no longer active.
+      # - `subscription_paused_cannot_update_cycles` if the subscription is already
+      # paused for a number of cycles and the request provides a value for
+      # `pause_cycle`.
+      #
+      # - `subscription_cannot_be_paused` if the subscription cannot be paused.
       #
       # - `subscription_already_ended` if the subscription has taken all payments.
       #

data/lib/gocardless_pro/services/webhooks_service.rb

@@ -0,0 +1,113 @@
+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 Webhook endpoints
+    class WebhooksService < BaseService
+      # Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your
+      # webhooks.
+      # Example URL: /webhooks
+      # @param options [Hash] parameters as a hash, under a params key.
+      def list(options = {})
+        path = '/webhooks'
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        ListResponse.new(
+          response: response,
+          unenveloped_body: unenvelope_body(response.body),
+          resource_class: Resources::Webhook
+        )
+      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 an existing webhook.
+      # Example URL: /webhooks/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "WB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def get(identity, options = {})
+        path = sub_url('/webhooks/:identity', 'identity' => identity)
+
+        options[:retry_failures] = true
+
+        response = make_request(:get, path, options)
+
+        return if response.body.nil?
+
+        Resources::Webhook.new(unenvelope_body(response.body), response)
+      end
+
+      # Requests for a previous webhook to be sent again
+      # Example URL: /webhooks/:identity/actions/retry
+      #
+      # @param identity       # Unique identifier, beginning with "WB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def retry(identity, options = {})
+        path = sub_url('/webhooks/:identity/actions/retry', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params]['data'] = params
+
+        options[:retry_failures] = false
+
+        begin
+          response = make_request(:post, path, options)
+
+          # Response doesn't raise any errors until #body is called
+          response.tap(&:body)
+        rescue InvalidStateError => e
+          if e.idempotent_creation_conflict?
+            case @api_service.on_idempotency_conflict
+            when :raise
+              raise IdempotencyConflict, e.error
+            when :fetch
+              return get(e.conflicting_resource_id)
+            else
+              raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::Webhook.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
+        'webhooks'
+      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.25.0'.freeze
+  VERSION = '2.27.0'.freeze
 end

data/spec/resources/bank_authorisation_spec.rb

@@ -0,0 +1,259 @@
+require 'spec_helper'
+
+describe GoCardlessPro::Resources::BankAuthorisation 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.bank_authorisations.get(id) }
+
+    context 'passing in a custom header' do
+      let!(:stub) do
+        stub_url = '/bank_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          with(headers: { 'Foo' => 'Bar' }).
+          to_return(
+            body: {
+              'bank_authorisations' => {
+
+                'authorisation_type' => 'authorisation_type-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,
+            headers: response_headers
+          )
+      end
+
+      subject(:get_response) do
+        client.bank_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 bank_authorisation to return' do
+      before do
+        stub_url = '/bank_authorisations/:identity'.gsub(':identity', id)
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).to_return(
+          body: {
+            'bank_authorisations' => {
+
+              'authorisation_type' => 'authorisation_type-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,
+          headers: response_headers
+        )
+      end
+
+      it 'wraps the response in a resource' do
+        expect(get_response).to be_a(GoCardlessPro::Resources::BankAuthorisation)
+      end
+    end
+
+    context 'when nothing is returned' do
+      before do
+        stub_url = '/bank_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.bank_authorisations.create(params: new_resource) }
+    context 'with a valid request' do
+      let(:new_resource) do
+        {
+
+          'authorisation_type' => 'authorisation_type-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
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/bank_authorisations}).
+          with(
+            body: {
+              'bank_authorisations' => {
+
+                'authorisation_type' => 'authorisation_type-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_return(
+            body: {
+              'bank_authorisations' =>
+
+                {
+
+                  'authorisation_type' => 'authorisation_type-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,
+            headers: response_headers
+          )
+      end
+
+      it 'creates and returns the resource' do
+        expect(post_create_response).to be_a(GoCardlessPro::Resources::BankAuthorisation)
+      end
+    end
+
+    context 'with a request that returns a validation error' do
+      let(:new_resource) { {} }
+
+      before do
+        stub_request(:post, %r{.*api.gocardless.com/bank_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
+        {
+
+          'authorisation_type' => 'authorisation_type-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
+
+      let!(:post_stub) do
+        stub_request(:post, %r{.*api.gocardless.com/bank_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 = "/bank_authorisations/#{id}"
+        stub_request(:get, /.*api.gocardless.com#{stub_url}/).
+          to_return(
+            body: {
+              'bank_authorisations' => {
+
+                'authorisation_type' => 'authorisation_type-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,
+            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
+end