authorizenet 1.8.7 → 1.8.8

data/lib/authorize_net/reporting/transaction_details.rb

@@ -1,25 +1,25 @@
-module AuthorizeNet::Reporting
-
-  # Models the details of a transaction.
-  class TransactionDetails
-    
-    include AuthorizeNet::Model
-
-    attr_accessor :id, :submitted_at, :status, :order, :customer, :account_type,
-                  :account_number, :settle_amount, :reference_id, :split_tender_id,
-                  :type, :response_code, :response_reason_code, :response_reason_description,
-                  :auth_code, :avs_response, :card_code_response, :cavv_response,
-                  :fds_filter_action, :fds_filters, :batch, :prepaid_balance_remaining,
-                  :payment_method, :recurring_billing, :bill_to, :ship_to, :auth_amount,
-                  :subscription_id, :subscription_paynum, :solution_id, :solution_name, :returns
-    
-    def submitted_at=(time)
-      if time.kind_of?(DateTime)
-        @submitted_at = time
-      else
-        @submitted_at = DateTime.parse(time.to_s)
-      end
-    end
-
-  end
+module AuthorizeNet::Reporting
+
+  # Models the details of a transaction.
+  class TransactionDetails
+    
+    include AuthorizeNet::Model
+
+    attr_accessor :id, :submitted_at, :status, :order, :customer, :account_type,
+                  :account_number, :settle_amount, :reference_id, :split_tender_id,
+                  :type, :response_code, :response_reason_code, :response_reason_description,
+                  :auth_code, :avs_response, :card_code_response, :cavv_response,
+                  :fds_filter_action, :fds_filters, :batch, :prepaid_balance_remaining,
+                  :payment_method, :recurring_billing, :bill_to, :ship_to, :auth_amount,
+                  :subscription_id, :subscription_paynum, :solution_id, :solution_name, :returns
+    
+    def submitted_at=(time)
+      if time.kind_of?(DateTime)
+        @submitted_at = time
+      else
+        @submitted_at = DateTime.parse(time.to_s)
+      end
+    end
+
+  end
 end

data/lib/authorize_net/response.rb

@@ -1,27 +1,27 @@
-module AuthorizeNet
-  
-  # The core, API agnostic response class. You shouldn't instantiate this one.
-  # Instead you should use AuthorizeNet::AIM::Response, AuthorizeNet::ARB::Response or AuthorizeNet::SIM::Response.
-  class Response
-    
-    include AuthorizeNet::TypeConversions
-        
-    # Fields to convert to/from booleans.
-    @@boolean_fields = []
-
-    # Fields to convert to/from BigDecimal.
-    @@decimal_fields = []
-    
-    # DO NOT USE. Instantiate AuthorizeNet::AIM::Response or AuthorizeNet::SIM::Response instead.
-    def initialize()
-      raise "#{self.class.to_s} should not be instantiated directly."
-    end
-    
-    # Check to see if the response indicated success.
-    def success?
-      false
-    end
-    
-  end
-  
+module AuthorizeNet
+  
+  # The core, API agnostic response class. You shouldn't instantiate this one.
+  # Instead you should use AuthorizeNet::AIM::Response, AuthorizeNet::ARB::Response or AuthorizeNet::SIM::Response.
+  class Response
+    
+    include AuthorizeNet::TypeConversions
+        
+    # Fields to convert to/from booleans.
+    @@boolean_fields = []
+
+    # Fields to convert to/from BigDecimal.
+    @@decimal_fields = []
+    
+    # DO NOT USE. Instantiate AuthorizeNet::AIM::Response or AuthorizeNet::SIM::Response instead.
+    def initialize()
+      raise "#{self.class.to_s} should not be instantiated directly."
+    end
+    
+    # Check to see if the response indicated success.
+    def success?
+      false
+    end
+    
+  end
+  
 end

data/lib/authorize_net/sim/hosted_payment_form.rb

