smulube-activemerchant 1.5.1.1 → 1.5.1.2

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.orig
+*.swp
+*.swo
+.autotest
+*.gemspec

data/Rakefile

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'lib/support/gateway_support'
+require 'lib/active_merchant'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "smulube-activemerchant"
+    gemspec.version = ActiveMerchant::VERSION
+    gemspec.summary = 'Framework and tools for dealing with credit card transactions.'
+    gemspec.description  = 'Active Merchant is a simple payment abstraction library used in and sponsored by Shopify. It is written by Tobias Luetke, Cody Fauser, and contributors. The aim of the project is to feel natural to Ruby users and to abstract as many parts as possible away from the user to offer a consistent interface across all supported gateways.'
+    gemspec.email = "tobi@leetsoft.com"
+    gemspec.authors = ["Tobias Luetke", "Cody Fauser", "Dennis Thiesen", "Sam Mulube"]
+    gemspec.homepage = 'http://activemerchant.org/'
+    gemspec.add_dependency('activesupport', '>= 2.3.2')
+    gemspec.add_dependency('builder', '>= 2.0.0')
+  
+    gemspec.signing_key = ENV['GEM_PRIVATE_KEY']
+    gemspec.cert_chain  = ['gem-public_cert.pem']
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new(:units) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/unit/**/*_test.rb'
+    test.verbose = true
+    test.ruby_opts << '-rubygems'
+  end
+
+  Rake::TestTask.new(:remote) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/remote/**/*_test.rb'
+    test.verbose = true
+    test.ruby_opts << '-rubygems'
+  end
+end
+
+desc "Run the unit test suite"
+task :default => 'test:units'
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "ActiveMerchant library"
+  rdoc.options << '--line-numbers' << '--inline-source' << '--main=README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc', 'CHANGELOG')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('lib/tasks')
+end
+
+require 'rake/clean'
+CLEAN.include("pkg")
+
+namespace :gateways do
+  desc 'Print the currently supported gateways'
+  task :print do
+    support = GatewaySupport.new
+    support.to_s
+  end
+  
+  namespace :print do
+    desc 'Print the currently supported gateways in RDoc format'
+    task :rdoc do
+      support = GatewaySupport.new
+      support.to_rdoc
+    end
+  
+    desc 'Print the currently supported gateways in Textile format'
+    task :textile do
+      support = GatewaySupport.new
+      support.to_textile
+    end
+    
+    desc 'Print the gateway functionality supported by each gateway'
+    task :features do
+      support = GatewaySupport.new
+      support.features
+    end
+  end
+end

data/generators/gateway/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/gateway/gateway_generator.rb

@@ -0,0 +1,61 @@
+class GatewayGenerator < RubiGen::Base
+  LIB_DIR = "lib/active_merchant/billing/gateways/"
+  UNIT_TEST_DIR = "test/unit/gateways/"
+  REMOTE_TEST_DIR =  "test/remote/gateways/"
+  
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.length < 1
+    @name = args.shift
+    extract_options
+  end
+  
+  def class_name
+    @name.classify
+  end
+
+  def manifest
+    record do |m|
+      
+      m.directory LIB_DIR
+      m.directory UNIT_TEST_DIR
+      m.directory REMOTE_TEST_DIR
+
+      m.template 'gateway.rb', LIB_DIR + "#{name}.rb"
+      m.template 'gateway_test.rb', UNIT_TEST_DIR + "#{name}_test.rb"
+      m.template 'remote_gateway_test.rb', REMOTE_TEST_DIR + "remote_#{name}_test.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/generators/gateway/templates/gateway.rb

