activemerchant 1.8.0 → 1.9.0

data/CHANGELOG

@@ -1,5 +1,14 @@
 = ActiveMerchant CHANGELOG
 
+== Version 1.9.0 (October 14, 2010)
+
+* Add support for DirecPay gateway [Soleone]
+* Add SagePay Form integration gateway [Adrian Irving-Beer]
+* Allow Return class to include a Notification for gateways that treat the direct response as a notification [Adrian Irving-Beer]
+* Add support for PayboxDirect gateway [Donald Piret]
+* Add support for SecureNet gateway [Kal]
+* Add support for the Inspire gateway [ryan r. smith]
+
 == Version 1.8.0 (September 24, 2010)
 
 * PayPal Express: Add support for billing agreements [Nathaniel Talbott]

data/CONTRIBUTORS

@@ -147,4 +147,24 @@ Garanti (May 05, 2010)
 
 Braintree Blue Gateway (May 19th, 2010)
 
-* Braintree (code@getbraintree.com)
+* Braintree (code@getbraintree.com)
+
+Inspire Gateway (September 27, 2010)
+
+* ryan r. smith
+
+SecureNet Gateway (September 27, 2010)
+
+* Kal
+
+PayboxDirect Gateway (September 27, 2010)
+
+* Donald Piret <donald@donaldpiret.com>
+
+SagePay Form Offsite Gateway (October 14, 2010)
+
+* Adrian Irving-Beer
+
+DirecPay Gateway (October 14, 2010)
+
+* Soleone

data/README.rdoc

