CnpOnline 8.31.0

data/bin/Setup.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+# Copyright (c) 2011 Litle & Co.
+#
+# 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.
+
+# make setup file executable
+
+#
+# Configuration generation for URL and credentials
+#
+class Setup
+  attr_reader :handle, :path
+  def initialize(filename)
+    @handle = File.new(filename, File::CREAT | File::TRUNC | File::RDWR, 0o600)
+    File.open(filename, 'w') do |f|
+      puts 'Welcome to Litle Ruby_SDK'
+      puts 'Please input your user name:'
+      f.puts 'user: ' + gets
+      puts 'Please input your password:'
+      f.puts	'password: ' + gets
+      puts 'Please input your merchantId:'
+
+      f.puts 'currency_merchant_map:'
+      f.puts '  DEFAULT: ' + gets
+      f.puts "default_report_group: 'Default Report Group'"
+
+      puts "Please choose Litle url from the following list (example: 'prelive') or directly input another URL:
+sandbox => https://www.testvantivcnp.com/sandbox/communicator/online
+prelive => https://payments.vantivprelive.com/vap/communicator/online
+postlive => https://payments.vantivpostlive.com/vap/communicator/online
+production => https://payments.vantivcnp.com/vap/communicator/online
+transact_prelive => https://transact.vantivprelive.com/vap/communicator/online
+transact_postlive => https://transact.vantivpostlive.com/vap/communicator/online
+transact_production => https://transact.vantivcnp.com/vap/communicator/online"
+      f.puts 'url: ' + Setup.choice(gets)
+      puts 'Please input the proxy address, if no proxy hit enter key: '
+      f.puts	'proxy_addr: ' + gets
+      puts 'Please input the proxy port, if no proxy hit enter key: '
+      f.puts	'proxy_port: ' + gets
+      puts 'Please input your sFTP username for batch processing; if no sFTP, hit enter key: '
+      f.puts 'sftp_username: ' + gets
+      puts 'Please input your sFTP password for batch processing; if no sFTP, hit enter key: '
+      f.puts 'sftp_password: ' + gets
+      puts 'Please input your sFTP url for batch processing; if no sFTP, hit enter key: '
+      f.puts 'sftp_url: ' + gets
+      puts 'Please input your url for fast batch processing; if no fast batch, hit enter key: '
+      f.puts 'fast_url: ' + gets
+      puts 'Please input your port for fast batch processing; if no fast batch, hit enter key: '
+      f.puts 'fast_port: ' + gets
+
+      f.puts 'printxml: false'
+      # default http timeout set to 500 ms
+      f.puts 'timeout: 500'
+    end
+  end
+
+  def finished
+    @handle.close
+  end
+
+  def self.choice(litle_env)
+    litle_online_ctx = 'vap/communicator/online'
+    if litle_env == "sandbox\n"
+      return 'https://www.testvantivcnp.com/sandbox/communicator/online'
+    elsif litle_env == "prelive\n"
+      return 'https://payments.vantivprelive.com/' + litle_online_ctx
+    elsif litle_env == "postlive\n"
+      return 'https://payments.vantivpostlive.com/' + litle_online_ctx
+    elsif litle_env == "production\n"
+      return 'https://payments.vantivcnp.com/' + litle_online_ctx
+    elsif litle_env == "transact_production\n"
+      return 'https://transact.vantivcnp.com/' + litle_online_ctx
+    elsif litle_env == "transact_prelive\n"
+      return 'https://transact.vantivprelive.com/' + litle_online_ctx
+    elsif litle_env == "transact_postlive\n"
+      return 'https://transact.vantivpostlive.com/' + litle_online_ctx
+    else
+      return 'https://www.testvantivcnp.com/sandbox/communicator/online'
+    end
+  end
+end
+
+#
+#
+# Optionally enable the configuration to reside in a custom location
+# if the $LITLE_CONFIG_DIR directory is set
+#
+
+# make the config.yml file in the LITLE_CONFIG_DIR directory or HOME directory
+path = if !ENV['LITLE_CONFIG_DIR'].nil?
+         ENV['LITLE_CONFIG_DIR']
+       else
+         ENV['HOME']
+       end
+
+# make the config.yml file hidden
+# create a config file contain all the configuration data
+config_file = path + '/.litle_SDK_config.yml'
+f = Setup.new(config_file)
+
+# return the path of the config file and the path file
+@path = File.expand_path(config_file)
+puts 'The Litle configuration file has been generated, the file is located at: ' + @path
+f.finished

