activemerchant 1.28.0 → 1.29.1

data/lib/active_merchant/billing/gateways/data_cash.rb

@@ -8,9 +8,9 @@ module ActiveMerchant
       # usable:
       # American Express, ATM, Carte Blanche, Diners Club, Discover,
       # EnRoute, GE Capital, JCB, Laser, Maestro, Mastercard, Solo,
-      # Switch, Visa, Visa Delta, VISA Electron, Visa Purchasing 
+      # Switch, Visa, Visa Delta, VISA Electron, Visa Purchasing
       #
-      # Note continuous authority is only supported for :visa, :master and :american_express card types  
+      # Note continuous authority is only supported for :visa, :master and :american_express card types
       self.supported_cardtypes = [ :visa, :master, :american_express, :discover, :diners_club, :jcb, :maestro, :switch, :solo, :laser ]
 
       self.homepage_url = 'http://www.datacash.com/'
@@ -37,24 +37,23 @@ module ActiveMerchant
       DATACASH_SUCCESS = '1'
 
       # Creates a new DataCashGateway
-      # 
+      #
       # The gateway requires that a valid login and password be passed
       # in the +options+ hash.
-      # 
+      #
       # ==== Options
       #
       # * <tt>:login</tt> -- The Datacash account login.
       # * <tt>:password</tt> -- The Datacash account password.
       # * <tt>:test => +true+ or +false+</tt> -- Use the test or live Datacash url.
-      #     
+      #
       def initialize(options = {})
         requires!(options, :login, :password)
-        @options = options
         super
       end
 
       # Perform a purchase, which is essentially an authorization and capture in a single operation.
-      # 
+      #
       # ==== Parameters
       # * <tt>money</tt> The amount to be authorized as an Integer value in cents.
       # * <tt>authorization_or_credit_card</tt>:: The continuous authority reference or CreditCard details for the transaction.
@@ -62,8 +61,8 @@ module ActiveMerchant
       #   * <tt>:order_id</tt> A unique reference for this order (corresponds to merchantreference in datacash documentation)
       #   * <tt>:set_up_continuous_authority</tt>
       #      Set to true to set up a recurring historic transaction account be set up.
-      #      Only supported for :visa, :master and :american_express card types 
-      #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions. 
+      #      Only supported for :visa, :master and :american_express card types
+      #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions.
       #   * <tt>:address</tt>:: billing address for card
       #
       # The continuous authority reference will be available in response#params['ca_referece'] if you have requested one
@@ -79,7 +78,7 @@ module ActiveMerchant
         commit(request)
       end
 
-      # Performs an authorization, which reserves the funds on the customer's credit card, but does not 
+      # Performs an authorization, which reserves the funds on the customer's credit card, but does not
       # charge the card.
       #
       # ==== Parameters
@@ -90,8 +89,8 @@ module ActiveMerchant
       #   * <tt>:order_id</tt> A unique reference for this order (corresponds to merchantreference in datacash documentation)
       #   * <tt>:set_up_continuous_authority</tt>::
       #      Set to true to set up a recurring historic transaction account be set up.
-      #      Only supported for :visa, :master and :american_express card types 
-      #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions. 
+      #      Only supported for :visa, :master and :american_express card types
+      #      See http://www.datacash.com/services/recurring/historic.php for more details of historic transactions.
       #   * <tt>:address</tt>:: billing address for card
       #
       # The continuous authority reference will be available in response#params['ca_referece'] if you have requested one
@@ -108,20 +107,20 @@ module ActiveMerchant
       end
 
       # Captures the funds from an authorized transaction.
-      # 
+      #
       # ==== Parameters
       #
       # * <tt>money</tt> -- The amount to be captured as anInteger value in cents.
-      # * <tt>authorization</tt> -- The authorization returned from the previous authorize request.   
+      # * <tt>authorization</tt> -- The authorization returned from the previous authorize request.
       def capture(money, authorization, options = {})
         commit(build_void_or_capture_request(FULFILL_TYPE, money, authorization, options))
-      end                    
+      end
 
       # Void a previous transaction
-      # 
+      #
       # ==== Parameters
       #
-      # * <tt>authorization</tt> - The authorization returned from the previous authorize request.   
+      # * <tt>authorization</tt> - The authorization returned from the previous authorize request.
       def void(authorization, options = {})
         request = build_void_or_capture_request(CANCEL_TYPE, nil, authorization, options)
 
@@ -129,7 +128,7 @@ module ActiveMerchant
       end
 
       # Refund to a card
