devise 0.8.2 → 0.9.0

data/CHANGELOG.rdoc

@@ -1,15 +1,34 @@
+== 0.9.0
+
+* deprecation
+  * devise :all is deprecated
+  * :success and :failure flash messages are now :notice and :alert
+
+* enhancements
+  * Added devise lockable (by github.com/mhfs)
+  * Warden 0.9.0 compatibility
+  * Mongomapper 0.6.10 compatibility
+  * Added Devise.add_module as hooks for extensions (by github.com/grimen)
+  * Ruby 1.9.1 compatibility (by github.com/grimen)
+
+* bug fix
+  * Accept path prefix not starting with slash
+  * url helpers should rely on find_scope!
+
 == 0.8.2
 
 * enhancements
-  * Allow Devise.mailer_sender to be a proc (by github/grimen)
+  * Allow Devise.mailer_sender to be a proc (by github.com/grimen)
 
 * bug fix
-  * Fix bug with passenger, update is required to anyone deploying on passenger (by github/dvdpalm)
+  * Fix bug with passenger, update is required to anyone deploying on passenger (by github.com/dvdpalm)
 
 == 0.8.1
 
 * enhancements
   * Move salt to encryptors
+  * Devise::Lockable
+  * Moved view links into partial and I18n'ed them
 
 * bug fix
   * Bcrypt generator was not being loaded neither setting the proper salt

data/README.rdoc

@@ -7,7 +7,7 @@ Devise is a flexible authentication solution for Rails based on Warden. It:
 * Allows you to have multiple roles (or models/scopes) signed in at the same time;
 * Is based on a modularity concept: use just what you really need.
 
-Right now it's composed of six modules included by default when you invoke "devise :all" in your models:
+Right now it's composed of nine modules:
 
 * Authenticatable: responsible for encrypting password and validating authenticity of a user while signing in.
 * Confirmable: responsible for verifying whether an account is already confirmed to sign in, and to send emails with confirmation instructions.
@@ -15,11 +15,9 @@ Right now it's composed of six modules included by default when you invoke "devi
 * Rememberable: manages generating and clearing token for remember the user from a saved cookie.
 * Trackable: tracks sign in count, timestamps and ip.
 * Validatable: creates all needed validations for email and password. It's totally optional, so you're able to to customize validations by yourself.
-
-And it also includes the optional modules:
-
-* Activatable: if you need to activate accounts by other means, which are not through confirmation, use this module.
 * Timeoutable: expires sessions without activity in a certain period of time.
+* Lockable: takes care of locking an account based on the number of failed sign in attempts. Handles unlock via expire and email.
+* Activatable: if you need to activate accounts by other means, which are not through confirmation, use this module.
 
 There's an example application using Devise at http://github.com/plataformatec/devise_example .
 
@@ -50,15 +48,23 @@ Run the generator:
 
 	ruby script/generate devise_install
 
-And you're ready to go. The generator will install an initializer which describes Devise's configuration options. Be sure to take a look.
+And you're ready to go. The generator will install an initializer which describes ALL Devise's configuration options, so be sure to take a look at it and the documentation as well:
+
+  http://rdoc.info/projects/plataformatec/devise
 
 == Basic Usage
 
-This is a walkthrough with all steps you need to setup a devise resource, including model, migration, route files, and optional configuration. You can also check out the *Generators* section below to help you start.
+This is a walkthrough with all steps you need to setup a devise resource, including model, migration, route files, and optional configuration. You MUST also check out the *Generators* section below to help you start.
 
 Devise must be set up within the model (or models) you want to use, and devise routes must be created inside your config/routes.rb file.
 
-We're assuming here you want a User model. First of all you have to setup a migration with the following fields:
+We're assuming here you want a User model with some modules, as outlined below:
+
+  class User < ActiveRecord::Base
+    devise :authenticatable, :confirmable, :recoverable, :rememberable, :trackable, :validatable
+  end
+
+After you choose which modules to use, you need to setup your migrations. Luckily, devise has some helpers to save you from this boring work:
 
   create_table :users do |t|
     t.authenticatable
@@ -69,48 +75,22 @@ We're assuming here you want a User model. First of all you have to setup a migr
     t.timestamps
   end
 
-You may also want to add some indexes to improve performance:
-
-  add_index :your_table, :email
-  add_index :your_table, :confirmation_token    # for confirmable
-  add_index :your_table, :reset_password_token  # for recoverable
-
-Now let's setup a User model adding the devise line:
-
-  class User < ActiveRecord::Base
-    devise :all
-  end
-
-This will include the six default modules outlined at the beginning. You can exclude and remove any module at will:
-
-  # Include timeout configuration
-  devise :all, :timeoutable
-
-  # Remove validations
-  devise :all, :except => :validatable
-
 Remember that Devise don't rely on _attr_accessible_ or _attr_protected_ inside its modules, so be sure to setup what attributes are accessible or protected in your model.
 
