activemerchant 1.1.0 → 1.2.0

data/gem-public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApjb2R5
+ZmF1c2VyMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMDcwMjIyMTcyMTI3WhcNMDgwMjIyMTcyMTI3WjBBMRMwEQYDVQQDDApj
+b2R5ZmF1c2VyMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC6T4Iqt5iWvAlU
+iXI6L8UO0URQhIC65X/gJ9hL/x4lwSl/ckVm/R/bPrJGmifT+YooFv824N3y/TIX
+25o/lZtRj1TUZJK4OCb0aVzosQVxBHSe6rLmxO8cItNTMOM9wn3thaITFrTa1DOQ
+O3wqEjvW2L6VMozVfK1MfjL9IGgy0rCnl+2g4Gh4jDDpkLfnMG5CWI6cTCf3C1ye
+ytOpWgi0XpOEy8nQWcFmt/KCQ/kFfzBo4QxqJi54b80842EyvzWT9OB7Oew/CXZG
+F2yIHtiYxonz6N09vvSzq4CvEuisoUFLKZnktndxMEBKwJU3XeSHAbuS7ix40OKO
+WKuI54fHAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBR9QQpefI3oDCAxiqJW/3Gg6jI6qjANBgkqhkiG9w0BAQUFAAOCAQEAs0lX26O+
+HpyMp7WL+SgZuM8k76AjfOHuKajl2GEn3S8pWYGpsa0xu07HtehJhKLiavrfUYeE
+qlFtyYMUyOh6/1S2vfkH6VqjX7mWjoi7XKHW/99fkMS40B5SbN+ypAUst+6c5R84
+w390mjtLHpdDE6WQYhS6bFvBN53vK6jG3DLyCJc0K9uMQ7gdHWoxq7RnG92ncQpT
+ThpRA+fky5Xt2Q63YJDnJpkYAz79QIama1enSnd4jslKzSl89JS2luq/zioPe/Us
+hbyalWR1+HrhgPoSPq7nk+s2FQUBJ9UZFK1lgMzho/4fZgzJwbu+cO8SNuaLS/bj
+hPaSTyVU0yCSnw==
+-----END CERTIFICATE-----

data/init.rb

@@ -0,0 +1,3 @@
+require 'active_merchant'
+require 'active_merchant/billing/integrations/action_view_helper'
+ActionView::Base.send(:include, ActiveMerchant::Billing::Integrations::ActionViewHelper)

data/lib/active_merchant.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2005 Tobias Luetke
+# Copyright (c) 2005-2007 Tobias Luetke
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -40,8 +40,10 @@ end
 
 require 'cgi'
 
+require 'active_merchant/lib/error'
 require 'active_merchant/lib/validateable'
 require 'active_merchant/lib/posts_data'
+require 'active_merchant/lib/post_data'
 require 'active_merchant/lib/requires_parameters'
 
 # Require the country class

data/lib/active_merchant/billing/credit_card.rb

@@ -3,10 +3,11 @@ require 'date'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # This credit card object can be used as a stand alone object. It acts just like a active record object
+    # This credit card object can be used as a stand alone object. It acts just like an ActiveRecord object
     # but doesn't support the .save method as its not backed by a database.
     class CreditCard
       include CreditCardMethods
+      include Validateable
       
       cattr_accessor :require_verification_value
       self.require_verification_value = false
@@ -15,8 +16,6 @@ module ActiveMerchant #:nodoc:
         require_verification_value
       end
         
-      include Validateable
-
       class ExpiryDate #:nodoc:
         attr_reader :month, :year
         def initialize(month, year)
@@ -60,30 +59,35 @@ module ActiveMerchant #:nodoc:
       end
 
       def validate
