activemerchant 1.28.0 → 1.29.1

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

@@ -1,140 +1,138 @@
-#  This class implements the Psigate gateway for the ActiveMerchant module.
-#  Psigate = http://www.psigate.com/ The class  is currently set up to use
-#  the psigate test server while rails is in testing or developement mode.
-#  The real server will be used while in production mode.
-#  
-#  Modifications by Sean O'Hara ( sohara at sohara dot com )
-#  
-#  Usage for a PreAuth (authorize) is as follows:
-#  
-#  twenty = 2000
-#  gateway = PsigateGateway.new(
-#    :login => 'teststore',
-#    :password => 'psigate1234'
-#  )
-#  
-#  creditcard = CreditCard.new(
-#    :number => '4242424242424242',
-#    :month => 8,
-#    :year => 2006,
-#    :first_name => 'Longbob',
-#    :last_name => 'Longsen'
-#  )
-#  response = @gateway.authorize(twenty, creditcard,
-#     :order_id =>  1234,
-#     :billing_address => {
-#  	    :address1 => '123 fairweather Lane',
-#  	    :address2 => 'Apt B',
-#  	    :city => 'New York',
-#  	    :state => 'NY',
-#  	    :country => 'U.S.A.',
-#  	    :zip => '10010'
-#    },
-#    :email => 'jack@yahoo.com'
-#  )
-
 require 'rexml/document'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-
+    # This class implements the Psigate gateway for the ActiveMerchant module.
+    #
+    # Modifications by Sean O'Hara ( sohara at sohara dot com )
+    #
+    # Usage for a PreAuth (authorize) is as follows:
+    #
+    # gateway = PsigateGateway.new(
+    #   :login => 'teststore',
+    #   :password => 'psigate1234'
+    # )
+    #
+    # creditcard = CreditCard.new(
+    #   :number => '4242424242424242',
+    #   :month => 8,
+    #   :year => 2006,
+    #   :first_name => 'Longbob',
+    #   :last_name => 'Longsen'
+    # )
+    #
+    # twenty = 2000
+    # response = @gateway.authorize(twenty, creditcard,
+    #    :order_id =>  1234,
+    #    :billing_address => {
+    #      :address1 => '123 fairweather Lane',
+    #      :address2 => 'Apt B',
+    #      :city => 'New York',
+    #      :state => 'NY',
+    #      :country => 'U.S.A.',
+    #      :zip => '10010'
+    #   },
+    #   :email => 'jack@yahoo.com'
+    # )
     class PsigateGateway < Gateway
       self.test_url  = 'https://dev.psigate.com:7989/Messenger/XMLMessenger'
       self.live_url  = 'https://secure.psigate.com:7934/Messenger/XMLMessenger'
-      
+
       self.supported_cardtypes = [:visa, :master, :american_express]
       self.supported_countries = ['CA']
       self.homepage_url = 'http://www.psigate.com/'
       self.display_name = 'Psigate'
-   
+
       SUCCESS_MESSAGE = 'Success'
       FAILURE_MESSAGE = 'The transaction was declined'
-      
+
       def initialize(options = {})
         requires!(options, :login, :password)
-        @options = options                          
-        super      
-      end      
-    
-      # Psigate PreAuth
+        super
+      end
+
       def authorize(money, creditcard, options = {})
-        requires!(options, :order_id)                                                          
-        options.update({ :CardAction => "1" })
-        commit(money, creditcard, options)      
+        requires!(options, :order_id)
+        options[:CardAction] = "1"
+        commit(money, creditcard, options)
       end
-      
-      # Psigate Sale
+
       def purchase(money, creditcard, options = {})
-        requires!(options, :order_id)                                                          
-        options.update({ :CardAction => "0" })
-        commit(money, creditcard, options)     
+        requires!(options, :order_id)
+        options[:CardAction] = "0"
+        commit(money, creditcard, options)
       end
-      
-      # Psigate PostAuth
+
       def capture(money, authorization, options = {})
-        options.update({ :CardAction => "2", :order_id => authorization })
+        options[:CardAction] = "2"
+        options[:order_id], options[:trans_ref_number] = split_authorization(authorization)
         commit(money, nil, options)
       end
-      
 
