activemerchant 1.8.0 → 1.9.0

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

@@ -0,0 +1,330 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class SecureNetGateway < Gateway
+
+      API_VERSION = "4.0"
+
+      TRANSACTIONS = {
+        :auth_only                      => "0000",  #
+        :partial_auth_only              => "0001",
+        :auth_capture                   => "0100",  #
+        :partial_auth_capture           => "0101",
+        :prior_auth_capture             => "0200",
+        :capture_only                   => "0300",  #
+        :void                           => "0400",  #
+        :partial_void                   => "0401",
+        :credit                         => "0500",  #
+        :credit_authonly                => "0501",
+        :credit_priorauthcapture        => "0502",
+        :force_credit                   => "0600",
+        :force_credit_authonly          => "0601",
+        :force_credit_priorauthcapture  => "0602",
+        :verification                   => "0700",
+        :auth_increment                 => "0800",
+        :issue                          => "0900",
+        :activate                       => "0901",
+        :redeem                         => "0902",
+        :redeem_partial                 => "0903",
+        :deactivate                     => "0904",
+        :reactivate                     => "0905",
+        :inquiry_balance                => "0906"
+      }
+
+      XML_ATTRIBUTES = { 'xmlns' => "http://gateway.securenet.com/API/Contracts",
+                         'xmlns:i' => "http://www.w3.org/2001/XMLSchema-instance"
+                       }
+      NIL_ATTRIBUTE = { 'i:nil' => "true" }
+
+#      SUCCESS = "true"
+#      SENSITIVE_FIELDS = [ :verification_str2, :expiry_date, :card_number ]
+
+      self.supported_countries = ['US']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover]
+      self.homepage_url = 'http://www.securenet.com/'
+      self.display_name = 'SecureNet'
+#      self.wiredump_device = STDOUT
+
+#      TEST_URL = 'https://certify.securenet.com/api/Gateway.svc'
+      TEST_URL = 'https://certify.securenet.com/API/gateway.svc/webHttp/ProcessTransaction'
+      LIVE_URL = 'https://gateway.securenet.com/api/Gateway.svc'
+
+      APPROVED, DECLINED, ERROR = 1, 2, 3
+
+      RESPONSE_CODE, RESPONSE_REASON_CODE, RESPONSE_REASON_TEXT = 0, 2, 3
+      AVS_RESULT_CODE, CARD_CODE_RESPONSE_CODE, TRANSACTION_ID  = 5, 6, 8
+
+      CARD_CODE_ERRORS = %w( N S )
+      AVS_ERRORS = %w( A E N R W Z )
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      def authorize(money, creditcard, options = {})
+        commit(build_sale_or_authorization_request(creditcard, options, :auth_only), money)
+      end
+
+      def purchase(money, creditcard, options = {})
+        commit(build_sale_or_authorization_request(creditcard, options, :auth_capture), money)
+      end
+
+      def capture(money, creditcard, authorization, options = {})
+        commit(build_capture_request(authorization, creditcard, options, :prior_auth_capture), money)
+      end
+
+      def void(money, creditcard, authorization, options = {})
+        commit(build_void_request(authorization, creditcard, options, :void), money)
+      end
+
+      def credit(money, creditcard, authorization, options = {})
+        commit(build_credit_request(authorization, creditcard, options, :credit), money)
+      end
+
+      private
+      def commit(request, money)
+        xml = build_request(request, money)
+        data = ssl_post(TEST_URL, xml, "Content-Type" => "text/xml")
+        response = parse(data)
+
+        test_mode = test?
+        Response.new(success?(response), message_from(response), response,
+          :test => test_mode,
+          :authorization => response[:transactionid],
+          :avs_result => { :code => response[:avs_result_code] },
+          :cvv_result => response[:card_code_response_code]
+        )
+      end
+
+      def build_request(request, money)
+        xml = Builder::XmlMarkup.new
+
+        xml.instruct!
+        xml.tag!("TRANSACTION", XML_ATTRIBUTES) do
+          xml.tag! 'AMOUNT', amount(money)
+          xml << request
+        end
+
+        xml.target!
+      end
+
+      def build_sale_or_authorization_request(creditcard, options, action)
+        xml = Builder::XmlMarkup.new
+
+        add_credit_card(xml, creditcard)
+        xml.tag! 'CODE', TRANSACTIONS[action]
+        add_customer_data(xml, options)
+        add_address(xml, creditcard, options)
+        xml.tag! 'DCI', 0 # No duplicate checking will be done, except for ORDERID
+        xml.tag! 'INSTALLMENT_SEQUENCENUM', 1
+        add_invoice(xml, options)
+        add_merchant_key(xml, options)
+        xml.tag! 'METHOD', 'CC'
+        xml.tag! 'ORDERID', options[:order_id]#'30'.to_i.to_s#'22'# @options[:order_id]
+        xml.tag! 'OVERRIDE_FROM', 0 # Docs say not required, but doesn't work without it
+        xml.tag! 'RETAIL_LANENUM', '0' # Docs say string, but it's an integer!?
+        xml.tag! 'TEST', 'TRUE'
+        xml.tag! 'TOTAL_INSTALLMENTCOUNT', 0
+        xml.tag! 'TRANSACTION_SERVICE', 0
+
+        xml.target!
+      end
+
+      def build_capture_or_credit_request(identification, options)
+        xml = Builder::XmlMarkup.new
+
+        add_identification(xml, identification)
+        add_customer_data(xml, options)
+
+        xml.target!
+      end
+
+      def build_capture_request(authorization, creditcard, options, action)
+        xml = Builder::XmlMarkup.new
+
+        add_credit_card(xml, creditcard)
+        xml.tag! 'CODE', TRANSACTIONS[action]
+        add_customer_data(xml, options)
+        xml.tag! 'DCI', 0 # No duplicate checking will be done, except for ORDERID
+        xml.tag! 'INSTALLMENT_SEQUENCENUM', 1
+        add_merchant_key(xml, options)
+        xml.tag! 'METHOD', 'CC'
+        xml.tag! 'ORDERID', options[:order_id]#'30'.to_i.to_s#'22'# @options[:order_id]
+        xml.tag! 'OVERRIDE_FROM', 0 # Docs say not required, but doesn't work without it
+        xml.tag! 'REF_TRANSID', authorization
+        xml.tag! 'RETAIL_LANENUM', '0' # Docs say string, but it's an integer!?
+        xml.tag! 'TEST', 'TRUE'
+        xml.tag! 'TOTAL_INSTALLMENTCOUNT', 0
+        xml.tag! 'TRANSACTION_SERVICE', 0
+
+        xml.target!
+      end
+
+      def build_credit_request(authorization, creditcard, options, action)
+#        requires!(options, :card_number)
+        xml = Builder::XmlMarkup.new
+
+        add_credit_card(xml, creditcard)
+        xml.tag! 'CODE', TRANSACTIONS[action]
+        add_customer_data(xml, options)
+        xml.tag! 'DCI', 0 # No duplicate checking will be done, except for ORDERID
+        xml.tag! 'INSTALLMENT_SEQUENCENUM', 1
+        add_merchant_key(xml, options)
+        xml.tag! 'METHOD', 'CC'
+        xml.tag! 'ORDERID', options[:order_id]#'30'.to_i.to_s#'22'# @options[:order_id]
+        xml.tag! 'OVERRIDE_FROM', 0 # Docs say not required, but doesn't work without it
+        xml.tag! 'REF_TRANSID', authorization
+        xml.tag! 'RETAIL_LANENUM', '0' # Docs say string, but it's an integer!?
+        xml.tag! 'TEST', 'TRUE'
+        xml.tag! 'TOTAL_INSTALLMENTCOUNT', 0
+        xml.tag! 'TRANSACTION_SERVICE', 0
+
+        xml.target!
+      end
+
+      def build_void_request(authorization, creditcard, options, action)
+        xml = Builder::XmlMarkup.new
+
+        add_credit_card(xml, creditcard)
+        xml.tag! 'CODE', TRANSACTIONS[action]
+        add_customer_data(xml, options)
+        xml.tag! 'DCI', 0 # No duplicate checking will be done, except for ORDERID
+        xml.tag! 'INSTALLMENT_SEQUENCENUM', 1
+        add_merchant_key(xml, options)
+        xml.tag! 'METHOD', 'CC'
+        xml.tag! 'ORDERID', options[:order_id]#'30'.to_i.to_s#'22'# @options[:order_id]
+        xml.tag! 'OVERRIDE_FROM', 0 # Docs say not required, but doesn't work without it
+        xml.tag! 'REF_TRANSID', authorization
+        xml.tag! 'RETAIL_LANENUM', '0' # Docs say string, but it's an integer!?
+        xml.tag! 'TEST', 'TRUE'
+        xml.tag! 'TOTAL_INSTALLMENTCOUNT', 0
+        xml.tag! 'TRANSACTION_SERVICE', 0
+
+        xml.target!
+      end
+
+      #########################################################################
+      # FUNCTIONS RELATED TO BUILDING THE XML
+      #########################################################################
+      def add_credit_card(xml, creditcard)
+        xml.tag!("CARD") do
+          xml.tag! 'CARDCODE', creditcard.verification_value if creditcard.verification_value?
+          xml.tag! 'CARDNUMBER', creditcard.number
+          xml.tag! 'EXPDATE', expdate(creditcard)
+        end
+      end
+
+      def expdate(creditcard)
+        year  = sprintf("%.4i", creditcard.year)
+        month = sprintf("%.2i", creditcard.month)
+
+        "#{month}#{year[-2..-1]}"
+      end
+
+      def add_customer_data(xml, options)
+        if options.has_key? :customer
+          xml.tag! 'CUSTOMERID', options[:customer]
+        end
+
+        if options.has_key? :ip
+          xml.tag! 'CUSTOMERIP', options[:ip]
+        end
+      end
+
+      def add_address(xml, creditcard, options)
+
+        if address = options[:billing_address] || options[:address]
+          xml.tag!("CUSTOMER_BILL") do
+            xml.tag! 'ADDRESS', address[:address1].to_s
+            xml.tag! 'CITY', address[:city].to_s
+            xml.tag! 'COMPANY', address[:company].to_s
+            xml.tag! 'COUNTRY', address[:country].to_s
+            if options.has_key? :email
+              xml.tag! 'EMAIL', options[:email]
+#              xml.tag! 'EMAIL', 'myemail@yahoo.com'
+              xml.tag! 'EMAILRECEIPT', 'FALSE'
+            end
+            xml.tag! 'FIRSTNAME', creditcard.first_name
+            xml.tag! 'LASTNAME', creditcard.last_name
+            xml.tag! 'PHONE', address[:phone].to_s
+            xml.tag! 'STATE', address[:state].blank?  ? 'n/a' : address[:state]
+            xml.tag! 'ZIP', address[:zip].to_s
+          end
+        end
+
+        if address = options[:shipping_address]
+          xml.tag!("CUSTOMER_SHIP") do
+            xml.tag! 'ADDRESS', address[:address1].to_s
+            xml.tag! 'CITY', address[:city].to_s
+            xml.tag! 'COMPANY', address[:company].to_s
+            xml.tag! 'COUNTRY', address[:country].to_s
+            xml.tag! 'FIRSTNAME', address[:first_name].to_s
+            xml.tag! 'LASTNAME', address[:last_name].to_s
+            xml.tag! 'STATE', address[:state].blank?  ? 'n/a' : address[:state]
+            xml.tag! 'ZIP', address[:zip].to_s
+          end
+        else
+          xml.tag!('CUSTOMER_SHIP', NIL_ATTRIBUTE) do
+          end
+        end
+
+      end
+
+      def add_invoice(xml, options)
+        xml.tag! 'INVOICEDESC', options[:description]
+        xml.tag! 'INVOICENUM', 'inv-8'
+      end
+
+      def add_merchant_key(xml, options)
+        xml.tag!("MERCHANT_KEY") do
+          xml.tag! 'GROUPID', 0
+          xml.tag! 'SECUREKEY', @options[:password]
+          xml.tag! 'SECURENETID', @options[:login]
+        end
+      end
+
+      #########################################################################
+      # FUNCTIONS RELATED TO THE RESPONSE
+      #########################################################################
+      def success?(response)
+        response[:response_code].to_i == APPROVED
+      end
+
+      def message_from(response)
+        if response[:response_code].to_i == DECLINED
+          return CVVResult.messages[ response[:card_code_response_code] ] if CARD_CODE_ERRORS.include?(response[:card_code_response_code])
+          return AVSResult.messages[ response[:avs_result_code] ] if AVS_ERRORS.include?(response[:avs_result_code])
+        end
+
+        return response[:response_reason_text].nil? ? '' : response[:response_reason_text][0..-1]
+      end
+
+      def parse(xml)
+        response = {}
+        xml = REXML::Document.new(xml)
+        root = REXML::XPath.first(xml, "//GATEWAYRESPONSE")# ||
+#        root = REXML::XPath.first(xml, "//ProcessTransactionResponse")# ||
+#               REXML::XPath.first(xml, "//ErrorResponse")
+        if root
+          root.elements.to_a.each do |node|
+            recurring_parse_element(response, node)
+          end
+        end
+
+        response
+      end
+
+      def recurring_parse_element(response, node)
+        if node.has_elements?
+          node.elements.each{|e| recurring_parse_element(response, e) }
+        else
+          response[node.name.underscore.to_sym] = node.text
+        end
+      end
+
+
+    end
+  end
+end
+

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