-        errors.add "year", "expired"                             if expired?
-            
-        errors.add "first_name", "cannot be empty"               if @first_name.blank?
-        errors.add "last_name", "cannot be empty"                if @last_name.blank?
-        errors.add "month", "cannot be empty"                    unless valid_month?(@month)
-        errors.add "year", "cannot be empty"                     unless valid_expiry_year?(@year)
+        errors.add :year, "expired"                             if expired?
+                   
+        errors.add :first_name, "cannot be empty"               if @first_name.blank?
+        errors.add :last_name, "cannot be empty"                if @last_name.blank?
+        errors.add :month, "is not a valid month"               unless valid_month?(@month)
+        errors.add :year, "is not a valid year"                 unless valid_expiry_year?(@year)
 
         # Bogus card is pretty much for testing purposes. Lets just skip these extra tests if its used
         
         return if type == 'bogus'
 
-        errors.add "number", "is not a valid credit card number" unless CreditCard.valid_number?(number)                     
-        errors.add "type", "is invalid"                          unless CreditCard.card_companies.keys.include?(type)
-        errors.add "type", "is not the correct card type"        unless CreditCard.type?(number) == type
-        
+        errors.add :number, "is not a valid credit card number" unless CreditCard.valid_number?(number)
+        errors.add :type, "is required" if type.blank?
+        errors.add :type, "is invalid"  unless CreditCard.card_companies.keys.include?(type)
+          
+        unless errors.on(:number) || errors.on(:type)
+          CreditCard.type?(number) == type or
+            errors.add :type, "is not the correct card type"
+        end
+
         if CreditCard.requires_verification_value?
-          errors.add "verification_value", "is required" unless verification_value?
+          errors.add :verification_value, "is required" unless verification_value?
         end
         
         if [ 'switch', 'solo' ].include?(type)
           unless valid_month?(@start_month) && valid_start_year?(@start_year) || valid_issue_number?(@issue_number)
-            errors.add "start_month", "is invalid"                    unless valid_month?(@start_month)
-            errors.add "start_year", "is invalid"                     unless valid_start_year?(@start_year)
-            errors.add "issue_number", "cannot be empty"              unless valid_issue_number?(@issue_number)
+            errors.add :start_month, "is invalid"                    unless valid_month?(@start_month)
+            errors.add :start_year, "is invalid"                     unless valid_start_year?(@start_year)
+            errors.add :issue_number, "cannot be empty"              unless valid_issue_number?(@issue_number)
           end
         end
       end  

data/lib/active_merchant/billing/credit_card_methods.rb

@@ -42,38 +42,36 @@ module ActiveMerchant #:nodoc:
         end
         
         # Regular expressions for the known card companies
-        # == Known card types
-        #	 Card Type                         Prefix                           Length
-        #  --------------------------------------------------------------------------
-        #	 master                            51-55                            16
-        #	 visa                              4                                13, 16
-        #	 american_express                  34, 37                           15
-        #	 diners_club                       300-305, 36, 38                  14
-        #	 discover                          6011                             16
-        #	 jcb                               3                                16
-        #	 jcb                               2131, 1800                       15
-        #	 switch                            various                          16,18,19
-        #	 solo                              63, 6767                         16,18,19
+        # http://en.wikipedia.org/wiki/Credit_card_number
+        # http://www.barclaycardbusiness.co.uk/information_zone/processing/bin_rules.html
         def card_companies
           { 
             'visa' =>  /^4\d{12}(\d{3})?$/,
-            'master' =>  /^5[1-5]\d{14}$/,
+            'master' =>  /^(5[1-5]\d{4}|677189)\d{10}$/,
             'discover' =>  /^6011\d{12}$/,
             'american_express' =>  /^3[47]\d{13}$/,
             'diners_club' =>  /^3(0[0-5]|[68]\d)\d{11}$/,
-            'jcb' =>  /^(3\d{4}|2131|1800)\d{11}$/,
-            'switch' =>  [/^49(03(0[2-9]|3[5-9])|11(0[1-2]|7[4-9]|8[1-2])|36[0-9]{2})\d{10}(\d{2,3})?$/, /^564182\d{10}(\d{2,3})?$/, /^6(3(33[0-4][0-9])|759[0-9]{2})\d{10}(\d{2,3})?$/],
-            'solo' =>  /^6(3(34[5-9][0-9])|767[0-9]{2})\d{10}(\d{2,3})?$/ 
+            'jcb' =>  /^3528\d{12}$/,
+            'switch' =>  /^6759\d{12}(\d{2,3})?$/,  
+            'solo' =>  /^6767\d{12}(\d{2,3})?$/,
+            'dankort' => /^5019\d{12}$/,
+            'maestro' => /^(5[06-8]|6\d)\d{14}$/,
+            'forbrugsforeningen' => /^600722\d{10}$/,
+            'laser' => /^(6304[89]\d{11}(\d{2,3})?|670695\d{12})$/
           }
         end
