gocardless_pro 2.18.0 → 2.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 250fed25fc74cb084ad988286e20f8dd2c679fcb62e0de5a1fc3bfca71b67c43
-  data.tar.gz: af02087f4d85aafa9337d51219c467bc195c6c9eff6d03b2f9c5dbf209956680
+  metadata.gz: 3bb8531d374a6fe482eaaccbc49cd9cbf1575f880cb9633c0b0848ca09157b76
+  data.tar.gz: 24e1f269a875c46dd8a2165f856ba18a4acea648aed82a600de26425bb32bd3d
 SHA512:
-  metadata.gz: a3bd1149c2936dfd1ba6d8b60e7183c279d105046c4c02ab497e2d11da3c3f93c363a56ce5a2c1133138ad9acd421bbfb4c479c1da3970afb4c6b650a0197965
-  data.tar.gz: '07951005f59ae4328b34342bb24c9b06bfb9f0221a87630751d21b9755354fb3daaf7f0b34bb51d98811f2e1199479be08745afdb66c888953bfad50fc8bc099'
+  metadata.gz: b93423658f351048e9dd31cb216a86d2c389638d2079647457f68a521eaa4f749844c199cc2cfbb44904dcc18ed9608f94698d1e2e3201341e833714c8a6e6bc
+  data.tar.gz: a2836a224de279066f96d8fa28238368271cbfe967bda9015655ce68cca8262466821d6a923b87db2a050f85e99f14758de9c8214f61fd0089ae127a0cb229d2

data/.circleci/config.yml

@@ -1,50 +1,32 @@
-version: 2
-references:
-  test_library: &test_library
+version: 2.1
+
+jobs:
+  test: &test
     parallelism: 1
+    parameters:
+      faraday-version: { type: string }
+      ruby-version: { type: string }
+    docker:
+      - image: ruby:<<parameters.ruby-version>>
+        environment:
+          - FARADAY_VERSION=<<parameters.faraday-version>>
     steps:
       - checkout
-      - run: |
-          bundle install
-          bundle exec rspec
-jobs:
-  test_ruby_2_5:
-    <<: *test_library
-    docker:
-      - image: ruby:2.5
-
-  test_ruby_2_4:
-    <<: *test_library
-    docker:
-      - image: ruby:2.4
-
-  test_ruby_2_3:
-    <<: *test_library
-    docker:
-      - image: ruby:2.3
-
-  test_ruby_2_2:
-    <<: *test_library
-    docker:
-      - image: ruby:2.2
-
-  test_ruby_2_1:
-    <<: *test_library
-    docker:
-      - image: ruby:2.1
-
-  test_ruby_2_0:
-    <<: *test_library
-    docker:
-      - image: ruby:2.0
+      - run: bundle install && bundle exec rspec
 
 workflows:
   version: 2
-  build:
+  tests:
     jobs:
-      - test_ruby_2_5
-      - test_ruby_2_4
-      - test_ruby_2_3
-      - test_ruby_2_2
-      - test_ruby_2_1
-      - test_ruby_2_0
+      - test:
+          matrix:
+            parameters:
+              faraday-version: ["0.9.2", "1.0"]
+              ruby-version: ["2.0", "2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7"]
+            exclude:
+              - faraday-version: "1.0"
+                ruby-version: "2.0"
+              - faraday-version: "1.0"
+                ruby-version: "2.1"
+              - faraday-version: "1.0"
+                ruby-version: "2.2"

data/Gemfile

@@ -1,2 +1,9 @@
 source 'https://rubygems.org'
 gemspec
+
+# We support both pre-1.x and post-1.x Faraday versions, but to ensure compatibility we
+# pin this gem against each in separate runs of CI, using the FARADAY_VERSION env var. For
+# more details on the values, see .circleci/config.yml.
+if ENV.key?("FARADAY_VERSION")
+  gem 'faraday', "~> #{ENV["FARADAY_VERSION"]}"
+end

data/gocardless_pro.gemspec

@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday', ['>= 0.9.2', '< 1.0']
+  spec.add_dependency 'faraday', ['>= 0.9.2', '< 2']
 
   spec.add_development_dependency 'rspec', '~> 3.7.0'
-  spec.add_development_dependency 'webmock', '~> 1.18'
+  spec.add_development_dependency 'webmock', '~> 3.8.3'
   spec.add_development_dependency 'rubocop', '~> 0.49.1'
   spec.add_development_dependency 'yard', '~> 0.9.11'
 

