shuber-authentication 1.0.0 → 1.0.1

data/CHANGELOG

@@ -1,3 +1,8 @@
+2009-01-09 - Sean Huber (shuber@huberry.com)
+  * Add authentication_options cattr_accessor
+  * Update README
+  * Add authentication_options cattr_accessor to models as well
+
 2009-01-08 - Sean Huber (shuber@huberry.com)
   * Clean up CHANGELOG
   * Convert to soft tabs

data/README.markdown

@@ -12,8 +12,12 @@ Installation
 	script/plugin install git://github.com/shuber/authentication.git
 
 
-Example
--------
+Usage
+-----
+
+### Model ###
+
+Simply call `uses_authentication` in your model like so:
 
 	class User < ActiveRecord::Base
 	  # Accepts an optional hash of options
@@ -23,59 +27,83 @@ Example
 	  #   :salt_field - (defaults to :salt)
 	  uses_authentication :login_field => :username
 	end
+
+A few helpful methods will now be available for your model:
+
+	# Class method that authenticates a user based on a login and password - returns a user instance or false
+	User.authenticate(login, password)
 	
-	class ApplicationController < ActionController::Base
-	  # Set optional authentication options here
-	  #   self.authentication_model = The model that uses authentication (defaults to 'User')
-	  #   self.unauthenticated_message = The error flash message to set when unauthenticated (defaults to 'Login to continue')
-	  #   self.unauthenticated_redirect_path = The path to redirect to when unauthenticated (can be a symbol of a method) (defaults to '/')
-	end
+	# Checks if the password passed to it matches the current user instance's password
+	authenticated?(password)
 	
+	# Checks if the current user instance's password has just been changed
+	password_changed?
+	
+	# Resets the password - will generate a new random password if one is not specified
+	reset_password(new_password = nil)
+	
+	# Resets the password and saves - will generate a new random password if one is not specified
+	reset_password!(new_password = nil)
+
+
+### Controller ###
+
+Simply add `before_filter :authentication_required` for any actions that require authentication. The `:model` will then be searched 
+for a record with the id found in the `session[options[:session_field]`. The result of that query is stored in a controller instance 
+method called `current_user`. If a record could not be found, the controller's `unauthenticated` instance method is called which simply 
+redirects with a flash message. You can overwrite this method to change this behavior.
+
 	class UsersController < ApplicationController
 	  before_filter :authentication_required, :only => [:index]
-	
+
 	  def index
-	    render :text => 'test'
+	    render :text => current_user.id.to_s
 	  end
-	end	
-
+	end
 
-Controller Methods
-------------------
+A few helpful instance methods are available for your controller:
 
 	# Returns the current user or nil if a user is not logged in
 	current_user
 	
-	# Checks if the current user is authenticated (optionaly accepts a block that is yielded when true)
+	# Checks if the current user is authenticated
 	logged_in?
 	
 	# Login a user
 	login(user)
 	
-	# A before filter to require authentication - redirects to the controller class's authentication_redirect_path if unauthenticated
-	authentication_required
-	
 	# Logout the current user
 	logout
 
+`current_user` and `logged_in?` are also helper methods so you can use them in your views.
 
-Model Methods
--------------
 
-	# Class method that authenticates a user based on a login and password - returns a user instance or false
-	User.authenticate(login, password)
+### Controller options ###
+
+Your controller has a class method called `authentication_options` which contains a hash with default options. You can change 
+these like so:
+
+	class ApplicationController < ActionController::Base
+	  self.authentication_options.merge!{ :message => 'You are not authenticated', :redirect_to => :new_session_path }
+	end
+
+The default controller authentication\_options are:
+
+	# The type of flash message to use when authentication fails. Defaults to :error.
+	:flash_type
 	
-	# Checks if the password passed to it matches the current user instance's password
-	authenticated?(password)
+	# The flash message to use when authentication fails. If set to false, no flash is set. Defaults to 'Login to continue'.
+	:message
 	
-	# Checks if the current user instance's password has just been changed
-	password_changed?
+	# The model to authenticate with. Defaults to 'User'
+	:model
 	
-	# Resets the password - will generate a new random password if one is not specified
-	reset_password(new_password = nil)
+	# The session field name to store the current_user's id. Defaults to "#{options[:model].to_s.underscore}_id".to_sym (e.g. :user_id)
+	:session_field
 	