-      # 
+      #
       # ==== Parameters
       #
       # * <tt>money</tt> The amount to be refunded as an Integer value in cents. Set to nil for a full refund on existing transaction.
@@ -151,14 +150,9 @@ module ActiveMerchant
         commit(build_transaction_refund_request(money, reference))
       end
 
-      # Is the gateway running in test mode?
-      def test?
-        @options[:test] || super
-      end
-
-      private                         
+      private
       # Create the xml document for a 'cancel' or 'fulfill' transaction.
-      # 
+      #
       # Final XML should look like:
       # <Request>
       #  <Authentication>
@@ -176,14 +170,14 @@ module ActiveMerchant
       #    </HistoricTxn>
       #  </Transaction>
       # </Request>
-      # 
+      #
       # Parameters:
       # * <tt>type</tt> must be FULFILL_TYPE or CANCEL_TYPE
       # * <tt>money</tt> - optional - Integer value in cents
       # * <tt>authorization</tt> - the Datacash authorization from a previous succesful authorize transaction
       # * <tt>options</tt>
       #   * <tt>order_id</tt> - A unique reference for the transaction
-      #   
+      #
       # Returns:
       #   -Builder xml document
       #
@@ -194,14 +188,14 @@ module ActiveMerchant
         xml.instruct!
         xml.tag! :Request do
           add_authentication(xml)
-          
+
           xml.tag! :Transaction do
             xml.tag! :HistoricTxn do
               xml.tag! :reference, reference
               xml.tag! :authcode, auth_code
               xml.tag! :method, type
             end
-            
+
             if money
               xml.tag! :TxnDetails do
                 xml.tag! :merchantreference, format_reference_number(options[:order_id])
@@ -214,9 +208,9 @@ module ActiveMerchant
       end
 
       # Create the xml document for an 'auth' or 'pre' transaction with a credit card
-      # 
+      #
       # Final XML should look like:
-      # 
+      #
       # <Request>
       #  <Authentication>
       #    <client>99000000</client>
@@ -261,7 +255,7 @@ module ActiveMerchant
       #    </CardTxn>
       #  </Transaction>
       # </Request>
-      # 
+      #
       # Parameters:
       #   -type must be 'auth' or 'pre'
       #   -money - A money object with the price and currency
@@ -270,7 +264,7 @@ module ActiveMerchant
       #     :order_id is the merchant reference number
       #     :billing_address is the billing address for the cc
       #     :address is the delivery address
-      #   
+      #
       # Returns:
       #   -xml: Builder document containing the markup
       #
@@ -279,7 +273,7 @@ module ActiveMerchant
         xml.instruct!
         xml.tag! :Request do
           add_authentication(xml)
-          
+
           xml.tag! :Transaction do
             if options[:set_up_continuous_authority]
               xml.tag! :ContAuthTxn, :type => 'setup'
@@ -299,35 +293,35 @@ module ActiveMerchant
 
       # Create the xml document for an 'auth' or 'pre' transaction with
       # continuous authorization
-      # 
+      #
       # Final XML should look like:
-      # 
-      # <Request> 
-      #   <Transaction> 
-      #     <ContAuthTxn type="historic" /> 
-      #     <TxnDetails> 
-      #       <merchantreference>3851231</merchantreference> 
-      #       <capturemethod>cont_auth</capturemethod> 
-      #       <amount currency="GBP">18.50</amount> 
-      #     </TxnDetails> 
-      #     <HistoricTxn> 
-      #       <reference>4500200040925092</reference> 
-      #       <method>auth</method> 
-      #     </HistoricTxn> 
-      #   </Transaction> 
-      #   <Authentication> 
-      #     <client>99000001</client> 
-      #     <password>mypasswd</password> 
-      #   </Authentication> 
+      #
+      # <Request>
+      #   <Transaction>
+      #     <ContAuthTxn type="historic" />
+      #     <TxnDetails>
+      #       <merchantreference>3851231</merchantreference>
+      #       <capturemethod>cont_auth</capturemethod>
+      #       <amount currency="GBP">18.50</amount>
+      #     </TxnDetails>
+      #     <HistoricTxn>
+      #       <reference>4500200040925092</reference>
+      #       <method>auth</method>
+      #     </HistoricTxn>
+      #   </Transaction>
+      #   <Authentication>
+      #     <client>99000001</client>
+      #     <password>mypasswd</password>
+      #   </Authentication>
       # </Request>
-      # 
+      #
       # Parameters:
       #   -type must be 'auth' or 'pre'
       #   -money - A money object with the price and currency
       #   -authorization - The authorization containing a continuous authority reference previously set up on a credit card
       #   -options:
       #     :order_id is the merchant reference number
