connect-sdk-ruby 2.45.0 → 2.46.0

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

@@ -1,14 +1,19 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/api_exception'
 
-  # This error is raised when the request refers to a resource or object that is not found by the Ingenico ePayments platform.
-  # The object referred to may not exist or it could have been removed recently.
-  class ReferenceException < ApiException
+module Ingenico
+  module Connect
+    module SDK
+      # This error is raised when the request refers to a resource or object that is not found by the Ingenico ePayments platform.
+      # The object referred to may not exist or it could have been removed recently.
+      class ReferenceException < ApiException
 
-    # Create a new ReferenceException.
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors,
-                   message='the Ingenico ePayments platform returned a reference error response')
-      super(status_code, response_body, error_id, errors, message)
+        # Create a new ReferenceException.
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, error_id, errors,
+                       message = 'the Ingenico ePayments platform returned a reference error response')
+          super(status_code, response_body, error_id, errors, message)
+        end
+      end
     end
   end
 end

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

@@ -1,56 +1,64 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Represents HTTP request headers
+      # Each header is immutable has a #name and #value attribute
+      #
+      # @attr_reader [String] name  HTTP header name
+      # @attr_reader [String] value HTTP header value
+      class RequestHeader
 
-  # Represents HTTP request headers
-  # Each header is immutable has a #name and #value attribute
-  #
-  # @attr_reader [String] name  HTTP header name
-  # @attr_reader [String] value HTTP header value
-  class RequestHeader
-
-    # Create a new header using the name and value given as parameters.
-    def initialize(name, value)
-      if name.nil? || name.strip.empty?
-        raise ArgumentError.new('name is required')
-      end
-      @name = name
-      @value = normalize_value(value)
-    end
+        # Create a new header using the name and value given as parameters.
+        def initialize(name, value)
+          if name.nil? || name.strip.empty?
+            raise ArgumentError.new('name is required')
+          end
+          @name = name
+          @value = normalize_value(value)
+        end
 
-    attr_reader :name
-    attr_reader :value
+        attr_reader :name
+        attr_reader :value
 
-    def to_s
-      "#{name}:#{value}"
-    end
+        def to_s
+          "#{name}:#{value}"
+        end
 
-    # Return the {Ingenico::Connect::SDK::ResponseHeader} that goes by the given _header_name_,
-    # If this Response does not contain a header with the given name, return _nil_ instead
-    def self.get_header(headers, header_name)
-        selected_headers = headers.select { |h| h.name == header_name }
-        if selected_headers.nil? || selected_headers.length == 0
-          return nil
-        else
-          return selected_headers[0]
+        # Return the {Ingenico::Connect::SDK::ResponseHeader} that goes by the given _header_name_,
+        # If this Response does not contain a header with the given name, return _nil_ instead
+        def self.get_header(headers, header_name)
+          selected_headers = headers.select { |h| h.name == header_name }
+          if selected_headers.nil? || selected_headers.length == 0
+            return nil
+          else
+            return selected_headers[0]
+          end
         end
-    end
 
-    # Returns the header value of the header that goes by the given _header_name_,
-    # If this response does not contain a header with the given name, return _nil_ instead
-    def self.get_header_value(headers, header_name)
-        header = get_header(headers, header_name)
-        return (if header.nil? then nil else header.value end)
-    end
+        # Returns the header value of the header that goes by the given _header_name_,
+        # If this response does not contain a header with the given name, return _nil_ instead
+        def self.get_header_value(headers, header_name)
+          header = get_header(headers, header_name)
+          return (
+            if header.nil?
+              nil
+            else
+              header.value
+            end)
+        end
 
-    private
+        private
 
-    def normalize_value(value)
-      if value.nil? || value.empty?
-        return value
+        def normalize_value(value)
+          if value.nil? || value.empty?
+            return value
+          end
+          # Replace all sequences of linebreak-whitespace* with a single linebreak-space
+          # This matches the normalization done by DefaultAuthenticator, and ensures that multiline headers
+          # will not cause authentication failures
+          value.gsub(/\r?\n[\s&&[^\r\n]]*/, ' ')
+        end
       end
-      # Replace all sequences of linebreak-whitespace* with a single linebreak-space
-      # This matches the normalization done by DefaultAuthenticator, and ensures that multiline headers
-      # will not cause authentication failures
-      value.gsub(/\r?\n[\s&&[^\r\n]]*/, ' ')
     end
   end
 end

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