@@ -1,38 +1,38 @@
-module AuthorizeNet::SIM
-  
-  # Models a hosted payment form.
-  class HostedPaymentForm
-    
-    include AuthorizeNet::Model
-    
-    attr_accessor :header_html, :footer_html, :color_background, :color_link, :color_text, :logo_url, :background_url, :rename
-    
-    # Convenience method for adding field rename requests to the transaction. This renames a field shown on
-    # the hosted payment form.
-    def add_rename(field, name)
-      rename = "#{field},#{name}"
-      unless @rename.nil?
-        @rename = @rename.to_a << rename
-      else
-        @rename = [rename]
-      end
-    end
-    
-    def to_hash
-      hash = {
-        :header_html_payment_form => @header_html,
-        :footer_html_payment_form => @footer_html,
-        :color_background => @color_background,
-        :color_link => @color_link,
-        :color_text => @color_text,
-        :logo_url => @logo_url,
-        :background_url => @background_url,
-        :rename => @rename
-      }
-      hash.delete_if {|k, v| v.nil?}
-      hash
-    end
-  
-  end
-  
+module AuthorizeNet::SIM
+  
+  # Models a hosted payment form.
+  class HostedPaymentForm
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :header_html, :footer_html, :color_background, :color_link, :color_text, :logo_url, :background_url, :rename
+    
+    # Convenience method for adding field rename requests to the transaction. This renames a field shown on
+    # the hosted payment form.
+    def add_rename(field, name)
+      rename = "#{field},#{name}"
+      unless @rename.nil?
+        @rename = @rename.to_a << rename
+      else
+        @rename = [rename]
+      end
+    end
+    
+    def to_hash
+      hash = {
+        :header_html_payment_form => @header_html,
+        :footer_html_payment_form => @footer_html,
+        :color_background => @color_background,
+        :color_link => @color_link,
+        :color_text => @color_text,
+        :logo_url => @logo_url,
+        :background_url => @background_url,
+        :rename => @rename
+      }
+      hash.delete_if {|k, v| v.nil?}
+      hash
+    end
+  
+  end
+  
 end

data/lib/authorize_net/sim/hosted_receipt_page.rb

@@ -1,37 +1,37 @@
-module AuthorizeNet::SIM
-  
-  # Models a hosted receipt page.
-  class HostedReceiptPage
-    
-    # Defines constants for each of the link methods used by the hosted receipt page.
-    module LinkMethod
-      LINK = 'LINK'
-      POST = 'POST'
-      GET = 'GET'
-    end
-    
-    include AuthorizeNet::Model
-    
-    attr_accessor :header_html, :footer_html, :color_background, :color_link, :color_text, :logo_url, :background_url, :link_method, :link_text, :link_url
-    
-    
-    def to_hash
-      hash = {
-        :header_html_receipt => @header_html,
-        :footer_html_receipt => @footer_html,
-        :color_background => @color_background,
-        :color_link => @color_link,
-        :color_text => @color_text,
-        :logo_url => @logo_url,
-        :background_url => @background_url,
-        :receipt_link_method => @link_method,
-        :receipt_link_text => @link_text,
-        :receipt_link_url => @link_url
-      }
-      hash.delete_if {|k, v| v.nil?}
-      hash
-    end
-  
-  end
-  
+module AuthorizeNet::SIM
+  
+  # Models a hosted receipt page.
+  class HostedReceiptPage
+    
+    # Defines constants for each of the link methods used by the hosted receipt page.
+    module LinkMethod
+      LINK = 'LINK'
+      POST = 'POST'
+      GET = 'GET'
+    end
+    
+    include AuthorizeNet::Model
+    
+    attr_accessor :header_html, :footer_html, :color_background, :color_link, :color_text, :logo_url, :background_url, :link_method, :link_text, :link_url
+    
+    
+    def to_hash
+      hash = {
+        :header_html_receipt => @header_html,
+        :footer_html_receipt => @footer_html,
+        :color_background => @color_background,
+        :color_link => @color_link,
+        :color_text => @color_text,
+        :logo_url => @logo_url,
+        :background_url => @background_url,
+        :receipt_link_method => @link_method,
+        :receipt_link_text => @link_text,
+        :receipt_link_url => @link_url
+      }
+      hash.delete_if {|k, v| v.nil?}
+      hash
+    end
+  
+  end
+  
 end

data/lib/authorize_net/sim/response.rb

