connect-sdk-ruby 2.45.0 → 2.47.0

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

@@ -1,80 +1,86 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/defaultimpl/authorization_type'
+require 'ingenico/connect/sdk/endpoint_configuration'
 
-  # A CommunicatorConfiguration stores all data used to initialize an {Ingenico::Connect::SDK::Communicator}.
-  #
-  # @attr [String] api_endpoint       Base URL to the Ingenico ePayments platform
-  # @attr [String] api_key_id         Identifier of the _secret_api_key_ used in authentication.
-  # @attr [String] secret_api_key     Secret key used in authentication
-  # @attr [String] authorization_type String representing the authentication algorithm used
-  class CommunicatorConfiguration < EndpointConfiguration
+module Ingenico
+  module Connect
+    module SDK
+      # A CommunicatorConfiguration stores all data used to initialize an {Ingenico::Connect::SDK::Communicator}.
+      #
+      # @attr [String] api_endpoint       Base URL to the Ingenico ePayments platform
+      # @attr [String] api_key_id         Identifier of the _secret_api_key_ used in authentication.
+      # @attr [String] secret_api_key     Secret key used in authentication
+      # @attr [String] authorization_type String representing the authentication algorithm used
+      class CommunicatorConfiguration < EndpointConfiguration
 
-    # Creates a new CommunicatorConfiguration instance.
-    #
-    # If a _properties_ object is given, it will be parsed like a hash in order to read these attributes.
-    # If a value is given in both the _properties_ hash and as a separate parameter,
-    # the separate parameter will take precedence over the value in the properties.
-    #
-    # @param properties              [Hash] hash that may contain any of the other parameters.
-    # @param api_endpoint            [String] the base URL to the Ingenico ePayments platform.
-    # @param api_key_id              [String] the identifier of the _secret_api_key_ used to authenticate requests.
-    # @param secret_api_key          [String] the key used to authenticate requests sent to the Ingenico ePayments platform.
-    # @param authorization_type      [String] string describing the authorization protocol to follow.
-    # @param connect_timeout         [Integer] the number of seconds before a connection attempt with the Ingenico ePayments platform times out.
-    # @param socket_timeout          [Integer] the number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.
-    # @param max_connections         [Integer] the number of connections with the Ingenico ePayments platform that are kept alive in the connection pool.
-    #                                These connections will be reused when possible.
-    # @param proxy_configuration     [Ingenico::Connect::SDK::ProxyConfiguration] stores the URL to a proxy to be used in all communication,
-    #                                or nil if no proxy should be used.
-    # @param integrator              [String] name of the integrator
-    # @param shopping_cart_extension [Ingenico::Connect::SDK::Domain::Metadata::ShoppingCartExtension] stores shopping cart-related metadata.
-    # @see EndpointConfiguration#initialize
-    def initialize(properties: nil, api_endpoint: nil, api_key_id: nil,
-                   secret_api_key: nil, authorization_type: nil,
-                   connect_timeout: nil, socket_timeout: nil,
-                   max_connections: nil, proxy_configuration: nil,
-                   integrator: nil, shopping_cart_extension: nil)
-      if properties
-        super(properties, 'connect.api')
-        unless properties.nil?
-          @authorization_type = DefaultImpl::AuthorizationType.get_authorization(
-              properties['connect.api.authorizationType'])
+        # Creates a new CommunicatorConfiguration instance.
+        #
+        # If a _properties_ object is given, it will be parsed like a hash in order to read these attributes.
+        # If a value is given in both the _properties_ hash and as a separate parameter,
+        # the separate parameter will take precedence over the value in the properties.
+        #
+        # @param properties              [Hash] hash that may contain any of the other parameters.
+        # @param api_endpoint            [String] the base URL to the Ingenico ePayments platform.
+        # @param api_key_id              [String] the identifier of the _secret_api_key_ used to authenticate requests.
+        # @param secret_api_key          [String] the key used to authenticate requests sent to the Ingenico ePayments platform.
+        # @param authorization_type      [String] string describing the authorization protocol to follow.
+        # @param connect_timeout         [Integer] the number of seconds before a connection attempt with the Ingenico ePayments platform times out.
+        # @param socket_timeout          [Integer] the number of seconds before a timeout occurs when transmitting data to or from the Ingenico ePayments platform.
+        # @param max_connections         [Integer] the number of connections with the Ingenico ePayments platform that are kept alive in the connection pool.
+        #                                These connections will be reused when possible.
+        # @param proxy_configuration     [Ingenico::Connect::SDK::ProxyConfiguration] stores the URL to a proxy to be used in all communication,
+        #                                or nil if no proxy should be used.
+        # @param integrator              [String] name of the integrator
+        # @param shopping_cart_extension [Ingenico::Connect::SDK::Domain::Metadata::ShoppingCartExtension] stores shopping cart-related metadata.
+        # @see EndpointConfiguration#initialize
+        def initialize(properties: nil, api_endpoint: nil, api_key_id: nil,
+                       secret_api_key: nil, authorization_type: nil,
+                       connect_timeout: nil, socket_timeout: nil,
+                       max_connections: nil, proxy_configuration: nil,
+                       integrator: nil, shopping_cart_extension: nil)
+          if properties
+            super(properties, 'connect.api')
+            unless properties.nil?
+              @authorization_type = DefaultImpl::AuthorizationType.get_authorization(
+                properties['connect.api.authorizationType'])
+            end
+          end
+          if api_endpoint
+            @api_endpoint = api_endpoint
+          end
+          if api_key_id
+            @api_key_id = api_key_id
+          end
+          if secret_api_key
+            @secret_api_key = secret_api_key
+          end
+          if authorization_type
+            @authorization_type = authorization_type
+          end
+          if connect_timeout
+            @connect_timeout = connect_timeout
+          end
+          if socket_timeout
+            @socket_timeout = socket_timeout
+          end
+          if max_connections
+            @max_connections = max_connections
+          end
+          if proxy_configuration
+            @proxy_configuration = proxy_configuration
+          end
+          if integrator
+            @integrator = integrator
+          end
+          if shopping_cart_extension
+            @shopping_cart_extension = shopping_cart_extension
+          end
         end