-
+        
         # Returns a string containing the type of card from the list of known information below.
+        # Need to check the cards in a particular order, as there is some overlap of the allowable ranges
+        # 
         def type?(number)
           return 'visa' if ActiveMerchant::Billing::Base.gateway_mode == :test and ['1','2','3','success','failure','error'].include?(number.to_s)
 
-          card_companies.each do |company, patterns|
-            return company if [patterns].flatten.any? { |pattern| number =~ pattern  } 
+          card_companies.reject{ |c,p| c == 'maestro' }.each do |company, pattern|
+            return company.dup if number =~ pattern 
           end
+          
+          return 'maestro' if number =~ card_companies['maestro']
 
           return nil
         end

data/lib/active_merchant/billing/gateway.rb

@@ -1,58 +1,140 @@
 require 'net/http'
 require 'net/https'
+require 'digest/md5'
 require 'active_merchant/billing/response'
 
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
-    # The Gateway class is the base class for all ActiveMerchant gateway
-    # implementations. The list of gateway functions that concrete
-    # gateway classes can and should implement include the following:
-    # 
-    # === Core operations supported by most gateways
-    # * purchase(money, creditcard, options = {})
-    # * authorize(money, creditcard, options = {})
-    # * capture(money, authorization, options = {})
-    # * void(identification, options = {})
-    # * credit(money, identification, options = {})
+    # 
+    # == Description
+    # The Gateway class is the base class for all ActiveMerchant gateway implementations. 
+    # 
+    # The list of gateway functions that concrete gateway classes can and should implement include 
+    # the following:
+    # 
+    # * <tt>purchase(money, creditcard, options = {})</tt>
+    # * <tt>authorize(money, creditcard, options = {})</tt>
+    # * <tt>capture(money, authorization, options = {})</tt>
+    # * <tt>void(identification, options = {})</tt>
+    # * <tt>credit(money, identification, options = {})</tt>
+    # 
+    # == Setting Up Your Gateway
+    # Aside from the obvious authorization parameters (login and password), you can set up your 
+    # gateway using numerous options. Be sure to reference your gateway of choice's documentation 
+    # before overriding it's default values that may be defined.
+    # 
+    # * <tt>Gateway.default_currency</tt>: sets the default currency if none is provided. See 
+    #   http://en.wikipedia.org/wiki/ISO_4217#Active_codes for active currency codes.
+    # 
+    # * <tt>Gateway.supported_countries</tt>: sets the countries of _merchants_ the gateway supports.
+    # 
+    # * <tt>Gateway.supported_cardtypes</tt>: sets the card types supported by the gateway.
+    # 
+    # * <tt>Gateway.homepage_url</tt>: sets the URL at which the gateway may be found.
+    # 
+    # * <tt>Gateway.display_name</tt>: sets the name of the gateway for display purposes, such as generating documentation.
+    # 
+    # * <tt>Gateway.application_id</tt>: This is the application making calls to the gateway. This 
+    #   is useful for things like the Paypal build notation (BN) id fields.
+    # 
+    # * <tt>Gateway.money_format</tt>: this attribute may be set to <tt>:dollars</tt> or 
+    #   <tt>:cents</tt>. Use this to set the expected money format you'll be inputting.
+    #
+    # 
+    #     Gateway.money_format = :dollars # => 12.50
+    #     Gateway.money_format = :cents   # => 1250
+    # 
+    # 
+    # == Testing Your Code
+    # There are two kinds of tests performed with your code: local and remote.
+    # 
+    # === Local Tests
+    # Before running any remote tests, it's best to ensure that your code covers the basics 
+    # locally. Local tests run on your own machine and will run faster than remote tests.
+    # 
+    # To run a local test, first ensure that your gateway is in test mode: 
+    # 
+    #   ActiveMerchant::Base.mode = :test
+    # 
+    # (See ActiveMerchant::Base for more details.) This is often best set in your test's +setup+ 
+    # or +teardown+ methods, if you are using Test::Unit.
+    # 
+    # The next step is to use one of three test credit card numbers: 
+    # 
+    # <tt>1</tt>:: Result will be successful
+    # <tt>2</tt>:: Result will be a failure
+    # <tt>3</tt>:: Result will raise a miscellaneous error
+    # 
+    # For examples of test requests, please see your gateway of interest's unit test code.
+    # 
+    # === Remote Tests
+    # Remote tests aren't mandatory, but it's not a bad idea to write them to ensure everything 
+    # works as expected. You'll first need authorization parameters from the gateway you'll be 
+    # working with. Once you have these values you'll be able to use ActiveMerchant to run test 
+    # requests.
+    # 
+    # As with local tests, first ensure that you are in test mode: 
+    # 
+    #   ActiveMerchant::Base.mode = :test
+    # 
+    # (See ActiveMerchant::Base for more details.) 
+    # 
+    # Test requests may then be made using appropriate parameters provided by your gateway of 
+    # choice. For instance, the Moneris gateway provides a test MasterCard and Visa number that 
+    # one may use to process test purchases and authorization requests.
+    # 
+    # Given that these remote tests will take longer to run than local tests, it is recommended 
+    # that you comment them out, or disable them when not required.
     class Gateway
       include PostsData
       include RequiresParameters
       include CreditCardFormatting
       
