activemerchant 1.13.0 → 1.14.0

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

@@ -24,11 +24,16 @@ module ActiveMerchant #:nodoc:
         commit(request)
       end
       
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         request = build_reference_request(:credit, money, identification, options)
         commit(request)
       end        
 
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
       def setup_authorization(money, options = {})
         requires!(options, :return_url, :cancel_return_url)
         

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

@@ -64,12 +64,17 @@ module ActiveMerchant #:nodoc:
       end
       
       # Refund funds to the card holder
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         requires!(options, :description)
         
         request = build_capture_or_credit_request(money, identification, options)                                            
         commit(:credit, request)
       end
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
       
       # token based billing
       

data/lib/active_merchant/billing/gateways/paypal/paypal_common_api.rb

@@ -105,8 +105,13 @@ module ActiveMerchant #:nodoc:
         commit 'DoVoid', build_void_request(authorization, options)
       end
       
+      def refund(money, identification, options = {})
+        commit 'RefundTransaction', build_refund_request(money, identification, options)
+      end
+
       def credit(money, identification, options = {})
-        commit 'RefundTransaction', build_credit_request(money, identification, options)
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
       end
 
       private
@@ -141,7 +146,7 @@ module ActiveMerchant #:nodoc:
         xml.target!        
       end
       
-      def build_credit_request(money, identification, options)
+      def build_refund_request(money, identification, options)
         xml = Builder::XmlMarkup.new
             
         xml.tag! 'RefundTransactionReq', 'xmlns' => PAYPAL_NAMESPACE do

data/lib/active_merchant/billing/gateways/paypal/paypal_express_response.rb

@@ -2,11 +2,15 @@ module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PaypalExpressResponse < Response
       def email
-        @params['PayerInfo']['Payer']
+        info['Payer']
+      end
+
+      def info
+        (@params['PayerInfo']||{})
       end
       
       def name
-        payer = @params['PayerInfo']['PayerName']
+        payer = (info['PayerName']||{})
         [payer['FirstName'], payer['MiddleName'], payer['LastName']].compact.join(' ')
       end
       
@@ -15,11 +19,11 @@ module ActiveMerchant #:nodoc:
       end
       
       def payer_id
-        @params['PayerInfo']['PayerID']
+        info['PayerID']
       end
       
       def payer_country
-        @params['PayerInfo']['PayerCountry']
+        info['PayerCountry']
       end
       
       # PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.
@@ -28,16 +32,16 @@ module ActiveMerchant #:nodoc:
       end
       
       def address
-        address = @params['PaymentDetails']['ShipToAddress']
+        address = (@params['PaymentDetails']||{})['ShipToAddress']
         {  'name'       => address['Name'],
-           'company'    => @params['PayerInfo']['PayerBusiness'],
+           'company'    => info['PayerBusiness'],
            'address1'   => address['Street1'],
            'address2'   => address['Street2'],
            'city'       => address['CityName'],
            'state'      => address['StateOrProvince'],
            'country'    => address['Country'],
            'zip'        => address['PostalCode'],
-           'phone'      => contact_phone || address['Phone']
+           'phone'      => (contact_phone || address['Phone'])
         }
       end
     end

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

@@ -156,7 +156,7 @@ module ActiveMerchant
         add_amount(post, money, options)
        
         if identification_or_creditcard.is_a?(String)
-          warn CREDIT_DEPRECATION_MESSAGE
+          deprecated CREDIT_DEPRECATION_MESSAGE
           refund(money, identification_or_creditcard, options)
         else
           add_creditcard(post, identification_or_creditcard)        

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

@@ -79,7 +79,7 @@ module ActiveMerchant #:nodoc:
 
       # Psigate Credit
       def credit(money, authorization, options = {})
-        warn CREDIT_DEPRECATION_MESSAGE
+        deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, authorization, options)
       end
 

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

@@ -104,7 +104,7 @@ module ActiveMerchant #:nodoc:
       #
       #
       def credit(money, identification, options = {})
-        warn CREDIT_DEPRECATION_MESSAGE
+        deprecated CREDIT_DEPRECATION_MESSAGE
         refund(money, identification, options = {})
       end
 

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

