LitleOnline 8.13.2 → 8.16.0

data/lib/LitleXmlMapper.rb

@@ -23,6 +23,8 @@ 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 Litle XML -> Sends XML payload to Litle via HTTP(S) -> formats XML response into a Ruby hash and returns it
@@ -30,20 +32,33 @@ OTHER DEALINGS IN THE SOFTWARE.
 module LitleOnline
   class LitleXmlMapper
     def LitleXmlMapper.request(request_xml, config_hash)
-  
-      # create a Litle XML request from the nested hashes
-      if(config_hash['printxml'])
-        puts request_xml
-      end
+      logger = initialize_logger(config_hash)
+
+      logger.debug request_xml
       # get the Litle Online Response from the API server over HTTP
       response_xml = Communications.http_post(request_xml,config_hash)
-      if(config_hash['printxml'])
-        puts response_xml
-      end
+      logger.debug response_xml
+
       # create response object from xml returned form the Litle API
       response_object = XMLObject.new(response_xml)
       
       return response_object
     end
+
+    private
+
+    def self.initialize_logger(config_hash)
+      # Sadly, this needs to be static (the alternative would be to change the LitleXmlMapper.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/lib/XMLFields.rb

@@ -1102,6 +1102,7 @@ module LitleOnline
     object_node :shipToAddress, "shipToAddress", :class=>Contact, :default_value=>nil
     optional_choice_node :if,    'echeck', :then, (object_node :echeck, "echeck", :class=>Echeck),
     :elsif, 'echeckToken', :then, (object_node :echeckToken, "echeckToken", :class=>EcheckToken)
+	object_node :merchantData, "merchantData", :class=>MerchantData, :default_value=>nil
   end
   
   class EcheckCredit
@@ -1130,6 +1131,7 @@ module LitleOnline
     text_node :litleTxnId, "litleTxnId", :default_value=>nil
     optional_choice_node :if,    'echeck', :then, (object_node :echeck, "echeck", :class=>Echeck, :default_value=>nil),
     :elsif, 'echeckToken', :then, (object_node :echeckToken, "echeckToken", :class=>EcheckToken, :default_value=>nil)
+	object_node :merchantData, "merchantData", :class=>MerchantData, :default_value=>nil
   end
   
   class EcheckSale
@@ -1151,13 +1153,26 @@ module LitleOnline
     object_node :merchantData, "merchantData", :class=>MerchantData, :default_value=>nil
   end
   
+  class UpdateCardValidationNumOnToken
+    include XML::Mapping
+    text_node :reportGroup, "@reportGroup", :default_value=>nil
+    text_node :transactionId, "@id", :default_value=>nil
+    text_node :customerId, "@customerId", :default_value=>nil
+  
+    text_node :orderId, "orderId", :default_value=>nil
+    text_node :litleToken, "litleToken", :default_value=>nil
+    text_node :cardValidationNum, "cardValidationNum", :default_value=>nil
+  end
+  
+  
   class OnlineRequest
     include XML::Mapping
     root_element_name "litleOnlineRequest"
     text_node :merchantId, "@merchantId", :default_value=>nil
     text_node :version, "@version", :default_value=>nil
     text_node :xmlns, "@xmlns", :default_value=>nil
-    text_node :merchantSdk, "@merchantSdk", :default_vaule=>nil
+    text_node :merchantSdk, "@merchantSdk", :default_value=>nil
+    text_node :loggedInUser, "@loggedInUser", :default_value=>nil
     object_node :authentication, "authentication", :class=>Authentication
     optional_choice_node   :if,    'authorization', :then, (object_node :authorization, "authorization", :class=>Authorization),
     :elsif, 'sale',    :then, (object_node :sale,    "sale",    :class=>Sale),
@@ -1172,7 +1187,8 @@ module LitleOnline
     :elsif, 'echeckSale', :then, (object_node :echeckSale, "echeckSale", :class=>EcheckSale),
     :elsif, 'echeckVoid', :then, (object_node :echeckVoid, "echeckVoid", :class=>EcheckVoid),
     :elsif, 'echeckVerification', :then, (object_node :echeckVerification, "echeckVerification", :class=>EcheckVerification),
