jelaniharris-activemerchant 1.24.1

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

@@ -0,0 +1,280 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class WorldpayGateway < Gateway
+      TEST_URL = 'https://secure-test.wp3.rbsworldpay.com/jsp/merchant/xml/paymentService.jsp'
+      LIVE_URL = 'https://secure.wp3.rbsworldpay.com/jsp/merchant/xml/paymentService.jsp'
+
+      self.default_currency = 'GBP'
+      self.money_format = :cents
+      self.supported_countries = ['HK', 'US', 'GB', 'AU']
+      self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :maestro]
+      self.homepage_url = 'http://www.worldpay.com/'
+      self.display_name = 'WorldPay'
+
+      CARD_CODES = {
+        'visa'             => 'VISA-SSL',
+        'master'           => 'ECMC-SSL',
+        'discover'         => 'DISCOVER-SSL',
+        'american_express' => 'AMEX-SSL',
+      }
+
+      def initialize(options = {})
+        requires!(options, :login, :password)
+        @options = options
+        super
+      end
+
+      def purchase(money, payment_method, options = {})
+        response = MultiResponse.new
+        response << authorize(money, payment_method, options)
+        response << capture(money, response.authorization, options.merge(:authorization_validated => true)) if response.success?
+        response
+      end
+
+      def authorize(money, payment_method, options = {})
+        requires!(options, :order_id)
+        commit 'authorize', build_authorization_request(money, payment_method, options)
+      end
+
+      def capture(money, authorization, options = {})
+        response = MultiResponse.new
+        response << inquire(authorization, options) unless options[:authorization_validated]
+        response << commit('capture', build_capture_request(money, authorization, options)) if response.success?
+        response
+      end
+
+      def void(authorization, options = {})
+        response = MultiResponse.new
+        response << inquire(authorization, options)
+        response << commit('cancel', build_void_request(authorization, options)) if response.success?
+        response        
+      end
+
+      def refund(money, authorization, options = {})
+        response = MultiResponse.new
+        response << inquire(authorization, options)
+        response << commit('refund', build_refund_request(money, authorization, options)) if response.success?
+        response        
+      end
+
+      private
+
+      def inquire(authorization, options={})
+        commit 'inquiry', build_order_inquiry_request(authorization, options)
+      end
+
+      def build_request
+        xml = Builder::XmlMarkup.new :indent => 2
+        xml.instruct!
+        xml.declare! :DOCTYPE, :paymentService, :PUBLIC, "-//WorldPay//DTD WorldPay PaymentService v1//EN", "http://dtd.wp3.rbsworldpay.com/paymentService_v1.dtd"
+        xml.tag! 'paymentService', 'version' => "1.4", 'merchantCode' => @options[:login] do
+          yield xml
+        end
+        xml.target!
+      end
+
+      def build_order_modify_request(authorization)
+        build_request do |xml|
+          xml.tag! 'modify' do
+            xml.tag! 'orderModification', 'orderCode' => authorization do
+              yield xml
+            end
+          end
+        end
+      end
+
+      def build_order_inquiry_request(authorization, options)
+        build_request do |xml|
+          xml.tag! 'inquiry' do
+            xml.tag! 'orderInquiry', 'orderCode' => authorization
+          end
+        end
+      end
+
+      def build_authorization_request(money, payment_method, options)
+        build_request do |xml|
+          xml.tag! 'submit' do
+            xml.tag! 'order', {'orderCode' => options[:order_id], 'installationId' => @options[:inst_id]}.reject{|_,v| !v} do
+              xml.description(options[:description].blank? ? "Purchase" : options[:description])
+              add_amount(xml, money, options)
+              if options[:order_content]
+                xml.tag! 'orderContent' do
+                  xml.cdata! options[:order_content]
+                end
+              end
+              add_payment_method(xml, money, payment_method, options)
+            end
+          end
+        end
+      end
+
+      def build_capture_request(money, authorization, options)
+        build_order_modify_request(authorization) do |xml|
+          xml.tag! 'capture' do
+            time = Time.now
+            xml.tag! 'date', 'dayOfMonth' => time.day, 'month' => time.month, 'year'=> time.year
+            add_amount(xml, money, options)
+          end
+        end
+      end
+
+      def build_void_request(authorization, options)
+        build_order_modify_request(authorization) do |xml|
+          xml.tag! 'cancel'
+        end
+      end
+
+      def build_refund_request(money, authorization, options)
+        build_order_modify_request(authorization) do |xml|
+          xml.tag! 'refund' do
+            add_amount(xml, money, options)
+          end
+        end
+      end
+
+      def add_amount(xml, money, options)
+        xml.tag! 'amount',
+          :value => amount(money),
+          'currencyCode' => (options[:currency] || currency(money)),
+          'exponent' => 2
+      end
+
+      def add_payment_method(xml, amount, payment_method, options)
+        if payment_method.is_a?(String)
+          xml.tag! 'payAsOrder', 'orderCode' => payment_method do
+            add_amount(xml, amount, options)
+          end
+        else
+          xml.tag! 'paymentDetails' do
+            xml.tag! CARD_CODES[card_brand(payment_method)] do
+              xml.tag! 'cardNumber', payment_method.number
+              xml.tag! 'expiryDate' do
+                xml.tag! 'date', 'month' => format(payment_method.month, :two_digits), 'year' => format(payment_method.year, :four_digits)
+              end
+
+              xml.tag! 'cardHolderName', payment_method.name
+              xml.tag! 'cvc', payment_method.verification_value
+
+              add_address(xml, 'cardAddress', (options[:billing_address] || options[:address]))
+            end
+          end
+        end
+      end
+
+      def add_address(xml, element, address)
+        return if address.nil?
+
+        xml.tag! element do
+          xml.tag! 'address' do
+            if m = /^\s*([^\s]+)\s+(.+)$/.match(address[:name])
+              xml.tag! 'firstName', m[1]
+              xml.tag! 'lastName', m[2]
+            end
+            if m = /^\s*(\d+)\s+(.+)$/.match(address[:address1])
+              xml.tag! 'street', m[2]
+              house_number = m[1]
+            else
+              xml.tag! 'street', address[:address1]
+            end
+            xml.tag! 'houseName', address[:address2] if address[:address2]
+            xml.tag! 'houseNumber', house_number if house_number.present?
+            xml.tag! 'postalCode', (address[:zip].present? ? address[:zip] : "0000")
+            xml.tag! 'city', address[:city] if address[:city]
+            xml.tag! 'state', (address[:state].present? ? address[:state] : 'N/A')
+            xml.tag! 'countryCode', address[:country]
+            xml.tag! 'telephoneNumber', address[:phone] if address[:phone]
+          end
+        end
+      end
+
+      def parse(action, xml)
+        parse_element({:action => action}, REXML::Document.new(xml))
+      end
+
+      def parse_element(raw, node)
+        node.attributes.each do |k, v|
+          raw["#{node.name.underscore}_#{k.underscore}".to_sym] = v
+        end
+        if node.has_elements?
+          raw[node.name.underscore.to_sym] = true unless node.name.blank?
+          node.elements.each{|e| parse_element(raw, e) }
+        else
+          raw[node.name.underscore.to_sym] = node.text unless node.text.nil?
+        end
+        raw
+      end
+
+      def commit(action, request)
+        xmr = ssl_post((test? ? TEST_URL : LIVE_URL),
+          request,
+          'Content-Type' => 'text/xml',
+          'Authorization' => encoded_credentials)
+
+        raw = parse(action, xmr)
+
+        Response.new(
+          success_from(raw),
+          message_from(raw),
+          raw,
+          :authorization => authorization_from(raw),
+          :test => test?)
+
+      rescue ActiveMerchant::ResponseError => e
+        if e.response.code.to_s == "401"
+          return Response.new(false, "Invalid credentials", {}, :test => test?)
+        else
+          raise e
+        end
+      end
+
+      def success_from(raw)
+        (raw[:last_event] == "AUTHORISED" ||
+          raw[:ok].present?)
+      end
+
+      def message_from(raw)
+        (raw[:iso8583_return_code_description] ||
+          raw[:error] ||
+          "SUCCESS")
+      end
+
+      def authorization_from(raw)
+        pair = raw.detect{|k,v| k.to_s =~ /_order_code$/}
+        (pair ? pair.last : nil)
+      end
+
+      def encoded_credentials
+        credentials = "#{@options[:login]}:#{@options[:password]}"
+        "Basic #{[credentials].pack('m').strip}"
+      end
+
+      class MultiResponse < Response
+        attr_reader :responses
+
+        def initialize
+          @responses = []
+        end
+
+        def <<(response)
+          if response.is_a?(MultiResponse)
+            response.responses.each{|r| @responses << r}
+          else
+            @responses << response
+          end
+        end
+
+        def success?
+          @responses.all?{|r| r.success?}
+        end
+
+        %w(params message test authorization avs_result cvv_result test? fraud_review?).each do |m|
+          class_eval %(
+            def #{m}
+              @responses.last.#{m}
+            end
+          )
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations.rb

