onlinepayments-sdk-ruby 4.23.0 → 5.0.0

data/lib/onlinepayments/sdk/json/marshaller.rb

@@ -0,0 +1,27 @@
+module OnlinePayments
+  module SDK
+    module JSON
+      # Class responsible for marshalling and unmarshalling objects to and from JSON
+      class Marshaller
+
+        # Marshals _request_object_ to JSON format by calling #to_h on it.
+        #
+        # @param request_object [OnlinePayments::SDK::Domain::DataObject] the object to format
+        # @return [String] _request_object_ converted to JSON
+        def marshal(request_object)
+          raise NotImplementedError
+        end
+
+        # Unmarshals a JSON string into an object of type _type_.
+        # The new object is initialized by calling .new_from_hash with contents of the JSON as a Hash object.
+        #
+        # @param response_json [String] The JSON to unmarshal
+        # @param type          [Type] The class of the object that will be instantiated using _type.new_from_hash_
+        # @return The JSON unmarshalled to the given type
+        def unmarshal(response_json, type)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/json/marshaller_syntax_exception.rb

@@ -0,0 +1,9 @@
+module OnlinePayments
+  module SDK
+    module JSON
+      # Raised when an error occurred while marshalling/unmarshalling data to/from JSON
+      class MarshallerSyntaxException < RuntimeError
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/json.rb

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

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

@@ -1,21 +1,23 @@
-module OnlinePayments::SDK
-  module Logging
+module OnlinePayments
+  module SDK
+    module Logging
+      # Base logger class used in this SDK. This class is an interface and cannot be instantiated.
+      class CommunicatorLogger
 
-    # Base logger class used in this SDK. This class is an interface and cannot be instantiated.
-    class CommunicatorLogger
-      # Interface, no instantiation
-      # @see OnlinePayments::SDK::Logging::StdoutCommunicatorLogger
-      # @see OnlinePayments::SDK::Logging::RubyCommunicatorLogger
-      def initialize
-        raise NotImplementedError, "#{self.class.name} is not implemented."
-      end
+        # Interface, no instantiation
+        # @see OnlinePayments::SDK::Logging::StdoutCommunicatorLogger
+        # @see OnlinePayments::SDK::Logging::RubyCommunicatorLogger
+        def initialize
+          raise NotImplementedError.new("#{self.class.name} is not implemented.")
+        end
 
-      # Logs a message with or without exception
-      #
-      # @param message [String] the message to log
-      # @param thrown  [Exception, false] the exception to log, or false to log no exception
-      def log(message, thrown = false)
-        raise NotImplementedError, "#{self.class.name}#log() is not implemented."
+        # Logs a message with or without exception
+        #
+        # @param message [String] the message to log
+        # @param thrown  [Exception, nil] the exception to log, or nil to log no exception
+        def log(message, thrown = nil)
+          raise NotImplementedError.new("#{self.class.name}#log() is not implemented.")
+        end
       end
     end
   end

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

@@ -1,56 +1,89 @@
-module OnlinePayments::SDK
-  module Logging
-
-    # Abstract class used to construct a message describing a request or response.
-    #
-    # @attr_reader [String] request_id   An identifier assigned to the request and response
-    # @attr_reader [String] headers      Request or response headers in string form
-    # @attr_reader [String] body         Request or response body as a string
-    # @attr_reader [String] content_type Content type of the body, generally 'application/json' or 'text/html'
-    class LogMessageBuilder
-
-      attr_reader :request_id
-      attr_reader :headers
-      attr_reader :body
-      attr_reader :content_type
-
-      # Create a new LogMessageBuilder
-      def initialize(request_id)
-        raise ArgumentError if request_id.nil? || request_id.empty?
-        @request_id = request_id
-        @headers = ''
-      end
+require 'onlinepayments/sdk/logging/obfuscation/body_obfuscator'
+require 'onlinepayments/sdk/logging/obfuscation/header_obfuscator'
 