data/lib/gocardless_pro/api_service.rb

@@ -23,7 +23,7 @@ module GoCardlessPro
       @url = url
       root_url, @path_prefix = unpack_url(url)
       http_adapter = options[:http_adapter] || [:net_http]
-      connection_options = options[:connection_options]
+      connection_options = options.fetch(:connection_options, {})
 
       @connection = Faraday.new(root_url, connection_options) do |faraday|
         faraday.response :raise_gocardless_errors

data/lib/gocardless_pro/client.rb

@@ -148,7 +148,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.18.0',
+          'GoCardless-Client-Version' => '2.22.0',
         },
       }
     end

data/lib/gocardless_pro/resources/creditor_bank_account.rb

@@ -23,8 +23,7 @@ module GoCardlessPro
     # `links[creditor_bank_account]` in the error response.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is not
-    # available for
-    # partner integrations.</p>
+    # available for partner integrations.</p>
     class CreditorBankAccount
       attr_reader :account_holder_name
       attr_reader :account_number_ending

data/lib/gocardless_pro/resources/customer_notification.rb

@@ -23,11 +23,9 @@ module GoCardlessPro
     # way, it is no longer visible using this API.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently
-    # only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get
-    # in touch</a> if you would like to use this API.</p>
-    #
+    # currently only available for approved integrators - please <a
+    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
+    # use this API.</p>
     class CustomerNotification
       attr_reader :action_taken
       attr_reader :action_taken_at

data/lib/gocardless_pro/resources/event.rb

@@ -14,7 +14,8 @@ module GoCardlessPro
 
     # Events are stored for all webhooks. An event refers to a resource which
     # has been updated, for example a payment which has been collected, or a
-    # mandate which has been transferred.
+    # mandate which has been transferred. See [here](#event-actions) for a
+    # complete list of event types.
     class Event
       attr_reader :action
       attr_reader :created_at

data/lib/gocardless_pro/resources/mandate_import.rb

@@ -47,16 +47,13 @@ module GoCardlessPro
     # system](#mandate-import-entries-list-all-mandate-import-entries).
     #
     # <p class="notice">Note that all Mandate Imports have an upper limit of
-    # 30,000 entries, so
-    # we recommend you split your import into several smaller imports if you're
-    # planning to
-    # exceed this threshold.</p>
+    # 30,000 entries, so we recommend you split your import into several smaller
+    # imports if you're planning to exceed this threshold.</p>
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently
-    # only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get
-    # in touch</a> if you would like to use this API.</p>
+    # currently only available for approved integrators - please <a
+    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
+    # use this API.</p>
     class MandateImport
       attr_reader :created_at
       attr_reader :id

data/lib/gocardless_pro/resources/mandate_import_entry.rb

@@ -39,11 +39,9 @@ module GoCardlessPro
     # been imported.
     #
     # <p class="restricted-notice"><strong>Restricted</strong>: This API is
-    # currently
-    # only available for approved integrators - please <a
-    # href="mailto:help@gocardless.com">get
-    # in touch</a> if you would like to use this API.</p>
-    #
+    # currently only available for approved integrators - please <a
+    # href="mailto:help@gocardless.com">get in touch</a> if you would like to
+    # use this API.</p>
     class MandateImportEntry
       attr_reader :created_at
       attr_reader :record_identifier

data/lib/gocardless_pro/resources/payout.rb

@@ -26,6 +26,7 @@ module GoCardlessPro
       attr_reader :deducted_fees
       attr_reader :fx
       attr_reader :id
+      attr_reader :metadata
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
@@ -43,6 +44,7 @@ module GoCardlessPro
         @fx = object['fx']
         @id = object['id']
         @links = object['links']
+        @metadata = object['metadata']
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']

data/lib/gocardless_pro/resources/redirect_flow.rb

@@ -49,6 +49,7 @@ module GoCardlessPro
       attr_reader :created_at
       attr_reader :description
       attr_reader :id
+      attr_reader :metadata
       attr_reader :redirect_url
       attr_reader :scheme
       attr_reader :session_token
@@ -64,6 +65,7 @@ module GoCardlessPro
         @description = object['description']
         @id = object['id']
         @links = object['links']
+        @metadata = object['metadata']
         @redirect_url = object['redirect_url']
         @scheme = object['scheme']
         @session_token = object['session_token']

data/lib/gocardless_pro/resources/subscription.rb

