activemerchant 1.1.0 → 1.2.0

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

@@ -1,13 +1,16 @@
 require File.dirname(__FILE__) + '/paypal/paypal_common_api'
+require File.dirname(__FILE__) + '/paypal_express'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PaypalGateway < Gateway
       include PaypalCommonAPI
       
-      def self.supported_cardtypes
-        [:visa, :master, :american_express, :discover]
-      end
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.supported_countries = ['US']
+      
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside'
+      self.display_name = 'PayPal Website Payments Pro (US)'
       
       def authorize(money, credit_card, options = {})
         requires!(options, :ip)
@@ -36,6 +39,7 @@ module ActiveMerchant #:nodoc:
       private
       def build_sale_or_authorization_request(action, money, credit_card, options)
         shipping_address = options[:shipping_address] || options[:address]
+        currency_code = options[:currency] || currency(money)
        
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'DoDirectPaymentReq', 'xmlns' => PAYPAL_NAMESPACE do
@@ -44,10 +48,20 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'n2:DoDirectPaymentRequestDetails' do
               xml.tag! 'n2:PaymentAction', action
               xml.tag! 'n2:PaymentDetails' do
-                xml.tag! 'n2:OrderTotal', amount(money), 'currencyID' => currency(money)
+                xml.tag! 'n2:OrderTotal', amount(money), 'currencyID' => currency_code
+                
+                # All of the values must be included together and add up to the order total
+                if [:subtotal, :shipping, :handling, :tax].all?{ |o| options.has_key?(o) }
+                  xml.tag! 'n2:ItemTotal', amount(options[:subtotal]), 'currencyID' => currency_code
+                  xml.tag! 'n2:ShippingTotal', amount(options[:shipping]),'currencyID' => currency_code
+                  xml.tag! 'n2:HandlingTotal', amount(options[:handling]),'currencyID' => currency_code
+                  xml.tag! 'n2:TaxTotal', amount(options[:tax]), 'currencyID' => currency_code
+                end
+                
                 xml.tag! 'n2:NotifyURL', options[:notify_url]
                 xml.tag! 'n2:OrderDescription', options[:description]
                 xml.tag! 'n2:InvoiceID', options[:order_id]
+                xml.tag! 'n2:ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank? 
                 
                 add_address(xml, 'n2:ShipToAddress', shipping_address)
               end

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

@@ -1,10 +1,12 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # This class is an abstract base class for both PaypalGateway and
-    # PaypalExpressGateway
+    # This class is included in both PaypalGateway and PaypalExpressGateway
     module PaypalCommonAPI
       def self.included(base)
+        
+        base.default_currency = 'USD'
         base.cattr_accessor :pem_file
+        base.cattr_accessor :signature
       end
       
       API_VERSION = '2.0'
@@ -33,18 +35,29 @@ module ActiveMerchant #:nodoc:
         'VIC' => 'Victoria',
         'WA'  => 'Western Australia'
       }
-    
+      
+      # The gateway must be configured with either your PayPal PEM file
+      # or your PayPal API Signature.  Only one is required.
+      #
       # <tt>:pem</tt>         The text of your PayPal PEM file. Note
       #                       this is not the path to file, but its
       #                       contents. If you are only using one PEM
       #                       file on your site you can declare it
       #                       globally and then you won't need to
       #                       include this option
+      #
+      # <tt>:signature</tt>   The text of your PayPal signature. 
+      #                       If you are only using one API Signature
+      #                       on your site you can declare it
+      #                       globally and then you won't need to
+      #                       include this option
+      
       def initialize(options = {})
         requires!(options, :login, :password)
         
         @options = {
-          :pem => self.class.pem_file
+          :pem => pem_file,
+          :signature => signature
         }.update(options)
         
         super
@@ -92,7 +105,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'DoReauthorizationRequest', 'xmlns:n2' => EBAY_NAMESPACE do
             xml.tag! 'n2:Version', API_VERSION
             xml.tag! 'AuthorizationID', authorization
-            xml.tag! 'Amount', amount(money), 'currencyID' => currency(money)
+            xml.tag! 'Amount', amount(money), 'currencyID' => options[:currency] || currency(money)
           end
         end
 
@@ -106,7 +119,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'DoCaptureRequest', 'xmlns:n2' => EBAY_NAMESPACE do
             xml.tag! 'n2:Version', API_VERSION
             xml.tag! 'AuthorizationID', authorization
