clearance 1.4.3 → 1.5.0

data/lib/clearance/configuration.rb

@@ -1,6 +1,6 @@
 module Clearance
   class Configuration
-    attr_writer :allow_sign_up
+    attr_writer :allow_sign_up, :routes
 
     attr_accessor \
       :cookie_domain,
@@ -21,6 +21,7 @@ module Clearance
       @httponly = false
       @mailer_sender = 'reply@example.com'
       @redirect_url = '/'
+      @routes = true
       @secure_cookie = false
       @sign_in_guards = []
     end
@@ -44,6 +45,10 @@ module Clearance
     def user_id_parameter
       "#{user_model.model_name.singular}_id".to_sym
     end
+
+    def routes_enabled?
+      @routes
+    end
   end
 
   def self.configuration

data/lib/clearance/version.rb

@@ -1,3 +1,3 @@
 module Clearance
-  VERSION = '1.4.3'
+  VERSION = '1.5.0'
 end

data/lib/generators/clearance/routes/routes_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/base'
+
+module Clearance
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def inject_clearance_routes_into_application_routes
+        route(clearance_routes)
+      end
+
+      private
+
+      def clearance_routes
+        File.read(routes_file_path)
+      end
+
+      def routes_file_path
+        File.expand_path(find_in_source_paths('routes.rb'))
+      end
+    end
+  end
+end

data/lib/generators/clearance/routes/templates/routes.rb

@@ -0,0 +1,12 @@
+resources :passwords, controller: 'clearance/passwords', only: [:create, :new]
+  resource :session, controller: 'clearance/sessions', only: [:create]
+
+  resources :users, controller: 'clearance/users', only: [:create] do
+    resource :password,
+      controller: 'clearance/passwords',
+      only: [:create, :edit, :update]
+  end
+
+  get '/sign_in' => 'clearance/sessions#new', as: 'sign_in'
+  delete '/sign_out' => 'clearance/sessions#destroy', as: 'sign_out'
+  get '/sign_up' => 'clearance/users#new', as: 'sign_up'

data/spec/clearance/back_door_spec.rb

@@ -10,8 +10,8 @@ describe Clearance::BackDoor do
 
     result = back_door.call(env)
 
-    env[:clearance].should have_received(:sign_in).with(user)
-    result.should eq mock_app.call(env)
+    expect(env[:clearance]).to have_received(:sign_in).with(user)
+    expect(result).to eq mock_app.call(env)
   end
 
   it 'delegates directly without a user' do
@@ -20,8 +20,8 @@ describe Clearance::BackDoor do
 
     result = back_door.call(env)
 
-    env[:clearance].should have_received(:sign_in).never
-    result.should eq mock_app.call(env)
+    expect(env[:clearance]).to have_received(:sign_in).never
+    expect(result).to eq mock_app.call(env)
   end
 
   def env_without_user_id

data/spec/clearance/rack_session_spec.rb

@@ -16,9 +16,9 @@ describe Clearance::RackSession do
 
     response = Rack::MockResponse.new(*app.call(env))
 
-    Clearance::Session.should have_received(:new).with(env)
-    response.body.should == expected_session
-    expected_session.should have_received(:add_cookie_to_headers).
+    expect(Clearance::Session).to have_received(:new).with(env)
+    expect(response.body).to eq expected_session
+    expect(expected_session).to have_received(:add_cookie_to_headers).
       with(has_entries(headers))
   end
 end

data/spec/clearance/session_spec.rb

@@ -4,7 +4,7 @@ describe Clearance::Session do
   before { Timecop.freeze }
   after { Timecop.return }
 
-  let(:headers) {{}}
+  let(:headers) { {} }
   let(:session) { Clearance::Session.new(env_without_remember_token) }
   let(:user) { create(:user) }
 
@@ -12,20 +12,22 @@ describe Clearance::Session do
     user = create(:user)
     env = env_with_remember_token(user.remember_token)
     session = Clearance::Session.new(env)
-    session.should be_signed_in
-    session.current_user.should == user
+
+    expect(session).to be_signed_in
+    expect(session.current_user).to eq user
   end
 
   it 'returns nil for an unknown user' do
     env = env_with_remember_token('bogus')
     session = Clearance::Session.new(env)