@@ -20,40 +20,45 @@ module GoCardlessPro
     # The following rules apply when specifying recurrence:
     #
     # - The first payment must be charged within 1 year.
-    # - When neither `month` nor `day_of_month` are present, the subscription
-    # will recur from the `start_date` based on the `interval_unit`.
-    # - If `month` or `day_of_month` are present, the recurrence rules will be
-    # applied from the `start_date`, and the following validations apply:
+    # - If `day_of_month` and `start_date` are not provided `start_date` will be
+    # the [mandate](#core-endpoints-mandates)'s `next_possible_charge_date` and
+    # the subscription will then recur based on the `interval` & `interval_unit`
+    # - If `month` or `day_of_month` are present the following validations
+    # apply:
     #
-    # | interval_unit   | month                                          |
-    # day_of_month                            |
-    # | :-------------- | :--------------------------------------------- |
-    # :-------------------------------------- |
-    # | yearly          | optional (required if `day_of_month` provided) |
-    # optional (required if `month` provided) |
-    # | monthly         | invalid                                        |
-    # required                                |
-    # | weekly          | invalid                                        |
-    # invalid                                 |
+    # | __interval_unit__ | __month__                                      |
+    # __day_of_month__                           |
+    # | :---------------- | :--------------------------------------------- |
+    # :----------------------------------------- |
+    # | yearly            | optional (required if `day_of_month` provided) |
+    # optional (invalid if `month` not provided) |
+    # | monthly           | invalid                                        |
+    # optional                                   |
+    # | weekly            | invalid                                        |
+    # invalid                                    |
     #
     # Examples:
     #
-    # | interval_unit   | interval   | month   | day_of_month   | valid?
-    #                                     |
-    # | :-------------- | :--------- | :------ | :------------- |
+    # | __interval_unit__ | __interval__ | __month__ | __day_of_month__ | valid?
+    #                                             |
+    # | :---------------- | :----------- | :-------- | :--------------- |
     # :------------------------------------------------- |
-    # | yearly          | 1          | january | -1             | valid
-    #                                     |
-    # | yearly          | 1          | march   |                | invalid -
-    # missing `day_of_month`                   |
-    # | monthly         | 6          |         | 12             | valid
-    #                                     |
-    # | monthly         | 6          | august  | 12             | invalid -
-    # `month` must be blank                    |
-    # | weekly          | 2          |         |                | valid
-    #                                     |
-    # | weekly          | 2          | october | 10             | invalid -
-    # `month` and `day_of_month` must be blank |
+    # | yearly            | 1            | january   | -1               | valid
+    #                                             |
+    # | monthly           | 6            |           |                  | valid
+    #                                             |
+    # | monthly           | 6            |           | 12               | valid
+    #                                             |
+    # | weekly            | 2            |           |                  | valid
+    #                                             |
+    # | yearly            | 1            | march     |                  |
+    # invalid - missing `day_of_month`                   |
+    # | yearly            | 1            |           | 2                |
+    # invalid - missing `month`                          |
+    # | monthly           | 6            | august    | 12               |
+    # invalid - `month` must be blank                    |
+    # | weekly            | 2            | october   | 10               |
+    # invalid - `month` and `day_of_month` must be blank |
     #
     # ### Rolling dates
     #
@@ -73,6 +78,7 @@ module GoCardlessPro
       attr_reader :created_at
       attr_reader :currency
       attr_reader :day_of_month
+      attr_reader :earliest_charge_date_after_resume
       attr_reader :end_date
       attr_reader :id
       attr_reader :interval
@@ -97,6 +103,7 @@ module GoCardlessPro
         @created_at = object['created_at']
         @currency = object['currency']
         @day_of_month = object['day_of_month']
+        @earliest_charge_date_after_resume = object['earliest_charge_date_after_resume']
         @end_date = object['end_date']
         @id = object['id']
         @interval = object['interval']

data/lib/gocardless_pro/services/customers_service.rb

@@ -123,8 +123,7 @@ module GoCardlessPro
       # ID.
       #
       # <p class="restricted-notice"><strong>The action of removing a customer cannot
-      # be
-      # reversed, so please use with care.</strong></p>
+      # be reversed, so please use with care.</strong></p>
       # Example URL: /customers/:identity
       #
       # @param identity       # Unique identifier, beginning with "CU".

data/lib/gocardless_pro/services/instalment_schedules_service.rb

@@ -162,6 +162,27 @@ module GoCardlessPro
         Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
       end
 
