authorizenet 1.9.4 → 1.9.5

data/lib/authorize_net/arb/sorting.rb

@@ -1,13 +1,11 @@
 module AuthorizeNet::ARB
-
   class Sorting
-    
     # Models Sorting
     include AuthorizeNet::Model
-    
+
     attr_accessor :order_by, :order_descending
 
-    # Initializes Sorting object. 
+    # Initializes Sorting object.
     #
     # Typical usage:
     #  sorting = AuthorizeNet::ARB::Sorting.new('name',true)
@@ -29,15 +27,13 @@ module AuthorizeNet::ARB
       @order_by = order_by
       @order_descending = order_descending
     end
-   
+
     def to_hash
       hash = {
-        :order_by => @order_by,
-        :order_descending => @order_descending
+        order_by: @order_by,
+        order_descending: @order_descending
       }
-      hash.delete_if {|k, v| v.nil?}
+      hash.delete_if { |_k, v| v.nil? }
     end
-      
   end
-
 end

data/lib/authorize_net/arb/subscription.rb

@@ -1,30 +1,28 @@
 module AuthorizeNet::ARB
-
   # Models an ARB subscription.
   class Subscription
-    
     # Use this constant for the value of total_occurrences to get a subscription with no end.
     UNLIMITED_OCCURRENCES = 9999
-    
+
     # Constants for the various interval units supported by the ARB API.
     module IntervalUnits
-      MONTH = 'months'
-      DAY = 'days'
+      MONTH = 'months'.freeze
+      DAY = 'days'.freeze
     end
-    
+
     # Constants for the various statuses a subscription can have. These are returned by the get_status call.
     module Status
-      ACTIVE = 'active'
-      EXPIRED = 'expired'
-      SUSPENDED = 'suspended'
-      CANCELED = 'canceled'
-      TERMINATED = 'terminated'
+      ACTIVE = 'active'.freeze
+      EXPIRED = 'expired'.freeze
+      SUSPENDED = 'suspended'.freeze
+      CANCELED = 'canceled'.freeze
+      TERMINATED = 'terminated'.freeze
     end
-    
+
     include AuthorizeNet::Model
-    
+
     attr_accessor :name, :length, :unit, :start_date, :total_occurrences, :trial_occurrences, :amount, :trial_amount, :invoice_number, :description, :subscription_id, :credit_card, :billing_address, :shipping_address, :customer
-    
+
     # Override the total_occurrences setter to provide support for :unlimited shortcut.
     def total_occurrences=(new_total_occurrences) #:nodoc:
       if new_total_occurrences == :unlimited
@@ -33,7 +31,7 @@ module AuthorizeNet::ARB
         @total_occurrences = new_total_occurrences
       end
     end
-    
+
     # Override the unit setter to provide support for :day, :days, :month, :months shortcut. Do not document this method in rdoc.
     def unit=(new_unit) #:nodoc:
       case new_unit
@@ -45,28 +43,26 @@ module AuthorizeNet::ARB
         @unit = new_unit
       end
     end
-    
+
     def to_hash
       hash = {
-        :subscription_name => @name,
-        :subscription_length => @length,
-        :subscription_unit => @unit,
-        :subscription_start_date => @start_date,
-        :subscription_total_occurrences => @total_occurrences,
-        :subscription_trial_occurrences => @trial_occurrences,
-        :subscription_amount => @amount,
-        :subscription_trial_amount => @trial_amount,
-        :invoice_num => @invoice_number,
-        :description => @description,
-        :subscription_id => @subscription_id
+        subscription_name: @name,
+        subscription_length: @length,
+        subscription_unit: @unit,
+        subscription_start_date: @start_date,
+        subscription_total_occurrences: @total_occurrences,
+        subscription_trial_occurrences: @trial_occurrences,
+        subscription_amount: @amount,
+        subscription_trial_amount: @trial_amount,
+        invoice_num: @invoice_number,
+        description: @description,
+        subscription_id: @subscription_id
       }
       hash.merge!(@credit_card.to_hash) unless @credit_card.nil?
       hash.merge!(@billing_address.to_hash) unless @billing_address.nil?
       hash.merge!(@shipping_address.to_hash) unless @shipping_address.nil?
       hash.merge!(@customer.to_hash) unless @customer.nil?
