gocardless_pro 2.21.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c285e5a1284e099a2840ea4dfb7a8282a73a38aa0def7e81f522654b4be5922
-  data.tar.gz: 0443f073f12c0c6d69029a4a79d28634978274e73b6d1bc0a1517066c44b66e8
+  metadata.gz: 1e1d21b1955fd8db168185745bd1afbd46fd7c3fa434006abf5c0e838cd7507e
+  data.tar.gz: ef057338fc37aa2e791ef3dcd7536a50ff55711e7d8fa5762a51d6797395cab6
 SHA512:
-  metadata.gz: bf2401b3823b41bd1d562a80f0e7a8b0847a86f04e1ec29ad2e55b3caf814e39ea379f0686c6108b91de81701b8cebc697e0bd1f7cd4741c44176785c01bcc27
-  data.tar.gz: f8aa9bd7ff1c8f969d54ae654b324395572459ec065e603601dbe5eb9a38ec61852724820dc8423bc7407e47004434dcee4b880b3a4d2678086b0f0729dece07
+  metadata.gz: 7c1daafd49f92798ff81c407809ecf888429f2c723801c42b49dfe4d7d7351ae818925c46d897784f798c7d4ee2c7089959594cec38ab0fc6df3472f481d0207
+  data.tar.gz: 78eb4cd3154aa14fe50e445cd94605fe39f91893564650948717e84356fb7d374357ecbfad08784be2c21221fc096530e85407c8a1a3eb794b2ab5d40d0024d1

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.rb

@@ -77,6 +77,9 @@ require_relative 'gocardless_pro/services/mandate_import_entries_service'
 require_relative 'gocardless_pro/resources/mandate_pdf'
 require_relative 'gocardless_pro/services/mandate_pdfs_service'
 
+require_relative 'gocardless_pro/resources/payer_authorisation'
+require_relative 'gocardless_pro/services/payer_authorisations_service'
+
 require_relative 'gocardless_pro/resources/payment'
 require_relative 'gocardless_pro/services/payments_service'
 
@@ -95,4 +98,7 @@ require_relative 'gocardless_pro/services/refunds_service'
 require_relative 'gocardless_pro/resources/subscription'
 require_relative 'gocardless_pro/services/subscriptions_service'
 
+require_relative 'gocardless_pro/resources/tax_rate'
+require_relative 'gocardless_pro/services/tax_rates_service'
+
 require_relative 'gocardless_pro/client.rb'

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

@@ -68,6 +68,11 @@ module GoCardlessPro
       @mandate_pdfs ||= Services::MandatePdfsService.new(@api_service)
     end
 
+    # Access to the service for payer_authorisation to make API calls
+    def payer_authorisations
+      @payer_authorisations ||= Services::PayerAuthorisationsService.new(@api_service)
+    end
+
     # Access to the service for payment to make API calls
     def payments
       @payments ||= Services::PaymentsService.new(@api_service)
@@ -98,6 +103,11 @@ module GoCardlessPro
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
     end
 
+    # Access to the service for tax_rate to make API calls
+    def tax_rates
+      @tax_rates ||= Services::TaxRatesService.new(@api_service)
+    end
+
     # Get a Client configured to use HTTP Basic authentication with the GC Api
     #
     # @param options [Hash<Symbol,String>] configuration for creating the client
@@ -148,7 +158,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.21.0',
+          'GoCardless-Client-Version' => '2.25.0',
         },
       }
     end

data/lib/gocardless_pro/resources/event.rb

@@ -64,6 +64,14 @@ module GoCardlessPro
           @links['creditor']
         end
 
+        def customer
+          @links['customer']
+        end
+
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
         def instalment_schedule
           @links['instalment_schedule']
         end
@@ -88,6 +96,10 @@ module GoCardlessPro
           @links['parent_event']
         end
 
+        def payer_authorisation
+          @links['payer_authorisation']
+        end
+
         def payment
           @links['payment']
         end

data/lib/gocardless_pro/resources/payer_authorisation.rb

