merb_merchant 1.4.1

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

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/beanstream/beanstream_core'
+
+module MerbMerchant #: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
+    #  
+    # == 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.
+    #  
+    #  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, credit_card, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_credit_card(post, credit_card)        
+        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
+
+      private
+      def build_response(*args)
+        Response.new(*args)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,233 @@
+module MerbMerchant #:nodoc:
+  module Billing #:nodoc:
+    module BeanstreamCore
+      URL = 'https://www.beanstream.com/scripts/process_transaction.asp'
+
+      TRANSACTIONS = {
+        :authorization  => 'PA',
+        :purchase       => 'P',
+        :capture        => 'PAC',
+        :credit         => 'R',
+        :void           => 'VP',
+        :check_purchase => 'D',
+        :check_credit   => 'C',
+        :void_purchase  => 'VP',
+        :void_credit    => 'VR'
+      }
+
+      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 credit 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 credit(money, source, options = {})
+        post = {}
+        reference, amount, type = split_auth(source)
+        add_reference(post, reference)
+        add_transaction_type(post, credit_action(type))
+        add_amount(post, money)
+        commit(post)
+      end
+    
+      private
+      def purchase_action(source)
+        source.type.to_s == "check" ? :check_purchase : :purchase
+      end
+      
+      def void_action(original_transaction_type)
+        original_transaction_type == TRANSACTIONS[:credit] ? :void_credit : :void_purchase
+      end
+      
+      def credit_action(type)
+        type == TRANSACTIONS[:check_purchase] ? :check_credit : :credit
+      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)      
+        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 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)
+        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
+            
+      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 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)
+        post(post_data(params))
+      end
+      
+      def post(data)
+        response = parse(ssl_post(URL, data))
+        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]
+      end
+
+      def success?(response)
+        response[:responseType] == 'R' || response[:trnApproved] == '1'
+      end
+      
+      def add_source(post, source)
+        source.type == "check" ? add_check(post, source) : add_credit_card(post, source)
+      end
+      
+      def add_transaction_type(post, action)
+        post[:trnType] = TRANSACTIONS[action]
+      end
+          
+      def post_data(params)
+        params[:requestType] = 'BACKEND'
+        params[:merchant_id] = @options[:login]
+        params[:username] = @options[:user] if @options[:user]
+        params[:password] = @options[:password] if @options[:password]
+        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
+

data/lib/merb_merchant/billing/gateways/beanstream_interac.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/beanstream/beanstream_core'
+
+module MerbMerchant #:nodoc:
+  module Billing #:nodoc:
+    class BeanstreamInteracResponse < Response
+      def redirect
+        params['pageContents']
+      end
+    end
+    
+    class BeanstreamInteracGateway < Gateway
+      include BeanstreamCore
+      
+      # Confirm a transaction posted back from the bank to Beanstream.
+      # Confirming a transaction does not require any credentials,
+      # and in an application with many merchants sharing a funded
+      # URL the application may not yet know which merchant the 
+      # post back is for until the response of the confirmation is
+      # received, which contains the order number.
+      def self.confirm(transaction)
+        gateway = new(:login => '')
+        gateway.confirm(transaction)
+      end
+      
+      def purchase(money, options = {})
+        post = {}
+        add_amount(post, money)
+        add_invoice(post, options)
+        add_address(post, options)
+        add_interac_details(post, options)
+        add_transaction_type(post, :purchase)
+        commit(post)
+      end
+      
+      # Confirm a transaction posted back from the bank to Beanstream.
+      def confirm(transaction)
+        post(transaction)
+      end
+      
+      private
+      
+      def add_interac_details(post, options)
+        address = options[:billing_address] || options[:address] || {}
+        post[:trnCardOwner] = address[:name]
+        post[:paymentMethod] = 'IO'
+      end
+      
+      def build_response(*args)
+        BeanstreamInteracResponse.new(*args)
+      end
+    end
+  end
+end
+

