CnpOnline 12.3.0 → 12.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cef590b8463a6f6118c20299168b6031a8fa03233274457f257e30ba35d49d2
-  data.tar.gz: b5ea9c7fbebe24a1fa599420eec7afe016ce5a82351d4cd1baf88d276fc64523
+  metadata.gz: 6d0c5b65177dba187096e279852c2b9e6d3b0dce579078a9753dec101b2cbe45
+  data.tar.gz: e3ac1e9a6d6885938c1edca85c7078a58ed4101fe4ad2b3d4c6f9c901141bb08
 SHA512:
-  metadata.gz: 00e1f8333670f342d9c2539a89d65d5a63609d2163758373d03f5171f51ed449b9ef0d0be25168ee00cb4d5c9d4dc92ddeed072ef1d370111268c1f3355005b0
-  data.tar.gz: ad514732266f706a30b9751ebb9eaaeac6ef0f3d2cf1776ab148cdbd9ff3b6a0153a91461b2a8af6ad2194f1a812717cc31035ae5c89ae2fcd18b31ff9ae9cc4
+  metadata.gz: 0e7a5e5960163256e9130ae3c0750b62c1c05e7f62fa1baf103e9c9a4535d8dec3b1dbeca11aa8f1358f85ddde950ae548c99e1f0451399b61a875101193f057
+  data.tar.gz: fd4220cd5c0032a1f465af9606639c7d69549587d0fd045ed7bbeb36c80abedb7e229eb268c9aceff046f38c1bc475915dcd7ba03465ae5b08d3658b9f769f9d

data/CHANGELOG

@@ -1,3 +1,15 @@
+==Version 12.8.0 (June 19, 2019)
+* Feature: Full functions for XML v12.8 
+* Feature: added support for new type: tokenUrl
+* Feature: add support for new type: echeckTypeCtx
+* Feature: add 4 new types in cnpBatch: vendorCreditCtx, vendorDebitCtx, submerchantCreditCtx, submerchantDebitCtx
+* Feature: add support for multiSite functionality
+* Feature: add a new type: encryptedCcAccountNumberType
+* Feature: add support for encryption on registerTokenRequestType
+* Feature: add paymentAccountReferenceNumber in authorizationResponse and saleResponse
+* Feature: add disbursementTypeEnum in fastAccessFunding
+
+
 ==Version 12.3.0 (May 10, 2018)
 *Feature: Added LodgingInfo support
 *Feature: Added TranslateToLowTokenValue support

data/Rakefile

@@ -32,7 +32,7 @@ spec = Gem::Specification.new do |s|
   s.description = File.read(File.join(File.dirname(__FILE__), 'DESCRIPTION'))
   s.requirements =
     ['Contact sdksupport@vantiv.com for more information']
-  s.version = '12.3.0'
+  s.version = '12.8.0'
   s.author = 'Vantiv - eCommerce'
   s.email = 'sdksupport@vantiv.com'
   s.homepage = 'https://developer.vantiv.com/community/ecommerce/pages/sdks#jive_content_id_Ruby_SDK'

data/lib/CnpBatchRequest.rb

@@ -397,11 +397,11 @@ module CnpOnline
     end
 
     def submerchant_credit(options)
-      transaction = @cnp_txn.submerchant_credit(options)
+      transaction = @cnp_txn.submerchant_credit_ctx(options)
       @txn_counts[:submerchantCredit][:numSubmerchantCredit] += 1
       @txn_counts[:submerchantCredit][:submerchantCreditAmount] += options['amount'].to_i
 
-      add_txn_to_batch(transaction, :submerchantCredit, options)
+      add_txn_to_batch(transaction, :submerchantCreditCtx, options)
     end
 
     def reserve_credit(options)
@@ -413,11 +413,11 @@ module CnpOnline
     end
 
     def vendor_credit(options)
-      transaction = @cnp_txn.vendor_credit(options)
+      transaction = @cnp_txn.vendor_credit_ctx(options)
       @txn_counts[:vendorCredit][:numVendorCredit] += 1
       @txn_counts[:vendorCredit][:vendorCreditAmount] += options['amount'].to_i
 