-      #   
+      #
       # Returns:
       #   -xml: Builder document containing the markup
       #
@@ -356,25 +350,25 @@ module ActiveMerchant
       end
 
       # Create the xml document for a full or partial refund transaction with
-      # 
+      #
       # Final XML should look like:
       #
-      # <Request> 
-      #   <Authentication> 
-      #     <client>99000001</client> 
-      #     <password>*******</password> 
-      #   </Authentication> 
-      #   <Transaction> 
-      #     <HistoricTxn> 
-      #       <method>txn_refund</method> 
-      #       <reference>12345678</reference> 
-      #     </HistoricTxn> 
-      #     <TxnDetails> 
-      #       <amount>10.00</amount> 
-      #     </TxnDetails> 
+      # <Request>
+      #   <Authentication>
+      #     <client>99000001</client>
+      #     <password>*******</password>
+      #   </Authentication>
+      #   <Transaction>
+      #     <HistoricTxn>
+      #       <method>txn_refund</method>
+      #       <reference>12345678</reference>
+      #     </HistoricTxn>
+      #     <TxnDetails>
+      #       <amount>10.00</amount>
+      #     </TxnDetails>
       #   </Transaction>
-      # </Request> 
-      # 
+      # </Request>
+      #
       def build_transaction_refund_request(money, reference)
         xml = Builder::XmlMarkup.new :indent => 2
         xml.instruct!
@@ -396,27 +390,27 @@ module ActiveMerchant
       end
 
       # Create the xml document for a full or partial refund  with
-      # 
+      #
       # Final XML should look like:
       #
-      # <Request> 
-      #   <Authentication> 
-      #     <client>99000001</client> 
-      #     <password>*****</password> 
-      #   </Authentication> 
-      #   <Transaction> 
-      #     <CardTxn> 
-      #       <Card> 
-      #         <pan>633300*********1</pan> 
-      #         <expirydate>04/06</expirydate> 
-      #         <startdate>01/04</startdate> 
-      #       </Card> 
-      #       <method>refund</method> 
-      #     </CardTxn> 
-      #     <TxnDetails> 
-      #       <merchantreference>1000001</merchantreference> 
-      #       <amount currency="GBP">95.99</amount> 
-      #     </TxnDetails> 
+      # <Request>
+      #   <Authentication>
+      #     <client>99000001</client>
+      #     <password>*****</password>
+      #   </Authentication>
+      #   <Transaction>
+      #     <CardTxn>
+      #       <Card>
+      #         <pan>633300*********1</pan>
+      #         <expirydate>04/06</expirydate>
+      #         <startdate>01/04</startdate>
+      #       </Card>
+      #       <method>refund</method>
+      #     </CardTxn>
+      #     <TxnDetails>
+      #       <merchantreference>1000001</merchantreference>
+      #       <amount currency="GBP">95.99</amount>
+      #     </TxnDetails>
       #   </Transaction>
       # </Request>
       def build_refund_request(money, credit_card, options)
@@ -440,13 +434,13 @@ module ActiveMerchant
 
 
       # Adds the authentication element to the passed builder xml doc
-      # 
+      #
       # Parameters:
       #   -xml: Builder document that is being built up
-      #   
+      #
       # Returns:
       #   -none: The results is stored in the passed xml document
-      #   
+      #
       def add_authentication(xml)
         xml.tag! :Authentication do
           xml.tag! :client, @options[:login]
@@ -455,17 +449,17 @@ module ActiveMerchant
       end
 
       # Add credit_card detals to the passed XML Builder doc
-      # 
+      #
       # Parameters:
       #   -xml: Builder document that is being built up
       #   -credit_card: ActiveMerchant::Billing::CreditCard object
       #   -billing_address: Hash containing all of the billing address details
-      #   
+      #
       # Returns:
       #   -none: The results is stored in the passed xml document
-      #   
+      #
       def add_credit_card(xml, credit_card, address)
-        
+
         xml.tag! :Card do
 
           # DataCash calls the CC number 'pan'
@@ -474,7 +468,7 @@ module ActiveMerchant
 
           # optional values - for Solo etc
           if [ 'switch', 'solo' ].include?(card_brand(credit_card).to_s)
-            
+
             xml.tag! :issuenumber, credit_card.issue_number unless credit_card.issue_number.blank?
 
             if !credit_card.start_month.blank? && !credit_card.start_year.blank?
@@ -492,14 +486,14 @@ module ActiveMerchant
               xml.tag! :postcode, address[:zip] unless address[:zip].blank?
             end
 