@@ -0,0 +1,77 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class <%= class_name %>Gateway < Gateway
+      TEST_URL = 'https://example.com/test'
+      LIVE_URL = 'https://example.com/live'
+      
+      # The countries the gateway supports merchants from as 2 digit ISO country codes
+      self.supported_countries = ['US']
+      
+      # The card types supported by the payment gateway
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      
+      # The homepage URL of the gateway
+      self.homepage_url = 'http://www.example.net/'
+      
+      # The name of the gateway
+      self.display_name = 'New Gateway'
+      
+      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
+    
+      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/generators/gateway/templates/gateway_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  def setup
+    @gateway = <%= class_name %>Gateway.new(
+                 :login => 'login',
+                 :password => 'password'
+               )
+
+    @credit_card = credit_card
+    @amount = 100
+    
+    @options = { 
+      :order_id => '1',
+      :billing_address => address,
+      :description => 'Store Purchase'
+    }
+  end
+  
+  def test_successful_purchase
+    @gateway.expects(:ssl_post).returns(successful_purchase_response)
+    
+    assert response = @gateway.purchase(@amount, @credit_card, @options)
+    assert_instance_of 
+    assert_success response
+    
+    # Replace with authorization number from the successful response
+    assert_equal '', response.authorization
+    assert response.test?
+  end
+
+  def test_unsuccessful_request
+    @gateway.expects(:ssl_post).returns(failed_purchase_response)
+    
+    assert response = @gateway.purchase(@amount, @credit_card, @options)
+    assert_failure response
+    assert response.test?
+  end
+
+  private
+  
+  # Place raw successful response from gateway here
+  def successful_purchase_response
+  end
+  
+  # Place raw failed response from gateway here
+  def failed_purcahse_response
+  end
+end

data/generators/gateway/templates/remote_gateway_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class Remote<%= class_name %>Test < Test::Unit::TestCase
+  
+
+  def setup
+    @gateway = <%= class_name %>Gateway.new(fixtures(:<%= class_name.underscore %>))
+    
+    @amount = 100
+    @credit_card = credit_card('4000100011112224')
+    @declined_card = credit_card('4000300011112220')
+    
+    @options = { 
+      :order_id => '1',
+      :billing_address => address,
+      :description => 'Store Purchase'
+    }
+  end
+  
+  def test_successful_purchase
+    assert response = @gateway.purchase(@amount, @credit_card, @options)
+    assert_success response
+    assert_equal 'REPLACE WITH SUCCESS MESSAGE', response.message
+  end
+
+  def test_unsuccessful_purchase
+    assert response = @gateway.purchase(@amount, @declined_card, @options)
+    assert_failure response
+    assert_equal 'REPLACE WITH FAILED PURCHASE MESSAGE', response.message
+  end
+
+  def test_authorize_and_capture
+    amount = @amount
+    assert auth = @gateway.authorize(amount, @credit_card, @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, @credit_card, @options)
+    assert_failure response
+    assert_equal 'REPLACE WITH FAILURE MESSAGE', response.message
+  end
+end

data/generators/integration/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/generators/integration/integration_generator.rb

@@ -0,0 +1,68 @@
+class IntegrationGenerator < RubiGen::Base
+  BASE_DIR = "lib/active_merchant/billing/integrations/"
+  TEST_DIR = "test/unit/integrations/"
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.size < 1
+    @name = args.shift
+    extract_options
+  end
+  
+  def class_name
+    name.classify
+  end
+  
+  def lib_dir
+    BASE_DIR + name
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory lib_dir
+      m.directory TEST_DIR
+      m.directory TEST_DIR + "helpers"
+      m.directory TEST_DIR + "notifications"
+      
+      m.template 'integration.rb', "#{lib_dir}.rb"
+      m.template 'helper.rb', lib_dir + "/helper.rb"      
+      m.template 'notification.rb', lib_dir + "/notification.rb"
+     
+      m.template 'module_test.rb', TEST_DIR + "#{name}_module_test.rb"
+      m.template 'helper_test.rb', TEST_DIR + "helpers/#{name}_helper_test.rb"
+      m.template 'notification_test.rb', TEST_DIR + "notifications/#{name}_notification_test.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/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/generators/integration/templates/helper_test.rb

@@ -0,0 +1,54 @@
+require '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

data/generators/integration/templates/integration.rb

