gocardless_pro 2.23.0 → 2.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 380e86ab83d0876327222f7966dbae08687e51cec34c468f2f57b9064a6de49b
-  data.tar.gz: 92a6001ee0d724bb218d3d4ef6e245389842391b8d251e7b79afe6210432367a
+  metadata.gz: ed30309cc0e32f7ec8fe6136447f06a06b7f6b42fea7ccadd35313cd2a5ca0a1
+  data.tar.gz: cd88fcef318324644a91336c487e2704283e12120c938bc48bfbba5cbaa36919
 SHA512:
-  metadata.gz: 6241d24b24dcf35224c87bf2c559c3a0c6f543ef4f3e2c73885e8aee1a4cccc9e8fb748d323df5768c9acd01510b0ae78cf8182d2d684a7feb119bd91ad0c5ac
-  data.tar.gz: 2981ece7e5ad7cef1056ed51a02dc805c5a4c3d41ec483604e2b0ae2a552ca6cd2d2da1e7a92fa1740c9ce61b55e3fecd27c9138817bcf87a8d830047acdd552
+  metadata.gz: af3903ffe4dc7425072a286abc535fa379fd8d293307112d6f26b66d1ed283b7f8a440cddf833f255b13507b09ed5671d43e30773b1b50305c736ae30c84520b
+  data.tar.gz: c1f579f53780f7c1f96464810e2a5186fddf1d041af62f7cf975fa6d7e4304c1d149b74ff9fdf3d07985e41bb1ee46eb71ac67d556aab49343e85650e02f06b7

data/.circleci/config.yml

@@ -13,7 +13,19 @@ jobs:
     steps:
       - checkout
       - run: bundle install && bundle exec rspec
-
+  publish: &publish
+    docker:
+      - image: ruby:2.6
+    steps:
+      - checkout
+      - run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: $RUBYGEM_PUBLISH_API_KEY\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+          
 workflows:
   version: 2
   tests:
@@ -22,11 +34,18 @@ workflows:
           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"]
+              ruby-version: ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
             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"
+              - faraday-version: "0.9.2"
+                ruby-version: "3.0"
+      - publish:
+          filters:
+            branches:
+              only:
+                - master      
+          requires:
+            - test

data/lib/gocardless_pro.rb

@@ -32,15 +32,30 @@ require_relative 'gocardless_pro/error/gocardless_error'
 require_relative 'gocardless_pro/error/invalid_api_usage_error'
 require_relative 'gocardless_pro/error/invalid_state_error'
 require_relative 'gocardless_pro/error/api_error'
+require_relative 'gocardless_pro/error/permission_error'
+require_relative 'gocardless_pro/error/authentication_error'
+require_relative 'gocardless_pro/error/rate_limit_error'
 require_relative 'gocardless_pro/paginator'
 require_relative 'gocardless_pro/request'
 require_relative 'gocardless_pro/response'
 require_relative 'gocardless_pro/api_response'
 require_relative 'gocardless_pro/webhook'
 
+require_relative 'gocardless_pro/resources/bank_authorisation'
+require_relative 'gocardless_pro/services/bank_authorisations_service'
+
 require_relative 'gocardless_pro/resources/bank_details_lookup'
 require_relative 'gocardless_pro/services/bank_details_lookups_service'
 
+require_relative 'gocardless_pro/resources/billing_request'
+require_relative 'gocardless_pro/services/billing_requests_service'
+
+require_relative 'gocardless_pro/resources/billing_request_flow'
+require_relative 'gocardless_pro/services/billing_request_flows_service'
+
+require_relative 'gocardless_pro/resources/billing_request_template'
+require_relative 'gocardless_pro/services/billing_request_templates_service'
+
 require_relative 'gocardless_pro/resources/creditor'
 require_relative 'gocardless_pro/services/creditors_service'
 
@@ -65,6 +80,9 @@ require_relative 'gocardless_pro/services/events_service'
 require_relative 'gocardless_pro/resources/instalment_schedule'
 require_relative 'gocardless_pro/services/instalment_schedules_service'
 
+require_relative 'gocardless_pro/resources/institution'
+require_relative 'gocardless_pro/services/institutions_service'
+
 require_relative 'gocardless_pro/resources/mandate'
 require_relative 'gocardless_pro/services/mandates_service'
 
@@ -77,6 +95,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'
 
