clearance 0.9.1 → 0.10.0

data/CHANGELOG.md

@@ -1,4 +1,23 @@
-0.8.9 (unreleased)
+0.10.0
+------------------
+
+* Lots of README cleanup
+* Better email validation regex
+* Removed email confirmation step, was mostly a hassle and can always be added back in
+  at the application level (instead of engine level) if necessary
+* Removed disable_with on forms since it does not allow IE users to submit forms. See more:
+
+  https://github.com/rails/jquery-ujs/issues#issue/30
+  http://bugs.jquery.com/ticket/7061
+
+0.9.x
+------------------
+
+Forgot to update the changelog in a while, this is going to be brief:
+
+* This release supports Rails 3, capybara, and shoulda 2.10+.
+
+0.8.9
 ------------------
 
 * Removed unnecessary db index. (Rich Thornett, doctorzaius)

data/README.md

@@ -8,7 +8,7 @@ Rails authentication with email & password.
 Help
 ----
 
-* [documentation](http://rdoc.info/projects/thoughtbot/clearance)
+* [documentation](http://rdoc.info/gems/clearance)
 * [#thoughtbot](irc://irc.freenode.net/thoughtbot) IRC channel on freenode
 * [mailing list](http://groups.google.com/group/thoughtbot-clearance)
 
@@ -20,27 +20,24 @@ Fork away and create a [Github Issue](http://github.com/thoughtbot/clearance/iss
 Installation
 ------------
 
-Clearance is a Rails engine. The latest stable version (0.8.8) works with versions of Rails 2.x.
+Clearance is a Rails engine for Rails 3.
 
-Install it as a gem however you like to install gems. Also, uninstall old versions:
+Use the [0.8.x](https://github.com/thoughtbot/clearance/tree/v0.8.8)
+series of Clearance if you have a Rails 2 app.
 
-    sudo gem uninstall thoughtbot-clearance
-    sudo gem uninstall clearance
-    sudo gem install clearance
+Include the gem in your Gemfile:
+
+    gem "clearance"
 
 Make sure the development database exists, then run the generator:
 
-    script/rails generate clearance
+    rails generate clearance
 
 This:
 
 * inserts Clearance::User into your User model
 * inserts Clearance::Authentication into your ApplicationController
-* created a migration that either creates a users table or adds only missing columns
-
-There is a release candidate which features Rails 3 support. To install this version:
-
-    gem install clearance --prerelease
+* creates a migration that either creates a users table or adds only missing columns
 
 Usage
 -----
@@ -111,6 +108,16 @@ Clearance has another generator to generate Formastic views:
 
 Its implementation is designed so other view styles (Haml?) can be generated.
 
+Extensions
+----------
+
+Clearance is intended to be small, simple, well-tested, and easy to extend.
+Check out some of the ways people have extended Clearance:
+
+* [Clearance HTTP Auth](https://github.com/karmi/clearance_http_auth)
+* [Clearance Twitter](https://github.com/thoughtbot/clearance-twitter)
+* [Clearance Admin](https://github.com/xenda/clearance-admin)
+
 Authors
 -------
 
@@ -118,11 +125,4 @@ Clearance was extracted out of [Hoptoad](http://hoptoadapp.com). We merged the
 authentication code from two of thoughtbot's client Rails apps and have since
 used it each time we needed 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, Jon Yurek, Anuj Dutta, Chad Pytel, Ben Orenstein, Bobby Wilson,
-Matthew Ford, Ryan McGeary, Claudio Poli, Joseph Holsten, Peter Haza,
-Ron Newman, and Rich Thornett.
+Thank you to all [the contributors](https://github.com/thoughtbot/clearance/contributors)!

data/VERSION

@@ -1 +1 @@
-0.9.1
+0.10.0

data/app/controllers/clearance/passwords_controller.rb

@@ -33,7 +33,6 @@ class Clearance::PasswordsController < ApplicationController
 
     if @user.update_password(params[:user][:password],
                              params[:user][:password_confirmation])
-      @user.confirm_email!
       sign_in(@user)
       flash_success_after_update
       redirect_to(url_after_update)

data/app/controllers/clearance/sessions_controller.rb

@@ -15,15 +15,9 @@ class Clearance::SessionsController < ApplicationController
       flash_failure_after_create
       render :template => 'sessions/new', :status => :unauthorized
     else
-      if @user.email_confirmed?
-        sign_in(@user)
-        flash_success_after_create
-        redirect_back_or(url_after_create)
-      else
-        ::ClearanceMailer.confirmation(@user).deliver
-        flash_notice_after_create
-        redirect_to(sign_in_url)
-      end
+      sign_in(@user)
+      flash_success_after_create
+      redirect_back_or(url_after_create)
     end
   end
 
@@ -45,13 +39,6 @@ class Clearance::SessionsController < ApplicationController
     flash[:success] = translate(:signed_in, :default =>  "Signed in.")
   end
 
-  def flash_notice_after_create
-    flash[:notice] = translate(:unconfirmed_email,
-      :scope   => [:clearance, :controllers, :sessions],
-      :default => "User has not confirmed email. " <<
-                  "Confirmation email will be resent.")
-  end
-
   def url_after_create
     '/'
   end

data/app/controllers/clearance/users_controller.rb

@@ -13,6 +13,7 @@ class Clearance::UsersController < ApplicationController
     @user = ::User.new params[:user]
     if @user.save
       flash_notice_after_create
+      sign_in(@user)
       redirect_to(url_after_create)
     else
       render :template => 'users/new'
@@ -24,8 +25,7 @@ class Clearance::UsersController < ApplicationController
   def flash_notice_after_create
     flash[:notice] = translate(:deliver_confirmation,
       :scope   => [:clearance, :controllers, :users],
-      :default => "You will receive an email within the next few minutes. " <<
-                  "It contains instructions for confirming your account.")
+      :default => "You are now signed up.")
   end
 
   def url_after_create

data/app/models/clearance_mailer.rb

@@ -1,5 +1,4 @@
 class ClearanceMailer < ActionMailer::Base
-
   def change_password(user)
     @user = user
     from       Clearance.configuration.mailer_sender
@@ -8,14 +7,4 @@ class ClearanceMailer < ActionMailer::Base
                       :scope   => [:clearance, :models, :clearance_mailer],
                       :default => "Change your password")
   end
-
-  def confirmation(user)
-    @user = user
-    from       Clearance.configuration.mailer_sender
-    recipients @user.email
-    subject    I18n.t(:confirmation,
-                      :scope   => [:clearance, :models, :clearance_mailer],
-                      :default => "Account confirmation")
-  end
-
 end

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

@@ -18,6 +18,6 @@
     <%= form.password_field :password_confirmation %>
   </div>
   <div class="submit_field">
-    <%= form.submit "Save this password", :disable_with => "Please wait..." %>
+    <%= form.submit "Save this password" %>
   </div>
 <% end %>

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

@@ -10,6 +10,6 @@
     <%= form.text_field :email %>
   </div>
   <div class="submit_field">
-    <%= form.submit "Reset password", :disable_with => "Please wait..." %>
+    <%= form.submit "Reset password" %>
   </div>
 <% end %>

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

@@ -10,7 +10,7 @@
     <%= form.password_field :password %>
   </div>
   <div class="submit_field">
-    <%= form.submit "Sign in", :disable_with => "Please wait..." %>
+    <%= form.submit "Sign in" %>
   </div>
 <% end %>
 

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

@@ -2,5 +2,5 @@
 
 <%= form_for @user do |form| %>
   <%= render :partial => '/users/form', :object => form %>
-  <%= form.submit 'Sign up', :disable_with => 'Please wait...' %>
+  <%= form.submit 'Sign up' %>
 <% end %>

data/clearance.gemspec

@@ -18,13 +18,11 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
-    "app/controllers/clearance/confirmations_controller.rb",
     "app/controllers/clearance/passwords_controller.rb",
     "app/controllers/clearance/sessions_controller.rb",
     "app/controllers/clearance/users_controller.rb",
     "app/models/clearance_mailer.rb",
     "app/views/clearance_mailer/change_password.html.erb",
-    "app/views/clearance_mailer/confirmation.html.erb",
     "app/views/passwords/edit.html.erb",
     "app/views/passwords/new.html.erb",
     "app/views/sessions/new.html.erb",
@@ -94,13 +92,7 @@ Gem::Specification.new do |s|
     "spec/rails_root/config/initializers/session_store.rb",
     "spec/rails_root/config/locales/en.yml",
     "spec/rails_root/config/routes.rb",
-    "spec/rails_root/db/schema.rb",
     "spec/rails_root/doc/README_FOR_APP",
-    "spec/rails_root/features/password_reset.feature",
-    "spec/rails_root/features/sign_in.feature",
-    "spec/rails_root/features/sign_out.feature",
-    "spec/rails_root/features/sign_up.feature",
-    "spec/rails_root/features/step_definitions/clearance_steps.rb",
     "spec/rails_root/features/step_definitions/web_steps.rb",
     "spec/rails_root/features/support/env.rb",
     "spec/rails_root/features/support/paths.rb",
@@ -128,7 +120,6 @@ Gem::Specification.new do |s|
     "spec/rails_root/vendor/plugins/dynamic_form/test/dynamic_form_i18n_test.rb",
     "spec/rails_root/vendor/plugins/dynamic_form/test/dynamic_form_test.rb",
     "spec/rails_root/vendor/plugins/dynamic_form/test/test_helper.rb",
-    "test/controllers/confirmations_controller_test.rb",
     "test/controllers/passwords_controller_test.rb",
     "test/controllers/sessions_controller_test.rb",
     "test/controllers/users_controller_test.rb",
@@ -196,7 +187,8 @@ Gem::Specification.new do |s|
   ]
 
   s.add_dependency('rails', '~>3.0.0')
-  s.add_development_dependency('rspec', [">= 1.3.0"])
+  s.add_development_dependency('rspec', '~> 1.3.0')
+  s.add_development_dependency('cucumber', '0.10.0')
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/config/routes.rb

@@ -11,10 +11,6 @@ Rails.application.routes.draw do
     resource :password,
       :controller => 'clearance/passwords',
       :only       => [:create, :edit, :update]
-
-    resource :confirmation,
-      :controller => 'clearance/confirmations',
-      :only       => [:new, :create]
   end
 
   match 'sign_up'  => 'clearance/users#new', :as => 'sign_up'

data/lib/clearance/shoulda_macros.rb

@@ -16,16 +16,8 @@ module Clearance
     end
 
     def should_be_signed_in_and_email_confirmed_as(&block)
-      warn "[DEPRECATION] should_be_signed_in_and_email_confirmed_as: questionable usefulness"
+      warn "[DEPRECATION] should_be_signed_in_and_email_confirmed_as: email confirmation is gone"
       should_be_signed_in_as &block
-
-      should "have confirmed email" do
-        user = block.bind(self).call
-
-        assert_not_nil user
-        assert_equal user, assigns(:user)
-        assert assigns(:user).email_confirmed?
-      end
     end
 
     def should_not_be_signed_in

data/lib/clearance/user.rb

@@ -50,7 +50,7 @@ module Clearance
         model.class_eval do
           validates_presence_of     :email, :unless => :email_optional?
           validates_uniqueness_of   :email, :case_sensitive => false, :allow_blank => true
-          validates_format_of       :email, :with => %r{.+@.+\..+}, :allow_blank => true
+          validates_format_of       :email, :with => %r{^[a-z0-9!#\$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#\$%&'*+\/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$}i, :allow_blank => true
 
           validates_presence_of     :password, :unless => :password_optional?
           validates_confirmation_of :password
@@ -66,9 +66,7 @@ module Clearance
         model.class_eval do
           before_save   :initialize_salt,
                         :encrypt_password
-          before_create :generate_confirmation_token,
-                        :generate_remember_token
-          after_create  :send_confirmation_email, :unless => :email_confirmed?
+          before_create :generate_remember_token
         end
       end
     end
@@ -101,16 +99,6 @@ module Clearance
         save(:validate => false)
       end
 
-      # Confirm my email.
-      #
-      # @example
-      #   user.confirm_email!
-      def confirm_email!
-        self.email_confirmed    = true
-        self.confirmation_token = nil
-        save(:validate => false)
-      end
-
       # Mark my account as forgotten password.
       #
       # @example
@@ -183,10 +171,6 @@ module Clearance
         # warn "[DEPRECATION] password_required?: use !password_optional? instead"
         !password_optional?
       end
-
-      def send_confirmation_email
-        ClearanceMailer.confirmation(self).deliver
-      end
     end
 
     module ClassMethods

data/lib/rails/generators/clearance_features_templates/features/password_reset.feature

@@ -16,6 +16,9 @@ Feature: Password reset
 
     Scenario: User is signed up updated his password and types wrong confirmation
       Given I signed up with "email@person.com/password"
+      And I go to the password reset request page
+      And I fill in "Email address" with "email@person.com"
+      And I press "Reset password"
       When I follow the password reset link sent to "email@person.com"
       And I update my password with "newpassword/wrongconfirmation"
       Then I should see an error message
@@ -23,6 +26,9 @@ Feature: Password reset
 
     Scenario: User is signed up and updates his password
       Given I signed up with "email@person.com/password"
+      And I go to the password reset request page
+      And I fill in "Email address" with "email@person.com"
+      And I press "Reset password"
       When I follow the password reset link sent to "email@person.com"
       And I update my password with "newpassword/newpassword"
       Then I should be signed in

data/lib/rails/generators/clearance_features_templates/features/sign_in.feature

@@ -10,26 +10,18 @@ Feature: Sign in
       Then I should see "Bad email or password"
       And I should be signed out
 
-    Scenario: User is not confirmed
-      Given I signed up with "email@person.com/password"
-      When I go to the sign in page
-      And I sign in as "email@person.com/password"
-      Then I should see "User has not confirmed email"
-      And I should be signed out
-
    Scenario: User enters wrong password
-      Given I am signed up and confirmed as "email@person.com/password"
+      Given I am signed up as "email@person.com/password"
       When I go to the sign in page
       And I sign in as "email@person.com/wrongpassword"
       Then I should see "Bad email or password"
       And I should be signed out
 
    Scenario: User signs in successfully
-      Given I am signed up and confirmed as "email@person.com/password"
+      Given I am signed up as "email@person.com/password"
       When I go to the sign in page
       And I sign in as "email@person.com/password"
       Then I should see "Signed in"
       And I should be signed in
       When I return next time
       Then I should be signed in
-

data/lib/rails/generators/clearance_features_templates/features/sign_out.feature

@@ -4,7 +4,7 @@ Feature: Sign out
   Should be able to sign out
 
     Scenario: User signs out
-      Given I am signed up and confirmed as "email@person.com/password"
+      Given I am signed up as "email@person.com/password"
       When I sign in as "email@person.com/password"
       Then I should be signed in
       And I sign out

data/lib/rails/generators/clearance_features_templates/features/sign_up.feature

@@ -17,29 +17,4 @@ Feature: Sign up
       And I fill in "Password" with "password"
       And I fill in "Confirm password" with "password"
       And I press "Sign up"
-      Then I should see "instructions for confirming"
-      And a confirmation message should be sent to "email@person.com"
-
-    Scenario: User confirms his account
-      Given I signed up with "email@person.com/password"
-      When I follow the confirmation link sent to "email@person.com"
-      Then I should see "Confirmed email and signed in"
-      And I should be signed in
-
-    Scenario: Signed in user clicks confirmation link again
-      Given I signed up with "email@person.com/password"
-      When I follow the confirmation link sent to "email@person.com"
-      Then I should be signed in
-      When I follow the confirmation link sent to "email@person.com"
-      Then I should see "Confirmed email and signed in"
-      And I should be signed in
-
-    Scenario: Signed out user clicks confirmation link again
-      Given I signed up with "email@person.com/password"
-      When I follow the confirmation link sent to "email@person.com"
-      Then I should be signed in
-      When I sign out
-      And I follow the confirmation link sent to "email@person.com"
-      Then I should see "Already confirmed email. Please sign in."
-      And I should be signed out
-
+      Then I should see "signed up"

data/lib/rails/generators/clearance_features_templates/features/step_definitions/clearance_steps.rb

@@ -15,17 +15,14 @@ Given /^no user exists with an email of "(.*)"$/ do |email|
 end
 
 Given /^I signed up with "(.*)\/(.*)"$/ do |email, password|
-  user = Factory :user,
-    :email                 => email,
-    :password              => password,
-    :password_confirmation => password
+  Factory(:user,
+          :email                 => email,
+          :password              => password,
+          :password_confirmation => password)
 end
 
-Given /^I am signed up and confirmed as "(.*)\/(.*)"$/ do |email, password|
-  user = Factory :email_confirmed_user,
-    :email                 => email,
-    :password              => password,
-    :password_confirmation => password
+Given /^I am signed up as "([^"]+)"$/ do |email_password|
+  Given %{I signed up with "#{email_password}"}
 end
 
 # Session
@@ -48,7 +45,7 @@ When /^session is cleared$/ do
 end
 
 Given /^I have signed in with "(.*)\/(.*)"$/ do |email, password|
-  Given %{I am signed up and confirmed as "#{email}/#{password}"}
+  Given %{I am signed up as "#{email}/#{password}"}
   And %{I sign in as "#{email}/#{password}"}
 end
 
@@ -59,24 +56,6 @@ end
 
 # Emails
 
-Then /^a confirmation message should be sent to "(.*)"$/ do |email|
-  user = User.find_by_email(email)
-  assert !user.confirmation_token.blank?
-  assert !ActionMailer::Base.deliveries.empty?
-  result = ActionMailer::Base.deliveries.any? do |email|
-    email.to == [user.email] &&
-    email.subject =~ /confirm/i &&
-    email.body =~ /#{user.confirmation_token}/
-  end
-  assert result
-end
-
-When /^I follow the confirmation link sent to "(.*)"$/ do |email|
-  user = User.find_by_email(email)
-  visit new_user_confirmation_path(:user_id => user,
-                                   :token   => user.confirmation_token)
-end
-
 Then /^a password reset message should be sent to "(.*)"$/ do |email|
   user = User.find_by_email(email)
   assert !user.confirmation_token.blank?