activemerchant 1.0.0

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

@@ -0,0 +1,189 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+        
+    class UsaEpayGateway < Gateway
+    	GATEWAY_URL = 'https://www.usaepay.com/gate.php'
+      
+      attr_reader :url 
+      attr_reader :response
+      attr_reader :options
+
+      def initialize(options = {})
+        requires!(options, :login)
+        @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 = {})
+        post = {:refNum => authorization}
+        commit('capture', money, post)
+      end
+    
+      def self.supported_cardtypes
+        [:visa, :master, :american_express]
+      end
+         
+      private                       
+    
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{year[-2..-1]}#{month}"
+      end
+      
+      def add_customer_data(post, options)
+        address = options[:billing_address] || options[:address] || {}
+        post[:street] = address[:address1]
+        post[:zip] = address[:zip]
+
+        if options.has_key? :email
+          post[:custemail] = options[:email]
+          post[:custreceipt] = 'No'
+        end
+        
+        if options.has_key? :customer
+          post[:custid] = options[:customer]
+        end
+        
+        if options.has_key? :ip
+          post[:ip] = options[:ip]
+        end        
+      end
+
+      def add_address(post, creditcard, options)
+        billing_address = options[:billing_address] || options[:address]
+        shipping_address = options[:shipping_address] || billing_address
+        
+        add_address_for_type(:billing, post, creditcard, billing_address) unless billing_address.nil?
+        add_address_for_type(:shipping, post, creditcard, shipping_address) unless shipping_address.nil?
+      end
+
+      def add_address_for_type(type, post, creditcard, address)
+        prefix = address_key_prefix(type)
+
+        post[address_key(prefix, 'fname')] = creditcard.first_name
+        post[address_key(prefix, 'lname')] = creditcard.last_name
+        post[address_key(prefix, 'company')] = address[:company] unless address[:company].blank?
+        post[address_key(prefix, 'street')] = address[:address1] unless address[:address1].blank?
+        post[address_key(prefix, 'street2')] = address[:address2] unless address[:address2].blank?
+        post[address_key(prefix, 'city')] = address[:city] unless address[:city].blank?
+        post[address_key(prefix, 'state')] = address[:state] unless address[:state].blank?
+        post[address_key(prefix, 'zip')] = address[:zip] unless address[:zip].blank?
+        post[address_key(prefix, 'country')] = address[:country] unless address[:country].blank?
+        post[address_key(prefix, 'phone')] = address[:phone] unless address[:phone].blank?
+      end
+      
+      def address_key_prefix(type)  
+        case type
+        when :shipping then 'ship'
+        when :billing then 'bill'
+        end
+      end
+
+      def address_key(prefix, key)
+        "#{prefix}#{key}".to_sym
+      end
+      
+      def add_invoice(post, options)
+        post[:invoice] = options[:order_id]
+      end
+      
+      def add_creditcard(post, creditcard)      
+        post[:card]  = creditcard.number
+        post[:cvv2] = creditcard.verification_value if creditcard.verification_value?
+        post[:expir]  = expdate(creditcard)
+        post[:name] = creditcard.name
+      end
+      
+      def parse(body)
+        fields = {}
+        for line in body.split('&')
+          key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
+          fields[key] = CGI.unescape(value)
+        end
+
+        {
+          :status => fields['UMstatus'],
+          :auth_code => fields['UMauthCode'],
+          :ref_num => fields['UMrefNum'],
+          :batch => fields['UMbatch'],
+          :avs_result => fields['UMavsResult'],
+          :avs_result_code => fields['UMavsResultCode'],
+          :cvv2_result => fields['UMcvv2Result'],
+          :cvv2_result_code => fields['UMcvv2ResultCode'],
+          :vpas_result_code => fields['UMvpasResultCode'],
+          :result => fields['UMresult'],
+          :error => fields['UMerror'],
+          :error_code => fields['UMerrorcode'],
+          :acs_url => fields['UMacsurl'],
+          :payload => fields['UMpayload']
+        }.delete_if{|k, v| v.nil?}         
+      end     
+
+      
+      def commit(action, money, parameters)
+        parameters[:software] = 'Active Merchant'
+        parameters[:amount]       = amount(money)
+        parameters[:testmode] = test? ? 1 : 0
+        
+        if result = test_result_from_cc_number(parameters[:card])
+          return result
+        end
+                   
+        data = ssl_post GATEWAY_URL, 
+                        post_data(action, parameters),
+                        { 'Content-Type' => 'application/x-www-form-urlencoded' }
+        
+        @response = parse(data)
+        success = @response[:status] == 'Approved'
+        message = message_from(@response)
+
+        Response.new(success, message, @response, 
+            :test => test?,
+            :authorization => @response[:ref_num]
+        )        
+      end
+
+      def message_from(response)
+        if response[:status] == "Approved"
+          return 'Success'
+        else
+          return 'Unspecified error' if response[:error].blank?
+          return response[:error]
+        end
+      end
+      
+      def post_data(action, parameters = {})
+        post = {}
+  
+        post[:command]  = action
+        post[:key] = @options[:login]
+
+        request = post.merge(parameters).collect { |key, value| "UM#{key}=#{CGI.escape(value.to_s)}" }.join("&")
+        request
+      end
+    end
+  end
+end
+