@@ -92,10 +113,16 @@ require_relative 'gocardless_pro/services/redirect_flows_service'
 require_relative 'gocardless_pro/resources/refund'
 require_relative 'gocardless_pro/services/refunds_service'
 
+require_relative 'gocardless_pro/resources/scenario_simulator'
+require_relative 'gocardless_pro/services/scenario_simulators_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/resources/webhook'
+require_relative 'gocardless_pro/services/webhooks_service'
+
 require_relative 'gocardless_pro/client.rb'

data/lib/gocardless_pro/api_service.rb

@@ -34,6 +34,10 @@ module GoCardlessPro
       @headers = options[:default_headers] || {}
       @headers['Authorization'] = "Bearer #{token}"
       @on_idempotency_conflict = options[:on_idempotency_conflict] || :fetch
+
+      unless %i[fetch raise].include?(@on_idempotency_conflict)
+        raise ArgumentError, 'Unknown mode for :on_idempotency_conflict'
+      end
     end
 
     # Make a request to the API

data/lib/gocardless_pro/client.rb

@@ -3,11 +3,31 @@ module GoCardlessPro
   class Client
     extend Forwardable
 
+    # Access to the service for bank_authorisation to make API calls
+    def bank_authorisations
+      @bank_authorisations ||= Services::BankAuthorisationsService.new(@api_service)
+    end
+
     # Access to the service for bank_details_lookup to make API calls
     def bank_details_lookups
       @bank_details_lookups ||= Services::BankDetailsLookupsService.new(@api_service)
     end
 
+    # Access to the service for billing_request to make API calls
+    def billing_requests
+      @billing_requests ||= Services::BillingRequestsService.new(@api_service)
+    end
+
+    # Access to the service for billing_request_flow to make API calls
+    def billing_request_flows
+      @billing_request_flows ||= Services::BillingRequestFlowsService.new(@api_service)
+    end
+
+    # Access to the service for billing_request_template to make API calls
+    def billing_request_templates
+      @billing_request_templates ||= Services::BillingRequestTemplatesService.new(@api_service)
+    end
+
     # Access to the service for creditor to make API calls
     def creditors
       @creditors ||= Services::CreditorsService.new(@api_service)
@@ -48,6 +68,11 @@ module GoCardlessPro
       @instalment_schedules ||= Services::InstalmentSchedulesService.new(@api_service)
     end
 
+    # Access to the service for institution to make API calls
+    def institutions
+      @institutions ||= Services::InstitutionsService.new(@api_service)
+    end
+
     # Access to the service for mandate to make API calls
     def mandates
       @mandates ||= Services::MandatesService.new(@api_service)
@@ -68,6 +93,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)
@@ -93,6 +123,11 @@ module GoCardlessPro
       @refunds ||= Services::RefundsService.new(@api_service)
     end
 
+    # Access to the service for scenario_simulator to make API calls
+    def scenario_simulators
+      @scenario_simulators ||= Services::ScenarioSimulatorsService.new(@api_service)
+    end
+
     # Access to the service for subscription to make API calls
     def subscriptions
       @subscriptions ||= Services::SubscriptionsService.new(@api_service)
@@ -103,6 +138,11 @@ module GoCardlessPro
       @tax_rates ||= Services::TaxRatesService.new(@api_service)
     end
 
+    # Access to the service for webhook to make API calls
+    def webhooks
+      @webhooks ||= Services::WebhooksService.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
@@ -153,7 +193,7 @@ module GoCardlessPro
           'User-Agent' => user_agent.to_s,
           'Content-Type' => 'application/json',
           'GoCardless-Client-Library' => 'gocardless-pro-ruby',
-          'GoCardless-Client-Version' => '2.23.0',
+          'GoCardless-Client-Version' => '2.28.0',
         },
       }
     end

data/lib/gocardless_pro/error/authentication_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class AuthenticationError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/error/permission_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class PermissionError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/error/rate_limit_error.rb

@@ -0,0 +1,4 @@
+module GoCardlessPro
+  class RateLimitError < InvalidApiUsageError
+  end
+end

data/lib/gocardless_pro/middlewares/raise_gocardless_errors.rb

@@ -12,12 +12,23 @@ module GoCardlessPro
         if CLIENT_ERROR_STATUSES.include?(env.status)
           json_body ||= JSON.parse(env.body) unless env.body.empty?
           error_type = json_body['error']['type']
