onlinepayments-sdk-ruby 4.23.0 → 5.1.0

data/lib/onlinepayments/sdk/logging/obfuscation/body_obfuscator.rb

@@ -0,0 +1,113 @@
+require 'onlinepayments/sdk/logging/obfuscation/obfuscation_rule'
+
+module OnlinePayments
+  module SDK
+    module Logging
+      module Obfuscation
+        # A class that can be used to obfuscate properties in JSON bodies.
+        class BodyObfuscator
+
+          # Creates a new body obfuscator.
+          # This will contain some pre-defined obfuscation rules, as well as any provided custom rules
+          #
+          # @param additional_rules [Hash] An optional hash where the keys are property names and the values are
+          #        functions that obfuscate a single value
+          def initialize(additional_rules = nil)
+            @obfuscation_rules = {
+              "additionalInfo" => Obfuscation.obfuscate_all,
+              "cardholderName" => Obfuscation.obfuscate_all,
+              "dateOfBirth" => Obfuscation.obfuscate_all,
+              "emailAddress" => Obfuscation.obfuscate_all,
+              "faxNumber" => Obfuscation.obfuscate_all,
+              "firstName" => Obfuscation.obfuscate_all,
+              "houseNumber" => Obfuscation.obfuscate_all,
+              "mobilePhoneNumber" => Obfuscation.obfuscate_all,
+              "passengerName" => Obfuscation.obfuscate_all,
+              "phoneNumber" => Obfuscation.obfuscate_all,
+              "street" => Obfuscation.obfuscate_all,
+              "workPhoneNumber" => Obfuscation.obfuscate_all,
+              "zip" => Obfuscation.obfuscate_all,
+              "cardNumber" => Obfuscation.obfuscate_all_but_last(4),
+              "expiryDate" => Obfuscation.obfuscate_all_but_last(2),
+              "cvv" => Obfuscation.obfuscate_all,
+              "iban" => Obfuscation.obfuscate_all_but_last(4),
+              "accountNumber" => Obfuscation.obfuscate_all_but_last(4),
+              "reformattedAccountNumber" => Obfuscation.obfuscate_all_but_last(4),
+              "bin" => Obfuscation.obfuscate_all_but_first(6),
+              "value" => Obfuscation.obfuscate_all,
+              "keyId" => Obfuscation.obfuscate_with_fixed_length(8),
+              "secretKey" => Obfuscation.obfuscate_with_fixed_length(8),
+              "publicKey" => Obfuscation.obfuscate_with_fixed_length(8),
+              "userAuthenticationToken" => Obfuscation.obfuscate_with_fixed_length(8),
+              "encryptedPayload" => Obfuscation.obfuscate_with_fixed_length(8),
+              "decryptedPayload" => Obfuscation.obfuscate_with_fixed_length(8),
+              "encryptedCustomerInput" => Obfuscation.obfuscate_with_fixed_length(8),
+            }
+            if additional_rules
+              additional_rules.each do |name, rule|
+                @obfuscation_rules[name] = rule
+              end
+            end
+
+            @property_pattern = build_property_pattern(@obfuscation_rules.keys)
+          end
+
+          private
+
+          def build_property_pattern(pn)
+            return /$^/ if pn.empty? # no possible match
+            # Regex to create:
+            # (["'])(X|Y|Z)\1\s*:\s*(?:(["'])(.*?)(?<!\\)\3|([^"'\s\[\{]\S*))
+            # Groups:
+            # 1: opening " or ' for the property name
+            # 2: property name
+            # 3: opening " or ' for the value
+            # 4: quoted value
+            # 5: non-quoted-value
+            # The negative lookbehind is to allow escaped quotes to be part of
+            # the value. What this does not allow currently is having values end
+            # with a \ (which would be escaped to \\).
+            regex = pn.inject("([\"'])(") { |r, p| "#{r}#{Regexp.quote(p)}|" }.chop <<
+              ")\\1\\s*:\\s*(?:([\"'])(.*?)(?<!\\\\)\\3|([^\"'\\s\\[\\{]((?!,)\\S)*))"
+            /#{regex}/m # dotall mode
+          end
+
+          def obfuscate_value(property_name, value)
+            obfuscation_rule = @obfuscation_rules[property_name]
+            return obfuscation_rule.call(value) if obfuscation_rule
+            value
+          end
+
+          public
+
+          # Obfuscates the given body as necessary.
+          #
+          # @return (String)
+          def obfuscate_body(body)
+            return nil if body.nil?
+            return '' if body.empty?
+
+            body.gsub(@property_pattern) do
+              m = Regexp.last_match
+              property_name = m[2]
+              value = m[4] || m[5]
+              # copy value 'cause it's part of m[0]
+              m[0].sub(value, obfuscate_value(property_name, value.dup))
+            end
+          end
+
+          private
+
+          DEFAULT_OBFUSCATOR = BodyObfuscator.new
+
+          public
+
+          # @return [BodyObfuscator]
+          def self.default_obfuscator
+            DEFAULT_OBFUSCATOR
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/logging/obfuscation/header_obfuscator.rb