-    session.should be_signed_out
-    session.current_user.should be_nil
+
+    expect(session).to be_signed_out
+    expect(session.current_user).to be_nil
   end
 
   it 'returns nil without a remember token' do
-    session.should be_signed_out
-    session.current_user.should be_nil
+    expect(session).to be_signed_out
+    expect(session.current_user).to be_nil
   end
 
   describe '#sign_in' do
@@ -109,13 +111,15 @@ describe Clearance::Session do
 
       def stub_default_sign_in_guard
         stub(:default_sign_in_guard).tap do |sign_in_guard|
-          Clearance::DefaultSignInGuard.stubs(:new).with(session).returns(sign_in_guard)
+          Clearance::DefaultSignInGuard.stubs(:new).with(session).
+            returns(sign_in_guard)
         end
       end
 
       def stub_guard_class(guard)
         stub(:guard_class).tap do |guard_class|
-          guard_class.stubs(:new).with(session, stub_default_sign_in_guard).returns(guard)
+          guard_class.stubs(:new).with(session, stub_default_sign_in_guard).
+            returns(guard)
         end
       end
 
@@ -138,7 +142,7 @@ describe Clearance::Session do
     it 'sets a httponly cookie' do
       session.add_cookie_to_headers(headers)
 
-      headers['Set-Cookie'].should =~ /remember_token=.+; HttpOnly/
+      expect(headers['Set-Cookie']).to match(/remember_token=.+; HttpOnly/)
     end
 
     after { restore_default_config }
@@ -152,7 +156,7 @@ describe Clearance::Session do
     it 'sets a standard cookie' do
       session.add_cookie_to_headers(headers)
 
-      headers['Set-Cookie'].should_not =~ /remember_token=.+; HttpOnly/
+      expect(headers['Set-Cookie']).not_to match(/remember_token=.+; HttpOnly/)
     end
   end
 
@@ -164,7 +168,11 @@ describe Clearance::Session do
         session = Clearance::Session.new(env_without_remember_token)
         session.sign_in user
         session.add_cookie_to_headers headers
-        headers.should set_cookie('remember_token', user.remember_token, 1.year.from_now)
+
+        expect(headers).to set_cookie(
+          'remember_token',
+          user.remember_token, 1.year.from_now
+        )
       end
     end
 
@@ -175,6 +183,7 @@ describe Clearance::Session do
           session = Clearance::Session.new(env_without_remember_token)
           session.stubs(:warn)
           session.add_cookie_to_headers headers
+
           expect(session).to have_received(:warn).once
         end
       end
@@ -188,7 +197,11 @@ describe Clearance::Session do
           session.sign_in user
           session.stubs(:warn)
           session.add_cookie_to_headers headers
-          headers.should set_cookie('remember_token', user.remember_token, expires_at.call)
+
+          expect(headers).to set_cookie(
+            'remember_token',
+            user.remember_token, expires_at.call
+          )
         end
       end
     end
@@ -196,14 +209,23 @@ describe Clearance::Session do
     context 'configured with lambda taking one argument' do
       it 'it can use other cookies to set the value of the expires token' do
         remembered_expires = 12.hours.from_now
-        expires_at = ->(cookies) { cookies['remember_me'] ? remembered_expires : nil }
+        expires_at = ->(cookies) do
+          cookies['remember_me'] ? remembered_expires : nil
+        end
         with_custom_expiration expires_at do
           user = stub('User', remember_token: '123abc')
           headers = {}
-          session = Clearance::Session.new(env_with_cookies(remember_me: 'true'))
+          environment = env_with_cookies(remember_me: 'true')
+          session = Clearance::Session.new(environment)
           session.sign_in user
           session.add_cookie_to_headers headers
-          headers.should set_cookie('remember_token', user.remember_token, remembered_expires)
+
+          expect(headers).to set_cookie(
+            'remember_token',
+            user.remember_token,
+            remembered_expires
+          )
+
         end
       end
     end
@@ -218,7 +240,7 @@ describe Clearance::Session do
       it 'sets a standard cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should_not =~ /remember_token=.+; secure/
+        expect(headers['Set-Cookie']).not_to match(/remember_token=.+; secure/)
       end
     end
 
@@ -231,7 +253,7 @@ describe Clearance::Session do
       it 'sets a secure cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should =~ /remember_token=.+; secure/