@@ -14,7 +14,7 @@ module ActiveMerchant #:nodoc:
           Notification.new(post)
         end
         
-        def self.return(query_string)
+        def self.return(query_string, options = {})
           Return.new(query_string)
         end
       end

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

@@ -14,7 +14,7 @@ module ActiveMerchant #:nodoc:
           Notification.new(post)
         end
         
-        def self.return(query_string)
+        def self.return(query_string, options = {})
           Return.new(query_string)
         end
       end

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

@@ -0,0 +1,37 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module DirecPay
+        autoload :Helper, File.dirname(__FILE__) + '/direc_pay/helper.rb'
+        autoload :Return, File.dirname(__FILE__) + '/direc_pay/return.rb'
+        autoload :Notification, File.dirname(__FILE__) + '/direc_pay/notification.rb'
+        autoload :Status, File.dirname(__FILE__) + '/direc_pay/status.rb'
+       
+        mattr_accessor :production_url, :test_url
+        
+        self.production_url = "https://www.timesofmoney.com/direcpay/secure/dpMerchantTransaction.jsp"
+        self.test_url       = "https://test.timesofmoney.com/direcpay/secure/dpMerchantTransaction.jsp"
+
+        def self.service_url
+          mode = ActiveMerchant::Billing::Base.integration_mode
+          case mode
+          when :production
+            self.production_url
+          when :test
+            self.test_url
+          else
+            raise StandardError, "Integration mode set to an invalid value: #{mode}"
+          end
+        end
+        
+        def self.notification(post)
+          Notification.new(post)
+        end
+        
+        def self.return(query_string)
+          Return.new(query_string)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,188 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module DirecPay
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          mapping :account,  'MID'
+          mapping :order,    'Merchant Order No'
+          mapping :amount,   'Amount'
+          mapping :currency, 'Currency'
+          mapping :country,  'Country'
+          
+          mapping :billing_address,  :city     => 'custCity',
+                                     :address1 => 'custAddress',
+                                     :state    => 'custState',
+                                     :zip      => 'custPinCode',
+                                     :country  => 'custCountry',
+                                     :phone2   => 'custMobileNo'
+
+          mapping :shipping_address, :name     => 'deliveryName',
+                                     :city     => 'deliveryCity',
+                                     :address1 => 'deliveryAddress',
+                                     :state    => 'deliveryState',
+                                     :zip      => 'deliveryPinCode',
+                                     :country  => 'deliveryCountry',
+                                     :phone2   => 'deliveryMobileNo'
+
+          mapping :customer, :name  => 'custName',
+                             :email => 'custEmailId'
+
+          mapping :description, 'otherNotes'
+          mapping :edit_allowed, 'editAllowed'
+          
+          mapping :return_url, 'Success URL'
+          mapping :failure_url, 'Failure URL'
+          
+          mapping :operating_mode, 'Operating Mode'
+          mapping :other_details, 'Other Details'
+          mapping :collaborator, 'Collaborator'
+          
+          OPERATING_MODE = 'DOM'
+          COUNTRY        = 'IND'
+          CURRENCY       = 'INR'
+          OTHER_DETAILS  = 'NULL'
+          EDIT_ALLOWED   = 'N'
+          
+          PHONE_CODES = {
+            'IN' => '91',
+            'US' => '01',
+            'CA' => '01'
+          }
+          
+          ENCODED_PARAMS = [ :account, :operating_mode, :country, :currency, :amount, :order, :other_details, :return_url, :failure_url, :collaborator ]
+          
+          
+          def initialize(order, account, options = {})
+            super
+            collaborator = ActiveMerchant::Billing::Base.integration_mode == :test || options[:test] ? 'TOML' : 'DirecPay'
+            add_field(mappings[:collaborator], collaborator)
+            add_field(mappings[:country], 'IND')
+            add_field(mappings[:operating_mode], OPERATING_MODE)
+            add_field(mappings[:other_details], OTHER_DETAILS)
+            add_field(mappings[:edit_allowed], EDIT_ALLOWED)
+          end
+          
+
+          def customer(params = {})
+            full_name = "#{params[:first_name]} #{params[:last_name]}"
+            add_field(mappings[:customer][:name], full_name)
+            add_field(mappings[:customer][:email], params[:email])
+          end
+          
+          # Need to format the amount to have 2 decimal places
+          def amount=(money)
+            cents = money.respond_to?(:cents) ? money.cents : money
+            if money.is_a?(String) or cents.to_i <= 0
+              raise ArgumentError, 'money amount must be either a Money object or a positive integer in cents.'
+            end
+            add_field(mappings[:amount], sprintf("%.2f", cents.to_f/100))
+          end
+          
+          def shipping_address(params = {})
+            add_street_address!(params)
+            super(params.dup)
+            add_field(mappings[:shipping_address][:name], fields[mappings[:customer][:name]]) if fields[mappings[:shipping_address][:name]].blank?
+            add_phone_for!(:shipping_address, params)
+          end
+          
+          def billing_address(params = {})
+            add_street_address!(params)
+            super(params.dup)
+            add_phone_for!(:billing_address, params)
+          end
+          
+          def form_fields
+            add_failure_url
+            add_request_parameters
+            
+            unencoded_parameters
+          end
+          
+
+          private
+
+          def add_request_parameters
+            params = ENCODED_PARAMS.map{ |param| fields[mappings[param]] }
+            encoded = encode_value(params.join('|'))
+            
+            add_field('requestparameter', encoded)
+          end
+          
+          def unencoded_parameters
+            params = fields.dup
+            # remove all encoded params from exported fields
+            ENCODED_PARAMS.each{ |param| params.delete(mappings[param]) }
+            # remove all special characters from each field value
+            params = params.collect{|name, value| [name, remove_special_characters(value)] }
+            Hash[params]
+          end
+          
+          def add_failure_url
+            if fields[mappings[:failure_url]].nil?
+              add_field(mappings[:failure_url], fields[mappings[:return_url]])
+            end
+          end
+          
+          def add_street_address!(params)
+            address = params[:address1]
+            address << " #{params[:address2]}" if params[:address2]
+            params.merge!(:address1 => address)
+          end
+                    
+          def add_phone_for!(address_type, params)
+            address_field = address_type == :billing_address ? 'custPhoneNo' : 'deliveryPhNo'
+            
+            if params.has_key?(:phone)
+              country = fields[mappings[address_type][:country]]
+              phone = params[:phone].to_s
+              # Remove all non digits
+              phone.gsub!(/[^\d ]+/, '')
+              
+              phone_country_code, phone_area_code, phone_number = nil
+
+              if country == 'IN' && phone =~ /(91)? *(\d{3}) *(\d{4,})$/
+                phone_country_code, phone_area_code, phone_number = $1, $2, $3
+              else
+                numbers = phone.split(' ')
+                case numbers.size
+                when 3
+                  phone_country_code, phone_area_code, phone_number = numbers
+                when 2
+                  phone_area_code, phone_number = numbers
+                else
+                  phone =~ /(\d{3})(\d+)$/
+                  phone_area_code, phone_number = $1, $2
+                end
+              end
+
+              add_field("#{address_field}1", phone_country_code || phone_code_for_country(country) || '91')
+              add_field("#{address_field}2", phone_area_code)
+              add_field("#{address_field}3", phone_number)
+            end
+          end
+          
+          # Special characters are NOT allowed while posting transaction parameters on DirecPay system
+          def remove_special_characters(string)
+            string.gsub(/[~"'&#%]/, '-')
+          end
+          
+          def encode_value(value)
+            encoded = ActiveSupport::Base64.encode64s(value)
+            string_to_encode = encoded[0, 1] + "T" + encoded[1, encoded.length]
+            ActiveSupport::Base64.encode64s(string_to_encode)
+          end
+          
+          def decode_value(value)
+            decoded = ActiveSupport::Base64.decode64(value)
+            string_to_decode = decoded[0, 1] + decoded[2, decoded.length]
+            ActiveSupport::Base64.decode64(string_to_decode)
+          end
+          
+          def phone_code_for_country(country)
+            PHONE_CODES[country]
+          end
+        end
+      end
+    end
+  end
+end