@@ -1,25 +1,28 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Represents a URL request parameter.
+      # Each parameter is immutable and has a #name and #value attribute.
+      #
+      # @attr_reader [String] name  Parameter name
+      # @attr_reader [String] value Parameter value
+      class RequestParam
 
-  # Represents a URL request parameter.
-  # Each parameter is immutable and has a #name and #value attribute.
-  #
-  # @attr_reader [String] name  Parameter name
-  # @attr_reader [String] value Parameter value
-  class RequestParam
+        def initialize(name, value)
+          if name.nil? || name.strip.empty?
+            raise ArgumentError.new('name is required')
+          end
+          @name = name
+          @value = value
+        end
 
-    def initialize(name, value)
-      if name.nil? || name.strip.empty?
-        raise ArgumentError.new('name is required')
-      end
-      @name = name
-      @value = value
-    end
+        attr_reader :name
+        attr_reader :value
 
-    attr_reader :name
-    attr_reader :value
-
-    def to_s
-      "#{name}=#{value}"
+        def to_s
+          "#{name}=#{value}"
+        end
+      end
     end
   end
 end

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

@@ -1,51 +1,56 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/response_header'
 
-  # Exception used internally in the SDK to indicate an error response was received from the Ingenico ePayments platform.
-  #
-  # @attr_reader [Integer] status_code HTTP status code that was returned by the Ingenico ePayments platform
-  # @attr_reader [String] body         HTTP message body that was returned by the Ingenico ePayments platform
-  # @attr_reader [Array<Ingenico:Connect:SDK:ResponseHeader>] headers HTTP headers used in the response from the Ingenico ePayments platform
-  class ResponseException < RuntimeError
+module Ingenico
+  module Connect
+    module SDK
+      # Exception used internally in the SDK to indicate an error response was received from the Ingenico ePayments platform.
+      #
+      # @attr_reader [Integer] status_code HTTP status code that was returned by the Ingenico ePayments platform
+      # @attr_reader [String] body         HTTP message body that was returned by the Ingenico ePayments platform
+      # @attr_reader [Array<Ingenico:Connect:SDK:ResponseHeader>] headers HTTP headers used in the response from the Ingenico ePayments platform
+      class ResponseException < RuntimeError
 
-    def initialize(status_code, headers, body)
-      super('the Ingenico ePayments platform returned an error response')
-      @status_code = status_code
-      @headers = if headers.nil? or headers.empty?
-                   {}
-                 else
-                   headers.inject({}) do |hash, header|
-                     hash[header.name.downcase.to_sym] = header.dup.freeze
-                     hash
-                   end
-                 end.freeze
-      @body = body
-    end
+        def initialize(status_code, headers, body)
+          super('the Ingenico ePayments platform returned an error response')
+          @status_code = status_code
+          @headers = if headers.nil? or headers.empty?
+                       {}
+                     else
+                       headers.inject({}) do |hash, header|
+                         hash[header.name.downcase.to_sym] = header.dup.freeze
+                         hash
+                       end
+                     end.freeze
+          @body = body
+        end
 
-    attr_reader :status_code
-    attr_reader :body
-    attr_reader :headers
+        attr_reader :status_code
+        attr_reader :body
+        attr_reader :headers
 
-    # Returns the {Ingenico::Connect::SDK::ResponseHeader} that corresponds to the given _header_name_
-    # used in the HTTP response from the Ingenico ePayments platform, or *nil* if the header was not present in the response.
-    def get_header(header_name)
-      ResponseHeader.get_header(@headers, header_name)
-    end
+        # Returns the {Ingenico::Connect::SDK::ResponseHeader} that corresponds to the given _header_name_
+        # used in the HTTP response from the Ingenico ePayments platform, or *nil* if the header was not present in the response.
+        def get_header(header_name)
+          ResponseHeader.get_header(@headers, header_name)
+        end
 
-    # Returns the header value received that corresponds to the header named by _header_name_,
-    # or *nil* if _header_name_ was not a header present in the HTTP response.
-    def get_header_value(header_name)
-      ResponseHeader.get_header_value(@headers, header_name)
-    end
+        # Returns the header value received that corresponds to the header named by _header_name_,
+        # or *nil* if _header_name_ was not a header present in the HTTP response.
+        def get_header_value(header_name)
+          ResponseHeader.get_header_value(@headers, header_name)
+        end
 