@@ -70,10 +70,15 @@ module ActiveMerchant #:nodoc:
         commit(build_void_request(identification, options), options)
       end
 
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         commit(build_credit_request(money, identification, options), options)
       end
 
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)
+      end
+
       private
 
       def setup_address_hash(options)

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

@@ -75,7 +75,7 @@ module ActiveMerchant #:nodoc:
         commit(:cancel, post)
       end
       
-      def credit(money, identification, options = {})
+      def refund(money, identification, options = {})
         post = {}
 
         add_amount_without_currency(post, money)
@@ -83,6 +83,11 @@ module ActiveMerchant #:nodoc:
 
         commit(:refund, post)
       end
+
+      def credit(money, identification, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, identification, options)      
+      end
       
       def store(creditcard, options = {})                       
         post = {}

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

@@ -3,11 +3,11 @@ require 'digest/sha1'
 
 module ActiveMerchant
   module Billing
-    # Realex us the leading CC gateway in Ireland
+    # Realex is the leading CC gateway in Ireland
     # see http://www.realexpayments.com
     # Contributed by John Ward (john@ward.name)
     # see http://thinedgeofthewedge.blogspot.com
-    # 
+    #
     # Realex works using the following
     # login - The unique id of the merchant
     # password - The secret is used to digitally sign the request
@@ -15,12 +15,12 @@ module ActiveMerchant
     # and is used if the merchant wishes do distuinguish cc traffic from the different sources
     # by using a different account. This must be created in advance
     #
-    # the Realex team decided to make the orderid unique per request, 
-    # so if validation fails you can not correct and resend using the 
+    # the Realex team decided to make the orderid unique per request,
+    # so if validation fails you can not correct and resend using the
     # same order id
     class RealexGateway < Gateway
       URL = 'https://epage.payandshop.com/epage-remote.cgi'
-                  
+
       CARD_MAPPING = {
         'master'            => 'MC',
         'visa'              => 'VISA',
@@ -30,46 +30,78 @@ module ActiveMerchant
         'solo'              => 'SWITCH',
         'laser'             => 'LASER'
       }
-      
+
       self.money_format = :cents
       self.default_currency = 'EUR'
       self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :switch, :solo, :laser ]
       self.supported_countries = [ 'IE', 'GB' ]
       self.homepage_url = 'http://www.realexpayments.com/'
       self.display_name = 'Realex'
-           
+
       SUCCESS, DECLINED          = "Successful", "Declined"
       BANK_ERROR = REALEX_ERROR  = "Gateway is in maintenance. Please try again later."
       ERROR = CLIENT_DEACTIVATED = "Gateway Error"
-      
+
       def initialize(options = {})
         requires!(options, :login, :password)
+        options[:refund_hash] = Digest::SHA1.hexdigest(options[:rebate_secret]) if options.has_key?(:rebate_secret)
         @options = options
         super
-      end  
-  
+      end
+
       def purchase(money, credit_card, options = {})
         requires!(options, :order_id)
-        
-        request = build_purchase_or_authorization_request(:purchase, money, credit_card, options) 
+
+        request = build_purchase_or_authorization_request(:purchase, money, credit_card, options)
         commit(request)
-      end     
-      
-      private           
-      def commit(request)        
+      end
+
+      def authorize(money, creditcard, options = {})
+        requires!(options, :order_id)
+
+        request = build_purchase_or_authorization_request(:authorization, money, creditcard, options)
+        commit(request)
+      end
+
+      def capture(money, authorization, options = {})
+        request = build_capture_request(authorization, options)
+        commit(request)
+      end
+
+      def refund(money, authorization, options = {})
+        request = build_refund_request(money, authorization, options)
+        commit(request)
+      end
+
+      def credit(money, authorization, options = {})
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(money, authorization, options)
+      end
+
+      def void(authorization, options = {})
+        request = build_void_request(authorization, options)
+        commit(request)
+      end
+
+      private
+      def commit(request)
         response = parse(ssl_post(URL, request))
 
         Response.new(response[:result] == "00", message_from(response), response,
           :test => response[:message] =~ /\[ test system \]/,
-          :authorization => response[:authcode],
-          :cvv_result => response[:cvnresult]
-        )      
+          :authorization => authorization_from(response),
+          :cvv_result => response[:cvnresult],
+          :avs_result => {
+            :street_match => response[:avspostcoderesponse],
+            :postal_match => response[:avspostcoderesponse]
+          }
+        )
       end
 
       def parse(xml)
         response = {}