@@ -0,0 +1,54 @@
+require 'onlinepayments/sdk/logging/obfuscation/obfuscation_rule'
+
+module OnlinePayments
+  module SDK
+    module Logging
+      module Obfuscation
+        # A class that can be used to obfuscate headers.
+        class HeaderObfuscator
+
+          # Creates a new header obfuscator.
+          # This will contain some pre-defined obfuscation rules, as well as any provided custom rules
+          #
+          # @param additional_rules [Hash] An optional hash where the keys are header names and the values are
+          #        functions that obfuscate a single value
+          def initialize(additional_rules = nil)
+            @obfuscation_rules = {
+              "X-GCS-Authentication-Token" => Obfuscation.obfuscate_with_fixed_length(8),
+              "X-GCS-CallerPassword" => Obfuscation.obfuscate_with_fixed_length(8),
+              "authorization" => Obfuscation.obfuscate_with_fixed_length(8),
+              "www-authenticate" => Obfuscation.obfuscate_with_fixed_length(8),
+              "proxy-authenticate" => Obfuscation.obfuscate_with_fixed_length(8),
+              "proxy-authorization" => Obfuscation.obfuscate_with_fixed_length(8),
+            }
+            if additional_rules
+              additional_rules.each do |name, rule|
+                @obfuscation_rules[name.downcase] = rule
+              end
+            end
+          end
+
+          # Obfuscates the value for the given header as necessary.
+          #
+          # @return (String)
+          def obfuscate_header(header_name, value)
+            obfuscation_rule = @obfuscation_rules[header_name.downcase]
+            return obfuscation_rule.call(value) if obfuscation_rule
+            value
+          end
+
+          private
+
+          DEFAULT_OBFUSCATOR = HeaderObfuscator.new
+
+          public
+
+          # @return [HeaderObfuscator]
+          def self.default_obfuscator
+            DEFAULT_OBFUSCATOR
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/logging/obfuscation/obfuscation_capable.rb

@@ -0,0 +1,21 @@
+module OnlinePayments
+  module SDK
+    module Logging
+      module Obfuscation
+        # Abstract mixin module that allows specifying body and header obfuscators for an object.
+        module ObfuscationCapable
+
+          # Sets the current body obfuscator to use.
+          def set_body_obfuscator(body_obfuscator)
+            raise NotImplementedError
+          end
+
+          # Sets the current header obfuscator to use.
+          def set_header_obfuscator(header_obfuscator)
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/logging/obfuscation/obfuscation_rule.rb

