RubyGems - authorize-net - Versions diffs - 1.5.2 - Mend

authorize-net 1.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

data/License.pdf +0 -0
data/README.rdoc +124 -0
data/Rakefile +74 -0
data/generators/authorize_net_direct_post/USAGE +20 -0
data/generators/authorize_net_direct_post/authorize_net_direct_post_generator.rb +21 -0
data/generators/authorize_net_direct_post/templates/README-AuthorizeNet +49 -0
data/generators/authorize_net_direct_post/templates/config.yml.erb +8 -0
data/generators/authorize_net_direct_post/templates/config.yml.rails3.erb +8 -0
data/generators/authorize_net_direct_post/templates/controller.rb.erb +31 -0
data/generators/authorize_net_direct_post/templates/initializer.rb +4 -0
data/generators/authorize_net_direct_post/templates/layout.erb +18 -0
data/generators/authorize_net_direct_post/templates/payment.erb +10 -0
data/generators/authorize_net_direct_post/templates/payment.rails3.erb +10 -0
data/generators/authorize_net_direct_post/templates/receipt.erb +1 -0
data/generators/authorize_net_direct_post/templates/relay_response.erb +1 -0
data/generators/authorize_net_sim/USAGE +20 -0
data/generators/authorize_net_sim/authorize_net_sim_generator.rb +19 -0
data/generators/authorize_net_sim/templates/README-AuthorizeNet +52 -0
data/generators/authorize_net_sim/templates/config.yml.erb +8 -0
data/generators/authorize_net_sim/templates/config.yml.rails3.erb +8 -0
data/generators/authorize_net_sim/templates/controller.rb.erb +21 -0
data/generators/authorize_net_sim/templates/initializer.rb +4 -0
data/generators/authorize_net_sim/templates/layout.erb +18 -0
data/generators/authorize_net_sim/templates/payment.erb +6 -0
data/generators/authorize_net_sim/templates/payment.rails3.erb +6 -0
data/generators/authorize_net_sim/templates/thank_you.erb +1 -0
data/generators/generator_extensions.rb +75 -0
data/init.rb +2 -0
data/install.rb +1 -0
data/lib/app/helpers/authorize_net_helper.rb +24 -0
data/lib/authorize-net.rb +4 -0
data/lib/authorize_net.rb +92 -0
data/lib/authorize_net/addresses/address.rb +29 -0
data/lib/authorize_net/addresses/shipping_address.rb +26 -0
data/lib/authorize_net/aim/response.rb +131 -0
data/lib/authorize_net/aim/transaction.rb +184 -0
data/lib/authorize_net/arb/response.rb +34 -0
data/lib/authorize_net/arb/subscription.rb +72 -0
data/lib/authorize_net/arb/transaction.rb +146 -0
data/lib/authorize_net/authorize_net.rb +154 -0
data/lib/authorize_net/cim/customer_profile.rb +19 -0
data/lib/authorize_net/cim/payment_profile.rb +37 -0
data/lib/authorize_net/cim/response.rb +110 -0
data/lib/authorize_net/cim/transaction.rb +678 -0
data/lib/authorize_net/customer.rb +27 -0
data/lib/authorize_net/email_receipt.rb +24 -0
data/lib/authorize_net/fields.rb +736 -0
data/lib/authorize_net/key_value_response.rb +117 -0
data/lib/authorize_net/key_value_transaction.rb +291 -0
data/lib/authorize_net/line_item.rb +25 -0
data/lib/authorize_net/order.rb +42 -0
data/lib/authorize_net/payment_methods/credit_card.rb +74 -0
data/lib/authorize_net/payment_methods/echeck.rb +72 -0
data/lib/authorize_net/reporting/batch.rb +19 -0
data/lib/authorize_net/reporting/batch_statistics.rb +19 -0
data/lib/authorize_net/reporting/fds_filter.rb +11 -0
data/lib/authorize_net/reporting/response.rb +127 -0
data/lib/authorize_net/reporting/transaction.rb +116 -0
data/lib/authorize_net/reporting/transaction_details.rb +25 -0
data/lib/authorize_net/response.rb +27 -0
data/lib/authorize_net/sim/hosted_payment_form.rb +38 -0
data/lib/authorize_net/sim/hosted_receipt_page.rb +37 -0
data/lib/authorize_net/sim/response.rb +142 -0
data/lib/authorize_net/sim/transaction.rb +138 -0
data/lib/authorize_net/transaction.rb +66 -0
data/lib/authorize_net/xml_response.rb +172 -0
data/lib/authorize_net/xml_transaction.rb +275 -0
data/lib/generators/authorize_net/direct_post_generator.rb +51 -0
data/lib/generators/authorize_net/sim_generator.rb +47 -0
data/spec/aim_spec.rb +310 -0
data/spec/arb_spec.rb +191 -0
data/spec/authorize_net_spec.rb +200 -0
data/spec/cim_spec.rb +450 -0
data/spec/reporting_spec.rb +431 -0
data/spec/sim_spec.rb +97 -0
data/spec/spec.opts +5 -0
data/spec/spec_helper.rb +2 -0
data/uninstall.rb +1 -0
metadata +223 -0