-            xml.tag! 'Amount', amount(money), 'currencyID' => currency(money)
+            xml.tag! 'Amount', amount(money), 'currencyID' => options[:currency] || currency(money)
             xml.tag! 'CompleteType', 'Complete'
             xml.tag! 'Note', options[:description]
           end
@@ -122,7 +135,7 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'RefundTransactionRequest', 'xmlns:n2' => EBAY_NAMESPACE do
             xml.tag! 'n2:Version', API_VERSION
             xml.tag! 'TransactionID', identification
-            xml.tag! 'Amount', amount(money), 'currencyID' => currency(money)
+            xml.tag! 'Amount', amount(money), 'currencyID' => options[:currency] || currency(money)
             xml.tag! 'RefundType', 'Partial'
             xml.tag! 'Memo', options[:note] unless options[:note].blank?
           end
@@ -159,7 +172,7 @@ module ActiveMerchant #:nodoc:
               options ||= default_options
               xml.tag! 'MassPayItem' do
                 xml.tag! 'ReceiverEmail', recipient
-                xml.tag! 'Amount', amount(money), 'currencyID' => currency(money)
+                xml.tag! 'Amount', amount(money), 'currencyID' => options[:currency] || currency(money)
                 xml.tag! 'Note', options[:note] if options[:note]
                 xml.tag! 'UniqueId', options[:unique_id] if options[:unique_id]
               end
@@ -234,6 +247,7 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'Username', @options[:login]
             xml.tag! 'Password', @options[:password]
             xml.tag! 'Subject', @options[:subject]
+            xml.tag! 'Signature', @options[:signature] unless @options[:signature].blank?
           end
         end
       end
@@ -253,21 +267,23 @@ module ActiveMerchant #:nodoc:
       end
       
       def lookup_state(address)
-        state = if address[:country].to_s.upcase == 'AU' || address[:country] == 'Australia'
+        country = Country.find(address[:country]) rescue nil
+        return '' if country.nil?
+        
+        case country.code(:alpha2).to_s
+        when 'AU'
           AUSTRALIAN_STATES[address[:state]] || address[:state] 
+        when 'GB'
+          address[:state].blank? ? 'N/A' : address[:state] 
         else
           address[:state]
         end
       end
 
-      def currency(money)
-        money.respond_to?(:currency) ? money.currency : 'USD'
-      end
-      
       def commit(action, request)
         url = test? ? TEST_URL : LIVE_URL
+
         data = ssl_post(url, build_request(request))
-        
         @response = parse(action, data)
        
         success = @response[:ack] == "Success"
@@ -280,4 +296,4 @@ module ActiveMerchant #:nodoc:
       end
     end
   end
-end
+end

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

@@ -5,6 +5,10 @@ module ActiveMerchant #:nodoc:
         @params['payer']
       end
       
+      def name
+        [@params['first_name'], @params['middle_name'], @params['last_name']].compact.join(' ')
+      end
+      
       def token
         @params['token']
       end
@@ -13,6 +17,10 @@ module ActiveMerchant #:nodoc:
         @params['payer_id']
       end
       
