authlogic 3.4.6 → 3.5.0

data/lib/authlogic/acts_as_authentic/persistence_token.rb

@@ -8,26 +8,26 @@ module Authlogic
           add_acts_as_authentic_module(Methods)
         end
       end
-      
+
       # Methods for the persistence token.
       module Methods
         def self.included(klass)
           klass.class_eval do
             extend ClassMethods
             include InstanceMethods
-            
+
             if respond_to?(:after_password_set) && respond_to?(:after_password_verification)
               after_password_set :reset_persistence_token
               after_password_verification :reset_persistence_token!, :if => :reset_persistence_token?
             end
-            
+
             validates_presence_of :persistence_token
             validates_uniqueness_of :persistence_token, :if => :persistence_token_changed?
-            
+
             before_validation :reset_persistence_token, :if => :reset_persistence_token?
           end
         end
-        
+
         # Class level methods for the persistence token.
         module ClassMethods
           # Resets ALL persistence tokens in the database, which will require all users to reauthenticate.
@@ -42,22 +42,23 @@ module Authlogic
             end while !records.blank?
           end
         end
-        
+
         # Instance level methods for the persistence token.
         module InstanceMethods
           # Resets the persistence_token field to a random hex value.
           def reset_persistence_token
             self.persistence_token = Authlogic::Random.hex_token
           end
-          
+
           # Same as reset_persistence_token, but then saves the record.
           def reset_persistence_token!
             reset_persistence_token
             save_without_session_maintenance(:validate => false)
           end
           alias_method :forget!, :reset_persistence_token!
-          
+
           private
+
             def reset_persistence_token?
               persistence_token.blank?
             end
@@ -65,4 +66,4 @@ module Authlogic
       end
     end
   end
-end
+end

data/lib/authlogic/acts_as_authentic/restful_authentication.rb

@@ -36,6 +36,7 @@ module Authlogic
         alias_method :transition_from_restful_authentication=, :transition_from_restful_authentication
 
         private
+
           def set_restful_authentication_config
             crypto_provider_key = act_like_restful_authentication ? :crypto_provider : :transition_from_crypto_providers
             self.send("#{crypto_provider_key}=", CryptoProviders::Sha1)
@@ -48,6 +49,7 @@ module Authlogic
 
       module InstanceMethods
         private
+
           def act_like_restful_authentication?
             self.class.act_like_restful_authentication == true
           end

data/lib/authlogic/acts_as_authentic/session_maintenance.rb

@@ -1,22 +1,26 @@
 module Authlogic
   module ActsAsAuthentic
-    # This is one of my favorite features that I think is pretty cool. It's things like this that make a library great
-    # and let you know you are on the right track.
+    # This is one of my favorite features that I think is pretty cool. It's
+    # things like this that make a library great and let you know you are on the
+    # right track.
     #
-    # Just to clear up any confusion, Authlogic stores both the record id and the persistence token in the session.
-    # Why? So stale sessions can not be persisted. It stores the id so it can quickly find the record, and the
-    # persistence token to ensure no sessions are stale. So if the persistence token changes, the user must log
-    # back in.
+    # Just to clear up any confusion, Authlogic stores both the record id and
+    # the persistence token in the session. Why? So stale sessions can not be
+    # persisted. It stores the id so it can quickly find the record, and the
+    # persistence token to ensure no sessions are stale. So if the persistence
+    # token changes, the user must log back in.
     #
-    # Well, the persistence token changes with the password. What happens if the user changes his own password?
-    # He shouldn't have to log back in, he's the one that made the change.
+    # Well, the persistence token changes with the password. What happens if the
+    # user changes his own password? He shouldn't have to log back in, he's the
+    # one that made the change.
     #
-    # That being said, wouldn't it be nice if their session and cookie information was automatically updated?
-    # Instead of cluttering up your controller with redundant session code. The same thing goes for new
+    # That being said, wouldn't it be nice if their session and cookie
+    # information was automatically updated? Instead of cluttering up your
+    # controller with redundant session code. The same thing goes for new
     # registrations.
     #
