LitleOnline 8.25.1 → 8.29.0

data/samples/Auth/LitleAuthReversalTransaction.rb

@@ -0,0 +1,15 @@
+require_relative '../../lib/LitleOnline'
+ 
+#Auth Reversal
+#litleTxnId contains the Litle Transaction Id returned on the authorization
+reversal_info = {'litleTxnId' => '100000000000000001'}
+reversal_response = LitleOnline::LitleOnlineRequest.new.auth_reversal(reversal_info)
+ 
+#display results
+puts "Response: " + reversal_response.authReversalResponse.response
+puts "Message: " + reversal_response.authReversalResponse.message
+puts "Litle Transaction ID: " + reversal_response .authReversalResponse.litleTxnId
+
+if (!reversal_response.authReversalResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleAuthReversalTransaction has not been Approved", caller
+end

data/samples/Auth/LitleAuthorizationTransaction.rb

@@ -0,0 +1,31 @@
+require_relative '../../lib/LitleOnline'
+ 
+#Authorization
+auth_info = {
+  'orderId' => '1',
+  'amount' => '10010',
+  'orderSource'=>'ecommerce',
+  'billToAddress'=>{
+  'name' => 'John Smith',
+  'addressLine1' => '1 Main St.',
+  'city' => 'Burlington',
+  'state' => 'MA',
+  'zip' => '01803-3747',
+  'country' => 'US'},
+  'card'=>{
+  'number' =>'4**************9',
+  'expDate' => '0112',
+  'cardValidationNum' => '349',
+  'type' => 'VI'}
+}
+auth_response = LitleOnline::LitleOnlineRequest.new.authorization(auth_info)
+ 
+#display results
+puts "Response: " + auth_response.authorizationResponse.response
+puts "Message: " + auth_response.authorizationResponse.message
+puts "Litle Transaction ID: " + auth_response.authorizationResponse.litleTxnId
+
+if (!auth_response.authorizationResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleAuthorizationTransaction has not been Approved", caller
+end
+

data/samples/Auth/LitlePaymentFullLifeCycle.rb

@@ -0,0 +1,47 @@
+require_relative '../../lib/LitleOnline'
+ 
+#Authorization
+#Puts a hold on the funds
+auth_hash = {
+  'orderId' => '1',
+  'amount' => '10010',
+  'orderSource'=>'ecommerce',
+  'billToAddress'=>{
+  'name' => 'John Smith',
+  'addressLine1' => '1 Main St.',
+  'city' => 'Burlington',
+  'state' => 'MA',
+  'zip' => '01803-3747',
+  'country' => 'US'},
+  'card'=>{
+  'number' =>'4**************9',
+  'expDate' => '0112',
+  'cardValidationNum' => '349',
+  'type' => 'VI'}
+}
+auth_response = LitleOnline::LitleOnlineRequest.new.authorization(auth_hash)
+ 
+#Capture
+#Captures the authorization and results in money movement
+capture_hash =  {'litleTxnId' => auth_response.authorizationResponse.litleTxnId}
+capture_response = LitleOnline::LitleOnlineRequest.new.capture(capture_hash)
+
+if (!capture_response.captureResponse.message.eql?'Approved')
+   raise ArgumentError, "LitlePaymentFullLifeCycle's Capture Transaction has not been Approved", caller
+end
+#Credit
+#Refund the customer
+credit_hash =  {'litleTxnId' => capture_response.captureResponse.litleTxnId}
+credit_response = LitleOnline::LitleOnlineRequest.new.credit(credit_hash)
+
+if (!credit_response.creditResponse.message.eql?'Approved')
+   raise ArgumentError, "LitlePaymentFullLifeCycle's credit Transaction has not been Approved", caller
+end
+#Void
+#Cancel the refund, note that a deposit can be Voided as well
+void_hash =  {'litleTxnId' => credit_response.creditResponse.litleTxnId}
+void_response = LitleOnline::LitleOnlineRequest.new.void(void_hash)
+
+if (!void_response.voidResponse.message.eql?'Approved')
+   raise ArgumentError, "LitlePaymentFullLifeCycle's Void Transaction has not been Approved", caller
+end

data/samples/Batch/AccountUpdate.rb

@@ -0,0 +1,64 @@
+require_relative '../../lib/LitleOnline'
+accountUpdateHash = {
+        'reportGroup'=>'Planets',
+        'id'=>'12345',
+        'customerId'=>'0987',
+        'orderId'=>'1234',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}
+
+saleHash = {
+        'reportGroup'=>'Planets',
+        'id' => '006',
+        'orderId'=>'12344',
+        'amount'=>'6000',
+        'orderSource'=>'ecommerce',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}
+       
+authReversalHash = {
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'litleTxnId'=>'12345678000',
+        'amount'=>'106',
+        'payPalNotes'=>'Notes'
+      }
+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
+
+  batch = LitleOnline::LitleBatchRequest.new
+  batch.create_new_batch(path)
+ 
+  #add the same sale ten times
+
+   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.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"     
+

data/samples/Batch/SampleBatchDriver.rb

@@ -0,0 +1,94 @@
+require_relative '../../lib/LitleOnline'
+saleHash = {
+        'reportGroup'=>'Planets',
+        'id' => '006',
+        'orderId'=>'12344',
+        'amount'=>'6000',
+        'orderSource'=>'ecommerce',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}
+      
+updateCardHash = {
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'id'=>'12345',
+        'customerId'=>'0987',
+        'orderId'=>'12344',
+        'litleToken'=>'1233456789103801',
+        'cardValidationNum'=>'123'
+      }      
+      
+accountUpdateHash = {
+        'reportGroup'=>'Planets',
+        'id'=>'12345',
+        'customerId'=>'0987',
+        'orderId'=>'1234',
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+      }}
+      
+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)
+  }
+ 
+  #close the batch, indicating we plan to add no more transactions
+  batch.close_batch()
+  #add the batch to the LitleRequest
+  request.commit_batch(batch)
+}
+ 
+# 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"] 
+    if (!transaction["message"].eql?'Approved')
+   raise ArgumentError, "SampleBatchDriver has not been Approved", caller
+    end
+  end
+end})
+stop = Time::now
+puts "Total time: " + (stop - start).to_s
+