data/lib/merb_merchant/billing/gateways/bogus.rb

@@ -0,0 +1,98 @@
+module MerbMerchant #:nodoc:
+  module Billing #:nodoc:
+    # Bogus Gateway
+    class BogusGateway < Gateway
+      AUTHORIZATION = '53433'
+      
+      SUCCESS_MESSAGE = "Bogus Gateway: Forced success"
+      FAILURE_MESSAGE = "Bogus Gateway: Forced failure"
+      ERROR_MESSAGE = "Bogus Gateway: Use CreditCard number 1 for success, 2 for exception and anything else for error"
+      CREDIT_ERROR_MESSAGE = "Bogus Gateway: Use trans_id 1 for success, 2 for exception and anything else for error"
+      UNSTORE_ERROR_MESSAGE = "Bogus Gateway: Use trans_id 1 for success, 2 for exception and anything else for error"
+      CAPTURE_ERROR_MESSAGE = "Bogus Gateway: Use authorization number 1 for exception, 2 for error and anything else for success"
+      VOID_ERROR_MESSAGE = "Bogus Gateway: Use authorization number 1 for exception, 2 for error and anything else for success"
+      
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:bogus]
+      self.homepage_url = 'http://example.com'
+      self.display_name = 'Bogus'
+      
+      def authorize(money, creditcard, options = {})
+        case creditcard.number
+        when '1'
+          Response.new(true, SUCCESS_MESSAGE, {:authorized_amount => money.to_s}, :test => true, :authorization => AUTHORIZATION )
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:authorized_amount => money.to_s, :error => FAILURE_MESSAGE }, :test => true)
+        else
+          raise Error, ERROR_MESSAGE
+        end      
+      end
+  
+      def purchase(money, creditcard, options = {})
+        case creditcard.number
+        when '1'
+          Response.new(true, SUCCESS_MESSAGE, {:paid_amount => money.to_s}, :test => true)
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:paid_amount => money.to_s, :error => FAILURE_MESSAGE },:test => true)
+        else
+          raise Error, ERROR_MESSAGE
+        end
+      end
+ 
+      def credit(money, ident, options = {})
+        case ident
+        when '1'
+          raise Error, CREDIT_ERROR_MESSAGE
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:paid_amount => money.to_s, :error => FAILURE_MESSAGE }, :test => true)
+        else
+          Response.new(true, SUCCESS_MESSAGE, {:paid_amount => money.to_s}, :test => true)
+        end
+      end
+ 
+      def capture(money, ident, options = {})
+        case ident
+        when '1'
+          raise Error, CAPTURE_ERROR_MESSAGE
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:paid_amount => money.to_s, :error => FAILURE_MESSAGE }, :test => true)
+        else
+          Response.new(true, SUCCESS_MESSAGE, {:paid_amount => money.to_s}, :test => true)
+        end
+      end
+
+      def void(ident, options = {})
+        case ident
+        when '1'
+          raise Error, VOID_ERROR_MESSAGE
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:authorization => ident, :error => FAILURE_MESSAGE }, :test => true)
+        else
+          Response.new(true, SUCCESS_MESSAGE, {:authorization => ident}, :test => true)
+        end
+      end
+      
+      def store(creditcard, options = {})
+        case creditcard.number
+        when '1'
+          Response.new(true, SUCCESS_MESSAGE, {:billingid => '1'}, :test => true, :authorization => AUTHORIZATION )
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:billingid => nil, :error => FAILURE_MESSAGE }, :test => true)
+        else
+          raise Error, ERROR_MESSAGE
+        end              
+      end
+      
+      def unstore(identification, options = {})
+        case identification
+        when '1'
+          Response.new(true, SUCCESS_MESSAGE, {}, :test => true)
+        when '2'
+          Response.new(false, FAILURE_MESSAGE, {:error => FAILURE_MESSAGE },:test => true)
+        else
+          raise Error, UNSTORE_ERROR_MESSAGE
+        end
+      end
+    end
+  end
+end