public
Fork of technoweenie/restful-authentication
Description: Generates common user authentication code for Rails/Merb, with a full test/unit and rspec suite and optional Acts as State Machine support built-in.
Homepage: http://weblog.techno-weenie.net
Clone URL: git://github.com/b3b0p/restful-authentication.git
name age message
file README Sat Dec 08 13:11:37 -0800 2007 add a --stateful option (http://www.vaporbase.c... [technoweenie]
file Rakefile Tue Aug 01 11:32:04 -0700 2006 initial commit of the restful_authentication pl... [technoweenie]
directory generators/ Tue Jan 01 14:24:36 -0800 2008 fix tests to use updated session keys [technoweenie]
file install.rb Tue Aug 01 11:32:04 -0700 2006 initial commit of the restful_authentication pl... [technoweenie]
README
Restful Authentication Generator
====

This is a basic restful authentication generator for rails, taken 
from acts as authenticated.  Currently it requires Rails 1.2 (or 
edge).

To use:

  ./script/generate authenticated user sessions \
    --include-activation \
    --stateful

The first parameter specifies the model that gets created in signup
(typically a user or account model).  A model with migration is 
created, as well as a basic controller with the create method.

The second parameter specifies the sessions controller name.  This is
the controller that handles the actual login/logout function on the 
site.

The third parameter (--include-activation) generates the code for a 
ActionMailer and its respective Activation Code through email.

The fourth (--stateful) builds in support for acts_as_state_machine
and generates activation code.  This was taken from:

http://www.vaporbase.com/postings/stateful_authentication

You can pass --skip-migration to skip the user migration.

From here, you will need to add the resource routes in 
config/routes.rb.  

  map.resources :users
  map.resource  :session

If you're using acts_as_state_machine, define your users resource like this:

  map.resources :users, :member => { :suspend   => :put,
                                     :unsuspend => :put,
                                     :purge     => :delete }

If you're on rails 1.2.3 you may need to specify the controller name
for the session singular resource:

  map.resource :session, :controller => 'sessions'

Also, add an observer to config/environment.rb if you chose the 
--include-activation option

  config.active_record.observers = :user_observer # or whatever you 
                                                  # named your model

Security Alert
====

I introduced a change to the model controller that's been tripping 
folks up on Rails 2.0.  The change was added as a suggestion to help
combat session fixation attacks.  However, this resets the Form 
Authentication token used by Request Forgery Protection.  I've left
it out now, since Rails 1.2.6 and Rails 2.0 will both stop session
fixation attacks anyway.