-== Model configuration
-
-In addition to :except, you can provide :pepper, :stretches, :encryptor, :authentication_keys, :confirm_within, :remember_for and :timeout as options to devise method.
-
-All those options are described in "config/initializers/devise.rb", which is generated when you invoke `ruby script/generate devise_install` in your application root.
-
-== Routes
-
-The next step after setting up your model is to configure your routes for devise. You do this by opening up your config/routes.rb and adding:
+The next setup after setting up your model is to configure your routes. You do this by opening up your config/routes.rb and adding:
 
   map.devise_for :users
 
 This is going to look inside you User model and create a set of needed routes (you can see them by running `rake routes`).
 
-There are also some options available for configuring your routes, as :class_name (to set the class for that route), :as and :path_names, where the last two have the same meaning as in common routes. The available :path_names are:
+There are also some options available for configuring your routes, as :class_name (to set the class for that route), :path_prefix, :as and :path_names, where the last two have the same meaning as in common routes. The available :path_names are:
 
-  map.devise_for :users, :as => "usuarios", :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification' }
+  map.devise_for :users, :as => "usuarios", :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification', :unlock => 'unblock' }
 
 Be sure to check devise_for documentation for detailed description.
 
+After this steps, run your migrations, and you are ready to go! But don't finish reading, we still have a lot to tell you:
+
 == Controller filters and helpers
 
 Devise is gonna create some helpers to use inside your controllers and views. To setup a controller that needs user authentication, just add this before_filter:
@@ -129,32 +109,29 @@ You have also access to the session for this scope:
 
   user_session
 
-After signing in a user, confirming it's account or updating it's password, devise will look for a scoped root path to redirect. Example: For a :user resource, it will use user_root_path if it exists, otherwise default root_path will be used. To do it so, you need to create e default root inside your routes for your application:
+After signing in a user, confirming it's account or updating it's password, devise will look for a scoped root path to redirect. Example: For a :user resource, it will use user_root_path if it exists, otherwise default root_path will be used. This means that you need to set the root inside your routes:
 
   map.root :controller => 'home'
 
 You can also overwrite after_sign_in_path_for and after_sign_out_path_for to customize better your redirect hooks.
 
-Finally, if you are using confirmable or recoverable, you also need to setup default url options for the mailer in each environment. Here's is the configuration for config/environments/development.rb:
+Finally, you also need to setup default url options for the mailer in each environment. Here's is the configuration for config/environments/development.rb:
 
   config.action_mailer.default_url_options = { :host => 'localhost:3000' }
 
-== Views
-
-By default devise will use the same views for all scopes/roles you have. But what if you need so different views to each of them? Devise also has an easy way to accomplish it: just setup config,scoped_views to true inside your devise config file, and you will be able to have views based on scope like 'sessions/users/new' and 'sessions/admin/new'. If no view is found within the scope, Devise will fallback to the default view.
-
 == Tidying up
 
-Devise let's you setup as many roles as you want, so let's say you already have this User model and also want an Admin model with just authentication, trackable and timeoutable stuff and none of confirmation or password recovery. Just follow the same steps:
+Devise let's you setup as many roles as you want, so let's say you already have this User model and also want an Admin model with just authentication, trackable, lockable and timeoutable stuff and none of confirmation or password recovery. Just follow the same steps:
 
   # Create a migration with the required fields
   create_table :admins do |t|
     t.authenticatable
+    t.lockable
     t.trackable
   end
 
   # Inside your Admin model
-  devise :authenticatable, :trackable, :timeoutable
+  devise :authenticatable, :trackable, :timeoutable, :lockable
 
   # Inside your routes
   map.devise_for :admin
@@ -179,11 +156,23 @@ This will generate an initializer, with a description of all configuration value
 
 A model configured with all devise modules and attr_accessible for default fields will be created. The generator will also create the migration and configure your routes for devise.
 
-You can also copy devise views to your application, being able to modify them based on your needs. To do it so, run the following command:
+== Model configuration
+
+The devise method in your models also accept some options to configure its modules. For example, you can chose which encryptor to use in authenticatable:
+
+  devise :authenticatable, :confirmable, :recoverable, :encryptor => :bcrypt
+
+Besides :encryptor, you can provide :pepper, :stretches, :confirm_within, :remember_for, :timeout_in, :unlock_in and others. All those are describer in the initializer created when you invoke the devise_install generator describer above.
+
+== Views
+
+Since devise is an engine, it has all default views inside the gem. They are good to get you started, but you will want to customize them at some point. And Devise has a generator to make copy them all to your application:
 
   ruby script/generate devise_views
 
