authorizenet 1.9.4 → 1.9.5

data/lib/authorize_net/reporting/returned_item.rb

@@ -1,12 +1,11 @@
 module AuthorizeNet::Reporting
-
   class ReturnedItem
     include AuthorizeNet::Model
 
     attr_accessor :id, :date_utc, :date_local, :code, :description, :returned_items
 
     def date_utc=(time)
-      if time.kind_of?(DateTime)
+      if time.is_a?(DateTime)
         @date_utc = time
       else
         @date_utc = DateTime.parse(time.to_s)
@@ -14,7 +13,7 @@ module AuthorizeNet::Reporting
     end
 
     def date_local=(time)
-      if time.kind_of?(DateTime)
+      if time.is_a?(DateTime)
         @date_local = time
       else
         @date_local = DateTime.parse(time.to_s)
@@ -22,24 +21,24 @@ module AuthorizeNet::Reporting
     end
 
     def add_returned_item(id = nil, date_utc = nil, date_local = nil, code = nil, description = nil)
-      if id.kind_of?(AuthorizeNet::Reporting::ReturnedItem)
+      if id.is_a?(AuthorizeNet::Reporting::ReturnedItem)
         returned_item = id
       else
-        returned_item = AuthorizeNet::Reporting::ReturnedItem.new({:return_item_id => id, :return_item_date_utc => date_utc, :return_item_date_local => date_local, :return_item_code => code, :line_item_description => description})
+        returned_item = AuthorizeNet::Reporting::ReturnedItem.new(return_item_id: id, return_item_date_utc: date_utc, return_item_date_local: date_local, return_item_code: code, line_item_description: description)
       end
       @returned_items = @returned_items.to_a << returned_item
     end
 
     def to_hash
       hash = {
-          :id => @id,
-          :date_utc => @date_utc,
-          :date_local => @date_local,
-          :code => @code,
-          :description => @description,
-          :returned_items => handle_multivalue_hashing(@returned_items)
+        id: @id,
+        date_utc: @date_utc,
+        date_local: @date_local,
+        code: @code,
+        description: @description,
+        returned_items: handle_multivalue_hashing(@returned_items)
       }
-      hash.delete_if { |k, v| v.nil? }
+      hash.delete_if { |_k, v| v.nil? }
       hash
     end
   end

data/lib/authorize_net/reporting/transaction.rb

@@ -1,65 +1,64 @@
 module AuthorizeNet::Reporting
-
   # The Reporting API transaction class.
   class Transaction < AuthorizeNet::XmlTransaction
-    
     include AuthorizeNet::Reporting::Fields
-    
+
     # The class to wrap our response in.
     @response_class = AuthorizeNet::Reporting::Response
-    
+
     # Fields to convert to/from Date.
-    @@datetime_fields = [:first_settlement_date, :last_settlement_date]
-    
+    @@datetime_fields = %i[first_settlement_date last_settlement_date]
+
     # Constructs a Reporting transaction. You can use the new Reporting transaction object
     # to issue a request to the payment gateway and parse the response into a new
     # AuthorizeNet::Reporting::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
-    # +gateway+:: The gateway to submit the transaction to. Can be a URL string, an AuthorizeNet::Reporting::Transaction::Gateway constant, or one of the convenience symbols :sandbox, :test, :production, or :live (:test is an alias for :sandbox, and :live is an alias for :production). 
+    # +gateway+:: The gateway to submit the transaction to. Can be a URL string, an AuthorizeNet::Reporting::Transaction::Gateway constant, or one of the convenience symbols :sandbox, :test, :production, or :live (:test is an alias for :sandbox, and :live is an alias for :production).
     # +verify_ssl+:: A boolean indicating if the SSL certificate of the +gateway+ should be verified. Defaults to true.
     # +reference_id+:: A string that can be used to identify a particular transaction with its response. Will be echo'd in the response, only if it was provided in the transaction. Defaults to nil.
     #
     def initialize(api_login_id, api_transaction_key, options = {})
+      ActiveSupport::Deprecation.warn "use AuthorizeNet::API::Transaction"
       super
     end
-    
+
     # Sets up and submits a getSettledBatchListRequest transaction. If this transaction has already been
     # run, this method will return nil. Otherwise it will return an AuthorizeNet::Reporting::Response object. The
     # response object will have an array of Batch objects available via its batch_list method if
     # the request was successful.
-    # 
+    #
     #
     # +from_date+:: Takes either a DateTime or a String representing a date and time. Only settled batches >= this value will be returned. Defaults to nil (which returns >= 24hrs ago). A to_date must be specified if a from_date is.
     # +to_date+:: Takes either a DateTime or a String representing a date and time. Only settled batches <= this value will be returned. Defaults to nil. The maximum date range is 31 days, and a from_date must be supplied if a to_date is.
     # +include_stats+:: Takes a Boolean. Determines if BatchStatistics should be returned with the Batch objects. Defaults to false.
     #
     # Typical usage:
-    # 
+    #
     #   response = transaction.get_settled_batch_list(DateTime.now() - (1 * 3600 * 48), DateTime.now(), true)
     #   batches = response.batch_list if response.success?
     #
     def get_settled_batch_list(from_date = nil, to_date = nil, include_stats = false)
       @type = Type::REPORT_GET_BATCH_LIST
-      set_fields({:first_settlement_date => from_date, :last_settlement_date => to_date, :include_statistics => include_stats})
+      set_fields(first_settlement_date: from_date, last_settlement_date: to_date, include_statistics: include_stats)
       make_request
     end
-    
+
     # Sets up and submits a getTransactionListRequest transaction. If this transaction has already been
     # run, this method will return nil. Otherwise it will return an AuthorizeNet::Reporting::Response object. The
     # response object will have an array of TransactionDetail objects available via its transactions method if
     # the request was successful. These TransactionDetail objects will not be fully populated. Use get_transaction_details
     # to get all the details.
