gonow-activemerchant 1.15.0

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

@@ -0,0 +1,308 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class BarclaysEpdqGateway < Gateway
+      TEST_URL = 'https://secure2.mde.epdq.co.uk:11500'
+      LIVE_URL = 'https://secure2.epdq.co.uk:11500'
+
+      self.supported_countries = ['UK']
+      self.default_currency = 'GBP'
+      self.supported_cardtypes = [:visa, :master, :maestro, :switch ]
+      self.money_format = :cents
+      self.homepage_url = 'http://www.barclaycard.co.uk/business/accepting-payments/epdq-mpi/'
+      self.display_name = 'Barclays ePDQ'
+      
+      def initialize(options = {})
+        requires!(options, :login, :password, :client_id)
+        @options = options
+        super
+      end  
+      
+      def authorize(money, creditcard, options = {})
+        document = Document.new(self, @options) do
+          add_order_form(options[:order_id]) do
+            add_consumer(options) do
+              add_creditcard(creditcard)
+            end
+            add_transaction(:PreAuth, money)
+          end
+        end
+
+        commit(document)
+      end
+      
+      def purchase(money, creditcard, options = {})
+        # disable fraud checks if this is a repeat order:
+        if options[:payment_number] && (options[:payment_number] > 1)
+          no_fraud = true
+        else
+          no_fraud = options[:no_fraud]
+        end
+        document = Document.new(self, @options, :no_fraud => no_fraud) do
+          add_order_form(options[:order_id], options[:group_id]) do
+            add_consumer(options) do
+              add_creditcard(creditcard)
+            end
+            add_transaction(:Auth, money, options)
+          end
+        end
+        commit(document)
+      end                       
+    
+      # authorization is your unique order ID, not the authorization 
+      # code returned by ePDQ
+      def capture(money, authorization, options = {})
+        document = Document.new(self, @options) do
+          add_order_form(authorization) do
+            add_transaction(:PostAuth, money)
+          end
+        end
+
+        commit(document)
+      end
+
+      # authorization is your unique order ID, not the authorization 
+      # code returned by ePDQ
+      def credit(money, creditcard_or_authorization, options = {})
+        if creditcard_or_authorization.is_a?(String)
+          deprecated CREDIT_DEPRECATION_MESSAGE
+          refund(money, creditcard_or_authorization, options)
+        else
+          credit_new_order(money, creditcard_or_authorization, options)
+        end
+      end
+
+      def refund(money, authorization, options = {})
+        credit_existing_order(money, authorization, options)
+      end
+
+      def void(authorization, options = {})
+        document = Document.new(self, @options) do
+          add_order_form(authorization) do
+            add_transaction(:Void)
+          end
+        end
+
+        commit(document)
+      end
+
+      private                       
+      def credit_new_order(money, creditcard, options)
+        document = Document.new(self, @options) do
+          add_order_form do
+            add_consumer(options) do
+              add_creditcard(creditcard)
+            end
+            add_transaction(:Credit, money)
+          end
+        end
+
+        commit(document)
+      end
+
+      def credit_existing_order(money, authorization, options)
+        order_id, _ = authorization.split(":")
+        document = Document.new(self, @options) do
+          add_order_form(order_id) do
+            add_transaction(:Credit, money)
+          end
+        end
+        
+        commit(document)
+      end
+      
+      def parse(body)
+        parser = Parser.new(body)
+        response = parser.parse
+        Response.new(response[:success], response[:message], response,
+          :test => test?,
+          :authorization => response[:authorization],
+          :avs_result => response[:avsresponse],
+          :cvv_result => response[:cvv_result],
+          :order_id => response[:order_id],
+          :raw_response => response[:raw_response]
+        )
+      end     
+      
+      def commit(document)
+        url = (test? ? TEST_URL : LIVE_URL)
+        data = ssl_post(url, document.to_xml)
+        parse(data)
+      end
+
+      class Parser
+        def initialize(response)
+          @response = response
+        end
+
+        def parse
+          doc = REXML::Document.new(@response)
+          auth_type = find(doc, "//Transaction/Type").to_s
+
+          message = find(doc, "//Message/Text")
+          if message.blank?
+            message = find(doc, "//Transaction/CardProcResp/CcReturnMsg")
+          end
+
+          case auth_type
+          when 'Credit', 'Void'
+            success = find(doc, "//CcReturnMsg") == "Approved."
+          else
+            success = find(doc, "//Transaction/AuthCode").present?
+          end
+
+          {       
+            :success => success,
+            :message => message,
+            :authorization => find(doc, "//Transaction/Id"),
+            :avs_result => find(doc, "//Transaction/AvsRespCode"),
+            :cvv_result => find(doc, "//Transaction/Cvv2Resp"),
+            :order_id => find(doc, "//OrderFormDoc/Transaction/Id"),
+            :raw_response => @response
+          }
+        end
+
+        def find(doc, xpath)
+          REXML::XPath.first(doc, xpath).try(:text)
+        end
+      end
+
+      class Document
+        attr_reader :type, :xml
+
+        PAYMENT_INTERVALS = { 
+          :days => 'D',
+          :months => 'M'
+        }
+
+        EPDQ_CARD_TYPES = {
+          :visa => 1,
+          :master => 2,
+          :switch => 9,
+          :maestro => 10,
+        }
+      
+        def initialize(gateway, options = {}, document_options = {}, &block)
+          @gateway = gateway
+          @options = options
+          @document_options = document_options
+          @xml = Builder::XmlMarkup.new(:indent => 2)
+          build(&block)
+        end
+
+        def to_xml
+          @xml.target!
+        end
+
+        def build(&block)
+          xml.instruct!(:xml, :version => '1.0')
+          xml.EngineDocList do
+            xml.DocVersion "1.0"
+            xml.EngineDoc do
+              xml.ContentType "OrderFormDoc"
+              xml.User do
+                xml.Name(@options[:login])
+                xml.Password(@options[:password])
+                xml.ClientId({ :DataType => "S32" }, @options[:client_id])
+              end
+              xml.Instructions do
+                if @document_options[:no_fraud]
+                  xml.Pipeline "PaymentNoFraud" 
+                else
+                  xml.Pipeline "Payment"
+                end
+              end
+              instance_eval(&block)
+            end
+          end
+        end
+
+        def add_order_form(order_id=nil, group_id=nil, &block)
+          xml.OrderFormDoc do
+            xml.Mode 'P'
+            xml.Id(order_id) if order_id
+            xml.GroupId(group_id) if group_id
+            instance_eval(&block)
+          end
+        end
+
+        def add_consumer(options=nil, &block)
+          xml.Consumer do
+            if options
+              xml.Email(options[:email]) if options[:email]
+              billing_address = options[:billing_address] || options[:address]
+              if billing_address
+                xml.BillTo do
+                  xml.Location do
+                    xml.Address do
+                      xml.Street1 billing_address[:address1]
+                      xml.Street2 billing_address[:address2]
+                      xml.City billing_address[:city]
+                      xml.StateProv billing_address[:state]
+                      xml.PostalCode billing_address[:zip]
+                      xml.Country billing_address[:country_code]
+                    end
+                  end
+                end
+              end
+            end
+            instance_eval(&block)
+          end
+        end
+
+        def add_creditcard(creditcard)
+          xml.PaymentMech do
+            xml.CreditCard do
+              xml.Type({ :DataType => 'S32' }, EPDQ_CARD_TYPES[creditcard.brand.to_sym])
+              xml.Number creditcard.number
+              xml.Expires({ :DataType => 'ExpirationDate', :Locale => 826 }, format_expiry_date(creditcard))
+              if creditcard.verification_value.present?
+                xml.Cvv2Indicator 1
+                xml.Cvv2Val creditcard.verification_value
+              else
+                xml.Cvv2Indicator 5
+              end
+              xml.IssueNum(creditcard.issue_number) if creditcard.issue_number.present?
+            end
+          end
+        end
+
+        def add_transaction(auth_type, amount = nil, options = {})
+          @auth_type = auth_type
+          xml.Transaction do
+            xml.Type @auth_type.to_s
+            if options[:payment_number] && options[:payment_number] > 1
+              xml.CardholderPresentCode({ :DataType => 'S32' }, 8)
+            else
+              xml.CardholderPresentCode({ :DataType => 'S32' }, 7)
+            end
+            if options[:payment_number]
+              xml.PaymentNumber({ :DataType => 'S32' }, options[:payment_number])
+            end
+            if options[:total_payments]
+              xml.TotalNumberPayments({ :DataType => 'S32' }, options[:total_payments])
+            end
+            if amount
+              xml.CurrentTotals do
+                xml.Totals do
+                  xml.Total({ :DataType => 'Money', :Currency => 826 }, amount)
+                end
+              end
+            end
+          end
+        end
+
+        # date must be formatted MM/YY
+        def format_expiry_date(creditcard)
+          month_str = "%02d" % creditcard.month
+          if match = creditcard.year.to_s.match(/^\d{2}(\d{2})$/) 
+            year_str = "%02d" % match[1].to_i
+          else 
+            year_str = "%02d" % creditcard.year
+          end
+          "#{month_str}/#{year_str}"
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,139 @@
+require File.dirname(__FILE__) + '/beanstream/beanstream_core'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # This class implements the Canadian {Beanstream}[http://www.beanstream.com] payment gateway.
+    # It is also named TD Canada Trust Online Mart payment gateway.
+    # To learn more about the specification of Beanstream gateway, please read the OM_Direct_Interface_API.pdf,
+    # which you can get from your Beanstream account or get from me by email.
+    #  
+    # == Supported transaction types by Beanstream:
+    # * +P+ - Purchase
+    # * +PA+ - Pre Authorization
+    # * +PAC+ - Pre Authorization Completion
+    #  
+    # == Secure Payment Profiles:
+    # BeanStream supports payment profiles (vaults). This allows you to store cc information with BeanStream and process subsequent transactions with a customer id.
+    # Secure Payment Profiles must be enabled on your account (must be done over the phone).
+    # Your API Access Passcode must be set in Administration => account settings => order settings.
+    # To learn more about storing credit cards with the Beanstream gateway, please read the BEAN_Payment_Profiles.pdf (I had to phone BeanStream to request it.)
+    # 
+    # == Notes 
+    # * Recurring billing is not yet implemented.
+    # * Adding of order products information is not implemented.
+    # * Ensure that country and province data is provided as a code such as "CA", "US", "QC".
+    # * login is the Beanstream merchant ID, username and password should be enabled in your Beanstream account and passed in using the <tt>:user</tt> and <tt>:password</tt> options.
+    # * Test your app with your true merchant id and test credit card information provided in the api pdf document.
+    # * Beanstream does not allow Payment Profiles to be deleted with their API. The accounts are 'closed', but have to be deleted manually.  
+    #  
+    #  Example authorization (Beanstream PA transaction type):
+    #  
+    #   twenty = 2000
+    #   gateway = BeanstreamGateway.new(
+    #     :login => '100200000',
+    #     :user => 'xiaobozz',
+    #     :password => 'password'
+    #   )
+    #   
+    #   credit_card = CreditCard.new(
+    #     :number => '4030000010001234',
+    #     :month => 8,
+    #     :year => 2011,
+    #     :first_name => 'xiaobo',
+    #     :last_name => 'zzz',
+    #     :verification_value => 137
+    #   )
+    #   response = gateway.authorize(twenty, credit_card,
+    #     :order_id => '1234',
+    #     :billing_address => {
+    #       :name => 'xiaobo zzz',
+    #       :phone => '555-555-5555',
+    #       :address1 => '1234 Levesque St.',
+    #       :address2 => 'Apt B',
+    #       :city => 'Montreal',
+    #       :state => 'QC',
+    #       :country => 'CA',
+    #       :zip => 'H2C1X8'
+    #     },
+    #     :email => 'xiaobozzz@example.com',
+    #     :subtotal => 800,
+    #     :shipping => 100,
+    #     :tax1 => 100,
+    #     :tax2 => 100,
+    #     :custom => 'reference one'
+    #   )
+    class BeanstreamGateway < Gateway
+      include BeanstreamCore
+      
+      def authorize(money, source, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_source(post, source)        
+        add_address(post, options)
+        add_transaction_type(post, :authorization)
+        commit(post)
+      end
+      
+      def purchase(money, source, options = {})
+        post = {}
+        add_amount(post, money) 
+        add_invoice(post, options)
+        add_source(post, source)
+        add_address(post, options)
+        add_transaction_type(post, purchase_action(source))
+        commit(post)
+      end                       
+          
+      def void(authorization, options = {})
+        reference, amount, type = split_auth(authorization)
+        
+        post = {}
+        add_reference(post, reference)
+        add_original_amount(post, amount)
+        add_transaction_type(post, void_action(type))
+        commit(post)
+      end
+      
+      def interac
+        @interac ||= BeanstreamInteracGateway.new(@options)
+      end
+      
+      # To match the other stored-value gateways, like TrustCommerce,
+      # store and unstore need to be defined
+      def store(credit_card, options = {})
+        post = {}        
+        add_address(post, options)
+        add_credit_card(post, credit_card)      
+        add_secure_profile_variables(post,options)
+        commit(post, true)
+      end
+      
+      #can't actually delete a secure profile with the supplicaed API. This function sets the status of the profile to closed (C).
+      #Closed profiles will have to removed manually.
+      def delete(vault_id)
+        update(vault_id, false, {:status => "C"})
+      end
+      
+      alias_method :unstore, :delete
+      
+      # Update the values (such as CC expiration) stored at
+      # the gateway.  The CC number must be supplied in the
+      # CreditCard object.
+      def update(vault_id, credit_card, options = {})
+        post = {}
+        add_address(post, options)
+        add_credit_card(post, credit_card)
+        options.merge!({:vault_id => vault_id, :operation => secure_profile_action(:modify)})
+        add_secure_profile_variables(post,options)
+        commit(post, true)
+      end
+
+      private
+      def build_response(*args)
+        Response.new(*args)
+      end
+    end
+  end
+end
+

data/lib/active_merchant/billing/gateways/beanstream/beanstream_core.rb

@@ -0,0 +1,282 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module BeanstreamCore
+      URL = 'https://www.beanstream.com/scripts/process_transaction.asp'
+      SECURE_PROFILE_URL = 'https://www.beanstream.com/scripts/payment_profile.asp'
+      SP_SERVICE_VERSION = '1.1'
+
+      TRANSACTIONS = {
+        :authorization  => 'PA',
+        :purchase       => 'P',
+        :capture        => 'PAC',
+        :refund         => 'R',
+        :void           => 'VP',
+        :check_purchase => 'D',
+        :check_refund   => 'C',
+        :void_purchase  => 'VP',
+        :void_refund    => 'VR'
+      }
+
+      PROFILE_OPERATIONS = {
+        :new => 'N',
+        :modify => 'M'
+      }
+
+      CVD_CODES = {
+        '1' => 'M',
+        '2' => 'N',
+        '3' => 'I',
+        '4' => 'S',
+        '5' => 'U',
+        '6' => 'P'
+      }
+
+      AVS_CODES = {
+        '0' => 'R',
+        '5' => 'I',
+        '9' => 'I'
+      }
+      
+      def self.included(base)
+        base.default_currency = 'CAD'
+
+        # The countries the gateway supports merchants from as 2 digit ISO country codes
+        base.supported_countries = ['CA']
+
+        # The card types supported by the payment gateway
+        base.supported_cardtypes = [:visa, :master, :american_express]
+
+        # The homepage URL of the gateway
+        base.homepage_url = 'http://www.beanstream.com/'
+
+        # The name of the gateway
+        base.display_name = 'Beanstream.com'
+      end
+      
+      # Only <tt>:login</tt> is required by default, 
+      # which is the merchant's merchant ID. If you'd like to perform void, 
+      # capture or refund transactions then you'll also need to add a username
+      # and password to your account under administration -> account settings ->
+      # order settings -> Use username/password validation
+      def initialize(options = {})
+        requires!(options, :login)
+        @options = options
+        super
+      end
+      
+      def capture(money, authorization, options = {})
+        reference, amount, type = split_auth(authorization)
+        
+        post = {}
+        add_amount(post, money)
+        add_reference(post, reference)
+        add_transaction_type(post, :capture)
+        commit(post)
+      end
+      
+      def refund(money, source, options = {})
+        post = {}
+        reference, amount, type = split_auth(source)
+        add_reference(post, reference)
+        add_transaction_type(post, refund_action(type))
+        add_amount(post, money)
+        commit(post)
+      end
+
+      def credit(money, source, options = {})
+        deprecated Gateway::CREDIT_DEPRECATION_MESSAGE
+        refund(money, source, options)
+      end
+    
+      private
+      def purchase_action(source)
+        (card_brand(source) == "check") ? :check_purchase : :purchase
+      end
+      
+      def void_action(original_transaction_type)
+        (original_transaction_type == TRANSACTIONS[:refund]) ? :void_refund : :void_purchase
+      end
+      
+      def refund_action(type)
+        (type == TRANSACTIONS[:check_purchase]) ? :check_refund : :refund
+      end
+      
+      def secure_profile_action(type)
+        PROFILE_OPERATIONS[type] || PROFILE_OPERATIONS[:new]
+      end
+      
+      def split_auth(string)
+        string.split(";")
+      end
+      
+      def add_amount(post, money)
+        post[:trnAmount] = amount(money)
+      end
+      
+      def add_original_amount(post, amount)
+        post[:trnAmount] = amount
+      end
+
+      def add_reference(post, reference)                
+        post[:adjId] = reference
+      end
+      
+      def add_address(post, options)
+        prepare_address_for_non_american_countries(options)
+        
+        if billing_address = options[:billing_address] || options[:address]
+          post[:ordName]          = billing_address[:name]
+          post[:ordEmailAddress]  = options[:email]
+          post[:ordPhoneNumber]   = billing_address[:phone]
+          post[:ordAddress1]      = billing_address[:address1]
+          post[:ordAddress2]      = billing_address[:address2]
+          post[:ordCity]          = billing_address[:city]
+          post[:ordProvince]      = billing_address[:state]
+          post[:ordPostalCode]    = billing_address[:zip]
+          post[:ordCountry]       = billing_address[:country]
+        end
+        if shipping_address = options[:shipping_address]
+          post[:shipName]         = shipping_address[:name]
+          post[:shipEmailAddress] = options[:email]
+          post[:shipPhoneNumber]  = shipping_address[:phone]
+          post[:shipAddress1]     = shipping_address[:address1]
+          post[:shipAddress2]     = shipping_address[:address2]
+          post[:shipCity]         = shipping_address[:city]
+          post[:shipProvince]     = shipping_address[:state]
+          post[:shipPostalCode]   = shipping_address[:zip]
+          post[:shipCountry]      = shipping_address[:country]
+          post[:shippingMethod]   = shipping_address[:shipping_method]
+          post[:deliveryEstimate] = shipping_address[:delivery_estimate]
+        end
+      end
+
+      def prepare_address_for_non_american_countries(options)
+        [ options[:billing_address], options[:shipping_address] ].compact.each do |address|
+          unless ['US', 'CA'].include?(address[:country])
+            address[:state] = '--'
+            address[:zip]   = '000000' unless address[:zip]
+          end
+        end
+      end
+
+      def add_invoice(post, options)
+        post[:trnOrderNumber]   = options[:order_id]
+        post[:trnComments]      = options[:description]
+        post[:ordItemPrice]     = amount(options[:subtotal])
+        post[:ordShippingPrice] = amount(options[:shipping])
+        post[:ordTax1Price]     = amount(options[:tax1] || options[:tax])
+        post[:ordTax2Price]     = amount(options[:tax2])
+        post[:ref1]             = options[:custom]
+      end
+      
+      def add_credit_card(post, credit_card)
+        if credit_card
+          post[:trnCardOwner] = credit_card.name
+          post[:trnCardNumber] = credit_card.number
+          post[:trnExpMonth] = format(credit_card.month, :two_digits)
+          post[:trnExpYear] = format(credit_card.year, :two_digits)
+          post[:trnCardCvd] = credit_card.verification_value
+        end
+      end
+            
+      def add_check(post, check)
+        # The institution number of the consumer’s financial institution. Required for Canadian dollar EFT transactions.
+        post[:institutionNumber] = check.institution_number
+        
+        # The bank transit number of the consumer’s bank account. Required for Canadian dollar EFT transactions.
+        post[:transitNumber] = check.transit_number
+        
+        # The routing number of the consumer’s bank account.  Required for US dollar EFT transactions.
+        post[:routingNumber] = check.routing_number
+        
+        # The account number of the consumer’s bank account.  Required for both Canadian and US dollar EFT transactions.
+        post[:accountNumber] = check.account_number
+      end
+      
+      def add_secure_profile_variables(post, options = {})
+        post[:serviceVersion] = SP_SERVICE_VERSION
+        post[:responseFormat] = 'QS'
+        post[:cardValidation] = (options[:cardValidation].to_i == 1) || '0'
+        
+        post[:operationType] = options[:operationType] || options[:operation] || secure_profile_action(:new)
+        post[:customerCode] = options[:billing_id] || options[:vault_id] || false
+        post[:status] = options[:status]
+      end
+      
+      def parse(body)
+        results = {}
+        if !body.nil?
+          body.split(/&/).each do |pair|
+            key,val = pair.split(/=/)
+            results[key.to_sym] = val.nil? ? nil : CGI.unescape(val)
+          end
+        end
+        
+        # Clean up the message text if there is any
+        if results[:messageText]
+          results[:messageText].gsub!(/<LI>/, "")
+          results[:messageText].gsub!(/(\.)?<br>/, ". ")
+          results[:messageText].strip!
+        end
+        
+        results
+      end
+      
+      def commit(params, use_profile_api = false)
+        post(post_data(params,use_profile_api),use_profile_api)
+      end
+      
+      def post(data, use_profile_api=nil)
+        response = parse(ssl_post((use_profile_api ? SECURE_PROFILE_URL : URL), data))
+        response[:customer_vault_id] = response[:customerCode] if response[:customerCode]
+        build_response(success?(response), message_from(response), response,
+          :test => test? || response[:authCode] == "TEST",
+          :authorization => authorization_from(response),
+          :cvv_result => CVD_CODES[response[:cvdId]],
+          :avs_result => { :code => (AVS_CODES.include? response[:avsId]) ? AVS_CODES[response[:avsId]] : response[:avsId] }
+        )
+      end
+            
+      def authorization_from(response)
+        "#{response[:trnId]};#{response[:trnAmount]};#{response[:trnType]}"
+      end
+
+      def message_from(response)
+        response[:messageText] || response[:responseMessage]
+      end
+
+      def success?(response)
+        response[:responseType] == 'R' || response[:trnApproved] == '1' || response[:responseCode] == '1'
+      end
+      
+      def add_source(post, source)
+        if source.is_a?(String) or source.is_a?(Integer)
+          post[:customerCode] = source
+        else
+          card_brand(source) == "check" ? add_check(post, source) : add_credit_card(post, source)
+        end
+      end
+      
+      def add_transaction_type(post, action)
+        post[:trnType] = TRANSACTIONS[action]
+      end
+          
+      def post_data(params, use_profile_api)
+        params[:requestType] = 'BACKEND'
+        if use_profile_api
+          params[:merchantId] = @options[:login] 
+          params[:passCode] = @options[:secure_profile_api_key]
+        else
+          params[:username] = @options[:user] if @options[:user]
+          params[:password] = @options[:password] if @options[:password]
+          params[:merchant_id] = @options[:login]     
+        end
+        params[:vbvEnabled] = '0'
+        params[:scEnabled] = '0'
+        
+        params.reject{|k, v| v.blank?}.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+    end
+  end
+end
+