-      add_txn_to_batch(transaction, :vendorCredit, options)
+      add_txn_to_batch(transaction, :vendorCreditCtx, options)
     end
 
     def physical_check_credit(options)
@@ -450,11 +450,11 @@ module CnpOnline
     end
 
     def submerchant_debit(options)
-      transaction = @cnp_txn.submerchant_debit(options)
+      transaction = @cnp_txn.submerchant_debit_ctx(options)
       @txn_counts[:submerchantDebit][:numSubmerchantDebit] += 1
       @txn_counts[:submerchantDebit][:submerchantDebitAmount] += options['amount'].to_i
 
-      add_txn_to_batch(transaction, :submerchantDebit, options)
+      add_txn_to_batch(transaction, :submerchantDebitCtx, options)
     end
 
     def reserve_debit(options)
@@ -466,11 +466,11 @@ module CnpOnline
     end
 
     def vendor_debit(options)
-      transaction = @cnp_txn.vendor_debit(options)
+      transaction = @cnp_txn.vendor_debit_ctx(options)
       @txn_counts[:vendorDebit][:numVendorDebit] += 1
       @txn_counts[:vendorDebit][:vendorDebitAmount] += options['amount'].to_i
 
-      add_txn_to_batch(transaction, :vendorDebit, options)
+      add_txn_to_batch(transaction, :vendorDebitCtx, options)
     end
 
     def physical_check_debit(options)
@@ -502,6 +502,10 @@ module CnpOnline
       return @txn_counts
     end
 
+    def get_num_transactions
+      return @txn_counts[:total]
+    end
+
     def get_batch_name
       return @path_to_batch
     end
@@ -515,6 +519,7 @@ module CnpOnline
     def add_txn_to_batch(transaction, type, options)
       @txn_counts[:total] += 1
       xml = transaction.save_to_xml.to_s
+
       File.open(@txn_file, 'a+') do |file|
         file.write(xml)
       end
@@ -730,6 +735,10 @@ module CnpOnline
       return @txn_counts
     end
 
+    def get_num_transactions
+      return @txn_counts[:total]
+    end
+
     def get_batch_name
       return @path_to_batch
     end

data/lib/CnpOnline.rb

@@ -54,6 +54,8 @@ require_relative 'CnpOnlineRequest'
 require_relative 'CnpRequest'
 require_relative 'CnpListeners'
 require_relative 'Configuration'
