activemerchant 1.1.0 → 1.2.0

data/lib/active_merchant/billing/gateways/payflow/payflow_common_api.rb

@@ -1,19 +1,21 @@
-require 'digest/sha1'
-
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     module PayflowCommonAPI
       def self.included(base)
-        base.class_inheritable_accessor :default_currency
         base.default_currency = 'USD'
           
         # The certification_id is required by PayPal to make direct HTTPS posts to their servers.
-        # You can obtain a certification id by emailing: payflowintegrator@paypal.com
+        # The certification_id has been deprecated by PayPal.  It will soon be removed and you can simply
+        # use the certification_id that has been configured here, or generate your own
         base.class_inheritable_accessor :certification_id
+        base.certification_id = '55d64dfec398cbbe66c1bf843cbad9'
+        
         base.class_inheritable_accessor :partner
         
         # Set the default partner to PayPal
         base.partner = 'PayPal'
+        
+        base.supported_countries = ['US', 'CA', 'SG', 'AU']
       end
       
       XMLNS = 'http://www.paypal.com/XMLPay'
@@ -30,6 +32,14 @@ module ActiveMerchant #:nodoc:
         :switch => 'Switch',
         :solo => 'Solo'
       }
+      
+      TRANSACTIONS = { 
+        :purchase       => "Sale",
+        :authorization  => "Authorization",
+        :capture        => "Capture",
+        :void           => "Void",
+        :credit         => "Credit" 
+      }
           
       def initialize(options = {})
         requires!(options, :login, :password)
@@ -46,33 +56,37 @@ module ActiveMerchant #:nodoc:
       end
       
       def capture(money, authorization, options = {})
-        request = build_void_or_capture_request('Capture', authorization)
+        request = build_reference_request(:capture, money, authorization, options)
         commit(request)
       end
       
       def void(authorization, options = {})
-        request = build_void_or_capture_request('Void', authorization)
+        request = build_reference_request(:void, nil, authorization, options)
         commit(request)
       end
-         
+  
       private      
-      def build_request(body)
+      def build_request(body, request_type = nil)
         xml = Builder::XmlMarkup.new :indent => 2
         xml.instruct!
         xml.tag! 'XMLPayRequest', 'Timeout' => 30, 'version' => "2.1", "xmlns" => XMLNS do
           xml.tag! 'RequestData' do
             xml.tag! 'Vendor', @options[:login]
             xml.tag! 'Partner', @options[:partner]
-            xml.tag! 'Transactions' do
-              xml.tag! 'Transaction' do
-                xml.tag! 'Verbosity', 'MEDIUM'
-                xml << body
+            if request_type == :recurring
+              xml << body
+            else
+              xml.tag! 'Transactions' do
+                xml.tag! 'Transaction' do
+                  xml.tag! 'Verbosity', 'MEDIUM'
+                  xml << body
+                end
               end
             end
           end
           xml.tag! 'RequestAuth' do
             xml.tag! 'UserPass' do
-              xml.tag! 'User', @options[:login]
+              xml.tag! 'User', !@options[:user].blank? ? @options[:user] : @options[:login]
               xml.tag! 'Password', @options[:password]
             end
           end
@@ -80,21 +94,20 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
       
-      def build_void_or_capture_request(action, authorization)
+      def build_reference_request(action, money, authorization, options)
         xml = Builder::XmlMarkup.new :indent => 2
-        xml.tag! action do
+        xml.tag! TRANSACTIONS[action] do
           xml.tag! 'PNRef', authorization
+        
+          unless money.nil?
+            xml.tag! 'Invoice' do
+              xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
+            end
+          end
         end
+        
         xml.target!
       end
-            
-      def add_paypal_details(xml, options)
-        xml.tag! 'PayPal' do
-          xml.tag! 'EMail', options[:email]
-          xml.tag! 'ReturnURL', options[:return_url]
-          xml.tag! 'CancelURL', options[:cancel_return_url]
-        end
-      end
 
       def add_address(xml, tag, address, options)  
         return if address.nil?
@@ -105,7 +118,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'Address' do
             xml.tag! 'Street', address[:address1] unless address[:address1].blank?
             xml.tag! 'City', address[:city] unless address[:city].blank?
-            xml.tag! 'State', address[:state] unless address[:state].blank?
+            xml.tag! 'State', address[:state].blank? ? "N/A" : address[:state]
             xml.tag! 'Country', address[:country] unless address[:country].blank?
             xml.tag! 'Zip', address[:zip] unless address[:zip].blank?
           end
