onlinepayments-sdk-ruby 4.23.0 → 5.0.0

data/lib/onlinepayments/sdk/logging/logging_util.rb

@@ -1,286 +0,0 @@
-module OnlinePayments::SDK
-  module Logging
-
-    # Class responsible for obfuscating sensitive data in a message body.
-    class ValueObfuscator
-
-      class << self
-
-        alias_method :private_new, :new
-
-        protected :private_new, :new
-      end
-
-      public
-
-      def self.INSTANCE
-        # use lazy instantiation
-        @@INSTANCE ||= ValueObfuscator.new
-      end
-
-      # Obfuscates the parameter value.
-      def obfuscate_value(value)
-        (value.nil? or value.empty?) ? value : "*#{value.length}"
-      end
-    end
-
-    # end of ValueObfuscator
-
-    # Class responsible for obfuscating sensitive data.
-    class SensitiveValueObfuscator
-
-      class << self
-
-        alias_method :private_new, :new
-
-        protected :private_new, :new
-      end
-
-      public
-
-      def self.INSTANCE
-        # use lazy instantiation
-        @@INSTANCE ||= SensitiveValueObfuscator.new
-      end
-
-      # @return an arbitrary number of '*', or null/empty if the value is null/empty.
-      def obfuscate_value(value)
-        value.nil? or value.empty? ? value : "***"
-      end
-    end
-
-    # end of SensitiveValueObfuscator
-
-    class Obfuscator
-      def initialize(obfuscators, case_insensitive)
-        raise ArgumentError unless obfuscators.is_a? Hash
-        @obfuscators = copy(obfuscators, case_insensitive)
-      end
-
-      private
-
-      # case insensitive hash
-      # @private
-      class HashClod < Hash
-
-        def initialize(other)
-          other.each { |k, v| self.[]=(k, v) }
-        end
-
-        def [](key)
-          super _insensitive(key)
-        end
-
-        def []=(key, value)
-          super _insensitive(key), value
-        end
-
-        protected
-
-        def _insensitive(key)
-          key.respond_to?(:upcase) ? key.upcase : key
-        end
-      end
-
-      # end of HashClod
-
-      def copy(obfuscators, case_insensitive)
-        cp = case_insensitive ? HashClod.new(obfuscators) : obfuscators
-        Marshal.load(Marshal.dump(cp)) # deep copy
-      end
-
-      public
-
-      def obfuscate_value(key, value)
-        obfuscator = @obfuscators[key]
-        if obfuscator.nil?
-          value
-        else
-          obfuscator.obfuscate_value(value)
-        end
-      end
-
-      # A convenient wrapper to build obfuscators
-      class Builder
-        attr_accessor :obfuscators
-
-        def initialize
-          raise NotImplementedError, "#{self.class.name} is not implemented."
-        end
-
-        def with_field(key)
-          @obfuscators[key] = ValueObfuscator.INSTANCE
-          self
-        end
-
-        def with_sensitive_field(key)
-          @obfuscators[key] = SensitiveValueObfuscator.INSTANCE
-          self
-        end
-
-        def build
-          raise NotImplementedError, "#{self.class.name}#build() is not implemented."
-        end
-      end
-
-      # Builder
-    end
-
-    # Obfuscator
-
-    # Class that obfuscates headers of a message
-    class HeaderObfuscator < Obfuscator
-      def initialize(obfuscators)
-        # case insensitive
-        super(obfuscators, true)
-      end
-
-      def self.builder
-        Builder.new
-      end
-
-      class Builder < Obfuscator::Builder
-        def initialize
-          @obfuscators = {}
-        end
-
-        def with_field(name)
-          raise ArgumentError unless name.is_a? String
-          super(name)
-        end
-
-        def with_sensitive_field(name)
-          raise ArgumentError unless name.is_a? String
-          super(name)
-        end
-
-        def build
-          HeaderObfuscator.new(obfuscators)
-        end
-      end
-    end
-
-    # end of HeadObfuscator
-
-    # Class that obfuscates properties in the JSON body of a message
-    class PropertyObfuscator < Obfuscator
-      def initialize(obfuscators)
-        # case sensitive
-        super(obfuscators, false)
-        @property_pattern = build_property_pattern(obfuscators.keys)
-      end
-
-      private
-
-      def build_property_pattern(pn)
-        return /$^/ if pn.empty? # no possible match
-        # Regex to create:
-        # (["'])(X|Y|Z)\1\s*:\s*(?:(["'])(.*?)(?<!\\)\3|([^"'\s\[\{]\S*))
-        # Groups:
-        # 1: opening " or ' for the property name
-        # 2: property name
-        # 3: opening " or ' for the value
-        # 4: quoted value
-        # 5: non-quoted-value
-        # The negative lookbehind is to allow escaped quotes to be part of
-        # the value. What this does not allow currently is having values end
-        # with a \ (which would be escaped to \\).
-        regex = pn.inject("([\"'])(") { |r, p| "#{r}#{Regexp.quote(p)}|" }.chop <<
-          ")\\1\\s*:\\s*(?:([\"'])(.*?)(?<!\\\\)\\3|([^\"'\\s\\[\\{]((?!,)\\S)*))"
-        /#{regex}/m # dotall mode
-      end
-
-      public
-
-      def obfuscate(body)
-        return nil if body.nil?
-        return "" if body.empty?
-
-        body.gsub(@property_pattern) do
-          m = Regexp.last_match
-          property_name = m[2]
-          value = m[4] || m[5]
-          # copy value 'cause it's part of m[0]
-          m[0].sub(value, obfuscate_value(property_name, value.dup))
-        end
-      end
-
-      def self.builder
-        Builder.new
-      end
-
-      class Builder < Obfuscator::Builder
-        def initialize
-          @obfuscators = {}
-        end
-
-        def with_field(property)
-          raise ArgumentError unless property.is_a? String
-          super(property)
-        end
-
-        def with_sensitive_field(property)
-          raise ArgumentError unless property.is_a? String
-          super(property)
-        end
-
-        def build
-          PropertyObfuscator.new(obfuscators)
-        end
-      end
-    end
-
-    # end of property obfuscator
-
-    module LoggingUtil
-      @@PROPERTY_OBFUSCATOR = PropertyObfuscator.builder
-                                                .with_field("cardNumber")
-                                                .with_field("expiryDate")
-                                                .with_field("cvv")
-                                                .with_field("iban")
-                                                .with_field("accountNumber")
-                                                .with_field("reformattedAccountNumber")
-                                                .with_field("additionalInfo")
-                                                .with_field("cardholderName")
-                                                .with_field("dateOfBirth")
-                                                .with_field("emailAddress")
-                                                .with_field("faxNumber")
-                                                .with_field("firstName")
-                                                .with_field("houseNumber")
-                                                .with_field("mobilePhoneNumber")
-                                                .with_field("passengerName")
-                                                .with_field("phoneNumber")
-                                                .with_field("street")
-                                                .with_field("surname")
-                                                .with_field("workPhoneNumber")
-                                                .with_field("zip")
-                                                .with_field("bin")
-                                                .with_field("value")
-                                                .with_sensitive_field("keyId")
-                                                .with_sensitive_field("secretKey")
-                                                .with_sensitive_field("publicKey")
-                                                .with_sensitive_field("userAuthenticationToken")
-                                                .with_sensitive_field("encryptedPayload")
-                                                .with_sensitive_field("decryptedPayload")
-                                                .with_sensitive_field("encryptedCustomerInput")
-                                                .build
-
-      @@HEADER_OBFUSCATOR = HeaderObfuscator.builder
-                                            .with_sensitive_field("Authorization")
-                                            .with_sensitive_field("WWW-Authenticate")
-                                            .with_sensitive_field("Proxy-Authenticate")
-                                            .with_sensitive_field("Proxy-Authorization")
-                                            .with_sensitive_field("X-GCS-Authentication-Token")
-                                            .with_sensitive_field("X-GCS-CallerPassword")
-                                            .build
-
-      def self.obfuscate_body(body)
-        @@PROPERTY_OBFUSCATOR.obfuscate(body)
-      end
-
-      def self.obfuscate_header(name, value)
-        @@HEADER_OBFUSCATOR.obfuscate_value(name, value)
-      end
-    end # end of LoggingUtil
-  end
-end

data/lib/onlinepayments/sdk/marshaller.rb

@@ -1,24 +0,0 @@
-module OnlinePayments::SDK
-
-  # 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 [OnlinePayments::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
-    end
-  end
-end

data/lib/onlinepayments/sdk/marshaller_syntax_exception.rb

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

data/lib/onlinepayments/sdk/merchant/services/get_privacy_policy_params.rb

@@ -1,30 +0,0 @@
-#
-# This class was auto-generated.
-#
-require 'onlinepayments/sdk/param_request'
-require 'onlinepayments/sdk/request_param'
-
-module OnlinePayments::SDK
-  module Merchant
-    module Services
-
-      # Query parameters for 'Get Privacy Policy'.
-      # @attr [String] locale
-      # @attr [Integer] payment_product_id
-      class GetPrivacyPolicyParams < OnlinePayments::SDK::ParamRequest
-
-        attr_accessor :locale
-
-        attr_accessor :payment_product_id
-
-        # @return [Array<OnlinePayments::SDK::RequestParam>] representing the attributes of this class
-        def to_request_parameters
-          result = []
-          result << RequestParam.new('locale', @locale) unless @locale.nil?
-          result << RequestParam.new('paymentProductId', @payment_product_id.to_s) unless @payment_product_id.nil?
-          result
-        end
-      end
-    end
-  end
-end

data/lib/onlinepayments/sdk/meta_data_provider.rb

@@ -1,150 +0,0 @@
-require 'onlinepayments/sdk/domain/shopping_cart_extension'
-require 'base64'
-
-module OnlinePayments::SDK
-
-  # Manages metadata about the server using the SDK
-  #
-  # @attr_reader [Array<OnlinePayments::SDK::RequestHeader>] meta_data_headers List of headers that should be used in all requests.
-  class MetaDataProvider
-    SDK_VERSION = '0.0.1'.freeze
-    SERVER_META_INFO_HEADER = 'X-GCS-ServerMetaInfo'.freeze
-    PROHIBITED_HEADERS = [SERVER_META_INFO_HEADER,
-                          'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization'].sort!.freeze
-    CHARSET = 'utf-8'.freeze
-
-    # Stores metadata about the server so it can be sent to the Online Payments platform
-    class ServerMetaInfo < DataObject
-      @platform_identifier = nil
-      @sdk_identifier = nil
-      @sdk_creator = nil
-      @integrator = nil
-      @shopping_cart_extension = nil
-
-      # String containing system information (Operating system and Ruby version).
-      attr_accessor :platform_identifier
-
-      # String containing this SDK version.
-      attr_accessor :sdk_identifier
-
-      attr_accessor :sdk_creator
-
-      attr_accessor :integrator
-
-      attr_accessor :shopping_cart_extension
-
-      # Returns the values of all attributes as a hash.
-      def to_h
-        hash = super
-        hash['platformIdentifier'] = @platform_identifier if @platform_identifier
-        hash['sdkIdentifier'] = @sdk_identifier if @sdk_identifier
-        hash['sdkCreator'] = @sdk_creator if @sdk_creator
-        hash['integrator'] = @integrator if @integrator
-        hash['shoppingCartExtension'] = @shopping_cart_extension.to_h if @shopping_cart_extension
-        hash
-      end
-
-      # Initializes the ServerMetaInfo object with properties stored in the parameter hash
-      def from_hash(hash)
-        super
-        @platform_identifier = hash['platformIdentifier'] if hash.has_key? 'platformIdentifier'
-        @sdk_identifier = hash['sdkIdentifier'] if hash.has_key? 'sdkIdentifier'
-        @sdk_creator = hash['sdkCreator'] if hash.has_key? 'sdkCreator'
-        @integrator = hash['integrator'] if hash.has_key? 'integrator'
-        @shopping_cart_extension = Domain::ShoppingCartExtension.new_from_hash(hash['shoppingCartExtension']) if hash.has_key? 'shoppingCartExtension'
-      end
-    end
-
-    # Create a new MetaDataProvider instance that can be used to access platform-related information
-    #
-    # @param integrator                 [String] Name of the integrator
-    # @param shopping_cart_extension    [OnlinePayments::SDK::Domain::ShoppingCartExtension] shopping cart-related metadata.
-    # @param additional_request_headers [Array<OnlinePayments::SDK::RequestHeader>] list of additional headers to include in all requests made.
-    #                                   The following headers are not allowed due to conflicts with already added headers:
-    #                                   'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization' and 'X-GCS-ServerMetaInfo'
-    def initialize(integrator, shopping_cart_extension: nil, additional_request_headers: [].freeze)
-
-      MetaDataProvider.validate_additional_request_headers(additional_request_headers)
-      server_meta_info = ServerMetaInfo.new
-      server_meta_info.platform_identifier = get_platform_identifier
-      server_meta_info.sdk_identifier = get_sdk_identifier
-      server_meta_info.sdk_creator = 'OnlinePayments'
-      server_meta_info.integrator = integrator
-      server_meta_info.shopping_cart_extension = shopping_cart_extension if shopping_cart_extension
-      server_meta_info_string = DefaultImpl::DefaultMarshaller.INSTANCE.marshal(server_meta_info)
-      server_meta_info_header = RequestHeader.new(
-        SERVER_META_INFO_HEADER,
-        Base64.strict_encode64(server_meta_info_string.force_encoding('iso-8859-1').encode(CHARSET)))
-      if additional_request_headers.nil? || additional_request_headers.empty?
-        @meta_data_headers = [server_meta_info_header].freeze
-      else
-        request_headers = [server_meta_info_header]
-        request_headers += additional_request_headers
-        @meta_data_headers = request_headers.freeze
-      end
-    end
-
-    # Checks that none of the {OnlinePayments::SDK::RequestHeaders} in _additional_request_headers_ is equal to any of the forbidden headers.
-    # The forbidden headers are:
-    #'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization' and 'X-GCS-ServerMetaInfo'
-    # If a header is found that is equal to one of the forbidden headers an ArgumentError is raised.
-    def self.validate_additional_request_headers(additional_request_headers)
-      if additional_request_headers
-        additional_request_headers.each { |additional_request_header|
-          validate_additional_request_header(additional_request_header)
-        }
-      end
-    end
-
-    # Checks that the {OnlinePayments::SDK::RequestHeaders} _additional_request_header_ is equal to any of the forbidden headers.
-    # The forbidden headers are:
-    #'X-GCS-Idempotence-Key', 'Date', 'Content-Type', 'Authorization' and 'X-GCS-ServerMetaInfo'
-    # If the header is equal to one of the forbidden headers an ArgumentError is raised.
-    def self.validate_additional_request_header(additional_request_header)
-      if MetaDataProvider.PROHIBITED_HEADERS.include? additional_request_header.name
-        raise ArgumentError, "request header '#{additional_request_header.name}' not allowed"
-      end
-    end
-
-    protected
-
-    # String containing information of the system using the SDK.
-    # It contains data like Operating System version and Ruby version
-    def get_platform_identifier
-      os_host = RbConfig::CONFIG['host_os']
-      if os_host.include? 'mingw'
-        s = 'Windows'
-      elsif os_host.include? 'linux'
-        s = 'Linux'
-      else
-        s = 'Mac OS X'
-      end
-      "#{s}/#{RUBY_DESCRIPTION}"
-    end
-
-    # String describing the version of the SDK being used
-    def get_sdk_identifier
-      "RubyServerSDK/v#{SDK_VERSION}"
-    end
-
-    public
-
-    # Version of this SDK being used
-    def self.SDK_VERSION
-      SDK_VERSION
-    end
-
-    # A {OnlinePayments::SDK::RequestHeader} that contains serialized and encoded {OnlinePayments::SDK::MetaDataProvider::ServerMetaInfo}.
-    def self.SERVER_META_INFO_HEADER
-      SERVER_META_INFO_HEADER
-    end
-
-    # A list of header names that should not be used by any added headers.
-    # These headers are reserved for specific purposes.
-    def self.PROHIBITED_HEADERS
-      PROHIBITED_HEADERS
-    end
-
-    attr_reader :meta_data_headers
-  end
-end

data/lib/onlinepayments/sdk/modules.rb

@@ -1,62 +0,0 @@
-# Main module of this SDK. All non-data classes that are used at multiple places in the SDK are placed in this module.
-module OnlinePayments::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 OnlinePayments::SDK::DefaultImpl
-end
-
-# Container for all data-containing modules.
-# The data-classes contained within can be serialized and communicated with the Online Payments platform.
-# These classes generally contain data used in processing requests or responses.
-module OnlinePayments::SDK::Domain
-end
-
-# Contains all logging-related classes.
-module OnlinePayments::SDK::Logging
-end
-
-# Contains interfaces to all Online Payments services. These services are accessed through a *OnlinePayments::SDK::Client* instance.
-module OnlinePayments::SDK::Merchant
-end
-
-# Contains the client used to access the Hosted Checkout service.
-module OnlinePayments::SDK::Merchant::HostedCheckout
-end
-
-# Contains the client used to access the Hosted Tokenization service.
-module OnlinePayments::SDK::Merchant::HostedTokenization
-end
-
-# Contains the client used to access the Payment service.
-module OnlinePayments::SDK::Merchant::Payments
-end
-
-# Contains the client used to access the Payout service.
-module OnlinePayments::SDK::Merchant::Payouts
-end
-
-# Contains the client used to access the Product Groups service.
-module OnlinePayments::SDK::Merchant::ProductGroups
-end
-
-# Contains the client used to access the Products service.
-module OnlinePayments::SDK::Merchant::Products
-end
-
-# Contains the client to access miscellaneous services.
-module OnlinePayments::SDK::Merchant::Services
-end
-
-# Contains the client used to access the Sessions service.
-module OnlinePayments::SDK::Merchant::Sessions
-end
-
-# Contains the client used to access the Tokens service.
-module OnlinePayments::SDK::Merchant::Tokens
-end
-
-# Contains data classes related to Webhooks functionality.
-module OnlinePayments::SDK::Webhooks
-end

