adyen-ruby-api-library 6.0.0 → 10.1.2

data/lib/adyen/client.rb

@@ -1,187 +1,225 @@
-require "faraday"
-require "json"
-require_relative "./errors"
-require_relative "./result"
+# rubocop:disable Metrics/ParameterLists
+# rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/ClassLength
+
+require 'faraday'
+require 'json'
+require_relative './errors'
+require_relative './result'
 
 module Adyen
   class Client
-    attr_accessor :ws_user, :ws_password, :api_key, :client, :adapter, :live_url_prefix
-    attr_reader :env
+    attr_accessor :ws_user, :ws_password, :api_key, :oauth_token, :client, :adapter
+    attr_reader :env, :connection_options, :adapter_options, :terminal_region
 
-    def initialize(ws_user: nil, ws_password: nil, api_key: nil, env: :live, adapter: nil, mock_port: 3001, live_url_prefix: nil, mock_service_url_base: nil)
+    def initialize(ws_user: nil, ws_password: nil, api_key: nil, oauth_token: nil, env: :live, adapter: nil, mock_port: 3001,
+                   live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil, terminal_region: nil)
       @ws_user = ws_user
       @ws_password = ws_password
       @api_key = api_key
+      @oauth_token = oauth_token
       @env = env
       @adapter = adapter || Faraday.default_adapter
+      if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.1')
+        # for faraday 2.1 and higher
+        @adapter_options = adapter_options || Faraday.default_adapter_options
+      else
+        # for faraday 1.x and 2.0
+        @adapter_options = adapter_options || {}
+      end
       @mock_service_url_base = mock_service_url_base || "http://localhost:#{mock_port}"
       @live_url_prefix = live_url_prefix
+      @connection_options = connection_options || Faraday::ConnectionOptions.new
+      @terminal_region = terminal_region
     end
 
     # make sure that env can only be :live, :test, or :mock
     def env=(value)
-      raise ArgumentError, "Invalid value for Client.env: '#{value}'' - must be one of [:live, :test, :mock]" unless [:live, :test, :mock].include? value
+      raise ArgumentError, "Invalid value for Client.env: '#{value}'' - must be one of [:live, :test, :mock]" unless %i[
+        live test mock
+      ].include? value
+
       @env = value
     end
 
     # remove 'https' from live_url_prefix if necessary
     def live_url_prefix=(value)
-      if not value["https://"].nil?
-        value["https://"] = ""
-      end
+      value['https://'] = '' unless value['https://'].nil?
       @live_url_prefix = value
     end
 
     # base URL for API given service and @env
     def service_url_base(service)
-      raise ArgumentError, "Please set Client.live_url_prefix to the portion of your merchant-specific URL prior to '-[service]-live.adyenpayments.com'" if @live_url_prefix.nil? and @env == :live
       if @env == :mock
         @mock_service_url_base
       else
         case service
-        when "Checkout"
-          url = "https://checkout-#{@env}.adyen.com/checkout"
+        when 'Checkout'
+          url = "https://checkout-#{@env}.adyen.com"
           supports_live_url_prefix = true
-        when "Account", "Fund", "Notification", "Hop"
-          url = "https://cal-#{@env}.adyen.com/cal/services"
+        when 'Account', 'Fund', 'Notification', 'Hop'
+          url = "https://cal-#{@env}.adyen.com/cal/services/#{service}"
           supports_live_url_prefix = false
-        when "Recurring", "Payment", "Payout", "BinLookup"
-          url = "https://pal-#{@env}.adyen.com/pal/servlet"
+        when 'Recurring', 'Payment', 'Payout', 'BinLookup', 'StoredValue', 'BalanceControlService'
+          url = "https://pal-#{@env}.adyen.com/pal/servlet/#{service}"
           supports_live_url_prefix = true
-        when "Terminal"
+        when 'PosTerminalManagement'
           url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
           supports_live_url_prefix = false
-        when "DataProtectionService", "DisputeService"
-          url = "https://ca-#{@env}.adyen.com/ca/services"
+        when 'DataProtectionService', 'DisputesService'
+          url = "https://ca-#{@env}.adyen.com/ca/services/#{service}"
+          supports_live_url_prefix = false
+        when 'LegalEntityManagement'
+          url = "https://kyc-#{@env}.adyen.com/lem"
+          supports_live_url_prefix = false
+        when 'BalancePlatform'
+          url = "https://balanceplatform-api-#{@env}.adyen.com/bcl"
+          supports_live_url_prefix = false
+        when 'Transfers'
+          url = "https://balanceplatform-api-#{@env}.adyen.com/btl"
+          supports_live_url_prefix = false
+        when 'Management'
+          url = "https://management-#{@env}.adyen.com"
           supports_live_url_prefix = false
