connect-sdk-ruby 2.30.2 → 2.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7db60897f47065c79b42b4f458baaa3eb9c346b66b50381bd795b6abb762fbe6
-  data.tar.gz: 2a43fcff7d2729aefd492f3ace41f6f67dab7157da8699ea38947c3fbc53b73d
+  metadata.gz: 1f9cc67b441796020e9aa26d52bdd4d27e4151ad7ee0011929f623e10eb83ab5
+  data.tar.gz: f67e1575cafad14f2ffebae9544d76bd0e2c5ced65f9ba0ba0903ad56d231abd
 SHA512:
-  metadata.gz: 8e9114ffa747a472929b909730f60748f97fe1409acbcbb143b290e88b2999c34624bf630827e0f3ee7a6aa52368ab100bf944d11ab48c6b07891cacc42a434a
-  data.tar.gz: 1f9a4c4a0db466fd0ecea4fa718738b4c8c7df63e3890d95933ec8de4a853454f39aebc8ff8e9ed05fae107b90e310969183027d327743a8ccd950a79cbafa3b
+  metadata.gz: 8347f98939d41bab6d3b17023f81ec5813d0cb272ab938dae81541de458a5ec5210e0bd83a085b432e2d30692c81cab220f43eca8042b433e37da08591cfa302
+  data.tar.gz: af0b2d7c03d66496bc3335c1bc7785f59a2b3054fe8459f53d93372884af9ed29d12dfdc5dcd0697692d7c6705575020cba08443bd51ab7368b1a815bf717db4

data/README.md

