activemerchant 1.1.0 → 1.2.0

data/lib/active_merchant/lib/requires_parameters.rb

@@ -4,10 +4,10 @@ module ActiveMerchant #:nodoc:
       keys = hash.keys
       params.each do |param| 
         if param.is_a?(Array)
-          raise ArgumentError.new("Missing required parameter: #{param}") unless keys.include?(param.first) 
+          raise ArgumentError.new("Missing required parameter: #{param.first}") unless keys.include?(param.first) 
 
           valid_options = param[1..-1]
-          raise ArgumentError.new("Parameter :#{param.first} must be one of #{valid_options.inspect}") unless valid_options.include?(hash[param.first])
+          raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(:connector => 'or')}") unless valid_options.include?(hash[param.first])
         else
           raise ArgumentError.new("Missing required parameter: #{param}") unless keys.include?(param) 
         end

data/lib/active_merchant/lib/validateable.rb

@@ -28,7 +28,7 @@ module ActiveMerchant #:nodoc:
     end  
 
     # This hash keeps the errors of the object
-    class Errors < Hash
+    class Errors < HashWithIndifferentAccess
 
       def initialize(base)
         @base = base

data/lib/support/gateway_support.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'active_support'
+require 'lib/active_merchant'
+
+
+class GatewaySupport
+  attr_reader :gateways
+  
+  def initialize
+    @gateways = []
+    ObjectSpace.each_object(Class) do |c|  
+      if c.name =~ /Gateway/ && c.ancestors.reject{|a| a == c}.include?(ActiveMerchant::Billing::Gateway)
+        gateways << c
+      end
+    end
+    
+    @gateways.delete(ActiveMerchant::Billing::BogusGateway)
+    @gateways = @gateways.sort_by(&:name)
+  end
+  
+  def each_gateway
+    @gateways.each{|g| yield g }
+  end
+  
+  def to_rdoc
+    each_gateway do |g|
+      puts "* {#{g.display_name}}[#{g.homepage_url}] - #{g.supported_countries.join(', ')}"
+    end
+  end
+  
+  def to_textile
+    each_gateway do |g|
+      puts %/ * "#{g.display_name}":#{g.homepage_url} [#{g.supported_countries.join(', ')}]/
+    end
+  end
+  
+  def to_s
+    each_gateway do |g|
+      puts "#{g.display_name} - #{g.homepage_url} [#{g.supported_countries.join(', ')}]"
+    end
+  end
+end
+
+
+    

data/lib/tasks/cia.rb

@@ -71,7 +71,7 @@ task :cia do
   
   if build.has_changes? and not build.tests_ok? 
 
-    require_gem 'actionmailer'
+    require 'actionmailer'
 
     ActionMailer::Base.delivery_method = :sendmail
 

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'active_support'
+rescue LoadError
+  require 'rubygems'
+  require 'active_support'
+end
+
+require 'erb'
+require 'script/generator/generator'
+
+ActiveMerchant::Generator::Generator.run(ARGV)
+

data/script/generator/base.rb

@@ -0,0 +1,45 @@
+module ActiveMerchant #:nodoc:
+  module Generator
+    class Base
+      attr_reader :class_name, :name
+
+      def initialize(name, class_name)
+        @name = name
+        @class_name = class_name
+      end
+
+      def root
+        File.dirname(__FILE__) + '/../..'
+      end
+
+      def run
+        # Create the required directories
+        manifest.directories.each do |d|
+          if File.exists?("#{root}/#{d}")
+            puts "Ignoring existing directory #{d}"
+          else 
+            puts "Creating directory #{d}"
+            Dir.mkdir("#{root}/#{d}")
+          end
+        end 
+        
+        manifest.templates.each do |t|
+          template = ERB.new(File.read(File.dirname(__FILE__) + "/generators/#{name}/templates/#{t[:input]}"), nil, '-')
+          File.open("#{root}/#{t[:output]}", 'w') do |f|
+            puts "Writing file #{t[:output]}"
+            f.puts template.result(binding)
+          end
+        end
+      end
+
+      def file_name
+        @class_name.underscore
+      end
+
+      protected
+      def record
+        Manifest.new{ |m| yield m }
+      end
+    end
+  end
+end

data/script/generator/generator.rb

@@ -0,0 +1,24 @@
+require 'script/generator/manifest'
+require 'script/generator/base'
+
+module ActiveMerchant #:nodoc:
+  module Generator
+    class Generator
+      def self.run(args = [])
+        unless args.size == 2
+          puts <<-BANNER
+Usage: script/generate <generator> <ClassName>
+Where <generator> is one of:
+  gateway     - Generate a new payment gateway
+  integration - Generate a new payment integration
+          BANNER
+          exit
+        end
+  
+        generator, class_name = ARGV  
+        require "script/generator/generators/#{generator}/#{generator}_generator"
+        "#{generator.classify}Generator".constantize.new(generator, class_name).run
+      end
+    end
+  end
+end

