devise 1.0.11 → 1.1.0

data/lib/generators/devise/templates/devise.rb

@@ -0,0 +1,142 @@
+# Use this hook to configure devise mailer, warden hooks and so forth. The first
+# four configuration values can also be set straight in your models.
+Devise.setup do |config|
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in DeviseMailer.
+  config.mailer_sender = "please-change-me@config-initializers-devise.com"
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = "Devise::Mailer"
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/<%= options[:orm] %>'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating an user. By default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating an user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # config.authentication_keys = [ :email ]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Basic Auth is enabled. True by default.
+  # config.http_authenticatable = true
+
+  # Set this to true to use Basic Auth for AJAX requests.  True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication
+  # config.http_authentication_realm = "Application"
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 10. If
+  # using other encryptors, it sets how many times you want the password re-encrypted.
+  config.stretches = 10
+
+  # Define which will be the encryption algorithm. Devise also supports encryptors
+  # from others authentication tools as :clearance_sha1, :authlogic_sha512 (then
+  # you should set stretches above to 20 for default behavior) and :restful_authentication_sha1
+  # (then you should set stretches to 10, and copy REST_AUTH_SITE_KEY to pepper)
+  config.encryptor = :bcrypt
+
+  # Setup a pepper to generate the encrypted password.
+  config.pepper = <%= ActiveSupport::SecureRandom.hex(64).inspect %>
+
+  # ==> Configuration for :confirmable
+  # The time you want to give your user to confirm his account. During this time
+  # he will be able to access your application without confirming. Default is nil.
+  # When confirm_within is zero, the user won't be able to sign in without confirming. 
+  # You can use this to let your user access some features of your application 
+  # without confirming the account, but blocking it after a certain period 
+  # (ie 2 days). 
+  # config.confirm_within = 2.days
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # If true, a valid remember token can be re-used between multiple browsers.
+  # config.remember_across_browsers = true
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # ==> Configuration for :validatable
+  # Range for password length
+  # config.password_length = 6..20
+
+  # Regex to use to validate the email address
+  # config.email_regexp = /^([\w\.%\+\-]+)@([\w\-]+\.)+([\w]{2,})$/i
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again.
+  # config.timeout_in = 10.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = true
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes.
+  # config.default_scope = :user
+
+  # Configure sign_out behavior. 
+  # By default sign_out is scoped (i.e. /users/sign_out affects only :user scope).
+  # In case of sign_out_all_scopes set to true any logout action will sign out all active scopes.
+  # config.sign_out_all_scopes = false
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists. Default is [:html]
+  # config.navigational_formats = [:html, :iphone]
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not (yet) supported by Devise,
+  # you can configure them inside the config.warden block. The example below
+  # allows you to setup OAuth, using http://github.com/roman/warden_oauth
+  #
+  # config.warden do |manager|
+  #   manager.oauth(:twitter) do |twitter|
+  #     twitter.consumer_secret = <YOUR CONSUMER SECRET>
+  #     twitter.consumer_key  = <YOUR CONSUMER KEY>
+  #     twitter.options :site => 'http://twitter.com'
+  #   end
+  #   manager.default_strategies(:scope => :user).unshift :twitter_oauth
+  # end
+end

data/lib/generators/devise/views_generator.rb