@@ -0,0 +1,17 @@
+module ActiveMerchant
+  module Billing
+    module Integrations        
+    
+      Dir[File.dirname(__FILE__) + '/integrations/*.rb'].each do |f|      
+      
+        # Get camelized class name 
+        filename = File.basename(f, '.rb')
+        # Camelize the string to get the class name
+        gateway_class = filename.camelize.to_sym
+              
+        # Register for autoloading
+        autoload gateway_class, f      
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+require '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 => 'cody@example.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(options.delete(:service).to_s.camelize)
+
+          result = []
+          result << form_tag(integration_module.service_url, options.delete(:html) || {})
+          
+          service_class = integration_module.const_get('Helper')
+          service = service_class.new(order, account, options)
+
+          result << capture(service, &proc)
+
+          service.form_fields.each do |field, value|
+            result << hidden_field_tag(field, value)
+          end
+          
+          service.raw_html_fields.each do |field, value|
+            result << "<input id=\"#{field}\" name=\"#{field}\" type=\"hidden\" value=\"#{value}\" />\n"
+          end
+          
+          result << '</form>'
+          result= result.join("\n")
+          
+          concat(result.respond_to?(:html_safe) ? result.html_safe : result)
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module AuthorizeNetSim 
+        autoload :Helper, 'active_merchant/billing/integrations/authorize_net_sim/helper.rb'
+        autoload :Notification, 'active_merchant/billing/integrations/authorize_net_sim/notification.rb'
+
+        # Overwrite this if you want to change the ANS test url
+        mattr_accessor :test_url
+        self.test_url = 'https://test.authorize.net/gateway/transact.dll'
+        
+        # Overwrite this if you want to change the ANS production url
+        mattr_accessor :production_url 
+        self.production_url = 'https://secure.authorize.net/gateway/transact.dll' 
+        
+        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/authorize_net_sim/helper.rb