+require_relative 'CommManager'
+require_relative 'RequestTarget'
 
 #allows attribute values to be in double quotes, required by Cnp Server
 REXML::Attribute.class_eval( %q^

data/lib/CnpOnlineRequest.rb

@@ -272,6 +272,31 @@ module CnpOnline
       commit(transaction, :fraudCheck, options)
     end
 
+    def vendor_credit(options)
+      transaction = @cnp_transaction.vendor_credit(options)
+
+      commit(transaction, :vendorCredit, options)
+    end
+
+    def vendor_debit(options)
+      transaction = @cnp_transaction.vendor_debit(options)
+
+      commit(transaction, :vendorDebit, options)
+    end
+
+    def submerchant_credit(options)
+      transaction = @cnp_transaction.submerchant_credit(options)
+
+      commit(transaction, :submerchantCredit, options)
+    end
+
+    def submerchant_debit(options)
+      transaction = @cnp_transaction.submerchant_debit(options)
+
+      commit(transaction, :submerchantDebit, options)
+    end
+
+
     private
 
     def add_account_info(transaction, options)
@@ -295,7 +320,7 @@ module CnpOnline
 
       request.authentication  = authentication
       request.merchantId      = get_merchant_id(options)
-      request.version         = '12.3'
+      request.version         = '12.8'
       request.loggedInUser    = get_logged_in_user(options)
       request.xmlns           = "http://www.vantivcnp.com/schema"
       request.merchantSdk     = get_merchant_sdk(options)
@@ -310,6 +335,7 @@ module CnpOnline
       add_account_info(transaction, options)
       request.send(:"#{type}=", transaction)
 
+
       xml = request.save_to_xml.to_s
       CnpXmlMapper.request(xml, @config_hash)
     end
@@ -318,6 +344,7 @@ module CnpOnline
       @config_hash['proxy_addr'] = options['proxy_addr'] unless options['proxy_addr'].nil?
       @config_hash['proxy_port'] = options['proxy_port'] unless options['proxy_port'].nil?
       @config_hash['url']        = options['url']        unless options['url'].nil?
+      @config_hash['multiSite']  = options['multiSite']  unless options['multiSite'].nil?
     end
 
     def get_merchant_id(options)
@@ -325,7 +352,7 @@ module CnpOnline
     end
 
     def get_merchant_sdk(options)
-      options['merchantSdk'] || 'Ruby;12.3'
+      options['merchantSdk'] || 'Ruby;12.8'
     end
 
     def get_report_group(options)
@@ -339,5 +366,6 @@ module CnpOnline
     def get_logged_in_user(options)
       options['loggedInUser'] || nil
     end
+
   end
 end

data/lib/CnpRequest.rb

@@ -207,7 +207,7 @@ module CnpOnline
       cnpRequest.authentication = authentication
       cnpRequest.numBatchRequests = "0"
       
-      cnpRequest.version         = '12.3'
+      cnpRequest.version         = '12.8'
       cnpRequest.xmlns           = "http://www.vantivcnp.com/schema"
 
       
@@ -248,24 +248,31 @@ module CnpOnline
     # +options+:: An (option) +Hash+ containing the username, password, and URL to attempt to sFTP to.
     # If not provided, the values will be populated from the configuration file.
     def send_to_cnp(path = (File.dirname(@path_to_batches)), options = {})
+
       use_encryption = get_config(SFTP_USE_ENCRYPTION_CONFIG_NAME, options)
       username = get_config(SFTP_USERNAME_CONFIG_NAME, options)
       password = get_config(SFTP_PASSWORD_CONFIG_NAME, options)
       delete_batch_files = get_config(SFTP_DELETE_BATCH_FILES_CONFIG_NAME, options)
       url = get_config(SFTP_URL_CONFIG_NAME, options)
 
+
+
       if(username == nil or password == nil or url == nil) then
         raise ArgumentError, "You are not configured to use sFTP for batch processing. Please run /bin/Setup.rb again!"
       end
       path = path_to_requests = prepare_for_sftp(path, use_encryption)
 
+
       if use_encryption
         encrypted_path = path_to_requests + ENCRYPTED_PATH_DIR
         encrypt_request_files(path, encrypted_path, options)
         path_to_requests = encrypted_path
       end
 
+
+
       @responses_expected = upload_to_sftp(path_to_requests, url, username, password, use_encryption)
+
       if delete_batch_files
         delete_files_in_path(path_to_requests, /#{REQUEST_FILE_PREFIX}\d+#{COMPLETE_FILE_SUFFIX}#{ENCRYPTED_FILE_SUFFIX}?#{SENT_FILE_SUFFIX}\z/)
         if use_encryption
@@ -300,7 +307,7 @@ module CnpOnline
           
       Dir.foreach(path) do |filename|
         if((filename =~ /#{REQUEST_FILE_PREFIX}\d+#{COMPLETE_FILE_SUFFIX}\z/) != nil) then
-          begin 
+          begin
             socket = TCPSocket.open(url,port.to_i)
             ssl_context = OpenSSL::SSL::SSLContext.new()
             ssl_context.ssl_version = :SSLv23
@@ -349,6 +356,7 @@ module CnpOnline
         response_path += ENCRYPTED_PATH_DIR
       end
 
+
       download_from_sftp(response_path, url, username, password)
 
       if use_encryption
@@ -361,6 +369,7 @@ module CnpOnline
     # for a transaction listener (see +DefaultCnpListener+). It may also include a batch listener and a
     # custom path where response files from the server are located (if it is not provided, we'll guess the position)
     def process_responses(args)
+
       #the transaction listener is required
       if(!args.has_key?(:transaction_listener)) then
         raise ArgumentError, "The arguments hash must contain an entry for transaction listener!"
@@ -371,7 +380,7 @@ module CnpOnline
       path_to_responses = args[:path_to_responses] ||= (File.dirname(@path_to_batches) + '/' + RESPONSE_PATH_DIR)
       delete_batch_files = args[:deleteBatchFiles] ||= get_config(:deleteBatchFiles, args)
       #deleteBatchFiles = get_config(:deleteBatchFiles, args)
-      
+
       Dir.foreach(path_to_responses) do |filename|
         if ((filename =~ /#{RESPONSE_FILE_PREFIX}\d+#{COMPLETE_FILE_SUFFIX}.asc#{RECEIVED_FILE_SUFFIX}\z/) != nil) then
           process_response(path_to_responses + filename, transaction_listener, batch_listener)
@@ -392,6 +401,7 @@ module CnpOnline
     # Note that this will om-nom-nom quite a bit of memory    
     def process_response(path_to_response, transaction_listener, batch_listener = nil)
       reader = LibXML::XML::Reader.file(path_to_response)
+
       reader.read # read into the root node
       #if the response attribute is nil, we're dealing with an RFR and everything is a-okay
       if reader.get_attribute('response') != "0" and reader.get_attribute('response') != nil then
@@ -459,7 +469,7 @@ module CnpOnline
       authentication.password = get_config(:password, options)
 
       cnp_request.authentication = authentication
-      cnp_request.version         = '12.3'
+      cnp_request.version         = '12.8'
       cnp_request.xmlns           = "http://www.vantivcnp.com/schema"
       # cnp_request.id              = options['sessionId'] #grab from options; okay if nil
       cnp_request.numBatchRequests = @num_batch_requests
@@ -535,10 +545,14 @@ module CnpOnline
     def upload_to_sftp(path_to_requests, url, username, password, use_encryption)
     begin
       responses_expected = 0
+
       Net::SFTP.start(url, username, :password => password) do |sftp|
+
         Dir.foreach(path_to_requests) do |filename|
           if (filename =~ /#{REQUEST_FILE_PREFIX}\d+#{COMPLETE_FILE_SUFFIX}((#{ENCRYPTED_FILE_SUFFIX})?)\z/) != nil
+
             new_filename = filename + '.prg'
+
             File.rename(path_to_requests + filename, path_to_requests + new_filename)
             # upload the file
             sftp.upload!(path_to_requests + new_filename, '/inbound/' + new_filename)
@@ -554,6 +568,7 @@ module CnpOnline
           end
         end
       end
+
       return responses_expected
     rescue Net::SSH::AuthenticationFailed
       raise ArgumentError, "The sFTP credentials provided were incorrect. Try again!"
@@ -564,13 +579,18 @@ module CnpOnline
     responses_grabbed = 0
     begin
       #wait until a response has a possibility of being there?
+
       sleep(@POLL_DELAY)
+
       time_begin = Time.now
       Net::SFTP.start(url, username, :password => password) do |sftp|
         while((Time.now - time_begin) < @RESPONSE_TIME_OUT  && responses_grabbed < @responses_expected)
           #sleep for 60 seconds, ¿no es bueno?
           sleep(60)
+
+
           sftp.dir.foreach('/outbound/') do |entry|
+
             if (entry.name =~ /#{REQUEST_FILE_PREFIX}\d+#{COMPLETE_FILE_SUFFIX}((#{ENCRYPTED_FILE_SUFFIX})?).asc\z/) != nil then
               response_filename = response_path + entry.name.gsub(REQUEST_FILE_PREFIX, RESPONSE_FILE_PREFIX) + RECEIVED_FILE_SUFFIX
               sftp.download!('/outbound/' + entry.name, response_filename)

data/lib/CnpTransaction.rb

@@ -38,6 +38,11 @@ module CnpOnline
       transaction.submerchantName = options['submerchantName']
       transaction.fundsTransferId = options['fundsTransferId']
       transaction.amount = options['amount']
+      if(options['disbursementType'])
+        transaction.disbursementType = options['disbursementType']
+      else
+        transaction.disbursementType = "VMD"
+      end
       if(options['card'])
         transaction.card = Card.from_hash(options)
       end
@@ -372,11 +377,16 @@ module CnpOnline
     def register_token_request(options)
       transaction = RegisterTokenRequest.new
 
-      transaction.orderId               = options['orderId']
-      transaction.accountNumber         = options['accountNumber']
-      transaction.echeckForToken        = EcheckForToken.from_hash(options)
-      transaction.paypageRegistrationId = options['paypageRegistrationId']
-      transaction.applepay              = Applepay.from_hash(options,'applepay')
+      transaction.encryptionKeyId             = options['encryptionKeyId']
+      transaction.orderId                     = options['orderId']
+      transaction.mpos                        = Mpos.from_hash(options,'mpos')
+      transaction.accountNumber               = options['accountNumber']
+      transaction.echeckForToken              = EcheckForToken.from_hash(options)
+      transaction.paypageRegistrationId       = options['paypageRegistrationId']
+      transaction.applepay                    = Applepay.from_hash(options,'applepay')
+      transaction.encryptedAccountNumber      = options['encryptedAccountNumber']
+      transaction.cardValidationNum           = options['cardValidationNum']
+      transaction.encryptedCardValidationNum  = options['encryptedCardValidationNum']
       add_account_info(transaction, options)
       return transaction
     end
@@ -507,19 +517,45 @@ module CnpOnline
       return transaction
     end
 
+    def submerchant_credit_ctx(options)
+      transaction = SubmerchantCredit.new
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.submerchantName         = options['submerchantName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      transaction.customIdentifier        = options['customIdentifier']
+      transaction.accountInfo = EcheckCtx.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     def vendor_credit(options)
       transaction = VendorCredit.new
       transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
       transaction.vendorName              = options['vendorName']
       transaction.fundsTransferId         = options['fundsTransferId']
       transaction.amount                  = options['amount']
-      
+
       transaction.accountInfo = Echeck.from_hash(options,'accountInfo')
       add_account_info(transaction, options)
 
       return transaction
     end
 
+    def vendor_credit_ctx(options)
+      transaction = VendorCreditCtx.new
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.vendorName              = options['vendorName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+
+      transaction.accountInfo = EcheckCtx.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     def payFac_credit(options)
       transaction = PayFacCredit.new
       transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
@@ -579,7 +615,7 @@ module CnpOnline
   
 
     def submerchant_debit(options)
-      transaction = SubmerchantDebit.new
+      transaction = SubmerchantDebitCtx.new
       transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
       transaction.submerchantName         = options['submerchantName']
       transaction.fundsTransferId         = options['fundsTransferId']
@@ -591,6 +627,19 @@ module CnpOnline
       return transaction
     end
 
+    def submerchant_debit_ctx(options)
+      transaction = SubmerchantDebitCtx.new
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.submerchantName         = options['submerchantName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+      transaction.customIdentifier        = options['customIdentifier']
+      transaction.accountInfo = EcheckCtx.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     def vendor_debit(options)
       transaction = VendorDebit.new
       transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
@@ -604,6 +653,19 @@ module CnpOnline
       return transaction
     end
 
+    def vendor_debit_ctx(options)
+      transaction = VendorDebitCtx.new
+      transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
+      transaction.vendorName              = options['vendorName']
+      transaction.fundsTransferId         = options['fundsTransferId']
+      transaction.amount                  = options['amount']
+
+      transaction.accountInfo = EcheckCtx.from_hash(options,'accountInfo')
+      add_account_info(transaction, options)
+
+      return transaction
+    end
+
     def payFac_debit(options)
       transaction = PayFacDebit.new
       transaction.fundingSubmerchantId    = options['fundingSubmerchantId']
@@ -764,5 +826,6 @@ module CnpOnline
       #options['reportGroup'] || @config_hash['default_report_group']
       options['reportGroup']
     end
+
   end
 end