data/samples/Capture/LitleCaptureGivenAuthTransaction.rb

@@ -0,0 +1,30 @@
+require_relative '../../lib/LitleOnline'
+#Capture Given Auth
+capture_given_auth_info = {
+  'merchantId' => '101',
+  'version'=>'8.8',
+  'reportGroup'=>'Planets',
+  'orderId'=>'12344',
+  'amount'=>'106',
+  'authInformation' => {
+    'authDate'=>'2002-10-09',
+    'authCode'=>'543216',
+    'authAmount'=>'12345'
+  },
+  'orderSource'=>'ecommerce',
+  'card'=>{
+    'type'=>'VI',
+    'number' =>'4100000000000001',
+    'expDate' =>'1210'
+    }
+}
+response = LitleOnline::LitleOnlineRequest.new.capture_given_auth(capture_given_auth_info)
+ 
+#display results
+puts "Response: " + response.captureGivenAuthResponse.response
+puts "Message: " + response.captureGivenAuthResponse.message
+puts "Litle Transaction ID: " + response.captureGivenAuthResponse.litleTxnId
+
+if (!response.captureGivenAuthResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleCaptureGivenAuthTransaction has not been Approved", caller
+end

data/samples/Capture/LitleCaptureTransaction.rb

@@ -0,0 +1,14 @@
+require_relative '../../lib/LitleOnline'
+#Capture
+#litleTxnId contains the Litle Transaction Id returned on the authorization
+capture_info =  {'litleTxnId' => '100000000000000001'}
+capture_response = LitleOnline::LitleOnlineRequest.new.capture(capture_info)
+ 
+#display results
+puts "Response: " + capture_response.captureResponse.response
+puts "Message: " + capture_response.captureResponse.message
+puts "Litle Transaction ID: " + capture_response .captureResponse.litleTxnId
+
+if (!capture_response.captureResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleCaptureTransaction has not been Approved", caller
+end

data/samples/Capture/LitleForceCaptureTransaction.rb

@@ -0,0 +1,26 @@
+require_relative '../../lib/LitleOnline'
+#Force Capture
+force_capture_info = {
+  'merchantId' => '101',
+  'version'=>'8.8',
+  'reportGroup'=>'Planets',
+  'litleTxnId'=>'123456',
+  'orderId'=>'12344',
+  'amount'=>'106',
+  'orderSource'=>'ecommerce',
+  'card'=>{
+    'type'=>'VI',
+    'number' =>'4100000000000001',
+    'expDate' =>'1210'
+  }
+}
+response= LitleOnline::LitleOnlineRequest.new.force_capture(force_capture_info)
+ 
+#display results
+puts "Response: " + response.forceCaptureResponse.response
+puts "Message: " + response.forceCaptureResponse.message
+puts "Litle Transaction ID: " + response.forceCaptureResponse.litleTxnId
+
+if (!response.forceCaptureResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleForceCaptureTransaction has not been Approved", caller
+end

data/samples/Capture/LitlePartialCapture.rb

@@ -0,0 +1,16 @@
+require_relative '../../lib/LitleOnline'
+#Partial Capture
+#litleTxnId contains the Litle Transaction Id returned as part of the authorization
+#submit the amount to capture which is less than the authorization amount
+#to generate a partial capture
+capture_info =  {'litleTxnId' => '320000000000000001', 'amount' => '5005'}
+capture_response = LitleOnline::LitleOnlineRequest.new.capture(capture_info)
+ 
+#display results
+puts "Response: " + capture_response.captureResponse.response
+puts "Message: " + capture_response.captureResponse.message
+puts "Litle Transaction ID: " + capture_response.captureResponse.litleTxnId
+
+if (!capture_response.captureResponse.message.eql?'Approved')
+   raise ArgumentError, "LitlePartialCapture has not been Approved", caller
+end

data/samples/Credit/LitleCreditTransaction.rb

@@ -0,0 +1,16 @@
+require_relative '../../lib/LitleOnline'
+#Credit
+#litleTxnId contains the Litle Transaction Id returned on 
+#the capture or sale transaction being credited
+#the amount is optional, if it isn't submitted the full amount will be credited
+credit_info =  {'litleTxnId' => '100000000000000002', 'amount' => '1010'}
+credit_response = LitleOnline::LitleOnlineRequest.new.credit(credit_info)
+ 
+#display results
+puts "Response: " + credit_response.creditResponse.response
+puts "Message: " + credit_response.creditResponse.message
+puts "Litle Transaction ID: " + credit_response.creditResponse.litleTxnId
+
+ if (!credit_response.creditResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleCreditTransaction has not been Approved", caller
+ end

data/samples/Credit/LitleRefundTransaction.rb

@@ -0,0 +1,29 @@
+require_relative '../../lib/LitleOnline'
+#Stand alone credit
+credit_info = {
+  'orderId' => '1',
+  'amount' => '1010',
+  'orderSource'=>'ecommerce',
+  'billToAddress'=>{
+  'name' => 'John Smith',
+  'addressLine1' => '1 Main St.',
+  'city' => 'Burlington',
+  'state' => 'MA',
+  'zip' => '01803-3747',
+  'country' => 'US'},
+  'card'=>{
+  'number' =>'4**************9',
+  'expDate' => '0112',
+  'cardValidationNum' => '349',
+  'type' => 'VI'}
+}
+credit_response= LitleOnline::LitleOnlineRequest.new.credit(credit_info)
+ 
+#display results
+puts "Response: " + credit_response.creditResponse.response
+puts "Message: " + credit_response.creditResponse.response
+puts "Litle Transaction ID: " + credit_response.creditResponse.litleTxnId
+
+ if (!credit_response.creditResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleRefundTransaction has not been Approved", caller
+ end

data/samples/Other/LitleAvsTransaction.rb

@@ -0,0 +1,34 @@
+require_relative '../../lib/LitleOnline'
+ @@merchant_hash = {'reportGroup'=>'Planets','id'=>'321','customerId'=>'123',
+      'merchantId'=>'101'
+    }
+#AVS Only
+auth_info = {
+  'orderId' => '1',
+  'amount' => '10010',
+  'orderSource'=>'ecommerce',
+  'billToAddress'=>{
+  'name' => 'John Smith',
+  'addressLine1' => '1 Main St.',
+  'city' => 'Burlington',
+  'state' => 'MA',
+  'zip' => '01803-3747',
+  'country' => 'US'},
+  'card'=>{
+  'number' =>'4457010000000009',
+  'expDate' => '0112',
+  'cardValidationNum' => '349',
+  'type' => 'VI'}
+} 
+hash = auth_info.merge(@@merchant_hash)
+auth_response = LitleOnline::LitleOnlineRequest.new.authorization(hash)
+ 
+#display results
+puts "Response: " + auth_response.authorizationResponse.response
+puts "Message: " + auth_response.authorizationResponse.message
+puts "Litle Transaction ID: " + auth_response.authorizationResponse.litleTxnId
+puts "AVS Match: " + auth_response.authorizationResponse.fraudResult.avsResult
+
+ if (!auth_response.authorizationResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleAvsTransaction has not been Approved", caller
+ end

data/samples/Other/LitleVoidTransaction.rb

@@ -0,0 +1,18 @@
+require_relative '../../lib/LitleOnline'
+ 
+#Void
+void_info = {
+  #litleTxnId contains the Litle Transaction Id returned on the deposit/refund
+  'litleTxnId' => '100000000000000001',
+}
+ 
+response = LitleOnline::LitleOnlineRequest.new.void(void_info)
+ 
+#display results
+puts "Response: " + response.voidResponse.response
+puts "Message: " + response.voidResponse.message
+puts "Litle Transaction ID: " + response.voidResponse.litleTxnId
+
+ if (!response.voidResponse.message.eql?'Approved')
+   raise ArgumentError, "LitleVoidTransaction has not been Approved", caller
+ end