connect-sdk-ruby 1.0.0

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

@@ -0,0 +1,130 @@
+# Main module of this SDK. All non-data classes that are used at multiple places in the SDK are placed in this module.
+module Ingenico::Connect::SDK
+end
+
+# Contains provided implementations for abstract functionality in this SDK.
+# These implementations can be replaced or adapted if desired to suit specific needs.
+module Ingenico::Connect::SDK::DefaultImpl
+end
+
+# Contains all logging-related classes.
+module Ingenico::Connect::SDK::Logging
+end
+
+# Contains interfaces to all GlobalCollect services. These services are accessed through a *Ingenico::Connect::SDK::Client* instance.
+module Ingenico::Connect::SDK::Merchant
+end
+
+# Container for all data-containing modules.
+# The data-classes contained within can be serialized and communicated with the GlobalCollect platform.
+# These classes generally contain financially relevant data used in processing requests or responses.
+module Ingenico::Connect::SDK::Domain
+end
+
+# Contains the client used to access the HostedCheckouts service.
+# @see https://developer.globalcollect.com/documentation/api/server/#hostedcheckouts
+module Ingenico::Connect::SDK::Merchant::Hostedcheckouts
+end
+
+# Contains data classes that are used in the HostedCheckouts service.
+# @see https://developer.globalcollect.com/documentation/api/server/#hostedcheckouts
+module Ingenico::Connect::SDK::Domain::Hostedcheckout
+end
+
+# Contains the client used to access the payment service.
+# @see https://developer.globalcollect.com/documentation/api/server/#payments
+module Ingenico::Connect::SDK::Merchant::Payments
+end
+
+# Contains data classes that are used in payment services.
+# @see https://developer.globalcollect.com/documentation/api/server/#payments
+module Ingenico::Connect::SDK::Domain::Payment
+end
+
+# Contains the client used to access the payout service.
+# @see https://developer.globalcollect.com/documentation/api/server/#payouts
+module Ingenico::Connect::SDK::Merchant::Payouts
+end
+
+# Contains data classes that are used in payout services.
+# @see https://developer.globalcollect.com/documentation/api/server/#payouts
+module Ingenico::Connect::SDK::Domain::Payout
+end
+
+# Contains the client used to access the product groups service.
+# @see https://developer.globalcollect.com/documentation/api/server/#productgroups
+module Ingenico::Connect::SDK::Merchant::Productgroups
+end
+
+# Contains the client used to access the products service.
+# @see https://developer.globalcollect.com/documentation/api/server/#products
+module Ingenico::Connect::SDK::Merchant::Products
+end
+
+# Contains data classes that are used in payment product and payment product group services.
+# @see https://developer.globalcollect.com/documentation/api/server/#products
+module Ingenico::Connect::SDK::Domain::Product
+end
+
+# Contains the client used to access the refunds service
+# @see https://developer.globalcollect.com/documentation/api/server/#refunds
+module Ingenico::Connect::SDK::Merchant::Refunds
+end
+
+# Contains data classes that are used in refund requests.
+# @see https://developer.globalcollect.com/documentation/api/server/#refunds
+module Ingenico::Connect::SDK::Domain::Refund
+end
+
+# Contains the client used to access the riskassessments service.
+# @see https://developer.globalcollect.com/documentation/api/server/#riskassessments
+module Ingenico::Connect::SDK::Merchant::Riskassessments
+end
+
+# Contains data classes that are used in riskassessment services.
+# @see https://developer.globalcollect.com/documentation/api/server/#riskassessments
+module Ingenico::Connect::SDK::Domain::Riskassessments
+end
+
+# Contains the client to access miscellaneous services.
+# @see https://developer.globalcollect.com/documentation/api/server/#services
+module Ingenico::Connect::SDK::Merchant::Services
+end
+
+# Contains data classes that are used in miscellaneous services.
+# @see https://developer.globalcollect.com/documentation/api/server/#services
+module Ingenico::Connect::SDK::Domain::Services
+end
+
+# Contains the client used to access the sessions service.
+# @see https://developer.globalcollect.com/documentation/api/server/#sessions
+module Ingenico::Connect::SDK::Merchant::Sessions
+end
+
+# Contains data classes that are used in initiating Sessions.
+# @see https://developer.globalcollect.com/documentation/api/server/#sessions
+module Ingenico::Connect::SDK::Domain::Sessions
+end
+
+# Contains the client used to access the tokens service.
+# @see https://developer.globalcollect.com/documentation/api/server/#tokens
+module Ingenico::Connect::SDK::Merchant::Tokens
+end
+
+# Contains data classes that are used in the tokenization service.
+# @see https://developer.globalcollect.com/documentation/api/server/#tokens
+module Ingenico::Connect::SDK::Domain::Token
+end
+
+# Contains the general data classes that are used in multiple different types of requests.
+# These classes can be serialized and used in communication with the GlobalCollect platform.
+module Ingenico::Connect::SDK::Domain::Definitions
+end
+
+# Contains classes that represent error responses from the GlobalCollect platform.
+module Ingenico::Connect::SDK::Domain::Errors
+end
+
+# Contains data classes related to shopping cart functionality.
+module Ingenico::Connect::SDK::Domain::MetaData
+end

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