+        expect(headers['Set-Cookie']).to match(/remember_token=.+; secure/)
       end
 
       after { restore_default_config }
@@ -248,7 +270,7 @@ describe Clearance::Session do
       it 'sets a standard cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should =~ /domain=\.example\.com; path/
+        expect(headers['Set-Cookie']).to match(/domain=\.example\.com; path/)
       end
 
       after { restore_default_config }
@@ -260,7 +282,7 @@ describe Clearance::Session do
       it 'sets a standard cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should_not =~ /domain=.+; path/
+        expect(headers['Set-Cookie']).not_to match(/domain=.+; path/)
       end
     end
   end
@@ -272,7 +294,7 @@ describe Clearance::Session do
       it 'sets a standard cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should_not =~ /domain=.+; path/
+        expect(headers['Set-Cookie']).to_not match(/domain=.+; path/)
       end
     end
 
@@ -285,7 +307,7 @@ describe Clearance::Session do
       it 'sets a standard cookie' do
         session.add_cookie_to_headers(headers)
 
-        headers['Set-Cookie'].should =~ /path=\/user; expires/
+        expect(headers['Set-Cookie']).to match(/path=\/user; expires/)
       end
 
       after { restore_default_config }
@@ -296,7 +318,7 @@ describe Clearance::Session do
     headers = {}
     session = Clearance::Session.new(env_without_remember_token)
     session.add_cookie_to_headers headers
-    headers.should_not set_cookie('remember_token')
+    expect(headers).not_to set_cookie('remember_token')
   end
 
   it 'signs out a user' do
@@ -305,8 +327,8 @@ describe Clearance::Session do
     env = env_with_remember_token(old_remember_token)
     session = Clearance::Session.new(env)
     session.sign_out
-    session.current_user.should be_nil
-    user.reload.remember_token.should_not == old_remember_token
+    expect(session.current_user).to be_nil
+    expect(user.reload.remember_token).not_to eq old_remember_token
   end
 
   def env_with_cookies(cookies)

data/spec/configuration_spec.rb

@@ -36,7 +36,7 @@ describe Clearance::Configuration do
     end
 
     it 'returns true' do
-      expect(Clearance.configuration.secure_cookie).to be_true
+      expect(Clearance.configuration.secure_cookie).to eq true
     end
   end
 
@@ -47,12 +47,12 @@ describe Clearance::Configuration do
     end
 
     it 'defaults to false' do
-      expect(Clearance.configuration.secure_cookie).to be_false
+      expect(Clearance.configuration.secure_cookie).to eq false
     end
   end
 
   context 'when no redirect URL specified' do
-    it 'should return "/" as redirect URL' do
+    it 'returns "/" as redirect URL' do
       expect(Clearance::Configuration.new.redirect_url).to eq '/'
     end
   end
@@ -66,7 +66,7 @@ describe Clearance::Configuration do
       end
     end
 
-    it 'should return new redirect URL' do
+    it 'returns new redirect URL' do
       expect(Clearance.configuration.redirect_url).to eq new_redirect_url
     end
   end
@@ -80,7 +80,7 @@ describe Clearance::Configuration do
       end
     end
 
-    it 'should return the stack with added guards' do
+    it 'returns the stack with added guards' do
       expect(Clearance.configuration.sign_in_guards).to eq [DummyGuard]
     end
   end
@@ -113,17 +113,17 @@ describe Clearance::Configuration do
     end
   end
 
-  describe '#sign_up?' do
+  describe '#allow_sign_up?' do
     context 'when allow_sign_up is configured to false' do
       it 'returns false' do
         Clearance.configure { |config| config.allow_sign_up = false }
-        Clearance.configuration.allow_sign_up?.should be_false
+        expect(Clearance.configuration.allow_sign_up?).to eq false
       end
     end
 
     context 'when allow_sign_up has not been configured' do
       it 'returns true' do
-        Clearance.configuration.allow_sign_up?.should be_true
+        expect(Clearance.configuration.allow_sign_up?).to eq true
       end
     end
   end
@@ -132,13 +132,13 @@ describe Clearance::Configuration do
     context 'when allow_sign_up is configured to false' do
       it 'returns empty array' do
         Clearance.configure { |config| config.allow_sign_up = false }