-        
-        xml = REXML::Document.new(xml)          
+
+        xml = REXML::Document.new(xml)
         xml.elements.each('//response/*') do |node|
 
           if (node.elements.size == 0)
@@ -78,88 +110,178 @@ module ActiveMerchant
             node.elements.each do |childnode|
               name = "#{node.name.downcase}_#{childnode.name.downcase}"
               response[name.to_sym] = normalize(childnode.text)
-            end              
+            end
           end
 
         end unless xml.root.nil?
 
         response
       end
-      
-      def parse_credit_card_number(request)
-        xml = REXML::Document.new(request)
-        card_number = REXML::XPath.first(xml, '/request/card/number')
-        card_number && card_number.text
+
+      def authorization_from(parsed)
+        [parsed[:orderid], parsed[:pasref], parsed[:authcode]].join(';')
       end
 
       def build_purchase_or_authorization_request(action, money, credit_card, options)
-        timestamp = Time.now.strftime('%Y%m%d%H%M%S')
-        
+        timestamp = new_timestamp
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'auth' do
-      
-          xml.tag! 'merchantid', @options[:login] 
-          xml.tag! 'account', @options[:account]
-      
+          add_merchant_details(xml, options)
           xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+          add_amount(xml, money, options)
+          add_card(xml, credit_card)
+          xml.tag! 'autosettle', 'flag' => auto_settle_flag(action)
+          add_signed_digest(xml, timestamp, @options[:login], options[:order_id], amount(money), (options[:currency] || currency(money)), credit_card.number)
+          add_comments(xml, options)
+          add_address_and_customer_info(xml, options)
+        end
+        xml.target!
+      end
+
+      def build_capture_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'settle' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], options[:order_id])
+        end
+        xml.target!
+      end
+
+      def build_refund_request(money, authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'rebate' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
           xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
+          xml.tag! 'refundhash', @options[:refund_hash] if @options[:refund_hash]
+          xml.tag! 'autosettle', 'flag' => 1
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], options[:order_id], amount(money), (options[:currency] || currency(money)))
+        end
+        xml.target!
+      end
 
-          xml.tag! 'card' do
-            xml.tag! 'number', credit_card.number
-            xml.tag! 'expdate', expiry_date(credit_card)
-            xml.tag! 'type', CARD_MAPPING[card_brand(credit_card).to_s]
-            xml.tag! 'chname', credit_card.name
-            xml.tag! 'issueno', credit_card.issue_number
-            
-            xml.tag! 'cvn' do
-              xml.tag! 'number', credit_card.verification_value
-              xml.tag! 'presind', credit_card.verification_value? ? 1 : nil
-            end
-          end
-          
-          xml.tag! 'autosettle', 'flag' => auto_settle_flag(action)
-          xml.tag! 'sha1hash', sha1from("#{timestamp}.#{@options[:login]}.#{sanitize_order_id(options[:order_id])}.#{amount(money)}.#{options[:currency] || currency(money)}.#{credit_card.number}")
-          xml.tag! 'comments' do
-            xml.tag! 'comment', options[:description], 'id' => 1 
-            xml.tag! 'comment', 'id' => 2
-          end
-          
-          billing_address = options[:billing_address] || options[:address] || {}
-          shipping_address = options[:shipping_address] || {}
-          
-          xml.tag! 'tssinfo' do
+      def build_void_request(authorization, options)
+        timestamp = new_timestamp
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'request', 'timestamp' => timestamp, 'type' => 'void' do
+          add_merchant_details(xml, options)
+          add_transaction_identifiers(xml, authorization, options)
+          add_comments(xml, options)
+          add_signed_digest(xml, timestamp, @options[:login], options[:order_id])
+        end
+        xml.target!
+      end
+
+      def add_address_and_customer_info(xml, options)
+        billing_address = options[:billing_address] || options[:address]
+        shipping_address = options[:shipping_address]
+
+        return unless billing_address || shipping_address || options[:customer] || options[:invoice] || options[:ip]
+
+        xml.tag! 'tssinfo' do
+          xml.tag! 'custnum', options[:customer] if options[:customer]
+          xml.tag! 'prodid', options[:invoice] if options[:invoice]
+          xml.tag! 'custipaddress', options[:ip] if options[:ip]
+
+          if billing_address
             xml.tag! 'address', 'type' => 'billing' do