-    :elsif, 'registerTokenRequest', :then, (object_node :registerTokenRequest, "registerTokenRequest", :class=>RegisterTokenRequest)
+    :elsif, 'registerTokenRequest', :then, (object_node :registerTokenRequest, "registerTokenRequest", :class=>RegisterTokenRequest),
+    :elsif, 'updateCardValidationNumOnToken', :then, (object_node :updateCardValidationNumOnToken, "updateCardValidationNumOnToken", :class=>UpdateCardValidationNumOnToken)
     def post_save(xml, options={:Mapping=>:_default})
       xml.each_element() {|el| 
         if(el.name == 'captureTxn')

data/test/functional/test_auth.rb

@@ -216,6 +216,22 @@ module LitleOnline
       response = LitleOnlineRequest.new.authorization(start_hash.merge({'customerInfo'=>{'ssn'=>'000112222'} }))
       assert_equal('000', response.authorizationResponse.response)
     end
+
+    def test_simple_auth_with_paypage
+      hash = {
+        'orderId'=>'12344',
+        'amount'=>'106',
+        'orderSource'=>'ecommerce',
+        'paypage'=>{
+        	'type'=>'VI',
+        	'paypageRegistrationId' =>'QU1pTFZnV2NGQWZrZzRKeTNVR0lzejB1K2Q5VDdWMTVqb2J5WFJ2Snh4U0U4eTBxaFg2cEVWaDBWSlhtMVZTTw==',
+        	'expDate' =>'1210',
+        	'cardValidationNum' => '123'
+        }
+      }
+      response= LitleOnlineRequest.new.authorization(hash)
+      assert_equal('000', response.authorizationResponse.response)
+    end
     
   end
 end  

data/test/functional/test_token.rb

@@ -45,10 +45,11 @@ module LitleOnline
         'version'=>'8.8',
         'reportGroup'=>'Planets',
         'orderId'=>'12344',
-        'paypageRegistrationId'=>'1233456789101112'
+        'paypageRegistrationId'=>'QU1pTFZnV2NGQWZrZzRKeTNVR0lzejB1K2Q5VDdWMTVqb2J5WFJ2Snh4U0U4eTBxaFg2cEVWaDBWSlhtMVZTTw=='
       }
       response= LitleOnlineRequest.new.register_token_request(hash)
       assert_equal('Valid Format', response.message)
+      assert_equal('1111222233334444', response.registerTokenResponse.litleToken)
     end
   
     def test_simple_token_echeck

data/test/functional/test_updateCardValidationNumOnToken.rb

@@ -0,0 +1,43 @@
+=begin
+Copyright (c) 2012 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 'lib/LitleOnline'
+require 'test/unit'
+
+module LitleOnline
+  class TestUpdateCardValidationNumOnToken < Test::Unit::TestCase
+    def test_simple
+      hash = {
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'orderId'=>'12344',
+        'litleToken'=>'1233456789103801',
+		'cardValidationNum'=>'123'
+      }
+      response= LitleOnlineRequest.new.update_card_validation_num_on_token(hash)
+      assert_equal('Valid Format', response.message)
+    end
+  end
+end

data/test/functional/ts_all.rb

@@ -40,3 +40,4 @@ require_relative 'test_echeckSale'
 require_relative 'test_echeckCredit'
 require_relative 'test_echeckVerification'
 require_relative 'test_echeckVoid'
+require_relative 'test_updateCardValidationNumOnToken'

data/test/unit/test_LitleOnlineRequest.rb

@@ -244,9 +244,101 @@ module LitleOnline
       #Explicit - used for integrations
       assert_equal 'ActiveMerchant;3.2', litle.send(:get_merchant_sdk, {'merchantSdk'=>'ActiveMerchant;3.2'})
       #Implicit - used raw when nothing is specified
-      assert_equal 'Ruby;8.13.2', litle.send(:get_merchant_sdk, {'NotMerchantSdk'=>'ActiveMerchant;3.2'})
+      assert_equal 'Ruby;8.16.0', litle.send(:get_merchant_sdk, {'NotMerchantSdk'=>'ActiveMerchant;3.2'})
     end
   
+    def test_sale_paypal_order_complete_typo
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10'})
+      hash={
+        'reportGroup'=>'Planets',
+        'id' => '006',
+        'orderId'=>'12344',
+        'amount'=>'106',
+        'orderSource'=>'ecommerce',
+        'payPalOrderComplete'=>'true',
+        'card'=>{
+          'type'=>'VI',
+          'number' =>'4100000000000001',
+          'expDate' =>'1210'
+        }}
+
+      Communications.expects(:http_post).with(regexp_matches(/<litleOnlineRequest.*<sale.*<payPalOrderComplete>true<\/payPalOrderComplete>.*/m),kind_of(Hash))
+      XMLObject.expects(:new)
+ 
+      response = LitleOnlineRequest.new.sale(hash)
+    end
+
+    def test_version_matches_sdk_major_and_minor_version_ignoring_config
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10'})
+      hash={
+        'litleTxnId' => '006'
+      }
+
+      Communications.expects(:http_post).with(regexp_matches(/<litleOnlineRequest.*version="8\.16".*/m),kind_of(Hash))
+      XMLObject.expects(:new)
+ 
+      response = LitleOnlineRequest.new.void(hash)
+    end
     