-    # That's what this module is all about. This will automatically maintain the cookie and session values as
-    # records are saved.
+    # That's what this module is all about. This will automatically maintain the
+    # cookie and session values as records are saved.
     module SessionMaintenance
       def self.included(klass)
         klass.class_eval do
@@ -24,11 +28,12 @@ module Authlogic
           add_acts_as_authentic_module(Methods)
         end
       end
-      
+
       module Config
-        # This is more of a convenience method. In order to turn off automatic maintenance of sessions just
-        # set this to false, or you can also set the session_ids method to a blank array. Both accomplish
-        # the same thing. This method is a little clearer in it's intentions though.
+        # This is more of a convenience method. In order to turn off automatic
+        # maintenance of sessions just set this to false, or you can also set
+        # the session_ids method to a blank array. Both accomplish the same
+        # thing. This method is a little clearer in it's intentions though.
         #
         # * <tt>Default:</tt> true
         # * <tt>Accepts:</tt> Boolean
@@ -36,9 +41,10 @@ module Authlogic
           rw_config(:maintain_sessions, value, true)
         end
         alias_method :maintain_sessions=, :maintain_sessions
-        
-        # As you may know, authlogic sessions can be separate by id (See Authlogic::Session::Base#id). You can
-        # specify here what session ids you want auto maintained. By default it is the main session, which has
+
+        # As you may know, authlogic sessions can be separate by id (See
+        # Authlogic::Session::Base#id). You can specify here what session ids
+        # you want auto maintained. By default it is the main session, which has
         # an id of nil.
         #
         # * <tt>Default:</tt> [nil]
@@ -47,8 +53,9 @@ module Authlogic
           rw_config(:session_ids, value, [nil])
         end
         alias_method :session_ids=, :session_ids
-        
-        # The name of the associated session class. This is inferred by the name of the model.
+
+        # The name of the associated session class. This is inferred by the name
+        # of the model.
         #
         # * <tt>Default:</tt> "#{klass.name}Session".constantize
         # * <tt>Accepts:</tt> Class
@@ -58,7 +65,7 @@ module Authlogic
         end
         alias_method :session_class=, :session_class
       end
-      
+
       module Methods
         def self.included(klass)
           klass.class_eval do
@@ -66,7 +73,7 @@ module Authlogic
             before_save :maintain_sessions, :if => :update_sessions?
           end
         end
-        
+
         # Save the record and skip session maintenance all together.
         def save_without_session_maintenance(*args)
           self.skip_session_maintenance = true
@@ -74,30 +81,36 @@ module Authlogic
           self.skip_session_maintenance = false
           result
         end
-        
+
         private
+
           def skip_session_maintenance=(value)
             @skip_session_maintenance = value
           end
-          
+
           def skip_session_maintenance
             @skip_session_maintenance ||= false
           end
-          
+
           def update_sessions?
-            !skip_session_maintenance && session_class && session_class.activated? && self.class.maintain_sessions == true && !session_ids.blank? && persistence_token_changed?
+            !skip_session_maintenance &&
+              session_class &&
+              session_class.activated? &&
+              self.class.maintain_sessions == true &&
+              !session_ids.blank? &&
+              persistence_token_changed?
           end
-          
+
           def get_session_information
             # Need to determine if we are completely logged out, or logged in as another user
             @_sessions = []
-            
+
             session_ids.each do |session_id|
               session = session_class.find(session_id, self)
               @_sessions << session if session && session.record
             end
           end
-          
+
           def maintain_sessions
             if @_sessions.empty?
               create_session
@@ -105,7 +118,7 @@ module Authlogic
               update_sessions
             end
           end
-          
+
           def create_session
             # We only want to automatically login into the first session, since this is the main session. The other sessions are sessions
             # that need to be created after logging into the main session.
@@ -114,7 +127,7 @@ module Authlogic
 
             return true
           end
-          
+
           def update_sessions
             # We found sessions above, let's update them with the new info
             @_sessions.each do |stale_session|