@@ -131,19 +144,13 @@ module ActiveMerchant #:nodoc:
       def parse_element(response, node)
         if node.has_elements?
           node.elements.each{|e| parse_element(response, e) }
+        elsif node.name == 'ExtData'
+          response[node.attributes['Name'].underscore.to_sym] = node.attributes['Value']
         else
           response[node.name.underscore.to_sym] = node.text
         end
       end
       
-      def generate_request_token
-        Digest::SHA1.hexdigest(rand.to_s).slice(0,32)
-      end
-      
-      def currency(money)
-        money.respond_to?(:currency) ? money.currency : self.default_currency
-      end
-      
       def build_headers(content_length)
         {
           "Content-Type" => "text/xml",
@@ -152,16 +159,21 @@ module ActiveMerchant #:nodoc:
       	  "X-VPS-VIT-Client-Certification-Id" => @options[:certification_id].to_s,
       	  "X-VPS-VIT-Integration-Product" => "ActiveMerchant",
       	  "X-VPS-VIT-Runtime-Version" => RUBY_VERSION,
-      	  "X-VPS-Request-ID" => generate_request_token
+      	  "X-VPS-Request-ID" => generate_unique_id
     	  }
     	end
     	
-    	def commit(request_body)
-        request = build_request(request_body)
-        headers = build_headers(request_body.size)
-    	  
+    	def commit(request_body, request_type = nil)
+        request = build_request(request_body, request_type)
+        headers = build_headers(request.size)
+        
+        if result = test_result_from_cc_number(parse_credit_card_number(request))
+          return result
+        end
+      
     	  url = test? ? TEST_URL : LIVE_URL
     	  data = ssl_post(url, request, headers)
+    	  
     	  @response = parse(data)
     	  
     	  success = @response[:result] == "0"
@@ -169,9 +181,15 @@ module ActiveMerchant #:nodoc:
     	  
     	  build_response(success, message, @response,
     	    :test => test?,
-    	    :authorization => @response[:pn_ref]
+    	    :authorization => @response[:pn_ref] || @response[:rp_ref]
         )
       end
+      
+      def parse_credit_card_number(request)
+        xml = REXML::Document.new(request)
+        card_number = REXML::XPath.first(xml, '//Tender/Card/CardNum')
+        card_number && card_number.text
+      end
     end
   end
 end

data/lib/active_merchant/billing/gateways/payflow/payflow_express_response.rb

@@ -5,6 +5,10 @@ module ActiveMerchant #:nodoc:
         @params['e_mail']
       end
       
+      def full_name
+        "#{@params['name']} #{@params['lastname']}"
+      end
+      
       def token
         @params['token']
       end
@@ -13,8 +17,13 @@ module ActiveMerchant #:nodoc:
         @params['payer_id']
       end
       
+      # Really the shipping country, but it is all the information provided
+      def payer_country
+        address['country']
+      end
+      
       def address