@@ -0,0 +1,63 @@
+module Devise
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views", __FILE__)
+      desc "Copies all Devise views to your application."
+
+      argument :scope, :required => false, :default => nil,
+                       :desc => "The scope to copy views to"
+
+      class_option :template_engine, :type => :string, :aliases => "-t", :default => "erb",
+                                     :desc => "Template engine for the views. Available options are 'erb' and 'haml'."
+
+      def copy_views
+        case options[:template_engine].to_s
+        when "haml"
+          verify_haml_existence
+          verify_haml_version
+          create_and_copy_haml_views
+        else
+          directory "devise", "app/views/#{scope || :devise}"
+        end
+      end
+
+    protected
+
+      def verify_haml_existence
+        begin
+          require 'haml'
+        rescue LoadError
+          say "HAML is not installed, or it is not specified in your Gemfile."
+          exit
+        end
+      end
+
+      def verify_haml_version
+        unless Haml.version[:major] == 2 and Haml.version[:minor] >= 3 or Haml.version[:major] >= 3
+          say "To generate HAML templates, you need to install HAML 2.3 or above."
+          exit
+        end
+      end
+
+      def create_and_copy_haml_views
+        require 'tmpdir'
+        html_root = "#{self.class.source_root}/devise"
+
+        Dir.mktmpdir("devise-haml.") do |haml_root|
+          Dir["#{html_root}/**/*"].each do |path|
+            relative_path = path.sub(html_root, "")
+            source_path   = (haml_root + relative_path).sub(/erb$/, "haml")
+
+            if File.directory?(path)
+              FileUtils.mkdir_p(source_path)
+            else
+              `html2haml -r #{path} #{source_path}`
+            end
+          end
+
+          directory haml_root, "app/views/#{scope || :devise}"
+        end
+      end
+    end
+  end
+end

data/lib/generators/devise_install_generator.rb