@@ -0,0 +1,228 @@
+require 'active_support/core_ext/float/rounding.rb' # Float#round(precision)
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module AuthorizeNetSim
+        # An example. Note the username as a parameter and transaction key you
+        # will want to use later. The amount that you pass in will be *rounded*,
+        # so preferably pass in X.2 decimal so that no rounding occurs. It is
+        # rounded because if it looks like 00.000 Authorize.Net fails the
+        # transaction as incorrectly formatted.
+        # 
+        #  payment_service_for('order_id', 'authorize_net_account', :service => :authorize_net_sim,  :amount => 157.0) do |service|
+        # 
+        #    # You must call setup_hash and invoice
+        #    
+        #    service.setup_hash :transaction_key => '8CP6zJ7uD875J6tY',
+        #        :order_timestamp => 1206836763
+        #    service.customer_id 8
+        #    service.customer :first_name => 'g',
+        #                       :last_name => 'g',
+        #                       :email => 'g@g.com',
+        #                       :phone => '3'
+        #   service.billing_address :zip => 'g',
+        #                   :country => 'United States of America',
+        #                   :address => 'g'
+        # 
+        #   service.ship_to_address :first_name => 'g',
+        #                            :last_name => 'g',
+        #                            :city => '',
+        #                            :address => 'g',
+        #                            :address2 => '',
+        #                            :state => address.state,
+        #                            :country => 'United States of America',
+        #                            :zip => 'g'
+        # 
+        #   service.invoice "516428355" # your invoice number
+        #   # The end-user is presented with the HTML produced by the notify_url.
+        #   service.notify_url "http://t/authorize_net_sim/payment_received_notification_sub_step"
+        #   service.payment_header 'My store name'
+        #   service.add_line_item :name => 'item name', :quantity => 1, :unit_price => 0
+        #   service.test_request 'true' # only if it's just a test
+        #   service.shipping '25.0'
+        #   # Tell it to display a "0" line item for shipping, with the price in
+        #   # the name, otherwise it isn't shown at all, leaving the end user to
+        #   # wonder why the total is different than the sum of the line items.
+        #   service.add_shipping_as_line_item
+        #   server.add_tax_as_line_item # same with tax
+        #   # See the helper.rb file for various custom fields
+        # end
+         
+        class Helper < ActiveMerchant::Billing::Integrations::Helper           
+          mapping :order, 'x_fp_sequence'
+          mapping :account, 'x_login'
+          
+          mapping :customer, :first_name => 'x_first_name',
+                             :last_name  => 'x_last_name',
+                             :email      => 'x_email',
+                             :phone      => 'x_phone'
+                            
+          mapping :notify_url, 'x_relay_url'
+          mapping :return_url, '' # unused
+          mapping :cancel_return_url, '' # unused
+          
+          # Custom fields for Authorize.net SIM.
+          # See http://www.Authorize.Net/support/SIM_guide.pdf for more descriptions.
+          mapping :fax, 'x_fax'
+          mapping :customer_id, 'x_cust_id'
+          mapping :description, 'x_description'
+          mapping :tax, 'x_tax'
+          mapping :shipping, 'x_freight'
+          
+          # True or false, or 0 or 1 same effect [not required to send one,
+          # defaults to false].
+          mapping :test_request, 'x_test_request'
+          
+          # This one is necessary for the notify url to be able to parse its
+          # information later! They also pass back customer id, if that's
+          # useful.
+          def invoice(number)
+            add_field 'x_invoice_num', number
+          end
+          
+          # Set the billing address. Call like service.billing_address {:city =>
+          # 'provo, :state => 'UT'}...
+          def billing_address(options)
+            for setting in [:city, :state, :zip, :country, :po_num] do
+              add_field 'x_' + setting.to_s, options[setting]
+            end
+            raise 'must use address1 and address2' if options[:address]
+            add_field 'x_address', (options[:address1].to_s + ' ' + options[:address2].to_s).strip
+          end
+          
+          # Adds a custom field which you submit to Authorize.Net. These fields
+          # are all passed back to you verbatim when it does its relay
+          # (callback) to you note that if you call it twice with the same name,
+          # this function only uses keeps the second value you called it with.          
+          def add_custom_field(name, value)
+            add_field name, value
+          end
+          
+          # Displays tax as a line item, so they can see it. Otherwise it isn't
+          # displayed.
+          def add_tax_as_line_item
+            raise unless @fields['x_tax']
+            add_line_item :name => 'Total Tax', :quantity => 1, :unit_price => @fields['x_tax'], :tax => 0, :line_title => 'Tax'
+          end
+          
+          # Displays shipping as a line item, so they can see it. Otherwise it
+          # isn't displayed.
+          def add_shipping_as_line_item(extra_options = {})
+            raise 'must set shipping/freight before calling this' unless @fields['x_freight']
+            add_line_item extra_options.merge({:name => 'Shipping and Handling Cost', :quantity => 1, :unit_price => @fields['x_freight'], :line_title => 'Shipping'})
+          end
+          
+          # Add ship_to_address in the same format as the normal address is
+          # added.
+          def ship_to_address(options)
+            for setting in [:first_name, :last_name, :company, :city, :state, :zip, :country] do
+              if options[setting] then
+                add_field 'x_ship_to_' + setting.to_s, options[setting]
+              end
+            end
+            raise 'must use :address1 and/or :address2' if options[:address]
+            add_field 'x_ship_to_address', (options[:address1].to_s + ' ' + options[:address2].to_s).strip
+          end
+          
+          # These control the look of the SIM payment page. Note that you can
+          # include a CSS header in descriptors, etc.
+          mapping :color_link, 'x_color_link'
+          mapping :color_text, 'x_color_text'
+          mapping :logo_url, 'x_logo_url'
+          mapping :background_url, 'x_background_url' # background image url for the page
+          mapping :payment_header, 'x_header_html_payment_form'
+          mapping :payment_footer, 'x_footer_html_payment_form'
+          
+          # For this to work you must have also passed in an email for the
+          # purchaser.
+          def yes_email_customer_from_authorizes_side
+            add_field 'x_email_customer', 'TRUE'
+          end
+
+          # Add a line item to Authorize.Net.
+          # Call line add_line_item {:name => 'orange', :unit_price => 30, :tax_value => 'Y', :quantity => 3, }
+          # Note you can't pass in a negative unit price, and you can add an
+          # optional :line_title => 'special name' if you don't want it to say
+          # 'Item 1' or what not, the default coded here.
+          # Cannot have a negative price, nor a name with "'s or $
+          # You can use the :line_title for the product name and then :name for description, if desired
+          def add_line_item(options)
+            raise 'needs name' unless options[:name]
+            
+            if @line_item_count == 30
+              # Add a note that we are not showing at least one -- AN doesn't
+              # display more than 30 or so.
+              description_of_last = @raw_html_fields[-1][1]
+              # Pull off the second to last section, which is the description.
+              description_of_last =~ />([^>]*)<\|>[YN]$/
+              # Create a new description, which can't be too big, so truncate here.
+              @raw_html_fields[-1][1] = description_of_last.gsub($1, $1[0..200] + ' + more unshown items after this one.')
+            end
+            
+            name = options[:name]
+            quantity = options[:quantity] || 1
+            line_title = options[:line_title] || ('Item ' + (@line_item_count + 1).to_s) # left most field
+            unit_price = options[:unit_price] || 0
+            unit_price = unit_price.to_f.round(2)
+            tax_value = options[:tax_value] || 'N'
+            
+            # Sanitization, in case they include a reserved word here, following
+            # their guidelines; unfortunately, they require 'raw' fields here,
+            # not CGI escaped, using their own delimiters.
+            # 
+            # Authorize.net ignores the second field (sanitized_short_name)
+            raise 'illegal char for line item <|>' if name.include? '<|>'
+            raise 'illegal char for line item "' if name.include? '"'
+            raise 'cannot pass in dollar sign' if unit_price.to_s.include? '$'
+            raise 'must have positive or 0 unit price' if unit_price.to_f < 0
+            # Using CGI::escape causes the output to be formated incorrectly in
+            # the HTML presented to the end-user's browser (e.g., spaces turn
+            # into +'s).
+            sanitized_short_name = name[0..30]
+            name = name[0..255]            
+
+            add_raw_html_field "x_line_item", "#{line_title}<|>#{sanitized_short_name}<|>#{name}<|>#{quantity}<|>#{unit_price}<|>#{tax_value}"
+
+            @line_item_count += 1
+          end
+            
+          # If you call this it will e-mail to this address a copy of a receipt
+          # after successful, from Authorize.Net.
+          def email_merchant_from_authorizes_side(to_this_email)
+            add_field 'x_email_merchant', to_this_email
+          end
+          
+          # You MUST call this at some point for it to actually work. Options
+          # must include :transaction_key and :order_timestamp
+          def setup_hash(options)
+            raise unless options[:transaction_key]
+            raise unless options[:order_timestamp]
+            amount = @fields['x_amount']
+            data = "#{@fields['x_login']}^#{@fields['x_fp_sequence']}^#{options[:order_timestamp].to_i}^#{amount}^#{@fields['x_currency_code']}"
+            hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest::Digest.new('md5'), options[:transaction_key], data)
+            add_field 'x_fp_hash', hmac
+            add_field 'x_fp_timestamp', options[:order_timestamp].to_i
+          end
+          
+          # Note that you should call #invoice and #setup_hash as well, for the
+          # response_url to actually work.
+          def initialize(order, account, options = {})
+            super
+            raise 'missing parameter' unless order and account and options[:amount]
+            raise 'error -- amount with no digits!' unless options[:amount].to_s =~ /\d/
+            add_field('x_type', 'AUTH_CAPTURE') # the only one we deal with, for now.  Not refunds or anything else, currently.
+            add_field 'x_show_form', 'PAYMENT_FORM'
+            add_field 'x_relay_response', 'TRUE'
+            add_field 'x_duplicate_window', '28800' # large default duplicate window.
+            add_field 'x_currency_code', currency_code
+          	add_field 'x_version' , '3.1' # version from doc
+            add_field 'x_amount', options[:amount].to_f.round(2)
+          	@line_item_count = 0
+          end
+
+        end
+      end
+    end
+  end
+end