@@ -1,142 +1,142 @@
-module AuthorizeNet::SIM
-  
-  # The SIM response class. Handles parsing the response from the gateway. Also
-  # provides a few relay response helpers used to implement Direct Post Method.
-  class Response < AuthorizeNet::KeyValueResponse
-    
-    # Our MD5 digest generator.
-    @@digest = OpenSSL::Digest.new('md5')
-
-    include AuthorizeNet::SIM::Fields
-    
-    # Constructs a new response object from a +raw_response+. Provides utility methods
-    # for validating the response as authentic, and for handling the Direct Post Method
-    # relay response.
-    # 
-    # +raw_response+:: The raw response, either a string in POST body or GET query string format, or a hash of key/value pairs.
-    # 
-    # Typical usage:
-    #   response = AuthorizeNet::SIM::Response("x_first_name=John&x_last_name=Doe")
-    def initialize(raw_response)
-      @raw_response = raw_response
-      @custom_fields = {}
-      @fields = {}
-      parse_response(@raw_response)
-    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[:trans_id]}#{@fields[:amount]}").downcase == @fields[:MD5_Hash].downcase
-    end
-    
-    # Returns an HTML string that can be returned to the gateway during the Relay Response,
-    # and will send the user on to URL you specify. Takes a hash of options, currently the
-    # only option is :include, which can be True to include all fields returned in the response
-    # as query string parameters, or it can be an array of fields to include.
-    def direct_post_reply(url, options = {})
-      url = direct_post_url(url, options[:include]) if options.has_key?(:include)
-      js_url = url.gsub("'", '\'')
-      html_url = url.gsub('&', '&amp;').gsub('"', "\"")
-      html = <<-HTML
-<html><head><script type="text/javascript" charset="utf-8">window.location='#{js_url}';</script><noscript><meta http-equiv="refresh" content="1;url=#{html_url}"></noscript></head><body></body></html>
-HTML
-    end
-    
-    # Returns an URL with the fields found in the response and specified in include_fields attached as
-    # part of the URL's query string. If you pass true instead of an array of fields, all fields will be
-    # attached.
-    def direct_post_url(base_url, include_fields = true)
-      url = base_url
-      if include_fields
-        fields = []
-        case include_fields
-        when TrueClass
-          fields = FIELDS.collect do |k|
-            k_str = k.to_s
-            k_str[2..k_str.length].to_sym
-          end
-        when Array
-          fields = include_fields
-        else
-          fields = include_fields.to_a
-        end
-        parsed_url = URI.parse(url)
-        if parsed_url.query.nil?
-          parsed_url.query = ''
-        elsif parsed_url.query.length != 0
-          parsed_url.query = parsed_url.query.chomp('&') + '&'
-        end
-        parsed_url.query += ((fields.select { |k| @fields.has_key?(k) }).collect { |k| self.to_param(k, @fields[k]) }).join('&')
-        parsed_url.query.chomp('&')
-        url = parsed_url.to_s
-      end
-      url
-    end
-    
-    # Check to see if the response indicated success. Success is defined as a valid MD5 hash
-    # and an response code of AuthorizeNet::Response::ResponseCode::APPROVED.
-    def success?(api_login, merchant_value)
-      valid_md5?(api_login, merchant_value) && approved?
-    end
-    
-    # Returns the transaction's authorization code. This should be shown to the
-    # end user.
-    def authorization_code
-      @fields[:auth_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[:trans_id]
-    end
-    
-    # Returns the customer id from the response.
-    def customer_id
-      @fields[:cust_id]
-    end
-    
-    # Returns a response code (from AVSResponseCode) indicating the result of any Address Verification
-    # Service checks. 
-    def avs_response
-      @fields[:avs_code]
-    end
-    
-    #:enddoc:
-    protected
-    
-    # Internal helper to parse the raw response object. It handles both raw POST bodies and
-    # hashes.
-    def parse_response(raw_response)
-      case raw_response
-      when Hash
-        raw_response.each do |k, v|
-          k = k.to_sym
-          if FIELDS.include?(k)
-            @fields[to_internal_field(k)] = v # remove x_ from sym and stick in @fields
-          else
-            @custom_fields[k] = v
-          end
-        end
-      when String
-        # convert to hash and re-parse
-        hash = CGI::parse(raw_response)
-        hash.each do |k, v|
-          if v.kind_of?(Array) && v.length == 1
-            hash[k] = v[0]
-          end
-        end
-        parse_response(hash)
-      else
-        parse_response(@raw_response.to_s)
-      end
-    end
-    
-  end
-
+module AuthorizeNet::SIM
+  
+  # The SIM response class. Handles parsing the response from the gateway. Also
+  # provides a few relay response helpers used to implement Direct Post Method.
+  class Response < AuthorizeNet::KeyValueResponse
+    
+    # Our MD5 digest generator.
+    @@digest = OpenSSL::Digest.new('md5')
+
+    include AuthorizeNet::SIM::Fields
+    
+    # Constructs a new response object from a +raw_response+. Provides utility methods
+    # for validating the response as authentic, and for handling the Direct Post Method
+    # relay response.
+    # 
+    # +raw_response+:: The raw response, either a string in POST body or GET query string format, or a hash of key/value pairs.
+    # 
+    # Typical usage:
+    #   response = AuthorizeNet::SIM::Response("x_first_name=John&x_last_name=Doe")
+    def initialize(raw_response)
+      @raw_response = raw_response
+      @custom_fields = {}
+      @fields = {}
+      parse_response(@raw_response)
+    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[:trans_id]}#{@fields[:amount]}").downcase == @fields[:MD5_Hash].downcase
+    end
+    
+    # Returns an HTML string that can be returned to the gateway during the Relay Response,
+    # and will send the user on to URL you specify. Takes a hash of options, currently the
+    # only option is :include, which can be True to include all fields returned in the response
+    # as query string parameters, or it can be an array of fields to include.
+    def direct_post_reply(url, options = {})
+      url = direct_post_url(url, options[:include]) if options.has_key?(:include)
+      js_url = url.gsub("'", '\'')
+      html_url = url.gsub('&', '&amp;').gsub('"', "\"")
+      html = <<-HTML
+<html><head><script type="text/javascript" charset="utf-8">window.location='#{js_url}';</script><noscript><meta http-equiv="refresh" content="1;url=#{html_url}"></noscript></head><body></body></html>
+HTML
+    end
+    
+    # Returns an URL with the fields found in the response and specified in include_fields attached as
+    # part of the URL's query string. If you pass true instead of an array of fields, all fields will be
+    # attached.
+    def direct_post_url(base_url, include_fields = true)
+      url = base_url
+      if include_fields
+        fields = []
+        case include_fields
+        when TrueClass
+          fields = FIELDS.collect do |k|
+            k_str = k.to_s
+            k_str[2..k_str.length].to_sym
+          end
+        when Array
+          fields = include_fields
+        else
+          fields = include_fields.to_a
+        end
+        parsed_url = URI.parse(url)
+        if parsed_url.query.nil?
+          parsed_url.query = ''
+        elsif parsed_url.query.length != 0
+          parsed_url.query = parsed_url.query.chomp('&') + '&'
+        end
+        parsed_url.query += ((fields.select { |k| @fields.has_key?(k) }).collect { |k| self.to_param(k, @fields[k]) }).join('&')
+        parsed_url.query.chomp('&')
+        url = parsed_url.to_s
+      end
+      url
+    end
+    
+    # Check to see if the response indicated success. Success is defined as a valid MD5 hash
+    # and an response code of AuthorizeNet::Response::ResponseCode::APPROVED.
+    def success?(api_login, merchant_value)
+      valid_md5?(api_login, merchant_value) && approved?
+    end
+    
+    # Returns the transaction's authorization code. This should be shown to the
+    # end user.
+    def authorization_code
+      @fields[:auth_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[:trans_id]
+    end
+    
+    # Returns the customer id from the response.
+    def customer_id
+      @fields[:cust_id]
+    end
+    
+    # Returns a response code (from AVSResponseCode) indicating the result of any Address Verification
+    # Service checks. 
+    def avs_response
+      @fields[:avs_code]
+    end
+    
+    #:enddoc:
+    protected
+    
+    # Internal helper to parse the raw response object. It handles both raw POST bodies and
+    # hashes.
+    def parse_response(raw_response)
+      case raw_response
+      when Hash
+        raw_response.each do |k, v|
+          k = k.to_sym
+          if FIELDS.include?(k)
+            @fields[to_internal_field(k)] = v # remove x_ from sym and stick in @fields
+          else
+            @custom_fields[k] = v
+          end
+        end
+      when String
+        # convert to hash and re-parse
+        hash = CGI::parse(raw_response)
+        hash.each do |k, v|
+          if v.kind_of?(Array) && v.length == 1
+            hash[k] = v[0]
+          end
+        end
+        parse_response(hash)
+      else
+        parse_response(@raw_response.to_s)
+      end
+    end
+    
+  end
+
 end