-      # Psigate Credit
       def credit(money, authorization, options = {})
         deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 
       def refund(money, authorization, options = {})
-        options.update({ :CardAction => "3", :order_id => authorization })
+        options[:CardAction] = "3"
+        options[:order_id], options[:trans_ref_number] = split_authorization(authorization)
         commit(money, nil, options)
       end
 
-      private                       
-    
-      def commit(money, creditcard, options = {}) 
-        response = parse(ssl_post(test? ? self.test_url : self.live_url, post_data(money, creditcard, options)))
+      def void(authorization, options = {})
+        options[:CardAction] = "9"
+        options[:order_id], options[:trans_ref_number] = split_authorization(authorization)
+        commit(nil, nil, options)
+      end
+
+      private
+
+      def commit(money, creditcard, options = {})
+        response = parse(ssl_post(url, post_data(money, creditcard, options)))
 
-        Response.new(successful?(response), message_from(response), response, 
-          :test => test?, 
-          :authorization => response[:orderid],
+        Response.new(successful?(response), message_from(response), response,
+          :test => test?,
+          :authorization => build_authorization(response) ,
           :avs_result => { :code => response[:avsresult] },
           :cvv_result => response[:cardidresult]
         )
       end
-      
+
+      def url
+        (test? ? self.test_url : self.live_url)
+      end
+
       def successful?(response)
         response[:approved] == "APPROVED"
       end
-                                               
+
       def parse(xml)
         response = {:message => "Global Error Receipt", :complete => false}
 
-        xml = REXML::Document.new(xml)          
+        xml = REXML::Document.new(xml)
         xml.elements.each('//Result/*') do |node|
-
           response[node.name.downcase.to_sym] = normalize(node.text)
-
         end unless xml.root.nil?
 
         response
-      end     
+      end
 
       def post_data(money, creditcard, options)
         xml = REXML::Document.new
         xml << REXML::XMLDecl.new
-        root  = xml.add_element("Order")
-        
-        for key, value in parameters(money, creditcard, options)
+        root = xml.add_element("Order")
+
+        parameters(money, creditcard, options).each do |key, value|
           root.add_element(key.to_s).text = value if value
-        end    
+        end
 
         xml.to_s
       end
-      
-      # Set up the parameters hash just once so we don't have to do it
-      # for every action. 
-      def parameters(money, creditcard, options = {})  
+
+      def parameters(money, creditcard, options = {})
         params = {
-          # General order paramters
+          # General order parameters
           :StoreID => @options[:login],
           :Passphrase => @options[:password],
           :TestResult => options[:test_result],
@@ -143,12 +141,13 @@ module ActiveMerchant #:nodoc:
           :Phone => options[:phone],
           :Fax => options[:fax],
           :Email => options[:email],
-          
-          # Credit Card paramaters
+          :TransRefNumber => options[:trans_ref_number],
+
+          # Credit Card parameters
           :PaymentType => "CC",
           :CardAction => options[:CardAction],
-          
-          # Financial paramters
+
+          # Financial parameters
           :CustomerIP => options[:ip],
           :SubTotal => amount(money),
           :Tax1 => options[:tax1],
@@ -159,9 +158,9 @@ module ActiveMerchant #:nodoc:
         if creditcard
           exp_month = sprintf("%.2i", creditcard.month) unless creditcard.month.blank?
           exp_year = creditcard.year.to_s[2,2] unless creditcard.year.blank?
-          card_id_code = creditcard.verification_value.blank? ? nil : "1"
+          card_id_code = (creditcard.verification_value.blank? ? nil : "1")
 
-          params.update( 
+          params.update(
             :CardNumber => creditcard.number,
             :CardExpMonth => exp_month,
             :CardExpYear => exp_year,
@@ -169,9 +168,9 @@ module ActiveMerchant #:nodoc:
             :CardIDNumber => creditcard.verification_value
           )
         end
-        
-        if address = options[:billing_address] || options[:address]           
-          params[:Bname] = address[:name] || creditcard.name 
+
+        if(address = (options[:billing_address] || options[:address]))
+          params[:Bname] = address[:name] || creditcard.name
           params[:Baddress1]    = address[:address1] unless address[:address1].blank?
           params[:Baddress2]    = address[:address2] unless address[:address2].blank?
           params[:Bcity]        = address[:city]     unless address[:city].blank?
@@ -180,9 +179,9 @@ module ActiveMerchant #:nodoc:
           params[:Bcountry]     = address[:country]  unless address[:country].blank?
           params[:Bcompany]     = address[:company]  unless address[:company].blank?
         end
-        
+
         if address = options[:shipping_address]
-          params[:Sname]        = address[:name] || creditcard.name 
+          params[:Sname]        = address[:name] || creditcard.name
           params[:Saddress1]    = address[:address1] unless address[:address1].blank?
           params[:Saddress2]    = address[:address2] unless address[:address2].blank?
           params[:Scity]        = address[:city]     unless address[:city].blank?
@@ -191,10 +190,10 @@ module ActiveMerchant #:nodoc:
           params[:Scountry]     = address[:country]  unless address[:country].blank?
           params[:Scompany]     = address[:company]  unless address[:company].blank?
         end
-       	 	
-        return params
+
+        params
       end
-      
+
       def message_from(response)
         if response[:approved] == "APPROVED"
           return SUCCESS_MESSAGE
@@ -214,6 +213,15 @@ module ActiveMerchant #:nodoc:
         else field
         end
       end
+
+      def split_authorization(authorization)
+        order_id, trans_ref_number = authorization.split(';')
+        [order_id, trans_ref_number]
+      end
+
+      def build_authorization(response)
+        [response[:orderid], response[:transrefnumber]].join(";")
+      end
     end
   end
 end

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

@@ -2,66 +2,66 @@ module ActiveMerchant
   module Billing
     #
     # ActiveMerchant PSL Card Gateway
-    # 
+    #
     # Notes:
     #   -To be able to use the capture function, the IP address of the machine must be
     #    registered with PSL
-    #   -ESALE_KEYED should only be used in situations where the cardholder perceives the 
-    #    transaction to be Internet-based, such as purchasing from a web site/on-line store.  
-    #    If the Internet is used purely for the transport of information from the merchant 
-    #    directly to the gateway then the appropriate cardholder present or not present message 
+    #   -ESALE_KEYED should only be used in situations where the cardholder perceives the
+    #    transaction to be Internet-based, such as purchasing from a web site/on-line store.
+    #    If the Internet is used purely for the transport of information from the merchant
+    #    directly to the gateway then the appropriate cardholder present or not present message
     #    type should be used rather than the ‘E’ equivalent.
     #   -The CV2 / AVS policies are set up with the account settings when signing up for an account
     class PslCardGateway < Gateway
       self.money_format = :cents
       self.default_currency = 'GBP'
-      
+
       self.supported_countries = ['GB']
       # Visa Credit, Visa Debit, Mastercard, Maestro, Solo, Electron,
       # American Express, Diners Club, JCB, International Maestro,
       # Style, Clydesdale Financial Services, Other
-         
+
       self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :jcb, :switch, :solo, :maestro ]
       self.homepage_url = 'http://www.paymentsolutionsltd.com/'
       self.display_name = 'PSL Payment Solutions'
-      
+
       # Default ISO 3166 country code (GB)
       cattr_accessor :location
       self.location = 826
-      
+
       # PslCard server self.live_url - The url is the same whether testing or live - use
       # the test account when testing...
       self.live_url = self.test_url = 'https://pslcard3.paymentsolutionsltd.com/secure/transact.asp?'
-      
+
       # eCommerce sale transaction, details keyed by merchant or cardholder
-      MESSAGE_TYPE = 'ESALE_KEYED' 
-      
+      MESSAGE_TYPE = 'ESALE_KEYED'
+
       # The type of response that we want to get from PSL, options are HTML, XML or REDIRECT
       RESPONSE_ACTION = 'HTML'
-      
+
       # Currency Codes
       CURRENCY_CODES = {
         'AUD' => 036,
         'GBP' => 826,
         'USD' => 840
       }
-      
+
       #The terminal used - only for swipe transactions, so hard coded to 32 for online
       EMV_TERMINAL_TYPE = 32
-      
+
       #Different Dispatch types
       DISPATCH_LATER  = 'LATER'
       DISPATCH_NOW    = 'NOW'
-      
+
       # Return codes
       APPROVED = '00'
-      
+
       #Nominal amount to authorize for a 'dispatch later' type
       #The nominal amount is held straight away, when the goods are ready
       #to be dispatched, PSL is informed and the full amount is the
       #taken.
       NOMINAL_AMOUNT = 101
-      
+
       AVS_CODE = {
         "ALL MATCH"	=> 'Y',
         "SECURITY CODE MATCH ONLY" => 'N',
@@ -70,7 +70,7 @@ module ActiveMerchant
         "DATA NOT CHECKED"	=> 'R',
         "SECURITY CHECKS NOT SUPPORTED"	=> 'X'
       }
-      
+
       CVV_CODE = {
         "ALL MATCH"	=> 'M',
         "SECURITY CODE MATCH ONLY" => 'M',
@@ -79,23 +79,22 @@ module ActiveMerchant
         "DATA NOT CHECKED"	=> 'P',
         "SECURITY CHECKS NOT SUPPORTED"	=> 'X'
       }
-      
+
       # Create a new PslCardGateway
-      # 
+      #
       # The gateway requires that a valid :login be passed in the options hash
-      # 
+      #
       # Paramaters:
       #   -options:
       #     :login -    the PslCard account login (required)
       def initialize(options = {})
         requires!(options, :login)
-              
-        @options = options
+
         super
       end
 
       # Purchase the item straight away
-      # 
+      #
       # Parameters:
       #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: the PSL cross reference from the previous authorization
@@ -103,27 +102,27 @@ module ActiveMerchant
       #
       # Returns:
       #   -ActiveRecord::Billing::Response object
-      #   
+      #
       def purchase(money, credit_card, options = {})
         post = {}
-        
+
         add_amount(post, money, DISPATCH_NOW, options)
         add_credit_card(post, credit_card)
         add_address(post, options)
         add_invoice(post, options)
         add_purchase_details(post)
-        
+
         commit(post)
       end
-      
+
       # Authorize the transaction
-      # 
-      # Reserves the funds on the customer's credit card, but does not 
+      #
+      # Reserves the funds on the customer's credit card, but does not
       # charge the card.
       #
       # This implementation does not authorize the full amount, rather it checks that the full amount
       # is available and only 'reserves' the nominal amount (currently a pound and a penny)
-      # 
+      #
       # Parameters:
       #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: the PSL cross reference from the previous authorization
@@ -131,23 +130,23 @@ module ActiveMerchant
       #
       # Returns:
       #   -ActiveRecord::Billing::Response object
-      #   
+      #
       def authorize(money, credit_card, options = {})
         post = {}
-      
+
         add_amount(post, money, DISPATCH_LATER, options)
         add_credit_card(post, credit_card)
         add_address(post, options)
         add_invoice(post, options)
         add_purchase_details(post)
-              
+
         commit(post)
       end
-      
-      # Post an authorization. 
+
+      # Post an authorization.
+      #
+      # Captures the funds from an authorized transaction.
       #
-      # Captures the funds from an authorized transaction. 
-      # 
       # Parameters:
       #   -money: Amount to be charged as an Integer value in cents
       #   -authorization: The PSL Cross Reference
@@ -158,7 +157,7 @@ module ActiveMerchant
       #
       def capture(money, authorization, options = {})
         post = {}
-      
+
         add_amount(post, money, DISPATCH_NOW, options)
         add_reference(post, authorization)
         add_purchase_details(post)
@@ -167,82 +166,82 @@ module ActiveMerchant
       end
 
       private
-    
+
       def add_credit_card(post, credit_card)
         post[:QAName] = credit_card.name
         post[:CardNumber] = credit_card.number
         post[:EMVTerminalType] = EMV_TERMINAL_TYPE
         post[:ExpMonth] = credit_card.month
         post[:ExpYear] = credit_card.year
-        
-        if requires_start_date_or_issue_number?(credit_card)        
+
+        if requires_start_date_or_issue_number?(credit_card)
           post[:IssueNumber] = credit_card.issue_number unless credit_card.issue_number.blank?
           post[:StartMonth] = credit_card.start_month unless credit_card.start_month.blank?
           post[:StartYear] = credit_card.start_year unless credit_card.start_year.blank?
         end
-        
+
         # CV2 check
         post[:AVSCV2Check] = credit_card.verification_value? ? 'YES' : 'NO'
         post[:CV2] = credit_card.verification_value if credit_card.verification_value?
       end
-      
+
       def add_address(post, options)
         address = options[:billing_address] || options[:address]
         return if address.nil?
-      
+
         post[:QAAddress] = [:address1, :address2, :city, :state].collect{|a| address[a]}.reject{|a| a.blank?}.join(' ')
         post[:QAPostcode] = address[:zip]
       end
-        
+
       def add_invoice(post, options)
         post[:MerchantName] = options[:merchant] || 'Merchant Name' # May use this as the order_id field
         post[:OrderID] = options[:order_id] unless options[:order_id].blank?
       end
-    
+
       def add_reference(post, authorization)
         post[:CrossReference] = authorization
       end
-      
+
       def add_amount(post, money, dispatch_type, options)
         post[:CurrencyCode] = currency_code(options[:currency] || currency(money))
-        
+
         if dispatch_type == DISPATCH_LATER
           post[:amount] = amount(NOMINAL_AMOUNT)
           post[:DispatchLaterAmount] = amount(money)
         else
           post[:amount] = amount(money)
         end
-        
+
         post[:Dispatch] = dispatch_type
       end
-      
+
       def add_purchase_details(post)
         post[:EchoAmount] = 'YES'
         post[:SCBI] = 'YES'                   # Return information about the transaction
         post[:MessageType] = MESSAGE_TYPE
       end
-    
+
       # Get the currency code for the passed money object
-      # 
+      #
       # The money class stores the currency as an ISO 4217:2001 Alphanumeric,
       # however PSL requires the ISO 4217:2001 Numeric code.
-      # 
+      #
       # Parameters:
       #   -money: Integer value in cents
-      #   
+      #
       # Returns:
       #   -the ISO 4217:2001 Numberic currency code
-      #   
+      #
       def currency_code(currency)
         CURRENCY_CODES[currency]
       end
-      
+
       # Parse the PSL response and create a Response object
       #
       # Parameters:
       #   -body:  The response string returned from PSL, Formatted:
       #           Key=value&key=value...
-      # 
+      #
       # Returns:
       #   -a hash with all of the values returned in the PSL response
       #
@@ -255,7 +254,7 @@ module ActiveMerchant
         end
         fields.symbolize_keys
       end
-      
+
       # Send the passed data to PSL for processing
       #
       # Parameters:
@@ -266,23 +265,23 @@ module ActiveMerchant
       #
       def commit(request)
         response = parse( ssl_post(self.live_url, post_data(request)) )
-        
-        Response.new(response[:ResponseCode] == APPROVED, response[:Message], response, 
-          :test => test?, 
+
+        Response.new(response[:ResponseCode] == APPROVED, response[:Message], response,
+          :test => test?,
           :authorization => response[:CrossReference],
           :cvv_result => CVV_CODE[response[:AVSCV2Check]],
           :avs_result => { :code => AVS_CODE[response[:AVSCV2Check]] }
         )
       end
-      
+
       # Put the passed data into a format that can be submitted to PSL
       # Key=Value&Key=Value...
       #
       # Any ampersands and equal signs are removed from the data being posted
-      # as PSL puts them back into the response string which then cannot be parsed. 
+      # as PSL puts them back into the response string which then cannot be parsed.
       # This is after escaping before sending the request to PSL - this is a work
       # around for the time being
-      # 
+      #
       # Parameters:
       #   -post: Hash of all the data to be sent
       #
@@ -294,7 +293,7 @@ module ActiveMerchant
         post[:MerchantID] = @options[:login]
         post[:ValidityID] = @options[:password]
         post[:ResponseAction] = RESPONSE_ACTION
-        
+
         post.collect { |key, value|
           "#{key}=#{CGI.escape(value.to_s.tr('&=', ' '))}"
         }.join("&")

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

@@ -38,8 +38,6 @@ module ActiveMerchant #:nodoc:
       #
       def initialize(options = {})
         requires!(options, :login, :ticket)
-        test_mode = options[:test] || false
-        @options = options
         super
       end
 
@@ -115,10 +113,6 @@ module ActiveMerchant #:nodoc:
         commit(:query, nil, {})
       end
 
-      def test?
-        @options[:test] || super  
-      end
-
       private
 
       def hosted?