activemerchant 1.3.2 → 1.4.0

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

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/paypal'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # The PayPal gateway for PayPal Website Payments Pro Canada only supports Visa and MasterCard
+    class PaypalCaGateway < PaypalGateway
+      self.supported_cardtypes = [:visa, :master]
+      self.supported_countries = ['CA']
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside'
+      self.display_name = 'PayPal Website Payments Pro (CA)'
+    end
+  end
+end

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

@@ -1,26 +1,17 @@
 require File.dirname(__FILE__) + '/paypal/paypal_common_api'
 require File.dirname(__FILE__) + '/paypal/paypal_express_response'
+require File.dirname(__FILE__) + '/paypal_express_common'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PaypalExpressGateway < Gateway
       include PaypalCommonAPI
+      include PaypalExpressCommon
       
+      self.test_redirect_url = 'https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token='
       self.supported_countries = ['US']
-      
-      LIVE_REDIRECT_URL = 'https://www.paypal.com/cgibin/webscr?cmd=_express-checkout&token='
-      TEST_REDIRECT_URL = 'https://www.sandbox.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
-      
-      def redirect_url_for(token)
-        "#{redirect_url}#{token}"
-      end
       
       def setup_authorization(money, options = {})
         requires!(options, :return_url, :cancel_return_url)

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

@@ -0,0 +1,20 @@
+module ActiveMerchant
+  module Billing
+    module PaypalExpressCommon
+      def self.included(base)
+        base.cattr_accessor :test_redirect_url
+        base.cattr_accessor :live_redirect_url
+        base.live_redirect_url = 'https://www.paypal.com/cgibin/webscr?cmd=_express-checkout&token='
+      end
+      
+      def redirect_url
+        test? ? test_redirect_url : live_redirect_url
+      end
+      
+      def redirect_url_for(token, options = {})
+        options = {:review => true}.update(options)
+        options[:review] ? "#{redirect_url}#{token}" : "#{redirect_url}#{token}&useraction=commit"
+      end
+    end
+  end
+end

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

@@ -23,6 +23,7 @@ module ActiveMerchant #:nodoc:
         :master => "MC",
         :delta => "DELTA",
         :solo => "SOLO",
+        :switch => "MAESTRO",
         :maestro => "MAESTRO",
         :american_express => "AMEX",
         :electron => "UKE",
@@ -39,7 +40,7 @@ module ActiveMerchant #:nodoc:
         "NOTMATCHED" => 'N'
       }
     
-      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :solo, :maestro, :diners_club]
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :switch, :solo, :maestro, :diners_club]
       self.supported_countries = ['GB']
       self.default_currency = 'GBP'
       
@@ -53,7 +54,7 @@ module ActiveMerchant #:nodoc:
       end
       
       def test?
-        @options[:test] || Base.gateway_mode == :test
+        @options[:test] || super
       end
       
       def purchase(money, credit_card, options = {})
@@ -84,11 +85,13 @@ module ActiveMerchant #:nodoc:
         commit(:authorization, post)
       end
       
-      # Only supports capturing the original amount of the transaction
+      # You can only capture a transaction once, even if you didn't capture the full amount the first time.
       def capture(money, identification, options = {})
         post = {}
         
         add_reference(post, identification)
+        add_release_amount(post, money, options)
+        
         commit(:capture, post)
       end
       
@@ -136,10 +139,15 @@ module ActiveMerchant #:nodoc:
         add_pair(post, :Currency, options[:currency] || currency(money), :required => true)
       end
 
+      # doesn't actually use the currency -- dodgy!
+      def add_release_amount(post, money, options)
+        add_pair(post, :ReleaseAmount, amount(money), :required => true)
+      end
+
       def add_customer_data(post, options)
-        add_pair(post, :BillingEmail, options[:email])
-        add_pair(post, :ContactNumber, options[:phone])
-        add_pair(post, :ContactFax, options[:fax])
+        add_pair(post, :BillingEmail, options[:email][0,255]) unless options[:email].blank?
+        add_pair(post, :ContactNumber, options[:phone].gsub(/[^0-9+]/, '')[0,20]) unless options[:phone].blank?
+        add_pair(post, :ContactFax, options[:fax].gsub(/[^0-9+]/, '')[0,20]) unless options[:fax].blank?
         add_pair(post, :ClientIPAddress, options[:ip])
       end
 