@@ -0,0 +1,47 @@
+module OnlinePayments
+  module SDK
+    module Logging
+      module Obfuscation
+
+        # Returns an obfuscation rule (callable) that will replace all characters with *
+        def self.obfuscate_all
+          ->(value) do
+            return value if value.nil? or value.empty?
+            '*' * (value || '').length
+          end
+        end
+
+        # Returns an obfuscation rule (function) that will replace values with a fixed length string containing only *
+        def self.obfuscate_with_fixed_length(fixed_length)
+          ->(value) { '*' * fixed_length }
+        end
+
+        # Returns an obfuscation rule (function) that will keep a fixed number of characters at the start,
+        # then replaces all other characters with *
+        def self.obfuscate_all_but_first(count)
+          ->(value) do
+            return value if value.nil? or value.empty?
+            return value if value.length < count
+            # range describes the range of characters to replace with asterisks
+            range = count...value.length
+            value[range] = '*' * range.size
+            value
+          end
+        end
+
+        # Returns an obfuscation rule that will keep a fixed number of characters at the end,
+        # then replaces all other characters with *
+        def self.obfuscate_all_but_last(count)
+          ->(value) do
+            return value if value.nil? or value.empty?
+            return value if value.length < count
+            # range describes the range of characters to replace with asterisks
+            range = 0...(value.length - count)
+            value[range] = '*' * range.size
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/logging/obfuscation.rb

@@ -0,0 +1 @@
+Dir[File.join(__dir__, 'obfuscation', '*.rb')].each { |f| require f }

data/lib/onlinepayments/sdk/logging/request_log_message_builder.rb

@@ -1,38 +1,49 @@
-module OnlinePayments::SDK
-  module Logging
+require 'onlinepayments/sdk/logging/obfuscation/body_obfuscator'
+require 'onlinepayments/sdk/logging/obfuscation/header_obfuscator'
+require 'onlinepayments/sdk/logging/log_message_builder'
 
-    # Class that converts data about a request into a properly formatted log message.
-    # Formats request id, http method, uri, headers and body into a helpful message.
-    class RequestLogMessageBuilder < OnlinePayments::SDK::Logging::LogMessageBuilder
+module OnlinePayments
+  module SDK
+    module Logging
+      # Class that converts data about a request into a properly formatted log message.
+      # Formats request id, http method, uri, headers and body into a helpful message.
+      class RequestLogMessageBuilder < LogMessageBuilder
 
-      def initialize(request_id, method, uri)
-        super(request_id)
-        @method = method
-        @uri = uri
-      end
+        def initialize(request_id, method, uri,
+                       body_obfuscator = Obfuscation::BodyObfuscator.default_obfuscator,
+                       header_obfuscator = Obfuscation::HeaderObfuscator.default_obfuscator)
+          super(request_id, body_obfuscator, header_obfuscator)
+          @method = method
+          @uri = uri
+        end
 
-      # Constructs and returns a log message based on the request data. The log message is a string.
-      def get_message
-        @body ?
-          sprintf(MSG_TEMPLATE_WITH_BODY, @request_id, empty_if_null(@method),
-                  format_uri, @headers, empty_if_null(@content_type), @body) :
-          sprintf(MSG_TEMPLATE_WITHOUT_BODY, @request_id, empty_if_null(@method), format_uri, @headers)
-      end
+        # Constructs and returns a log message based on the request data. The log message is a string.
+        def get_message
+          msg_template_without_body = "Outgoing request (requestId='%s'):\n" +
+            "  method:       '%s'\n" +
+            "  uri:          '%s'\n" +
+            "  headers:      '%s'"
+          msg_template_with_body = msg_template_without_body + "\n" +
+            "  content-type: '%s'\n" +
+            "  body:         '%s'"
 
-      private
+          return sprintf(msg_template_without_body, @request_id, empty_if_null(@method),
+                         format_uri, @headers) if @body.nil?
+          sprintf(msg_template_with_body, @request_id, empty_if_null(@method),
+                  format_uri, @headers, empty_if_null(@content_type), @body)
+        end
 
-      MSG_TEMPLATE_WITHOUT_BODY = "Outgoing request (requestId=\"%s\"):\n"\
-                                  "  method:       \"%s\"\n"\
-                                  "  uri:          \"%s\"\n"\
-                                  "  headers:      \"%s\"".freeze
-      MSG_TEMPLATE_WITH_BODY = "#{MSG_TEMPLATE_WITHOUT_BODY}\n"\
-                               "  content-type: \"%s\"\n"\
-                               "  body:         \"%s\"".freeze
+        private
 
