authorizenet 1.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05a6564190f0053229964b6eb9420e268cb52840
+  data.tar.gz: d871b9c10bfb798c784b3b9242b5c230a5896ce3
+SHA512:
+  metadata.gz: abffcf5aca709932fc317311af410d21f3329b6b799dbaa0903c20a928c75ffb6f95ecea2b93a2482972ee96fd25975842f99b40d2270ec41aa12f980f6f1dfd
+  data.tar.gz: b4cfaf36863847afbb9ddfa0943bd8cf6e12e2562ee1314a375448e8c4e3e7f87740605d41f339b507a93b6cdca59f44c89f2e29f198dba1ba364158890fc6be

data/lib/app/helpers/authorize_net_helper.rb

@@ -0,0 +1,24 @@
+# The Authorize.Net Rails Helper module. Provides methods to assist with integrating the various APIs.
+
+module AuthorizeNetHelper
+  
+  # Generates a collection of hidden form fields (as a raw HTML string) for a AuthorizeNet::SIM::Transaction
+  # (sim_transaction). You can specify any html_options that hidden_field_tag accepts, and the
+  # hidden fields will be built with those options.
+  def sim_fields(sim_transaction, html_options = {})
+    fields = sim_transaction.form_fields.collect do |k, v|
+      if v.kind_of? Array
+        v.collect { |val| hidden_field_tag(k, val, html_options) }
+      else
+        hidden_field_tag(k, v, html_options)
+      end
+    end
+    fields.flatten!
+    field_str = fields.join("\n")
+    if field_str.respond_to?(:html_safe)
+      return field_str.html_safe
+    else
+      return field_str
+    end
+  end
+end

data/lib/authorize_net.rb

@@ -0,0 +1,92 @@
+# The SDK initialization enters here. Loads all needed libraries and files. Inspects
+# the current runtime to see if Rails is present. If it is, we inject our helper into
+# ActiveSupport.
+
+require "cgi"
+require "net/https"
+require "uri"
+require "openssl"
+require 'bigdecimal'
+require 'nokogiri'
+require 'date'
+
+# TODO: Add local data validation where possible
+
+$:.unshift File.dirname(__FILE__)
+
+require "authorize_net/authorize_net"
+require "authorize_net/payment_methods/credit_card"
+require "authorize_net/payment_methods/echeck"
+require "authorize_net/addresses/address"
+require "authorize_net/addresses/shipping_address"
+require "authorize_net/customer"
+require "authorize_net/email_receipt"
+require "authorize_net/order"
+require "authorize_net/line_item"
+require "authorize_net/cim/payment_profile"
+require "authorize_net/cim/customer_profile"
+require "authorize_net/reporting/batch"
+require "authorize_net/reporting/batch_statistics"
+require "authorize_net/reporting/transaction_details"
+require "authorize_net/reporting/fds_filter"
+require "authorize_net/response"
+require "authorize_net/key_value_response"
+require "authorize_net/xml_response"
+require "authorize_net/transaction"
+require "authorize_net/key_value_transaction"
+require "authorize_net/xml_transaction"
+require "authorize_net/fields"
+
+# AIM
+
+require "authorize_net/aim/transaction"
+require "authorize_net/aim/response"
+
+# SIM
+
+require "authorize_net/sim/hosted_payment_form"
+require "authorize_net/sim/hosted_receipt_page"
+require "authorize_net/sim/transaction"
+require "authorize_net/sim/response"
+
+# ARB
+
+require "authorize_net/arb/subscription"
+require "authorize_net/arb/response"
+require "authorize_net/arb/transaction"
+
+# CIM
+
+require "authorize_net/cim/response"
+require "authorize_net/cim/transaction"
+
+# Reporting
+
+require "authorize_net/reporting/response"
+require "authorize_net/reporting/transaction"
+
+# Load our Rails plugin
+
+if defined?(Rails)
+  if defined?(Rails::Railtie)
+    module AuthorizeNet
+      class Railtie < Rails::Railtie
+        initializer "authorize_net.load_path_initialize" do |app|
+          %w{ models controllers helpers }.each do |dir|
+            path = File.join(File.dirname(__FILE__), 'app', dir)
+            $LOAD_PATH << path
+            ActiveSupport::Dependencies.autoload_paths << path
+            ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+          end
+        end
+      end
+    end
+  else
+    %w{ models controllers helpers }.each do |dir|
+      path = File.join(File.dirname(__FILE__), 'app', dir)
+      $LOAD_PATH << path
+      ActiveSupport::Dependencies.load_paths << path
+      ActiveSupport::Dependencies.load_once_paths.delete(path)
+    end
+  end
+end

data/lib/authorize_net/addresses/address.rb