-              xml.tag! 'code', billing_address[:zip]
+              xml.tag! 'code', avs_input_code( billing_address )
               xml.tag! 'country', billing_address[:country]
             end
+          end
 
+          if shipping_address
             xml.tag! 'address', 'type' => 'shipping' do
               xml.tag! 'code', shipping_address[:zip]
               xml.tag! 'country', shipping_address[:country]
             end
-            
-            xml.tag! 'custnum', options[:customer]
-            
-            xml.tag! 'prodid', options[:invoice]
-            xml.tag! 'varref'
           end
         end
+      end
 
-        xml.target!
+      def add_merchant_details(xml, options)
+        xml.tag! 'merchantid', @options[:login]
+        if options[:account] || @options[:account]
+          xml.tag! 'account', options[:account] || @options[:account]
+        end
+      end
+
+      def add_transaction_identifiers(xml, authorization, options)
+        options[:order_id], pasref, authcode = authorization.split(';')
+        xml.tag! 'orderid', sanitize_order_id(options[:order_id])
+        xml.tag! 'pasref', pasref
+        xml.tag! 'authcode', authcode
+      end
+
+      def add_comments(xml, options)
+        return unless options[:description]
+        xml.tag! 'comments' do
+          xml.tag! 'comment', options[:description], 'id' => 1
+        end
+      end
+
+      def add_amount(xml, money, options)
+        xml.tag! 'amount', amount(money), 'currency' => options[:currency] || currency(money)
+      end
+
+      def add_card(xml, credit_card)
+        xml.tag! 'card' do
+          xml.tag! 'number', credit_card.number
+          xml.tag! 'expdate', expiry_date(credit_card)
+          xml.tag! 'chname', credit_card.name
+          xml.tag! 'type', CARD_MAPPING[card_brand(credit_card).to_s]
+          xml.tag! 'issueno', credit_card.issue_number
+          xml.tag! 'cvn' do
+            xml.tag! 'number', credit_card.verification_value
+            xml.tag! 'presind', (options['presind'] || (credit_card.verification_value? ? 1 : nil))
+          end
+        end
+      end
+
+      def avs_input_code(address)
+        address.values_at(:zip, :address1).map{ |v| extract_digits(v) }.join('|')
+      end
+
+      def extract_digits(string)
+        return "" if string.nil?
+        string.gsub(/[\D]/,'')
+      end
+
+      def stringify_values(values)
+        string = ""
+        (0..5).each do |i|
+          string << "#{values[i]}"
+          string << "." unless i == 5
+        end
+        string
       end
       
+      def new_timestamp
+        Time.now.strftime('%Y%m%d%H%M%S')
+      end
+
+      def add_signed_digest(xml, *values)
+        string = stringify_values(values)
+        xml.tag! 'sha1hash', sha1from(string)
+      end
+
       def auto_settle_flag(action)
         action == :authorization ? '0' : '1'
       end
-      
+
       def expiry_date(credit_card)
         "#{format(credit_card.month, :two_digits)}#{format(credit_card.year, :two_digits)}"
       end
-      
+
       def sha1from(string)
         Digest::SHA1.hexdigest("#{Digest::SHA1.hexdigest(string)}.#{@options[:password]}")
       end
-      
+
       def normalize(field)
         case field
         when "true"   then true
@@ -167,12 +289,12 @@ module ActiveMerchant
         when ""       then nil
         when "null"   then nil
         else field
-        end        
+        end
       end
-      
+
       def message_from(response)
         message = nil
-        case response[:result]                
+        case response[:result]
         when "00"
           message = SUCCESS
         when "101"
@@ -184,14 +306,16 @@ module ActiveMerchant
         when /^3[0-9][0-9]/
           message = REALEX_ERROR
         when /^5[0-9][0-9]/
+          message = response[:message]
+        when "600", "601", "603"
           message = ERROR
         when "666"
           message = CLIENT_DEACTIVATED
         else
           message = DECLINED
-        end  
+        end
       end
-      
+
       def sanitize_order_id(order_id)
         order_id.to_s.gsub(/[^a-zA-Z0-9\-_]/, '')
       end