data/bin/sample_batch_driver.rb

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+=begin
+Copyright (c) 2011 Litle & Co.
+
+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
+
+#Sample Driver
+require_relative '../lib/LitleOnline'
+
+saleHash = {
+        'reportGroup'=>'Planets',
+        'id' => '006',
+        'orderId'=>'12344',
+        'amount'=>'6000',
+        'orderSource'=>'ecommerce',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}     
+      
+accountUpdateHash = {
+        'reportGroup'=>'Planets',
+        'id'=>'12345',
+        'customerId'=>'0987',
+        'orderId'=>'1234',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}
+      
+rfrHash = {
+        'merchantId'=>101,
+        'postDay'=>'2013-06-04'  
+}
+      
+path = Dir.pwd
+
+request = LitleOnline::LitleRequest.new({'sessionId'=>'8675309'})
+  
+request.create_new_litle_request(path)
+puts "Created new LitleRequest at location: " + path
+start = Time::now
+#create five batches, each with 10 sales
+#5.times{
+  batch = LitleOnline::LitleBatchRequest.new
+  batch.create_new_batch(path)
+
+  #add the same sale ten times
+  #10.times{
+    batch.sale(saleHash)
+  #}
+  batch.account_update(accountUpdateHash)
+
+  #close the batch, indicating we plan to add no more transactions
+  batch.close_batch()
+  #add the batch to the LitleRequest
+  request.commit_batch(batch)
+#}
+
+request.add_rfr_request(rfrHash)
+
+
+ 
+# puts "Finished adding batches to LitleRequest at " + request.get_path_to_batches
+#finish the Litle Request, indicating we plan to add no more batches
+request.finish_request
+puts "Generated final XML markup of the LitleRequest"
+ 
+#send the batch files at the given directory over sFTP
+request.send_to_litle
+puts "Dropped off the XML of the LitleRequest over FTP"
+#grab the expected number of responses from the sFTP server and save them to the given path
+request.get_responses_from_server()
+puts "Received the LitleRequest responses from the server"
+#process the responses from the server with a listener which applies the given block
+start = Time::now
+request.process_responses({:transaction_listener => LitleOnline::DefaultLitleListener.new do |transaction|
+  type = transaction["type"]
+  #if we're dealing with a saleResponse (check the Litle XML Reference Guide!)
+  if(type == "saleResponse") then
+    #grab an attribute of the parent of the response
+    puts "Report Group: " + transaction["reportGroup"]
+    
+    #grab some child elements of the transaction
+    puts "Litle Txn Id: " + transaction["litleTxnId"]
+    puts "Order Id: " + transaction["orderId"]
+    puts "Response: " + transaction["response"]
+    
+    #grab a child element of a child element of the transation
+    puts "AVS Result: " + transaction["fraudResult"]["avsResult"]
+    puts "Token Response Message: " + transaction["tokenResponse"]["tokenMessage"] 
+  end
+  
+  if(type == "RFRResponse") then
+    puts "RFR Response Code: " + transaction["response"]
+    puts "RFR Response Message: " + transaction["message"]  
+  end 
+end})
+stop = Time::now
+puts "Total time: " + (stop - start).to_s
+

data/bin/sample_driver.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+=begin
+Copyright (c) 2011 Litle & Co.
+
+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
+
+#Sample Driver
+#require 'LitleOnline'
+#include LitleOnline
+require_relative '../lib/LitleOnline'
+hash = {
+  'reportGroup'=>'product1',
+  'orderId'=>'12344',
+  'card'=>{
+    'type'=>'VI',
+    'number' =>'4100000000000001',
+    'expDate' =>'1210'
+    },
+  'orderSource'=>'ecommerce',
+  'amount'=>'106'
+}
+
+#perform credit transaction
+response= LitleOnline::LitleOnlineRequest.new.credit(hash)
+
+#display results
+puts "Message: "+response.message
+puts "Litle Transaction ID: "+response.creditResponse.litleTxnId

data/lib/Communications.rb

@@ -0,0 +1,85 @@
+=begin
+Copyright (c) 2011 Litle & Co.
+
+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 Litle over HTTP or HTTPS
+# works with or without an HTTP proxy
+#
+# URL and proxy server settings are derived from the configuration file
+#
+module LitleOnline
+  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']
+      litle_url = config_hash['url']
+  
+      # setup https or http post
+      url = URI.parse(litle_url)
+  
+      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','Connection'=>'close'})
+        response_xml = response
+      }
+  
+      # 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
+
+  Litle & Co. 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 Litle & Co. and back to the merchant
+    2.  Processing time by the authorization provider
+    3.  Processing time by Litle 
+  Under normal operating circumstances, the transmission time to and from Litle does not exceed 0.6 seconds 
+  and processing overhead by Litle 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, Litle & Co. 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/lib/Configuration.rb

@@ -0,0 +1,67 @@
+=begin
+Copyright (c) 2011 Litle & Co.
+
+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 'yaml'
+#
+# Loads the configuration from a file
+#
+module LitleOnline
+  class Configuration
+    class << self
+      # External logger, if specified
+      attr_accessor :logger
+    end
+
+    def config
+      begin
+        if !(ENV['LITLE_CONFIG_DIR'].nil?)
+          config_file = ENV['LITLE_CONFIG_DIR'] + "/.litle_SDK_config.yml"
+        else
+          config_file = ENV['HOME'] + "/.litle_SDK_config.yml"        
+        end
+        #if Env variable exist, then just override the data from config file
+         if (File.exists?(config_file))
+          datas=YAML.load_file(config_file)  
+         else         
+          environments = EnvironmentVariables.new   
+          datas={}
+          environments.instance_variables.each {|var| datas[var.to_s.delete("@")] = environments.instance_variable_get(var) }          
+         end
+          datas.each {|key,value| setENV(key,datas)}                      
+        return datas
+      rescue   
+        return {}
+      end
+  
+    end
+    def setENV(key,datas)
+      if !(ENV['litle_'+key].nil?)
+       datas[key]=ENV['litle_'+key]
+      end
+    end
+    
+  end
+
+end