@@ -0,0 +1,119 @@
+# 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.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a payer_authorisation resource returned from the API
+
+    # Payer Authorisation resource acts as a wrapper for creating customer, bank
+    # account and mandate details in a single request.
+    # PayerAuthorisation API enables the integrators to build their own custom
+    # payment pages.
+    #
+    # The process to use the Payer Authorisation API is as follows:
+    #
+    #   1. Create a Payer Authorisation, either empty or with already available
+    # information
+    #   2. Update the authorisation with additional information or fix any
+    # mistakes
+    #   3. Submit the authorisation, after the payer has reviewed their
+    # information
+    #   4. [coming soon] Redirect the payer to the verification mechanisms from
+    # the response of the Submit request (this will be introduced as a
+    # non-breaking change)
+    #   5. Confirm the authorisation to indicate that the resources can be
+    # created
+    #
+    # After the Payer Authorisation is confirmed, resources will eventually be
+    # created as it's an asynchronous process.
+    #
+    # To retrieve the status and ID of the linked resources you can do one of
+    # the following:
+    # <ol>
+    #   <li> Listen to <code>  payer_authorisation_completed </code>  <a
+    # href="#appendix-webhooks"> webhook</a> (recommended)</li>
+    #   <li> Poll the GET <a
+    # href="#payer-authorisations-get-a-single-payer-authorisation">
+    # endpoint</a></li>
+    #   <li> Poll the GET events API
+    # <code>https://api.gocardless.com/events?payer_authorisation={id}&action=completed</code>
+    # </li>
+    # </ol>
+    #
+    # <p class="notice">
+    #   Note that the `create` and `update` endpoints behave differently than
+    #   other existing `create` and `update` endpoints. The Payer Authorisation
+    # is still saved if incomplete data is provided.
+    #   We return the list of incomplete data in the `incomplete_fields` along
+    # with the resources in the body of the response.
+    #   <br><br>
+    #   The API is designed to be flexible and allows you to collect information
+    # in multiple steps without storing any sensitive data in the browser or in
+    # your servers.
+    # </p>
+    class PayerAuthorisation
+      attr_reader :bank_account
+      attr_reader :created_at
+      attr_reader :customer
+      attr_reader :id
+      attr_reader :incomplete_fields
+      attr_reader :mandate
+      attr_reader :status
+
+      # Initialize a payer_authorisation resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @bank_account = object['bank_account']
+        @created_at = object['created_at']
+        @customer = object['customer']
+        @id = object['id']
+        @incomplete_fields = object['incomplete_fields']
+        @links = object['links']
+        @mandate = object['mandate']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @payer_authorisation_links ||= Links.new(@links)
+      end
+
+      # Provides the payer_authorisation resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def bank_account
+          @links['bank_account']
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def mandate
+          @links['mandate']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/payout.rb

@@ -30,6 +30,7 @@ module GoCardlessPro
       attr_reader :payout_type
       attr_reader :reference
       attr_reader :status
+      attr_reader :tax_currency
 
       # Initialize a payout resource instance
       # @param object [Hash] an object returned from the API
@@ -48,6 +49,7 @@ module GoCardlessPro
         @payout_type = object['payout_type']
         @reference = object['reference']
         @status = object['status']
+        @tax_currency = object['tax_currency']
         @response = response
       end
 

data/lib/gocardless_pro/resources/payout_item.rb

@@ -32,6 +32,7 @@ module GoCardlessPro
     #
     class PayoutItem
       attr_reader :amount
+      attr_reader :taxes
       attr_reader :type
 
       # Initialize a payout_item resource instance
@@ -41,6 +42,7 @@ module GoCardlessPro
 
         @amount = object['amount']
         @links = object['links']
+        @taxes = object['taxes']
         @type = object['type']
         @response = response
       end
@@ -71,6 +73,10 @@ module GoCardlessPro
         def payment
           @links['payment']
         end
+
+        def refund
+          @links['refund']
+        end
       end
     end
   end

data/lib/gocardless_pro/resources/tax_rate.rb

@@ -0,0 +1,51 @@
+# 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.
+#
+
+require 'uri'
+
+module GoCardlessPro
+  # A module containing classes for each of the resources in the GC Api
+  module Resources
+    # Represents an instance of a tax_rate resource returned from the API
+
+    # Tax rates from tax authority.
+    #
+    # We also maintain a [static list of the tax rates for each
+    # jurisdiction](#appendix-tax-rates).
+    class TaxRate
+      attr_reader :end_date
+      attr_reader :id
+      attr_reader :jurisdiction
+      attr_reader :percentage
+      attr_reader :start_date
+      attr_reader :type
+
+      # Initialize a tax_rate resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @end_date = object['end_date']
+        @id = object['id']
+        @jurisdiction = object['jurisdiction']
+        @percentage = object['percentage']
+        @start_date = object['start_date']
+        @type = object['type']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Provides the tax_rate resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+    end
+  end
+end

data/lib/gocardless_pro/services/bank_details_lookups_service.rb

@@ -1,5 +1,4 @@
 require_relative './base_service'
-require 'uri'
 
 # encoding: utf-8
 #
@@ -59,15 +58,6 @@ module GoCardlessPro
       def envelope_key
         'bank_details_lookups'
       end
-
-      # take a URL with placeholder params and substitute them out for the actual value
-      # @param url [String] the URL with placeholders in
-      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
-      def sub_url(url, param_map)
-        param_map.reduce(url) do |new_url, (param, value)|
-          new_url.gsub(":#{param}", URI.escape(value))
-        end
-      end
     end
   end
 end

data/lib/gocardless_pro/services/base_service.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 module GoCardlessPro
   # Module that contains all services for making requests to the API.
   module Services
@@ -23,6 +25,15 @@ module GoCardlessPro
       def envelope_key
         raise NotImplementedError
       end
+
+      # take a URL with placeholder params and substitute them out for the actual value
+      # @param url [String] the URL with placeholders in
+      # @param param_map [Hash] a hash of placeholders and their actual values (which will be escaped)
+      def sub_url(url, param_map)
+        param_map.reduce(url) do |new_url, (param, value)|
+          new_url.gsub(":#{param}", CGI.escape(value))
+        end
+      end
     end
   end
 end