+        when 'TerminalCloudAPI'
+          url = if !terminal_region.nil?
+            "https://terminal-api-#{@env}-#{terminal_region}.adyen.com"
+          else
+            "https://terminal-api-#{@env}.adyen.com"
+          end
+          supports_live_url_prefix = false
+        when 'PosMobile'
+          url = "https://checkout-#{@env}.adyen.com/checkout/possdk"
+          supports_live_url_prefix = true
         else
-          raise ArgumentError, "Invalid service specified"
+          raise ArgumentError, 'Invalid service specified'
+        end
+
+        if @live_url_prefix.nil? && (@env == :live) && supports_live_url_prefix
+          raise ArgumentError,
+                "Please set Client.live_url_prefix to the portion \
+          of your merchant-specific URL prior to '-[service]-live.adyenpayments.com'"
         end
 
         if @env == :live && supports_live_url_prefix
           url.insert(8, "#{@live_url_prefix}-")
-          url["adyen.com"] = "adyenpayments.com"
+          url['adyen.com'] = 'adyenpayments.com'
         end
 
-        return url
+        url
       end
     end
 
     # construct full URL from service and endpoint
     def service_url(service, action, version)
-      if service == "Checkout" || service == "Terminal"
-        "#{service_url_base(service)}/v#{version}/#{action}"
+      if service == "Checkout" && @env == :live
+        return "#{service_url_base(service)}/checkout/v#{version}/#{action}"
+      elsif version == nil
+        return "#{service_url_base(service)}/#{action}"
       else
-        "#{service_url_base(service)}/#{service}/v#{version}/#{action}"
+        return "#{service_url_base(service)}/v#{version}/#{action}"
       end
     end
 
     # send request to adyen API
-    def call_adyen_api(service, action, request_data, headers, version, with_application_info = false)
+    def call_adyen_api(service, action, request_data, headers, version, _with_application_info: false)
       # get URL for requested endpoint
       url = service_url(service, action.is_a?(String) ? action : action.fetch(:url), version)
 
-      # make sure right authentication has been provided
-      # will use api_key if present, otherwise ws_user and ws_password
-      if @api_key.nil?
-        if service == "PaymentSetupAndVerification"
-          raise Adyen::AuthenticationError.new("Checkout service requires API-key", request_data), "Checkout service requires API-key"
-        elsif @ws_password.nil? || @ws_user.nil?
-          raise Adyen::AuthenticationError.new("No authentication found - please set api_key or ws_user and ws_password", request_data), "No authentication found - please set api_key or ws_user and ws_password"
-        else
-          auth_type = "basic"
-        end
-      else
-        auth_type = "api-key"
-      end
+      auth_type = auth_type(service, request_data)
 
       # initialize Faraday connection object
-      conn = Faraday.new(url: url) do |faraday|
-        faraday.adapter @adapter
-        faraday.headers["Content-Type"] = "application/json"
-        faraday.headers["User-Agent"] = Adyen::NAME + "/" + Adyen::VERSION
-
-        # set auth type based on service
-        case auth_type
-        when "basic"
-          faraday.basic_auth(@ws_user, @ws_password)
-        when "api-key"
-          faraday.headers["x-api-key"] = @api_key
-        end
+      conn = Faraday.new(url, @connection_options) do |faraday|
+        faraday.adapter @adapter, **@adapter_options
+        faraday.headers['Content-Type'] = 'application/json'
+        faraday.headers['User-Agent'] = "#{Adyen::NAME}/#{Adyen::VERSION}"
+
+        # set header based on auth_type and service
+        auth_header(auth_type, faraday)
 
         # add optional headers if specified in request
         # will overwrite default headers if overlapping
         headers.map do |key, value|
           faraday.headers[key] = value
         end
+
+        # add library headers
+        faraday.headers['adyen-library-name'] = Adyen::NAME
+        faraday.headers['adyen-library-version'] = Adyen::VERSION
       end
       # if json string convert to hash
       # needed to add applicationInfo
-      if request_data.is_a?(String)
-        request_data = JSON.parse(request_data)
-      end
-
-      # add application only on checkout service
-      if with_application_info
-        add_application_info(request_data)
-      end
+      request_data = JSON.parse(request_data) if request_data.is_a?(String)
 
       # convert to json
       request_data = request_data.to_json
 
       if action.is_a?(::Hash)