@@ -0,0 +1,29 @@
+module AuthorizeNet
+
+  # Models an address.
+  class Address
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :first_name, :last_name, :company, :street_address, :city, :state, :zip, :country, :phone, :fax, :customer_address_id
+    
+    def to_hash
+      hash = {
+        :first_name => @first_name,
+        :last_name => @last_name,
+        :company => @company,
+        :address => @street_address,
+        :city => @city,
+        :state => @state,
+        :zip => @zip,
+        :country => @country,
+        :phone => @phone,
+        :fax => @fax,
+        :customer_address_id => @customer_address_id
+      }
+      hash.delete_if {|k, v| v.nil?}
+    end
+    
+  end
+
+end

data/lib/authorize_net/addresses/shipping_address.rb

@@ -0,0 +1,26 @@
+module AuthorizeNet
+
+  # Models a shipping address.
+  class ShippingAddress < Address
+    
+    include AuthorizeNet::Model
+
+    def to_hash
+      hash = {
+        :ship_to_first_name => @first_name,
+        :ship_to_last_name => @last_name,
+        :ship_to_company => @company,
+        :ship_to_address => @street_address,
+        :ship_to_city => @city,
+        :ship_to_state => @state,
+        :ship_to_zip => @zip,
+        :ship_to_country => @country,
+        :ship_to_phone => @phone,
+        :ship_to_fax => @fax
+      }
+      hash.delete_if {|k, v| v.nil?}
+    end
+    
+  end
+
+end

data/lib/authorize_net/aim/response.rb

@@ -0,0 +1,131 @@
+module AuthorizeNet::AIM
+  
+  # The AIM response class. Handles parsing the response from the gateway.
+  class Response < AuthorizeNet::KeyValueResponse
+    
+    # Our MD5 digest generator.
+    @@digest = OpenSSL::Digest::Digest.new('md5')
+    
+    include AuthorizeNet::AIM::Fields
+    
+    # Fields to convert to/from booleans.     
+    @@boolean_fields = [:tax_exempt]
+    
+    # Fields to convert to/from BigDecimal.
+    @@decimal_fields = [:amount, :tax, :freight, :duty, :requested, :balance_on_card]
+    
+    
+    # Constructs a new response object from a +raw_response+ and the +transaction+ that generated
+    # the +raw_response+. You don't typically construct this object yourself, as AuthorizeNet::AIM::Transaction
+    # will build one for you when it makes the request to the gateway.
+    def initialize(raw_response, transaction)
+      @version = transaction.version
+      raise "AuthorizeNet gem only supports AIM version 3.1" unless @version.to_s == '3.1'
+      @raw_response = raw_response
+      @fields = {}
+      @transaction = transaction
+      custom_field_names = transaction.custom_fields.keys.collect(&:to_s).sort.collect(&:to_sym)
+      @custom_fields = {}
+      split_on = transaction.delimiter
+      if @raw_response.kind_of?(Net::HTTPOK) || @raw_response.kind_of?(Nokogiri::XML::Element)
+        if @raw_response.kind_of?(Net::HTTPOK)
+          raw_data = @raw_response.body 
+        else
+          raw_data = @raw_response.text
+        end
+        unless transaction.encapsulation_character.nil?
+          split_on = transaction.encapsulation_character + split_on + transaction.encapsulation_character
+          raw_data = raw_data[1..raw_data.length - 2]
+        end
+        raw_data.split(split_on).each_with_index  do |field, index|
+          if transaction.cp_version.nil?
+            field_desc = FIELDS
+          else
+            field_desc = CP_FIELDS
+          end
+          if index < field_desc.length
+            @fields[field_desc[index]] = field
+          else
+            @custom_fields[custom_field_names[index - field_desc.length]] = field
+          end
+        end
+        @fields.delete(nil)
+        @fields.each do |k, v|
+          if @@boolean_fields.include?(k)
+            @fields[k] = value_to_boolean(v)
+          elsif @@decimal_fields.include?(k)
+            @fields[k] = value_to_decimal(v)
+          end
+        end
+      end
+    end
+    
+    # Returns True if the MD5 hash found in the response payload validates using
+    # the supplied api_login and secret merchant_value (THIS IS NOT YOUR API KEY).
+    def valid_md5?(api_login, merchant_value)
+      if @fields[:md5_hash].nil?
+        return false
+      end
+      @@digest.hexdigest("#{merchant_value}#{api_login}#{@fields[:transaction_id]}#{@transaction.fields[:amount]}").downcase == @fields[:md5_hash].downcase
+    end
+    
+    # Returns the current API version that we are adhering to.
+    def version
+      @version
+    end
+    
+    # Check to see if the response indicated success. Success is defined as a 200 OK response indicating
+    # that the transaction was approved.
+    def success?
+      !connection_failure? && approved?
+    end
+    
+    # Returns true if we failed to open a connection to the gateway or got back a non-200 OK HTTP response.
+    def connection_failure?
+      !@raw_response.kind_of?(Net::HTTPOK) && !@raw_response.kind_of?(Nokogiri::XML::Element)
+    end
+    
+    # Returns the underlying Net::HTTPResponse object. This has the original response body along with
+    # headers and such. Note that if an exception is generated while making the request (which happens
+    # if there is no internet connection for example), you will get the exception object here instead of
+    # a Net::HTTPResponse object.
+    def raw
+      @raw_response
+    end
+    
+    # Returns the AuthorizeNet::Transaction instance that owns this response.
+    def transaction
+      @transaction
+    end
+    
+    # Returns the transaction's authorization code. This should be shown to the
+    # end user.
+    def authorization_code
+      @fields[:authorization_code]
+    end
+    
+    # Returns the transaction's authorization id. You will need this for future void, refund
+    # and prior authorization capture requests.
+    def transaction_id
+      @fields[:transaction_id]
+    end
+    
+    # Returns the customer id from the response.
+    def customer_id
+      @fields[:customer_id]
+    end
+    
+    # Returns a response code (from AVSResponseCode) indicating the result of any Address Verification
+    # Service checks. 
+    def avs_response
+      @fields[:avs_response]
+    end
+    
+    # Returns the credit card type used in the transaction. The values returned can be found in CardType.
+    def card_type
+      @fields[:card_type]
+    end
+    
+  end
+  
+end