@@ -0,0 +1,4 @@
+# Remove this file after deprecation
+if caller.none? { |l| l =~ %r{lib/rails/generators\.rb:(\d+):in `lookup!'$} }
+  warn "[WARNING] `rails g devise_install` is deprecated, please use `rails g devise:install` instead."
+end

data/lib/generators/devise_views_generator.rb

@@ -0,0 +1,4 @@
+# Remove this file after deprecation
+if caller.none? { |l| l =~ %r{lib/rails/generators\.rb:(\d+):in `lookup!'$} }
+  warn "[WARNING] `rails g devise_views` is deprecated, please use `rails g devise:views` instead."
+end

data/lib/generators/mongoid/devise_generator.rb

@@ -0,0 +1,17 @@
+require 'generators/devise/orm_helpers'
+
+module Mongoid
+  module Generators
+    class DeviseGenerator < Rails::Generators::NamedBase
+      include Devise::Generators::OrmHelpers
+
+      def generate_model
+        invoke "mongoid:model", [name] unless model_exists?
+      end
+
+      def inject_devise_content
+        inject_into_file model_path, model_contents, :after => "include Mongoid::Document\n"
+      end
+    end
+  end
+end

data/test/controllers/helpers_test.rb

@@ -1,4 +1,4 @@
-require 'test/test_helper'
+require 'test_helper'
 require 'ostruct'
 
 class MockController < ApplicationController
@@ -11,16 +11,33 @@ class MockController < ApplicationController
   def path
     ''
   end
+
+  def index
+  end
+
+  def host_with_port
+    "test.host:3000"
+  end
+
+  def protocol
+    "http"
+  end
+
+  def script_name
+    ""
+  end
+
+  def symbolized_path_parameters
+    {}
+  end
 end
 
 class ControllerAuthenticableTest < ActionController::TestCase
   tests MockController
 
   def setup
-    @controller = MockController.new
     @mock_warden = OpenStruct.new
     @controller.env = { 'warden' => @mock_warden }
-    @controller.session = {}
   end
 
   test 'setup warden' do
@@ -109,22 +126,31 @@ class ControllerAuthenticableTest < ActionController::TestCase
     @controller.sign_out(User.new)
   end
 
+  test 'sign out everybody proxy to logout on warden' do
+    Devise.mappings.keys.each { |scope|
+      @mock_warden.expects(:user).with(scope).returns(true)
+    }
+
+    @mock_warden.expects(:logout).with(*Devise.mappings.keys).returns(true)
+    @controller.sign_out_all_scopes
+  end
+
   test 'stored location for returns the location for a given scope' do
     assert_nil @controller.stored_location_for(:user)
-    @controller.session[:"user.return_to"] = "/foo.bar"
+    @controller.session[:"user_return_to"] = "/foo.bar"
     assert_equal "/foo.bar", @controller.stored_location_for(:user)
   end
 
   test 'stored location for accepts a resource as argument' do
     assert_nil @controller.stored_location_for(:user)
-    @controller.session[:"user.return_to"] = "/foo.bar"
+    @controller.session[:"user_return_to"] = "/foo.bar"
     assert_equal "/foo.bar", @controller.stored_location_for(User.new)
   end
 
   test 'stored location cleans information after reading' do
-    @controller.session[:"user.return_to"] = "/foo.bar"
+    @controller.session[:"user_return_to"] = "/foo.bar"
     assert_equal "/foo.bar", @controller.stored_location_for(:user)
-    assert_nil @controller.session[:"user.return_to"]
+    assert_nil @controller.session[:"user_return_to"]
   end
 
   test 'after sign in path defaults to root path if none by was specified for the given scope' do
@@ -135,6 +161,14 @@ class ControllerAuthenticableTest < ActionController::TestCase
     assert_equal admin_root_path, @controller.after_sign_in_path_for(:admin)
   end
 
+  test 'after update path defaults to root path if none by was specified for the given scope' do
+    assert_equal root_path, @controller.after_update_path_for(:user)
+  end
+
+  test 'after update path defaults to the scoped root path' do
+    assert_equal admin_root_path, @controller.after_update_path_for(:admin)
+  end
+
   test 'after sign out path defaults to the root path' do
     assert_equal root_path, @controller.after_sign_out_path_for(:admin)
     assert_equal root_path, @controller.after_sign_out_path_for(:user)
@@ -142,7 +176,8 @@ class ControllerAuthenticableTest < ActionController::TestCase
 
   test 'sign in and redirect uses the stored location' do
     user = User.new
-    @controller.session[:"user.return_to"] = "/foo.bar"
+    @controller.session[:"user_return_to"] = "/foo.bar"
+    @mock_warden.expects(:user).with(:user).returns(nil)
     @mock_warden.expects(:set_user).with(user, :scope => :user).returns(true)
     @controller.expects(:redirect_to).with("/foo.bar")
     @controller.sign_in_and_redirect(user)
@@ -150,15 +185,18 @@ class ControllerAuthenticableTest < ActionController::TestCase
 
   test 'sign in and redirect uses the configured after sign in path' do
     admin = Admin.new
+    @mock_warden.expects(:user).with(:admin).returns(nil)
     @mock_warden.expects(:set_user).with(admin, :scope => :admin).returns(true)
     @controller.expects(:redirect_to).with(admin_root_path)
     @controller.sign_in_and_redirect(admin)
   end
 
-  test 'only redirect if skip is given' do
+  test 'sign in and redirect does not sign in again if user is already signed' do
     admin = Admin.new
+    @mock_warden.expects(:user).with(:admin).returns(admin)
+    @mock_warden.expects(:set_user).never
     @controller.expects(:redirect_to).with(admin_root_path)
-    @controller.sign_in_and_redirect(:admin, admin, true)
+    @controller.sign_in_and_redirect(admin)
   end
 
   test 'sign out and redirect uses the configured after sign out path' do
@@ -172,13 +210,4 @@ class ControllerAuthenticableTest < ActionController::TestCase
   test 'is not a devise controller' do
     assert_not @controller.devise_controller?
   end
-
-  test 'default url options are retrieved from devise' do
-    begin
-      Devise.default_url_options {{ :locale => I18n.locale }}
-      assert_equal({ :locale => :en }, @controller.send(:default_url_options))
-    ensure
-      Devise.default_url_options {{ }}
-    end
-  end
 end

data/test/controllers/internal_helpers_test.rb

@@ -1,4 +1,4 @@
-require 'test/test_helper'
+require 'test_helper'
 
 class MyController < ApplicationController
   include Devise::Controllers::InternalHelpers
@@ -7,35 +7,31 @@ end
 class HelpersTest < ActionController::TestCase
   tests MyController
 
-  test 'get resource name from request path' do
-    @request.path = '/users/session'
-    assert_equal :user, @controller.resource_name
+  def setup
+    @mock_warden = OpenStruct.new
+    @controller.request.env['warden'] = @mock_warden
+    @controller.request.env['devise.mapping'] = Devise.mappings[:user]
   end
 
-  test 'get resource name from specific request path' do
-    @request.path = '/admin_area/session'
-    assert_equal :admin, @controller.resource_name
+  test 'get resource name from env' do
+    assert_equal :user, @controller.resource_name
   end
 
-  test 'get resource class from request path' do
-    @request.path = '/users/session'
+  test 'get resource class from env' do
     assert_equal User, @controller.resource_class
   end
 
-  test 'get resource instance variable from request path' do
-    @request.path = '/admin_area/session'
-    @controller.instance_variable_set(:@admin, admin = Admin.new)
+  test 'get resource instance variable from env' do
+    @controller.instance_variable_set(:@user, admin = Admin.new)
     assert_equal admin, @controller.resource
   end
 
-  test 'set resource instance variable from request path' do
-    @request.path = '/admin_area/session'
-
+  test 'set resource instance variable from env' do
     admin = @controller.send(:resource_class).new
     @controller.send(:resource=, admin)
 
     assert_equal admin, @controller.send(:resource)
-    assert_equal admin, @controller.instance_variable_get(:@admin)
+    assert_equal admin, @controller.instance_variable_get(:@user)
   end
 
   test 'resources methods are not controller actions' do

data/test/controllers/url_helpers_test.rb

@@ -1,9 +1,9 @@
-require 'test/test_helper'
+require 'test_helper'
 
 class RoutesTest < ActionController::TestCase
   tests ApplicationController
 
-  def test_path_and_url(name, prepend_path=nil)
+  def assert_path_and_url(name, prepend_path=nil)
     @request.path = '/users/session'
     prepend_path = "#{prepend_path}_" if prepend_path
 
@@ -29,19 +29,30 @@ class RoutesTest < ActionController::TestCase
 
 
   test 'should alias session to mapped user session' do
-    test_path_and_url :session
-    test_path_and_url :session, :new
-    test_path_and_url :session, :destroy
+    assert_path_and_url :session
+    assert_path_and_url :session, :new
+    assert_path_and_url :session, :destroy
   end
 
   test 'should alias password to mapped user password' do
-    test_path_and_url :password
-    test_path_and_url :password, :new
-    test_path_and_url :password, :edit
+    assert_path_and_url :password
+    assert_path_and_url :password, :new
+    assert_path_and_url :password, :edit
   end
 
   test 'should alias confirmation to mapped user confirmation' do
-    test_path_and_url :confirmation
-    test_path_and_url :confirmation, :new
+    assert_path_and_url :confirmation
+    assert_path_and_url :confirmation, :new
+  end
+
+  test 'should alias unlock to mapped user unlock' do
+    assert_path_and_url :unlock
+    assert_path_and_url :unlock, :new
+  end
+
+  test 'should alias registration to mapped user registration' do
+    assert_path_and_url :registration
+    assert_path_and_url :registration, :new
+    assert_path_and_url :registration, :edit
   end
 end

data/test/devise_test.rb

@@ -1,8 +1,12 @@
-require 'test/test_helper'
+require 'test_helper'
 
 module Devise
-  def self.clean_warden_config!
-    @warden_config = nil
+  def self.yield_and_restore
+    @@warden_configured = nil
+    c, b = @@warden_config, @@warden_config_block
+    yield
+  ensure
+    @@warden_config, @@warden_config_block = c, b
   end
 end
 
@@ -20,28 +24,21 @@ class DeviseTest < ActiveSupport::TestCase
     end
   end
 
-  test 'warden manager configuration' do
-    config = Warden::Config.new
-    Devise.configure_warden(config)
-
-    assert_equal Devise::FailureApp, config.failure_app
-    assert_equal [:rememberable, :http_authenticatable, :token_authenticatable, :database_authenticatable], config.default_strategies
-    assert_equal :user, config.default_scope
-    assert config.silence_missing_strategies?
+  test 'stores warden configuration' do
+    assert_equal Devise::FailureApp, Devise.warden_config.failure_app
+    assert_equal :user, Devise.warden_config.default_scope
   end
 
   test 'warden manager user configuration through a block' do
-    begin
+    Devise.yield_and_restore do
       @executed = false
       Devise.warden do |config|
         @executed = true
         assert_kind_of Warden::Config, config
       end
 
-      Devise.configure_warden(Warden::Config.new)
+      Devise.configure_warden!
       assert @executed
-    ensure
-      Devise.clean_warden_config!
     end
   end
 
@@ -52,21 +49,15 @@ class DeviseTest < ActiveSupport::TestCase
     assert_not defined?(Devise::Models::Coconut)
     Devise::ALL.delete(:coconut)
 
-    assert_nothing_raised(Exception) { Devise.add_module(:banana, :strategy => true) }
-    assert_equal 1, Devise::STRATEGIES.select { |v| v == :banana }.size
+    assert_nothing_raised(Exception) { Devise.add_module(:banana, :strategy => :fruits) }
+    assert_equal :fruits, Devise::STRATEGIES[:banana]
     Devise::ALL.delete(:banana)
     Devise::STRATEGIES.delete(:banana)
 
     assert_nothing_raised(Exception) { Devise.add_module(:kivi, :controller => :fruits) }
-    assert_not_nil Devise::CONTROLLERS[:fruits]
-    assert_equal 1, Devise::CONTROLLERS[:fruits].select { |v| v == :kivi }.size
+    assert_equal :fruits, Devise::CONTROLLERS[:kivi]
     Devise::ALL.delete(:kivi)
-    Devise::CONTROLLERS.delete(:fruits)
-
-    assert_nothing_raised(Exception) { Devise.add_module(:carrot, :route => :vegetable) }
-    assert_equal 1, Devise::ROUTES.select { |v| v == :vegetable }.size
-    Devise::ALL.delete(:carrot)
-    Devise::ROUTES.delete(:vegetable)
+    Devise::CONTROLLERS.delete(:kivi)
 
     assert_nothing_raised(Exception) { Devise.add_module(:authenticatable_again, :model => 'devise/model/authenticatable') }
     assert defined?(Devise::Models::AuthenticatableAgain)

data/test/encryptors_test.rb

@@ -1,7 +1,6 @@
-gem 'bcrypt-ruby'
+require 'test_helper'
 
 class Encryptors < ActiveSupport::TestCase
-
   test 'should match a password created by authlogic' do
     authlogic = "b623c3bc9c775b0eb8edb218a382453396fec4146422853e66ecc4b6bc32d7162ee42074dcb5f180a770dc38b5df15812f09bbf497a4a1b95fe5e7d2b8eb7eb4"
     encryptor = Devise::Encryptors::AuthlogicSha512.digest('123mudar', 20, 'usZK_z_EAaF61Gwkw-ed', '')
@@ -24,7 +23,7 @@ class Encryptors < ActiveSupport::TestCase
     test "should have length #{value} for #{key.inspect}" do
       swap Devise, :encryptor => key do
         encryptor = Devise::Encryptors.const_get(key.to_s.classify)
-        assert_equal value, encryptor.digest('a', 4, encryptor.salt, nil).size
+        assert_equal value, encryptor.digest('a', 4, encryptor.salt(4), nil).size
       end
     end
   end