-            # The ExtendedPolicy defines what to do when the passed data 
+            # The ExtendedPolicy defines what to do when the passed data
             # matches, or not...
-            # 
+            #
             # All of the following elements MUST be present for the
             # xml to be valid (or can drop the ExtendedPolicy and use
             # a predefined one
             xml.tag! :ExtendedPolicy do
-              xml.tag! :cv2_policy, 
+              xml.tag! :cv2_policy,
               :notprovided =>   POLICY_REJECT,
               :notchecked =>    POLICY_REJECT,
               :matched =>       POLICY_ACCEPT,
@@ -511,7 +505,7 @@ module ActiveMerchant
               :matched =>       POLICY_ACCEPT,
               :notmatched =>    POLICY_REJECT,
               :partialmatch =>  POLICY_ACCEPT
-              xml.tag! :address_policy, 
+              xml.tag! :address_policy,
               :notprovided =>   POLICY_ACCEPT,
               :notchecked =>    POLICY_ACCEPT,
               :matched =>       POLICY_ACCEPT,
@@ -523,15 +517,15 @@ module ActiveMerchant
       end
 
       # Send the passed data to DataCash for processing
-      # 
+      #
       # Parameters:
       #   -request: The XML data that is to be sent to Datacash
-      #   
+      #
       # Returns:
       #   - ActiveMerchant::Billing::Response object
-      #   
+      #
       def commit(request)
-        response = parse(ssl_post(test? ? self.test_url : self.live_url, request))      
+        response = parse(ssl_post(test? ? self.test_url : self.live_url, request))
 
         Response.new(response[:status] == DATACASH_SUCCESS, response[:reason], response,
           :test => test?,
@@ -540,11 +534,11 @@ module ActiveMerchant
       end
 
       # Returns a date string in the format Datacash expects
-      # 
+      #
       # Parameters:
       #   -month: integer, the month
       #   -year: integer, the year
-      # 
+      #
       # Returns:
       #   -String: date in MM/YY format
       #
@@ -556,10 +550,10 @@ module ActiveMerchant
       #
       # Parameters:
       #   -body: The XML returned from Datacash
-      # 
+      #
       # Returns:
       #   -a hash with all of the values returned in the Datacash XML response
-      # 
+      #
       def parse(body)
 
         response = {}
@@ -571,14 +565,14 @@ module ActiveMerchant
         end
 
         response
-      end     
+      end
 
       # Parse an xml element
       #
       # Parameters:
       #   -response: The hash that the values are being returned in
       #   -node: The node that is currently being read
-      # 
+      #
       # Returns:
       # -  none (results are stored in the passed hash)
       def parse_element(response, node)

data/lib/active_merchant/billing/gateways/efsnet.rb

@@ -8,22 +8,17 @@ module ActiveMerchant #:nodoc:
       self.supported_cardtypes = [:visa, :master, :american_express, :discover]
       self.homepage_url = 'http://www.concordefsnet.com/'
       self.display_name = 'Efsnet'
-     
+
       self.test_url = 'https://testefsnet.concordebiz.com/efsnet.dll'
       self.live_url = 'https://efsnet.concordebiz.com/efsnet.dll'
-      
+
       # login is your Store ID
       # password is your Store Key
       def initialize(options = {})
         requires!(options, :login, :password)
-        @options = options
-        super      
-      end
-      
-      def test?
-        @options[:test] || super
+        super
       end
-      
+
       def authorize(money, creditcard, options = {})
         request = build_credit_card_request(money, creditcard, options)
         commit(:credit_card_authorize, request)
@@ -33,7 +28,7 @@ module ActiveMerchant #:nodoc:
         request = build_credit_card_request(money, creditcard, options)
         commit(:credit_card_charge, request)
       end
-     
+
       def capture(money, identification, options = {})
         request = build_refund_or_settle_request(money, identification, options)
         commit(:credit_card_settle, request)
@@ -62,28 +57,28 @@ module ActiveMerchant #:nodoc:
         original_transaction_id, original_transaction_amount = identification.split(";")
         commit(:void_transaction, {:reference_number => format_reference_number(options[:order_id]), :transaction_id => original_transaction_id})
       end
-      
+
       def voice_authorize(money, authorization_code, creditcard, options = {})
         options[:authorization_number] = authorization_code
         request = build_credit_card_request(money, creditcard, options)
         commit(:credit_card_voice_authorize, request)
       end
-      
+
       def force(money, authorization_code, creditcard, options = {})
         options[:authorization_number] = authorization_code
         request = build_credit_card_request(money, creditcard, options)
         commit(:credit_card_capture, request)
       end
-      
+
       def system_check
-        commit(:system_check, {})      
+        commit(:system_check, {})
       end
 
       private
 
       def build_refund_or_settle_request(money, identification, options = {})
         original_transaction_id, original_transaction_amount = identification.split(";")
-        
+
         requires!(options, :order_id)
 
         post = {
@@ -94,7 +89,7 @@ module ActiveMerchant #:nodoc:
           :client_ip_address => options[:ip]
         }
       end
-    
+
       def build_credit_card_request(money, creditcard, options = {})
         requires!(options, :order_id)
 
@@ -103,17 +98,17 @@ module ActiveMerchant #:nodoc:
           :authorization_number => options[:authorization_number],
           :transaction_amount => amount(money),
           :client_ip_address => options[:ip]
-          
+
         }
         add_creditcard(post,creditcard)
         add_address(post,options)
         post
       end