data/lib/authorize_net/aim/transaction.rb

@@ -0,0 +1,184 @@
+module AuthorizeNet::AIM
+  
+  # The AIM transaction class. Handles building the transaction payload and
+  # transmitting it to the gateway.
+  class Transaction < AuthorizeNet::KeyValueTransaction
+    
+    # The default options for the constructor.
+    @@option_defaults = {
+      :transaction_type => Type::AUTHORIZE_AND_CAPTURE,
+      :gateway => :production,
+      :test => false,
+      :allow_split => false,
+      :delimiter => ',',
+      :encapsulation_character => nil,
+      :verify_ssl => false,
+      :device_type => DeviceType::UNKNOWN,
+      :market_type => MarketType::RETAIL
+    }
+    
+    # Fields to convert to/from booleans.
+    @@boolean_fields = [:tax_exempt, :test_request, :recurring_billing, :allow_partial_auth, :delim_data, :email_customer, :relay_response]
+    
+    # Fields to convert to/from BigDecimal.
+    @@decimal_fields = [:amount]
+    
+    # Constructs an AIM transaction. You can use the new AIM transaction object
+    # to issue a request to the payment gateway and parse the response into a new
+    # AuthorizeNet::AIM::Response object.
+    # 
+    # +api_login_id+:: Your API login ID, as a string.
+    # +api_transaction_key+:: Your API transaction key, as a string.
+    # +options+:: A hash of options. See below for values.
+    # 
+    # Options
+    # +transaction_type+:: The type of transaction to perform. Defaults to AuthorizeNet::Type::AUTHORIZE_AND_CAPTURE. This value is only used if run is called directly.
+    # +gateway+:: The gateway to submit the transaction to. Can be a URL string, an AuthorizeNet::AIM::Transaction::Gateway constant, or one of the convenience symbols :sandbox, :test, :card_present_test, :card_present_live, :card_present_sandbox, :card_present_production, :production, or :live (:test is an alias for :sandbox, :card_present_test is an alias for :card_present_sandbox, :card_present_production is an alias for :card_present_live, and :live is an alias for :production). 
+    # +test+:: A boolean indicating if the transaction should be run in test mode or not (defaults to false).
+    # +allow_split+:: A boolean indicating if split transactions should be allowed (defaults to false).
+    # +delimiter+:: A single character (as a string) that will be used to delimit the response from the gateway. Defaults to ','.
+    # +encapsulation_character+:: A single character (as a string) that will be used to encapsulate each field in the response from the gateway. Defaults to nil.
+    # +verify_ssl+:: A boolean indicating if the SSL certificate of the +gateway+ should be verified. Defaults to false.
+    # +device_type+:: A constant from DeviceType indicating the type of POS device used in a card present transaction. Defaults to DeviceType::UNKNOWN.
+    # +market_type+:: A constant from MarketType indicating your industry. Used for card present transactions. Defaults to MarketType::RETAIL.
+    #
+    def initialize(api_login_id, api_transaction_key, options = {})
+      super()
+      options = @@option_defaults.merge(options)
+      @api_login_id = api_login_id
+      @api_transaction_key = api_transaction_key
+      @test_mode = options[:test]
+      @response ||= nil
+      @delimiter = options[:delimiter]
+      @type = options[:transaction_type]
+      @cp_version = nil
+      case options[:gateway]
+      when :sandbox, :test
+        @gateway = Gateway::TEST
+      when :production, :live
+        @gateway = Gateway::LIVE
+      when :card_present_live, :card_present_production
+        @gateway = Gateway::CARD_PRESENT_LIVE
+        @cp_version = '1.0'
+      when :card_present_test, :card_present_sandbox
+        @gateway = Gateway::CARD_PRESENT_TEST
+        @cp_version = '1.0'
+      else
+        @gateway = options[:gateway]
+      end
+      @allow_split_transaction = options[:allow_split]
+      @encapsulation_character = options[:encapsulation_character]
+      @verify_ssl = options[:verify_ssl]
+      @market_type = options[:market_type]
+      @device_type = options[:device_type]
+    end
+    
+    # Checks if the transaction has been configured for test mode or not. Return TRUE if the
+    # transaction is a test transaction, FALSE otherwise. All transactions run against the sandbox
+    # are considered test transactions.
+    def test?
+      super || @gateway == Gateway::TEST
+    end
+    
+    # Returns TRUE if split transactions are allowed, FALSE otherwise.
+    def split_transaction_allowed?
+      !!@allow_split_transaction
+    end
+    
+    # Returns the current encapsulation character unless there is none, in which case Nil is returned.
+    def encapsulation_character
+      @encapsulation_character
+    end
+    
+    # Returns the gateway to be used for this transaction.
+    def gateway
+      @gateway
+    end
+    
+    # Checks to see if the transaction has a response (meaning it has been submitted to the gateway).
+    # Returns TRUE if a response is present, FALSE otherwise.
+    def has_response?
+      !@response.nil?
+    end
+    
+    # Retrieve the response object (or Nil if transaction hasn't been sent to the gateway).
+    def response
+      @response
+    end
+    
+    # Returns the current delimiter we are using to parse the fields returned by the
+    # gateway.
+    def delimiter
+      @delimiter
+    end
+    
+    # Sets the delimiter used to parse the response from the gateway.
+    def delimiter=(delimiter)
+      @delimiter = delimiter
+    end
+    
+    # Submits the transaction to the gateway for processing. Returns a response object. If the transaction
+    # has already been run, it will return nil.
+    def run
+      make_request
+    end
+    
+    # Returns the current card present API version that we are adhering to.
+    def cp_version
+      @cp_version
+    end
+    
+    #:enddoc:
+    protected
+    
+    # An internal method that builds the POST body, submits it to the gateway, and constructs a Response object with the response.
+    def make_request
+      if has_response?
+        return nil
+      end
+      url = URI.parse(@gateway)
+      fields = @fields.merge(:type => @type, :delim_char => @delimiter, :delim_data => "TRUE", :login => @api_login_id, :tran_key => @api_transaction_key, :relay_response => "FALSE")
+      
+      if @cp_version.nil?
+        fields.merge!(:version => @version)
+      else
+        fields.merge!(:cp_version => @cp_version, :market_type => @market_type, :device_type => @device_type, :response_format => "1")
+      end
+      fields[:test_request] = boolean_to_value(@test_mode)
+      fields[:allow_partial_auth] = 'TRUE' if @allow_split_transaction
+      fields[:encap_char] = @encapsulation_character unless @encapsulation_character.nil?
+      fields.each do |k, v|
+        if @@boolean_fields.include?(k)
+          fields[k] = boolean_to_value(v)
+        elsif @@decimal_fields.include?(k)
+          fields[k] = decimal_to_value(v)
+        end
+      end
+      data = fields.collect do |key, val|
+        self.to_param(key, val)
+      end
+      custom_field_keys = @custom_fields.keys.collect(&:to_s).sort.collect(&:to_sym)
+      for key in custom_field_keys
+        data += [self.to_param(key, @custom_fields[key.to_sym], '')]
+      end
+      data.flatten!
+      request = Net::HTTP::Post.new(url.path)
+      request.content_type = 'application/x-www-form-urlencoded'
+      request.body = data.join("&")
+      connection = Net::HTTP.new(url.host, url.port)
+      connection.use_ssl = true
+      if @verify_ssl
+        connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      else
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      begin
+        @response = AuthorizeNet::AIM::Response.new((connection.start {|http| http.request(request)}), self)
+      rescue
+        @response = AuthorizeNet::AIM::Response.new($!, self)
+      end
+    end
+    
+  end
+  
+end