connect-sdk-ruby 2.45.0 → 2.46.0

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

@@ -1,96 +1,100 @@
 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
+module Ingenico
+  module Connect
+    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 = {
-            "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
+            # 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
+              @property_pattern = build_property_pattern(@obfuscation_rules.keys)
+            end
 
-        private
+            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 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
+            def obfuscate_value(property_name, value)
+              obfuscation_rule = @obfuscation_rules[property_name]
+              return obfuscation_rule.call(value) if obfuscation_rule
+              value
+            end
 
-        public
+            public
 
-        # Obfuscates the given body as necessary.
-        #
-        # @return (String)
-        def obfuscate_body(body)
-          return nil if body.nil?
-          return '' if body.empty?
+            # 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
+              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
+            private
 
-        @@default_obfuscator = BodyObfuscator.new
+            @@default_obfuscator = BodyObfuscator.new
 
-        public
+            public
 
-        # @return [BodyObfuscator]
-        def self.default_obfuscator
-          @@default_obfuscator
+            # @return [BodyObfuscator]
+            def self.default_obfuscator
+              @@default_obfuscator
+            end
+          end
         end
       end
     end

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

@@ -1,50 +1,54 @@
 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
+module Ingenico
+  module Connect
+    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 = {
-            "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
+            # 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
-          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
+            # 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
+            private
 
-        @@default_obfuscator = HeaderObfuscator.new
+            @@default_obfuscator = HeaderObfuscator.new
 
-        public
+            public
 
-        # @return [HeaderObfuscator]
-        def self.default_obfuscator
-          @@default_obfuscator
+            # @return [HeaderObfuscator]
+            def self.default_obfuscator
+              @@default_obfuscator
+            end
+          end
         end
       end
     end

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

@@ -1,16 +1,21 @@
-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
+module Ingenico
+  module Connect
+    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
+            # 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

@@ -1,43 +1,47 @@
-module Ingenico::Connect::SDK
-  module Logging
-    module Obfuscation
+module Ingenico
+  module Connect
+    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 (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 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 (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
+          # 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/obfuscation.rb

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

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

@@ -1,43 +1,51 @@
-module Ingenico::Connect::SDK
-  module Logging
+require 'ingenico/connect/sdk/logging/obfuscation/body_obfuscator'
+require 'ingenico/connect/sdk/logging/obfuscation/header_obfuscator'
+require 'ingenico/connect/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 < Ingenico::Connect::SDK::Logging::LogMessageBuilder
-      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
+module Ingenico
+  module Connect
+    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 < Ingenico::Connect::SDK::Logging::LogMessageBuilder
 
-      # 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'"
+          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
 
-        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
+          # 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'"
+
+            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
 
-      private
+          private
 
-      def format_uri
-        '' unless @uri && @uri.path
-        if @uri.query.nil?
-          @uri.path
-        else
-          "#{@uri.path}?#{@uri.query}" unless @uri.query.nil?
+          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
-        # @uri.path + '?' + empty_if_null(@uri.query)
       end
     end
   end

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

@@ -1,36 +1,42 @@
-module Ingenico::Connect::SDK
-  module Logging
+require 'ingenico/connect/sdk/logging/obfuscation/body_obfuscator'
+require 'ingenico/connect/sdk/logging/obfuscation/header_obfuscator'
+require 'ingenico/connect/sdk/logging/log_message_builder'
 
-    class ResponseLogMessageBuilder < LogMessageBuilder
+module Ingenico
+  module Connect
+    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.
+        class ResponseLogMessageBuilder < LogMessageBuilder
 
-      # 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,
-                     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
+          # @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 < 0) ? "" : ", %.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'"
 
-        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))
+            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))
+          end
+        end
       end
     end
   end