data/generators/authorize_net_sim/templates/config.yml.erb ADDED

@@ -0,0 +1,8 @@
+default:
+  api_login_id: <%= args[0] %>
+  api_transaction_key: <%= args[1] %>
+  merchant_hash_value: <%= args[2] %>
+development:
+test:
+production:

data/generators/authorize_net_sim/templates/config.yml.rails3.erb ADDED

@@ -0,0 +1,8 @@
+default:
+  api_login_id: <%= self.api_login_id %>
+  api_transaction_key: <%= self.api_transaction_key %>
+  merchant_hash_value: <%= self.merchant_hash_value %>
+development:
+test:
+production:

data/generators/authorize_net_sim/templates/controller.rb.erb ADDED

@@ -0,0 +1,21 @@
+class <%= class_name %>Controller < ApplicationController
+  layout 'authorize_net'
+  helper :authorize_net
+  protect_from_forgery :except => :relay_response
+  # GET
+  # Displays a payment form.
+  def payment
+    @amount = 10.00
+    @sim_transaction = AuthorizeNet::SIM::Transaction.new(AUTHORIZE_NET_CONFIG['api_login_id'], AUTHORIZE_NET_CONFIG['api_transaction_key'], @amount, :hosted_payment_form => true)
+    @sim_transaction.set_hosted_payment_receipt(AuthorizeNet::SIM::HostedReceiptPage.new(:link_method => AuthorizeNet::SIM::HostedReceiptPage::LinkMethod::GET, :link_text => 'Continue', :link_url => <%= singular_name %>_thank_you_url(:only_path => false)))
+  end
+  # GET
+  # Displays a thank you page.
+  def thank_you
+    @auth_code = params[:x_auth_code]
+  end
+end

data/generators/authorize_net_sim/templates/initializer.rb ADDED

@@ -0,0 +1,4 @@
+yml = YAML.load_file("#{RAILS_ROOT}/config/authorize_net.yml")
+AUTHORIZE_NET_CONFIG = yml['default']
+AUTHORIZE_NET_CONFIG.merge!(yml[RAILS_ENV]) unless yml[RAILS_ENV].nil?
+AUTHORIZE_NET_CONFIG.freeze

data/generators/authorize_net_sim/templates/layout.erb ADDED

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>SIM Sample App</title>
+    <style>
+    body {
+      text-align: center;
+      font-family: Helvetica;
+    }
+    label {
+      display: block;
+    }
+    </style>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/generators/authorize_net_sim/templates/payment.erb ADDED

@@ -0,0 +1,6 @@
+<% form_for :sim_transaction, :url => AuthorizeNet::SIM::Transaction::Gateway::TEST do |f| %>
+  <%= sim_fields(@sim_transaction) %>
+  <%= label_tag 'x_amount', "Total: #{number_to_currency(@amount)}" %>
+  <br />
+  <%= f.submit 'Purchase'%>
+<% end %>