@@ -0,0 +1,19 @@
+module Ingenico::Connect::SDK
+
+  # Raised when a resource is not found on the GlobalCollect platform.
+  # This error corresponds to a 404 HTTP response.
+  class NotFoundException < RuntimeError
+
+    def initialize(cause, message=FALSE)
+      if message
+        super(message)
+      else
+        super
+      end
+      @cause = cause
+    end
+
+    # The error that is the cause of this error.
+    attr_accessor :cause
+  end
+end

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

@@ -0,0 +1,33 @@
+module Ingenico::Connect::SDK
+
+  # Class that represents the URL request parameters.
+  # Contains a method to add a name and value pair to a parameter array as a {Ingenico::Connect::SDK::RequestParam}.
+  class ParamRequest
+
+    protected
+
+    # Adds a {Ingenico::Connect::SDK::RequestParam} object to the _request_parameters_ array
+    # where RequestParam.name = name and RequestParam.value = value.
+    # Allows Strings, Integers, booleans and arrays of these to be converted to RequestParams.
+    # If _value_ is an array, one RequestParam instance will be added for each element in the array.
+    # An array containing another array is explicitly disallowed and will raise an error.
+    def add_parameter(request_parameters, name, value)
+      add_param(request_parameters, name, value)
+    end
+
+    private
+
+    def add_param(request_parameters, name, value, allow_collection = TRUE)
+      if value.is_a?(String) || value.is_a?(Integer) || value.class == TrueClass ||
+          value.class == FalseClass
+        request_parameters.push(RequestParam.new(name, value.to_s))
+      elsif allow_collection && value.class == Array
+        value.each { |element|
+          add_param(request_parameters, name, element, FALSE)
+        }
+      elsif !value.nil?
+        raise ArgumentError.new("Unsupported request parameter type: #{value.class}")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Ingenico::Connect::SDK
+
+  # {Ingenico::Connect::SDK::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 Ingenico::Connect::SDK::DefaultImpl::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

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

@@ -0,0 +1,75 @@
+module Ingenico::Connect::SDK
+
+  # Contains the url, username and password of a proxy.
+  class ProxyConfiguration
+
+    # Initialize a new ProxyConfiguration from the parameter hash.
+    # In order to be complete either host, port and scheme, or an address is required.
+    # Arguments read from the hash are:
+    # host::      Host part of the url to the proxy.
+    # port::      Port the proxy will be accessed through.
+    # scheme::    HTTP scheme used to communicate with the proxy (HTTP or HTTPS).
+    # address::   Full uri to the proxy excluding username and password.
+    #             If given this uri takes precedence over individual host, port and scheme.
+    # username::  Username used in authentication to the proxy.
+    # password::  Password used to authenticate to the proxy.
+    def initialize(args)
+
+      host = args[:host]
+      port = args[:port]
+      username = args[:username]
+      password = args[:password]
+      scheme = args[:scheme] || 'http'
+
+      # Don't switch the order, a given address overrides host, port and username
+      address = args[:address]
+      host = address.host if address
+      port = address.port if address
+      scheme = address.scheme if address
+
+      raise ArgumentError.new('scheme is required') unless scheme and not scheme.strip.empty?
+      raise ArgumentError.new('host is required') unless host and not host.strip.empty?
+      raise ArgumentError.new('port is required') unless port and port > 0 and port <= 65535
+
+      @host = host
+      @port = port
+      @username = username
+      @password = password
+      @scheme = scheme
+    end
+
+    # proxy scheme (http or https)
+    attr_accessor :scheme
+
+    # proxy hostname
+    attr_accessor :host
+
+    # proxy port
+    attr_accessor :port
+
+    # proxy authentication username
+    attr_accessor :username
+
+    # proxy authentication password
+    attr_accessor :password
+
+    # Returns a url string representation of the proxy, excluding authentication.
+    def proxy_uri
+       "#{scheme}://#{host}:#{port}"
+    end
+
+    def to_s
+      proxy_uri
+    end
+
+    private
+
+    def self.get_port(address)
+      port = address.port
+      return port if port != -1
+      return 80 if address.scheme.casecmp('http') == 0
+      return 443 if address.scheme.casecmp('https') == 0
+      raise ArgumentError.new('unsupported scheme: ' + address.scheme)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Ingenico::Connect::SDK
+
+  # This error is raised when the request refers to a resource or object that is not found by the GlobalCollect 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 GlobalCollect platform returned a reference error response')
+      super(status_code, response_body, error_id, errors, message)
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Ingenico::Connect::SDK
+
+  # Represents HTTP request headers
+  # Each header is immutable has a #name and #value attribute
+  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 = value
+    end
+
+    # HTTP header name
+    attr_reader :name
+    # HTTP header value
+    attr_reader :value
+
+    def to_s
+      name + ':' + value
+    end
+  end
+end

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

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

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