+      # Updates an instalment schedule. This accepts only the metadata parameter.
+      # Example URL: /instalment_schedules/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "IS".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/instalment_schedules/:identity', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+
+        Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
+      end
+
       # Immediately cancels an instalment schedule; no further payments will be
       # collected for it.
       #

data/lib/gocardless_pro/services/mandates_service.rb

@@ -172,7 +172,7 @@ module GoCardlessPro
       # This will fail with a `mandate_not_inactive` error if the mandate is already
       # being submitted, or is active.
       #
-      # Mandates can be resubmitted up to 3 times.
+      # Mandates can be resubmitted up to 10 times.
       # Example URL: /mandates/:identity/actions/reinstate
       #
       # @param identity       # Unique identifier, beginning with "MD". Note that this prefix may not

data/lib/gocardless_pro/services/payouts_service.rb

@@ -59,6 +59,27 @@ module GoCardlessPro
         Resources::Payout.new(unenvelope_body(response.body), response)
       end
 
+      # Updates a payout object. This accepts only the metadata parameter.
+      # Example URL: /payouts/:identity
+      #
+      # @param identity       # Unique identifier, beginning with "PO".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def update(identity, options = {})
+        path = sub_url('/payouts/:identity', 'identity' => identity)
+
+        params = options.delete(:params) || {}
+        options[:params] = {}
+        options[:params][envelope_key] = params
+
+        options[:retry_failures] = true
+
+        response = make_request(:put, path, options)
+
+        return if response.body.nil?
+
+        Resources::Payout.new(unenvelope_body(response.body), response)
+      end
+
       private
 
       # Unenvelope the response of the body using the service's `envelope_key`

data/lib/gocardless_pro/services/subscriptions_service.rb

@@ -138,6 +138,135 @@ module GoCardlessPro
         Resources::Subscription.new(unenvelope_body(response.body), response)
       end
 
+      # 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
+      # payments (created using `count`)
+      # or when they continue forever (created without `count` or `end_date`)
+      #
+      # 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`.
+      # When paused indefinitely, `upcoming_payments` will be empty.
+      #
+      # When `pause_cycles` is provided the subscription will be paused for the number
+      # of cycles requested.
+      # If the subscription is collecting a fixed number of payments, `end_date` will
+      # be set to a new value.
+      # When paused for a number of cycles, `upcoming_payments` will still contain the
+      # upcoming charge dates.
+      #
+      # This fails with:
+      #
+      # - `forbidden` if the subscription was created by an app and you are not
+      # authenticated as that app, or if the subscription was not created by an app
+      # and you are authenticated as an app
+      #
+      # - `validation_failed` if invalid data is provided when attempting to pause a
+      # subscription.
+      #
+      # - `subscription_not_active` if the subscription is no longer active.
+      #
+      # - `subscription_already_ended` if the subscription has taken all payments.
+      #
+      # - `pause_cycles_must_be_greater_than_or_equal_to` if the provided value for
+      # `pause_cycles` cannot be satisfied.
+      #
+      # Example URL: /subscriptions/:identity/actions/pause
+      #
+      # @param identity       # Unique identifier, beginning with "SB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def pause(identity, options = {})
+        path = sub_url('/subscriptions/:identity/actions/pause', '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::Subscription.new(unenvelope_body(response.body), response)
+      end
+
+      # Resume a subscription object.
+      # Payments will start to be created again based on the subscriptions recurrence
+      # rules.
+      # The `charge_date` on the next payment will be the same as the subscriptions
+      # `earliest_charge_date_after_resume`
+      #
+      # This fails with:
+      #
+      # - `forbidden` if the subscription was created by an app and you are not
+      # authenticated as that app, or if the subscription was not created by an app
+      # and you are authenticated as an app
+      #
+      # - `validation_failed` if invalid data is provided when attempting to resume a
+      # subscription.
+      #
+      # - `subscription_not_paused` if the subscription is not paused.
+      #
+      # Example URL: /subscriptions/:identity/actions/resume
+      #
+      # @param identity       # Unique identifier, beginning with "SB".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def resume(identity, options = {})
+        path = sub_url('/subscriptions/:identity/actions/resume', '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::Subscription.new(unenvelope_body(response.body), response)
+      end
+
       # Immediately cancels a subscription; no more payments will be created under it.
       # Any metadata supplied to this endpoint will be stored on the payment
       # cancellation event it causes.