-    def to_s
-      str = super.to_s
-      if @status_code > 0
-        str += '; status_code=' + @status_code.to_s
-      end
-      if !@body.nil? && @body.length > 0
-        str += "; response_body='" + @body + "'"
+        def to_s
+          str = super.to_s
+          if @status_code > 0
+            str += '; status_code=' + @status_code.to_s
+          end
+          if !@body.nil? && @body.length > 0
+            str += "; response_body='" + @body + "'"
+          end
+          str.to_s
+        end
       end
-      str.to_s
     end
   end
 end

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

@@ -1,70 +1,78 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Represents HTTP response headers
+      # Each header is immutable has a #name and #value attribute
+      #
+      # @attr_reader [String] name  HTTP header name
+      # @attr_reader [String] value HTTP header value
+      class ResponseHeader
 
-  # Represents HTTP response headers
-  # Each header is immutable has a #name and #value attribute
-  #
-  # @attr_reader [String] name  HTTP header name
-  # @attr_reader [String] value HTTP header value
-  class ResponseHeader
+        # Create a new header using the name and value given as parameters.
+        def initialize(name, value)
+          raise ArgumentError.new('name is required') if name.nil? or name.strip.empty?
+          @name = name
+          @value = value
+        end
 
-    # Create a new header using the name and value given as parameters.
-    def initialize(name, value)
-      raise ArgumentError.new('name is required') if name.nil? or name.strip.empty?
-      @name = name
-      @value = value
-    end
+        attr_reader :name
+        attr_reader :value
 
-    attr_reader :name
-    attr_reader :value
+        def to_s
+          "#{name}:#{value}"
+        end
 
-    def to_s
-      "#{name}:#{value}"
-    end
+        # Return the {Ingenico::Connect::SDK::ResponseHeader} that goes by the given _header_name_,
+        # If this Response does not contain a header with the given name, return _nil_ instead
+        def self.get_header(headers, header_name)
+          selected_headers = headers.select { |h| h.name.casecmp(header_name) == 0 }
+          if selected_headers.nil? || selected_headers.length == 0
+            return nil
+          else
+            return selected_headers[0]
+          end
+        end
 
-    # Return the {Ingenico::Connect::SDK::ResponseHeader} that goes by the given _header_name_,
-    # If this Response does not contain a header with the given name, return _nil_ instead
-    def self.get_header(headers, header_name)
-      selected_headers = headers.select { |h| h.name.casecmp(header_name) == 0 }
-      if selected_headers.nil? || selected_headers.length == 0
-        return nil
-      else
-        return selected_headers[0]
-      end
-    end
+        # Returns the header value of the header that goes by the given _header_name_,
+        # If this response does not contain a header with the given name, return _nil_ instead
+        def self.get_header_value(headers, header_name)
+          header = get_header(headers, header_name)
+          return (
+            if header.nil?
+              nil
+            else
+              header.value
+            end)
+        end
 
-    # Returns the header value of the header that goes by the given _header_name_,
-    # If this response does not contain a header with the given name, return _nil_ instead
-    def self.get_header_value(headers, header_name)
-      header = get_header(headers, header_name)
-      return (if header.nil? then nil else header.value end)
-    end
+        # Returns the value of the _filename_ parameter of the _Content-Disposition_ header from
+        # parameter _headers_
+        # If this Response does not contain a header with the given name, return _nil_ instead
+        def self.get_disposition_filename(headers)
+          header_value = get_header_value(headers, "Content-Disposition")
+          unless header_value.nil?
+            if header_value =~ /(?:^|;)\s*filename\s*=\s*(.*?)\s*(?:;|$)i/
+              return trim_quotes($2)
+            end
+          end
 
-    # Returns the value of the _filename_ parameter of the _Content-Disposition_ header from
-    # parameter _headers_
-    # If this Response does not contain a header with the given name, return _nil_ instead
-    def self.get_disposition_filename(headers)
-      header_value = get_header_value(headers, "Content-Disposition")
-      unless header_value.nil?
-        if header_value =~ /(?:^|;)\s*filename\s*=\s*(.*?)\s*(?:;|$)i/
-          return trim_quotes($2)
+          return nil
         end
-      end
-
-      return nil
-    end
 
-    private
+        private
 
-    # Trims the single or double quotes at the beginning and end of parameter _filename_ if they exist
-    # If they don't exist, it returns the original _filename_ instead
-    def trim_quotes(filename)
-      unless filename.length < 2
-        if ( filename.chars.first == '\'' && filename.chars.last == '\"' ) ||
-            ( filename.chars.first == '"' && filename.chars.last == '"' )
-          return filename[1...-1]
+        # Trims the single or double quotes at the beginning and end of parameter _filename_ if they exist
+        # If they don't exist, it returns the original _filename_ instead
+        def trim_quotes(filename)
+          unless filename.length < 2
+            if (filename.chars.first == '\'' && filename.chars.last == '\"') ||
+              (filename.chars.first == '"' && filename.chars.last == '"')
+              return filename[1...-1]
+            end
+          end
+          filename
         end
       end