-          raise(error_class_for_type(error_type), json_body['error'])
+
+          error_class = error_class_for_status(env.status) || error_class_for_type(error_type)
+
+          raise(error_class, json_body['error'])
         end
       end
 
       private
 
+      def error_class_for_status(code)
+        {
+          401 => GoCardlessPro::AuthenticationError,
+          403 => GoCardlessPro::PermissionError,
+          429 => GoCardlessPro::RateLimitError,
+        }.fetch(code, nil)
+      end
+
       def error_class_for_type(type)
         {
           validation_failed: GoCardlessPro::ValidationError,

data/lib/gocardless_pro/resources/bank_authorisation.rb

@@ -0,0 +1,85 @@
+# 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 bank_authorisation resource returned from the API
+
+    # Bank Authorisations can be used to authorise Billing Requests.
+    # Authorisations
+    # are created against a specific bank, usually the bank that provides the
+    # payer's
+    # account.
+    #
+    # Creation of Bank Authorisations is only permitted from GoCardless hosted
+    # UIs
+    # (see Billing Request Flows) to ensure we meet regulatory requirements for
+    # checkout flows.
+    class BankAuthorisation
+      attr_reader :authorisation_type
+      attr_reader :authorised_at
+      attr_reader :created_at
+      attr_reader :expires_at
+      attr_reader :id
+      attr_reader :last_visited_at
+      attr_reader :redirect_uri
+      attr_reader :url
+
+      # Initialize a bank_authorisation resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @authorisation_type = object['authorisation_type']
+        @authorised_at = object['authorised_at']
+        @created_at = object['created_at']
+        @expires_at = object['expires_at']
+        @id = object['id']
+        @last_visited_at = object['last_visited_at']
+        @links = object['links']
+        @redirect_uri = object['redirect_uri']
+        @url = object['url']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @bank_authorisation_links ||= Links.new(@links)
+      end
+
+      # Provides the bank_authorisation resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def billing_request
+          @links['billing_request']
+        end
+
+        def institution
+          @links['institution']
+        end
+
+        def payment_request
+          @links['payment_request']
+        end
+      end
+    end
+  end
+end

data/lib/gocardless_pro/resources/billing_request.rb

@@ -0,0 +1,108 @@
+# 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 billing_request resource returned from the API
+
+    # Billing Requests help create resources that require input or action from a
+    # customer. An example of required input might be additional customer
+    # billing
+    # details, while an action would be asking a customer to authorise a payment
+    # using their mobile banking app.
+    #
+    # See [Billing Requests:
+    # Overview](https://developer.gocardless.com/getting-started/billing-requests/overview/)
+    # for how-to's, explanations and tutorials.
+    class BillingRequest
+      attr_reader :actions
+      attr_reader :created_at
+      attr_reader :id
+      attr_reader :mandate_request
+      attr_reader :metadata
+      attr_reader :payment_request
+      attr_reader :resources
+      attr_reader :status
+
+      # Initialize a billing_request resource instance
+      # @param object [Hash] an object returned from the API
+      def initialize(object, response = nil)
+        @object = object
+
+        @actions = object['actions']
+        @created_at = object['created_at']
+        @id = object['id']
+        @links = object['links']
+        @mandate_request = object['mandate_request']
+        @metadata = object['metadata']
+        @payment_request = object['payment_request']
+        @resources = object['resources']
+        @status = object['status']
+        @response = response
+      end
+
+      def api_response
+        ApiResponse.new(@response)
+      end
+
+      # Return the links that the resource has
+      def links
+        @billing_request_links ||= Links.new(@links)
+      end
+
+      # Provides the billing_request resource as a hash of all its readable attributes
+      def to_h
+        @object
+      end
+
+      class Links
+        def initialize(links)
+          @links = links || {}
+        end
+
+        def bank_authorisation
+          @links['bank_authorisation']
+        end
+
+        def creditor
+          @links['creditor']
+        end
+
+        def customer
+          @links['customer']
+        end
+
+        def customer_bank_account
+          @links['customer_bank_account']
+        end
+
+        def customer_billing_detail
+          @links['customer_billing_detail']
+        end
+
+        def mandate_request
+          @links['mandate_request']
+        end
+
+        def mandate_request_mandate
+          @links['mandate_request_mandate']
+        end
+
+        def payment_request
+          @links['payment_request']
+        end
+
+        def payment_request_payment
+          @links['payment_request_payment']
+        end
+      end
+    end
+  end
+end