johnideal-activemerchant 1.4.4

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)

data/lib/active_merchant/billing/avs_result.rb

@@ -0,0 +1,98 @@
+#!ruby19
+# encoding: utf-8
+
+module ActiveMerchant
+  module Billing 
+    # Implements the Address Verification System
+    # https://www.wellsfargo.com/downloads/pdf/biz/merchant/visa_avs.pdf
+    # http://en.wikipedia.org/wiki/Address_Verification_System
+    # http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_IG/html/app_avs_cvn_codes.htm#app_AVS_CVN_codes_7891_48375
+    # http://imgserver.skipjack.com/imgServer/5293710/AVS%20and%20CVV2.pdf
+    # http://www.emsecommerce.net/avs_cvv2_response_codes.htm
+    class AVSResult
+      MESSAGES = {
+        'A' => 'Street address matches, but 5-digit and 9-digit postal code do not match.',
+        'B' => 'Street address matches, but postal code not verified.',
+        'C' => 'Street address and postal code do not match.',
+        'D' => 'Street address and postal code match.',
+        'E' => 'AVS data is invalid or AVS is not allowed for this card type.',
+        'F' => 'Card member\'s name does not match, but billing postal code matches.',
+        'G' => 'Non-U.S. issuing bank does not support AVS.',
+        'H' => 'Card member\'s name does not match. Street address and postal code match.',
+        'I' => 'Address not verified.',
+        'J' => 'Card member\'s name, billing address, and postal code match. Shipping information verified and chargeback protection guaranteed through the Fraud Protection Program.',
+        'K' => 'Card member\'s name matches but billing address and billing postal code do not match.',
+        'L' => 'Card member\'s name and billing postal code match, but billing address does not match.',
+        'M' => 'Street address and postal code match.',
+        'N' => 'Street address and postal code do not match.',
+        'O' => 'Card member\'s name and billing address match, but billing postal code does not match.',
+        'P' => 'Postal code matches, but street address not verified.',
+        'Q' => 'Card member\'s name, billing address, and postal code match. Shipping information verified but chargeback protection not guaranteed.',
+        'R' => 'System unavailable.',
+        'S' => 'U.S.-issuing bank does not support AVS.',
+        'T' => 'Card member\'s name does not match, but street address matches.',
+        'U' => 'Address information unavailable.',
+        'V' => 'Card member\'s name, billing address, and billing postal code match.',
+        'W' => 'Street address does not match, but 9-digit postal code matches.',
+        'X' => 'Street address and 9-digit postal code match.',
+        'Y' => 'Street address and 5-digit postal code match.',
+        'Z' => 'Street address does not match, but 5-digit postal code matches.'
+      }
+      
+      # Map vendor's AVS result code to a postal match code
+      POSTAL_MATCH_CODE = {
+        'Y' => %w( D H F H J L M P Q V W X Y Z ),
+        'N' => %w( A C K N O ),
+        'X' => %w( G S ),
+        nil => %w( B E I R T U )
+      }.inject({}) do |map, (type, codes)|
+        codes.each { |code| map[code] = type }
+        map
+      end
+      
+      # Map vendor's AVS result code to a street match code
+      STREET_MATCH_CODE = {
+        'Y' => %w( A B D H J M O Q T V X Y ),
+        'N' => %w( C K L N P W Z ),
+        'X' => %w( G S ),
+        nil => %w( E F I R U )
+      }.inject({}) do |map, (type, codes)|
+        codes.each { |code| map[code] = type }
+        map
+      end
+      
+      attr_reader :code, :message, :street_match, :postal_match
+      
+      def self.messages
+        MESSAGES
+      end
+      
+      def initialize(attrs)
+        attrs ||= {}
+        
+        @code = attrs[:code].upcase unless attrs[:code].blank?
+        @message = self.class.messages[code]
+        
+        if attrs[:street_match].blank?
+          @street_match = STREET_MATCH_CODE[code]
+        else  
+          @street_match = attrs[:street_match].upcase
+        end
+          
+        if attrs[:postal_match].blank?
+          @postal_match = POSTAL_MATCH_CODE[code]
+        else  
+          @postal_match = attrs[:postal_match].upcase
+        end
+      end
+    
+      def to_hash
+        { 'code' => code,
+          'message' => message,
+          'street_match' => street_match,
+          'postal_match' => postal_match
+        }
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/base.rb

@@ -0,0 +1,57 @@
+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)
+        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)
+        Billing::Integrations.const_get("#{name.to_s.downcase}".camelize)
+      end
+      
+      # A check to see if we're in test mode
+      def self.test?
+        self.gateway_mode == :test
+      end
+    end             
+  end
+end

data/lib/active_merchant/billing/check.rb

@@ -0,0 +1,68 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    # The Check object is a plain old Ruby object, similar to CreditCard. It supports validation
+    # of necessary attributes such as checkholder's name, routing and account numbers, but it is
+    # not backed by any database.
+    # 
+    # You may use Check in place of CreditCard with any gateway that supports it. Currently, only
+    # +BrainTreeGateway+ supports the Check object.
+    class Check
+      include Validateable
+      
+      attr_accessor :first_name, :last_name, :routing_number, :account_number, :account_holder_type, :account_type, :number
+      
+      # Used for Canadian bank accounts
+      attr_accessor :institution_number, :transit_number
+      
+      def name
+        @name ||= "#{@first_name} #{@last_name}".strip
+      end
+      
+      def name=(value)
+        return if value.blank?
+
+        @name = value
+        segments = value.split(' ')
+        @last_name = segments.pop
+        @first_name = segments.join(' ')
+      end
+      
+      def validate
+        [:name, :routing_number, :account_number].each do |attr|
+          errors.add(attr, "cannot be empty") if self.send(attr).blank?
+        end
+        
+        errors.add(:routing_number, "is invalid") unless valid_routing_number?
+        
+        errors.add(:account_holder_type, "must be personal or business") if
+            !account_holder_type.blank? && !%w[business personal].include?(account_holder_type.to_s)
+        
+        errors.add(:account_type, "must be checking or savings") if
+            !account_type.blank? && !%w[checking savings].include?(account_type.to_s)
+      end
+      
+      def type
+        'check'
+      end
+      
+      # Routing numbers may be validated by calculating a checksum and dividing it by 10. The
+      # formula is:
+      #   (3(d1 + d4 + d7) + 7(d2 + d5 + d8) + 1(d3 + d6 + d9))mod 10 = 0
+      # See http://en.wikipedia.org/wiki/Routing_transit_number#Internal_checksums
+      def valid_routing_number?
+        d = routing_number.to_s.split('').map(&:to_i).select { |d| (0..9).include?(d) }
+        case d.size
+          when 9 then
+            checksum = ((3 * (d[0] + d[3] + d[6])) +
+                        (7 * (d[1] + d[4] + d[7])) +
+                             (d[2] + d[5] + d[8])) % 10
+            case checksum
+              when 0 then true
+              else        false
+            end
+          else false
+        end
+      end
+    end
+  end
+end