shingara-devise 0.4.3

data/CHANGELOG.rdoc

@@ -0,0 +1,119 @@
+* 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)
+
+== 0.4.3
+
+* bug fix
+  * [#29] Authentication fail if user cannot be serialized from session;
+  * 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,253 @@
+== 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 five mainly 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.
+* Recoverable: takes care of reseting the user password and send reset instructions.
+* Rememberable: manages generating and clearing token for remember the user from a saved cookie.
+* Validatable: creates all needed validations for email and password. It's totally optional, so you're able to to customize validations by yourself.
+
+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 instalation 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.5.2 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'
+
+And you're ready to go.
+
+== 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.
+
+Devise must be setted up within the model (or models) you want to use, and devise routes must be created inside your 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:
+
+  create_table :users do
+    t.authenticatable
+    t.confirmable
+    t.recoverable
+    t.rememberable
+    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 to have your authentication working:
+
+  class User < ActiveRecord::Base
+    devise
+  end
+
+This line adds devise authenticatable automatically for you inside your User class. 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.
+
+You could also include the other devise modules as below:
+
+  # Same as using only devise, authenticatable is activated by default
+  devise :authenticatable
+
+  # Include authenticatable + confirmable
+  devise :confirmable
+
+  # Include authenticatable + recoverable + rememberable
+  devise :recoverable, :rememberable
+
+  # Include all of them
+  devise :all
+
+  # Include all except recoverable
+  devise :all, :except => :recoverable
+
+Note that validations aren't added by default, so you're able to customize it. In order to have automatic validations working just include :validatable.
+
+== Model configuration
+
+In addition to :except, you can provide :pepper, :stretches, :confirm_within and :remember_for 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:
+
+  map.devise_for :users
+
+This is going to look inside you User model and create the needed routes:
+
+  # Session routes for Authenticatable (default)
+       new_user_session GET  /users/sign_in                    {:controller=>"sessions", :action=>"new"}
+           user_session POST /users/sign_in                    {:controller=>"sessions", :action=>"create"}
+   destroy_user_session GET  /users/sign_out                   {:controller=>"sessions", :action=>"destroy"}
+
+  # Password routes for Recoverable, if User model has :recoverable configured
+      new_user_password GET  /users/password/new(.:format)     {:controller=>"passwords", :action=>"new"}
+     edit_user_password GET  /users/password/edit(.:format)    {:controller=>"passwords", :action=>"edit"}
+          user_password PUT  /users/password(.:format)         {:controller=>"passwords", :action=>"update"}
+                        POST /users/password(.:format)         {:controller=>"passwords", :action=>"create"}
+
+  # Confirmation routes for Confirmable, if User model has :confirmable configured
+  new_user_confirmation GET  /users/confirmation/new(.:format) {:controller=>"confirmations", :action=>"new"}
+      user_confirmation GET  /users/confirmation(.:format)     {:controller=>"confirmations", :action=>"show"}
+                        POST /users/confirmation(.:format)     {:controller=>"confirmations", :action=>"create"}
+
+You can run the routes rake task to verify what routes are being created by devise.
+
+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 routes. The available :path_names are:
+
+  map.devise_for :users, :as => "usuarios", :path_names => { :sign_in => 'login', :sign_out => 'logout', :password => 'secret', :confirmation => 'verification' }
+
+Be sure to check devise_for documentation for detailed description.
+
+== Controller filters
+
+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. To do it so, you need to create e default root inside your routes for your application:
+
+  map.root :controller => 'home'
+
+You also need to setup default url options for the mailer, if you are using confirmable or recoverable. Here's is the configuration for development:
+
+  DeviseMailer.sender = "no-reply@yourapp.com"
+  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 the same authentication stuff, but not confirmation or password recovery. Just follow the same steps:
+
+  # Create a migration with the required fields
+  create_table :admins do |t|
+    t.authenticatable
+  end
+
+  # Inside your Admin model
+  devise :validatable
+
+  # 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.
+
+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:
+
+  ruby script/generate devise_views
+
+This is gonna copy all session, password, confirmation and mailer views to your app/views folder.
+
+== 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.
+
+== 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).
+
+== TODO
+
+Please refer to TODO file.
+
+== Contributors
+
+* José Valim (http://github.com/josevalim)
+* Carlos Antônio da Silva (http://github.com/carlosantoniodasilva)
+* Marcelo Silveira (http://github.com/mhfs)
+
+== 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,45 @@
+# encoding: UTF-8
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require File.join(File.dirname(__FILE__), 'lib', 'devise', 'version')
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test Devise.'
+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 = "shingara-devise"
+    s.version = Devise::VERSION
+    s.summary = "Flexible authentication solution for Rails with Warden"
+    s.email = "contact@plataformatec.com.br"
+    s.homepage = "http://github.com/plataformatec/devise"
+    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.5.2")
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/TODO

@@ -0,0 +1,5 @@
+* Devise::Timeoutable
+* Devise::TestHelper
+* Use request_ip in session cookies
+* Devise::BruteForceProtection
+* Devise::MagicColumns

data/app/controllers/confirmations_controller.rb

@@ -0,0 +1,33 @@
+class ConfirmationsController < ApplicationController
+  include Devise::Controllers::Helpers
+
+  # GET /resource/confirmation/new
+  def new
+    build_resource
+  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 :new
+    end
+  end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  def show
+    self.resource = resource_class.confirm!(:confirmation_token => params[:confirmation_token])
+
+    if resource.errors.empty?
+      sign_in(resource_name, resource)
+      set_flash_message :success, :confirmed
+      redirect_to home_or_root_path
+    else
+      render :new
+    end
+  end
+end

data/app/controllers/passwords_controller.rb

@@ -0,0 +1,41 @@
+class PasswordsController < ApplicationController
+  include Devise::Controllers::Helpers
+
+  before_filter :require_no_authentication
+
+  # GET /resource/password/new
+  def new
+    build_resource
+  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 :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]
+  end
+
+  # PUT /resource/password
+  def update
+    self.resource = resource_class.reset_password!(params[resource_name])
+
+    if resource.errors.empty?
+      sign_in(resource_name, resource)
+      set_flash_message :success, :updated
+      redirect_to home_or_root_path
+    else
+      render :edit
+    end
+  end
+end

data/app/controllers/sessions_controller.rb

@@ -0,0 +1,33 @@
+class SessionsController < ApplicationController
+  include Devise::Controllers::Helpers
+
+  before_filter :require_no_authentication, :only => [ :new, :create ]
+
+  # GET /resource/sign_in
+  def new
+    Devise::FLASH_MESSAGES.each do |message, type|
+      set_now_flash_message type, message if params.key?(message)
+    end
+    build_resource
+  end
+
+  # POST /resource/sign_in
+  def create
+    if authenticate(resource_name)
+      set_flash_message :success, :signed_in
+      redirect_back_or_to home_or_root_path
+    else
+      set_now_flash_message :failure, :invalid
+      build_resource
+      render :new
+    end
+  end
+
+  # GET /resource/sign_out
+  def destroy
+    set_flash_message :success, :signed_out if signed_in?(resource_name)
+    sign_out(resource_name)
+    redirect_to root_path
+  end
+
+end

data/app/models/devise_mailer.rb

@@ -0,0 +1,53 @@
+class DeviseMailer < ::ActionMailer::Base
+
+  # Sets who is sending the e-mail
+  def self.sender=(value)
+    @@sender = value
+  end
+
+  # Reads who is sending the e-mail
+  def self.sender
+    @@sender
+  end
+  self.sender = nil
+
+  # 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
+
+  private
+
+    # Configure default email options
+    def setup_mail(record, key)
+      mapping = Devise.mappings.values.find { |m| m.to == record.class }
+      raise "Invalid devise resource #{record}" unless mapping
+
+      subject      translate(mapping, key)
+      from         self.class.sender
+      recipients   record.email
+      sent_on      Time.now
+      content_type 'text/html'
+      body         mapping.name => record, :resource => record
+    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/views/confirmations/new.html.erb

@@ -0,0 +1,16 @@
+<h2>Resend confirmation instructions</h2>
+
+<% form_for resource_name, resource, :url => confirmation_path(resource_name) do |f| %>
+  <%= f.error_messages %>
+
+  <p><%= f.label :email %></p>
+  <p><%= f.text_field :email %></p>
+
+  <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 -%>

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

@@ -0,0 +1,5 @@
+Welcome <%= @resource.email %>!
+
+You can confirm your account through the link below:
+
+<%= link_to 'Confirm my account', confirmation_url(@resource, :confirmation_token => @resource.confirmation_token) %>

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

@@ -0,0 +1,8 @@
+Hello <%= @resource.email %>!
+
+Someone has requested a link to change your password, and you can do this through the link below.
+
+<%= link_to 'Change my password', edit_password_url(@resource, :reset_password_token => @resource.reset_password_token) %>
+
+If you didn't request this, please ignore this email.
+Your password won't change until you access the link above and create a new one.

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

@@ -0,0 +1,20 @@
+<h2>Change your password</h2>
+
+<% form_for resource_name, resource, :url => password_path(resource_name), :html => { :method => :put } do |f| %>
+  <%= f.error_messages %>
+  <%= f.hidden_field :reset_password_token %>
+
+  <p><%= f.label :password %></p>
+  <p><%= f.password_field :password %></p>
+
+  <p><%= f.label :password_confirmation %></p>
+  <p><%= f.password_field :password_confirmation %></p>
+
+  <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 -%>

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

@@ -0,0 +1,16 @@
+<h2>Forgot your password?</h2>
+
+<% form_for resource_name, resource, :url => password_path(resource_name) do |f| %>
+  <%= f.error_messages %>
+
+  <p><%= f.label :email %></p>
+  <p><%= f.text_field :email %></p>
+
+  <p><%= f.submit "Send me reset password instructions" %></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 -%>