+    def test_void_response_contains_recycling
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10'})
+      hash={
+        'litleTxnId' => '123'
+      }
+
+      Communications.expects(:http_post).with(kind_of(String),kind_of(Hash)).returns('<litleOnlineResponse><voidResponse><recycling><creditLitleTxnId>65</creditLitleTxnId></recycling></voidResponse></litleOnlineResponse>')
+ 
+      response = LitleOnlineRequest.new.void(hash)
+      assert_equal '65', response.voidResponse.recycling.creditLitleTxnId
+    end
+    
+    def test_printxml_can_be_turned_on_by_setting_value_to_true
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10','printxml'=>true})
+      Communications.expects(:http_post).with(kind_of(String),kind_of(Hash)).returns('<litleOnlineResponse><voidResponse><recycling><creditLitleTxnId>65</creditLitleTxnId></recycling></voidResponse></litleOnlineResponse>')
+      Logger.any_instance.expects(:debug).with(kind_of(String)).twice
+      hash={
+        'litleTxnId' => '123'
+      }
+ 
+      response = LitleOnlineRequest.new.void(hash)
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+      assert_equal logger.level, Configuration.logger.level
+      assert_equal logger.sev_threshold, Configuration.logger.sev_threshold
+      LitleOnline::Configuration.logger = nil
+    end
+    
+    def test_printxml_can_be_turned_off_by_setting_value_to_false
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10','printxml'=>false})
+      Communications.expects(:http_post).with(kind_of(String),kind_of(Hash)).returns('<litleOnlineResponse><voidResponse><recycling><creditLitleTxnId>65</creditLitleTxnId></recycling></voidResponse></litleOnlineResponse>')
+      Logger.any_instance.expects(:debug).with(kind_of(String)).twice
+      hash={
+        'litleTxnId' => '123'
+      }
+ 
+      response = LitleOnlineRequest.new.void(hash)
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      assert_equal logger.level, Configuration.logger.level
+      assert_equal logger.sev_threshold, Configuration.logger.sev_threshold
+      LitleOnline::Configuration.logger = nil
+    end
+    
+    def test_printxml_can_be_turned_off_by_not_setting_value
+      Configuration.any_instance.stubs(:config).returns({'currency_merchant_map'=>{'DEFAULT'=>'1'}, 'user'=>'a','password'=>'b','version'=>'8.10'})
+      Communications.expects(:http_post).with(kind_of(String),kind_of(Hash)).returns('<litleOnlineResponse><voidResponse><recycling><creditLitleTxnId>65</creditLitleTxnId></recycling></voidResponse></litleOnlineResponse>')
+      Logger.any_instance.expects(:debug).with(kind_of(String)).twice
+      hash={
+        'litleTxnId' => '123'
+      }
+ 
+      response = LitleOnlineRequest.new.void(hash)
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::INFO
+      assert_equal logger.level, Configuration.logger.level
+      assert_equal logger.sev_threshold, Configuration.logger.sev_threshold
+      LitleOnline::Configuration.logger = nil
+    end
+
   end
 end

data/test/unit/test_auth.rb

@@ -266,6 +266,20 @@ module LitleOnline
       Communications.expects(:http_post).with(regexp_matches(/.*<authentication.*?<password>TEST<\/password>.*?<\/authentication>.*/m),kind_of(Hash))
       LitleOnlineRequest.new.authorization(hash)
     end
+    
+    def test_logged_in_user
+      hash = {
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'litleTxnId'=>'123456',
+        'loggedInUser'=>'gdake'
+      }
+  
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.authorization(hash)
+    end
           
   end
 

data/test/unit/test_authReversal.rb

@@ -40,7 +40,20 @@ module LitleOnline
       }
       LitleXmlMapper.expects(:request).with(regexp_matches(/.*<litleTxnId>12345678000<\/litleTxnId>.*/m), is_a(Hash))
       LitleOnlineRequest.new.auth_reversal(hash)