-This is gonna copy all session, password, confirmation and mailer views to your app/views folder.
+By default Devise will use the same views for all roles you have. But what if you need so different views to each of them? Devise also has an easy way to accomplish it: just setup config.scoped_views to true inside "config/initializers/devise.rb". 
+
+After doing so you will be able to have views based on the scope like 'sessions/users/new' and 'sessions/admin/new'. If no view is found within the scope, Devise will fallback to the default view.
 
 == I18n
 
@@ -240,8 +229,7 @@ Devise implements encryption strategies for Clearance, Authlogic and Restful-Aut
 
 == Other ORMs
 
-Devise was made to work from scratch with ActiveRecord. However it currently supports DataMapper and MongoMapper as well.
-To use it, just set Devise.orm or configure it in the initialization file (which is created with devise_install).
+Devise supports both ActiveRecord (default) and MongoMapper, and has experimental Datamapper supports (in a sense that Devise test suite does not run completely with Datamapper). To choose other ORM, you just need to configure it in the initializer file.
 
 == TODO
 
@@ -254,9 +242,7 @@ Please refer to TODO file.
 
 == Contributors
 
-* Marcelo Silveira (http://github.com/mhfs)
-* Cyril Mougel (http://github.com/shingara)
-* Jonas Grimfelt (http://github.com/grimen)
+We have a long running list of contributors. Check them in the CHANGELOG or do `git shortlog -s -n` in the cloned repository.
 
 == Bugs and Feedback
 

data/Rakefile

@@ -44,7 +44,7 @@ begin
     s.description = "Flexible authentication solution for Rails with Warden"
     s.authors = ['José Valim', 'Carlos Antônio']
     s.files =  FileList["[A-Z]*", "{app,config,generators,lib}/**/*", "init.rb"]
-    s.add_dependency("warden", "~> 0.8.1")
+    s.add_dependency("warden", "~> 0.9.0")
   end
 
   Jeweler::GemcutterTasks.new

data/TODO

@@ -1,6 +1,4 @@
-* Make test run with DataMapper (ActiveRecord, MongoMapper)
+* Make test run with DataMapper
 * Add Registerable support
 * Add http authentication support
-* Extract SessionSerializer tests from Authenticatable
-* Extract CookieSerializer tests from Authenticatable
 * Extract Activatable tests from Confirmable

data/app/controllers/confirmations_controller.rb

@@ -1,33 +1,22 @@
 class ConfirmationsController < ApplicationController
-  include Devise::Controllers::Helpers
-
-  # GET /resource/confirmation/new
-  def new
-    build_resource
-    render_with_scope :new
-  end
-
-  # POST /resource/confirmation
-  def create
-    self.resource = resource_class.send_confirmation_instructions(params[resource_name])
-
-    if resource.errors.empty?
-      set_flash_message :success, :send_instructions
-      redirect_to new_session_path(resource_name)
-    else
-      render_with_scope :new
-    end
-  end
+  include Devise::Controllers::InternalHelpers
+  include Devise::Controllers::Common
 
   # GET /resource/confirmation?confirmation_token=abcdef
   def show
     self.resource = resource_class.confirm!(:confirmation_token => params[:confirmation_token])
 
     if resource.errors.empty?
-      set_flash_message :success, :confirmed
+      set_flash_message :notice, :confirmed
       sign_in_and_redirect(resource_name, resource)
     else
       render_with_scope :new
     end
   end
+
+  protected
+
+    def send_instructions_with
+      :send_confirmation_instructions
+    end
 end

data/app/controllers/passwords_controller.rb

@@ -1,26 +1,9 @@
 class PasswordsController < ApplicationController
-  include Devise::Controllers::Helpers
+  include Devise::Controllers::InternalHelpers
+  include Devise::Controllers::Common
 
   before_filter :require_no_authentication
 
-  # GET /resource/password/new
-  def new
-    build_resource
-    render_with_scope :new
-  end
-
-  # POST /resource/password
-  def create
-    self.resource = resource_class.send_reset_password_instructions(params[resource_name])
-
-    if resource.errors.empty?
-      set_flash_message :success, :send_instructions
-      redirect_to new_session_path(resource_name)
-    else
-      render_with_scope :new
-    end
-  end
-
   # GET /resource/password/edit?reset_password_token=abcdef
   def edit
     self.resource = resource_class.new
@@ -33,10 +16,16 @@ class PasswordsController < ApplicationController
     self.resource = resource_class.reset_password!(params[resource_name])
 
     if resource.errors.empty?
-      set_flash_message :success, :updated
+      set_flash_message :notice, :updated
       sign_in_and_redirect(resource_name, resource)
     else
       render_with_scope :edit
     end
   end
+
+  protected
+
+    def send_instructions_with
+      :send_reset_password_instructions
+    end
 end

data/app/controllers/sessions_controller.rb

@@ -1,24 +1,24 @@
 class SessionsController < ApplicationController
-  include Devise::Controllers::Helpers
+  include Devise::Controllers::InternalHelpers
+  include Devise::Controllers::Common
 
   before_filter :require_no_authentication, :only => [ :new, :create ]
 
   # GET /resource/sign_in
   def new
     Devise::FLASH_MESSAGES.each do |message|
-      set_now_flash_message :failure, message if params.try(:[], message) == "true"
+      set_now_flash_message :alert, message if params.try(:[], message) == "true"
     end
-    build_resource
-    render_with_scope :new
+    super
   end
 
   # POST /resource/sign_in
   def create
-    if authenticate(resource_name)
-      set_flash_message :success, :signed_in
-      sign_in_and_redirect(resource_name)
+    if resource = authenticate(resource_name)
+      set_flash_message :notice, :signed_in
+      sign_in_and_redirect(resource_name, resource, true)
     else
-      set_now_flash_message :failure, warden.message || :invalid
+      set_now_flash_message :alert, warden.message || :invalid
       build_resource
       render_with_scope :new
     end
@@ -26,7 +26,7 @@ class SessionsController < ApplicationController
 
   # GET /resource/sign_out
   def destroy
-    set_flash_message :success, :signed_out if signed_in?(resource_name)
+    set_flash_message :notice, :signed_out if signed_in?(resource_name)
     sign_out_and_redirect(resource_name)
   end
 

data/app/controllers/unlocks_controller.rb

@@ -0,0 +1,22 @@
+class UnlocksController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+  include Devise::Controllers::Common
+
+  # GET /resource/unlock?unlock_token=abcdef
+  def show
+    self.resource = resource_class.unlock!(:unlock_token => params[:unlock_token])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :unlocked
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :new
+    end
+  end
+
+  protected
+
+    def send_instructions_with
+      :send_unlock_instructions
+    end
+end

data/app/models/devise_mailer.rb

@@ -11,6 +11,10 @@ class DeviseMailer < ::ActionMailer::Base
     setup_mail(record, :reset_password_instructions)
   end
 
+  def unlock_instructions(record)
+    setup_mail(record, :unlock_instructions)
+  end
+
   private
 
     # Configure default email options
@@ -40,7 +44,8 @@ class DeviseMailer < ::ActionMailer::Base
 
     def mailer_sender(mapping)
       if Devise.mailer_sender.is_a?(Proc)
-        Devise.mailer_sender.call(mapping.name)
+        block_args = mapping.name if Devise.mailer_sender.arity > 0
+        Devise.mailer_sender.call(*block_args)
       else
         Devise.mailer_sender
       end

data/app/views/confirmations/new.html.erb

@@ -9,8 +9,4 @@
   <p><%= f.submit "Resend confirmation instructions" %></p>
 <% end %>
 
-<%= link_to "Sign in", new_session_path(resource_name) %><br />
-
-<%- if devise_mapping.recoverable? %>
-  <%= link_to "Forgot password?", new_password_path(resource_name) %><br />
-<% end -%>
+<%= render :partial => "shared/devise_links" %>

data/app/views/devise_mailer/unlock_instructions.html.erb

@@ -0,0 +1,7 @@
+Hello <%= @resource.email %>!
+
+Your account has been locked due to an excessive amount of unsuccessful sign in attempts.
+
+Click the link below to unlock your account:
+
+<%= link_to 'Unlock my account', unlock_url(@resource, :unlock_token => @resource.unlock_token) %>

data/app/views/passwords/edit.html.erb

@@ -13,8 +13,4 @@
   <p><%= f.submit "Change my password" %></p>
 <% end %>
 
-<%= link_to "Sign in", new_session_path(resource_name) %><br />
-
-<%- if devise_mapping.confirmable? %>
-  <%= link_to "Didn't receive confirmation instructions?", new_confirmation_path(resource_name) %><br />
-<% end -%>
+<%= render :partial => "shared/devise_links" %>