-        {  'name'       => @params['name'],
+        {  'name'       => full_name,
            'company'    => nil,
            'address1'   => @params['street'],
            'address2'   => nil,

data/lib/active_merchant/billing/gateways/payflow/payflow_response.rb

@@ -0,0 +1,9 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayflowResponse < Response
+      def profile_id
+        @params['profile_id']
+      end
+    end
+  end
+end

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

@@ -3,12 +3,15 @@ require File.dirname(__FILE__) + '/payflow/payflow_express_response'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    class PayflowExpressGateway < Gateway
+    class PayflowExpressGateway < Gateway 
       include PayflowCommonAPI
       
       LIVE_REDIRECT_URL = 'https://www.paypal.com/cgibin/webscr?cmd=_express-checkout&token='
       TEST_REDIRECT_URL = 'https://test-expresscheckout.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token='
       
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside'
+      self.display_name = 'PayPal Express Checkout'
+      
       def redirect_url
         test? ? TEST_REDIRECT_URL : LIVE_REDIRECT_URL
       end
@@ -27,8 +30,13 @@ module ActiveMerchant #:nodoc:
         requires!(options, :token, :payer_id)
         request = build_sale_or_authorization_request('Sale', money, options)
         commit(request)
-      end                       
-    
+      end
+      
+      def credit(money, identification, options = {})
+        request = build_reference_request(:credit, money, identification, options)
+        commit(request)
+      end        
+
       def setup_authorization(money, options = {})
         requires!(options, :return_url, :cancel_return_url)
         
@@ -46,7 +54,7 @@ module ActiveMerchant #:nodoc:
       def details_for(token)
         request = build_get_express_details_request(token)
         commit(request)
-      end         
+      end
       
       private
       def build_get_express_details_request(token)
@@ -81,7 +89,7 @@ module ActiveMerchant #:nodoc:
                 add_address(xml, 'BillTo', billing_address, options)
                 add_address(xml, 'ShipTo', shipping_address, options)
                 
-                xml.tag! 'TotalAmt', amount(money), 'Currency' => currency(money)
+                xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
               end
               
               xml.tag! 'Tender' do
@@ -99,14 +107,10 @@ module ActiveMerchant #:nodoc:
           xml.tag! action do
             xml.tag! 'PayData' do
               xml.tag! 'Invoice' do 
-                xml.tag! 'TotalAmt', amount(money), 'Currency' => currency(money)
+                xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
               end
               xml.tag! 'Tender' do
-                xml.tag! 'PayPal' do
-                  xml.tag! 'Token', options[:token]
-                  xml.tag! 'PayerID', options[:payer_id]
-                  xml.tag! 'NotifyURL', options[:notify_url]
-                end
+                add_paypal_details xml, options
               end
             end
           end
@@ -114,6 +118,27 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
       
+      def add_paypal_details(xml, options)
+         xml.tag! 'PayPal' do
+          xml.tag! 'EMail', options[:email] unless options[:email].blank?
+          xml.tag! 'ReturnURL', options[:return_url] unless options[:return_url].blank?
+          xml.tag! 'CancelURL', options[:cancel_return_url] unless options[:cancel_return_url].blank?
+          xml.tag! 'NotifyURL', options[:notify_url] unless options[:notify_url].blank?
+          xml.tag! 'PayerID', options[:payer_id] unless options[:payer_id].blank?
+          xml.tag! 'Token', options[:token] unless options[:token].blank?
+          xml.tag! 'NoShipping', options[:no_shipping] ? '1' : '0'
+          xml.tag! 'AddressOverride', options[:address_override] ? '1' : '0'
+          xml.tag! 'ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank? 
+          
+          # Customization of the payment page
+          xml.tag! 'PageStyle', options[:page_style] unless options[:page_style].blank?
+          xml.tag! 'HeaderImage', options[:header_image] unless options[:header_image].blank?
+          xml.tag! 'HeaderBackColor', options[:header_background_color] unless options[:header_background_color].blank?
+          xml.tag! 'HeaderBorderColor', options[:header_border_color] unless options[:header_border_color].blank?
+          xml.tag! 'PayflowColor', options[:background_color] unless options[:background_color].blank?
+        end
+      end
+      
       def build_response(success, message, response, options = {})
         PayflowExpressResponse.new(success, message, response, options)
       end

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

@@ -1,8 +1,14 @@
+require File.dirname(__FILE__) + '/payflow_express'
+
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PayflowExpressUkGateway < PayflowExpressGateway
       self.default_currency = 'GBP'
       self.partner = 'PayPalUk'
+      
+      self.supported_countries = ['GB']
+      self.homepage_url = 'https://www.paypal.com/uk/cgi-bin/webscr?cmd=_additional-payment-overview-outside'
+      self.display_name = 'PayPal Express Checkout (UK)'
     end
   end
 end

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

@@ -1,3 +1,6 @@
+require File.dirname(__FILE__) + '/payflow'
+require File.dirname(__FILE__) + '/payflow_express_uk' 
+
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PayflowUkGateway < PayflowGateway
@@ -8,9 +11,10 @@ module ActiveMerchant #:nodoc:
         @express ||= PayflowExpressUkGateway.new(@options)
       end
       
-      def self.supported_cardtypes
-        [:visa, :master, :american_express, :discover, :solo, :switch]
-      end
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :solo, :switch]
+      self.supported_countries = ['GB']
+      self.homepage_url = 'https://www.paypal.com/uk/cgi-bin/webscr?cmd=_wp-pro-overview-outside'
+      self.display_name = 'PayPal Website Payments Pro (UK)'
     end
   end
 end

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

@@ -0,0 +1,261 @@
+require 'rexml/document'
+
+module ActiveMerchant
+  module Billing
+    
+    # In NZ DPS supports ANZ, Westpac, National Bank, ASB and BNZ. 
+    # In Australia DPS supports ANZ, NAB, Westpac, CBA, St George and Bank of South Australia. 
+    # The Maybank in Malaysia is supported and the Citibank for Singapore.
+    class PaymentExpressGateway < Gateway
+      attr_reader :url 
+      attr_reader :response
+      attr_reader :options
+      
+      self.default_currency = 'NZD'
+      # PS supports all major credit cards; Visa, Mastercard, Amex, Diners, BankCard & JCB. 
+      # Various white label cards can be accepted as well; Farmers, AirNZCard and Elders etc. 
+      # Please note that not all acquirers and Eftpos networks can support some of these card types.
+      # VISA, Mastercard, Diners Club and Farmers cards are supported
+      #
+      # However, regular accounts with DPS only support VISA and Mastercard
+      self.supported_cardtypes = [ :visa, :master, :american_express, :diners_club, :jcb ]
+      
+      self.supported_countries = [ 'AU', 'MY', 'NZ', 'SG', 'ZA', 'GB', 'US' ]
+      
+      self.homepage_url = 'http://www.paymentexpress.com/'
+      self.display_name = 'PaymentExpress'
+      
+      PAYMENT_URL = 'https://www.paymentexpress.com/pxpost.aspx'
+      
+      APPROVED = '1'
+      
+      TRANSACTIONS = {
+        :purchase       => 'Purchase',
+        :credit         => 'Refund',
+        :authorization  => 'Auth',
+        :capture        => 'Complete',
+        :validate       => 'Validate'
+      }
+      
+      POST_HEADERS = { "Content-Type" => "application/x-www-form-urlencoded" }
+
+      # We require the DPS gateway username and password when the object is created.
+      def initialize(options = {})
+        # A DPS username and password must exist 
+        requires!(options, :login, :password)
+        # Make the options an instance variable
+        @options = options
+        super
+      end
+      
+      # Funds are transferred immediately.
+      def purchase(money, credit_card_or_billing_token, options = {})
+        
+        credit_card = credit_card_or_billing_token if credit_card_or_billing_token.respond_to?(:number)
+        
+        if credit_card        
+          if result = test_result_from_cc_number(credit_card.number)
+            return result
+          end
+          options[:credit_card] = credit_card
+        else
+          options[:token]       = credit_card_or_billing_token
+        end
+        
+        request = build_purchase_or_authorization_request(money, options)
+        commit(:purchase, request)      
+      end
+      
+      # NOTE: Perhaps in options we allow a transaction note to be inserted
+      # Verifies that funds are available for the requested card and amount and reserves the specified amount.
+      # See: http://www.paymentexpress.com/technical_resources/ecommerce_nonhosted/pxpost.html#Authcomplete
+      def authorize(money, credit_card, options = {})
+        if result = test_result_from_cc_number(credit_card.number)
+          return result
+        end
+        
+        options[:credit_card] = credit_card
+
+        request = build_purchase_or_authorization_request(money, options)
+        commit(:authorization, request)
+      end
+      
+      # Transfer pre-authorized funds immediately
+      # See: http://www.paymentexpress.com/technical_resources/ecommerce_nonhosted/pxpost.html#Authcomplete
+      def capture(money, identification, options = {})
+        request = build_capture_or_credit_request(money, identification, options)                                            
+        commit(:capture, request)
+      end
+      
+      # Refund funds to the card holder
+      def credit(money, identification, options = {})
+        requires!(options, :description)
+        
+        request = build_capture_or_credit_request(money, identification, options)                                            
+        commit(:credit, request)
+      end
+      
+      # token based billing
+      
+      # initiates a "Validate" transcation to store card data on payment express servers
+      # returns a "token" that can be used to rebill this card
+      # see: http://www.paymentexpress.com/technical_resources/ecommerce_nonhosted/pxpost.html#Tokenbilling
+      # PaymentExpress does not support unstoring a stored card.
+      def store(credit_card, options = {})
+        request  = build_token_request(credit_card, options)
+        commit(:validate, request)
+      end
+      
+      private
+      
+      def build_purchase_or_authorization_request(money, options)
+        result = new_transaction      
+        
+        returning result do |r|
+          add_credit_card(r, options[:credit_card]) if options[:credit_card]
+          add_billing_token(r, options[:token])     if options[:token]
+        
+          add_amount(r, money, options)
+          add_invoice(r, options)
+          add_address_verification_data(r, options)
+        end
+      end
+      
+      def build_capture_or_credit_request(money, identification, options)
+        result = new_transaction
+      
+        add_amount(result, money, options)
+        add_invoice(result, options)
+        add_reference(result, identification)
+        
+        result
+      end
+      
+      def build_token_request(credit_card, options)
+        result = new_transaction
+          
+        returning result do |r|
+          add_credit_card(r, credit_card)
+          add_amount(r, 100, options) #need to make an auth request for $1
+          add_token_request(r, options)
+        end
+      end
+      
+      def add_credentials(xml)
+        xml.add_element("PostUsername").text = @options[:login]
+        xml.add_element("PostPassword").text = @options[:password]
+      end
+      
+      def add_reference(xml, identification)
+        xml.add_element("DpsTxnRef").text = identification
+      end
+      
+      def add_credit_card(xml, credit_card)
+        xml.add_element("CardHolderName").text = credit_card.name
+        xml.add_element("CardNumber").text = credit_card.number
+        xml.add_element("DateExpiry").text = format_date(credit_card.month, credit_card.year)
+        
+        if credit_card.verification_value?
+          xml.add_element("Cvc2").text = credit_card.verification_value
+        end
+        
+        if requires_start_date_or_issue_number?(credit_card)
+          xml.add_element("DateStart").text = format_date(credit_card.start_month, credit_card.start_year) unless credit_card.start_month.blank? || credit_card.start_year.blank?
+          xml.add_element("IssueNumber").text = credit_card.issue_number unless credit_card.issue_number.blank?
+        end
+      end
+      
+      def add_billing_token(xml, token) 
+        xml.add_element("DpsBillingId").text = token
+      end
+      
+      def add_token_request(xml, options)
+        xml.add_element("BillingId").text = options[:billing_id] if options[:billing_id]
+        xml.add_element("EnableAddBillCard").text = 1
+      end
+      
+      def add_amount(xml, money, options)
+        xml.add_element("Amount").text = amount(money)
+        xml.add_element("InputCurrency").text = options[:currency] || currency(money)
+      end
+      
+      def add_transaction_type(xml, action)
+        xml.add_element("TxnType").text = TRANSACTIONS[action]
+      end
+      
+      def add_invoice(xml, options)
+        xml.add_element("TxnId").text = options[:order_id] unless options[:order_id].blank?
+        xml.add_element("MerchantReference").text = options[:description] unless options[:description].blank?
+      end
+      
+      def add_address_verification_data(xml, options)
+        address = options[:billing_address] || options[:address]
+        return if address.nil?
+        
+        xml.add_element("EnableAvsData").text = 0
+        xml.add_element("AvsAction").text = 0
+        
+        xml.add_element("AvsStreetAddress").text = address[:address1]
+        xml.add_element("AvsPostCode").text = address[:zip]
+      end
+      
+      def new_transaction
+        REXML::Document.new.add_element("Txn")
+      end
+
+      # Take in the request and post it to DPS
+      def commit(action, request)
+        add_credentials(request)
+        add_transaction_type(request, action)
+        
+        # Next, post it to the server
+        response = ssl_post(PAYMENT_URL, request.to_s, POST_HEADERS)
+        
+        # Parse the XML response
+        @response = parse_response(response)
+        
+        success = @response[:success] == APPROVED
+        test = @response[:test_mode] == '1'
+        
+        # Return a response
+        PaymentExpressResponse.new(success, @response[:response_text], @response,
+          :test => test,
+          :authorization => @response[:dps_txn_ref]
+        )
+      end
+
+      # Response XML documentation: http://www.paymentexpress.com/technical_resources/ecommerce_nonhosted/pxpost.html#XMLTxnOutput
+      def parse_response(xml_string)
+        response = {}
+
+        xml = REXML::Document.new(xml_string)          
+
+        # Gather all root elements such as HelpText
+        xml.elements.each('Txn/*') do |element|
+          response[element.name.underscore.to_sym] = element.text unless element.name == 'Transaction'
+        end
+
+        # Gather all transaction elements and prefix with "account_"
+        # So we could access the MerchantResponseText by going
+        # response[account_merchant_response_text]
+        xml.elements.each('Txn/Transaction/*') do |element|
+          response[element.name.underscore.to_sym] = element.text
+        end
+        
+        response
+      end
+      
+      def format_date(month, year)
+        "#{format(month, :two_digits)}#{format(year, :two_digits)}"
+      end
+    end
+    
+    class PaymentExpressResponse < Response
+      # add a method to response so we can easily get the token
+      # for Validate transactions
+      def token
+        @params["billing_id"] || @params["dps_billing_id"]
+      end
+    end
+  end
+end