data/generators/authorize_net_sim/templates/payment.rails3.erb ADDED

@@ -0,0 +1,6 @@
+<%= form_for :sim_transaction, :url => AuthorizeNet::SIM::Transaction::Gateway::TEST do |f| %>
+  <%= sim_fields(@sim_transaction) %>
+  <%= label_tag 'x_amount', "Total: #{number_to_currency(@amount)}" %>
+  <br />
+  <%= f.submit 'Purchase'%>
+<% end %>

data/generators/authorize_net_sim/templates/thank_you.erb ADDED

	@@ -0,0 +1 @@
1	+ Thanks for your purchase! Your authorization code is <%=h @auth_code %>.

data/generators/generator_extensions.rb ADDED

@@ -0,0 +1,75 @@
+# Extends the Rails::Generator::Commands classes to add support for route and gem configuration generation.
+module Rails
+  module Generator
+    module Commands
+      class Base
+        def route_code(route_options)
+          route_options[:path] = route_options[:name] unless route_options.has_key? :path
+          code = "map.#{route_options[:name]} '#{route_options[:path]}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+          code += ", :conditions => #{route_options[:conditions]}" if route_options.has_key? :conditions
+        end
+        def gsub_file_check(relative_destination, regexp, *args, &block)
+          path = destination_path(relative_destination)
+          content = File.read(path)
+          !(content =~ regexp).nil?
+        end
+        def gem_code(gem_options)
+          gem_options[:lib] = gem_options[:name] unless gem_options.has_key? :lib
+          code = "config.gem '#{gem_options[:name]}', :lib => '#{gem_options[:lib]}'"
+        end
+      end
+# Here's a readable version of the long string used above in route_code;
+# but it should be kept on one line to avoid inserting extra whitespace
+# into routes.rb when the generator is run:
+# "map.#{route_options[:name]} '#{route_options[:name]}',
+#     :controller => '#{route_options[:controller]}',
+#     :action => '#{route_options[:action]}'"
+      class Create
+        def route(route_options)
+          sentinel = 'ActionController::Routing::Routes.draw do |map|'
+          unless gsub_file_check 'config/routes.rb', /(#{Regexp.escape(route_code(route_options))})/mi
+            logger.route route_code(route_options)
+            gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |m|
+                "#{m}\n  #{route_code(route_options)}"
+            end
+          else
+            logger.identical route_code(route_options)
+          end
+        end
+        def gem(gem_options)
+          sentinel = 'Rails::Initializer.run do |config|'
+          unless gsub_file_check 'config/environment.rb', /(#{Regexp.escape(gem_code(gem_options))})/mi
+            logger.gem gem_code(gem_options)
+            gsub_file 'config/environment.rb', /(#{Regexp.escape(sentinel)})/mi do |m|
+                "#{m}\n  #{gem_code(gem_options)}"
+            end
+          else
+            logger.identical gem_code(gem_options)
+          end
+        end
+      end
+      class Destroy
+        def route(route_options)
+          logger.remove_route route_code(route_options)
+          to_remove = "\n  #{Regexp.escape(route_code(route_options))}"
+          gsub_file 'config/routes.rb', /(#{to_remove})/mi, ''
+        end
+        def gem(gem_options)
+          logger.remove_gem gem_code(gem_options)
+          to_remove = "\n  #{Regexp.escape(gem_code(gem_options))}"
+          gsub_file 'config/environment.rb', /(#{to_remove})/mi, ''
+        end
+      end
+    end
+  end
+end

data/init.rb ADDED

	@@ -0,0 +1,2 @@
1	+ # Include hook code here
2	+ require 'authorize_net'

data/install.rb ADDED

	@@ -0,0 +1 @@
1	+ # Install hook code here

data/lib/app/helpers/authorize_net_helper.rb ADDED

@@ -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 ADDED

@@ -0,0 +1,4 @@
+# This file is just here to avoid obnoxious gem name/require name issues. All this
+# file does is require authorize_net.rb, the real initialization file.
+require 'authorize_net'

data/lib/authorize_net.rb ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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 ADDED

@@ -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