activemerchant 1.0.0

data/CHANGELOG

@@ -0,0 +1,40 @@
+# CHANGELOG
+# ---
+# * Add discover to list of supported card types for Authorize.net
+#
+# * Fix Psigate crediting [sean.alien8@gmail.com]
+# 
+# * Fix dependency loading of tests
+# 
+# * Add methods for storing credit cards to the Bogus gateway [Jim Kane]
+# 
+# * Fix bugs in expiration dates. [Jim Kane]
+# 
+# * Fixed bugs related to authorized.net [Rick Olson]
+# 
+# * Linkpoint is now a full featured backend for active merchant [Ryan Heneise]
+# 
+# * Added linkpoint support [Ryan Heneise]
+# 
+# * Added trust commerce gateway [Hans Friedrich]
+# 
+# * Removed shipping stuff until there is time to implement it properly
+# 
+# * The library now rejects money amounts which are not either cents as integer or a Money object
+# 
+# * Moneris now uses the same layout as the authorized.net plugin
+# 
+# * Added authorized.net
+# 
+# * Changed default to :test mode. Set to production with ActiveMerchant::Billing::Base.gateway_mode = :production
+# 
+# * More refactoring 
+# 
+# * Refactored a bit so that there is space for billing and shipping area. None of the shipping aids are fleshed out yet. Needs more work.
+# 
+# * Added Moneris support
+# 
+# * Credit card in memory object resembling a AR object
+# 
+# * Credit card validation methods as static methods of the credit card object
+# 

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2005 Tobias Luetke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,93 @@
+= Active Merchant
+
+This library is supposed to aid in creating e-commerce software in Ruby. 
+In the future we want to support all "good" payment gateways. 
+
+This library is the foundation of commerce for http://www.shopify.com. 
+
+Please visit the {ActiveMerchant homepage}[http://activemerchant.org] for more resources, tutorials and other information about this project. 
+
+== Supported Direct Payment Gateways
+ 
+* Bogus -- your trusty test gateway which does nothing. Great for testing your app!
+
+==== Australia
+
+* eWay[http://www.eway.com.au] 
+
+==== Canada
+
+* Moneris[http://www.moneris.com]
+* Psigate[http://www.psigate.com]
+
+==== United Kingdom
+
+* {PayPal Website Payments Pro UK}[https://www.paypal.com/uk/cgi-bin/webscr?cmd=_wp-pro-overview-outside]
+
+==== USA
+
+* Authorize.net[http://www.authorize.net]
+* LinkPoint[http://www.linkpoint.com]
+* {PayPal Payflow Pro}[https://www.paypal.com/cgi-bin/webscr?cmd=_payflow-gateway-overview-outside]
+* {PayPal Website Payments Pro US}[https://www.paypal.com/cgi-bin/webscr?cmd=_wp-pro-overview-outside]
+* TrustCommerce[http://www.trustcommerce.com] - Requires the tclink ruby library from http://www.trustcommerce.com/tclink.html. Otherwise it will not be loaded.
+* {USA ePay}[www.usaepay.com/]
+
+== 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]
+ 
+== Download
+
+Currently this library is available with svn from:
+
+	http://activemerchant.googlecode.com/svn/trunk/active_merchant
+	
+== Installation
+
+=== From Subversion
+
+You can check out the latest source from svn:
+
+  > svn co http://activemerchant.googlecode.com/svn/trunk/active_merchant
+
+=== As a Rails plugin
+
+ActiveMerchant includes an init.rb file. This means that Rails will automatically load ActiveMerchant on startup. Run the following command from the root directory of your Rails project to install ActiveMerchant as a Rails plugin:
+
+  > ./script/plugin install http://activemerchant.googlecode.com/svn/trunk/active_merchant
+
+=== From Ruby Gems
+
+Installation from RubyGems
+
+  > gem install activemerchant -y
+
+== Sample Usage
+
+  ten_dollars = Money.new(1000, 'USD')
+
+  credit_card = CreditCard.new(
+    :number => '4242424242424242',
+    :month => 8,
+    :year => 2006,
+    :name => 'Tobias Luetke',
+    :type => 'visa'
+  )
+
+  if creditcard.valid?
+    gateway = ActiveMerchant::Billing::AuthorizeNetGateway.new(
+      :login    => 'LOGIN_ID',
+      :password => 'TRANSACTION_KEY'
+    )
+    response = gateway.purchase(ten_dollars, credit_card)
+    
+    if response.success?
+      ...
+    else
+      raise StandardError.new( response.message )
+    end
+  end

data/lib/active_merchant.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright (c) 2005 Tobias Luetke
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#++
+                    
+$:.unshift(File.dirname(__FILE__))      
+
+# Include rails' active support for all the core extensions we love
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  require 'activesupport'
+end
+
+begin
+  require 'builder'
+rescue LoadError
+  require 'rubygems'
+  require 'builder'
+end
+
+require 'cgi'
+
+require 'active_merchant/lib/validateable'
+require 'active_merchant/lib/posts_data'
+require 'active_merchant/lib/requires_parameters'
+
+# Require the country class
+require 'active_merchant/lib/country'
+
+# CreditCard Utility class. 
+require 'active_merchant/billing/credit_card'
+
+require 'active_merchant/billing/base'
+
+# Require the supported gateways
+require 'active_merchant/billing/gateways'
+
+# Require the supported integrations
+require 'active_merchant/billing/integrations'

data/lib/active_merchant/billing/base.rb

@@ -0,0 +1,52 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Base
+      # Set ActiveMerchant gateways in test mode.
+      #
+      #   ActiveMerchant::Billing::Base.gateway_mode = :test
+      mattr_accessor :gateway_mode
+      
+      # Set ActiveMerchant gateways in test mode.
+      #
+      #   ActiveMerchant::Billing::Base.gateway_mode = :test
+      mattr_accessor :integration_mode
+      
+      # Set both the mode of both the gateways and integrations
+      # at once
+      mattr_reader :mode
+
+      def self.mode=(mode)
+        @@mode = mode
+        self.gateway_mode = mode
+        self.integration_mode = mode
+      end
+
+      self.mode = :production
+                                                                
+      # 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::Billing::Base.gateway('moneris').new
+      def self.gateway(name)
+        ActiveMerchant::Billing.const_get("#{name.to_s.downcase}_gateway".camelize)
+      end
+      
+
+      # Return the matching integration module
+      # You can then get the notification from the module
+      # * <tt>bogus</tt>: Bogus - Does nothing (for testing)      
+      # * <tt>chronopay</tt>: Chronopay - Does nothing (for testing)
+      # * <tt>paypal</tt>: Chronopay - Does nothing (for testing)
+      #   
+      #   chronopay = ActiveMerchant::Billing::Base.integration('chronopay')
+      #   notification = chronopay.notification(raw_post)
+      #
+      def self.integration(name)
+        ActiveMerchant::Billing::Integrations.const_get("#{name.to_s.downcase}".camelize)
+      end 
+    end             
+  end
+end

data/lib/active_merchant/billing/credit_card.rb

@@ -0,0 +1,217 @@
+require 'time'
+require 'delegate'
+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
+    # but doesn't support the .save method as its not backed by a database.
+    class CreditCard
+      cattr_accessor :require_verification_value
+      self.require_verification_value = false
+      
+      def self.requires_verification_value?
+        require_verification_value
+      end
+        
+      include Validateable
+
+      class ExpiryMonth < DelegateClass(Fixnum)#:nodoc:
+        def to_s(format = :default) #:nodoc:
+          case format
+          when :default
+            __getobj__.to_s
+          when :two_digit
+            sprintf("%.2i", self)[-2..-1]
+          else
+            super
+          end  
+        end
+
+        def valid? #:nodoc:
+          (1..12).include?(self)
+        end
+      end
+
+      class ExpiryYear < DelegateClass(Fixnum)#:nodoc:
+        def to_s(format = :default) #:nodoc:
+          case format
+          when :default
+            __getobj__.to_s
+          when :two_digit
+            sprintf("%.2i", self)[-2..-1]
+          when :four_digit
+            sprintf("%.4i", self)
+          else
+            super
+          end  
+        end
+
+        def valid? #:nodoc:
+          (Time.now.year..Time.now.year + 20).include?(self)
+        end
+      end
+
+      class ExpiryDate #:nodoc:
+        attr_reader :month, :year
+        def initialize(month, year)
+          @month = ExpiryMonth.new(month)
+          @year = ExpiryYear.new(year)
+        end
+
+        def expired? #:nodoc:
+          Time.now > expiration rescue true
+        end
+
+        def expiration #:nodoc:
+          Time.parse("#{month}/#{month_days}/#{year} 23:59:59") rescue Time.at(0)
+        end
+
+        private
+        def month_days
+          mdays = [nil,31,28,31,30,31,30,31,31,30,31,30,31]
+          mdays[2] = 29 if Date.leap?(year)
+          mdays[month]
+        end
+      end 
+
+      # required
+      attr_accessor :number, :month, :year, :type, :first_name, :last_name
+
+      # Optional verification_value (CVV, CVV2 etc)
+      #
+      # Gateways will try their best to run validation on the passed in value if it is supplied
+      #
+      attr_accessor :verification_value
+
+      def before_validate
+        self.type.downcase! if type.respond_to?(:downcase)
+        self.month = month.to_i
+        self.year = year.to_i
+        self.number.to_s.gsub!(/[^\d]/, "")
+      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 month.valid?
+        @errors.add "year", "cannot be empty"                     unless year.valid?
+
+        # 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
+        
+        if CreditCard.requires_verification_value?
+          @errors.add "verification_value", "is required" unless verification_value?
+        end
+      end  
+      
+      def expired?
+        expiry_date.expired?
+      end
+      
+      def name?
+        @first_name != nil and @last_name != nil
+      end
+      
+      def first_name?
+        @first_name != nil
+      end
+      
+      def last_name?
+        @last_name != nil
+      end
+            
+      def name
+        "#{@first_name} #{@last_name}"
+      end
+            
+      def verification_value?
+        !@verification_value.blank?
+      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
+      def self.card_companies
+        { 
+          'visa' =>  /^4\d{12}(\d{3})?$/,
+          'master' =>  /^5[1-5]\d{14}$/,
+          '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})?$/ 
+        }
+      end
+
+      # Returns a string containing the type of card from the list of known information below.
+      def self.type?(number)
+        return 'visa' if 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  } 
+        end
+
+        return nil
+      end
+
+      # Returns true if it validates. Optionally, you can pass a card type as an argument and make sure it is of the correct type.
+      # == References
+      # - http://perl.about.com/compute/perl/library/nosearch/P073000.htm
+      # - http://www.beachnet.com/~hstiles/cardtype.html
+      def self.valid_number?(number)
+        return true if Base.gateway_mode == :test and ['1','2','3','success','failure','error'].include?(number.to_s)
+        
+        return false unless number.to_s.length >= 13
+
+        sum = 0
+        for i in 0..number.length
+          weight = number[-1 * (i + 2), 1].to_i * (2 - (i % 2))
+          sum += (weight < 10) ? weight : weight - 9
+        end
+
+        (number[-1,1].to_i == (10 - sum % 10) % 10)
+      end
+
+      # Show the card number, with all but last 4 numbers replace with "X". (XXXX-XXXX-XXXX-4338)
+      def display_number
+        "XXXX-XXXX-XXXX-#{last_digits}"
+      end
+      
+      def last_digits
+        number.nil? ? "" : number.last(4)
+      end
+
+      def month
+        expiry_date.month
+      end
+
+      def year
+        expiry_date.year
+      end
+
+      def expiry_date
+        ExpiryDate.new(@month, @year)
+      end
+    end
+  end
+end