-      hash.delete_if {|k, v| v.nil?}
+      hash.delete_if { |_k, v| v.nil? }
     end
-    
   end
-
-end
+end

data/lib/authorize_net/arb/subscription_detail.rb

@@ -1,14 +1,10 @@
 module AuthorizeNet::ARB
-
   # Models Subscription Detail.
   class SubscriptionDetail
-    
     include AuthorizeNet::Model
-    
+
     attr_accessor :id, :name, :status, :create_time_stamp_utc, :first_name,
                   :last_name, :total_occurrences, :past_occurrences,
                   :payment_method, :account_number, :invoice, :amount, :currency_id
-      
   end
-
 end

data/lib/authorize_net/arb/subscription_list_response.rb

@@ -1,5 +1,4 @@
 module AuthorizeNet::ARB
-
   class SubscriptionListResponse < AuthorizeNet::XmlResponse
     # Constructs a new response object from a +raw_response. You don't typically
     # construct this object yourself, as AuthorizeNet::ARB::Transaction will
@@ -8,36 +7,30 @@ module AuthorizeNet::ARB
       super
       unless connection_failure?
         begin
-	  @subscription_details = @root.at_css('subscriptionDetails')
+          @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 = $!
+        rescue StandardError
+          @raw_response = $ERROR_INFO
         end
       end
     end
 
     # Returns total number of subscriptions matching the search criteria
-    def total_num_in_resultset
-      @total_num_in_resultset
-    end
+    attr_reader :total_num_in_resultset
 
     # 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
+        subscription_details = []
+        @subscription_details.element_children.each do |child|
+          next if child.nil?
+          subscription_detail = build_entity(child, Fields::SUBSCRIPTION_DETAIL_ENTITY_DESCRIPTION)
+
+          subscription_details <<= subscription_detail
+        end
+        return subscription_details unless subscription_details.empty?
        end
     end
-
-  end 
-
+  end
 end

data/lib/authorize_net/arb/transaction.rb

@@ -1,54 +1,53 @@
 module AuthorizeNet::ARB
-
   # The ARB transaction class.
   class Transaction < AuthorizeNet::XmlTransaction
-    
     include AuthorizeNet::ARB::Fields
-    
+
     # The default options for the constructor.
     @@option_defaults = {
-      :gateway => :production,
-      :verify_ssl => true,
-      :reference_id => nil
+      gateway: :production,
+      verify_ssl: true,
+      reference_id: nil
     }
-    
+
     # Fields to convert to/from booleans.
     @@boolean_fields = []
-    
+
     # Fields to convert to/from BigDecimal.
-    @@decimal_fields = [:amount, :trial_amount]
-    
+    @@decimal_fields = %i[amount trial_amount]
+
     # Fields to convert to/from Date.
     @@date_fields = [:subscription_start_date]
-    
+
     # The class to wrap our response in.
-    @response_class = AuthorizeNet::ARB::Response   
-    
+    @response_class = AuthorizeNet::ARB::Response
+
     # Constructs an ARB transaction. You can use the new ARB transaction object
     # to issue a request to the payment gateway and parse the response into a new
     # AuthorizeNet::ARB::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::ARB::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::ARB::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 start of subscription (ARBCreateSubscriptionRequest) transaction. Returns a response object. If the transaction
     # has already been run, it will return nil.
-    # 
+    #
     # +subscription+:: An instance of AuthorizeNet::ARB::Subscription describing the recurring payment you would like to create.
-    # 
-    # 
+    #
+    #
     # Typical usage:
-    # 
+    #
     #   subscription = AuthorizeNet::ARB::Subscription.new(
     #     :name => "Monthly Gift Basket",
     #     :length => 1,
@@ -68,15 +67,15 @@ module AuthorizeNet::ARB
       set_fields(subscription.to_hash)
       run
     end
-    
+
     # Sets up and submits a subscription update (ARBUpdateSubscriptionRequest) transaction. Returns a response object. If the transaction
     # has already been run, it will return nil.
-    # 
+    #
     # +subscription+:: An instance of AuthorizeNet::ARB::Subscription describing the changes to make. It must have a value for subscription_id so that the API knows what subscription to update. Note that some information (intervals, start dates, etc) can't be changed. See the ARB guide for more details.
-    # 
-    # 
+    #
+    #
     # Typical usage:
-    # 
+    #
     #   subscription = AuthorizeNet::ARB::Subscription.new(
     #     :billing_address => AuthorizeNet::Address.new(:first_name => 'Jane', :last_name => 'Doe'),
     #     :subscription_id => '123456'
@@ -88,15 +87,15 @@ module AuthorizeNet::ARB
       set_fields(subscription.to_hash)
       run
     end
-    
+
     # Sets up and submits a subscription status query (ARBGetSubscriptionStatusRequest) transaction. Returns a response object (which contains the subscription status). If the transaction
     # has already been run, it will return nil.
-    # 
+    #
     # +subscription_id+:: Either the subscription id of the subscription to get the status of as a string, or a Subscription instance with a value for subscription_id set on it.
-    # 
-    # 
+    #
+    #
     # Typical usage:
-    # 
+    #
     #   response = transaction.get_status('123456')
     #   response.subscription_status    # A value from AuthorizeNet::ARB::Subscription::Status
     #
@@ -106,8 +105,8 @@ module AuthorizeNet::ARB
       run
     end
 
-    # Sets up and submits a subscription list query (ARBGetSubscriptionListRequest). Returns a response object 
-    # which contains the list of subscription details and the total number of subscriptions matching the search 
+    # Sets up and submits a subscription list query (ARBGetSubscriptionListRequest). Returns a response object
+    # which contains the list of subscription details and the total number of subscriptions matching the search
     # criteria. Sorting and Paging are optional parameters.
     #
     # Valid values for search type parameter:
@@ -117,35 +116,31 @@ module AuthorizeNet::ARB
     #    subscriptionInactive
     #
     # Typical usage:
-    # 
+    #
     #   sorting = AuthorizeNet::ARB::Sorting.new('name',true)
     #   paging = AuthorizeNet::ARB::Paging.new(1,1000)
     #   response = transaction.get_subscription_list('subscriptionActive',sorting,paging)
     #
     def get_subscription_list(search_type, sorting = nil, paging = nil)
       unless search_type.nil?
-        self.class.instance_variable_set(:@response_class,SubscriptionListResponse)
+        self.class.instance_variable_set(:@response_class, SubscriptionListResponse)
         @type = Type::ARB_GET_SUBSCRIPTION_LIST
-        set_fields(:search_type => search_type.to_s) 
-        unless sorting.nil?  
-          set_fields(sorting.to_hash) 
-        end
-        unless paging.nil?
-          set_fields(paging.to_hash) 
-        end
-      run
+        set_fields(search_type: search_type.to_s)
+        set_fields(sorting.to_hash) unless sorting.nil?
+        set_fields(paging.to_hash) unless paging.nil?
+        run
       end
-      return response
+      response
     end
-      
+
     # Sets up and submits a subscription cancelation (ARBCancelSubscriptionRequest) transaction. Returns a response object. If the transaction
     # has already been run, it will return nil.
-    # 
+    #
     # +subscription_id+:: Either the subscription id of the subscription to get the status of as a string, or a Subscription instance with a value for subscription_id set on it.
-    # 
-    # 
+    #
+    #
     # Typical usage:
-    # 
+    #
     #   response = transaction.cancel('123456')
     #
     def cancel(subscription_id)
@@ -153,25 +148,24 @@ module AuthorizeNet::ARB
       handle_subscription_id(subscription_id)
       run
     end
-        
+
     #:enddoc:
     protected
-    
+
     # Internal method to handle multiple types of subscription id arguments.
     def handle_subscription_id(subscription_id)
       case subscription_id
       when Subscription
-        set_fields(:subscription_id => subscription_id.subscription_id.to_s)
+        set_fields(subscription_id: subscription_id.subscription_id.to_s)
       else
-        set_fields(:subscription_id => subscription_id.to_s)
+        set_fields(subscription_id: subscription_id.to_s)
       end
     end
-    
+
     # An internal method that builds the POST body, submits it to the gateway, and constructs a Response object with the response.
     def make_request
-      set_fields(:reference_id => @reference_id)
+      set_fields(reference_id: @reference_id)
       super
     end
-    
   end
 end

data/lib/authorize_net/authorize_net.rb

@@ -2,12 +2,10 @@
 # The core AuthoizeNet module.
 # The entire SDK is name-spaced inside of this module.
 module AuthorizeNet