-      def format_uri
-        return '' unless @uri && @uri.path
-        return @uri.path unless @uri.query
-        "#{@uri.path}?#{@uri.query}"
+        def format_uri
+          '' unless @uri && @uri.path
+          if @uri.query.nil?
+            @uri.path
+          else
+            "#{@uri.path}?#{@uri.query}" unless @uri.query.nil?
+          end
+          # @uri.path + '?' + empty_if_null(@uri.query)
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/logging/response_log_message_builder.rb

@@ -1,33 +1,40 @@
-module OnlinePayments::SDK
-  module Logging
-
-    class ResponseLogMessageBuilder < LogMessageBuilder
+require 'onlinepayments/sdk/logging/obfuscation/body_obfuscator'
+require 'onlinepayments/sdk/logging/obfuscation/header_obfuscator'
+require 'onlinepayments/sdk/logging/log_message_builder'
 
+module OnlinePayments
+  module SDK
+    module Logging
       # Class that converts data about a response into a properly formatted log message.
       # Formats request id, status code, headers, body and time between request and response into a helpful message.
-      #
-      # @param request_id  [String] identifier of the request corresponding to this response.
-      # @param status_code [Integer] HTTP status code of the response.
-      # @param duration    [Float] time elapsed between request and response.
-      def initialize(request_id, status_code, duration = -1)
-        super(request_id)
-        @status_code = status_code
-        @duration = duration
-      end
+      class ResponseLogMessageBuilder < LogMessageBuilder
+
+        # @param request_id  [String] identifier of the request corresponding to this response.
+        # @param status_code [Integer] HTTP status code of the response.
+        # @param duration    [Float] time elapsed between request and response.
+        def initialize(request_id, status_code, duration = -1,
+                       body_obfuscator = Obfuscation::BodyObfuscator.default_obfuscator,
+                       header_obfuscator = Obfuscation::HeaderObfuscator.default_obfuscator)
+          super(request_id, body_obfuscator, header_obfuscator)
+          @status_code = status_code
+          @duration = duration
+        end
 
-      # Constructs and returns a log message based on the request data. The log message is a string.
-      def get_message
-        msg_template = "Incoming response (requestId=\"%s\"#{(@duration.positive?) ? ", %.3f ms" : ""}):\n" +
-          "  status-code:  \"%s\"\n" +
-          "  headers:      \"%s\"\n" +
-          "  content-type: \"%s\"\n" +
-          "  body:         \"%s\""
+        # Constructs and returns a log message based on the request data. The log message is a string.
+        def get_message
+          msg_template = "Incoming response (requestId='%s'" +
+            ((@duration < 0) ? "" : ", %.3f ms") +
+            "):\n" +
+            "  status-code:  '%s'\n" +
+            "  headers:      '%s'\n" +
+            "  content-type: '%s'\n" +
+            "  body:         '%s'"
 
-        @duration.positive? ?
+          return sprintf(msg_template, @request_id, @status_code, @headers,
+                         empty_if_null(@content_type), empty_if_null(@body)) if @duration < 0
           sprintf(msg_template, @request_id, @duration, @status_code, @headers,
-                  empty_if_null(@content_type), empty_if_null(@body)) :
-          sprintf(msg_template, @request_id, @status_code, @headers,
                   empty_if_null(@content_type), empty_if_null(@body))
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/logging/ruby_communicator_logger.rb

@@ -1,56 +1,60 @@
 require 'English'
+require 'onlinepayments/sdk/logging/communicator_logger'
 
-module OnlinePayments::SDK
-  module Logging
+module OnlinePayments
+  module SDK
+    module Logging
+      # Logging class that Logs messages and errors to a logger.
+      # Errors can be logged at a separate level compared to regular messages.
+      class RubyCommunicatorLogger < CommunicatorLogger
 