+      ## Constants
+      
+      DEBIT_CARDS = [ :switch, :solo ]
+      
+      ## Attributes
+      
       # The format of the amounts used by the gateway
       # :dollars => '12.50'
       # :cents => '1250'
       class_inheritable_accessor :money_format
       self.money_format = :dollars
       
-      # Return the matching gateway for the provider
-      # * <tt>bogus</tt>: BogusGateway - Does nothing ( for testing)
-      # * <tt>moneris</tt>: MonerisGateway
-      # * <tt>authorize_net</tt>: AuthorizeNetGateway
-      # * <tt>trust_commerce</tt>: TrustCommerceGateway
-      # 
-      #   ActiveMerchant::Base.gateway('moneris').new
-      def self.gateway(name)
-        ActiveMerchant::Billing.const_get("#{name.to_s.downcase}_gateway".camelize)
-      end                        
-             
-      # Does this gateway support credit cards of the passed type?
-      def self.supports?(type)
-        supported_cardtypes.include?(type.intern)
-      end
-                                                                  
-      # Get a list of supported credit card types for this gateway
-      def self.supported_cardtypes
-        []
-      end                                 
-    
+      # The default currency for the transactions if no currency is provided
+      class_inheritable_accessor :default_currency
+      
+      # The countries of merchants the gateway supports
+      class_inheritable_accessor :supported_countries
+      self.supported_countries = []
+      
+      # The supported card types for the gateway
+      class_inheritable_accessor :supported_cardtypes
+      self.supported_cardtypes = []
+      
+      class_inheritable_accessor :homepage_url
+      class_inheritable_accessor :display_name
+      
+      # The application making the calls to the gateway
+      # Useful for things like the PayPal build notation (BN) id fields
+      class_inheritable_accessor :application_id
+      self.application_id = 'ActiveMerchant'
+      
       attr_reader :options
