connect-sdk-ruby 2.44.0 → 2.46.0

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

@@ -1,57 +1,61 @@
 require 'English'
+require 'ingenico/connect/sdk/logging/communicator_logger'
 
-module Ingenico::Connect::SDK
-  module Logging
+module Ingenico
+  module Connect
+    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] 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
 
-      # 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
+            @error_level = error_level
+          end
 
-        @logger = logger
-        @logLevel = log_level
-        @errorLevel = error_level
-      end
+          # Logs a single error or non-error message to the logger.
+          def log(msg, thrown = false)
+            # 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
 
-      # Logs a single error or non-error message to the logger.
-      def log(msg, thrown=false)
-        # use Ruby Logger
-        if thrown 
-          @logger.log(@errorLevel) { msg + $RS + thrown.to_s + $RS + thrown.backtrace.join($RS) }
-        else 
-          @logger.log(@logLevel, msg)
-        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)
-        begin
-          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/ingenico/connect/sdk/logging/stdout_communicator_logger.rb

@@ -1,33 +1,37 @@
 require 'English'
 require 'singleton'
+require 'ingenico/connect/sdk/logging/communicator_logger'
 
-module Ingenico::Connect::SDK
-  module Logging
+module Ingenico
+  module Connect
+    module SDK
+      module Logging
+        # Logging class that logs the messages to $stdout.
+        class StdoutCommunicatorLogger < CommunicatorLogger
+          include Singleton
 
-    # {Ingenico::Connect::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
+          # 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=false)
-        $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 = false)
+            $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
   end

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

@@ -1,14 +1 @@
-prefix = 'ingenico/connect/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'
-require prefix + 'obfuscation/obfuscation_rule'
-require prefix + 'obfuscation/body_obfuscator'
-require prefix + 'obfuscation/header_obfuscator'
-require prefix + 'obfuscation/obfuscation_capable'
+Dir[File.join(__dir__, 'logging', '*.rb')].each { |f| require f }

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

@@ -1,24 +1,27 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Class responsible for marshalling and unmarshalling objects to and from JSON
+      class Marshaller
 
-  # 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 [Ingenico::Connect::SDK::DataObject] the object to format
+        # @return [String] _request_object_ converted to JSON
+        def marshal(request_object)
+          raise NotImplementedError
+        end
 
-    # Marshals _request_object_ to JSON format by calling #to_h on it.
-    #
-    # @param request_object [Ingenico::Connect::SDK::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
+        # 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/ingenico/connect/sdk/marshaller_syntax_exception.rb

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

data/lib/ingenico/connect/sdk/merchant/captures/captures_client.rb

@@ -1,6 +1,6 @@
 #
 # This class was auto-generated from the API references found at
-# https://epayments-api.developer-ingenico.com/s2sapi/v1/
+# https://epayments-api.developer-ingenico.com/
 #
 require 'ingenico/connect/sdk/api_resource'
 require 'ingenico/connect/sdk/response_exception'
@@ -9,80 +9,83 @@ require 'ingenico/connect/sdk/domain/errors/error_response'
 require 'ingenico/connect/sdk/domain/refund/refund_error_response'
 require 'ingenico/connect/sdk/domain/refund/refund_response'
 
-module Ingenico::Connect::SDK
-  module Merchant
-    module Captures
+module Ingenico
+  module Connect
+    module SDK
+      module Merchant
+        module Captures
+          # Captures client. Thread-safe.
+          class CapturesClient < Ingenico::Connect::SDK::ApiResource
 
-      # Captures client. Thread-safe.
-      class CapturesClient < Ingenico::Connect::SDK::ApiResource
+            # @param parent       [Ingenico::Connect::SDK::ApiResource]
+            # @param path_context [Hash]
+            def initialize(parent, path_context)
+              super(parent, path_context)
+            end
 
