====== Clearance ======

Clearance is a Ruby gem that handles Rails authentication. It is intended for Rails developers who write tests.

It is written by [[http://thoughtbot.com | thoughtbot]], the authors of [[http://thoughtbot.com/projects/shoulda | Shoulda]] (testing framework), [[http://thoughtbot.com/projects/factory_girl | Factory Girl]] (test data for Ruby test suites), and [[http://thoughtbot.com/projects/paperclip | Paperclip]] (file uploads).

===== Installation =====

<code>$ sudo gem install thoughtbot-clearance -s http://gems.github.com</code>

===== Documentation =====

Documentation is actively maintained in Clearance's README.textile, which can be viewed online at Clearance's [[http://github.com/thoughtbot/clearance | Github page]].

===== End-User Features =====

Clearance includes by default the features that thoughtbot's clients regularly requested.

  * Register
  * Email confirmation
  * Encrypted password
  * Password recovery

===== Rails Developer Features =====

Clearance is opinionated about Rails best practices and how you will structure your Rails app. For example, it assumes that you will have a User model, and that you will be using [[http://api.rubyonrails.org/classes/ActiveRecord/Base.html#M001981 | attr_accessible]] in that User model.

  * Includes comprehensive [[http://github.com/aslakhellesoy/cucumber | Cucumber]] tests.
  * Authentication logic is encapsulated as a Rails Engine, keeping your application code clean.
  * signed_in? & current_user helper methods

Application controller example:

<code RUBY>class ApplicationController < ActionController::Base
  include Clearance::Authentication
end</code>

User model example:

<code RUBY>class User < ActiveRecord::Base
  include Clearance::User
end</code>

===== Feature requests & bug reports =====

Clearance's [[http://github.com/thoughtbot/clearance/issues | Github Issues]] queue is actively maintained by thoughtbot developers and other Clearance users.

===== Mailing List =====

There is a [[http://groups.google.com/group/thoughtbot-clearance | mailing list]] for questions about Clearance.