Merge pull request #98 from gocardless/template-changes

v2.32.0

Author: szastupov

.circleci/config.yml

@@ -25,7 +25,7 @@ jobs:
           printf -- "---\n:rubygems_api_key: $RUBYGEM_PUBLISH_API_KEY\n" > $HOME/.gem/credentials
           gem build *.gemspec
           gem push *.gem
-          
+
 workflows:
   version: 2
   tests:
@@ -34,18 +34,14 @@ workflows:
           matrix:
             parameters:
               faraday-version: ["0.9.2", "1.0"]
-              ruby-version: ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
+              ruby-version: ["2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
             exclude:
-              - faraday-version: "1.0"
-                ruby-version: "2.1"
-              - faraday-version: "1.0"
-                ruby-version: "2.2"
               - faraday-version: "0.9.2"
                 ruby-version: "3.0"
       - publish:
           filters:
             branches:
               only:
-                - master      
+                - master
           requires:
             - test

.travis.yml

@@ -2,8 +2,6 @@ language: ruby
 
 rvm:
   - 2.3.0
-  - 2.2
-  - 2.1
   - 2.0.0
 
 sudo: false

lib/gocardless_pro/client.rb

@@ -198,7 +198,7 @@ def default_options
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.30.0',
+          'GoCardless-Client-Version' => '2.32.0',
         },
       }
     end

lib/gocardless_pro/resources/billing_request.rb

@@ -97,6 +97,10 @@ def mandate_request_mandate
           @links['mandate_request_mandate']
         end
 
+        def organisation
+          @links['organisation']
+        end
+
         def payment_request
           @links['payment_request']
         end

lib/gocardless_pro/resources/billing_request_flow.rb

@@ -23,7 +23,10 @@ class BillingRequestFlow
       attr_reader :expires_at
       attr_reader :id
       attr_reader :lock_bank_account
+      attr_reader :lock_currency
       attr_reader :lock_customer_details
+      attr_reader :prefilled_bank_account
+      attr_reader :prefilled_customer
       attr_reader :redirect_uri
       attr_reader :session_token
       attr_reader :show_redirect_buttons
@@ -41,7 +44,10 @@ def initialize(object, response = nil)
         @id = object['id']
         @links = object['links']
         @lock_bank_account = object['lock_bank_account']
+        @lock_currency = object['lock_currency']
         @lock_customer_details = object['lock_customer_details']
+        @prefilled_bank_account = object['prefilled_bank_account']
+        @prefilled_customer = object['prefilled_customer']
         @redirect_uri = object['redirect_uri']
         @session_token = object['session_token']
         @show_redirect_buttons = object['show_redirect_buttons']

lib/gocardless_pro/resources/customer_bank_account.rb

@@ -22,6 +22,13 @@ module Resources
     # account. You may wish to handle this by updating the existing record
     # instead, the ID of which will be provided as
     # `links[customer_bank_account]` in the error response.
+    #
+    # _Note:_ To ensure the customer's bank accounts are valid, verify them
+    # first
+    # using
+    #
+    # [bank_details_lookups](#bank-details-lookups-perform-a-bank-details-lookup),
+    # before proceeding with creating the accounts
     class CustomerBankAccount
       attr_reader :account_holder_name
       attr_reader :account_number_ending

lib/gocardless_pro/resources/event.rb

@@ -14,8 +14,10 @@ module Resources
 
     # 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. See [here](#event-actions) for a
-    # complete list of event types.
+    # mandate which has been transferred. Event creation is an asynchronous
+    # process, so it can take some time between an action occurring and its
+    # corresponding event getting included in API responses. See
+    # [here](#event-actions) for a complete list of event types.
     class Event
       attr_reader :action
       attr_reader :created_at

lib/gocardless_pro/resources/institution.rb

@@ -19,6 +19,7 @@ module Resources
     # Not all institutions support both Payment Initiation (PIS) and Account
     # Information (AIS) services.
     class Institution
+      attr_reader :bank_redirect
       attr_reader :country_code
       attr_reader :icon_url
       attr_reader :id
@@ -30,6 +31,7 @@ class Institution
       def initialize(object, response = nil)
         @object = object
 
+        @bank_redirect = object['bank_redirect']
         @country_code = object['country_code']
         @icon_url = object['icon_url']
         @id = object['id']

lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -23,6 +23,12 @@ class BankDetailsLookupsService < BaseService
       # Bank account details may be supplied using [local
       # details](#appendix-local-bank-details) or an IBAN.
       #
+      # _ACH scheme_ For compliance reasons, an extra validation step is done using
+      # a third-party provider to make sure the customer's bank account can accept
+      # Direct Debit. If a bank account is discovered to be closed or invalid, the
+      # customer is requested to adjust the account number/routing number and
+      # succeed in this check to continue with the flow.
+      #
       # _Note:_ Usage of this endpoint is monitored. If your organisation relies on
       # GoCardless for
       # modulus or reachability checking but not for payment collection, please get in

lib/gocardless_pro/services/billing_requests_service.rb

@@ -144,6 +144,12 @@ def collect_customer_details(identity, options = {})
       # The endpoint takes the same payload as Customer Bank Accounts, but check
       # the bank account is valid for the billing request scheme before creating
       # and attaching it.
+      #
+      # _ACH scheme_ For compliance reasons, an extra validation step is done using
+      # a third-party provider to make sure the customer's bank account can accept
+      # Direct Debit. If a bank account is discovered to be closed or invalid, the
+      # customer is requested to adjust the account number/routing number and
+      # succeed in this check to continue with the flow.
       # Example URL: /billing_requests/:identity/actions/collect_bank_account
       #
       # @param identity       # Unique identifier, beginning with "BRQ".
@@ -218,6 +224,46 @@ def fulfil(identity, options = {})
         Resources::BillingRequest.new(unenvelope_body(response.body), response)
       end
 
+      # This will allow for the updating of the currency and subsequently the scheme
+      # if needed for a billing request
+      # this will only be available for mandate only flows, it will not support
+      # payments requests or plans
+      # Example URL: /billing_requests/:identity/actions/choose_currency
+      #
+      # @param identity       # Unique identifier, beginning with "BRQ".
+      # @param options [Hash] parameters as a hash, under a params key.
+      def choose_currency(identity, options = {})
+        path = sub_url('/billing_requests/:identity/actions/choose_currency', '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)
+            end
+          end
+
+          raise e
+        end
+
+        return if response.body.nil?
+
+        Resources::BillingRequest.new(unenvelope_body(response.body), response)
+      end
+
       # This is needed when you have a mandate request. As a scheme compliance rule we
       # are required to
       # allow the payer to crosscheck the details entered by them and confirm it.