gocardless_pro 4.20.1 → 4.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d609bad8f5a7b85cf05639093c346966b16df40a2519f44409900ee60a4ad40
-  data.tar.gz: 42bddbcb2b62a5053333d60051b3bd3323267e5f45f98ebc89f795ce24e8ed33
+  metadata.gz: 2fbb2b1d839a297b95fac3863d7f281e872bf53ddb887c1a4cbc0623c7b5fff9
+  data.tar.gz: eec20a669e42a995af7c9f1074a41e80a4a53e6e416e5683e90cec45cd028b9b
 SHA512:
-  metadata.gz: 36a5335fdd6fbe2674d449e53ddc6e759739dd361c0fa21754c02b175a98867051be8d3d70038a4e6df8334038d4a27ac093aa911969a11ec054c461c7e6cf76
-  data.tar.gz: 1d1047507f809cf172b6ef1c3bd14971076bb5680eebf8d842c1d9cab9cba29a55cdbd5ee80ba7a7ffb35e8044125805402b37b7cbe65836327dcd169879c8b3
+  metadata.gz: afc747c751aa25ba8d70c868b3863a81e8724dc51a711dd02d947552d06f38737a65a0e4f10d269c0a5f22df94718bc81c8b4a2c96cb2697d4996356a7514ebf
+  data.tar.gz: a6ba0ad4f44baaf68c7a7b2a0ac80b846bc69e945cb22bf1dcd0ec9b7f2d14fdac6e9696ea372d9823019bd1293b265db857c08f60dd1e691c54e7d312682113

data/README.md

@@ -192,7 +192,7 @@ end
 
 If the client is unable to connect to GoCardless, an appropriate exception will be raised, for example:
 
-* `Faraday::TimeoutError`, in case of a timeout
+* `Faraday::TimeoutError`, in case of a timeout (requests time out after 60 seconds by default; change this with the `connection_options` client option, e.g. `connection_options: { request: { timeout: 10 } }`)
 * `Faraday::ConnectionFailed`, in case of a connection issue (e.g. problems with DNS resolution)
 * `GoCardlessPro::ApiError`, for `5xx` errors returned from our infrastructure, but not by the API itself
 

data/lib/gocardless_pro/api_service.rb

@@ -9,6 +9,9 @@ require 'base64'
 module GoCardlessPro
   # GoCardless API
   class ApiService
+    # Seconds to wait for a response when `connection_options` doesn't set `request: { timeout: ... }`
+    DEFAULT_TIMEOUT = 60
+
     attr_reader :on_idempotency_conflict
 
     # Initialize an APIService
@@ -22,8 +25,9 @@ module GoCardlessPro
       root_url, @path_prefix = unpack_url(url)
       http_adapter = options[:http_adapter] || [:net_http]
       connection_options = options.fetch(:connection_options, {})
+      request_options = { timeout: DEFAULT_TIMEOUT }.merge(connection_options.fetch(:request, {}))
 
-      @connection = Faraday.new(root_url, connection_options) do |faraday|
+      @connection = Faraday.new(root_url, connection_options.merge(request: request_options)) do |faraday|
         faraday.response :raise_gocardless_errors
 
         faraday.adapter(*http_adapter)

data/lib/gocardless_pro/client.rb

@@ -239,7 +239,7 @@ module GoCardlessPro
     # @option options [Symbol] :environment the environment to connect to - one of `:live` or `:sandbox`.
     # @option options [Symbol] :access_token the API token
     # @option options [Symbol] :url the full URL used to make requests to. If you specify this, it will be used over the `environment` option.
-    # @option options [Symbol] :connection_options `Faraday` connection options hash, e.g. `{ request: { timeout: 3 } }`.
+    # @option options [Symbol] :connection_options `Faraday` connection options hash, e.g. `{ request: { timeout: 3 } }`. Requests time out after 60 seconds unless `request: { timeout: ... }` is set.
     # @return [Client] A client configured to use the API with HTTP Basic
     #   authentication.
     #
@@ -283,7 +283,7 @@ module GoCardlessPro
           'User-Agent' => "#{user_agent}",
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '4.20.1',
+          'GoCardless-Client-Version' => '4.22.0',
         },
       }
     end

data/lib/gocardless_pro/services/payer_authorisations_service.rb

@@ -16,6 +16,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
       def get(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
                          'identity' => identity,
@@ -38,6 +39,7 @@ module GoCardlessPro
       # solution, such as a multi-step form.
       # Example URL: /payer_authorisations
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
       def create(options = {})
         path = '/payer_authorisations'
 
@@ -82,6 +84,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
       def update(identity, options = {})
         path = sub_url('/payer_authorisations/:identity', {
                          'identity' => identity,
@@ -108,6 +111,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
       def submit(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/submit', {
                          'identity' => identity,
@@ -155,6 +159,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "PA".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Payer Authorisation is legacy API and cannot be used by new integrators. The Billing Request (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for any new integrations.
       def confirm(identity, options = {})
         path = sub_url('/payer_authorisations/:identity/actions/confirm', {
                          'identity' => identity,

data/lib/gocardless_pro/services/redirect_flows_service.rb

@@ -14,6 +14,7 @@ module GoCardlessPro
       # customer to the GoCardless hosted payment pages.
       # Example URL: /redirect_flows
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
       def create(options = {})
         path = '/redirect_flows'
 
@@ -51,6 +52,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "RE".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
       def get(identity, options = {})
         path = sub_url('/redirect_flows/:identity', {
                          'identity' => identity,
@@ -83,6 +85,7 @@ module GoCardlessPro
       #
       # @param identity       # Unique identifier, beginning with "RE".
       # @param options [Hash] parameters as a hash, under a params key.
+      # @deprecated Redirect Flows are legacy APIs and cannot be used by new integrators. The Billing Request flow (https://developer.gocardless.com/api-reference/#billing-requests) API should be used for your payment flows.
       def complete(identity, options = {})
         path = sub_url('/redirect_flows/:identity/actions/complete', {
                          'identity' => identity,

data/lib/gocardless_pro/version.rb

@@ -3,5 +3,5 @@ end
 
 module GoCardlessPro
   # Current version of the GC gem
-  VERSION = '4.20.1'
+  VERSION = '4.22.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gocardless_pro
 version: !ruby/object:Gem::Version
-  version: 4.20.1
+  version: 4.22.0
 platform: ruby
 authors:
 - GoCardless
@@ -63,28 +63,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.26.3
+        version: 3.32.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.26.3
+        version: 3.32.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.89.0
+        version: 1.92.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.89.0
+        version: 1.92.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement