CnpOnline 12.3.0 → 12.8.0

data/out/production/cnp-sdk-for-ruby/CnpXmlMapper.rb

@@ -0,0 +1,71 @@
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+require 'logger'
+
+#
+# Handles round trip of transactions
+# Maps the request to Cnp XML -> Sends XML payload to Cnp via HTTP(S) -> formats XML response into a Ruby hash and returns it
+#
+module CnpOnline
+  class CnpXmlMapper
+    def CnpXmlMapper.request(request_xml, config_hash)
+      logger = initialize_logger(config_hash)
+
+      logger.debug request_xml
+      # get the Cnp Online Response from the API server over HTTP
+      response_xml = Communications.http_post(request_xml,config_hash)
+      logger.debug response_xml
+
+      # create response object from xml returned form the Cnp API
+      response_object = XMLObject.new(response_xml)
+      
+      # Check if the response xml is valid.
+      if (response_object.response == "0")
+        return response_object
+      else
+        raise("Error with http response, code: " + response_object.response + ", message: " + response_object.message)
+      end
+      
+      return response_object
+    end
+
+    private
+
+    def self.initialize_logger(config_hash)
+      # Sadly, this needs to be static (the alternative would be to change the CnpXmlMapper.request API
+      # to accept a Configuration instance instead of the config_hash)
+      Configuration.logger ||= default_logger config_hash['printxml'] ? Logger::DEBUG : Logger::INFO
+    end
+
+    def self.default_logger(level) # :nodoc:
+      logger = Logger.new(STDOUT)
+      logger.level = level
+      # Backward compatible logging format for pre 8.16
+      logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+      logger
+    end
+  end
+end

data/out/production/cnp-sdk-for-ruby/CommManager.rb

@@ -0,0 +1,185 @@
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+
+module CnpOnline
+  class CommManager
+    attr_reader :REQUEST_RESULT_RESPONSE_RECEIVED, :REQUEST_RESULT_CONNECTION_FAILED, :REQUEST_RESULT_RESPONSE_TIMEOUT,
+                :multiSite, :legacyUrl, :multiSiteThreshold, :multiSiteUrls, :maxHoursWithoutSwitch, :currentMultiSiteUrlIndex,
+                :errorCount, :lastSiteSwitchTime
+    attr_writer :lastSiteSwitchTime
+
+    @@manager = nil
+
+    def manager
+      @@manager
+    end
+
+    def self.manager
+      @@manager
+    end
+
+
+    def initialize(config)
+      @REQUEST_RESULT_RESPONSE_RECEIVED = 1
+      @REQUEST_RESULT_CONNECTION_FAILED = 2
+      @REQUEST_RESULT_RESPONSE_TIMEOUT = 3
+
+      @config_hash = config
+      @multiSite = @config_hash['multiSite'] != nil ? @config_hash['multiSite'] : false
+      @legacyUrl = @config_hash['url']
+      @multiSiteUrls = Array.new
+      @errorCount = 0
+      @currentMultiSiteUrlIndex = 0
+      @multiSiteThreshold = 5
+      @lastSiteSwitchTime = 0
+      # @maxHoursWithoutSwitch = @config_hash['maxsHoursWithoutSwitch']
+      @maxHoursWithoutSwitch = 48
+      @printDebug = @config_hash['printMultiSiteDebug'] #get false as default
+
+
+      if (to_boolean(@multiSite))
+
+        for i in 1..2 do
+          @siteUrl = @config_hash["multSiteUrl" + i.to_s]
+          if (@siteUrl == '' || @siteUrl == nil)
+            break
+          end
+          @multiSiteUrls << @siteUrl
+        end
+
+          if (@multiSiteUrls.length == 0)
+            @multiSite = false
+          else
+            @multiSiteUrls.shuffle
+            @currentMultiSiteUrlIndex = 0
+            @errorCount = 0
+
+            _threshold = @config_hash['multiSiteThreshold']
+            if (_threshold != nil)
+              if (_threshold > 0 && _threshold < 100)
+                @multiSiteThreshold = _threshold
+              end
+            end
+
+            _maxHours = @config_hash['maxsHoursWithoutSwitch']
+            if (_maxHours != nil)
+              if (_maxHours >= 0 && _maxHours < 300)
+                @maxHoursWithoutSwitch = _maxHours
+              end
+            end
+
+            @lastSiteSwitchTime = Time.now.to_i * 1000
+          end
+        # end
+      end
+    end
+
+
+    def self.instance(config)
+      if (@@manager == nil)
+        @@manager = CommManager.new(config)
+      end
+      return @@manager
+    end
+
+    def self.reset
+      @@manager = nil
+    end
+
+    def findUrl()
+
+      _url = @legacyUrl
+      if (to_boolean(@multiSite))
+        _switchSite = false
+        _switchReason = ''
+        _currentUrl = @multiSiteUrls.at(@currentMultiSiteUrlIndex)
+
+        if (@errorCount < @multiSiteThreshold)
+          if (@maxHoursWithoutSwitch > 0)
+            _diffSinceSwitch = ((Time.now.to_i * 1000) - @lastSiteSwitchTime) / 3600
+            if (_diffSinceSwitch > @maxHoursWithoutSwitch)
+              _switchReason = " more than " + @maxHoursWithoutSwitch.to_s + " hours since last switch"
+              _switchSite = true
+            end
+          end
+        else
+        _switchReason = " consecutive error count has reach threshold of " + @multiSiteThreshold.to_s
+        _switchSite = true
+        end
+
+        if (_switchSite)
+        @currentMultiSiteUrlIndex += 1
+          if (@currentMultiSiteUrlIndex >= @multiSiteUrls.length)
+            @currentMultiSiteUrlIndex = 0
+          end
+
+          _url = @multiSiteUrls.at(@currentMultiSiteUrlIndex)
+          @errorCount = 0
+
+          if (@printDebug)
+           #print debug here
+          end
+        else
+          _url = _currentUrl
+       end
+
+        if (@printDebug)
+         #print some debug
+       end
+      end
+
+      return RequestTarget.new(_url, @currentMultiSiteUrlIndex)
+    end
+
+    def reportResult(target, result, statusCode)
+      if (target.requestTime < @lastSiteSwitchTime || !@multiSite)
+        return
+      end
+
+      case(result)
+      when @REQUEST_RESULT_RESPONSE_RECEIVED
+        if (statusCode == 200)
+          @errorCount = 0
+        elsif (statusCode >= 400)
+          @errorCount += 1
+        end
+      when @REQUEST_RESULT_CONNECTION_FAILED
+        @errorCount += 1
+      when @REQUEST_RESULT_RESPONSE_TIMEOUT
+        @errorCount += 1
+      end
+    end
+
+    private
+    def to_boolean(str)
+      if str.instance_of? String
+        str == 'true'
+      else
+        return str
+      end
+    end
+  end
+end

data/out/production/cnp-sdk-for-ruby/Communications.rb