@@ -0,0 +1,62 @@
+module Ingenico::Connect::SDK
+
+  # Base class for HTTP responses. It provides access to the response headers, status code and response message body
+  class Response
+
+    # Create a new response object that stores the following:
+    # status_code:: HTTP status code
+    # body::        response message body, given as a string
+    # headers::     response headers as a {Ingenico::Connect::SDK::ResponseHeader} list
+    def initialize(status_code, body, headers)
+      @status_code = status_code
+      @body = body
+      if headers.nil?
+        @headers = [].freeze
+      else
+        @headers = headers.dup.freeze
+      end
+    end
+
+    # HTTP status code
+    attr_reader :status_code
+    # Response message body
+    attr_reader :body
+    # Response headers as a {Ingenico::Connect::SDK::ResponseHeader} list
+    attr_reader :headers
+
+    # Returns the {Ingenico::Connect::SDK::ResponseHeader} that goes by the given _header_name_,
+    # or _nil_ if this Response does not contain a header with the given name.
+    def get_header(header_name)
+      @headers.each { |header|
+        if header.name.casecmp(header_name) == 0
+          return header
+        end
+      }
+      return nil
+    end
+
+    # Returns the header value of the header that goes by the given _header_name_,
+    # or _nil_ if this Response does not contain a header with the given name.
+    def get_header_value(header_name)
+      header = get_header(header_name)
+      if !header.nil?
+        header.value
+      else
+        nil
+      end
+    end
+
+    def to_s
+      str =  self.class.name
+      str += '[status_code=' + @status_code.to_s
+      if !@body.nil? && @body.length > 0
+        str += ",body='" + @body + "'"
+      end
+      unless @headers.empty? || @headers.nil?
+        str += ',headers=' + @headers.to_s
+      end
+      str += ']'
+      str.to_s
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Ingenico::Connect::SDK
+
+  # Exception used internally in the SDK to indicate an error response was received from the GlobalCollect platform.
+  class ResponseException < RuntimeError
+
+    def initialize(response)
+      super('the GlobalCollect platform returned an error response')
+      @response = response
+    end
+
+    # {Ingenico::Connect::SDK::Response} object that was returned by the GlobalCollect platform
+    attr_reader :response
+
+    # HTTP status code that was returned by the GlobalCollect platform
+    def status_code
+      @response.status_code
+    end
+
+    # string HTTP message body that was returned by the GlobalCollect platform
+    def body
+      @response.body
+    end
+
+    # List of {Ingenico::Connect::SDK::ResponseHeader} that represent the HTTP headers used in the response from the GlobalCollect platform
+    def headers
+      @response.headers
+    end
+
+    # Returns the {Ingenico::Connect::SDK::ResponseHeader} that corresponds to the given _header_name_
+    # used in the HTTP response from the GlobalCollect platform, or *nil* if the header was not present in the response.
+    def get_header(header_name)
+      @response.get_header(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)
+      @response.get_header_value(header_name)
+    end
+
+    def to_s
+      str = super.to_s
+      status_code = @response.status_code
+      if status_code > 0
+        str += '; status_code=' + status_code.to_s
+      end
+      response_body = @response.body
+      if !response_body.nil? && response_body.length > 0
+        str += "; response_body='" + response_body + "'"
+      end
+      str.to_s
+    end
+  end
+end