@@ -125,15 +138,15 @@ module Authlogic
 
             return true
           end
-          
+
           def session_ids
             self.class.session_ids
           end
-          
+
           def session_class
             self.class.session_class
           end
       end
     end
   end
-end
+end

data/lib/authlogic/acts_as_authentic/single_access_token.rb

@@ -1,7 +1,8 @@
 module Authlogic
   module ActsAsAuthentic
-    # This module is responsible for maintaining the single_access token. For more information the single access token and how to use it,
-    # see the Authlogic::Session::Params module.
+    # This module is responsible for maintaining the single_access token. For more
+    # information the single access token and how to use it, see the
+    # Authlogic::Session::Params module.
     module SingleAccessToken
       def self.included(klass)
         klass.class_eval do
@@ -9,13 +10,13 @@ module Authlogic
           add_acts_as_authentic_module(Methods)
         end
       end
-      
+
       # All configuration for the single_access token aspect of acts_as_authentic.
       module Config
-        # The single access token is used for authentication via URLs, such as a private feed. That being said,
-        # if the user changes their password, that token probably shouldn't change. If it did, the user would have
-        # to update all of their URLs. So be default this is option is disabled, if you need it, feel free to turn
-        # it on.
+        # The single access token is used for authentication via URLs, such as a private
+        # feed. That being said, if the user changes their password, that token probably
+        # shouldn't change. If it did, the user would have to update all of their URLs. So
+        # be default this is option is disabled, if you need it, feel free to turn it on.
         #
         # * <tt>Default:</tt> false
         # * <tt>Accepts:</tt> Boolean
@@ -24,37 +25,40 @@ module Authlogic
         end
         alias_method :change_single_access_token_with_password=, :change_single_access_token_with_password
       end
-      
+
       # All method, for the single_access token aspect of acts_as_authentic.
       module Methods
         def self.included(klass)
           return if !klass.column_names.include?("single_access_token")
-          
+
           klass.class_eval do
             include InstanceMethods
             validates_uniqueness_of :single_access_token, :if => :single_access_token_changed?
             before_validation :reset_single_access_token, :if => :reset_single_access_token?
-            after_password_set(:reset_single_access_token, :if => :change_single_access_token_with_password?) if respond_to?(:after_password_set)
+            if respond_to?(:after_password_set)
+              after_password_set(:reset_single_access_token, :if => :change_single_access_token_with_password?)
+            end
           end
         end
-        
+
         module InstanceMethods
           # Resets the single_access_token to a random friendly token.
           def reset_single_access_token
             self.single_access_token = Authlogic::Random.friendly_token
           end
-        
+
           # same as reset_single_access_token, but then saves the record.
           def reset_single_access_token!
             reset_single_access_token
             save_without_session_maintenance
           end
-      
+
           protected
+
             def reset_single_access_token?
               single_access_token.blank?
             end
-          
+
             def change_single_access_token_with_password?
               self.class.change_single_access_token_with_password == true
             end
@@ -62,4 +66,4 @@ module Authlogic
       end
     end
   end
-end
+end

data/lib/authlogic/acts_as_authentic/validations_scope.rb

@@ -9,7 +9,7 @@ module Authlogic
           extend Config
         end
       end
-      
+
       # All configuration for the scope feature.
       module Config
         # Allows you to scope everything to specific field(s). Works just like validates_uniqueness_of.
@@ -29,4 +29,4 @@ module Authlogic
       end
     end
   end
-end
+end

data/lib/authlogic/authenticates_many/association.rb

@@ -15,13 +15,13 @@ module Authlogic
     #   end
     class Association
       attr_accessor :klass, :find_options, :id
-      
+
       def initialize(klass, find_options, id)
         self.klass = klass
         self.find_options = find_options
         self.id = id
       end
-      
+
       [:create, :create!, :find, :new].each do |method|
         class_eval <<-"end_eval", __FILE__, __LINE__
           def #{method}(*args)
@@ -32,11 +32,12 @@ module Authlogic
         end_eval
       end
       alias_method :build, :new