data/script/generator/generators/gateway/gateway_generator.rb

@@ -0,0 +1,14 @@
+class GatewayGenerator < ActiveMerchant::Generator::Base
+  def manifest
+    record do |m|
+      m.template 'gateway.rb',
+                 "lib/active_merchant/billing/gateways/#{file_name}.rb"
+
+      m.template 'gateway_test.rb',
+                 "test/unit/gateways/#{file_name}_test.rb"
+
+      m.template 'remote_gateway_test.rb',
+                 "test/remote_tests/remote_#{file_name}_test.rb"
+    end
+  end
+end

data/script/generator/generators/gateway/templates/gateway.rb

@@ -0,0 +1,73 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class <%= class_name %>Gateway < Gateway
+      TEST_URL = 'https://example.com/test'
+      LIVE_URL = 'https://example.com/live'
+      
+      attr_reader :url 
+      attr_reader :response
+      attr_reader :options
+
+      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)        
+        add_address(post, creditcard, options)        
+        add_customer_data(post, options)
+        
+        commit('authonly', money, post)
+      end
+      
+      def purchase(money, creditcard, options = {})
+        post = {}
+        add_invoice(post, options)
+        add_creditcard(post, creditcard)        
+        add_address(post, creditcard, options)   
+        add_customer_data(post, options)
+             
+        commit('sale', money, post)
+      end                       
+    
+      def capture(money, authorization, options = {})
+        commit('capture', money, post)
+      end
+    
+      def self.supported_cardtypes
+        [:visa, :master, :american_express]
+      end
+         
+      private                       
+      
+      def add_customer_data(post, options)
+      end
+
+      def add_address(post, creditcard, options)      
+      end
+
+      def add_invoice(post, options)
+      end
+      
+      def add_creditcard(post, creditcard)      
+      end
+      
+      def parse(body)
+      end     
+      
+      def commit(action, money, parameters)
+      end
+
+      def message_from(response)
+      end
+      
+      def post_data(action, parameters = {})
+      end
+    end
+  end
+end
+

data/script/generator/generators/gateway/templates/gateway_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  AMOUNT = 100
+
+  def setup
+    @gateway = <%= class_name %>Gateway.new(fixtures(:<%= class_name.underscore %>))
+
+    @creditcard = credit_card('4242424242424242')
+
+    @address = { :address1 => '1234 My Street',
+                 :address2 => 'Apt 1',
+                 :company => 'Widgets Inc',
+                 :city => 'Ottawa',
+                 :state => 'ON',
+                 :zip => 'K1C2N6',
+                 :country => 'Canada',
+                 :phone => '(555)555-5555'
+               }
+  end
+  
+  def test_successful_request
+    @creditcard.number = 1
+    assert response = @gateway.purchase(AMOUNT, @creditcard, {})
+    assert_success response
+    assert_equal '5555', response.authorization
+    assert response.test?
+  end
+
+  def test_unsuccessful_request
+    @creditcard.number = 2
+    assert response = @gateway.purchase(AMOUNT, @creditcard, {})
+    assert_failure response
+    assert response.test?
+  end
+
+  def test_request_error
+    @creditcard.number = 3
+    assert_raise(Error){ @gateway.purchase(AMOUNT, @creditcard, {}) }
+  end
+end

data/script/generator/generators/gateway/templates/remote_gateway_test.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class Remote<%= class_name %>Test < Test::Unit::TestCase
+  AMOUNT = 100
+
+  def setup
+    @gateway = <%= class_name %>Gateway.new(fixtures(:<%= class_name.underscore %>))
+
+    @creditcard = credit_card('4000100011112224')
+
+    @declined_card = credit_card('4000300011112220')
+
+    @options = { :address => { :address1 => '1234 Shady Brook Lane',
+                              :zip => '90210'
+                             }
+               }
+  end
+  
+  def test_successful_purchase
+    assert response = @gateway.purchase(AMOUNT, @creditcard, @options)
+    assert_equal 'REPLACE WITH SUCCESS MESSAGE', response.message
+    assert_success response
+  end
+
+  def test_unsuccessful_purchase
+    assert response = @gateway.purchase(AMOUNT, @declined_card, @options)
+    assert_equal 'REPLACE WITH FAILED PURCHASE MESSAGE', response.message
+    assert_failure response
+  end
+
+  def test_authorize_and_capture
+    amount = AMOUNT
+    assert auth = @gateway.authorize(amount, @creditcard, @options)
+    assert_success auth
+    assert_equal 'Success', auth.message
+    assert auth.authorization
+    assert capture = @gateway.capture(amount, auth.authorization)
+    assert_success capture
+  end
+
+  def test_failed_capture
+    assert response = @gateway.capture(AMOUNT, '')
+    assert_failure response
+    assert_equal 'REPLACE WITH GATEWAY FAILURE MESSAGE', response.message
+  end
+
+  def test_invalid_login
+    gateway = <%= class_name %>Gateway.new({
+        :login => '',
+        :password => ''
+      })
+    assert response = gateway.purchase(AMOUNT, @creditcard, @options)
+    assert_equal 'REPLACE WITH FAILURE MESSAGE', response.message
+    assert_failure response
+  end
+end