-        Clearance.configuration.user_actions.should eq []
+        expect(Clearance.configuration.user_actions).to eq []
       end
     end
 
     context 'when sign_up has not been configured' do
       it 'returns create' do
-        Clearance.configuration.user_actions.should eq [:create]
+        expect(Clearance.configuration.user_actions).to eq [:create]
       end
     end
   end
@@ -148,7 +148,18 @@ describe Clearance::Configuration do
       CustomUser = Class.new(ActiveRecord::Base)
       Clearance.configure { |config| config.user_model = CustomUser }
 
-      Clearance.configuration.user_id_parameter.should eq :custom_user_id
+      expect(Clearance.configuration.user_id_parameter).to eq :custom_user_id
+    end
+  end
+
+  describe '#routes_enabled?' do
+    it 'is true by default' do
+      expect(Clearance.configuration.routes_enabled?).to be true
+    end
+
+    it 'is false when routes are set to false' do
+      Clearance.configure { |config| config.routes = false }
+      expect(Clearance.configuration.routes_enabled?).to be false
     end
   end
 end

data/spec/controllers/apis_controller_spec.rb

@@ -25,6 +25,6 @@ describe ApisController do
 
   it 'responds with HTTP status code 401 when denied' do
     get :show, format: :js
-    subject.should respond_with(:unauthorized)
+    expect(subject).to respond_with(:unauthorized)
   end
 end

data/spec/controllers/forgeries_controller_spec.rb

@@ -34,17 +34,17 @@ describe ForgeriesController do
 
     it 'succeeds with authentic token' do
       post :create, authenticity_token: 'golden-ticket'
-      subject.should redirect_to(action: 'index')
+      expect(subject).to redirect_to(action: 'index')
     end
 
     it 'fails with invalid token' do
       post :create, authenticity_token: 'hax0r'
-      subject.should deny_access
+      expect(subject).to deny_access
     end
 
     it 'fails with no token' do
       post :create
-      subject.should deny_access
+      expect(subject).to deny_access
     end
   end
 end

data/spec/controllers/passwords_controller_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Clearance::PasswordsController do
-  it { should be_a Clearance::BaseController }
+  it { is_expected.to be_a Clearance::BaseController }
 
   describe 'a signed up user' do
     before do
@@ -11,8 +11,8 @@ describe Clearance::PasswordsController do
     describe 'on GET to #new' do
       before { get :new, user_id: @user.to_param }
 
-      it { should respond_with(:success) }
-      it { should render_template(:new) }
+      it { is_expected.to respond_with(:success) }
+      it { is_expected.to render_template(:new) }
     end
 
     describe 'on POST to #create' do
@@ -23,15 +23,15 @@ describe Clearance::PasswordsController do
         end
 
         it 'should generate a token for the change your password email' do
-          @user.reload.confirmation_token.should_not be_nil
+          expect(@user.reload.confirmation_token).not_to be_nil
         end
 
         it 'sends an email with relevant subject' do
           email = ActionMailer::Base.deliveries.last
-          email.subject.should match(/change your password/i)
+          expect(email.subject).to match(/change your password/i)
         end
 
-        it { should respond_with(:success) }
+        it { is_expected.to respond_with(:success) }
       end
 
       describe 'with correct email address capitalized differently' do
@@ -41,36 +41,38 @@ describe Clearance::PasswordsController do
         end
 
         it 'should generate a token for the change your password email' do
-          @user.reload.confirmation_token.should_not be_nil
+          expect(@user.reload.confirmation_token).not_to be_nil
         end
 
         it 'sends an email with relevant subject' do
           email = ActionMailer::Base.deliveries.last
-          email.subject.should match(/change your password/i)
+          expect(email.subject).to match(/change your password/i)
         end
 
-        it { should respond_with(:success) }
+        it { is_expected.to respond_with(:success) }
       end
 
       describe 'with incorrect email address' do
         before do
           email = 'user1@example.com'
-          (Clearance.configuration.user_model.exists?(['email = ?', email])).should_not be
+          user = Clearance.configuration.user_model.exists?(email: email)
+          expect(user).not_to be_present
+
           ActionMailer::Base.deliveries.clear