-      end
-      if api_endpoint
-        @api_endpoint = api_endpoint
-      end
-      if api_key_id
-        @api_key_id = api_key_id
-      end
-      if secret_api_key
-        @secret_api_key = secret_api_key
-      end
-      if authorization_type
-        @authorization_type = authorization_type
-      end
-      if connect_timeout
-        @connect_timeout = connect_timeout
-      end
-      if socket_timeout
-        @socket_timeout = socket_timeout
-      end
-      if max_connections
-        @max_connections = max_connections
-      end
-      if proxy_configuration
-        @proxy_configuration = proxy_configuration
-      end
-      if integrator
-        @integrator = integrator
-      end
-      if shopping_cart_extension
-        @shopping_cart_extension = shopping_cart_extension
+
+        attr_accessor :api_endpoint
+        attr_accessor :api_key_id
+        attr_accessor :secret_api_key
+        attr_accessor :authorization_type
       end
     end
-
-    attr_accessor :api_endpoint
-    attr_accessor :api_key_id
-    attr_accessor :secret_api_key
-    attr_accessor :authorization_type
   end
 end

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

@@ -1,41 +1,46 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/logging/logging_capable'
 
-  # Class used to communicate using the HTTP (or HTTPS) protocol.
-  # Performs GET, DELETE, POST and PUT requests given a target uri and request headers.
-  # @see Ingenico::Connect::SDK::DefaultImpl::DefaultConnection
-  class Connection
-    include Ingenico::Connect::SDK::Logging::LoggingCapable
+module Ingenico
+  module Connect
+    module SDK
+      # Class used to communicate using the HTTP (or HTTPS) protocol.
+      # Performs GET, DELETE, POST and PUT requests given a target uri and request headers.
+      # @see Ingenico::Connect::SDK::DefaultImpl::DefaultConnection
+      class Connection
+        include Ingenico::Connect::SDK::Logging::LoggingCapable
 