data/lib/active_merchant/billing/integrations.rb

@@ -0,0 +1,12 @@
+require 'active_merchant/billing/integrations/notification'
+require 'active_merchant/billing/integrations/helper'
+require 'active_merchant/billing/integrations/bogus'
+require 'active_merchant/billing/integrations/chronopay'
+require 'active_merchant/billing/integrations/paypal'
+require 'active_merchant/billing/integrations/nochex'
+require 'active_merchant/billing/integrations/gestpay'
+
+# make the bogus gateway be classified correctly by the inflector
+Inflector.inflections do |inflect|
+  inflect.uncountable 'bogus'
+end

data/lib/active_merchant/billing/integrations/action_view_helper.rb

@@ -0,0 +1,65 @@
+require_library_or_gem 'action_pack'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module ActionViewHelper
+        # This helper allows the usage of different payment integrations
+        # through a single form helper.  Payment integrations are the
+        # type of service where the user is redirected to the secure
+        # site of the service, like Paypal or Chronopay.
+        #
+        # The helper creates a scope around a payment service helper
+        # which provides the specific mapping for that service.
+        # 
+        #  <% payment_service_for 1000, 'paypalemail@mystore.com',
+        #                               :amount => 50.00, 
+        #                               :currency => 'CAD', 
+        #                               :service => :paypal, 
+        #                               :html => { :id => 'payment-form' } do |service| %>
+        #
+        #    <% service.customer :first_name => 'Cody',
+        #                       :last_name => 'Fauser',
+        #                       :phone => '(555)555-5555',
+        #                       :email => 'codyfauser@gmail.com' %>
+        #
+        #    <% service.billing_address :city => 'Ottawa',
+        #                              :address1 => '21 Snowy Brook Lane',
+        #                              :address2 => 'Apt. 36',
+        #                              :state => 'ON',
+        #                              :country => 'CA',
+        #                              :zip => 'K1J1E5' %>
+        #
+        #    <% service.invoice '#1000' %>
+        #    <% service.shipping '0.00' %>
+        #    <% service.tax '0.00' %>
+        #
+        #    <% service.notify_url url_for(:only_path => false, :action => 'notify') %>
+        #    <% service.return_url url_for(:only_path => false, :action => 'done') %>
+        #    <% service.cancel_return_url 'http://mystore.com' %>
+        #  <% end %>
+        #
+        def payment_service_for(order, account, options = {}, &proc)
+          raise ArgumentError, "Missing block" unless block_given?
+
+          integration_module = ActiveMerchant::Billing::Integrations.const_get(Inflector.classify("#{options.delete(:service)}"))
+
+          concat(form_tag(integration_module.service_url, options.delete(:html) || {}), proc.binding)
+          result = "\n"
+          
+          service_class = integration_module.const_get('Helper')
+          service = service_class.new(order, account, options)
+          yield service
+          
+          result << service.form_fields.collect do |field, value|
+            hidden_field_tag(field, value)
+          end.join("\n")
+
+          result << "\n"
+          result << '</form>' 
+          concat(result, proc.binding)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/bogus.rb

@@ -0,0 +1,17 @@
+require 'active_merchant/billing/integrations/bogus/helper.rb'
+require 'active_merchant/billing/integrations/bogus/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bogus
+        mattr_accessor :service_url
+        self.service_url = 'http://www.bogus.com'
+
+        def self.notification(post)
+          Notification.new(post)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/bogus/helper.rb

@@ -0,0 +1,17 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bogus
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          mapping :account, 'account'
+          mapping :order, 'order'
+          mapping :amount, 'amount'
+          mapping :currency, 'currency'
+          mapping :customer, :first_name => 'first_name',
+                             :last_name => 'last_name'
+
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/bogus/notification.rb

@@ -0,0 +1,11 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Bogus
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/chronopay.rb

@@ -0,0 +1,17 @@
+require 'active_merchant/billing/integrations/chronopay/helper.rb'
+require 'active_merchant/billing/integrations/chronopay/notification.rb'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Chronopay
+        mattr_accessor :service_url
+        self.service_url = 'https://secure.chronopay.com/index_shop.cgi'
+
+        def self.notification(post)
+          Notification.new(post)
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/chronopay/helper.rb