-      # Adds a single header to the #headers string
-      def add_headers(name, value)
-        @headers += ', ' unless @headers.empty?
-        @headers += "#{name}='#{LoggingUtil.obfuscate_header(name, value)}'"
-      end
+module OnlinePayments
+  module SDK
+      module Logging
+        # Abstract class used to construct a message describing a request or response.
+        #
+        # @attr_reader [String] request_id   An identifier assigned to the request and response
+        # @attr_reader [String] headers      Request or response headers in string form
+        # @attr_reader [String] body         Request or response body as a string
+        # @attr_reader [String] content_type Content type of the body, generally 'application/json' or 'text/html'
+        # @attr_reader [OnlinePayments::SDK::Logging::Obfuscation::BodyObfuscator] body_obfuscator
+        # @attr_reader [OnlinePayments::SDK::Logging::Obfuscation::HeaderObfuscator] header_obfuscator
+        class LogMessageBuilder
 
-      # Sets the body of this message to the parameter body.
+          attr_reader :request_id
+          attr_reader :headers
+          attr_reader :body
+          attr_reader :content_type
+          attr_reader :body_obfuscator
+          attr_reader :header_obfuscator
 
-      # @param body         [String] the message body
-      # @param content_type [String] the content type of the body
-      def set_body(body, content_type)
-        @body = LoggingUtil.obfuscate_body(body)
-        @content_type = content_type
-      end
+          # Create a new LogMessageBuilder
+          def initialize(request_id,
+                         body_obfuscator = Obfuscation::BodyObfuscator.default_obfuscator,
+                         header_obfuscator = Obfuscation::HeaderObfuscator.default_obfuscator)
+            raise ArgumentError if request_id.nil? or request_id.empty?
+            raise ArgumentError if body_obfuscator.nil?
+            raise ArgumentError if header_obfuscator.nil?
+            @request_id = request_id
+            @headers = ''
+            @body_obfuscator = body_obfuscator
+            @header_obfuscator = header_obfuscator
+          end
 
-      # Constructs and returns the log message as a string.
-      def get_message
-        raise NotImplementedError, "#{self.class.name}#get_message() is not implemented."
-      end
+          # Adds a single header to the #headers string
+          def add_headers(name, value)
+            @headers += ', ' if @headers.length > 0
+            @headers += name + '="'
+            @headers += @header_obfuscator.obfuscate_header(name, value) unless value.nil?
+            @headers += '"'
+          end
 
-      def to_s
-        self.class == LogMessageBuilder ?
-          super.to_s :
-          get_message
-      end
+          # Sets the body of this message to the parameter body.
+
+          # @param body         [String] the message body
+          # @param content_type [String] the content type of the body
+          def set_body(body, content_type)
+            if is_binary(content_type)
+              @body = "<binary content>"
+            else
+              @body = @body_obfuscator.obfuscate_body(body)
+            end
+            @content_type = content_type
+          end
+
+          # Constructs and returns the log message as a string.
+          # @return [String]
+          def get_message
+            raise NotImplementedError.new("#{self.class.name}#get_message() is not implemented.")
+          end
+
+          def to_s
+            if self.class == LogMessageBuilder
+              super.to_s
+            else
+              get_message
+            end
+          end
+
+          # Returns an empty string if the parameter is nil, and returns the parameter itself otherwise
+          protected def empty_if_null(value)
+            value.nil? ? '' : value
+          end
 
-      # Returns an empty string if the parameter is nil, and returns the parameter itself otherwise
-      protected def empty_if_null(value)
-        value.nil? ? '' : value
+          # Returns whether or not the content type is binary
+          def is_binary(content_type)
+            if content_type.nil?
+              false
+            else
+              content_type = content_type.downcase
+              !(content_type.start_with?("text/") || content_type.include?("json") || content_type.include?("xml"))
+            end
+          end
+        end
       end
-    end
   end
 end

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

@@ -1,9 +1,9 @@
 module OnlinePayments
   module SDK
     module Logging
-
       # Abstract mixin module that allows loggers to be registered to an object.
       module LoggingCapable
+
         def enable_logging(communicator_logger)
           raise NotImplementedError
         end

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