-    # Performs a GET request to _uri_ using _request_headers_,
-    # and yields the response as the status code, headers and body.
-    #
-    # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
-    def get(uri, request_headers)
-      raise NotImplementedError
-    end
+        # Performs a GET request to _uri_ using _request_headers_,
+        # and yields the response as the status code, headers and body.
+        #
+        # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
+        def get(uri, request_headers)
+          raise NotImplementedError
+        end
 
-    # Performs a DELETE request to _uri_ using _request_headers_,
-    # and yields the response as the status code, headers and body.
-    #
-    # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
-    def delete(uri, request_headers)
-      raise NotImplementedError
-    end
+        # Performs a DELETE request to _uri_ using _request_headers_,
+        # and yields the response as the status code, headers and body.
+        #
+        # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
+        def delete(uri, request_headers)
+          raise NotImplementedError
+        end
 
-    # Performs a POST request to _uri_ using _request_headers_ and _body_,
-    # and yields the response as the status code, headers and body.
-    #
-    # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
-    def post(uri, request_headers, body)
-      raise NotImplementedError
-    end
+        # Performs a POST request to _uri_ using _request_headers_ and _body_,
+        # and yields the response as the status code, headers and body.
+        #
+        # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
+        def post(uri, request_headers, body)
+          raise NotImplementedError
+        end
 
-    # Performs a PUT request to _uri_ using _request_headers_ and _body_,
-    # and yields the response as the status code, headers and body.
-    #
-    # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
-    def put(uri, request_headers, body)
-      raise NotImplementedError
+        # Performs a PUT request to _uri_ using _request_headers_ and _body_,
+        # and yields the response as the status code, headers and body.
+        #
+        # @yield (Integer, Array<Ingenico::Connect::SDK::ResponseHeader>, IO) The status code, headers and body of the response.
+        def put(uri, request_headers, body)
+          raise NotImplementedError
+        end
+      end
     end
   end
 end

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

@@ -1,32 +1,34 @@
 require 'json'
 
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Base class for all SDK data objects, supports marshalling and unmarshalling the data object to and from JSON.
+      class DataObject
 
-  # Base class for all SDK data objects, supports marshalling and unmarshalling the data object to and from JSON.
-  class DataObject
+        # Returns a hash representation of the DataObject.
+        # The hash contains camelCase representations of the variables, and their values.
+        # Should be overridden to add all instance variables of the object.
+        #
+        # @return [Hash]
+        def to_h
+          {}
+        end
 
-    # Returns a hash representation of the DataObject.
-    # The hash contains camelCase representations of the variables, and their values.
-    # Should be overridden to add all instance variables of the object.
-    #
-    # @return [Hash]
-    def to_h
-      {}
-    end
-
-    # Create a new instance of this object (DataObject or descendant)
-    # from a hash containing attribute values in camelCase.
-    # Note that the hash contains Strings as keys instead of more commonly used tokens.
-    def self.new_from_hash(hash)
-      obj = self.new
-      obj.from_hash(hash)
-      obj
-    end
+        # Create a new instance of this object (DataObject or descendant)
+        # from a hash containing attribute values in camelCase.
+        # Note that the hash contains Strings as keys instead of more commonly used tokens.
+        def self.new_from_hash(hash)
+          obj = self.new
+          obj.from_hash(hash)
+          obj
+        end
 
-    # Set attributes from values in parameter hash.
-    # Should be overridden by descendants in order to properly restore their attributes from the hash.
-    # Note that the hash contains Strings as keys instead of more commonly used tokens.
-    def from_hash(hash)
+        # Set attributes from values in parameter hash.
+        # Should be overridden by descendants in order to properly restore their attributes from the hash.
+        # Note that the hash contains Strings as keys instead of more commonly used tokens.
+        def from_hash(hash) end
+      end
     end
   end
 end

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

@@ -1,43 +1,46 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/declined_transaction_exception'
 
