mongoid-devise 1.0.1

data/CHANGELOG.rdoc

@@ -0,0 +1,333 @@
+== 1.0.1
+
+* enhancements
+  * HttpAuthenticatable is not added by default automatically.
+  * Avoid mass assignment error messages with current password.
+
+* bug fix
+  * Fixed encryptors autoload
+
+== 1.0.0
+
+* deprecation
+  * :old_password in update_with_password is deprecated, use :current_password instead
+
+* enhancements
+  * Added Registerable
+  * Added Http Basic Authentication support
+  * Allow scoped_views to be customized per controller/mailer class
+  * [#99] Allow authenticatable to used in change_table statements
+
+== 0.9.2
+
+* bug fix
+  * Ensure inactive user cannot sign in
+  * Ensure redirect to proper url after sign up
+
+* enhancements
+  * Added gemspec to repo
+  * Added token authenticatable (by github.com/grimen)
+
+== 0.9.1
+
+* bug fix
+  * Allow bigger salt size (by github.com/jgeiger)
+  * Fix relative url root
+
+== 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.com/grimen)
+
+* bug fix
+  * 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
+
+== 0.8.0
+
+* enhancements
+  * Warden 0.8.0 compatibility
+  * Add an easy for map.connect "sign_in", :controller => "sessions", :action => "new" to work
+  * Added :bcrypt encryptor (by github.com/capotej)
+
+* bug fix
+  * sign_in_count is also increased when user signs in via password change, confirmation, etc..
+  * More DataMapper compatibility (by github.com/lancecarlson)
+
+* deprecation
+  * Removed DeviseMailer.sender
+
+== 0.7.5
+
+* enhancements
+  * Set a default value for mailer to avoid find_template issues
+  * Add models configuration to MongoMapper::EmbeddedDocument as well
+
+== 0.7.4
+
+* enhancements
+  * Extract Activatable from Confirmable
+  * Decouple Serializers from Devise modules
+
+== 0.7.3
+
+* bug fix
+  * Give scope to the proper model validation
+
+* enhancements
+  * Mail views are scoped as well
+  * Added update_with_password for authenticatable
+  * Allow render_with_scope to accept :controller option
+
+== 0.7.2
+
+* deprecation
+  * Renamed reset_confirmation! to resend_confirmation!
+  * Copying locale is part of the installation process
+
+* bug fix
+  * Fixed render_with_scope to work with all controllers
+  * Allow sign in with two different users in Devise::TestHelpers
+
+== 0.7.1
+
+* enhancements
+  * Small enhancements for other plugins compatibility (by github.com/grimen)
+
+== 0.7.0
+
+* deprecations
+  * :authenticatable is not included by default anymore
+
+* enhancements
+  * Improve loading process
+  * Extract SessionSerializer from Authenticatable
+
+== 0.6.3
+
+* bug fix
+  * Added trackable to migrations
+  * Allow inflections to work
+
+== 0.6.2
+
+* enhancements
+  * More DataMapper compatibility
+  * Devise::Trackable - track sign in count, timestamps and ips
+
+== 0.6.1
+
+* enhancements
+  * Devise::Timeoutable - timeout sessions without activity
+  * DataMapper now accepts conditions
+
+== 0.6.0
+
+* deprecations
+  * :authenticatable is still included by default, but yields a deprecation warning
+
+* enhancements
+  * Added DataMapper support
+  * Remove store_location from authenticatable strategy and add it to failure app
+  * Allow a strategy to be placed after authenticatable
+  * [#45] Do not rely attribute? methods, since they are not added on Datamapper
+
+== 0.5.6
+
+* enhancements
+  * [#42] Do not send nil to build (DataMapper compatibility)
+  * [#44] Allow to have scoped views
+
+== 0.5.5
+
+* enhancements
+  * Allow overwriting find for authentication method
+  * [#38] Remove Ruby 1.8.7 dependency
+
+== 0.5.4
+
+* deprecations
+  * Deprecate :singular in devise_for and use :scope instead
+
+* enhancements
+  * [#37] Create after_sign_in_path_for and after_sign_out_path_for hooks to be
+    overwriten in ApplicationController
+  * Create sign_in_and_redirect and sign_out_and_redirect helpers
+  * Warden::Manager.default_scope is automatically configured to the first given scope
+
+== 0.5.3
+
+* bug fix
+  * MongoMapper now converts DateTime to Time
+  * Ensure all controllers are unloadable
+
+* enhancements
+  * [#35] Moved friendly_token to Devise
+  * Added Devise.all, so you can freeze your app strategies
+  * Added Devise.apply_schema, so you can turn it to false in Datamapper or MongoMapper
+    in cases you don't want it be handlded automatically
+
+== 0.5.2
+
+* enhancements
+  * [#28] Improved sign_in and sign_out helpers to accepts resources
+  * [#28] Added stored_location_for as a helper
+  * [#20] Added test helpers
+
+== 0.5.1
+
+* enhancements
+  * Added serializers based on Warden ones
+  * Allow authentication keys to be set
+
+== 0.5.0
+
+* bug fix
+  * Fixed a bug where remember me module was not working properly
+
+* enhancements
+  * Moved encryption strategy into the Encryptors module to allow several algorithms (by github.com/mhfs)
+  * Implemented encryptors for Clearance, Authlogic and Restful-Authentication (by github.com/mhfs)
+  * Added support for MongoMapper (by github.com/shingara)
+
+== 0.4.3
+
+* bug fix
+  * [#29] Authentication just fails if user cannot be serialized from session, without raising errors;
+  * Default configuration values should not overwrite user values;
+
+== 0.4.2
+
+* deprecations
+  * Renamed mail_sender to mailer_sender
+
+* enhancements
+  * skip_before_filter added in Devise controllers
+  * Use home_or_root_path on require_no_authentication as well
+  * Added devise_controller?, useful to select or reject filters in ApplicationController
+  * Allow :path_prefix to be given to devise_for
+  * Allow default_url_options to be configured through devise (:path_prefix => "/:locale" is now supported)
+
+== 0.4.1
+
+* bug fix
+  * [#21] Ensure options can be set even if models were not loaded
+
+== 0.4.0
+
+* deprecations
+  * Notifier is deprecated, use DeviseMailer instead. Remember to rename
+    app/views/notifier to app/views/devise_mailer and I18n key from
+    devise.notifier to devise.mailer
+  * :authenticable calls are deprecated, use :authenticatable instead
+
+* enhancements
+  * [#16] Allow devise to be more agnostic and do not require ActiveRecord to be loaded
+  * Allow Warden::Manager to be configured through Devise
+  * Created a generator which creates an initializer
+
+== 0.3.0
+
+* bug fix
+  * [#15] Allow yml messages to be configured by not using engine locales
+
+* deprecations
+  * Renamed confirm_in to confirm_within
+  * [#14] Do not send confirmation messages when user changes his e-mail
+  * [#13] Renamed authenticable to authenticatable and added deprecation warnings
+
+== 0.2.3
+
+* enhancements
+  * Ensure fail! works inside strategies
+  * [#12] Make unauthenticated message (when you haven't signed in) different from invalid message
+
+* bug fix
+  * Do not redirect on invalid authenticate
+  * Allow model configuration to be set to nil
+
+== 0.2.2
+
+* bug fix
+  * [#9] Fix a bug when using customized resources
+
+== 0.2.1
+
+* refactor
+  * Clean devise_views generator to use devise existing views
+
+* enhancements
+  * [#7] Create instance variables (like @user) for each devise controller
+  * Use Devise::Controller::Helpers only internally
+
+* bug fix
+  * [#6] Fix a bug with Mongrel and Ruby 1.8.6
+
+== 0.2.0
+
+* enhancements
+  * [#4] Allow option :null => true in authenticable migration
+  * [#3] Remove attr_accessible calls from devise modules
+  * Customizable time frame for rememberable with :remember_for config
+  * Customizable time frame for confirmable with :confirm_in config
+  * Generators for creating a resource and copy views
+
+* optimize
+  * Do not load hooks or strategies if they are not used
+
+* bug fixes
+  * [#2] Fixed requiring devise strategies
+
+== 0.1.1
+
+* bug fixes
+  * [#1] Fixed requiring devise mapping
+
+== 0.1.0
+
+* Devise::Authenticable
+* Devise::Confirmable
+* Devise::Recoverable
+* Devise::Validatable
+* Devise::Migratable
+* Devise::Rememberable
+
+* SessionsController
+* PasswordsController
+* ConfirmationsController
+
+* Create an example app
+* devise :all, :except => :rememberable
+* Use sign_in and sign_out in SessionsController
+
+* Mailer subjects namespaced by model
+* Allow stretches and pepper per model
+
+* Store session[:return_to] in session
+* Sign user in automatically after confirming or changing it's password

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009 Plataforma Tecnologia. http://blog.plataformatec.com.br
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,260 @@
+== 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:
+
+* 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
+
+All gems are on gemcutter, so you need to add gemcutter to your sources if you haven't yet:
+
+  sudo gem sources -a http://gemcutter.org/
+
+Install warden gem if you don't have it installed (requires 0.6.4 or higher):
+
+  sudo gem install warden
+
+Install devise gem:
+
+  sudo gem install devise
+
+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
+
+== 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 :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
+    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.authenticatable
+    t.lockable
+    t.trackable
+  end
+
+  # Inside your Admin model
+  devise :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 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
+
+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.
+
+== 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 in the CHANGELOG or do `git shortlog -s -n` in the cloned repository.
+
+== 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