-        if action.fetch(:method) == "get"
+        if action.fetch(:method) == 'get'
           begin
-            response = conn.get 
-          rescue Faraday::ConnectionFailed => connection_error
-            raise connection_error, "Connection to #{url} failed"
+            response = conn.get
+          rescue Faraday::ConnectionFailed => e
+            raise e, "Connection to #{url} failed"
           end
         end
-        if action.fetch(:method) == "patch"
+        if action.fetch(:method) == 'delete'
+          begin
+            response = conn.delete
+          rescue Faraday::ConnectionFailed => e
+            raise e, "Connection to #{url} failed"
+          end
+        end
+        if action.fetch(:method) == 'patch'
           begin
             response = conn.patch do |req|
               req.body = request_data
             end
-          rescue Faraday::ConnectionFailed => connection_error
-            raise connection_error, "Connection to #{url} failed"
+          rescue Faraday::ConnectionFailed => e
+            raise e, "Connection to #{url} failed"
+          end
+        end
+        if action.fetch(:method) == 'post'
+          # post request to Adyen
+          begin
+            response = conn.post do |req|
+              req.body = request_data
+            end
+          rescue Faraday::ConnectionFailed => e
+            raise e, "Connection to #{url} failed"
           end
         end
       else
-        # post request to Adyen
         begin
           response = conn.post do |req|
             req.body = request_data
-          end # handle client errors
-        rescue Faraday::ConnectionFailed => connection_error
-          raise connection_error, "Connection to #{url} failed"
+          end
+        rescue Faraday::ConnectionFailed => e
+          raise e, "Connection to #{url} failed"
         end
       end
-
       # check for API errors
       case response.status
       when 401
-        raise Adyen::AuthenticationError.new("Invalid API authentication; https://docs.adyen.com/user-management/how-to-get-the-api-key", request_data)
+        raise Adyen::AuthenticationError.new(
+          'Invalid API authentication; https://docs.adyen.com/user-management/how-to-get-the-api-key', request_data
+        )
       when 403
-        raise Adyen::PermissionError.new("Missing user permissions; https://docs.adyen.com/user-management/user-roles", request_data)
+        raise Adyen::PermissionError.new('Missing user permissions; https://docs.adyen.com/user-management/user-roles',
+                                         request_data, response.body)
       end
 
-      formatted_response = AdyenResult.new(response.body, response.headers, response.status)
-
-      formatted_response
-    end
-
-    # add application_info for analytics
-    def add_application_info(request_data)
-      adyenLibrary = {
-        :name => Adyen::NAME,
-        :version => Adyen::VERSION.to_s,
-      }
-
-      if request_data[:applicationInfo].nil?
-        request_data[:applicationInfo] = {}
+      # delete has no response.body (unless it throws an error)
+      if response.body.nil? || response.body === ''
+        AdyenResult.new('{}', response.headers, response.status)
+      # terminal API async call returns always 'ok'
+      elsif response.body === 'ok'
+        AdyenResult.new('{}', response.headers, response.status)
+      else
+        AdyenResult.new(response.body, response.headers, response.status)
       end
-
-      request_data[:applicationInfo][:adyenLibrary] = adyenLibrary
     end
 
     # services
@@ -189,12 +227,12 @@ module Adyen
       @checkout ||= Adyen::Checkout.new(self)
     end
 
-    def payments
-      @payments ||= Adyen::Payments.new(self)
+    def payment
+      @payment ||= Adyen::Payment.new(self)
     end
 
-    def payouts
-      @payouts ||= Adyen::Payouts.new(self)
+    def payout
+      @payout ||= Adyen::Payout.new(self)
     end
 
     def recurring
@@ -205,20 +243,96 @@ module Adyen
       @marketpay ||= Adyen::Marketpay::Marketpay.new(self)
     end
 
-    def postfmapi
-      @postfmapi ||= Adyen::PosTerminalManagement.new(self)
+    def pos_terminal_management
+      @pos_terminal_management ||= Adyen::PosTerminalManagement.new(self)
     end
 
     def data_protection
       @data_protection ||= Adyen::DataProtection.new(self)
     end
 
-    def dispute
-      @dispute ||= Adyen::Dispute.new(self)
+    def disputes
+      @disputes ||= Adyen::Disputes.new(self)
     end
 
     def bin_lookup
       @bin_lookup ||= Adyen::BinLookup.new(self)
     end