+      def payer_country
+        @params['payer_country']
+      end
+      
       def address
         {  'name'       => @params['name'],
            'company'    => @params['payer_business'],

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

@@ -6,8 +6,13 @@ module ActiveMerchant #:nodoc:
     class PaypalExpressGateway < Gateway
       include PaypalCommonAPI
       
+      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 
@@ -39,7 +44,7 @@ module ActiveMerchant #:nodoc:
         commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Authorization', money, options)
       end
 
-      def purchase(money, token, payer_id, options = {})
+      def purchase(money, options = {})
         requires!(options, :token, :payer_id)
         
         commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Sale', money, options)
@@ -59,6 +64,8 @@ module ActiveMerchant #:nodoc:
       end
       
       def build_sale_or_authorization_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+        
         xml = Builder::XmlMarkup.new :indent => 2
         xml.tag! 'DoExpressCheckoutPaymentReq', 'xmlns' => PAYPAL_NAMESPACE do
           xml.tag! 'DoExpressCheckoutPaymentRequest', 'xmlns:n2' => EBAY_NAMESPACE do
@@ -68,8 +75,18 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'n2:Token', options[:token]
               xml.tag! 'n2:PayerID', options[:payer_id]
               xml.tag! 'n2:PaymentDetails' do
-                xml.tag! 'n2:OrderTotal', amount(money), 'currencyID' => currency(money)
+                xml.tag! 'n2:OrderTotal', amount(money), 'currencyID' => currency_code
+                
+                # All of the values must be included together and add up to the order total
+                if [:subtotal, :shipping, :handling, :tax].all?{ |o| options.has_key?(o) }
+                  xml.tag! 'n2:ItemTotal', amount(options[:subtotal]), 'currencyID' => currency_code
+                  xml.tag! 'n2:ShippingTotal', amount(options[:shipping]),'currencyID' => currency_code
+                  xml.tag! 'n2:HandlingTotal', amount(options[:handling]),'currencyID' => currency_code
+                  xml.tag! 'n2:TaxTotal', amount(options[:tax]), 'currencyID' => currency_code
+                end
+                
                 xml.tag! 'n2:NotifyURL', options[:notify_url]
+                xml.tag! 'n2:ButtonSource', application_id.to_s.slice(0,32) unless application_id.blank?
               end
             end
           end
@@ -85,12 +102,13 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'n2:Version', API_VERSION
             xml.tag! 'n2:SetExpressCheckoutRequestDetails' do
               xml.tag! 'n2:PaymentAction', action
-              xml.tag! 'n2:OrderTotal', amount(money), 'currencyID' => currency(money)
-              xml.tag! 'n2:MaxAmount', amount(options[:max_amount]), 'currencyID' => currency(options[:max_amount]) if options[:max_amount]
-              add_address(xml, 'n2:Address', options[:billing_address] || options[:address])
-              #xml.tag! 'n2:AddressOverride', 1
-              #xml.tag! 'n2:NoShipping', 1
-              xml.tag! 'n2:PageStyle', options[:page_style] unless options[:page_style].blank?
+              xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? amount(100) : amount(money), 'currencyID' => options[:currency] || currency(money)
+              if options[:max_amount]
+                xml.tag! 'n2:MaxAmount', amount(options[:max_amount]), 'currencyID' => options[:currency] || currency(options[:max_amount])
+              end
+              add_address(xml, 'n2:Address', options[:shipping_address] || options[:address])
+              xml.tag! 'n2:AddressOverride', options[:address_override] ? '1' : '0'
+              xml.tag! 'n2:NoShipping', options[:no_shipping] ? '1' : '0'
               xml.tag! 'n2:ReturnURL', options[:return_url]
               xml.tag! 'n2:CancelURL', options[:cancel_return_url]
               xml.tag! 'n2:IPAddress', options[:ip]
@@ -98,6 +116,13 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'n2:BuyerEmail', options[:email] unless options[:email].blank?
               xml.tag! 'n2:InvoiceID', options[:order_id]
         
+              # Customization of the payment page
+              xml.tag! 'n2:PageStyle', options[:page_style] unless options[:page_style].blank?
+              xml.tag! 'n2:cpp-image-header', options[:header_image] unless options[:header_image].blank?
+              xml.tag! 'n2:cpp-header-back-color', options[:header_background_color] unless options[:header_background_color].blank?
+              xml.tag! 'n2:cpp-header-border-color', options[:header_border_color] unless options[:header_border_color].blank?
+              xml.tag! 'n2:cpp-payflow-color', options[:background_color] unless options[:background_color].blank?
+              
               # This should be set to the same locale as the shop
               # localeCode          - String
             end

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

@@ -0,0 +1,300 @@
+module ActiveMerchant
+  module Billing
+        
+    class PlugnpayGateway < Gateway
+      class PlugnpayPostData < PostData
+        # Fields that will be sent even if they are blank
+        self.required_fields = [ :publisher_name, :publisher_password, 
+          :card_amount, :card_name, :card_number, :card_exp, :orderID ]
+      end                                                  
+                                                           
+      URL = 'https://pay1.plugnpay.com/payment/pnpremote.cgi'
+                                                        
+      CARD_CODE_MESSAGES = {
+        "M" => "Card verification number matched",
+        "N" => "Card verification number didn't match",
+        "P" => "Card verification number was not processed",
+        "S" => "Card verification number should be on card but was not indicated",
+        "U" => "Issuer was not certified for card verification"
+      }
+
+      CARD_CODE_ERRORS = %w( N S )
+      
+      AVS_MESSAGES = {
+        "A" => "Street address matches billing information, zip/postal code does not",
+        "B" => "Address information not provided for address verification check",
+        "E" => "Address verification service error",
+        "G" => "Non-U.S. card-issuing bank",
+        "N" => "Neither street address nor zip/postal match billing information",
+        "P" => "Address verification not applicable for this transaction",
+        "R" => "Payment gateway was unavailable or timed out",
+        "S" => "Address verification service not supported by issuer",
+        "U" => "Address information is unavailable",
+        "W" => "9-digit zip/postal code matches billing information, street address does not",
+        "X" => "Street address and 9-digit zip/postal code matches billing information",
+        "Y" => "Street address and 5-digit zip/postal code matches billing information",
+        "Z" => "5-digit zip/postal code matches billing information, street address does not",
+      }
+      
+      AVS_ERRORS = %w( A E N R W Z )
+      
+      PAYMENT_GATEWAY_RESPONSES = {
+        "P01" => "AVS Mismatch Failure",
+        "P02" => "CVV2 Mismatch Failure",
+        "P21" => "Transaction may not be marked",
+        "P30" => "Test Tran. Bad Card",
+        "P35" => "Test Tran. Problem",
+        "P40" => "Username already exists",
+        "P41" => "Username is blank",
+        "P50" => "Fraud Screen Failure",
+        "P51" => "Missing PIN Code",
+        "P52" => "Invalid Bank Acct. No.",
+        "P53" => "Invalid Bank Routing No.",
+        "P54" => "Invalid/Missing Check No.",
+        "P55" => "Invalid Credit Card No.",
+        "P56" => "Invalid CVV2/CVC2 No.",
+        "P57" => "Expired. CC Exp. Date",
+        "P58" => "Missing Data",
+        "P59" => "Missing Email Address",
+        "P60" => "Zip Code does not match Billing State.",
+        "P61" => "Invalid Billing Zip Code",
+        "P62" => "Zip Code does not match Shipping State.",
+        "P63" => "Invalid Shipping Zip Code",
+        "P64" => "Invalid Credit Card CVV2/CVC2 Format.",
+        "P65" => "Maximum number of attempts has been exceeded.",
+        "P66" => "Credit Card number has been flagged and can not be used to access this service.",
+        "P67" => "IP Address is on Blocked List.",
+        "P68" => "Billing country does not match ipaddress country.",
+        "P69" => "US based ipaddresses are currently blocked.",
+        "P70" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P71" => "Credit Cards issued from this bank are currently not being accepted.",
+        "P72" => "Daily volume exceeded.",
+        "P73" => "Too many transactions within allotted time.",
+        "P91" => "Missing/incorrect password",
+        "P92" => "Account not configured for mobil administration",
+        "P93" => "IP Not registered to username.",
+        "P94" => "Mode not permitted for this account.",
+        "P95" => "Currently Blank",
+        "P96" => "Currently Blank",
+        "P97" => "Processor not responding",
+        "P98" => "Missing merchant/publisher name",
+        "P99" => "Currently Blank"
+      }
+      
+      TRANSACTIONS = {
+        :authorization => 'auth',
+        :purchase => 'auth',
+        :capture => 'mark',
+        :void => 'void',
+        :refund => 'return',
+        :credit => 'newreturn'
+      }
+     
+      SUCCESS_CODES = [ 'pending', 'success' ]
+      FAILURE_CODES = [ 'badcard', 'fraud' ]
+     
+      # URL
+      attr_reader :response
+      attr_reader :options
+      
+      self.default_currency = 'USD'
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.plugnpay.com/'
+      self.display_name = "Plug'n Pay"
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+      
+      def purchase(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+        
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)
+        add_addresses(post, options)
+        add_invoice_data(post, options)
+        add_customer_data(post, options)
+         
+        post[:authtype] = 'authpostauth'
+        commit(:authorization, post)
+      end  
+      
+      def authorize(money, creditcard, options = {})
+        post = PlugnpayPostData.new
+        
+        add_amount(post, money, options)
+        add_creditcard(post, creditcard)        
+        add_addresses(post, options)
+        add_invoice_data(post, options)        
+        add_customer_data(post, options)
+        
+        post[:authtype] = 'authonly'
+        commit(:authorization, post)
+      end                  
+
+      def capture(money, authorization, options = {})
+        post = PlugnpayPostData.new
+        
+        post[:orderID] = authorization
+        
+        add_amount(post, money, options)
+        add_customer_data(post, options)
+         
+        commit(:capture, post)
+      end
+      
+      def void(authorization, options = {})
+        post = PlugnpayPostData.new
+        
+        post[:orderID] = authorization
+        post[:txn_type] = 'auth'
+        
+        commit(:void, post)
+      end
+      
+      def credit(money, identification_or_creditcard, options = {})
+        post = PlugnpayPostData.new
+        add_amount(post, money, options)
+       
+        if identification_or_creditcard.is_a?(String)
+          post[:orderID] = identification_or_creditcard
+          
+          commit(:refund, post)
+        else
+          add_creditcard(post, identification_or_creditcard)        
+          add_addresses(post, options)   
+          add_customer_data(post, options) 
+          
+          commit(:credit, post)
+        end
+      end
+      
+      private                                 
+      def commit(action, post)
+        if result = test_result_from_cc_number(post[:card_number])
+          return result
+        end
+                   
+        data = ssl_post(URL, post_data(action, post))
+           
+        @response = parse(data)
+        
+        success = SUCCESS_CODES.include?(@response[:finalstatus])
+        message = success ? 'Success' : message_from(@response)
+            
+        Response.new(success, message, @response, 
+          :test => test?, 
+          :authorization => @response[:orderid]
+        )
+      end
+                                               
+      def parse(body)
+        body = CGI.unescape(body)
+        results = {}
+        body.split('&').collect { |e| e.split('=') }.each do |key,value|
+          results[key.downcase.to_sym] = normalize(value.to_s.strip)
+        end
+        
+        results.delete(:publisher_password)
+        results[:avs_message] = AVS_MESSAGES[results[:avs_code]] if results[:avs_code]
+        results[:card_code_message] = CARD_CODE_MESSAGES[results[:cvvresp]] if results[:cvvresp]
+        
+        results
+      end     
+
+      def post_data(action, post)
+        post[:mode]               = TRANSACTIONS[action]
+        post[:convert]            = 'underscores'
+        post[:app_level]          = 0
+        post[:publisher_name]     = @options[:login]
+        post[:publisher_password] = @options[:password]
+      
+        post.to_s
+      end
+      
+      def add_creditcard(post, creditcard)      
+        post[:card_number]  = creditcard.number
+        post[:card_cvv]     = creditcard.verification_value
+        post[:card_exp]     = expdate(creditcard)
+        post[:card_name]    = creditcard.name.slice(0..38)
+      end
+      
+      def add_customer_data(post, options)
+        post[:email] = options[:email]
+        post[:dontsndmail]        = 'yes' unless options[:send_email_confirmation]
+        post[:ipaddress] = options[:ip]
+      end
+      
+      def add_invoice_data(post, options)
+        post[:shipping] = amount(options[:shipping]) unless options[:shipping].blank?
+        post[:tax] = amount(options[:tax]) unless options[:tax].blank?  
+      end
+
+      def add_addresses(post, options)      
+        if address = options[:billing_address] || options[:address]
+          post[:card_address1] = address[:address1]
+          post[:card_zip]      = address[:zip]     
+          post[:card_city]     = address[:city]    
+          post[:card_country]  = address[:country]
+          post[:phone]         = address[:phone]
+
+          case address[:country]
+          when 'US', 'CA'
+            post[:card_state] = address[:state]
+          else
+            post[:card_state] = 'ZZ' 
+            post[:card_prov]  = address[:state]
+          end
+        end
+        
+        if shipping_address = options[:shipping_address] || address
+          post[:shipname] = shipping_address[:name]
+          post[:address1] = shipping_address[:address1]
+          post[:address2] = shipping_address[:address2]
+          post[:city] = shipping_address[:city]
+          
+          case shipping_address[:country]
+          when 'US', 'CA'
+            post[:state] = shipping_address[:state]
+          else
+            post[:state] = 'ZZ' 
+            post[:province]  = shipping_address[:state]
+          end
+          
+          post[:country] = shipping_address[:country]
+          post[:zip] = shipping_address[:zip]
+        end        
+      end
+      
+      def add_amount(post, money, options)
+        post[:card_amount] = amount(money)
+        post[:currency] = options[:currency] || currency(money)
+      end
+    
+      # Make a ruby type out of the response string
+      def normalize(field)
+        case field
+        when "true"   then true
+        when "false"  then false
+        when ""       then nil
+        when "null"   then nil
+        else field
+        end        
+      end          
+      
+      def message_from(results)
+        PAYMENT_GATEWAY_RESPONSES[results[:resp_code]]
+      end
+        
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{month}/#{year[-2..-1]}"
+      end
+    end
+  end
+end