@@ -0,0 +1,18 @@
+require File.dirname(__FILE__) + '/<%= name %>/helper.rb'
+require File.dirname(__FILE__) + '/<%= name %>/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module <%= class_name %> 
+       
+        mattr_accessor :service_url
+        self.service_url = 'https://www.example.com'
+
+        def self.notification(post)
+          Notification.new(post)
+        end  
+      end
+    end
+  end
+end

data/generators/integration/templates/module_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class <%= class_name %>ModuleTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+  
+  def test_notification_method
+    assert_instance_of <%= class_name %>::Notification, <%= class_name %>.notification('name=cody')
+  end
+end 

data/generators/integration/templates/notification.rb

@@ -0,0 +1,100 @@
+require 'net/http'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module <%= class_name %>
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          def complete?
+            params['']
+          end 
+
+          def item_id
+            params['']
+          end
+
+          def transaction_id
+            params['']
+          end
+
+          # When was this payment received by the client. 
+          def received_at
+            params['']
+          end
+
+          def payer_email
+            params['']
+          end
+         
+          def receiver_email
+            params['']
+          end 
+
+          def security_key
+            params['']
+          end
+
+          # the money amount we received in X.2 decimal.
+          def gross
+            params['']
+          end
+
+          # Was this a test transaction?
+          def test?
+            params[''] == 'test'
+          end
+
+          def status
+            params['']
+          end
+
+          # Acknowledge the transaction to <%= class_name %>. This method has to be called after a new 
+          # apc arrives. <%= class_name %> will verify that all the information we received are correct and will return a 
+          # ok or a fail. 
+          # 
+          # Example:
+          # 
+          #   def ipn
+          #     notify = <%= class_name %>Notification.new(request.raw_post)
+          #
+          #     if notify.acknowledge 
+          #       ... process order ... if notify.complete?
+          #     else
+          #       ... log possible hacking attempt ...
+          #     end
+          def acknowledge      
+            payload = raw
+
+            uri = URI.parse(<%= class_name %>.notification_confirmation_url)
+
+            request = Net::HTTP::Post.new(uri.path)
+
+            request['Content-Length'] = "#{payload.size}"
+            request['User-Agent'] = "Active Merchant -- http://home.leetsoft.com/am"
+            request['Content-Type'] = "application/x-www-form-urlencoded" 
+
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.verify_mode    = OpenSSL::SSL::VERIFY_NONE unless @ssl_strict
+            http.use_ssl        = true
+
+            response = http.request(request, payload)
+
+            # Replace with the appropriate codes
+            raise StandardError.new("Faulty <%= class_name %> result: #{response.body}") unless ["AUTHORISED", "DECLINED"].include?(response.body)
+            response.body == "AUTHORISED"
+          end
+ private
+
+          # Take the posted data and move the relevant data into a hash
+          def parse(post)
+            @raw = post
+            for line in post.split('&')
+              key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+              params[key] = value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/generators/integration/templates/notification_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class <%= class_name %>NotificationTest < Test::Unit::TestCase
+  include ActiveMerchant::Billing::Integrations
+
+  def setup
+    @<%= name %> = <%= class_name %>::Notification.new(http_raw_data)
+  end
+
+  def test_accessors
+    assert @<%= name %>.complete?
+    assert_equal "", @<%= name %>.status
+    assert_equal "", @<%= name %>.transaction_id
+    assert_equal "", @<%= name %>.item_id
+    assert_equal "", @<%= name %>.gross
+    assert_equal "", @<%= name %>.currency
+    assert_equal "", @<%= name %>.received_at
+    assert @<%= name %>.test?
+  end
+
+  def test_compositions
+    assert_equal Money.new(3166, 'USD'), @<%= name %>.amount
+  end
+
+  # Replace with real successful acknowledgement code
+  def test_acknowledgement    
+
+  end
+
+  def test_send_acknowledgement
+  end
+
+  def test_respond_to_acknowledge
+    assert @<%= name %>.respond_to?(:acknowledge)
+  end
+
+  private
+  def http_raw_data
+    ""
+  end  
+end

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)