@@ -0,0 +1,90 @@
+=begin
+Copyright (c) 2017 Vantiv eCommerce
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+=end
+
+#
+# Used for all transmission to Cnp over HTTP or HTTPS
+# works with or without an HTTP proxy
+#
+# URL and proxy server settings are derived from the configuration file
+#
+
+module CnpOnline
+  class Communications
+    ##For http or https post with or without a proxy
+    def Communications.http_post(post_data,config_hash)
+  
+      proxy_addr = config_hash['proxy_addr']
+      proxy_port = config_hash['proxy_port']
+      _commManager = CommManager.instance(Configuration.new.config)
+      _requestTarget = _commManager.findUrl
+
+      #cnp_url = config_hash['url']
+  
+      # setup https or http post
+      url = URI.parse(_requestTarget.targetUrl)
+  
+      response_xml = nil
+      https = Net::HTTP.new(url.host, url.port, proxy_addr, proxy_port)
+      if(url.scheme == 'https') 
+        https.use_ssl = url.scheme=='https'
+        https.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        https.ca_file = File.join(File.dirname(__FILE__), "cacert.pem")
+      end
+      https.start { |http|
+        response = http.request_post(url.path, post_data.to_s, {'Content-Type'=>'text/xml; charset=UTF-8','Connection'=>'close'})
+        response_xml = response
+        CommManager.instance(Configuration.new.config).reportResult(_requestTarget, _commManager.REQUEST_RESULT_RESPONSE_RECEIVED, response.code)
+      }
+  
+      # validate response, only an HTTP 200 will work, redirects are not followed
+      case response_xml
+      when Net::HTTPOK
+        return response_xml.body
+      else
+        raise("Error with http http_post_request, code:" + response_xml.header.code)
+      end
+    end
+  end
+end
+
+=begin
+ NOTES ON HTTP TIMEOUT
+
+  Vantiv eCommerce optimizes our systems to ensure the return of responses as quickly as possible, some portions of the process are beyond our control.
+  The round-trip time of an Authorization can be broken down into three parts, as follows:
+    1.  Transmission time (across the internet) to Vantiv eCommerce and back to the merchant
+    2.  Processing time by the authorization provider
+    3.  Processing time by Cnp 
+  Under normal operating circumstances, the transmission time to and from Cnp does not exceed 0.6 seconds 
+  and processing overhead by Cnp occurs in 0.1 seconds. 
+  Typically, the processing time by the card association or authorization provider can take between 0.5 and 3 seconds,
+  but some percentage of transactions may take significantly longer.
+ 
+  Because the total processing time can vary due to a number of factors, Vantiv eCommerce recommends using a minimum timeout setting of
+  60 seconds to accomodate Sale transactions and 30 seconds if you are not utilizing Sale tranactions.
+
+  These settings should ensure that you do not frequently disconnect prior to receiving a valid authorization causing dropped orders 
+  and/or re-auths and duplicate auths.
+=end

data/out/production/cnp-sdk-for-ruby/Configuration.rb

@@ -0,0 +1,75 @@
+# Copyright (c) 2017 Vantiv eCommerce
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+
+require 'yaml'
+require_relative 'EnvironmentVariables'
+
+#
+# Loads the configuration from a file
+#
+module CnpOnline
+  class Configuration
+    class << self
+      # External logger, if specified
+      attr_accessor :logger
+    end
+
+    def config
+      if !ENV['CNP_CONFIG_DIR'].nil?
+        config_file = ENV['CNP_CONFIG_DIR'] + '/.cnp_SDK_config.yml'
+      else
+        config_file = ENV['HOME'] + '/.cnp_SDK_config.yml'
+      end
+
+      datas = {}
+      # if Env variable exist, then just override the data from config file
+      if File.exist?(config_file)
+        datas = YAML.load_file(config_file)
+      end
+
+      environments = EnvironmentVariables.new
+      environments.instance_variables.each do |var|
+        if datas[var.to_s.delete('@')].nil?
+          datas[var.to_s.delete('@')] = environments.instance_variable_get(var)
+        end
+      end
+      datas.each { |key, _value| setENV(key, datas) }
+      return datas
+    rescue
+      return {}
+    end
+
+    def setENV(key, datas)
+      val = ENV['cnp_' + key]
+      if !val.nil?
+        if val == 'true'
+          datas[key] = true
+        elsif val == 'false'
+          datas[key] = false
+        else
+          datas[key] = val
+        end
+      end
+    end
+  end
+end

data/out/production/cnp-sdk-for-ruby/EnvironmentVariables.rb

@@ -0,0 +1,33 @@
+module CnpOnline
+  class EnvironmentVariables
+    def initialize
+      # load configuration data
+      @user = ''
+      @password = ''
+      @currency_merchant_map = ''
+      @default_report_group = 'Default Report Group'
+      @url = ''
+      @proxy_addr = nil
+      @proxy_port = nil
+      @sftp_username = ''
+      @sftp_password = ''
+      @sftp_url = ''
+      @fast_url = ''
+      @fast_port = ''
+      @printxml = false
+      @timeout = 65
+      @deleteBatchFiles = false
+      @useEncryption = false
+      @vantivPublicKeyID = ''
+      @passphrase = ''
+      @multiSiteUrl1 = ''
+      @multiSiteUrl2 = ''
+      @multiSite = false
+      @printMultiSiteDebug = false
+      @multiSiteErrorThreshold = 5
+      @maxsHoursWithoutSwitch = 48
+
+
+    end
+  end
+end