@@ -19,17 +19,26 @@ The {ActiveMerchant Wiki}[http://github.com/Shopify/active_merchant/wikis] conta
 * {CyberSource}[http://www.cybersource.com] - US
 * {DataCash}[http://www.datacash.com/] - GB
 * {Efsnet}[http://www.concordefsnet.com/] - US
+* {Elavon MyVirtualMerchant}[http://www.elavon.com] - US, CA
 * {eWAY}[http://www.eway.com.au/] - AU
 * {E-xact}[http://www.e-xact.com] - CA, US
+* {FirstPay}[http://www.first-pay.com] - US
+* {Garanti Sanal POS}[https://ccpos.garanti.com.tr/ccRaporlar/garanti/ccReports] - US, TR
+* {Inspire}[http://www.inspiregateway.com] - US
+* {InstaPay}[http://www.instapayllc.com] - US
 * {Iridium}[http://www.iridiumcorp.co.uk/] - UK, ES
+* {JetPay}[http://www.jetpay.com] - US
 * {LinkPoint}[http://www.linkpoint.com/] - US
 * {Merchant e-Solutions}[http://merchante-solutions.com/] - US
+* {MerchantWare}[http://merchantwarehouse.com/merchantware] - US
 * {Modern Payments}[http://www.modpay.com] - US
 * {Moneris}[http://www.moneris.com/] - CA
 * {Netaxept}[http://www.betalingsterminal.no/Netthandel-forside] - NO, DK, SE, FI
 * {NetRegistry}[http://www.netregistry.com.au] - AU
 * {NELiX TransaX Gateway}[http://www.nelixtransax.com] - US
 * {NETbilling}[http://www.netbilling.com] - US
+* {Ogone DirectLink}[http://www.ogone.com] - BE, DE, FR, NL, AT, CH
+* {PayBox Direct}[http://www.paybox.com] - FR
 * {PayJunction}[http://www.payjunction.com/] - US
 * {PaySecure}[http://www.commsecure.com.au/paysecure.shtml] - AU
 * {PayPal Express Checkout}[https://www.paypal.com/cgi-bin/webscr?cmd=xpt/merchant/ExpressCheckoutIntro-outside] - US, CA, SG, AU
@@ -47,6 +56,7 @@ The {ActiveMerchant Wiki}[http://github.com/Shopify/active_merchant/wikis] conta
 * {Realex}[http://www.realexpayments.com/] - IE, GB
 * {Sage Payment Solutions}[http://www.sagepayments.com] - US, CA
 * {Sallie Mae}[http://www.salliemae.com] - US
+* {SecureNet}[http://www.securenet.com] - US
 * {SecurePay}[http://securepay.com.au] - AU
 * {SecurePay}[http://www.securepay.com/] - US
 * {SecurePayTech}[http://www.securepaytech.com/] - NZ
@@ -60,12 +70,14 @@ The {ActiveMerchant Wiki}[http://github.com/Shopify/active_merchant/wikis] conta
 
 == Supported Offsite Payment Gateways
 
-* {PayPal Website Payments Standard}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-standard-overview-outside]
-* {Chronopay}[http://www.chronopay.com]
-* {Nochex}[http://www.nochex.com]
-* {Banca Sella GestPay}[https://www.sella.it/banca/ecommerce/gestpay/gestpay.jsp]
 * {2 Checkout}[http://www.2checkout.com]
+* {Banca Sella GestPay}[https://www.sella.it/banca/ecommerce/gestpay/gestpay.jsp]
+* {Chronopay}[http://www.chronopay.com]
+* {DirecPay}[http://www.timesofmoney.com/direcpay/jsp/home.jsp]
 * {HiTRUST}[http://www.hitrust.com.hk/]
+* {Nochex}[http://www.nochex.com]
+* {PayPal Website Payments Standard}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-standard-overview-outside]
+* {SagePay Form}[http://www.sagepay.com/products_services/sage_pay_go/integration/form]
 
 == Download
 

data/lib/active_merchant.rb

@@ -31,6 +31,8 @@ require 'active_support/core_ext/class/attribute_accessors'
 require 'active_support/core_ext/class/delegating_attributes'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/kernel/requires'
+require 'active_support/base64'
+require 'active_support/secure_random'
 
 require 'builder'
 require 'cgi'

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

@@ -0,0 +1,221 @@
+require File.join(File.dirname(__FILE__), '..', 'check.rb')
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class InspireGateway < Gateway
+      URL = 'https://secure.inspiregateway.net/api/transact.php'
+    
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express]
+      self.homepage_url = 'http://www.inspiregateway.com'
+      self.display_name = 'Inspire Commerce'
+      # Creates a new InspireGateway 
+      # 
+      # The gateway requires that a valid login and password be passed
+      # in the +options+ hash.
+      # 
+      # ==== Options
+      #
+      # * <tt>:login</tt> -- The Inspire Username.
+      # * <tt>:password</tt> -- The Inspire Passowrd.
+      # See the Inspire Integration Guide for details. (default: +false+)
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end  
+      
+      # Pass :store => true in the options to store the 
+      # payment info at Inspire Gateway and get a generated 
+      # customer_vault_id in the response.  
+      # Pass :store => some_number_or_string to specify the
+      # customer_vault_id InspireGateway should use (make sure it's
+      # unique).
+      def authorize(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_payment_source(post, creditcard,options)        
+        add_address(post, creditcard, options)        
+        add_customer_data(post, options)
+        
+        commit('auth', money, post)
+      end
+      
+      def purchase(money, payment_source, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_payment_source(post, payment_source, options)        
+        add_address(post, payment_source, options)   
+        add_customer_data(post, options)
+             
+        commit('sale', money, post)
+      end                       
+    
+      def capture(money, authorization, options = {})
+        post ={}
+        post[:transactionid] = authorization
+        commit('capture', money, post)
+      end
+      
+      def void(authorization, options = {})
+        post ={}
+        post[:transactionid] = authorization
+        commit('void', nil, post)
+      end
+      
+      # Update the values (such as CC expiration) stored at
+      # InspireGateway.  The CC number must be supplied in the
+      # CreditCard object.
+      def update(vault_id, creditcard, options = {})
+        post = {}
+        post[:customer_vault] = "update_customer"
+        add_customer_vault_id(post, vault_id)
+        add_creditcard(post, creditcard, options)        
+        add_address(post, creditcard, options)   
+        add_customer_data(post, options)
+             
+        commit(nil, nil, post)
+      end
+    
+      def delete(vault_id)
+        post = {}
+        post[:customer_vault] = "delete_customer"
+        add_customer_vault_id(post, vault_id)         
+        commit(nil, nil, post)
+      end
+    
+      # To match the other stored-value gateways, like TrustCommerce,
+      # store and unstore need to be defined
+      def store(creditcard, options = {})
+        billing_id = options.delete(:billing_id).to_s || true
+        authorize(100, creditcard, options.merge(:store => billing_id))
+      end
+      
+      alias_method :unstore, :delete
+
+      private                             
+      def add_customer_data(post, options)
+        if options.has_key? :email
+          post[:email] = options[:email]
+        end
+
+        if options.has_key? :ip
+          post[:ipaddress] = options[:ip]
+        end        
+      end
+
+      def add_address(post, creditcard, options)     
+        if address = options[:billing_address] || options[:address]
+          post[:address1]    = address[:address1].to_s
+          post[:address2]    = address[:address2].to_s unless address[:address2].blank?
+          post[:company]    = address[:company].to_s
+          post[:phone]      = address[:phone].to_s
+          post[:zip]        = address[:zip].to_s       
+          post[:city]       = address[:city].to_s
+          post[:country]    = address[:country].to_s
+          post[:state]      = address[:state].blank?  ? 'n/a' : address[:state]
+        end         
+      end
+
+      def add_invoice(post, options)
+        post[:orderid] = options[:order_id].to_s.gsub(/[^\w.]/, '')
+        post[:orderdescription] = options[:description]
+      end
+      
+      def add_payment_source(params, source, options={})
+        case determine_funding_source(source)
+        when :vault       then add_customer_vault_id(params, source)
+        when :credit_card then add_creditcard(params, source, options)
+        when :check       then add_check(params, source)
+        end
+      end
+      
+      def add_customer_vault_id(params,vault_id)
+        params[:customer_vault_id] = vault_id
+      end
+      
+      def add_creditcard(post, creditcard,options)
+        if options[:store]  
+          post[:customer_vault] = "add_customer"
+          post[:customer_vault_id] = options[:store] unless options[:store] == true
+        end
+        post[:ccnumber]  = creditcard.number
+        post[:cvv] = creditcard.verification_value if creditcard.verification_value?
+        post[:ccexp]  = expdate(creditcard)
+        post[:firstname] = creditcard.first_name
+        post[:lastname]  = creditcard.last_name   
+      end
+      
+      def add_check(post, check)
+        post[:payment] = 'check' # Set transaction to ACH
+        post[:checkname] = check.name # The name on the customer's Checking Account
+        post[:checkaba] = check.routing_number # The customer's bank routing number
+        post[:checkaccount] = check.account_number # The customer's account number
+        post[:account_holder_type] = check.account_holder_type # The customer's type of ACH account
+        post[:account_type] = check.account_type # The customer's type of ACH account
+      end
+      
+      def parse(body)
+        results = {}
+        body.split(/&/).each do |pair|
+          key,val = pair.split(/=/)
+          results[key] = val
+        end
+        
+        results
+      end     
+      
+      def commit(action, money, parameters)
+        parameters[:amount]  = amount(money) if money
+        
+        response = parse( ssl_post(URL, post_data(action,parameters)) )
+
+        Response.new(response["response"] == "1", message_from(response), response, 
+          :authorization => response["transactionid"],
+          :test => test?,
+          :cvv_result => response["cvvresponse"],
+          :avs_result => { :code => response["avsresponse"] }
+        )
+        
+      end
+      
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+      
+
+      def message_from(response)
+        case response["responsetext"]
+        when "SUCCESS","Approved"
+          "This transaction has been approved"
+        when "DECLINE"
+          "This transaction has been declined"
+        else
+          response["responsetext"]
+        end
+      end
+      
+      def post_data(action, parameters = {})
+        post = {}
+        post[:username]      = @options[:login]
+        post[:password]   = @options[:password]
+        post[:type]       = action if action
+
+        request = post.merge(parameters).map {|key,value| "#{key}=#{CGI.escape(value.to_s)}"}.join("&")
+        request        
+      end
+      
+      def determine_funding_source(source)
+        case 
+        when source.is_a?(String) then :vault
+        when CreditCard.card_companies.keys.include?(card_brand(source)) then :credit_card
+        when card_brand(source) == 'check' then :check
+        else raise ArgumentError, "Unsupported funding source provided"
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,205 @@
+require 'iconv'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class PayboxDirectGateway < Gateway
+      TEST_URL = 'https://ppps.paybox.com/PPPS.php'
+      TEST_URL_BACKUP = 'https://ppps1.paybox.com/PPPS.php'
+      LIVE_URL = 'https://ppps.paybox.com/PPPS.php'
+      LIVE_URL_BACKUP = 'https://ppps1.paybox.com/PPPS.php'
+
+      # Payment API Version
+      API_VERSION = '00104'
+
+      # Transactions hash
+      TRANSACTIONS = {
+        :authorization => '00001',
+        :capture => '00002',
+        :purchase => '00003',
+        :unreferenced_credit => '00004',
+        :void => '00005',
+        :refund => '00014'
+      }
+
+      CURRENCY_CODES = {
+        "AUD"=> '036',
+        "CAD"=> '124',
+        "CZK"=> '203',
+        "DKK"=> '208',
+        "HKD"=> '344',
+        "ICK"=> '352',
+        "JPY"=> '392',
+        "NOK"=> '578',
+        "SGD"=> '702',
+        "SEK"=> '752',
+        "CHF"=> '756',
+        "GBP"=> '826',
+        "USD"=> '840',
+        "EUR"=> '978'
+      }
+
+      SUCCESS_CODES = ['00000']
+      UNAVAILABILITY_CODES = ['00001', '00097', '00098']
+      FRAUD_CODES = ['00102','00104','00105','00134','00138','00141','00143','00156','00157','00159']
+      SUCCESS_MESSAGE = 'The transaction was approved'
+      FAILURE_MESSAGE = 'The transaction failed'
+
+      # Money is referenced in cents
+      self.money_format = :cents
+      self.default_currency = 'EUR'
+
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['FR']
+
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club, :jcb]
+
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.paybox.com/'
+
+      # The name of the gateway
+      self.display_name = 'Paybox Direct'
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      def authorize(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        commit('authorization', money, post)
+      end
+
+      def purchase(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)
+        commit('purchase', money, post)
+      end
+
+      def capture(money, authorization, options = {})
+        requires!(options, :order_id)
+        post = {}
+        add_invoice(post, options)
+        post[:numappel] = authorization[0,10]
+        post[:numtrans] = authorization[10,10]
+        commit('capture', money, post)
+      end
+
+      def void(identification, options = {})
+        requires!(options, :order_id, :amount)
+        post ={}
+        add_invoice(post, options)
+        add_reference(post, identification)
+        post[:porteur] = '000000000000000'
+        post[:dateval] = '0000'
+        commit('void', options[:amount], post)
+      end
+
+      def credit(money, identification, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_reference(post, identification)
+        commit('refund', money, post)
+      end
+
+      def test?
+        @options[:test] || Base.gateway_mode == :test
+      end
+
+      private
+
+      def add_invoice(post, options)
+        post[:reference] = options[:order_id]
+      end
+
+      def add_creditcard(post, creditcard)
+        post[:porteur] = creditcard.number
+        post[:dateval] = expdate(creditcard)
+        post[:cvv] = creditcard.verification_value if creditcard.verification_value?
+      end
+
+      def add_reference(post, identification)
+        post[:numappel] = identification[0,10]
+        post[:numtrans] = identification[10,10]
+      end
+
+      def parse(body)
+        body = Iconv.iconv("UTF-8","LATIN1", body.to_s).join
+        results = {}
+        body.split(/&/).each do |pair|
+          key,val = pair.split(/\=/)
+          results[key.downcase.to_sym] = CGI.unescape(val) if val
+        end
+        results
+      end
+
+      def commit(action, money = nil, parameters = nil)
+        parameters[:montant] = ('0000000000' + (money ? amount(money) : ''))[-10..-1]
+        parameters[:devise] = CURRENCY_CODES[options[:currency] || currency(money)]
+        request_data = post_data(action,parameters)
+        response = parse(ssl_post(test? ? TEST_URL : LIVE_URL, request_data))
+        response = parse(ssl_post(test? ? TEST_URL_BACKUP : LIVE_URL_BACKUP, request_data)) if service_unavailable?(response)
+        Response.new(success?(response), message_from(response), response.merge(
+          :timestamp => parameters[:dateq]),
+          :test => test?,
+          :authorization => response[:numappel].to_s + response[:numtrans].to_s,
+          :cvv_result => '',
+          :avs_result => '',
+          :fraud_review => fraud_review?(response),
+          :sent_params => parameters.delete_if{|key,value| ['porteur','dateval','cvv'].include?(key.to_s)}
+        )
+      end
+
+      def success?(response)
+        SUCCESS_CODES.include?(response[:codereponse])
+      end
+
+      def fraud_review?(response)
+        FRAUD_CODES.include?(response[:codereponse])
+      end
+
+      def service_unavailable?(response)
+        UNAVAILABILITY_CODES.include?(response[:codereponse])
+      end
+
+      def message_from(response)
+        success?(response) ? SUCCESS_MESSAGE : (response[:commentaire]  || FAILURE_MESSAGE)
+      end
+
+      def post_data(action, parameters = {})
+
+        parameters.update(
+          :version => API_VERSION,
+          :type => TRANSACTIONS[action.to_sym],
+          :dateq => Time.now.strftime('%d%m%Y%H%M%S'),
+          :numquestion => unique_id(parameters[:order_id]),
+          :site => @options[:login].to_s[0,7],
+          :rang => @options[:login].to_s[7..-1],
+          :cle => @options[:password],
+          :pays => '',
+          :archivage => parameters[:order_id]
+        )
+
+        parameters.collect { |key, value| "#{key.to_s.upcase}=#{CGI.escape(value.to_s)}" }.join("&")
+      end
+
+      def unique_id(seed = 0)
+        randkey = "#{seed}#{Time.now.usec}".to_i % 2147483647 # Max paybox value for the question number
+
+        "0000000000#{randkey}"[-10..-1]
+      end
+
+      def expdate(credit_card)
+        year  = sprintf("%.4i", credit_card.year)
+        month = sprintf("%.2i", credit_card.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+
+    end
+  end
+end