-      # Initialize a new gateway 
+      
+      # Use this method to check if your gateway of interest supports a credit card of some type
+      def self.supports?(card_type)
+        supported_cardtypes.include?(card_type.to_sym)
+      end       
+    
+      ## Instance Methods
+    
+      # Initialize a new gateway.
       # 
-      # See the documentation for the gateway you will be using to make sure there
-      # are no other required options
-      def initialize(options = {})    
-        @ssl_strict = options[:ssl_strict] || false
+      # See the documentation for the gateway you will be using to make sure there are no other 
+      # required options.
+      def initialize(options = {})
       end
                                      
       # Are we running in test mode?
@@ -60,15 +142,27 @@ module ActiveMerchant #:nodoc:
         Base.gateway_mode == :test
       end
             
-      private
+      private # :nodoc: all
+
       def name 
         self.class.name.scan(/\:\:(\w+)Gateway/).flatten.first
       end
       
-      def test_result_from_cc_number(number)
+      # This is used to check if our credit card number implies that we are seeking a test 
+      # Response. Of course, this returns false if we are not in test mode.
+      # 
+      # Recognized values: 
+      # <tt>1</tt>:: Result will be successful
+      # <tt>2</tt>:: Result will be a failure
+      # <tt>3</tt>:: Result will raise a miscellaneous error
+      # 
+      # All other values will not be recognized.
+      #--
+      # TODO Refactor this method. It's kind of on the ugly side of things.
+      def test_result_from_cc_number(card_number)
         return false unless test?
         
-        case number.to_s
+        case card_number.to_s
         when '1', 'success' 
           Response.new(true, 'Successful test mode response', {:receiptid => '#0001'}, :test => true, :authorization => '5555')
         when '2', 'failure' 
@@ -80,7 +174,9 @@ module ActiveMerchant #:nodoc:
         end
       end
       
-      # Return a string with the amount in the appropriate format
+      # Return a String with the amount in the appropriate format
+      #--
+      # TODO Refactor this method. It's a tad on the ugly side.
       def amount(money)
         return nil if money.nil?
         cents = money.respond_to?(:cents) ? money.cents : money 
@@ -89,13 +185,33 @@ module ActiveMerchant #:nodoc:
           raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.' 
         end
 
-        case self.money_format
-        when :cents
+        if self.money_format == :cents
           cents.to_s
         else
-          sprintf("%.2f", cents.to_f/100)
+          sprintf("%.2f", cents.to_f / 100)
         end
-      end      
+      end
+      
+      # Ascertains the currency to be used on the money supplied.
+      def currency(money)
+        money.respond_to?(:currency) ? money.currency : self.default_currency
+      end
+      
+      def requires_start_date_or_issue_number?(credit_card)
+        return false if credit_card.type.blank?
+        DEBIT_CARDS.include?(credit_card.type.to_sym)
+      end
+      
+      def generate_unique_id
+         md5 = Digest::MD5.new
+         now = Time.now
+         md5 << now.to_s
+         md5 << String(now.usec)
+         md5 << String(rand(0))
+         md5 << String($$)
+         md5 << self.class.name
+         md5.hexdigest
+      end
     end
   end
 end

data/lib/active_merchant/billing/gateways.rb

@@ -1,16 +1,3 @@
 require 'active_merchant/billing/gateway'