-      return filename
     end
   end
 end

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

@@ -1,40 +1,43 @@
 require 'uri'
 
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # Contains networking and authentication data needed to communicate with the Ingenico ePayments platform
+      #
+      # @attr_reader [URI::HTTP] api_endpoint The base URI to the Ingenico ePayments platform
+      # @attr_reader [Ingenico::Connect::SDK::Connection] connection Used to communicate with the Ingenico ePayments platform
+      # @attr_reader [Ingenico::Connect::SDK::Authenticator] authenticator Used for authenticating messages sent
+      # @attr_reader [Ingenico::Connect::SDK::MetaDataProvider] meta_data_provider Object containing information relevant for sending requests
+      class Session
 
-  # Contains networking and authentication data needed to communicate with the Ingenico ePayments platform
-  #
-  # @attr_reader [URI::HTTP] api_endpoint The base URI to the Ingenico ePayments platform
-  # @attr_reader [Ingenico::Connect::SDK::Connection] connection Used to communicate with the Ingenico ePayments platform
-  # @attr_reader [Ingenico::Connect::SDK::Authenticator] authenticator Used for authenticating messages sent
-  # @attr_reader [Ingenico::Connect::SDK::MetaDataProvider] meta_data_provider Object containing information relevant for sending requests
-  class Session
+        # Construct a new Session.
+        #
+        # @param api_endpoint       [String] the base URL to the Ingenico ePayments platform
+        # @param connection         [Ingenico::Connect::SDK::Connection] used to communicate with the Ingenico ePayments platform
+        # @param authenticator      [Ingenico::Connect::SDK::Authenticator] used for authenticating messages sent
+        # @param meta_data_provider [Ingenico::Connect::SDK::MetaDataProvider] object containing information relevant for sending requests
+        def initialize(api_endpoint, connection, authenticator, meta_data_provider)
+          raise ArgumentError.new('api_endpoint is required') unless api_endpoint
+          raise ArgumentError.new('connection is required') unless connection
+          raise ArgumentError.new('authenticator is required') unless authenticator
+          raise ArgumentError.new('meta_data_provider is required') unless meta_data_provider
 
-    # Construct a new Session.
-    #
-    # @param api_endpoint       [String] the base URL to the Ingenico ePayments platform
-    # @param connection         [Ingenico::Connect::SDK::Connection] used to communicate with the Ingenico ePayments platform
-    # @param authenticator      [Ingenico::Connect::SDK::Authenticator] used for authenticating messages sent
-    # @param meta_data_provider [Ingenico::Connect::SDK::MetaDataProvider] object containing information relevant for sending requests
-    def initialize(api_endpoint, connection, authenticator, meta_data_provider)
-      raise ArgumentError.new('api_endpoint is required') unless api_endpoint
-      raise ArgumentError.new('connection is required') unless connection
-      raise ArgumentError.new('authenticator is required') unless authenticator
-      raise ArgumentError.new('meta_data_provider is required') unless meta_data_provider
+          uri = URI(api_endpoint)
+          if uri.path.length > 0 || uri.query || uri.fragment
+            raise ArgumentError.new("Base URL should not contain a path, query or fragment #{uri.to_s}")
+          end
+          @api_endpoint = uri
+          @connection = connection
+          @authenticator = authenticator
+          @meta_data_provider = meta_data_provider
+        end
 
-      uri = URI(api_endpoint)
-      if uri.path.length > 0 || uri.query || uri.fragment
-        raise ArgumentError.new("Base URL should not contain a path, query or fragment #{uri.to_s}")
+        attr_reader :api_endpoint
+        attr_reader :connection
+        attr_reader :authenticator
+        attr_reader :meta_data_provider
       end
-      @api_endpoint = uri
-      @connection = connection
-      @authenticator = authenticator
-      @meta_data_provider = meta_data_provider
     end
-
-    attr_reader :api_endpoint
-    attr_reader :connection
-    attr_reader :authenticator
-    attr_reader :meta_data_provider
   end
 end

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