-  
+    end  
+
+    def test_logged_in_user
+      hash = {
+       	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'litleTxnId'=>'12345678000',
+		'reportGroup'=>'Planets',
+		'amount'=>'5000',
+		'loggedInUser'=>'gdake'
+      }
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.auth_reversal(hash)
     end  
   end
 end

data/test/unit/test_capture.rb

@@ -35,6 +35,16 @@ module LitleOnline
       LitleXmlMapper.expects(:request).with(regexp_matches(/.*<litleTxnId>123456<\/litleTxnId>.*/m), is_a(Hash))
       LitleOnlineRequest.new.capture(hash)
     end
+    def test_logged_in_user
+      hash = {
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'litleTxnId'=>'123456',
+        'loggedInUser'=>'gdake'
+      }
+  
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.capture(hash)
+    end
   end
 end
 

data/test/unit/test_captureGivenAuth.rb

@@ -87,6 +87,29 @@ module LitleOnline
       exception = assert_raise(RuntimeError){LitleOnlineRequest.new.capture_given_auth(hash)}
       assert_match /Entered an Invalid Amount of Choices for a Field, please only fill out one Choice!!!!/, exception.message
     end
+    
+    def test_logged_in_user
+      hash = {
+      	'loggedInUser' => 'gdake',
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'orderId'=>'12344',
+        'amount'=>'106',
+        'orderSource'=>'ecommerce',
+        'authInformation' => {
+        'authDate'=>'2002-10-09','authCode'=>'543216',
+        'authAmount'=>'12345'
+        },
+        'card'=>{
+        'type'=>'VI',
+        'number' =>'4100000000000001',
+        'expDate' =>'1210'
+        }}
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.capture_given_auth(hash)
+    end
   end
 
 end

data/test/unit/test_credit.rb

@@ -226,5 +226,21 @@ module LitleOnline
       exception = assert_raise(RuntimeError){LitleOnlineRequest.new.credit(hash)}
       assert_match /If paypage is specified, it must have a paypageRegistrationId/, exception.message
     end
+    
+    def test_logged_in_user
+      hash = {
+      	'loggedInUser' => 'gdake',
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.12',
+        'orderId'=>'1',
+        'amount'=>'2',
+        'orderSource'=>'ecommerce',
+        'reportGroup'=>'Planets'
+      }
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.credit(hash)
+    end
+    
   end
 end

data/test/unit/test_echeckCredit.rb

@@ -39,6 +39,20 @@ module LitleOnline
       exception = assert_raise(RuntimeError){LitleOnlineRequest.new.echeck_credit(hash)}
       assert_match /Entered an Invalid Amount of Choices for a Field, please only fill out one Choice!!!!/, exception.message
     end
+    
+    def test_logged_in_user
+      hash = {
+      	'loggedInUser' => 'gdake',
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'litleTxnId'=>'123456',
+        'echeck' => {'accType'=>'Checking','accNum'=>'12345657890','routingNum'=>'123456789','checkNum'=>'123455'}
+      }
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.echeck_credit(hash)
+    end
   
   end
 end

data/test/unit/test_echeckRedeposit.rb

@@ -63,5 +63,32 @@ module LitleOnline
       exception = assert_raise(RuntimeError) {LitleOnlineRequest.new.echeck_redeposit(hash)}
       assert_match /If echeckToken is specified, it must have a routingNum/, exception.message
     end
+    
+    def test_logged_in_user
+      hash = {
+      	'loggedInUser' => 'gdake',
+      	'merchantSdk' => 'Ruby;8.14.0',
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'litleTxnId'=>'123456',
+        'echeck' => {'accType'=>'Checking','accNum'=>'12345657890','routingNum'=>'123456789','checkNum'=>'123455'}
+      }
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*loggedInUser="gdake".*merchantSdk="Ruby;8.14.0".*/m), is_a(Hash))
+      LitleOnlineRequest.new.echeck_redeposit(hash)
+    end
+    
+    def test_merchant_data
+      hash = {
+      	'merchantData' => {'campaign'=>'camping'},
+        'merchantId' => '101',
+        'version'=>'8.8',
+        'reportGroup'=>'Planets',
+        'litleTxnId'=>'123456',
+        'echeck' => {'accType'=>'Checking','accNum'=>'12345657890','routingNum'=>'123456789','checkNum'=>'123455'}
+      }
+      LitleXmlMapper.expects(:request).with(regexp_matches(/.*<\/echeck>.*<merchantData>.*<campaign>camping<\/campaign>.*<\/merchantData>/m), is_a(Hash))
+      LitleOnlineRequest.new.echeck_redeposit(hash)
+    end
   end
 end