@@ -171,12 +179,11 @@ module ActiveMerchant #:nodoc:
         add_pair(post, :CardHolder, credit_card.name, :required => true)
         add_pair(post, :CardNumber, credit_card.number, :required => true)
          
-        add_pair(post, :ExpiryDate, format_expiry_date(credit_card), :required => true)
+        add_pair(post, :ExpiryDate, format_date(credit_card.month, credit_card.year), :required => true)
          
         if requires_start_date_or_issue_number?(credit_card)
-          add_pair(post, :StartDate, format(credit_card.start_year, :four_digits))
-          
-          add_pair(post, :IssueNumber, format_issue_number(credit_card))
+          add_pair(post, :StartDate, format_date(credit_card.start_month, credit_card.start_year))
+          add_pair(post, :IssueNumber, credit_card.issue_number)
         end
         add_pair(post, :CardType, map_card_type(credit_card))
         
@@ -201,17 +208,15 @@ module ActiveMerchant #:nodoc:
       end
       
       # MMYY format
-      def format_expiry_date(credit_card)
-        year  = sprintf("%.4i", credit_card.year)
-        month = sprintf("%.2i", credit_card.month)
+      def format_date(month, year)
+        return nil if year.blank? || month.blank?
+        
+        year  = sprintf("%.4i", year)
+        month = sprintf("%.2i", month)
 
         "#{month}#{year[-2..-1]}"
       end
       
-      def format_issue_number(credit_card)
-        card_brand(credit_card).to_s == 'solo' ? format(credit_card.issue_number, :two_digits) : credit_card.issue_number
-      end
-
       def commit(action, parameters)
         response = parse( ssl_post(url_for(action), post_data(action, parameters)) )
           
@@ -230,7 +235,7 @@ module ActiveMerchant #:nodoc:
          [ params[:VendorTxCode],
            response["VPSTxId"],
            response["TxAuthNo"],
-           response["SecurityKey"] ].compact.join(";")
+           response["SecurityKey"] ].join(";")
       end
       
       def url_for(action)
@@ -248,12 +253,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def message_from(response)
-        if response["Status"] == APPROVED
-          return 'Success'
-        else
-          return 'Unspecified error' if response["StatusDetail"].blank?
-          return response["StatusDetail"]
-        end
+        response['Status'] == APPROVED ? 'Success' : (response['StatusDetail'] || 'Unspecified error')    # simonr 20080207 can't actually get non-nil blanks, so this is shorter
       end
 
       def post_data(action, parameters = {})
@@ -271,7 +271,7 @@ module ActiveMerchant #:nodoc:
       # Key2=value2
       def parse(body)
         result = {}
-        body.to_a.collect {|v| c=v.split('='); result[c[0]] = c[1].chomp if !c[1].blank? }
+        body.to_a.each { |pair| result[$1] = $2 if pair.strip =~ /\A([^=]+)=(.+)\Z/im }
         result
       end
 

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