@@ -1,30 +1,33 @@
-module Ingenico::Connect::SDK
+module Ingenico
+  module Connect
+    module SDK
+      # A file that can be uploaded
+      #
+      # The allowed forms of content are defined by the Connection implementation
+      # The default implementation supports file paths and IO objects.
+      #
+      # @attr_reader [String] file_name       The name of the file.
+      # @attr_reader [String, IO] content     The file's content.
+      # @attr_reader [String] content_type    The file's content type.
+      # @attr_reader [Integer] content_length The file's content length, or -1 if not known.
+      class UploadableFile
 
-    # A file that can be uploaded
-    #
-    # The allowed forms of content are defined by the Connection implementation
-    # The default implementation supports file paths and IO objects.
-    #
-    # @attr_reader [String] file_name       The name of the file.
-    # @attr_reader [String, IO] content     The file's content.
-    # @attr_reader [String] content_type    The file's content type.
-    # @attr_reader [Integer] content_length The file's content length, or -1 if not known.
-    class UploadableFile
+        def initialize(file_name, content, content_type, content_length = -1)
+          raise ArgumentError.new("file_name is required") if file_name.nil? or !file_name.strip
+          raise ArgumentError.new("content is required") if content.nil?
+          raise ArgumentError.new("content_type is required") if content_type.nil? or !content_type.strip
 
-        def initialize(file_name, content, content_type, content_length=-1)
-            raise ArgumentError.new("file_name is required") if file_name.nil? or !file_name.strip
-            raise ArgumentError.new("content is required") if content.nil?
-            raise ArgumentError.new("content_type is required") if content_type.nil? or !content_type.strip
-
-            @file_name = file_name
-            @content = content
-            @content_type = content_type
-            @content_length = [content_length, -1].max
+          @file_name = file_name
+          @content = content
+          @content_type = content_type
+          @content_length = [content_length, -1].max
         end
 
         attr_reader :file_name
         attr_reader :content
         attr_reader :content_type
         attr_reader :content_length
+      end
     end
+  end
 end

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

@@ -1,14 +1,19 @@
-module Ingenico::Connect::SDK
+require 'ingenico/connect/sdk/api_exception'
 
-  # Raised when the request sent to the Ingenico ePayments platform returned a HTTP response with status code 400.
-  # This indicates the request received by the Ingenico ePayments platform was malformed.
-  class ValidationException < ApiException
+module Ingenico
+  module Connect
+    module SDK
+      # Raised when the request sent to the Ingenico ePayments platform returned a HTTP response with status code 400.
+      # This indicates the request received by the Ingenico ePayments platform was malformed.
+      class ValidationException < ApiException
 
-    # Create a new ValidationException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors,
-                   message='the Ingenico ePayments platform returned an incorrect request error response')
-      super(status_code, response_body, error_id, errors, message)
+        # Create a new ValidationException
+        # @see ApiException#initialize
+        def initialize(status_code, response_body, error_id, errors,
+                       message = 'the Ingenico ePayments platform returned an incorrect request error response')
+          super(status_code, response_body, error_id, errors, message)
+        end
+      end
     end
   end
 end

data/lib/ingenico/connect/sdk/webhooks/api_version_mismatch_exception.rb

@@ -1,20 +1,24 @@
-module Ingenico::Connect::SDK
-  module Webhooks
-    # Raised when a webhooks event has an API version that is not supported by current version
-    # of SDK.
-    #
-    # @attr_reader [String] event_api_version The API version from the webhooks event.
-    # @attr_reader [String] sdk_api_version   The API version that this version of the SDK supports.
-    class ApiVersionMismatchException < RuntimeError
+module Ingenico
+  module Connect
+    module SDK
+      module Webhooks
+        # Raised when a webhooks event has an API version that is not supported by current version
+        # of SDK.
+        #
+        # @attr_reader [String] event_api_version The API version from the webhooks event.
+        # @attr_reader [String] sdk_api_version   The API version that this version of the SDK supports.
+        class ApiVersionMismatchException < RuntimeError
 
-      def initialize(event_api_version, sdk_api_version)
-        super("event API version #{event_api_version} is not compatible with SDK API version #{sdk_api_version}")
-        @event_api_version = event_api_version
-        @sdk_api_version = sdk_api_version
-      end
+          def initialize(event_api_version, sdk_api_version)
+            super("event API version #{event_api_version} is not compatible with SDK API version #{sdk_api_version}")
+            @event_api_version = event_api_version
+            @sdk_api_version = sdk_api_version
+          end
 
-      attr_reader :event_api_version
-      attr_reader :sdk_api_version
+          attr_reader :event_api_version
+          attr_reader :sdk_api_version
+        end
+      end
     end
   end
 end