authorizenet 1.8.1 → 1.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cff60bfbd16f4de9a46d9b4e34193cd3480dcd7
-  data.tar.gz: 2c4fd6d232a0cc895bfa8264b418c3325ad5a4b8
+  metadata.gz: ff5759dc180906c1a4e49eaa3806666c21e97d80
+  data.tar.gz: 8f68a83f8feb9df35fbbf41c5802666c3a0dd451
 SHA512:
-  metadata.gz: 5f01e13e78ba4ded7e83e6fd1cc981357adb5510333d97b2a40e9ef805d95c2935738d44604fa9fe3bf1f84a5594ef467c9ad6b2641c96730eb7c3aa7141c398
-  data.tar.gz: 538b6a17b2a6d198bfe572f995666a8a5539c9c97b4e2793af5408664c845915c33cc617b4c03cc3e33bd89757314b63233eb77862741102f5f35f55d161790d
+  metadata.gz: 0ff763839bf9cc2f6fda6f0a4ac93e86ed93c6d9774af353d8f79a9a398f8a20e2894ad928c16b5810f6f10ebbf8775bbaca08fce87c06f0a346107849dccb65
+  data.tar.gz: 5bdf56b8ffa4586f9a93d964147d167b9e644a1b9eb57948184713d9f91ee6c83612180c35f3e8064a7fa89d8341e1539746fae527fdffad85097d18acb60201

data/lib/authorize_net.rb

@@ -52,6 +52,11 @@ require "authorize_net/sim/response"
 
 # ARB
 
+require "authorize_net/arb/paging"
+require "authorize_net/arb/sorting"
+require "authorize_net/arb/subscription_list_response"
+require "authorize_net/arb/subscription_detail"
+require "authorize_net/arb/fields"
 require "authorize_net/arb/subscription"
 require "authorize_net/arb/response"
 require "authorize_net/arb/transaction"

data/lib/authorize_net.rb~

@@ -0,0 +1,95 @@
+# 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/reporting/returned_item"
+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_detail"
+require "authorize_net/arb/fields"
+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/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.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/arb/fields.rb

@@ -0,0 +1,24 @@
+module AuthorizeNet::ARB
+    module Fields
+      EntityDescription = Struct.new(:node_structure, :entity_class, :arg_mapping)
+
+      SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION = EntityDescription.new(
+        [
+          {:id => :id},
+          {:name => :name},
+          {:status => :status},
+	  {:createTimeStampUTC => :create_time_stamp_utc},
+	  {:firstName => :first_name},
+	  {:lastName => :last_name},
+	  {:totalOccurrences => :total_occurrences},
+	  {:pastOccurrences => :past_occurrences},
+	  {:paymentMethod => :payment_method},
+	  {:accountNumber => :account_number},
+	  {:invoice => :invoice},
+	  {:amount => :amount},
+          {:currencyId => :currency_id}
+        ],
+        AuthorizeNet::ARB::SubscriptionDetail
+      )
+    end
+end

data/lib/authorize_net/arb/fields.rb~

@@ -0,0 +1,13 @@
+module AuthorizeNet::ARB
+    module Fields
+      EntityDescription = Struct.new(:node_structure, :entity_class, :arg_mapping)
+
+      SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION = EntityDescription.new(
+        [
+          {:id => :id},
+          {:name => :name}
+        ],
+        AuthorizeNet::ARB::SubscriptionDetail
+      )
+    end
+end

data/lib/authorize_net/arb/paging.rb

@@ -0,0 +1,33 @@
+module AuthorizeNet::ARB
+
+  class Paging
+
+    # Models Paging
+    include AuthorizeNet::Model
+    
+    attr_accessor :offset,:limit
+
+    # Initializes Paging object. 
+    #
+    # Typical usage:
+    #  paging = AuthorizeNet::ARB::Paging.new(1,1000)
+    #
+    # Valid values for offset: 1 to 100000
+    # Valid values for limit: 1 to 1000
+    #
+    def initialize(offset,limit)
+      @offset = offset
+      @limit = limit
+    end
+
+    def to_hash
+      hash = {
+        :offset => @offset,
+        :limit => @limit
+      }
+      hash.delete_if {|k, v| v.nil?}
+    end
+      
+  end
+
+end