-	# Resets the password and saves - will generate a new random password if one is not specified
-	reset_password!(new_password = nil)
+	# The path to redirect to if authentication fails. Accepts a string or a symbol representing an instance method to call. 
+	# Defaults to '/'
+	:redirect_to
 
 
 Contact

data/lib/huberry/authentication/controller_methods.rb

@@ -5,10 +5,13 @@ module Huberry
         base.class_eval do
           include InstanceMethods
           
-          cattr_accessor :authentication_model, :unauthenticated_message, :unauthenticated_redirect_path
-          self.authentication_model = 'User'
-          self.unauthenticated_message = 'Login to continue'
-          self.unauthenticated_redirect_path = '/'
+          cattr_accessor :authentication_options
+          self.authentication_options = {
+            :flash_type => :error, 
+            :model => 'User', 
+            :message => 'Login to continue', 
+            :redirect_to => '/' 
+          }
           
           attr_accessor :current_user
           helper_method :current_user, :logged_in?
@@ -25,35 +28,33 @@ module Huberry
           def find_current_user(force_query = false)
             if @queried_for_current_user.nil? || force_query
               @queried_for_current_user = true
-              self.current_user = self.class.authentication_model.to_s.constantize.find(session[:user_id]) rescue nil
+              self.current_user = self.class.authentication_options[:model].to_s.constantize.find(session[authentication_session_field]) rescue nil
             end
             self.current_user
           end
           
           def logged_in?
-            find_current_user if self.current_user.nil?
-            if self.current_user.nil?
-              block_given? ? nil : false
-            else
-              block_given? ? yield : true
-            end
+            !find_current_user.nil?
           end
           
           def login(user)
             self.current_user = user
-            session[:user_id] = user.id
+            session[authentication_session_field] = user.id
           end
           
           def logout
             self.current_user = nil
-            session[:user_id] = nil
+            session[authentication_session_field] = nil
+          end
+          
+          def authentication_session_field
+            self.class.authentication_options[:session_field] || "#{self.class.authentication_options[:model].to_s.underscore}_id".to_sym
           end
           
           def unauthenticated
             session[:return_to] = request.request_uri
-            flash[:error] = self.class.unauthenticated_message.to_s
-            redirect_to respond_to?(self.class.unauthenticated_redirect_path) ? send(self.class.unauthenticated_redirect_path) : self.class.unauthenticated_redirect_path.to_s
-            false
+            flash[self.class.authentication_options[:flash_type]] = self.class.authentication_options[:message] if self.class.authentication_options[:message]
+            redirect_to respond_to?(self.class.authentication_options[:redirect_to]) ? send(self.class.authentication_options[:redirect_to]) : self.class.authentication_options[:redirect_to].to_s
           end
       end
     end

data/lib/huberry/authentication/model_methods.rb

@@ -7,17 +7,19 @@ module Huberry
         extend ClassMethods
         include InstanceMethods
         
-        cattr_accessor :hashed_password_field, :login_field, :password_field, :salt_field
-        self.hashed_password_field = options[:hashed_password_field] || :hashed_password
-        self.login_field = options[:login_field] || :email
-        self.password_field = options[:password_field] || :password
-        self.salt_field = options[:salt_field] || :salt
+        cattr_accessor :authentication_options
+        self.authentication_options = {
+          :hashed_password_field => :hashed_password, 
+          :login_field => :email, 
+          :password_field => :password, 
+          :salt_field => :salt 
+        }.merge(options)
         
-        attr_accessor self.password_field, "#{self.password_field}_confirmation".to_sym
+        attr_accessor self.authentication_options[:password_field], "#{self.authentication_options[:password_field]}_confirmation".to_sym
         
-        validates_presence_of self.login_field
-        validates_presence_of self.password_field, :if => :password_required?
-        validates_confirmation_of self.password_field, :if => :password_required?
+        validates_presence_of self.authentication_options[:login_field]
+        validates_presence_of self.authentication_options[:password_field], :if => :password_required?
+        validates_confirmation_of self.authentication_options[:password_field], :if => :password_required?
         
         before_save :hash_password
         
@@ -27,7 +29,7 @@ module Huberry
     
     module ClassMethods
       def authenticate(login, password)
-        user = send("find_by_#{self.login_field}", login)
+        user = send("find_by_#{self.authentication_options[:login_field]}", login)
         user && user.authenticated?(password) ? user : false
       end
       
@@ -38,7 +40,7 @@ module Huberry
     
     module InstanceMethods
       def authenticated?(password)