data/lib/onlinepayments/sdk/multipart_form_data_object.rb

@@ -1,44 +0,0 @@
-require 'securerandom'
-
-module OnlinePayments::SDK
-
-  # A representation of a multipart/form-data object
-  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

data/lib/onlinepayments/sdk/multipart_form_data_request.rb

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

data/lib/onlinepayments/sdk/not_found_exception.rb

@@ -1,16 +0,0 @@
-module OnlinePayments::SDK
-
-  # 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

data/lib/onlinepayments/sdk/param_request.rb

@@ -1,11 +0,0 @@
-module OnlinePayments::SDK
-
-  # 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::RequestParam}.
-  class ParamRequest
-    # @return [Array<OnlinePayments::SDK::RequestParam>]
-    def to_request_parameters
-      raise NotImplementedError
-    end
-  end
-end

data/lib/onlinepayments/sdk/payment_platform_exception.rb

@@ -1,15 +0,0 @@
-module OnlinePayments::SDK
-
-  # This exception is thrown when a response from the payment platform indicates that an error occurred
-  # on the payment platform while processing the request.
-  # This corresponds to a HTTP status code of 500 or 502.
-  class PaymentPlatformException < ApiException
-
-    # Create a new PaymentPlatformException
-    # @see ApiException#initialize
-    def initialize(status_code, response_body, error_id, errors,
-                   message = 'the Online Payments platform returned an error response')
-      super(status_code, response_body, error_id, errors, message)
-    end
-  end
-end

data/lib/onlinepayments/sdk/pooled_connection.rb

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