-      
+
       def format_reference_number(number)
         number.to_s.slice(0,12)
       end
-    
+
       def add_address(post,options)
         if address = options[:billing_address] || options[:address]
           if address[:address2]
@@ -123,7 +118,7 @@ module ActiveMerchant #:nodoc:
           end
           post[:billing_city]         = address[:city].to_s
           post[:billing_state]        = address[:state].blank?  ? 'n/a' : address[:state]
-          post[:billing_postal_code]  = address[:zip].to_s       
+          post[:billing_postal_code]  = address[:zip].to_s
           post[:billing_country]      = address[:country].to_s
         end
 
@@ -135,12 +130,12 @@ module ActiveMerchant #:nodoc:
           end
           post[:shipping_city]        = address[:city].to_s
           post[:shipping_state]       = address[:state].blank?  ? 'n/a' : address[:state]
-          post[:shipping_postal_code] = address[:zip].to_s       
+          post[:shipping_postal_code] = address[:zip].to_s
           post[:shipping_country]     = address[:country].to_s
         end
       end
 
-      def add_creditcard(post, creditcard)      
+      def add_creditcard(post, creditcard)
         post[:billing_name]  = creditcard.name if creditcard.name
         post[:account_number]  = creditcard.number
         post[:card_verification_value] = creditcard.verification_value if creditcard.verification_value?
@@ -148,8 +143,8 @@ module ActiveMerchant #:nodoc:
         post[:expiration_year]  = sprintf("%.4i", creditcard.year)[-2..-1]
       end
 
-  
-      def commit(action, parameters)  
+
+      def commit(action, parameters)
         response = parse(ssl_post(test? ? self.test_url : self.live_url, post_data(action, parameters), 'Content-Type' => 'text/xml'))
 
         Response.new(success?(response), message_from(response[:result_message]), response,
@@ -159,19 +154,19 @@ module ActiveMerchant #:nodoc:
           :cvv_result => response[:cvv_response_code]
         )
       end
-      
+
       def success?(response)
         response[:response_code] == '0'
       end
-      
+
       def authorization_from(response, params)
         [ response[:transaction_id], params[:transaction_amount] ].compact.join(';')
       end
-                                               
+
       def parse(xml)
         response = {}
 
-        xml = REXML::Document.new(xml)          
+        xml = REXML::Document.new(xml)
 
         xml.elements.each('//Reply//TransactionReply/*') do |node|
 
@@ -180,7 +175,7 @@ module ActiveMerchant #:nodoc:
         end unless xml.root.nil?
 
         response
-      end     
+      end
 
       def post_data(action, parameters = {})
         xml   = REXML::Document.new("<?xml version='1.0' encoding='UTF-8'?>")
@@ -196,7 +191,7 @@ module ActiveMerchant #:nodoc:
 
         xml.to_s
       end
-    
+
       def message_from(message)
         return 'Unspecified error' if message.blank?
         message.gsub(/[^\w]/, ' ').split.join(" ").capitalize
@@ -210,9 +205,9 @@ module ActiveMerchant #:nodoc:
         when ""       then nil
         when "null"   then nil
         else field
-        end        
-      end         
-    
+        end
+      end
+
       def actions
         ACTIONS
       end
@@ -229,7 +224,7 @@ module ActiveMerchant #:nodoc:
            :void_transaction			=> %w(ReferenceNumber TransactionID),
            :credit_card_settle			=> %w(ReferenceNumber TransactionAmount OriginalTransactionAmount OriginalTransactionID ClientIpAddress),
            :system_check			=> %w(SystemCheck),
-      }    
+      }
     end
   end
 end