-        # @param parent        [Ingenico::Connect::SDK::ApiResource]
-        # @param path_context  [Hash]
-        def initialize(parent, path_context)
-          super(parent, path_context)
-        end
-
-        # Resource /!{merchantId}/captures/!{captureId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/captures/get.html Get capture}
-        # @param capture_id [String]
-        # @param context    [Ingenico::Connect::SDK::CallContext]
-        # @return [Ingenico::Connect::SDK::Domain::Capture::CaptureResponse]
-        # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
-        # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
-        # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
-        # @raise [Ingenico::Connect::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 [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
-        #        the Ingenico ePayments 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 [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
-        def get(capture_id, context=nil)
-          path_context = {
-            'captureId'.freeze => capture_id,
-          }
-          uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}', path_context)
-          return @communicator.get(
-            uri,
-            client_headers,
-            nil,
-            Ingenico::Connect::SDK::Domain::Capture::CaptureResponse,
-            context)
-        rescue ResponseException => e
-          error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
-        end
+            # Resource /!{merchantId}/captures/!{captureId} - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/captures/get.html Get capture}
+            # @param capture_id [String]
+            # @param context    [Ingenico::Connect::SDK::CallContext]
+            # @return [Ingenico::Connect::SDK::Domain::Capture::CaptureResponse]
+            # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+            # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+            # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+            # @raise [Ingenico::Connect::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 [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+            #        the Ingenico ePayments 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 [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+            def get(capture_id, context = nil)
+              path_context = {
+                'captureId'.freeze => capture_id,
+              }
+              uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}', path_context)
+              @communicator.get(
+                uri,
+                client_headers,
+                nil,
+                Ingenico::Connect::SDK::Domain::Capture::CaptureResponse,
+                context)
+            rescue ResponseException => e
+              error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
+              error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+              raise create_exception(e.status_code, e.body, error_object, context)
+            end
 
-        # Resource /!{merchantId}/captures/!{captureId}/refund - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/captures/refund.html Create Refund}
-        # @param capture_id [String]
-        # @param body       [Ingenico::Connect::SDK::Domain::Refund::RefundRequest]
-        # @param context    [Ingenico::Connect::SDK::CallContext]
-        # @return [Ingenico::Connect::SDK::Domain::Refund::RefundResponse]
-        # @raise [Ingenico::Connect::SDK::DeclinedRefundException] if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.
-        # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
-        # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
-        # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
-        # @raise [Ingenico::Connect::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 [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
-        #        the Ingenico ePayments 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 [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
-        def refund(capture_id, body, context=nil)
-          path_context = {
-            'captureId'.freeze => capture_id,
-          }
-          uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}/refund', path_context)
-          return @communicator.post(
-            uri,
-            client_headers,
-            nil,
-            body,
-            Ingenico::Connect::SDK::Domain::Refund::RefundResponse,
-            context)
-        rescue ResponseException => e
-          error_type = Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse
-          error_object = @communicator.marshaller.unmarshal(e.body, error_type)
-          raise create_exception(e.status_code, e.body, error_object, context)
+            # Resource /!{merchantId}/captures/!{captureId}/refund - {https://epayments-api.developer-ingenico.com/s2sapi/v1/en_US/ruby/captures/refund.html Create Refund}
+            # @param capture_id [String]
+            # @param body       [Ingenico::Connect::SDK::Domain::Refund::RefundRequest]
+            # @param context    [Ingenico::Connect::SDK::CallContext]
+            # @return [Ingenico::Connect::SDK::Domain::Refund::RefundResponse]
+            # @raise [Ingenico::Connect::SDK::DeclinedRefundException] if the Ingenico ePayments platform declined / rejected the refund. The refund result will be available from the exception.
+            # @raise [Ingenico::Connect::SDK::ValidationException] if the request was not correct and couldn't be processed (HTTP status code 400)
+            # @raise [Ingenico::Connect::SDK::AuthorizationException] if the request was not allowed (HTTP status code 403)
+            # @raise [Ingenico::Connect::SDK::IdempotenceException] if an idempotent request caused a conflict (HTTP status code 409)
+            # @raise [Ingenico::Connect::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 [Ingenico::Connect::SDK::GlobalCollectException] if something went wrong at the Ingenico ePayments platform,
+            #        the Ingenico ePayments 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 [Ingenico::Connect::SDK::ApiException]if the Ingenico ePayments platform returned any other error
+            def refund(capture_id, body, context = nil)
+              path_context = {
+                'captureId'.freeze => capture_id,
+              }
+              uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}/refund', path_context)
+              @communicator.post(
+                uri,
+                client_headers,
+                nil,
+                body,
+                Ingenico::Connect::SDK::Domain::Refund::RefundResponse,
+                context)
+            rescue ResponseException => e
+              error_type = Ingenico::Connect::SDK::Domain::Refund::RefundErrorResponse
+              error_object = @communicator.marshaller.unmarshal(e.body, error_type)
+              raise create_exception(e.status_code, e.body, error_object, context)
+            end
+          end
         end
       end
     end

data/lib/ingenico/connect/sdk/merchant/captures.rb

@@ -0,0 +1,5 @@
+#
+# This file was auto-generated from the API references found at
+# https://epayments-api.developer-ingenico.com/
+#
+Dir[File.join(__dir__, 'captures', '*.rb')].each { |f| require f }