devise_ennder 1.0.1.0.9

data/README.rdoc

@@ -0,0 +1,272 @@
+== Devise
+
+Devise is a flexible authentication solution for Rails based on Warden. It:
+
+* Is Rack based;
+* Is a complete MVC solution based on Rails engines;
+* 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 12 modules:
+
+* Database Authenticatable: responsible for encrypting password and validating authenticity of a user while signing in.
+* Token Authenticatable: validates authenticity of a user while signing in using an authentication token (also known as "single access token").
+* HttpAuthenticatable: sign in users using basic HTTP authentication.
+* Confirmable: responsible for verifying whether an account is already confirmed to sign in, and to send emails with confirmation instructions.
+* Recoverable: takes care of reseting the user password and send reset instructions.
+* Registerable: handles signing up users through a registration process.
+* Rememberable: manages generating and clearing token for remember the user from a saved cookie.
+* Trackable: tracks sign in count, timestamps and ip.
+* Timeoutable: expires sessions without activity in a certain period of time.
+* Validatable: creates all needed validations for email and password. It's totally optional, so you're able to to customize validations by yourself.
+* 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 .
+
+== Dependencies
+
+Devise is based on Warden (http://github.com/hassox/warden), a Rack Authentication Framework so you need to install it as a gem. Please ensure you have it installed in order to use devise (see installation below).
+
+== Installation
+
+Install warden gem if you don't have it installed:
+
+  gem install warden
+
+Install devise gem:
+
+  gem install devise --version=1.0.9
+
+Configure warden and devise gems inside your app:
+
+  config.gem 'warden'
+  config.gem 'devise'
+
+Run the generator:
+
+	ruby script/generate devise_install
+
+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
+
+If you want to use Devise with bundler on Rails 2.3, you need to follow the instructions here:
+
+  http://github.com/carlhuda/bundler/issues/issue/83
+
+== 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 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 with some modules, as outlined below:
+
+  class User < ActiveRecord::Base
+    devise :database_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.database_authenticatable
+    t.confirmable
+    t.recoverable
+    t.rememberable
+    t.trackable
+    t.timestamps
+  end
+
+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.
+
+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), :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', :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:
+
+  before_filter :authenticate_user!
+
+To verify if a user is signed in, you have the following helper:
+
+  user_signed_in?
+
+And to get the current signed in user this helper is available:
+
+  current_user
+
+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. 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, 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' }
+
+== 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, 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.database_authenticatable
+    t.lockable
+    t.trackable
+  end
+
+  # Inside your Admin model
+  devise :database_authenticatable, :trackable, :timeoutable, :lockable
+
+  # Inside your routes
+  map.devise_for :admin
+
+  # Inside your protected controller
+  before_filter :authenticate_admin!
+
+  # Inside your controllers and views
+  admin_signed_in?
+  current_admin
+  admin_session
+
+== Generators
+
+Devise comes with some generators to help you start:
+
+  ruby script/generate devise_install
+
+This will generate an initializer, with a description of all configuration values. You can also generate models through:
+
+  ruby script/generate devise Model
+
+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.
+
+== 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 database_authenticatable:
+
+  devise :database_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
+
+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.
+
+Devise uses flash messages to let users know if their login is successful or not. Devise expects your application to call 'flash[:notice]' and 'flash[:alert]' as appropriate.
+
+== I18n
+
+Devise uses flash messages with I18n with the flash keys :success and :failure. To customize your app, you can setup your locale file this way:
+
+  en:
+    devise:
+      sessions:
+        signed_in: 'Signed in successfully.'
+
+You can also create distinct messages based on the resource you've configured using the singular name given in routes:
+
+  en:
+    devise:
+      sessions:
+        user:
+          signed_in: 'Welcome user, you are signed in.'
+        admin:
+          signed_in: 'Hello admin!'
+
+Devise mailer uses the same pattern to create subject messages:
+
+  en:
+    devise:
+      mailer:
+        confirmation_instructions: 'Hello everybody!'
+        user:
+          confirmation_instructions: 'Hello User! Please confirm your email'
+          reset_password_instructions: 'Reset instructions'
+
+Take a look at our locale file to check all available messages.
+
+== Test helpers
+
+Devise includes some tests helpers for functional specs. To use them, you just need to include Devise::TestHelpers in your test class and use the sign_in and sign_out method. Such methods have the same signature as in controllers:
+
+  sign_in :user, @user   # sign_in(scope, resource)
+  sign_in @user          # sign_in(resource)
+
+  sign_out :user         # sign_out(scope)
+  sign_out @user         # sign_out(resource)
+
+You can include the Devise Test Helpers in all of your tests by adding the following to the bottom of your test/test_helper.rb or spec/spec_helper.rb file:
+
+  class ActionController::TestCase
+    include Devise::TestHelpers
+  end
+
+Do not use such helpers for integration tests like Cucumber, Webrat... Just fill in the form or explicitly set the user in session. For more tips, check the wiki (http://wiki.github.com/plataformatec/devise).
+
+== Migrating from other solutions
+
+Devise implements encryption strategies for Clearance, Authlogic and Restful-Authentication. To make use of it set the desired encryptor in the encryptor initializer config option. You might also need to rename your encrypted password and salt columns to match Devises's one (encrypted_password and password_salt).
+
+== Other ORMs
+
+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
+
+Please refer to TODO file.
+
+== Security
+
+Needless to say, security is extremely important to Devise. If you find yourself in a possible security issue with Devise, please go through the following steps, trying to reproduce the bug:
+
+1) Look at the source code a bit to find out whether your assumptions are correct;
+2) If possible, provide a way to reproduce the bug: a small app on Github or a step-by-step to reproduce;
+3) E-mail us or send a Github private message instead of using the normal issues;
+
+Being able to reproduce the bug is the first step to fix it. Thanks for your understanding.
+
+== Maintainers
+
+* José Valim (http://github.com/josevalim)
+* Carlos Antônio da Silva (http://github.com/carlosantoniodasilva)
+
+== Contributors
+
+We have a long running list of contributors. Check them all here:
+
+http://github.com/plataformatec/devise/contributors
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on
+GitHub or send an e-mail to the mailing list.
+
+http://github.com/plataformatec/devise/issues
+http://groups.google.com/group/plataformatec-devise
+
+MIT License. Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'devise', 'version')
+
+desc 'Default: run tests for all ORMs.'
+task :default => :pre_commit
+
+desc 'Run Devise tests for all ORMs.'
+task :pre_commit do
+  Dir[File.join(File.dirname(__FILE__), 'test', 'orm', '*.rb')].each do |file|
+    orm = File.basename(file).split(".").first
+    system "rake test DEVISE_ORM=#{orm}"
+  end
+end
+
+desc 'Run Devise unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for Devise.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Devise'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "devise_ennder"
+    s.version = '1.0.' + Devise::VERSION.dup
+    s.summary = "Flexible authentication solution for Rails with Warden, translated in FR"
+    s.email = "mel@ennder.fr"
+    s.homepage = "http://homo-agilis.ennder.fr"
+	s.description = "Flexible authentication solution for Rails with Warden, translated in FR by Ennder"
+    s.authors = ['José VALIM', 'Carlos ANTÔNIO', 'Jérôme BATAILLE']
+    s.files =  FileList["[A-Z]*", "{app,config,db,lib}/**/*", "rails/init.rb"]
+    s.add_dependency("warden", "~> 0.10.7")
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/TODO

@@ -0,0 +1,2 @@
+* Make test run with DataMapper
+* Extract Activatable tests from Confirmable

data/app/controllers/confirmations_controller.rb

@@ -0,0 +1,33 @@
+class ConfirmationsController < ApplicationController
+  include Devise::Controllers::InternalHelpers
+
+  # 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 :notice, :send_instructions
+      redirect_to new_session_path(resource_name)
+    else
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  def show
+    self.resource = resource_class.confirm_by_token(params[:confirmation_token])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :confirmed
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :new
+    end
+  end
+end

data/app/controllers/passwords_controller.rb

@@ -0,0 +1,41 @@
+class PasswordsController < ApplicationController
+  prepend_before_filter :require_no_authentication
+  include Devise::Controllers::InternalHelpers
+
+  # 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 :notice, :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
+    resource.reset_password_token = params[:reset_password_token]
+    render_with_scope :edit
+  end
+
+  # PUT /resource/password
+  def update
+    self.resource = resource_class.reset_password_by_token(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :updated
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :edit
+    end
+  end
+end

data/app/controllers/registrations_controller.rb

@@ -0,0 +1,62 @@
+class RegistrationsController < ApplicationController
+  prepend_before_filter :require_no_authentication, :only => [ :new, :create ]
+  prepend_before_filter :authenticate_scope!, :only => [:edit, :update, :destroy]
+  include Devise::Controllers::InternalHelpers
+
+  # GET /resource/sign_in
+  def new
+    build_resource
+    render_with_scope :new
+  end
+
+  # POST /resource/sign_up
+  def create
+    build_resource
+
+    if resource.save
+      set_flash_message :notice, :signed_up
+      sign_in_and_redirect(resource_name, resource)
+    else
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/edit
+  def edit
+    render_with_scope :edit
+  end
+
+  # PUT /resource
+  def update
+    if self.resource.update_with_password(params[resource_name])
+      set_flash_message :notice, :updated
+      redirect_to after_sign_in_path_for(self.resource)
+    else
+      render_with_scope :edit
+    end
+  end
+
+  # DELETE /resource
+  def destroy
+    begin
+       self.resource.destroy
+	rescue Exception => exception
+		#Ennder 2010-11
+		#New message
+		set_flash_message :error, t('devise.sessions.Could_not_destroy_resource') + ': ' + exception.message
+		render_with_scope :edit
+		return
+	end
+
+	set_flash_message :notice, :destroyed
+    sign_out_and_redirect(self.resource)
+  end
+
+  protected
+
+    # Authenticates the current scope and dup the resource
+    def authenticate_scope!
+      send(:"authenticate_#{resource_name}!")
+      self.resource = send(:"current_#{resource_name}").dup
+    end
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,42 @@
+class SessionsController < ApplicationController
+  prepend_before_filter :require_no_authentication, :only => [ :new, :create ]
+  include Devise::Controllers::InternalHelpers
+
+  # GET /resource/sign_in
+  def new
+    unless flash[:notice].present?
+      Devise::FLASH_MESSAGES.each do |message|
+        set_now_flash_message :alert, message if params.try(:[], message) == "true"
+      end
+    end
+
+    build_resource
+    render_with_scope :new
+  end
+
+  # POST /resource/sign_in
+  def create
+    if resource = authenticate(resource_name)
+      set_flash_message :notice, :signed_in
+      sign_in_and_redirect(resource_name, resource, true)
+    elsif [:custom, :redirect].include?(warden.result)
+      throw :warden, :scope => resource_name
+    else
+      set_now_flash_message :alert, (warden.message || :invalid)
+      clean_up_passwords(build_resource)
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/sign_out
+  def destroy
+    set_flash_message :notice, :signed_out if signed_in?(resource_name)
+    sign_out_and_redirect(resource_name)
+  end
+
+  protected
+
+    def clean_up_passwords(object)
+      object.clean_up_passwords if object.respond_to?(:clean_up_passwords)
+    end
+end

data/app/controllers/unlocks_controller.rb

@@ -0,0 +1,41 @@
+class UnlocksController < ApplicationController
+  prepend_before_filter :ensure_email_as_unlock_strategy
+  prepend_before_filter :require_no_authentication
+  include Devise::Controllers::InternalHelpers
+
+  # GET /resource/unlock/new
+  def new
+    build_resource
+    render_with_scope :new
+  end
+
+  # POST /resource/unlock
+  def create
+    self.resource = resource_class.send_unlock_instructions(params[resource_name])
+
+    if resource.errors.empty?
+      set_flash_message :notice, :send_instructions
+      redirect_to new_session_path(resource_name)
+    else
+      render_with_scope :new
+    end
+  end
+
+  # GET /resource/unlock?unlock_token=abcdef
+  def show
+    self.resource = resource_class.unlock_access_by_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 ensure_email_as_unlock_strategy
+    raise ActionController::UnknownAction unless resource_class.unlock_strategy_enabled?(:email)
+  end
+end

data/app/models/devise_mailer.rb

@@ -0,0 +1,68 @@
+class DeviseMailer < ::ActionMailer::Base
+  extend Devise::Controllers::InternalHelpers::ScopedViews
+
+  # Deliver confirmation instructions when the user is created or its email is
+  # updated, and also when confirmation is manually requested
+  def confirmation_instructions(record)
+    setup_mail(record, :confirmation_instructions)
+  end
+
+  # Deliver reset password instructions when manually requested
+  def reset_password_instructions(record)
+    setup_mail(record, :reset_password_instructions)
+  end
+
+  def unlock_instructions(record)
+    setup_mail(record, :unlock_instructions)
+  end
+
+  private
+
+    # Configure default email options
+    def setup_mail(record, key)
+      scope_name = Devise::Mapping.find_scope!(record)
+      mapping    = Devise.mappings[scope_name]
+
+      subject      translate(mapping, key)
+      from         mailer_sender(mapping)
+      recipients   record.email
+      sent_on      Time.now
+      content_type Devise.mailer_content_type
+      body         render_with_scope(key, mapping, mapping.name => record, :resource => record)
+    end
+
+    def render_with_scope(key, mapping, assigns)
+      if self.class.scoped_views
+        begin
+          render :file => "devise_mailer/#{mapping.as}/#{key}", :body => assigns
+        rescue ActionView::MissingTemplate
+          render :file => "devise_mailer/#{key}", :body => assigns
+        end
+      else
+        render :file => "devise_mailer/#{key}", :body => assigns
+      end
+    end
+
+    def mailer_sender(mapping)
+      if Devise.mailer_sender.is_a?(Proc)
+        block_args = mapping.name if Devise.mailer_sender.arity > 0
+        Devise.mailer_sender.call(block_args)
+      else
+        Devise.mailer_sender
+      end
+    end
+
+    # Setup subject namespaced by model. It means you're able to setup your
+    # messages using specific resource scope, or provide a default one.
+    # Example (i18n locale file):
+    #
+    #   en:
+    #     devise:
+    #       mailer:
+    #         confirmation_instructions: '...'
+    #         user:
+    #           confirmation_instructions: '...'
+    def translate(mapping, key)
+      I18n.t(:"#{mapping.name}.#{key}", :scope => [:devise, :mailer], :default => key)
+    end
+end

data/app/models/user.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+	# Include default devise modules. Others available are:
+	# :http_authenticatable, :token_authenticatable, :lockable, :timeoutable and :activatable
+	devise :registerable, :database_authenticatable, :confirmable, :recoverable,
+		   :rememberable, :trackable, :validatable
+
+	# Setup accessible (or protected) attributes for your model
+	attr_accessible :email, :password, :password_confirmation
+end

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

@@ -0,0 +1,14 @@
+<!-- TODO A TRADUIRE "Resend confirmation instructions" -->
+<h2>Renvoi des instructions de confirmation</h2>
+
+<% form_for resource_name, resource, :url => confirmation_path(resource_name) do |f| %>
+  <%= f.error_messages %>
+  <br/>
+  <p><%= f.label :email %></p>
+  <p><%= f.text_field :email %></p>
+
+  <!-- TODO A TRADUIRE "Resend confirmation instructions" -->
+  <p><%= f.submit "Renvoyer les instructions de confirmation" %></p>
+<% end %>
+
+<%= render :partial => "shared/devise_links" %>

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

@@ -0,0 +1,6 @@
+<p>Welcome <%= @resource.email %>!</p>
+
+<p><%= t("devise.registrations.confirm_link") %></p>
+
+<!-- TODO A TRADUIRE "Confirm my account" -->
+<p><%= link_to 'Confirmer mon inscription', confirmation_url(@resource, :confirmation_token => @resource.confirmation_token) %></p>

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

@@ -0,0 +1,8 @@
+<p>Hello <%= (@resource.username + ' : ') unless @resource.username.blank? %><%= @resource.email %>!</p>
+
+<p><%= t('devise.mailer.Someone_requested_change_password') %></p>
+
+<p><%= link_to t('devise.mailer.Change_my_password'), edit_password_url(@resource, :reset_password_token => @resource.reset_password_token) %></p>
+
+<p><%= t('devise.mailer.If_you_didnt_request_this') %></p>
+<p><%= t('devise.mailer.Your_password_wont_change_until') %></p>

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

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