-    
+
       private
+
         def scope_options
-          {:find_options => find_options, :id => id}
+          { :find_options => find_options, :id => id }
         end
     end
   end
-end
+end

data/lib/authlogic/authenticates_many/base.rb

@@ -1,6 +1,7 @@
 module Authlogic
-  # This allows you to scope your authentication. For example, let's say all users belong to an account, you want to make sure only users
-  # that belong to that account can actually login into that account. Simple, just do:
+  # This allows you to scope your authentication. For example, let's say all users belong
+  # to an account, you want to make sure only users that belong to that account can
+  # actually login into that account. Simple, just do:
   #
   #   class Account < ActiveRecord::Base
   #     authenticates_many :user_sessions
@@ -17,7 +18,8 @@ module Authlogic
   # You may also want to checkout Authlogic::ActsAsAuthentic::Scope to scope your model.
   module AuthenticatesMany
     module Base
-      # Allows you set essentially set up a relationship with your sessions. See module definition above for more details.
+      # Allows you set essentially set up a relationship with your sessions. See module
+      # definition above for more details.
       #
       # === Options
       #
@@ -25,18 +27,26 @@ module Authlogic
       #   This is the related session class.
       #
       # * <tt>relationship_name:</tt> default: options[:session_class].klass_name.underscore.pluralize,
-      #   This is the name of the relationship you want to use to scope everything. For example an Account has many Users. There should be a relationship
-      #   called :users that you defined with a has_many. The reason we use the relationship is so you don't have to repeat yourself. The relatonship
-      #   could have all kinds of custom options. So instead of repeating yourself we essentially use the scope that the relationship creates.
+      #   This is the name of the relationship you want to use to scope everything. For
+      #   example an Account has many Users. There should be a relationship called :users
+      #   that you defined with a has_many. The reason we use the relationship is so you
+      #   don't have to repeat yourself. The relationship could have all kinds of custom
+      #   options. So instead of repeating yourself we essentially use the scope that the
+      #   relationship creates.
       #
       # * <tt>find_options:</tt> default: nil,
-      #   By default the find options are created from the relationship you specify with :relationship_name. But if you want to override this and
-      #   manually specify find_options you can do it here. Specify options just as you would in ActiveRecord::Base.find.
+      #   By default the find options are created from the relationship you specify with
+      #   :relationship_name. But if you want to override this and manually specify
+      #   find_options you can do it here. Specify options just as you would in
+      #   ActiveRecord::Base.find.
       #
       # * <tt>scope_cookies:</tt> default: false
-      #   By the nature of cookies they scope theirself if you are using subdomains to access accounts. If you aren't using subdomains you need to have
-      #   separate cookies for each account, assuming a user is logging into mroe than one account. Authlogic can take care of this for you by
-      #   prefixing the name of the cookie and sessin with the model id. You just need to tell Authlogic to do this by passing this option.
+      #   By the nature of cookies they scope themselves if you are using subdomains to
+      #   access accounts. If you aren't using subdomains you need to have separate
+      #   cookies for each account, assuming a user is logging into mroe than one account.
+      #   Authlogic can take care of this for you by prefixing the name of the cookie and
+      #   sessin with the model id. You just need to tell Authlogic to do this by passing
+      #   this option.
       def authenticates_many(name, options = {})
         options[:session_class] ||= name.to_s.classify.constantize
         options[:relationship_name] ||= options[:session_class].klass_name.underscore.pluralize
@@ -51,4 +61,4 @@ module Authlogic
 
     ::ActiveRecord::Base.extend(Base) if defined?(::ActiveRecord)
   end
-end
+end

data/lib/authlogic/config.rb

@@ -1,4 +1,4 @@
-#encoding: utf-8
+# encoding: utf-8
 module Authlogic
   module Config
     def self.extended(klass)
@@ -9,6 +9,7 @@ module Authlogic
     end
 
     private
+
       # This is a one-liner method to write a config setting, read the config
       # setting, and also set a default value for the setting.
       def rw_config(key, value, default_value = nil)