onlinepayments-sdk-ruby 4.23.0 → 5.0.0

data/lib/onlinepayments/sdk/communication/multipart_form_data_object.rb

@@ -0,0 +1,52 @@
+require 'securerandom'
+
+module OnlinePayments
+  module SDK
+    module Communication
+      # A representation of a multipart/form-data object
+      #
+      # @attr_reader [String] boundary
+      # @attr_reader [String] content_type
+      # @attr_reader [Hash] values
+      # @attr_reader [Hash] files
+      class MultipartFormDataObject
+        def initialize
+          @boundary = SecureRandom.uuid
+          @content_type = 'multipart/form-data; boundary=' + @boundary
+          @values = {}
+          @files = {}
+        end
+
+        attr_reader :boundary
+        attr_reader :content_type
+        attr_reader :values
+        attr_reader :files
+
+        def add_value(parameter_name, value)
+          if parameter_name.nil? || parameter_name.strip.empty?
+            raise ArgumentError, 'parameter_name is required'
+          end
+          raise ArgumentError, 'value is required' if value.nil?
+          if @values.include?(parameter_name) || @files.include?(parameter_name)
+            raise ArgumentError, 'duplicate parameterName: ' + parameter_name
+          end
+
+          @values[parameter_name] = value
+        end
+
+        # Adds a file to the multipart Form Data Object
+        def add_file(parameter_name, uploadable_file)
+          if parameter_name.nil? || parameter_name.strip.empty?
+            raise ArgumentError, 'parameter_name is required'
+          end
+          raise ArgumentError, 'uploadable_file is required' if uploadable_file.nil?
+          if @values.include?(parameter_name) || @files.include?(parameter_name)
+            raise ArgumentError, 'duplicate parameterName: ' + parameter_name
+          end
+
+          @files[parameter_name] = uploadable_file
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/multipart_form_data_request.rb

@@ -0,0 +1,13 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # A representation of a multipart/form-data request
+      class MultipartFormDataRequest
+        # @return [OnlinePayments::SDK::Communication::MultipartFormDataObject]
+        def to_multipart_form_data_object
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/not_found_exception.rb

@@ -0,0 +1,19 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # Raised when a resource is not found on the Online Payments platform.
+      # This error corresponds to a 404 HTTP response.
+      #
+      # @attr [Exception] cause The error that is the cause of this error.
+      class NotFoundException < RuntimeError
+
+        def initialize(cause, message = nil)
+          super(message)
+          @cause = cause
+        end
+
+        attr_accessor :cause
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/param_request.rb

@@ -0,0 +1,14 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # Class that represents the URL request parameters.
+      # Contains a method to add a name and value pair to a parameter array as a {OnlinePayments::SDK::Communication::RequestParam}.
+      class ParamRequest
+        # @return [Array<OnlinePayments::SDK::Communication::RequestParam>]
+        def to_request_parameters
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/pooled_connection.rb

@@ -0,0 +1,26 @@
+require 'onlinepayments/sdk/communication/connection'
+
+module OnlinePayments
+  module SDK
+    module Communication
+      # {OnlinePayments::SDK::Communication::Connection} that supports connection pooling. This is used to more efficiently communicate using HTTP.
+      # Connection pooling means that a number of connections are kept alive after use so they can possibly be reused.
+      # If the Connection does not do so automatically,
+      # the methods _close_idle_connections_ and _close_expired_connections_ can be used to drop connections
+      # that are idle for a specified amount of time or that have expired.
+      # @see OnlinePayments::SDK::Communication::DefaultConnection
+      class PooledConnection < Connection
+
+        # Closes all connections that have not been used for _idle_time_ seconds.
+        def close_idle_connections(idle_time)
+          raise NotImplementedError
+        end
+
+        # Closes all connections that have expired.
+        def close_expired_connections
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/request_header.rb

@@ -0,0 +1,62 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # 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
+
+        attr_reader :name
+        attr_reader :value
+
+        def to_s
+          "#{name}:#{value}"
+        end
+
+        # Return the {OnlinePayments::SDK::Communication::RequestHeader} 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
+
+        # 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
+
+        def normalize_value(value)
+          if value.nil? || value.empty?
+            return value
+          end
+          # Replace all sequences of linebreak-whitespace* with a single linebreak-space
+          value.gsub(/\r?\n[\s&&[^\r\n]]*/, ' ')
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/request_param.rb

@@ -0,0 +1,28 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # 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
+
+        attr_reader :name
+        attr_reader :value
+
+        def to_s
+          "#{name}=#{value}"
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/response_exception.rb

@@ -0,0 +1,56 @@
+require 'onlinepayments/sdk/communication/response_header'
+
+module OnlinePayments
+  module SDK
+    module Communication
+      # Exception used internally in the SDK to indicate an error response was received from the Online Payments platform.
+      #
+      # @attr_reader [Integer] status_code HTTP status code that was returned by the Online Payments platform
+      # @attr_reader [String] body         HTTP message body that was returned by the Online Payments platform
+      # @attr_reader [Array<OnlinePayments::SDK::Communication::ResponseHeader>] headers HTTP headers used in the response from the Online Payments platform
+      class ResponseException < RuntimeError
+
+        def initialize(status_code, headers, body)
+          super('the Online Payments 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
+
+        # Returns the {OnlinePayments::SDK::Communication::ResponseHeader} that corresponds to the given _header_name_
+        # used in the HTTP response from the Online Payments 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
+
+        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
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication/response_header.rb

@@ -0,0 +1,78 @@
+module OnlinePayments
+  module SDK
+    module Communication
+      # 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
+
+        attr_reader :name
+        attr_reader :value
+
+        def to_s
+          "#{name}:#{value}"
+        end
+
+        # Return the {OnlinePayments::SDK::Communication::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 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
+
+          return nil
+        end
+
+        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]
+            end
+          end
+          filename
+        end
+      end
+    end
+  end
+end

data/lib/onlinepayments/sdk/communication.rb

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