data/script/generator/generators/integration/integration_generator.rb

@@ -0,0 +1,25 @@
+class IntegrationGenerator < ActiveMerchant::Generator::Base
+  def manifest
+    @manifest ||= record do |m|
+      m.directory "lib/active_merchant/billing/integrations/#{file_name}"
+      
+      m.template 'integration.rb',
+                 "lib/active_merchant/billing/integrations/#{file_name}.rb"
+      
+      m.template 'helper.rb',
+                 "lib/active_merchant/billing/integrations/#{file_name}/helper.rb"
+      
+      m.template 'notification.rb',
+                 "lib/active_merchant/billing/integrations/#{file_name}/notification.rb"
+
+      m.template 'module_test.rb',
+                 "test/unit/integrations/#{file_name}_module_test.rb"
+      
+      m.template 'helper_test.rb',
+                 "test/unit/integrations/helpers/#{file_name}_helper_test.rb"
+      
+      m.template 'notification_test.rb',
+                 "test/unit/integrations/notifications/#{file_name}_notification_test.rb"
+    end
+  end
+end

data/script/generator/generators/integration/templates/helper.rb

@@ -0,0 +1,34 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module <%= class_name %>
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          # Replace with the real mapping
+          mapping :account, ''
+          mapping :amount, ''
+        
+          mapping :order, ''
+
+          mapping :customer, :first_name => '',
+                             :last_name  => '',
+                             :email      => '',
+                             :phone      => ''
+
+          mapping :billing_address, :city     => '',
+                                    :address1 => '',
+                                    :address2 => '',
+                                    :state    => '',
+                                    :zip      => '',
+                                    :country  => ''
+
+          mapping :notify_url, ''
+          mapping :return_url, ''
+          mapping :cancel_return_url, ''
+          mapping :description, ''
+          mapping :tax, ''
+          mapping :shipping, ''
+        end
+      end
+    end
+  end
+end

data/script/generator/generators/integration/templates/helper_test.rb

@@ -0,0 +1,54 @@
+require File.dirname(__FILE__) + '/../../../test_helper'
+
+class <%= class_name %>HelperTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+  
+  def setup
+    @helper = <%= class_name %>::Helper.new('order-500','cody@example.com', :amount => 500, :currency => 'USD')
+  end
+ 
+  def test_basic_helper_fields
+    assert_field '', 'cody@example.com'
+
+    assert_field '', '5.00'
+    assert_field '', 'order-500'
+  end
+  
+  def test_customer_fields
+    @helper.customer :first_name => 'Cody', :last_name => 'Fauser', :email => 'cody@example.com'
+    assert_field '', 'Cody'
+    assert_field '', 'Fauser'
+    assert_field '', 'cody@example.com'
+  end
+
+  def test_address_mapping
+    @helper.billing_address :address1 => '1 My Street',
+                            :address2 => '',
+                            :city => 'Leeds',
+                            :state => 'Yorkshire',
+                            :zip => 'LS2 7EE',
+                            :country  => 'CA'
+   
+    assert_field '', '1 My Street'
+    assert_field '', 'Leeds'
+    assert_field '', 'Yorkshire'
+    assert_field '', 'LS2 7EE'
+  end
+  
+  def test_unknown_address_mapping
+    @helper.billing_address :farm => 'CA'
+    assert_equal 3, @helper.fields.size
+  end
+
+  def test_unknown_mapping
+    assert_nothing_raised do
+      @helper.company_address :address => '500 Dwemthy Fox Road'
+    end
+  end
+  
+  def test_setting_invalid_address_field
+    fields = @helper.fields.dup
+    @helper.billing_address :street => 'My Street'
+    assert_equal fields, @helper.fields
+  end
+end