+
+    def legal_entity_management
+      @legal_entity_management ||= Adyen::LegalEntityManagement.new(self)
+    end
+
+    def balance_platform
+      @balance_platform ||= Adyen::BalancePlatform.new(self)
+    end
+
+    def transfers
+      @transfers ||= Adyen::Transfers.new(self)
+    end
+
+    def management
+      @management ||= Adyen::Management.new(self)
+    end
+
+    def stored_value
+      @stored_value ||= Adyen::StoredValue.new(self)
+    end
+
+    def balance_control_service
+      @balance_control_service ||= Adyen::BalanceControlService.new(self)
+    end
+
+    def terminal_cloud_api
+      @terminal_cloud_api ||= Adyen::TerminalCloudAPI.new(self)
+    end
+
+    def pos_mobile
+      @pos_mobile ||= Adyen::PosMobile.new(self)
+    end
+
+    private
+
+    def auth_header(auth_type, faraday)
+      case auth_type
+      when "basic"
+        if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.0')
+          # for faraday 2.0 and higher
+          faraday.request :authorization, :basic, @ws_user, @ws_password
+        else
+          # for faraday 1.x
+          faraday.basic_auth(@ws_user, @ws_password)
+        end
+      when "api-key"
+        faraday.headers["x-api-key"] = @api_key
+      when "oauth"
+        faraday.headers["Authorization"] = "Bearer #{@oauth_token}"
+      end
+    end
+
+    def auth_type(service, request_data)
+      # make sure valid authentication has been provided
+      validate_auth_type(service, request_data)
+      # Will prioritize authentication methods in this order:
+      # api-key, oauth, basic
+      return "api-key" unless @api_key.nil?
+      return "oauth" unless @oauth_token.nil?
+      "basic"
+    end
+
+    def validate_auth_type(service, request_data)
+      # ensure authentication has been provided
+      if @api_key.nil? && @oauth_token.nil? && (@ws_password.nil? || @ws_user.nil?)
+        raise Adyen::AuthenticationError.new(
+          'No authentication found - please set api_key, oauth_token, or ws_user and ws_password',
+          request_data
+        )
+      end
+      if service == "PaymentSetupAndVerification" && @api_key.nil? && @oauth_token.nil? && @ws_password.nil? && @ws_user.nil?
+        raise Adyen::AuthenticationError.new('Checkout service requires API-key or oauth_token', request_data),
+              'Checkout service requires API-key or oauth_token'
+      end
+    end
   end
 end
+# rubocop:enable all

data/lib/adyen/errors.rb

@@ -1,9 +1,18 @@
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/ParameterLists
+
 module Adyen
   class AdyenError < StandardError
     attr_reader :code, :response, :request, :msg
 
     def initialize(request = nil, response = nil, msg = nil, code = nil)
-      mask_fields(request)
+      unless request.nil?
+        request = request.is_a?(Hash) ? request : JSON.parse(request, symbolize_names: true)
+        mask_fields(request)
+      end
 
       # components of formatted error message
       attributes = {
@@ -27,34 +36,32 @@ module Adyen
       return if request.nil?
 
       # sensitive fields
-      fields_to_mask = [
-        :expiryMonth,
-        :expiryYear,
-        :encryptedCardNumber,
-        :encryptedExpiryMonth,
-        :encryptedExpiryYear,
-        :encryptedSecurityCode
+      fields_to_mask = %i[
+        expiryMonth
+        expiryYear
+        encryptedCardNumber
+        encryptedExpiryMonth
+        encryptedExpiryYear
+        encryptedSecurityCode
       ]
 
       # convert to hash if necessary
-      request = request.is_a?(Hash) ? request : JSON.parse(request)
+      request = request.is_a?(Hash) ? request : JSON.parse(request, symbolize_names: true)
 
       # iterate through request to find fields to mask
       request.each do |k, v|
         if request[k].is_a?(Hash)
           # recursively traverse multi-level hashes
           mask_fields(request[k])
-        else
-          if k == :number
-            # show first 6 and last 4 for cards
-            request[k] = "#{v[0,6]}******#{v[12,16]}"
-          elsif k == :cvc
-            # show length of cvc for debugging
-            request[k] = "*" * v.length
-          elsif fields_to_mask.include? k
-            # generic mask for other fields
-            request[k] = "***"
-          end
+        elsif k == :number
+          request[k] = "#{v[0, 6]}******#{v[12, 16]}"
+        # show first 6 and last 4 for cards
+        elsif k == :cvc
+          # show length of cvc for debugging
+          request[k] = '*' * v.length
+        elsif fields_to_mask.include? k
+          # generic mask for other fields
+          request[k] = '***'
         end
       end
     end
@@ -67,8 +74,8 @@ module Adyen
   end
 
   class PermissionError < AdyenError
-    def initialize(msg, request)
-      super(request, nil, msg, 403)
+    def initialize(msg, request, response)
+      super(request, response, msg, 403)
     end
   end
 
@@ -103,3 +110,4 @@ module Adyen
     end
   end
 end
+# rubocop:enable all

data/lib/adyen/hash_with_accessors.rb

@@ -1,3 +1,7 @@
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Metrics/PerceivedComplexity
+
 # This utility method inherits from Hash, but allows keys to be read
 # and updated with dot notation. Usage is entirely optional (i.e.,  hash values
 # can still be accessed via symbol and string keys).
@@ -9,11 +13,11 @@ module Adyen
       string_key = method.to_s.sub(/=\z/, '')
       sym_key = string_key.to_sym
 
-      key = if has_key?(string_key)
-        string_key
-      elsif has_key?(sym_key)
-        sym_key
-      end
+      key = if key?(string_key)
+              string_key
+            elsif key?(sym_key)
+              sym_key
+            end
 
       return super unless key
 
@@ -24,7 +28,7 @@ module Adyen
 
         self[key] = args.first
       else
-        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)" unless args.size == 0
+        raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0)" unless args.empty?
 
         self[key]
       end