-    # Logging class that Logs messages and errors to a logger.
-    # Errors can be logged at a separate level compared to regular messages.
-    class RubyCommunicatorLogger < CommunicatorLogger
+        # Creates a new RubyCommunicatorLogger instance.
+        #
+        # @param logger      [Logger] the logger to log messages to. Messages to log will be provided using logger#log(message level, message)
+        # @param log_level   [String] log level to use for non-error messages.
+        # @param error_level [String, nil] error logging level to use.
+        def initialize(logger, log_level, error_level = nil)
+          # implement the interface
+          error_level ||= log_level
+          raise ArgumentError unless logger
+          raise ArgumentError unless log_level
+          raise ArgumentError unless error_level
 
-      # Creates a new RubyCommunicatorLogger instance.
-      #
-      # @param logger      [Logger] the logger to log messages to. Messages to log will be provided using logger#log(message level, message)
-      # @param log_level   [String] log level to use for non-error messages.
-      # @param error_level [String] error logging level to use.
-      def initialize(logger, log_level, error_level = false)
-        # implement the interface
-        error_level ||= log_level
-        raise ArgumentError unless logger
-        raise ArgumentError unless log_level
-        raise ArgumentError unless error_level
-
-        @logger = logger
-        @log_level = log_level
-        @errorLevel = error_level
-      end
+          @logger = logger
+          @log_level = log_level
+          @error_level = error_level
+        end
 
-      # Logs a single error or non-error message to the logger.
-      def log(msg, thrown = nil)
-        # use Ruby Logger
-        if thrown
-          @logger.log(@errorLevel) { msg + $RS + thrown.to_s + $RS + thrown.backtrace.join($RS) }
-        else
-          @logger.log(@log_level, msg)
+        # Logs a single error or non-error message to the logger.
+        def log(msg, thrown = nil)
+          # use Ruby Logger
+          if thrown
+            @logger.log(@error_level) { msg + $RS + thrown.to_s + $RS + thrown.backtrace.join($RS) }
+          else
+            @logger.log(@log_level, msg)
+          end
         end
-      end
 
-      # Opens or creates a new file in write-only mode with _filename_.
-      def self.create_logfile(filename)
-        logdev = begin
-                   open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
-                 rescue Errno::EEXIST
-                   # file is created by another process
-                   open_logfile(filename)
-                 end
-        logdev.sync = true
-        logdev
-      end
+        # Opens or creates a new file in write-only mode with _filename_.
+        def self.create_logfile(filename)
+          logdev = begin
+                     open(filename, (File::WRONLY | File::APPEND | File::CREAT | File::EXCL))
+                   rescue Errno::EEXIST
+                     # file is created by another process
+                     open_logfile(filename)
+                   end
+          logdev.sync = true
+          logdev
+        end
 
-      # Opens or creates a new file in write-only mode with _filename_.
-      def self.open_logfile(filename)
-        open(filename, (File::WRONLY | File::APPEND))
-      rescue Errno::ENOENT
-        create_logfile(filename)
+        # Opens or creates a new file in write-only mode with _filename_.
+        def self.open_logfile(filename)
+          begin
+            open(filename, (File::WRONLY | File::APPEND))
+          rescue Errno::ENOENT
+            create_logfile(filename)
+          end
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/logging/stdout_communicator_logger.rb

@@ -1,33 +1,30 @@
 require 'English'
 require 'singleton'
+require 'onlinepayments/sdk/logging/communicator_logger'
 
-module OnlinePayments::SDK
-  module Logging
+module OnlinePayments
+  module SDK
+    module Logging
+      # Logging class that logs the messages to $stdout.
+      class StdoutCommunicatorLogger < CommunicatorLogger
+        include Singleton
 
-    # {OnlinePayments::SDK::Logging::CommunicatorLogger} that logs the messages to $stdout.
-    class StdoutCommunicatorLogger < CommunicatorLogger
-      include Singleton
+        def initialize
+          # implement the interface
+        end
 
