tlconnor-activemerchant 1.20.4

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

@@ -0,0 +1,49 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PaypalExpressResponse < Response
+      def email
+        info['Payer']
+      end
+
+      def info
+        (@params['PayerInfo']||{})
+      end
+      
+      def name
+        payer = (info['PayerName']||{})
+        [payer['FirstName'], payer['MiddleName'], payer['LastName']].compact.join(' ')
+      end
+      
+      def token
+        @params['Token']
+      end
+      
+      def payer_id
+        info['PayerID']
+      end
+      
+      def payer_country
+        info['PayerCountry']
+      end
+      
+      # PayPal returns a contact telephone number only if your Merchant account profile settings require that the buyer enter one.
+      def contact_phone
+        @params['ContactPhone']
+      end
+      
+      def address
+        address = (@params['PaymentDetails']||{})['ShipToAddress']
+        {  'name'       => address['Name'],
+           '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'])
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,229 @@
+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'
+      self.supported_countries = ['US']
+      self.homepage_url = 'https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside'
+      self.display_name = 'PayPal Express Checkout'
+      
+      def setup_authorization(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+        
+        commit 'SetExpressCheckout', build_setup_request('Authorization', money, options)
+      end
+      
+      def setup_purchase(money, options = {})
+        requires!(options, :return_url, :cancel_return_url)
+        
+        commit 'SetExpressCheckout', build_setup_request('Sale', money, options)
+      end
+
+      def details_for(token)
+        commit 'GetExpressCheckoutDetails', build_get_details_request(token)
+      end
+
+      def authorize(money, options = {})
+        requires!(options, :token, :payer_id)
+      
+        commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Authorization', money, options)
+      end
+
+      def purchase(money, options = {})
+        requires!(options, :token, :payer_id)
+        
+        commit 'DoExpressCheckoutPayment', build_sale_or_authorization_request('Sale', money, options)
+      end
+
+      def reference_transaction(money, options = {})
+        requires!(options, :reference_id, :payment_type, :invoice_id, :description, :ip)
+
+        commit 'DoReferenceTransaction', build_reference_transaction_request('Sale', money, options)
+      end
+
+      private
+      def build_get_details_request(token)
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'GetExpressCheckoutDetailsReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'GetExpressCheckoutDetailsRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'Token', token
+          end
+        end
+
+        xml.target!
+      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
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:DoExpressCheckoutPaymentRequestDetails' do
+              xml.tag! 'n2:PaymentAction', action
+              xml.tag! 'n2:Token', options[:token]
+              xml.tag! 'n2:PayerID', options[:payer_id]
+              xml.tag! 'n2:PaymentDetails' do
+                xml.tag! 'n2:OrderTotal', localized_amount(money, currency_code), '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', localized_amount(options[:subtotal], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:ShippingTotal', localized_amount(options[:shipping], currency_code),'currencyID' => currency_code
+                  xml.tag! 'n2:HandlingTotal', localized_amount(options[:handling], currency_code),'currencyID' => currency_code
+                  xml.tag! 'n2:TaxTotal', localized_amount(options[:tax], currency_code), '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?
+                xml.tag! 'n2:InvoiceID', options[:order_id]
+                xml.tag! 'n2:OrderDescription', options[:description]
+
+                add_items_xml(xml, options, currency_code) if options[:items]
+              end
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_setup_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+        
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'SetExpressCheckoutReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'SetExpressCheckoutRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:SetExpressCheckoutRequestDetails' do
+              xml.tag! 'n2:ReturnURL', options[:return_url]
+              xml.tag! 'n2:CancelURL', options[:cancel_return_url]
+              if options[:max_amount]
+                xml.tag! 'n2:MaxAmount', localized_amount(options[:max_amount], currency_code), 'currencyID' => currency_code
+              end
+              xml.tag! 'n2:NoShipping', options[:no_shipping] ? '1' : '0'
+              xml.tag! 'n2:AddressOverride', options[:address_override] ? '1' : '0'
+              xml.tag! 'n2:LocaleCode', options[:locale] unless options[:locale].blank?
+              xml.tag! 'n2:BrandName', options[:brand_name] unless options[:brand_name].blank?
+              # Customization of the payment page
+              xml.tag! 'n2:PageStyle', options[:page_style] unless options[:page_style].blank?
+              xml.tag! 'n2:cpp-header-image', options[:header_image] unless options[:header_image].blank?
+              xml.tag! 'n2:cpp-header-border-color', options[:header_border_color] unless options[:header_border_color].blank?
+              xml.tag! 'n2:cpp-header-back-color', options[:header_background_color] unless options[:header_background_color].blank?
+              xml.tag! 'n2:cpp-payflow-color', options[:background_color] unless options[:background_color].blank?
+              if options[:allow_guest_checkout]
+                xml.tag! 'n2:SolutionType', 'Sole'
+                xml.tag! 'n2:LandingPage', 'Billing'
+              end
+              xml.tag! 'n2:BuyerEmail', options[:email] unless options[:email].blank?
+
+              if options[:billing_agreement]
+                xml.tag! 'n2:BillingAgreementDetails' do
+                  xml.tag! 'n2:BillingType', options[:billing_agreement][:type]
+                  xml.tag! 'n2:BillingAgreementDescription', options[:billing_agreement][:description]
+                  xml.tag! 'n2:PaymentType', options[:billing_agreement][:payment_type] || 'InstantOnly'
+                end
+              end
+
+              if !options[:allow_note].nil?
+                xml.tag! 'n2:AllowNote', options[:allow_note] ? '1' : '0'
+              end
+              xml.tag! 'n2:CallbackURL', options[:callback_url] unless options[:callback_url].blank?
+
+              xml.tag! 'n2:PaymentDetails' do
+                xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), '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', localized_amount(options[:subtotal], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:ShippingTotal', localized_amount(options[:shipping], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:HandlingTotal', localized_amount(options[:handling], currency_code), 'currencyID' => currency_code
+                  xml.tag! 'n2:TaxTotal', localized_amount(options[:tax], currency_code), 'currencyID' => currency_code
+                end
+
+                xml.tag! 'n2:OrderDescription', options[:description]
+                xml.tag! 'n2:InvoiceID', options[:order_id]
+
+                add_address(xml, 'n2:ShipToAddress', options[:shipping_address] || options[:address])
+
+                add_items_xml(xml, options, currency_code) if options[:items]
+
+                xml.tag! 'n2:PaymentAction', action
+                xml.tag! 'n2:Custom', options[:custom] unless options[:custom].blank?
+              end
+
+              if options[:shipping_options]
+                options[:shipping_options].each do |shipping_option|
+                  xml.tag! 'n2:FlatRateShippingOptions' do
+                    xml.tag! 'n2:ShippingOptionIsDefault', shipping_option[:default]
+                    xml.tag! 'n2:ShippingOptionAmount', localized_amount(shipping_option[:amount], currency_code), 'currencyID' => currency_code
+                    xml.tag! 'n2:ShippingOptionName', shipping_option[:name]
+                  end
+                end
+              end
+
+              xml.tag! 'n2:CallbackTimeout', options[:callback_timeout] unless options[:callback_timeout].blank?
+              xml.tag! 'n2:CallbackVersion', options[:callback_version] unless options[:callback_version].blank?
+            end
+          end
+        end
+
+        xml.target!
+      end
+      
+      def build_reference_transaction_request(action, money, options)
+        currency_code = options[:currency] || currency(money)
+
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.tag! 'DoReferenceTransactionReq', 'xmlns' => PAYPAL_NAMESPACE do
+          xml.tag! 'DoReferenceTransactionRequest', 'xmlns:n2' => EBAY_NAMESPACE do
+            xml.tag! 'n2:Version', API_VERSION
+            xml.tag! 'n2:DoReferenceTransactionRequestDetails' do
+              xml.tag! 'n2:ReferenceID', options[:reference_id]
+              xml.tag! 'n2:PaymentAction', action
+              xml.tag! 'n2:PaymentType', options[:payment_type] || 'Any'
+              xml.tag! 'n2:PaymentDetails' do
+                xml.tag! 'n2:OrderTotal', amount(money).to_f.zero? ? localized_amount(100, currency_code) : localized_amount(money, currency_code), 'currencyID' => currency_code
+                xml.tag! 'n2:OrderDescription', options[:description]
+                xml.tag! 'n2:InvoiceID', options[:invoice_id]
+                xml.tag! 'n2:ButtonSource', 'ActiveMerchant'
+                xml.tag! 'n2:NotifyURL', ''
+              end
+              xml.tag! 'n2:IPAddress', options[:ip]
+            end
+          end
+        end
+
+        xml.target!
+      end
+
+      def build_response(success, message, response, options = {})
+        PaypalExpressResponse.new(success, message, response, options)
+      end
+
+      private
+
+      def add_items_xml(xml, options, currency_code)
+        options[:items].each do |item|
+          xml.tag! 'n2:PaymentDetailsItem' do
+            xml.tag! 'n2:Name', item[:name]
+            xml.tag! 'n2:Number', item[:number]
+            xml.tag! 'n2:Quantity', item[:quantity]
+            if item[:amount]
+              xml.tag! 'n2:Amount', localized_amount(item[:amount], currency_code), 'currencyID' => currency_code
+            end
+            xml.tag! 'n2:Description', item[:description]
+            xml.tag! 'n2:ItemURL', item[:url]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+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'
+      end
+      
+      def redirect_url
+        test? ? test_redirect_url : live_redirect_url
+      end
+      
+      def redirect_url_for(token, options = {})
+        options = {:review => true, :mobile => false}.update(options)
+
+        cmd  = options[:mobile] ? '_express-checkout-mobile' : '_express-checkout'
+        url  = "#{redirect_url}?cmd=#{cmd}&token=#{token}"
+        url += '&useraction=commit' unless options[:review]
+
+        url
+      end
+    end
+  end
+end

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

@@ -0,0 +1,201 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PaystationGateway < Gateway
+      
+      URL = "https://www.paystation.co.nz/direct/paystation.dll"
+      
+      # an "error code" of "0" means "No error - transaction successful"
+      SUCCESSFUL_RESPONSE_CODE = '0'
+      
+      # an "error code" of "34" means "Future Payment Stored OK"
+      SUCCESSFUL_FUTURE_PAYMENT = '34'
+      
+      # TODO: check this with paystation
+      self.supported_countries = ['NZ']
+      
+      # TODO: check this with paystation (amex and diners need to be enabled)
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club ]
+      
+      self.homepage_url        = 'http://paystation.co.nz'
+      self.display_name        = 'Paystation'
+      
+      self.default_currency    = 'NZD'
+      self.money_format        = :cents
+        
+      def initialize(options = {})
+        # You need to pass your Paystation ID and Gateway ID
+        requires!(options, :paystation_id, :gateway_id)
+        @options = options
+        super
+      end  
+      
+      def authorize(money, credit_card, options = {})
+        post = new_request
+        
+        add_invoice(post, options)
+        add_amount(post, money, options)
+        
+        add_credit_card(post, credit_card)
+        
+        add_authorize_flag(post, options)
+        
+        commit(post)
+      end
+      
+      def capture(money, authorization_token, options = {})
+        post = new_request
+        
+        add_invoice(post, options)
+        add_amount(post, money, options)
+        
+        add_authorization_token(post, authorization_token, options[:credit_card_verification])
+        
+        commit(post)
+      end
+      
+      def purchase(money, payment_source, options = {})
+        post = new_request
+        
+        add_invoice(post, options)
+        add_amount(post, money, options)
+        
+        if payment_source.is_a?(String)
+          add_token(post, payment_source)        
+        else
+          add_credit_card(post, payment_source)
+        end
+        
+        add_customer_data(post, options) if options.has_key?(:customer)
+        
+        commit(post)
+      end                       
+    
+      def store(credit_card, options = {})
+        post = new_request
+        
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)
+        store_credit_card(post, options)
+        
+        commit(post)
+      end
+    
+      private    
+      
+        def new_request
+          { 
+            :pi    => @options[:paystation_id], # paystation account id
+            :gi    => @options[:gateway_id],    # paystation gateway id
+            "2p"   => "t",                      # two-party transaction type
+            :nr    => "t",                      # -- redirect??
+            :df    => "yymm"                    # date format: optional sometimes, required others
+          } 
+        end
+      
+        def add_customer_data(post, options)
+          post[:mc] = options[:customer]
+        end
+
+        def add_invoice(post, options)
+          requires!(options, :order_id)
+
+          post[:ms] = options[:order_id]     # "Merchant Session", must be unique per request
+          post[:mo] = options[:invoice]      # "Order Details", displayed in Paystation Admin
+          post[:mr] = options[:description]  # "Merchant Reference Code", seen from Paystation Admin
+        end
+      
+        def add_credit_card(post, credit_card)     
+          
+          post[:cn] = credit_card.number
+          post[:ct] = credit_card.type
+          post[:ex] = format_date(credit_card.month, credit_card.year)
+          post[:cc] = credit_card.verification_value if credit_card.verification_value?
+          
+        end
+        
+        # bill a token (stored via "store") rather than a Credit Card
+        def add_token(post, token)
+          post[:fp] = "t"    # turn on "future payments" - what paystation calls Token Billing
+          post[:ft] = token
+        end
+        
+        def store_credit_card(post, options)
+          
+          post[:fp] = "t"                                # turn on "future payments" - what paystation calls Token Billing
+          post[:fs] = "t"                                # tells paystation to store right now, not bill
+          post[:ft] = options[:token] if options[:token] # specify a token to use that, or let Paystation generate one
+        
+        end
+        
+        def add_authorize_flag(post, options)
+          post[:pa] = "t" # tells Paystation that this is a pre-auth authorisation payment (account must be in pre-auth mode)
+        end
+        
+        def add_authorization_token(post, auth_token, verification_value = nil)
+          post[:cp] = "t" # Capture Payment flag – tells Paystation this transaction should be treated as a capture payment
+          post[:cx] = auth_token
+          post[:cc] = verification_value
+        end
+        
+        def add_amount(post, money, options)
+          
+          post[:am] = amount(money)
+          post[:cu] = options[:currency] || currency(money)
+          
+        end
+      
+        def parse(xml_response)
+          response = {}
+          
+          xml = REXML::Document.new(xml_response)
+          
+          # for normal payments, the root node is <Response>
+          # for "future payments", it's <PaystationFuturePaymentResponse>
+          xml.elements.each("#{xml.root.name}/*") do |element|
+            response[element.name.underscore.to_sym] = element.text
+          end
+                  
+          response
+        end     
+      
+        def commit(post)
+          
+          post[:tm] = "T" if test? # test mode
+        
+          pstn_prefix_params = post.collect { |key, value| "pstn_#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+          
+          # need include paystation param as "initiator flag for payment engine"
+          data     = ssl_post(URL, "#{pstn_prefix_params}&paystation=_empty")
+          response = parse(data)
+          message  = message_from(response)
+          
+          PaystationResponse.new(success?(response), message, response, 
+              :test          => (response[:tm] && response[:tm].downcase == "t"),
+              :authorization => response[:paystation_transaction_id]
+          )
+        end
+        
+        def success?(response)
+          (response[:ec] == SUCCESSFUL_RESPONSE_CODE) || (response[:ec] == SUCCESSFUL_FUTURE_PAYMENT)
+        end
+
+        def message_from(response)
+          response[:em]
+        end
+        
+        def format_date(month, year)
+          "#{format(year, :two_digits)}#{format(month, :two_digits)}"
+        end
+        
+    end
+    
+    class PaystationResponse < Response
+      # add a method to response so we can easily get the token
+      # for Validate transactions
+      def token
+        @params["future_payment_token"]
+      end
+    end
+  end
+end
+