@@ -32,7 +36,8 @@ module Adyen
 
     def respond_to_missing?(method, include_private = false)
       string_key = method.to_s.sub(/=\z/, '')
-      has_key?(string_key) || has_key?(string_key.to_sym) || super
+      key?(string_key) || key?(string_key.to_sym) || super
     end
   end
 end
+# rubocop:enable all

data/lib/adyen/services/balanceControlService.rb

@@ -0,0 +1,27 @@
+require_relative './service'
+module Adyen
+
+  # NOTE: This class is auto generated by OpenAPI Generator
+  # Ref: https://openapi-generator.tech
+  #
+  # Do not edit the class manually.
+  class BalanceControlService < Service
+    attr_accessor :service, :version
+
+    DEFAULT_VERSION = 1
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalanceControlService')
+    end
+
+    # Start a balance transfer
+    def balance_transfer(request, headers: {})
+      endpoint = '/balanceTransfer'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end

data/lib/adyen/services/balancePlatform/account_holders_api.rb

@@ -0,0 +1,76 @@
+require_relative '../service'
+module Adyen
+
+  # NOTE: This class is auto generated by OpenAPI Generator
+  # Ref: https://openapi-generator.tech
+  #
+  # Do not edit the class manually.
+  class AccountHoldersApi < Service
+    attr_accessor :service, :version
+
+    def initialize(client, version = DEFAULT_VERSION)
+      super(client, version, 'BalancePlatform')
+    end
+
+    # Create an account holder
+    def create_account_holder(request, headers: {})
+      endpoint = '/accountHolders'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint)
+      
+      action = { method: 'post', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+    # Get an account holder
+    def get_account_holder(id, headers: {})
+      endpoint = '/accountHolders/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    # Get all balance accounts of an account holder
+    def get_all_balance_accounts_of_account_holder(id, headers: {}, query_params: {})
+      endpoint = '/accountHolders/{id}/balanceAccounts'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    # Get all transaction rules for an account holder
+    def get_all_transaction_rules_for_account_holder(id, headers: {})
+      endpoint = '/accountHolders/{id}/transactionRules'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    # Get a tax form
+    def get_tax_form(id, headers: {}, query_params: {})
+      endpoint = '/accountHolders/{id}/taxForms'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      endpoint += create_query_string(query_params)
+      action = { method: 'get', url: endpoint }
+      @client.call_adyen_api(@service, action, {}, headers, @version)
+    end
+
+    # Update an account holder
+    def update_account_holder(request, id, headers: {})
+      endpoint = '/accountHolders/{id}'.gsub(/{.+?}/, '%s')
+      endpoint = endpoint.gsub(%r{^/}, '')
+      endpoint = format(endpoint, id)
+      
+      action = { method: 'patch', url: endpoint }
+      @client.call_adyen_api(@service, action, request, headers, @version)
+    end
+
+  end
+end