-      def initialize
-        # implement the interface
-      end
-
-      # NOTE: this alias is needed to not break existing method calls depending on old interface
-      class << self
-        alias_method :INSTANCE, :instance
-      end
-
-      # Logs a single error or non-error message to $stdout.
-      def log(msg, thrown = nil)
-        $stdout.puts get_date_prefix + msg
-        $stdout.puts thrown.to_s if thrown
-        $stdout.puts thrown.backtrace.join($RS) if thrown
-      end
+        # Logs a single error or non-error message to $stdout.
+        def log(msg, thrown = nil)
+          $stdout.puts get_date_prefix + msg
+          $stdout.puts thrown.to_s if thrown
+          $stdout.puts thrown.backtrace.join($RS) if thrown
+        end
 
-      private
+        private
 
-      def get_date_prefix
-        Time.now.strftime("%Y-%m-%dT%H:%M:%S ")
+        def get_date_prefix
+          Time.now.strftime("%Y-%m-%dT%H:%M:%S ")
+        end
       end
     end
   end

data/lib/onlinepayments/sdk/logging.rb

@@ -1,10 +1 @@
-prefix = 'onlinepayments/sdk/logging'
-
-require "#{prefix}/logging_capable"
-require "#{prefix}/log_message_builder"
-require "#{prefix}/request_log_message_builder"
-require "#{prefix}/response_log_message_builder"
-require "#{prefix}/logging_util"
-require "#{prefix}/communicator_logger"
-require "#{prefix}/ruby_communicator_logger"
-require "#{prefix}/stdout_communicator_logger"
+Dir[File.join(__dir__, 'logging', '*.rb')].each { |f| require f }

data/lib/onlinepayments/sdk/merchant/captures/captures_client.rb

@@ -0,0 +1,57 @@
+#
+# This file was automatically generated.
+#
+require 'onlinepayments/sdk/api_resource'
+require 'onlinepayments/sdk/exception_factory'
+require 'onlinepayments/sdk/communication/response_exception'
+require 'onlinepayments/sdk/domain/captures_response'
+require 'onlinepayments/sdk/domain/error_response'
+
+module OnlinePayments
+  module SDK
+    module Merchant
+      module Captures
+        # Captures client. Thread-safe.
+        class CapturesClient < OnlinePayments::SDK::ApiResource
+
+          # @param parent       [OnlinePayments::SDK::ApiResource]
+          # @param path_context [Hash, nil]
+          def initialize(parent, path_context)
+            super(parent: parent, path_context: path_context)
+          end
+
+          # Resource /v2/!{merchantId}/payments/!{paymentId}/captures - Get captures of payment
+          #
+          # @param payment_id [String]
+          # @param context    [OnlinePayments::SDK::CallContext, nil]
+          # @return [OnlinePayments::SDK::Domain::CapturesResponse]
+          # @raise [OnlinePayments::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+          # @raise [OnlinePayments::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+          # @raise [OnlinePayments::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+          # @raise [OnlinePayments::SDK::ReferenceException] if an object was attempted to be referenced that doesn't exist or has been removed,
+          #        or there was a conflict (HTTP status code 404, 409 or 410)
+          # @raise [OnlinePayments::SDK::PlatformException] if something went wrong at the payment platform,
+          #        the payment platform was unable to process a message from a downstream partner/acquirer,
+          #        or the service that you're trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)
+          # @raise [OnlinePayments::SDK::ApiException] if the payment platform returned any other error
+          def get_captures(payment_id, context = nil)
+            path_context = {
+              'paymentId'.freeze => payment_id,
+            }
+            uri = instantiate_uri('/v2/{merchantId}/payments/{paymentId}/captures', path_context)
+            @communicator.get(
+              uri,
+              client_headers,
+              nil,
+              OnlinePayments::SDK::Domain::CapturesResponse,
+              context)
+          rescue OnlinePayments::SDK::Communication::ResponseException => e
+            error_type = OnlinePayments::SDK::Domain::ErrorResponse
+            error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+            raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/merchant/captures.rb

@@ -0,0 +1,4 @@
+#
+# This file was automatically generated.
+#
+Dir[File.join(__dir__, 'captures', '*.rb')].each { |f| require f }