-    # 
+    #
     #
     # +batch_id+:: Takes either a Batch object with its id attribute populated, or a String representing the ID of the batch to retrieve the transaction list from.
     #
     # Typical usage:
-    # 
+    #
     #   response = transaction.get_transaction_list('123456')
     #   transactions = response.transactions if response.success?
     #
@@ -68,16 +67,16 @@ module AuthorizeNet::Reporting
       handle_batch_id(batch_id)
       make_request
     end
-    
+
     # Sets up and submits a getUnsettledTransactionListRequest transaction. If this transaction has already been
     # run, this method will return nil. Otherwise it will return an AuthorizeNet::Reporting::Response object. The
     # response object will have an array of TransactionDetail objects available via its transactions method if
     # the request was successful. These TransactionDetail objects will not be fully populated. Use get_transaction_details
     # to get all the details.
-    # 
+    #
     #
     # Typical usage:
-    # 
+    #
     #   response = transaction.get_unsettled_transaction_list
     #   transactions = response.transactions if response.success?
     #
@@ -91,12 +90,12 @@ module AuthorizeNet::Reporting
     # response object will have a TransactionDetail object available via its transactions method if
     # the request was successful. This TransactionDetail object will have more data than the limited version
     # returned by get_transaction_list.
-    # 
+    #
     #
     # +transaction_id+:: Takes either a TransactionDetail object with its id attribute populated, or a String representing the ID of the transaction to retrieve the details from.
     #
     # Typical usage:
-    # 
+    #
     #   response = transaction.get_transaction_details('123456789')
     #   transactions = response.transactions if response.success?
     #
@@ -105,29 +104,28 @@ module AuthorizeNet::Reporting
       handle_transaction_id(transaction_id)
       make_request
     end
-    
+
     #:enddoc:
     protected
-    
+
     # Handles batch id type massaging.
     def handle_batch_id(id)
       case id
       when Batch
-        set_fields(:batch_id => id.id.to_s)
+        set_fields(batch_id: id.id.to_s)
       else
-        set_fields(:batch_id => id.to_s)
+        set_fields(batch_id: id.to_s)
       end
     end
-    
+
     # Handles transaction id type massaging.
     def handle_transaction_id(id)
       case id
       when TransactionDetails
-        set_fields(:transaction_id => id.id.to_s)
+        set_fields(transaction_id: id.id.to_s)
       else
-        set_fields(:transaction_id => id.to_s)
+        set_fields(transaction_id: id.to_s)
       end
     end
   end
-  
 end

data/lib/authorize_net/reporting/transaction_details.rb

@@ -1,8 +1,6 @@
 module AuthorizeNet::Reporting
-
   # Models the details of a transaction.
   class TransactionDetails
-    
     include AuthorizeNet::Model
 
     attr_accessor :id, :submitted_at, :status, :order, :customer, :account_type,
@@ -12,14 +10,13 @@ module AuthorizeNet::Reporting
                   :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)
+      if time.is_a?(DateTime)
         @submitted_at = time
       else
         @submitted_at = DateTime.parse(time.to_s)
       end
     end
-
   end
-end
+end

data/lib/authorize_net/response.rb

@@ -1,29 +1,25 @@
 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."
+    def initialize
+      raise "#{self.class} should not be instantiated directly."
     end
-    
+
     # Check to see if the response indicated success.
     def success?
       false
     end
-    
   end
-  
-end
+end

data/lib/authorize_net/sim/hosted_payment_form.rb

@@ -1,38 +1,34 @@
 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
+      if @rename.nil?
         @rename = [rename]
+      else
+        @rename = @rename.to_a << 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
+        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.delete_if { |_k, v| v.nil? }
       hash
     end
-  
   end
-  
-end
+end

data/lib/authorize_net/sim/hosted_receipt_page.rb

@@ -1,37 +1,32 @@
 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'
+      LINK = 'LINK'.freeze
+      POST = 'POST'.freeze
+      GET = 'GET'.freeze
     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
+        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.delete_if { |_k, v| v.nil? }
       hash
     end
-  
   end
-  
-end
+end

data/lib/authorize_net/sim/response.rb

@@ -1,20 +1,18 @@
 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)
@@ -23,30 +21,27 @@ module AuthorizeNet::SIM
       @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
+      return false if @fields[:MD5_Hash].nil?
+      @@digest.hexdigest("#{merchant_value}#{api_login}#{@fields[:trans_id]}#{@fields[:amount]}").casecmp(@fields[:MD5_Hash]).zero?
     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('"', "\"")
+      url = direct_post_url(url, options[:include]) if options.key?(:include)
+      js_url = url.tr("'", '\'')
+      html_url = url.gsub('&', '&amp;').tr('"', "\"")
       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.
@@ -68,48 +63,48 @@ HTML
         parsed_url = URI.parse(url)
         if parsed_url.query.nil?
           parsed_url.query = ''
-        elsif parsed_url.query.length != 0
+        elsif !parsed_url.query.empty?
           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 += ((fields.select { |k| @fields.key?(k) }).collect { |k| 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. 
+    # 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)
@@ -125,18 +120,14 @@ HTML
         end
       when String
         # convert to hash and re-parse
-        hash = CGI::parse(raw_response)
+        hash = CGI.parse(raw_response)
         hash.each do |k, v|
-          if v.kind_of?(Array) && v.length == 1
-            hash[k] = v[0]
-          end
+          hash[k] = v[0] if v.is_a?(Array) && v.length == 1
         end
         parse_response(hash)
       else
         parse_response(@raw_response.to_s)
       end
     end
-    
   end
-
-end
+end