h1. Clearance

Rails authentication with email & password, *and invitations*.

"We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8

h2. Wiki

Most information regarding Clearance is on the "Github Wiki":http://wiki.github.com/thoughtbot/clearance.

h2. Installation

Clearance is a Rails engine. It works with versions of Rails greater than 2.3.

In config/environment.rb:

<pre>
config.gem "tonkapark-clearance", 
  :lib     => 'clearance', 
  :source  => 'http://gems.github.com', 
  :version => '0.6.9.2'
</pre>

Vendor the gem:

<pre>
rake gems:install
rake gems:unpack
</pre>

Make sure the development database exists and run the generator:

@script/generate clearance@

A number of files will be created and instructions will be printed.

You may already have some of these files. Don't worry. You'll be asked if you want to overwrite them.

Run the migration:

@rake db:migrate@

Define a HOST constant in your environment files.
In config/clearance.yml:

<pre>
production:
  host: you_production_host.com
  do_not_reply: do_not_reply@you_production_host.com
  invitation_subject_line: An Invitation
  invitation_from_email: invitation@you_production_host.com
</pre>  
  
Define root_url to *something* in your config/routes.rb:

@map.root :controller => 'home'@

h2. Cucumber Features

As your app evolves, you want to know that authentication still works. Clearance's opinion is that you should test its integration with your app using "Cucumber":http://cukes.info/.

In config/environments/test.rb:

<pre>
config.gem 'webrat',
  :version => '= 0.4.4'
config.gem 'cucumber',
  :version => '= 0.3.0'
config.gem 'thoughtbot-factory_girl',
  :lib     => 'factory_girl',
  :source  => "http://gems.github.com", 
  :version => '1.2.1'
</pre>

Vendor the gems:

<pre>
rake gems:install RAILS_ENV=test
rake gems:unpack  RAILS_ENV=test
</pre>

We don't vendor nokogiri due to its native extensions, so install it normally on your machine:

@sudo gem install nokogiri@

Run the Cucumber generator (if you haven't already) and Clearance's feature generator:

<pre>
script/generate cucumber
script/generate clearance_features
</pre>

All of the files generated should be new with the exception of the features/support/paths.rb file. If you have not modified your paths.rb then you will be okay to replace it with this one. If you need to keep your paths.rb file then add these locations in your paths.rb manually:

<pre>
def path_to(page_name)
  case page_name
   ...
  when /the sign up page/i
   new_user_path
  when /the sign in page/i
   new_session_path
  when /the password reset request page/i
   new_password_path
  ...
end
</pre>

h2. Authors

Clearance was extracted out of "Hoptoad":http://hoptoadapp.com. We merged the authentication code from two of thoughtbot's clients' Rails apps and have since used it each time we need authentication. The following people have improved the library. Thank you!

Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov, Nick Quaranto, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey, Eloy Duran, Tim Pope, Mihai Anca, Mark Cornick, Shay Arnett, Joshua Clayton & Mustafa Ekim.

h2. Questions?

Ask the "mailing list":http://groups.google.com/group/thoughtbot-clearance

h2. Suggestions, Bugs, Refactoring?

Fork away and create a "Github Issue":http://github.com/thoughtbot/clearance/issues. Please don't send pull requests.