-          @user.reload.confirmation_token.should == @user.confirmation_token
+          expect(@user.reload.confirmation_token).to eq @user.confirmation_token
 
           post :create, password: { email: email }
         end
 
         it 'should not generate a token for the change your password email' do
-          @user.reload.confirmation_token.should == @user.confirmation_token
+          expect(@user.reload.confirmation_token).to eq @user.confirmation_token
         end
 
         it 'should not send a password reminder email' do
-          ActionMailer::Base.deliveries.should be_empty
+          expect(ActionMailer::Base.deliveries).to be_empty
         end
 
-        it { should render_template(:create) }
+        it { is_expected.to render_template(:create) }
       end
     end
   end
@@ -83,16 +85,17 @@ describe Clearance::PasswordsController do
 
     describe 'on GET to #edit with correct id and token' do
       before do
-        get :edit, user_id: @user.to_param,
-          token: @user.confirmation_token
+        get :edit,
+            user_id: @user.to_param,
+            token: @user.confirmation_token
       end
 
       it 'should find the user' do
-        assigns(:user).should == @user
+        expect(assigns(:user)).to eq @user
       end
 
-      it { should respond_with(:success) }
-      it { should render_template(:edit) }
+      it { is_expected.to respond_with(:success) }
+      it { is_expected.to render_template(:edit) }
     end
 
     describe 'on GET to #edit with correct id but blank token' do
@@ -100,8 +103,8 @@ describe Clearance::PasswordsController do
         get :edit, user_id: @user.to_param, token: ''
       end
 
-      it { should set_the_flash.to(/double check the URL/i).now }
-      it { should render_template(:new) }
+      it { is_expected.to set_the_flash.to(/double check the URL/i).now }
+      it { is_expected.to render_template(:new) }
     end
 
     describe 'on GET to #edit with correct id but no token' do
@@ -109,8 +112,8 @@ describe Clearance::PasswordsController do
         get :edit, user_id: @user.to_param
       end
 
-      it { should set_the_flash.to(/double check the URL/i).now }
-      it { should render_template(:new) }
+      it { is_expected.to set_the_flash.to(/double check the URL/i).now }
+      it { is_expected.to render_template(:new) }
     end
 
     describe 'on PUT to #update with password' do
@@ -124,18 +127,18 @@ describe Clearance::PasswordsController do
       end
 
       it 'should update password' do
-        @user.encrypted_password.to_s.should_not eq @old_encrypted_password
+        expect(@user.encrypted_password.to_s).not_to eq @old_encrypted_password
       end
 
       it 'should clear confirmation token' do
-        @user.confirmation_token.should be_nil
+        expect(@user.confirmation_token).to be_nil
       end
 
       it 'should set remember token' do
-        @user.remember_token.should_not be_nil
+        expect(@user.remember_token).not_to be_nil
       end
 
-      it { should redirect_to_url_after_update }
+      it { is_expected.to redirect_to_url_after_update }
     end
 
     describe 'on PUT to #update with blank password' do
@@ -146,20 +149,20 @@ describe Clearance::PasswordsController do
       end
 
       it 'should not update password to be blank' do
-        @user.encrypted_password.should_not be_blank
+        expect(@user.encrypted_password).not_to be_blank
       end
 
       it 'should not clear token' do
-        @user.confirmation_token.should_not be_nil
+        expect(@user.confirmation_token).not_to be_nil
       end
 
       it 'should not be signed in' do
-        cookies[:remember_token].should be_nil
+        expect(cookies[:remember_token]).to be_nil
       end
 
-      it { should set_the_flash.to(/password can't be blank/i).now }
-      it { should respond_with(:success) }
-      it { should render_template(:edit) }
+      it { is_expected.to set_the_flash.to(/password can't be blank/i).now }
+      it { is_expected.to respond_with(:success) }
+      it { is_expected.to render_template(:edit) }
     end
 
     describe 'on PUT to #update with an empty token after the user sets a password' do
@@ -170,8 +173,8 @@ describe Clearance::PasswordsController do
           password_reset: { password: 'new password' }
       end
 
-      it { should set_the_flash.to(/double check the URL/i).now }
-      it { should render_template(:new) }
+      it { is_expected.to set_the_flash.to(/double check the URL/i).now }
+      it { is_expected.to render_template(:new) }
     end
   end