@@ -0,0 +1,81 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Chronopay
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          self.country_format = :alpha3
+          
+          def initialize(order, account, options = {})
+            super
+            add_field('cb_type', 'p')
+            add_field('language', 'EN')
+          end
+
+          # product_id
+          mapping :account, 'product_id'
+          # product_name
+          mapping :invoice, 'product_name'
+          # product_price
+          mapping :amount,   'product_price'
+          # product_price_currency
+          mapping :currency, 'product_price_currency'
+
+          # f_name
+          # s_name
+          # email
+          mapping :customer, :first_name => 'f_name',
+                             :last_name  => 's_name',
+                             :phone      => 'phone',
+                             :email      => 'email'
+
+          # city
+          # street
+          # state
+          # zip
+          # country - The country must be a 3 digit country code
+          # phone
+
+          mapping :billing_address, :city     => 'city',
+                                    :address1 => 'street',
+                                    :state    => 'state',
+                                    :zip      => 'zip',
+                                    :country  => 'country'
+
+          def billing_address(mapping = {})
+            # Gets the country code in the appropriate format or returns what we were given
+            # The appropriate format for Chronopay is the alpha 3 country code
+            country_code = lookup_country_code(mapping.delete(:country))
+            add_field(mappings[:billing_address][:country], country_code)
+            
+            countries_with_supported_states = ['USA', 'CAN']
+            if !countries_with_supported_states.include?(country_code)
+              mapping.delete(:state)
+              add_field(mappings[:billing_address][:state], 'XX')
+            end  
+            mapping.each do |k, v|
+              field = mappings[:billing_address][k]
+              add_field(field, v) unless field.nil?
+            end 
+          end        
+
+          # card_no
+          # exp_month
+          # exp_year
+          mapping :credit_card, :number       => 'card_no',
+                                :expiry_month => 'exp_month',
+                                :expiry_year  => 'exp_year'
+
+          # cb_url
+          mapping :notify_url, 'cb_url'
+
+          # cs1
+          mapping :order, 'cs1'
+
+          # cs2
+          # cs3
+          # decline_url
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/chronopay/notification.rb

@@ -0,0 +1,156 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Chronopay
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          def complete?
+            status == 'Completed'
+          end
+
+          # Status of transaction. List of possible values:
+          # <tt>onetime – one time payment has been made, no repayment required;</tt>::
+          # <tt>initial – first payment has been made, repayment required in corresponding period;</tt>::
+          # <tt>decline – charge request has been rejected;</tt>::
+          # <tt>rebill – repayment has been made together with initial transaction;</ttt>::
+          # <tt>cancel – repayments has been disabled;</tt>::
+          # <tt>expire – customer’s access to restricted zone membership has been expired;</tt>::
+          # <tt>refund – request to refund has been received;</tt>::
+          # <tt>chargeback – request to chargeback has been received.</tt>::
+          # 
+          # This implementation of Chronopay does not support subscriptions.
+          # The status codes used are matched to the status codes that Paypal
+          # sends.  See Paypal::Notification#status for more details
+          def status
+            case params['transaction_type']
+            when 'onetime'
+              'Completed'
+            when 'refund'
+              'Refunded'
+            when 'chargeback'
+              'Reversed'
+            else
+              'Failed'
+            end
+          end
+
+          # Unique ID of transaction
+          def transaction_id
+            params['transaction_id']
+          end
+
+          # Unique ID of customer
+          def customer_id
+            params['customer_id']
+          end
+
+          # Unique ID of Merchant’s web-site
+          def site_id 
+            params['site_id']
+          end
+
+          # ID of a product that was purchased
+          def product_id
+            params['product_id']
+          end
+
+          # Language
+          def language
+            params['language']
+          end
+
+          def received_at
+            Time.parse("#{date} #{time}") unless date.blank? || time.blank?
+          end
+
+          # Date of transaction in MM/DD/YYYY format
+          def date 
+            params['date']
+          end
+
+          # Time of transaction in HH:MM:SS format
+          def time
+            params['time']
+          end
+
+          # The customer's full name
+          def name
+            params['name']
+          end
+
+          # The customer's email address
+          def email
+            params['email']
+          end
+
+          # The customer's street address
+          def street
+            params['street']
+          end
+
+          # The customer's country - 3 digit country code
+          def country
+            params['country']
+          end
+
+          # The customer's city     
+          def city
+            params['city']
+          end
+
+          # The customer's zip
+          def zip
+            params['zip']
+          end
+
+          # The customer's state.  Only useful for US Customers
+          def state
+            params['state']
+          end
+
+          # Customer’s login for restricted access zone of Merchant’s Web-site
+          def username
+            params['username']
+          end
+
+          # Customer's password for restricted access zone of Merchant’s Web-site, as chosen
+          def password
+            params['password']
+          end
+
+          # The item id passed in the first custom parameter
+          def item_id
+            params['cs1']
+          end
+
+          # Additional parameter
+          def custom2
+            params['cs2']
+          end
+
+          # Additional parameter
+          def custom3
+            params['cs3']
+          end
+
+          # The currency the purchase was made in
+          def currency
+            params['currency']
+          end
+
+          # the money amount we received in X.2 decimal.
+          def gross
+            params['total']
+          end
+
+          def test?
+            date.blank? && time.blank? && transaction_id.blank?
+          end
+
+          def acknowledge
+            true
+          end
+        end
+      end
+    end
+  end
+end