@@ -0,0 +1,145 @@
+require File.dirname(__FILE__) + '/sage/sage_bankcard'
+require File.dirname(__FILE__) + '/sage/sage_virtual_check'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageGateway < Gateway
+      self.supported_cardtypes = SageBankcardGateway.supported_cardtypes
+
+      # Creates a new SageGateway
+      # 
+      # The gateway requires that a valid login and password be passed
+      # in the +options+ hash.
+      # 
+      # ==== Options
+      #
+      # * <tt>:login</tt> - The Sage Payment Solutions Merchant ID Number.
+      # * <tt>:password</tt> - The Sage Payment Solutions Merchant Key Number.
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      # Performs an authorization transaction
+      # 
+      # ==== Parameters
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>credit_card</tt> - The CreditCard object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an Integer value in cents. Maps to Sage <tt>T_shipping</tt>.      
+      def authorize(money, credit_card, options = {})
+        bankcard.authorize(money, credit_card, options)
+      end
+      
+      # Performs 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>source</tt> - The CreditCard or Check object to be used as the funding source for the transaction.
+      # * <tt>options</tt> - A hash of optional parameters.
+      #   * <tt>:order_id</tt> - A unique reference for this order. (maximum of 20 characters).
+      #   * <tt>:email</tt> - The customer's email address
+      #   * <tt>:customer</tt> - The Customer Number for Purchase Card Level II Transactions
+      #   * <tt>:billing_address</tt> - The customer's billing address as a hash of address information.
+      #     * <tt>:address1</tt> - The billing address street
+      #     * <tt>:city</tt> - The billing address city
+      #     * <tt>:state</tt> - The billing address state
+      #     * <tt>:country</tt> - The 2 digit ISO billing address country code
+      #     * <tt>:zip</tt> - The billing address zip code
+      #     * <tt>:phone</tt> - The billing address phone number
+      #     * <tt>:fax</tt> - The billing address fax number
+      #   * <tt>:shipping_address</tt> - The customer's shipping address as a hash of address information.
+      #     * <tt>:name</tt> - The name at the shipping address 
+      #     * <tt>:address1</tt> - The shipping address street
+      #     * <tt>:city</tt> - The shipping address city
+      #     * <tt>:state</tt> - The shipping address state code
+      #     * <tt>:country</tt> - The 2 digit ISO shipping address country code
+      #     * <tt>:zip</tt> - The shipping address zip code
+      #   * <tt>:tax</tt> - The tax amount for the transaction as an integer value in cents. Maps to Sage <tt>T_tax</tt>.
+      #   * <tt>:shipping</tt> - The shipping amount for the transaction as an integer value in cents. Maps to Sage <tt>T_shipping</tt>.
+      #
+      # ==== Additional options in the +options+ hash for when using a Check as the funding source
+      # * <tt>:originator_id</tt> - 10 digit originator. If not provided, Sage will use the default Originator ID for the specific customer type.
+      # * <tt>:addenda</tt> - Transaction addenda.
+      # * <tt>:ssn</tt> - The customer's Social Security Number.
+      # * <tt>:drivers_license_state</tt> - The customer's drivers license state code.
+      # * <tt>:drivers_license_number</tt> - The customer's drivers license number.
+      # * <tt>:date_of_birth</tt> - The customer's date of birth as a Time or Date object or a string in the format <tt>mm/dd/yyyy</tt>.
+      def purchase(money, source, options = {})
+        if source.type == "check"
+          virtual_check.purchase(money, source, options)
+        else
+          bankcard.purchase(money, source, options)
+        end
+      end                       
+    
+      # Captures authorized funds.
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents. Sage doesn't support changing the capture amount, so the full amount of the initial transaction will be captured.
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def capture(money, reference, options = {})
+        bankcard.capture(money, reference, options)
+      end
+      
+      # Voids a prior transaction. Works for both CreditCard and Check transactions.
+      #
+      # ==== Parameters
+      #
+      # * <tt>reference</tt> - The authorization reference string returned by the original transaction's Response#authorization.
+      def void(reference, options = {})
+        if reference.split(";").last == "virtual_check"
+          virtual_check.void(reference, options)
+        else
+          bankcard.void(reference, options)
+        end
+      end
+
+      # Performs a credit transaction. (Sage +Credit+ transaction).
+      #
+      # ==== Parameters
+      #
+      # * <tt>money</tt> - The amount to be authorized as an integer value in cents.
+      # * <tt>source</tt> - The CreditCard or Check object to be used as the target for the credit.
+      def credit(money, source, options = {})
+        if source.type == "check"
+          virtual_check.credit(money, source, options)
+        else
+          bankcard.credit(money, source, options)
+        end
+      end
+          
+      private
+      def bankcard
+        @bankcard ||= SageBankcardGateway.new(@options)
+      end
+      
+      def virtual_check
+        @virtual_check ||= SageVirtualCheckGateway.new(@options)
+      end 
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/sage/sage_bankcard.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/sage_core'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SageBankcardGateway < Gateway #:nodoc:
+      include SageCore
+      self.url = 'https://www.sagepayments.net/cgi-bin/eftBankcard.dll?transaction'
+      self.source = 'bankcard'
+          
+      # Credit cards supported by Sage
+      # * VISA
+      # * MasterCard
+      # * AMEX
+      # * Diners
+      # * Carte Blanche
+      # * Discover
+      # * JCB
+      # * Sears
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :diners_club]
+      
+      def authorize(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:authorization, post)
+      end
+      
+      def purchase(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:purchase, post)
+      end                       
+    
+      # The +money+ amount is not used. The entire amount of the 
+      # initial authorization will be captured.
+      def capture(money, reference, options = {})
+        post = {}
+        add_reference(post, reference)
+        commit(:capture, post)
+      end
+      
+      def void(reference, options = {})
+        post = {}
+        add_reference(post, reference)
+        commit(:void, post)
+      end
+      
+      def credit(money, credit_card, options = {})
+        post = {}
+        add_credit_card(post, credit_card)
+        add_transaction_data(post, money, options)
+        commit(:credit, post)
+      end
+          
+      private
+      def exp_date(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+
+      def add_credit_card(post, credit_card)
+        post[:C_name]       = credit_card.name
+        post[:C_cardnumber] = credit_card.number
+        post[:C_exp]        = exp_date(credit_card)
+        post[:C_cvv]        = credit_card.verification_value if credit_card.verification_value?
+      end
+      
+      def parse(data)
+        response = {}
+        response[:success]          = data[1,1]
+        response[:code]             = data[2,6]
+        response[:message]          = data[8,32].strip
+        response[:front_end]        = data[40, 2]
+        response[:cvv_result]       = data[42, 1]
+        response[:avs_result]       = data[43, 1].strip
+        response[:risk]             = data[44, 2]
+        response[:reference]        = data[46, 10]
+        
+        response[:order_number], response[:recurring] = data[57...-1].split("\034")
+        response
+      end
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/sage/sage_core.rb

@@ -0,0 +1,110 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module SageCore #:nodoc:
+      def self.included(base)
+        base.cattr_accessor :url
+        base.cattr_accessor :source
+        base.supported_countries = ['US', 'CA']
+        base.homepage_url = 'http://www.sagepayments.com'
+        base.display_name = 'Sage Payment Solutions'
+      end
+      
+      # Transactions types:
+      # <tt>01</tt> - Sale
+      # <tt>02</tt> - AuthOnly 
+      # <tt>03</tt> - Force/PriorAuthSale 
+      # <tt>04</tt> - Void 
+      # <tt>06</tt> - Credit 
+      # <tt>11</tt> - PriorAuthSale by Reference*
+      TRANSACTIONS = {
+        :purchase           => '01',
+        :authorization      => '02',
+        :capture            => '11',
+        :void               => '04',
+        :credit             => '06'
+      }
+      
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      private
+      def add_invoice(post, options)
+        post[:T_ordernum] = options[:order_id].slice(0, 20)
+        post[:T_tax] = amount(options[:tax]) unless options[:tax].blank?
+        post[:T_shipping] = amount(options[:shipping]) unless options[:shipping].blank?
+      end
+      
+      def add_reference(post, reference)
+        ref, source = reference.to_s.split(";")
+        post[:T_reference] = ref
+      end
+      
+      def add_amount(post, money)
+        post[:T_amt] = amount(money)
+      end
+      
+      def add_customer_data(post, options)
+        post[:T_customer_number] = options[:customer]
+      end
+
+      def add_addresses(post, options)
+        billing_address   = options[:billing_address] || options[:address] || {}
+        
+        post[:C_address]    = billing_address[:address1]
+        post[:C_city]       = billing_address[:city]
+        post[:C_state]      = billing_address[:state]
+        post[:C_zip]        = billing_address[:zip]
+        post[:C_country]    = billing_address[:country] 
+        post[:C_telephone]  = billing_address[:phone]
+        post[:C_fax]        = billing_address[:fax]
+        post[:C_email]      = options[:email]
+        
+        if shipping_address = options[:shipping_address]
+          post[:C_ship_name]    = shipping_address[:name]
+          post[:C_ship_address] = shipping_address[:address1]
+          post[:C_ship_city]    = shipping_address[:city]
+          post[:C_ship_state]   = shipping_address[:state]
+          post[:C_ship_zip]     = shipping_address[:zip] 
+          post[:C_ship_country] = shipping_address[:country]
+        end
+      end
+      
+      def add_transaction_data(post, money, options)
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_addresses(post, options)        
+        add_customer_data(post, options)
+      end
+      
+      def commit(action, params)
+        response = parse(ssl_post(url, post_data(action, params)))
+        
+        Response.new(success?(response), response[:message], response, 
+          :test => test?, 
+          :authorization => authorization_from(response),
+          :avs_result => { :code => response[:avs_result] },
+          :cvv_result => response[:cvv_result]
+        )
+      end
+      
+      def authorization_from(response)
+        "#{response[:reference]};#{source}"
+      end
+            
+      def success?(response)
+        response[:success] == 'A'
+      end
+
+      def post_data(action, params = {})
+        params[:M_id]  = @options[:login]
+        params[:M_key] = @options[:password]
+        params[:T_code] = TRANSACTIONS[action]
+        
+        params.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+    end
+  end
+end