-require 'active_merchant/billing/gateways/bogus'
-require 'active_merchant/billing/gateways/psigate'
-require 'active_merchant/billing/gateways/authorize_net'
-require 'active_merchant/billing/gateways/moneris'
-require 'active_merchant/billing/gateways/trust_commerce'
-require 'active_merchant/billing/gateways/linkpoint'
-require 'active_merchant/billing/gateways/paypal'
-require 'active_merchant/billing/gateways/paypal_express'
-require 'active_merchant/billing/gateways/eway'
-require 'active_merchant/billing/gateways/usa_epay'
-require 'active_merchant/billing/gateways/payflow'
-require 'active_merchant/billing/gateways/payflow_express'
-require 'active_merchant/billing/gateways/payflow_uk'
-require 'active_merchant/billing/gateways/payflow_express_uk'
-require 'active_merchant/billing/gateways/data_cash'
+
+Dir[File.dirname(__FILE__) + '/gateways/*.rb'].each{|g| require g}

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

@@ -3,9 +3,12 @@ module ActiveMerchant #:nodoc:
         
     class AuthorizeNetGateway < Gateway
       API_VERSION = '3.1'
-      LIVE_URL = "https://secure.authorize.net/gateway/transact.dll"
-      TEST_URL = "https://test.authorize.net/gateway/transact.dll"
-
+      
+      class_inheritable_accessor :test_url, :live_url
+    
+      self.test_url = "https://test.authorize.net/gateway/transact.dll"
+      self.live_url = "https://secure.authorize.net/gateway/transact.dll"
+    
       APPROVED, DECLINED, ERROR = 1, 2, 3
 
       RESPONSE_CODE, RESPONSE_REASON_CODE, RESPONSE_REASON_TEXT = 0, 2, 3
@@ -43,6 +46,11 @@ module ActiveMerchant #:nodoc:
       attr_reader :url 
       attr_reader :response
       attr_reader :options
+      
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.authorize.net/'
+      self.display_name = 'Authorize.net'
 
       def initialize(options = {})
         requires!(options, :login, :password)
@@ -90,21 +98,8 @@ module ActiveMerchant #:nodoc:
 
         commit('CREDIT', money, post)
       end
-    
-      # We support visa and master card
-      def self.supported_cardtypes
-        [:visa, :master, :american_express, :discover]
-      end
-         
+       
       private                       
-    
-      def expdate(creditcard)
-        year  = sprintf("%.4i", creditcard.year)
-        month = sprintf("%.2i", creditcard.month)
-
-        "#{year[-2..-1]}#{month}"
-      end
-  
       def commit(action, money, parameters)
         parameters[:amount]       = amount(money) unless action == 'VOID'
         
@@ -115,10 +110,11 @@ module ActiveMerchant #:nodoc:
           return result
         end
         
-        url = test? ? TEST_URL : LIVE_URL
+        url = test? ? self.test_url : self.live_url
         data = ssl_post url, post_data(action, parameters)
 
         @response = parse(data)
+
         success = @response[:response_code] == APPROVED
         message = message_from(@response)
 
@@ -138,8 +134,8 @@ module ActiveMerchant #:nodoc:
       end
                                                
       def parse(body)
-        fields = body[1..-2].split(/\$,\$/)
-               
+        fields = split(body)
+                
         results = {         
           :response_code => fields[RESPONSE_CODE].to_i,
           :response_reason_code => fields[RESPONSE_REASON_CODE], 
@@ -230,7 +226,7 @@ module ActiveMerchant #:nodoc:
           return AVS_MESSAGES[results[:avs_result_code]] if AVS_ERRORS.include?(results[:avs_result_code])
         end
         
-        return results[:response_reason_text][0..-2] # Forget the punctuation at the end
+        return results[:response_reason_text].nil? ? '' : results[:response_reason_text][0..-2]
       end
         
       def expdate(creditcard)
@@ -239,6 +235,10 @@ module ActiveMerchant #:nodoc:
 
         "#{month}#{year[-2..-1]}"
       end
+      
+      def split(response)
+        response[1..-2].split(/\$,\$/)
+      end
     end
     
     AuthorizedNetGateway = AuthorizeNetGateway