-  
   # Some type conversion routines that will be injected into our
   # Transaction/Response classes.
   module TypeConversions
-
-    API_FIELD_PREFIX = 'x_'
+    API_FIELD_PREFIX = 'x_'.freeze
 
     # Converts a value received from Authorize.Net into a boolean if
     # possible. This is designed to handle the wide range of boolean
@@ -22,7 +20,7 @@ module AuthorizeNet
         value
       end
     end
-    
+
     # Converts a boolean into an Authorize.Net boolean value string.
     # This is designed to handle the wide range of boolean formats that
     # Authorize.Net uses. If bool isn't a Boolean, its converted to a
@@ -35,32 +33,32 @@ module AuthorizeNet
         bool.to_s
       end
     end
-    
+
     # Converts a value received from Authorize.Net into a BigDecimal.
     def value_to_decimal(value)
       value = 0 if value == '' # Ruby 2.4+ does not accept ""
-      BigDecimal.new(value)
+      BigDecimal(value)
     end
-    
+
     # Converts a BigDecimal (or Float) into an Authorize.Net float value
     # string. If float isn't a BigDecimal (or Float), its converted to a
     # string and passed along.
     def decimal_to_value(float)
       case float
       when Float
-        "%0.2f" % float
+        format("%0.2f", float)
       when BigDecimal
         float.truncate(2).to_s('F')
       else
         float.to_s
       end
     end
-    
+
     # Converts a value received from Authorize.Net into a Date.
     def value_to_date(value)
       Date.strptime(value, '%Y-%m-%d')
     end
-    
+
     # Converts a Date (or DateTime, or Time) into an Authorize.Net date
     # value string. If date isn't a Date (or DateTime, or Time), its
     # converted to a string and passed along.
@@ -72,12 +70,12 @@ module AuthorizeNet
         date.to_s
       end
     end
-    
+
     # Converts a value received from Authorize.Net into a DateTime.
     def value_to_datetime(value)
       DateTime.strptime(value, '%Y-%m-%dT%H:%M:%S')
     end
-    
+
     # Converts a Date (or DateTime, or Time) into an Authorize.Net datetime
     # value string. If date isn't a Date (or DateTime, or Time), it's
     # converted to a string and passed along.
@@ -91,36 +89,36 @@ module AuthorizeNet
         datetime.to_s
       end
     end
-    
+
     # Converts a value received from Authorize.Net into an Integer.
     def value_to_integer(value)
       value.to_s.to_i
     end
-    
+
     # Converts an Integer into an Authorize.Net integer string.
     def integer_to_value(int)
       int.to_s
     end
-    
+
     # Converts a key value pair into a HTTP POST parameter. The key is
     # prefixed with key_prefix when being converted to a parameter name.
     def to_param(key, value, key_prefix = API_FIELD_PREFIX)
       key_str = "#{key_prefix}#{key}="
-      if value.kind_of?(Array)
+      if value.is_a?(Array)
         (value.collect do |v|
-          key_str + CGI::escape(v.to_s)
+          key_str + CGI.escape(v.to_s)
         end).join('&')
       else
-        key_str + CGI::escape(value.to_s)
+        key_str + CGI.escape(value.to_s)
       end
-    end 
-    
+    end
+
     # Converts an internal field name (Symbol) into an external field
     # name (Symbol) that can be consumed by the Authorize.Net API.
     def to_external_field(key)
       (API_FIELD_PREFIX + key.to_s).to_sym
     end
-    
+
     # Converts an external field name (Symbol) into an internal field
     # name (Symbol). This is the exact inverse of to_external_field.
     # Running to_internal_field(to_external_field(:foo)) would return
@@ -133,15 +131,12 @@ module AuthorizeNet
 
   # Provides some basic methods used by the various model classes.
   module Model
-
     # The constructor for models. Takes any of the supported attributes
     # as key/value pairs.
     def initialize(fields = {})
       fields.each do |k, v|
         method_name = (k.to_s + '=').to_sym
-        if self.respond_to?(method_name)
-          self.send(method_name, v)
-        end
+        send(method_name, v) if respond_to?(method_name)
       end
     end
 
@@ -155,7 +150,5 @@ module AuthorizeNet
     def handle_multivalue_hashing(obj)
       obj.to_a.collect(&:to_hash)
     end
-
   end
-
 end