-  # Indicates that a payment is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
-  class DeclinedPaymentException < DeclinedTransactionException
+module Ingenico
+  module Connect
+    module SDK
+      # Indicates that a payment is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
+      class DeclinedPaymentException < DeclinedTransactionException
 
-    # Create a new DeclinedPaymentException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      if errors.nil?
-        super(status_code, response_body, nil, nil, build_message(errors))
-      else
-        super(status_code, response_body, errors.error_id, errors.errors,
-              build_message(errors))
-      end
-      @errors = errors
-    end
+        # Create a new DeclinedPaymentException.
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, errors)
+          if errors.nil?
+            super(status_code, response_body, nil, nil, build_message(errors))
+          else
+            super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
+          end
+          @errors = errors
+        end
 
-    # The declined payment result returned by the Ingenico ePayments platform.
-    # @return [Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResult]
-    def payment_result
-      if @errors.nil?
-        nil
-      else
-        @errors.payment_result
-      end
-    end
+        # The declined payment result returned by the Ingenico ePayments platform.
+        # @return [Ingenico::Connect::SDK::Domain::Payment::CreatePaymentResult]
+        def payment_result
+          if @errors.nil?
+            nil
+          else
+            @errors.payment_result
+          end
+        end
 
-    private
+        private
 
-    def build_message(errors)
-      if !errors.nil? && !errors.payment_result.nil?
-        payment = errors.payment_result.payment
-      else
-        payment = nil
-      end
-      if payment.nil?
-        'the Ingenico ePayments platform returned a declined payment response'
-      else
-        "declined payment '" + payment.id + "' with status '" +
-            payment.status + "'"
+        def build_message(errors)
+          if !errors.nil? && !errors.payment_result.nil?
+            payment = errors.payment_result.payment
+          else
+            payment = nil
+          end
+          if payment.nil?
+            'the Ingenico ePayments platform returned a declined payment response'
+          else
+            "declined payment '" + payment.id + "' with status '" + payment.status + "'"
+          end
+        end
       end
     end
   end

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

@@ -1,43 +1,46 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/declined_transaction_exception'
 
-  # Indicates that a payout is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
-  class DeclinedPayoutException < DeclinedTransactionException
+module Ingenico
+  module Connect
+    module SDK
+      # Indicates that a payout is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
+      class DeclinedPayoutException < DeclinedTransactionException
 
-    # Create a new DeclinedPayoutException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      if errors.nil?
-        super(status_code, response_body, nil, nil, build_message(errors))
-      else
-        super(status_code, response_body, errors.error_id, errors.errors,
-              build_message(errors))
-      end
-      @errors = errors
-    end
+        # Create a new DeclinedPayoutException.
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, errors)
+          if errors.nil?
+            super(status_code, response_body, nil, nil, build_message(errors))
+          else
+            super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
+          end
+          @errors = errors
+        end
 
-    # The declined payout result as returned by the Ingenico ePayments platform.
-    # @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResult]
-    def payout_result
-      if @errors.nil?
-        nil
-      else
-        @errors.payout_result
-      end
-    end
+        # The declined payout result as returned by the Ingenico ePayments platform.
+        # @return [Ingenico::Connect::SDK::Domain::Payout::PayoutResult]
+        def payout_result
+          if @errors.nil?
+            nil
+          else
+            @errors.payout_result
+          end
+        end
 
-    private
+        private
 
-    def build_message(errors)
-      if !errors.nil?
-        payout = errors.payout_result
-      else
-        payout = nil
-      end
-      if payout.nil?
-        'the Ingenico ePayments platform returned a declined payout response'
-      else
-        "declined payment '" + payout.id + "' with status '" +
-            payout.status + "'"
+        def build_message(errors)
+          if !errors.nil?
+            payout = errors.payout_result
+          else
+            payout = nil
+          end
+          if payout.nil?
+            'the Ingenico ePayments platform returned a declined payout response'
+          else
+            "declined payout '" + payout.id + "' with status '" + payout.status + "'"
+          end
+        end
       end
     end
   end

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