-        send(self.class.hashed_password_field) == self.class.digest(password.to_s + send(self.class.salt_field).to_s)
+        send(self.class.authentication_options[:hashed_password_field]) == self.class.digest(password.to_s + send(self.class.authentication_options[:salt_field]).to_s)
       end
       
       def password_changed?
@@ -52,9 +54,9 @@ module Huberry
       
       def reset_password(new_password = nil)
         new_password = generate_salt[0..7] if new_password.blank?
-        send("#{self.class.salt_field}=", nil)
-        send("#{self.class.password_field}=", new_password)
-        send("#{self.class.password_field}_confirmation=", new_password)
+        send("#{self.class.authentication_options[:salt_field]}=", nil)
+        send("#{self.class.authentication_options[:password_field]}=", new_password)
+        send("#{self.class.authentication_options[:password_field]}_confirmation=", new_password)
         @password_changed = true
       end
       
@@ -71,13 +73,13 @@ module Huberry
         
         def hash_password
           if password_changed? || password_required?
-            send("#{self.class.salt_field}=", generate_salt) if send("#{self.class.salt_field}").blank?
-            send("#{self.class.hashed_password_field}=", self.class.digest(send(self.class.password_field).to_s + send(self.class.salt_field).to_s))
+            send("#{self.class.authentication_options[:salt_field]}=", generate_salt) if send("#{self.class.authentication_options[:salt_field]}").blank?
+            send("#{self.class.authentication_options[:hashed_password_field]}=", self.class.digest(send(self.class.authentication_options[:password_field]).to_s + send(self.class.authentication_options[:salt_field]).to_s))
           end
         end
         
         def password_required?
-          send(self.class.hashed_password_field).blank? || !send(self.class.password_field).blank?
+          send(self.class.authentication_options[:hashed_password_field]).blank? || !send(self.class.authentication_options[:password_field]).blank?
         end
     end
   end

data/test/_controller_test.rb

@@ -31,7 +31,10 @@ class ControllerTest < Test::Unit::TestCase
     @request    = ActionController::TestRequest.new
     @response   = ActionController::TestResponse.new
 
+    @controller.instance_variable_set('@_request', @request)
     @controller.instance_variable_set('@_session', @request.session)
+    
+    @controller.class.authentication_options.merge!(:session_field => nil, :message => 'Login to continue')
   end
   
   def teardown
@@ -48,13 +51,6 @@ class ControllerTest < Test::Unit::TestCase
     assert !@controller.send(:logged_in?)
   end
   
-  def test_logged_in_yields_block_on_true
-    assert_equal nil, @controller.send(:logged_in?) { 'some_value' }
-    
-    @controller.send :login, @user
-    assert_equal 'some_value', @controller.send(:logged_in?) { 'some_value' }
-  end
-  
   def test_current_user
     assert_nil @controller.send(:current_user)
     
@@ -68,9 +64,6 @@ class ControllerTest < Test::Unit::TestCase
   def test_should_require_login
     get :login_required
     assert_response :redirect
-    assert flash.has_key?(:error)
-    assert_equal @controller.unauthenticated_message, flash[:error]
-    assert_redirected_to '/'
   end
   
   def test_should_not_require_login
@@ -111,4 +104,26 @@ class ControllerTest < Test::Unit::TestCase
     assert_equal @controller.session[:return_to], '/login_required'
   end
   
+  def test_should_set_a_flash_message_when_unauthenticated
+    get :login_required
+    assert_equal @controller.class.authentication_options[:message], flash[@controller.class.authentication_options[:flash_type]]
+  end
+  
+  def test_not_should_set_a_flash_message_when_unauthenticated_if_message_is_false
+    @controller.class.authentication_options[:message] = false
+    get :login_required
+    assert_nil flash[@controller.class.authentication_options[:flash_type]]
+  end
+  
+  def test_should_redirect_when_unauthenticated
+    get :login_required
+    assert_redirected_to @controller.class.authentication_options[:redirect_to]
+  end
+  
+  def test_should_use_custom_session_field
+    @controller.class.authentication_options[:session_field] = :test
+    @request.session[:test] = @user.id
+    assert @controller.send(:logged_in?)
+  end
+  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: shuber-authentication
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Sean Huber
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-08 00:00:00 -08:00
+date: 2009-01-09 00:00:00 -08:00
 default_executable: 
 dependencies: []