data/lib/authorize_net/arb/paging.rb~

@@ -0,0 +1,25 @@
+module AuthorizeNet::ARB
+
+  class Paging
+
+    # Models Paging
+    include AuthorizeNet::Model
+    
+    attr_accessor :offset,:limit
+
+    def initialize(offset,limit)
+      @offset = offset
+      @limit = limit
+    end
+
+    def to_hash
+      hash = {
+        :offset => @offset,
+        :limit => @limit
+      }
+      hash.delete_if {|k, v| v.nil?}
+    end
+      
+  end
+
+end

data/lib/authorize_net/arb/response.rb~

@@ -0,0 +1,68 @@
+module AuthorizeNet::ARB
+
+  # The ARB response class.
+  class Response < AuthorizeNet::XmlResponse    
+    # Constructs a new response object from a +raw_response. You don't typically
+    # construct this object yourself, as AuthorizeNet::ARB::Transaction will
+    # build one for you when it makes the request to the gateway.
+    def initialize(raw_response, transaction)
+      super
+      unless connection_failure?
+        begin
+          @subscription_id = node_content_unless_nil(@root.at_css('subscriptionId'))
+          @subscription_status = node_content_unless_nil(@root.at_css('Status'))
+
+        rescue
+          @raw_response = $!
+        end
+      end
+    end
+    
+    # Returns the subscriptionId from the response if there is one. Otherwise returns nil.
+    def subscription_id
+      @subscription_id
+    end
+    
+    # Returns the status of the Subscription from the response if there is one. Otherwise returns nil. This value
+    # is only returned in response to a get_status transaction.
+    def subscription_status
+      @subscription_status
+    end
+    
+  end #Response
+
+  class SubscriptionListResponse < AuthorizeNet::XmlResponse
+    def initialize(raw_response, transaction)
+      super
+      unless connection_failure?
+        begin
+	  @subscription_details = @root.at_css('subscriptionDetails')
+          @subscription_detail = @root.at_css('subscriptionDetail')
+          @total_num_in_resultset = node_content_unless_nil(@root.at_css('totalNumInResultSet'))
+
+        rescue
+          @raw_response = $!
+        end
+      end
+    end
+
+    def total_num_in_resultset
+      @total_num_in_resultset
+    end
+
+    # Returns an Array of SubscriptionDetail objects built from the entities returned in the response. Returns nil if no subscriptions were returned.
+    def subscription_details
+      unless @subscription_details.nil?
+          subscription_details = []
+          @subscription_details.element_children.each do |child|
+            unless child.nil?
+              subscription_detail = build_entity(child, Fields::SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION)
+            
+              subscription_details <<= subscription_detail
+            end
+          end
+          return subscription_details unless subscription_details.length == 0
+       end
+    end
+  end #SubscriptionListResponse
+end

data/lib/authorize_net/arb/sorting.rb

@@ -0,0 +1,43 @@
+module AuthorizeNet::ARB
+
+  class Sorting
+    
+    # Models Sorting
+    include AuthorizeNet::Model
+    
+    attr_accessor :order_by, :order_descending
+
+    # Initializes Sorting object. 
+    #
+    # Typical usage:
+    #  sorting = AuthorizeNet::ARB::Sorting.new('name',true)
+    #
+    # Valid values for order_by values of the AuthorizeNet::ARB::Sorting:
+    #    id
+    #    name
+    #    status
+    #    createTimeStampUTC
+    #    lastName
+    #    firstName
+    #    accountNumber
+    #    amount
+    #    pastOccurrences
+    #
+    # Valid values for order_descending: true, false, 1, 0
+    #
+    def initialize(order_by, order_descending)
+      @order_by = order_by
+      @order_descending = order_descending
+    end
+   
+    def to_hash
+      hash = {
+        :order_by => @order_by,
+        :order_descending => @order_descending
+      }
+      hash.delete_if {|k, v| v.nil?}
+    end
+      
+  end
+
+end