@@ -1,45 +1,46 @@
 require 'ingenico/connect/sdk/declined_transaction_exception'
 
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Indicates that a refund is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
+      class DeclinedRefundException < DeclinedTransactionException
 
-  # Indicates that a refund is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
-  class DeclinedRefundException < DeclinedTransactionException
+        # Create a new DeclinedRefundException
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, errors)
+          if errors.nil?
+            super(status_code, response_body, nil, nil, build_message(errors))
+          else
+            super(status_code, response_body, errors.error_id, errors.errors, build_message(errors))
+          end
+          @errors = errors
+        end
 
-    # Create a new DeclinedRefundException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, errors)
-      if errors.nil?
-        super(status_code, response_body, nil, nil, build_message(errors))
-      else
-        super(status_code, response_body, errors.error_id, errors.errors,
-              build_message(errors))
-      end
-      @errors = errors
-    end
-
-    # The declined refund result as returned by the Ingenico ePayments platform.
-    # @return [Ingenico::Connect::SDK::Domain::Refund::RefundResult]
-    def refund_result
-      if @errors.nil?
-        nil
-      else
-        @errors.refund_result
-      end
-    end
+        # The declined refund result as returned by the Ingenico ePayments platform.
+        # @return [Ingenico::Connect::SDK::Domain::Refund::RefundResult]
+        def refund_result
+          if @errors.nil?
+            nil
+          else
+            @errors.refund_result
+          end
+        end
 
-    private
+        private
 
-    def build_message(errors)
-      if !errors.nil?
-        refund = errors.refund_result
-      else
-        refund = nil
-      end
-      if refund.nil?
-        'the Ingenico ePayments platform returned a declined refund response'
-      else
-        "declined refund '" + refund.id + "' with status '" +
-            refund.status + "'"
+        def build_message(errors)
+          if !errors.nil?
+            refund = errors.refund_result
+          else
+            refund = nil
+          end
+          if refund.nil?
+            'the Ingenico ePayments platform returned a declined refund response'
+          else
+            "declined refund '" + refund.id + "' with status '" + refund.status + "'"
+          end
+        end
       end
     end
   end

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

@@ -1,15 +1,20 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/api_exception'
 
-  # Indicates that a transaction is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
-  class DeclinedTransactionException < ApiException
+module Ingenico
+  module Connect
+    module SDK
+      # Indicates that a transaction is declined by the Ingenico ePayments platform or one of its downstream partners/acquirers.
+      class DeclinedTransactionException < ApiException
 
-    # Create a new DeclinedTransactionException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors, message=false)
-      if message == false
-        super(status_code, response_body, error_id, errors)
-      else
-        super(status_code, response_body, error_id, errors, message)
+        # Create a new DeclinedTransactionException.
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, error_id, errors, message = false)
+          if message == false
+            super(status_code, response_body, error_id, errors)
+          else
+            super(status_code, response_body, error_id, errors, message)
+          end
+        end
       end
     end
   end

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

@@ -1,18 +1,21 @@
-module Ingenico::Connect::SDK
-  module DefaultImpl
+module Ingenico
+  module Connect
+    module SDK
+      module DefaultImpl
+        # Contains all authentication schemes supported by the GlobalCollect platform.
+        class AuthorizationType
+          V1HMAC = 'v1HMAC'
 
-    # Contains all authentication schemes supported by the GlobabCollect platform.
-    class AuthorizationType
-      V1HMAC = 'v1HMAC'
+          # @return [String] the authorization string that belongs to the parameter _authorization_, or _nil_ if not found.
+          def self.get_authorization(authorization)
+            authorization if authorization == 'v1HMAC'
+          end
 
-      # @return [String] the authorization string that belongs to the parameter _authorization_, or _nil_ if not found.
-      def self.get_authorization(authorization)
-        authorization if authorization == 'v1HMAC'
-      end
-
-      # @return [String]
-      def self.get_signature_string
-        V1HMAC
+          # @return [String]
+          def self.get_signature_string
+            V1HMAC
+          end
+        end
       end
     end
   end