Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Rails authentication with email & password.

This branch is 0 commits ahead and 15 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

Clearance

Rails authentication with email & password.

We have clearance, Clarence.

Clearance was extracted out of Hoptoad.

Help

Installation

Clearance is a Rails engine for Rails 3.

Include the gem in your Gemfile:

gem "clearance"

Make sure the development database exists, then run the generator:

rails generate clearance

This:

  • inserts Clearance::User into your User model
  • inserts Clearance::Authentication into your ApplicationController
  • creates a migration that either creates a users table or adds only missing columns

Use the 0.8.x series of Clearance if you have a Rails 2 app.

Usage

If you want to authenticate users for a controller action, use the authenticate method in a before_filter.

class WidgetsController < ApplicationController
  before_filter :authenticate
  def index
    @widgets = Widget.all
  end
end

Customizing

To change any of provided actions, subclass a Clearance controller...

class SessionsController < Clearance::SessionsController
  def new
    # my special new action
  end
  def url_after_create
    my_special_path
  end
end

and add your route in config/routes.rb:

resource :session, :controller => 'sessions'

See config/routes.rb for all the routes Clearance provides.

Actions that redirect (create, update, and destroy) in Clearance controllers can be overridden by re-defining url_after_(action) methods as seen above.

Optional Cucumber features

As your app evolves, you want to know that authentication still works. If you use Cucumber, run the Clearance features generator:

rails generate clearance_features

Edit your Gemfile to include:

gem 'factory_girl_rails'

Edit config/enviroments/test.rb to include the following:

config.action_mailer.default_url_options = { :host => 'localhost:3000' }

Then run your tests!

rake

Optional Formtastic views

Clearance can also generate Formtastic views:

rails generate clearance_views

Extensions

Clearance is intended to be small, simple, well-tested, and easy to extend. Check out some of the ways people have extended Clearance:

Credits

thoughtbot

Clearance is maintained and funded by thoughtbot, inc

Thank you to all the contributors!

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

License

Clearance is Copyright © 2009-2011 thoughtbot. It is free software, and may be redistributed under the terms specified in the LICENSE file.

Something went wrong with that request. Please try again.