@@ -94,7 +94,8 @@ In order to run the unit and integration tests, some additional dependencies are
 * [rake](https://ruby.github.io/rake/) 12.3.3 or higher
 * [rspec](https://github.com/rspec/rspec) 3.5 or higher
 * [webmock](https://github.com/bblimke/webmock) 2.1 or higher
-* [sinatra](https://github.com/sinatra/sinatra) 1.4 or higher
+* [sinatra](https://github.com/sinatra/sinatra) 2.1 or higher
+* [webrick](https://github.com/ruby/webrick) 1.7 or higher
 
 They can be installed using the following command:
 

data/connect-sdk-ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = 'connect-sdk-ruby'
-  spec.version        = '2.30.2'
+  spec.version        = '2.31.0'
   spec.authors        = ['Ingenico ePayments']
   spec.email          = ['github@epay.ingenico.com']
   spec.summary        = %q{SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API}
@@ -23,7 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'webmock', '~> 2.1'
-  spec.add_development_dependency 'sinatra', '~> 1.4'
+  spec.add_development_dependency 'sinatra', '~> 2.1'
+  spec.add_development_dependency 'webrick', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   # spec.metadata['yard.run'] = 'yri'  # compiles yard doc on install
 end

data/lib/ingenico/connect/sdk/client.rb

@@ -5,6 +5,7 @@
 require 'ingenico/connect/sdk/api_resource'
 require 'ingenico/connect/sdk/data_object'
 require 'ingenico/connect/sdk/logging/logging_capable'
+require 'ingenico/connect/sdk/logging/obfuscation/obfuscation_capable'
 require 'ingenico/connect/sdk/merchant/merchant_client'
 require 'base64'
 
@@ -21,6 +22,7 @@ module Ingenico
       # Thread safe.
       class Client < ApiResource
         include Logging::LoggingCapable
+        include Logging::Obfuscation::ObfuscationCapable
 
         # @return [String]
         def self.API_VERSION
@@ -63,6 +65,18 @@ module Ingenico
           @communicator.close_expired_connections
         end
 
+        # Sets the current body obfuscator to use.
+        # @param body_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::BodyObfuscator]
+        def set_body_obfuscator(body_obfuscator)
+          @communicator.set_body_obfuscator(body_obfuscator)
+        end
+
+        # Sets the current header obfuscator to use.
+        # @param header_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::HeaderObfuscator]
+        def set_header_obfuscator(header_obfuscator)
+          @communicator.set_header_obfuscator(header_obfuscator)
+        end
+
         # Turns on logging using the given communicator logger.
         # @param communicator_logger [Ingenico::Connect::SDK::Logging::CommunicatorLogger]
         def enable_logging(communicator_logger)

data/lib/ingenico/connect/sdk/communicator.rb

@@ -11,6 +11,7 @@ module Ingenico::Connect::SDK
   #
   class Communicator
     include Logging::LoggingCapable
+    include Logging::Obfuscation::ObfuscationCapable
 
     # Creates a new Communicator based on a session and marshaller.
     #
@@ -363,6 +364,20 @@ module Ingenico::Connect::SDK
       connection.close_expired_connections if connection.is_a? PooledConnection
     end
 
+    # Sets the current body obfuscator to use.
+    # @param body_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::BodyObfuscator]
+    def set_body_obfuscator(body_obfuscator)
+      connection = @session.connection
+      connection.set_body_obfuscator(body_obfuscator) if connection.is_a? Logging::Obfuscation::ObfuscationCapable
+    end
+
+    # Sets the current header obfuscator to use.
+    # @param header_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::HeaderObfuscator]
+    def set_header_obfuscator(header_obfuscator)
+      connection = @session.connection
+      connection.set_header_obfuscator(header_obfuscator) if connection.is_a? Logging::Obfuscation::ObfuscationCapable
+    end
+
     # Enables logging outgoing requests and incoming responses by registering the _communicator_logger_.
     # Note that only one logger can be registered at a time and calling _enable_logging_
     # a second time will override the old logger instance with the new one.

data/lib/ingenico/connect/sdk/defaultimpl/default_connection.rb

@@ -16,6 +16,7 @@ end
 module Ingenico::Connect::SDK
   module DefaultImpl
     class DefaultConnection < PooledConnection
+      include Ingenico::Connect::SDK::Logging::Obfuscation::ObfuscationCapable
       using RefineHTTPClient
 
       CONTENT_TYPE = 'Content-Type'.freeze
@@ -50,6 +51,9 @@ module Ingenico::Connect::SDK
         @http_client.connect_timeout = @connect_timeout
         @http_client.send_timeout = @socket_timeout
         @http_client.receive_timeout = @socket_timeout
+
+        @body_obfuscator = Ingenico::Connect::SDK::Logging::Obfuscation::BodyObfuscator.default_obfuscator
+        @header_obfuscator = Ingenico::Connect::SDK::Logging::Obfuscation::HeaderObfuscator.default_obfuscator
       end
 
       private
@@ -202,13 +206,29 @@ module Ingenico::Connect::SDK
 
       # logging code
 
+      # Sets the current body obfuscator to use.
+      # @param body_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::BodyObfuscator]
+      def set_body_obfuscator(body_obfuscator)
+        raise ArgumentError, 'body_obfuscator is required' unless body_obfuscator
+
+        @body_obfuscator = body_obfuscator
+      end
+
+      # Sets the current header obfuscator to use.
+      # @param header_obfuscator [Ingenico::Connect::SDK::Logging::Obfuscation::HeaderObfuscator]
+      def set_header_obfuscator(header_obfuscator)
+        raise ArgumentError, 'header_obfuscator is required' unless header_obfuscator
+
+        @header_obfuscator = header_obfuscator
+      end
+
       # Enables logging outgoing requests and incoming responses by registering the _communicator_logger_.
       # Note that only one logger can be registered at a time and calling _enable_logging_
       # a second time will override the old logger instance with the new one.
       #
       # @param communicator_logger [Ingenico::Connect::SDK::Logging::CommunicatorLogger] the communicator logger the requests and responses are logged to
       def enable_logging(communicator_logger)
-        raise ArgumentError, 'communicatorLogger is required' unless communicator_logger
+        raise ArgumentError, 'communicator_logger is required' unless communicator_logger
 
         @communicator_logger = communicator_logger
       end
@@ -238,7 +258,9 @@ module Ingenico::Connect::SDK
         headers = args[:headers]
         body = args[:body]
         content_type = args[:content_type]
-        log_msg_builder = Ingenico::Connect::SDK::Logging::RequestLogMessageBuilder.new(request_id, method, uri)
+        log_msg_builder = Ingenico::Connect::SDK::Logging::RequestLogMessageBuilder.new(request_id, method, uri,
+                                                                                        @body_obfuscator,
+                                                                                        @header_obfuscator)
         headers.each { |k, v| log_msg_builder.add_headers(k, v) } if headers
 
         if binary?(headers)
@@ -264,7 +286,9 @@ module Ingenico::Connect::SDK
         body          = args[:body] unless args[:body].nil?
         content_type  = args[:content_type]
 
-        log_msg_builder = Ingenico::Connect::SDK::Logging::ResponseLogMessageBuilder.new(request_id, status_code, duration)
+        log_msg_builder = Ingenico::Connect::SDK::Logging::ResponseLogMessageBuilder.new(request_id, status_code, duration,
+                                                                                         @body_obfuscator,
+                                                                                         @header_obfuscator)
         unless headers.nil?
           headers = convert_from_sdk_headers(headers)
           headers.each do |key, value|

data/lib/ingenico/connect/sdk/logging/log_message_builder.rb

@@ -13,19 +13,27 @@ module Ingenico::Connect::SDK
       attr_reader :headers
       attr_reader :body
       attr_reader :content_type
+      attr_reader :body_obfuscator
+      attr_reader :header_obfuscator
 
       # Create a new LogMessageBuilder
-      def initialize(request_id)
+      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
 
       # Adds a single header to the #headers string
       def add_headers(name, value)
         @headers += ', ' if @headers.length > 0
         @headers += name + '="'
-        @headers += LoggingUtil.obfuscate_header(name, value) unless value.nil?
+        @headers += @header_obfuscator.obfuscate_header(name, value) unless value.nil?
         @headers += '"'
       end
 
@@ -37,7 +45,7 @@ module Ingenico::Connect::SDK
         if is_binary(content_type)
           @body = "<binary content>"
         else
-          @body = LoggingUtil.obfuscate_body(body)
+          @body = @body_obfuscator.obfuscate_body(body)
         end
         @content_type = content_type
       end
@@ -49,9 +57,9 @@ module Ingenico::Connect::SDK
 
       def to_s
         if self.class == LogMessageBuilder
-          return super.to_s
+          super.to_s
         else
-          return get_message
+          get_message
         end
       end
 
@@ -63,10 +71,10 @@ module Ingenico::Connect::SDK
       # Returns whether or not the content type is binary
       def is_binary(content_type)
         if content_type.nil?
-          return false
+          false
         else
           content_type = content_type.downcase
-          return !(content_type.start_with?("text/") || content_type.include?("json") || content_type.include?("xml"))
+          !(content_type.start_with?("text/") || content_type.include?("json") || content_type.include?("xml"))
         end
       end
     end

data/lib/ingenico/connect/sdk/logging/logging_util.rb

@@ -1,7 +1,12 @@
+require 'ingenico/connect/sdk/logging/obfuscation/body_obfuscator'
+require 'ingenico/connect/sdk/logging/obfuscation/header_obfuscator'
+
 module Ingenico::Connect::SDK
   module Logging
 
     # Class responsible for obfuscating sensitive data in a message body.
+    #
+    # @deprecated This class shouldn't have been exposed
     class ValueObfuscator
 
       class << self
@@ -71,8 +76,10 @@ module Ingenico::Connect::SDK
       def repeat_mask(count)
         @mask_character * count
       end
-    end # end of ValueObfuscator
+    end
 
+    #
+    # @deprecated This class shouldn't have been exposed
     class Obfuscator
       def initialize(obfuscators, case_insensitive)
         raise ArgumentError unless obfuscators.is_a? Hash
@@ -102,7 +109,7 @@ module Ingenico::Connect::SDK
         def _insensitive(key)
           key.respond_to?(:upcase) ? key.upcase : key
         end
-      end # end of HashClod
+      end
 
       def copy(obfuscators, case_insensitive)
         cp = case_insensitive ? HashClod.new(obfuscators) : obfuscators
@@ -117,6 +124,8 @@ module Ingenico::Connect::SDK
       end
 
       # A convenient wrapper to build obfuscators
+      #
+      # @deprecated This class shouldn't have been exposed
       class Builder
         attr_accessor :obfuscators
 
@@ -151,16 +160,26 @@ module Ingenico::Connect::SDK
     end # Obfuscator
 
     # Class that obfuscates headers of a message
+    #
+    # @deprecated This class shouldn't have been exposed
     class HeaderObfuscator < Obfuscator
       def initialize(obfuscators)
         # case insensitive
         super(obfuscators, true)
+        obfuscation_rules = obfuscators.map { |key, value| [key, ->(v) { value.obfuscate_value(v) }]}
+        @obfuscator = Obfuscation::HeaderObfuscator.new(obfuscation_rules)
+      end
+
+      def obfuscate_value(key, value)
+        @obfuscator.obfuscate_header(key, value)
       end
 
       def self.builder
         Builder.new
       end
 
+      #
+      # @deprecated This class shouldn't have been exposed
       class Builder < Obfuscator::Builder
         def initialize
           @obfuscators = {}
@@ -180,55 +199,39 @@ module Ingenico::Connect::SDK
           HeaderObfuscator.new(obfuscators)
         end
       end
-    end # end of HeadObfuscator
+    end
 
     # Class that obfuscates properties in the JSON body of a message
+    #
+    # @deprecated This class shouldn't have been exposed
     class PropertyObfuscator < Obfuscator
       def initialize(obfuscators)
         # case sensitive
         super(obfuscators, false)
-        @property_pattern = build_property_pattern(obfuscators.keys)
+        @obfuscation_rules = obfuscators.map { |key, value| [key, ->(v) { value.obfuscate_value(v) }]}
+        @obfuscator = Obfuscation::BodyObfuscator.new(@obfuscation_rules)
       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
-
       public
 
+      def obfuscate_value(key, value)
+        obfuscation_rule = @obfuscation_rules[property_name]
+        return obfuscation_rule.call(value) if obfuscation_rule
+        value
+      end
+
       def obfuscate(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
+        @obfuscator.obfuscate_body(body)
       end
 
       def self.builder
         Builder.new
       end
 
+      #
+      # @deprecated This class shouldn't have been exposed
       class Builder < Obfuscator::Builder
         def initialize
           @obfuscators = {}
@@ -258,9 +261,11 @@ module Ingenico::Connect::SDK
           PropertyObfuscator.new(obfuscators)
         end
       end
-    end # end of property obfuscator
+    end
 
     module LoggingUtil
+      #
+      # @deprecated This constant shouldn't have been exposed
       @@PROPERTY_OBFUSCATOR = PropertyObfuscator.builder
         .with_keep_end_count("cardNumber", 4)
         .with_keep_end_count("expiryDate", 2)
@@ -279,6 +284,8 @@ module Ingenico::Connect::SDK
         .with_fixed_length("encryptedCustomerInput", 8)
         .build
 
+      #
+      # @deprecated This constant shouldn't have been exposed
       @@HEADER_OBFUSCATOR = HeaderObfuscator.builder
         .with_fixed_length("Authorization", 8)
         .with_fixed_length("WWW-Authenticate", 8)
@@ -288,13 +295,19 @@ module Ingenico::Connect::SDK
         .with_fixed_length("X-GCS-CallerPassword", 8)
         .build
 
+      #
+      # @deprecated This doesn't support custom obfuscation. Use BodyObfuscator instead
+      # @see Obfuscation::BodyObfuscator
       def self.obfuscate_body(body)
-        @@PROPERTY_OBFUSCATOR.obfuscate(body)
+        return Obfuscation::BodyObfuscator.default_obfuscator.obfuscate_body(body)
       end
 
+      #
+      # @deprecated This doesn't support custom obfuscation. Use HeaderObfuscator instead
+      # @see Obfuscation::HeaderObfuscator
       def self.obfuscate_header(name, value)
-        @@HEADER_OBFUSCATOR.obfuscate_value(name, value)
+        return Obfuscation::HeaderObfuscator.default_obfuscator.obfuscate_header(name, value)
       end
-    end # end of LoggingUtil
+    end
   end
 end

data/lib/ingenico/connect/sdk/logging/obfuscation/body_obfuscator.rb

@@ -0,0 +1,98 @@
+require 'ingenico/connect/sdk/logging/obfuscation/obfuscation_rule'
+
+module Ingenico::Connect::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 = {
+            "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

data/lib/ingenico/connect/sdk/logging/obfuscation/header_obfuscator.rb

@@ -0,0 +1,52 @@
+require 'ingenico/connect/sdk/logging/obfuscation/obfuscation_rule'
+
+module Ingenico::Connect::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 = {
+            "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),
+            "x-gcs-authentication-token" => Obfuscation.obfuscate_with_fixed_length(8),
+            "x-gcs-callerpassword" => 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

data/lib/ingenico/connect/sdk/logging/obfuscation/obfuscation_capable.rb

@@ -0,0 +1,18 @@
+module Ingenico::Connect::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

data/lib/ingenico/connect/sdk/logging/obfuscation/obfuscation_rule.rb

@@ -0,0 +1,45 @@
+module Ingenico::Connect::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

data/lib/ingenico/connect/sdk/logging/request_log_message_builder.rb

@@ -4,8 +4,10 @@ module Ingenico::Connect::SDK
     # 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 < Ingenico::Connect::SDK::Logging::LogMessageBuilder
-      def initialize(request_id, method, uri)
-        super(request_id)
+      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
@@ -31,9 +33,9 @@ module Ingenico::Connect::SDK
       def format_uri
         '' unless @uri && @uri.path
         if @uri.query.nil?
-          return @uri.path
+          @uri.path
         else
-          return "#{@uri.path}?#{@uri.query}" unless @uri.query.nil?
+          "#{@uri.path}?#{@uri.query}" unless @uri.query.nil?
         end
         # @uri.path + '?' + empty_if_null(@uri.query)
       end