nagybence-clearance 0.4.1

data/generators/clearance/templates/app/views/sessions/new.html.erb

@@ -0,0 +1,28 @@
+<h2>Sign in</h2>
+
+<% form_for :session, :url => session_path do |form| %>
+  <div class="text_field">
+    <%= form.label :email %>
+    <%= form.text_field :email %>  
+  </div>
+  <div class="text_field">
+    <%= form.label :password %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="text_field">
+    <%= form.check_box :remember_me %>
+    <%= form.label :remember_me %>
+  </div>
+  <div class="submit_field">
+    <%= form.submit "Sign in", :disable_with => "Please wait..." %>
+  </div>
+<% end %>
+
+<ul>
+  <li>
+    <%= link_to "Register", new_user_path %>
+  </li>
+  <li>
+    <%= link_to "Forgot password?", new_password_path %>
+  </li>
+</ul>

data/generators/clearance/templates/app/views/users/_form.html.erb

@@ -0,0 +1,13 @@
+<%= form.error_messages %>
+<div class="text_field">
+  <%= form.label :email %>
+  <%= form.text_field :email %>
+</div>
+<div class="password_field">
+  <%= form.label :password %>
+  <%= form.password_field :password %>
+</div>
+<div class="password_field">
+  <%= form.label :password_confirmation, "Verify password" %>
+  <%= form.password_field :password_confirmation %>
+</div>

data/generators/clearance/templates/app/views/users/edit.html.erb

@@ -0,0 +1,6 @@
+<h2>Edit user information</h2>
+
+<% form_for @user do |form| %>
+  <%= render :partial => '/users/form', :object => form %>
+  <%= form.submit 'Update', :disable_with => 'Please wait...' %>
+<% end %>

data/generators/clearance/templates/app/views/users/new.html.erb

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

data/generators/clearance/templates/db/migrate/create_users_with_clearance_columns.rb

@@ -0,0 +1,21 @@
+class CreateOrUpdateUsersWithClearanceColumns < ActiveRecord::Migration
+  def self.up
+    create_table(:users) do |t|
+      t.string :email
+      t.string :encrypted_password, :limit => 128
+      t.string :salt, :limit => 128
+      t.string :remember_token
+      t.datetime :remember_token_expires_at
+      t.boolean :email_confirmed, :default => false, :null => false
+    end
+
+    add_index :users, [:email, :encrypted_password]
+    add_index :users, [:id, :salt]
+    add_index :users, :email
+    add_index :users, :remember_token    
+  end
+  
+  def self.down
+    drop_table :users  
+  end
+end

data/generators/clearance/templates/db/migrate/update_users_with_clearance_columns.rb

@@ -0,0 +1,42 @@
+class CreateOrUpdateUsersWithClearanceColumns < ActiveRecord::Migration
+  def self.up
+<% 
+      existing_columns = ActiveRecord::Base.connection.columns(:users).collect { |each| each.name }
+      columns = [
+        [:email,                     't.string :email'],
+        [:encrypted_password,        't.string :encrypted_password, :limit => 180'],
+        [:salt,                      't.string :salt, :limit => 180'],
+        [:remember_token,            't.string :remember_token'],
+        [:remember_token_expires_at, 't.datetime :remember_token_expires_at'],
+        [:email_confirmed,           't.boolean :email_confirmed, :default => false, :null => false']
+      ].delete_if {|c| existing_columns.include?(c.first.to_s)} 
+-%>
+    change_table(:users) do |t|
+<% columns.each do |c| -%>
+      <%= c.last %>
+<% end -%>
+    end
+    
+<%
+    existing_indexes = ActiveRecord::Base.connection.indexes(:users)
+    index_names = existing_indexes.collect { |each| each.name }
+    new_indexes = [
+      [:index_users_on_email_and_encrypted_password, 'add_index :users, [:email, :encrypted_password]'],
+      [:index_users_on_id_and_salt,                  'add_index :users, [:id, :salt]'],
+      [:index_users_on_email,                        'add_index :users, :email'],
+      [:index_users_on_remember_token,               'add_index :users, :remember_token']
+    ].delete_if { |each| index_names.include?(each.first.to_s) }
+-%>
+<% new_indexes.each do |each| -%>
+    <%= each.last %>
+<% end -%>
+  end
+  
+  def self.down
+    change_table(:users) do |t|
+<% unless columns.empty? -%>
+      t.remove <%= columns.collect { |each| ":#{each.first}" }.join(',') %>
+<% end -%>
+    end
+  end
+end

data/generators/clearance/templates/test/factories/clearance.rb

@@ -0,0 +1,16 @@
+Factory.sequence :email do |n|
+  "user#{n}@example.com"
+end
+
+Factory.define :registered_user, :class => 'user' do |user|
+  user.email                 { Factory.next :email }
+  user.password              { "password" }
+  user.password_confirmation { "password" }
+end
+
+Factory.define :email_confirmed_user, :class => 'user' do |user|
+  user.email                 { Factory.next :email }
+  user.password              { "password" }
+  user.password_confirmation { "password" }
+  user.email_confirmed       { true }
+end

data/generators/clearance/templates/test/functional/confirmations_controller_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ConfirmationsControllerTest < ActionController::TestCase
+  include Clearance::Test::Functional::ConfirmationsControllerTest
+end

data/generators/clearance/templates/test/functional/passwords_controller_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class PasswordsControllerTest < ActionController::TestCase
+  include Clearance::Test::Functional::PasswordsControllerTest
+end

data/generators/clearance/templates/test/functional/sessions_controller_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SessionsControllerTest < ActionController::TestCase
+  include Clearance::Test::Functional::SessionsControllerTest
+end

data/generators/clearance/templates/test/functional/users_controller_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UsersControllerTest < ActionController::TestCase
+  include Clearance::Test::Functional::UsersControllerTest
+end

data/generators/clearance/templates/test/unit/clearance_mailer_test.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ClearanceMailerTest < ActionMailer::TestCase
+  tests ClearanceMailer
+  include Clearance::Test::Unit::ClearanceMailerTest
+end

data/generators/clearance/templates/test/unit/user_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UserTest < Test::Unit::TestCase
+  include Clearance::Test::Unit::UserTest
+end

data/lib/clearance/app/controllers/application_controller.rb

@@ -0,0 +1,84 @@
+module Clearance
+  module App
+    module Controllers
+      module ApplicationController
+    
+        def self.included(controller)
+          controller.class_eval do
+                      
+            helper_method :current_user
+            helper_method :signed_in?
+            
+            hide_action :current_user, :signed_in?
+        
+            def current_user
+              @_current_user ||= (user_from_session || user_from_cookie)
+            end
+
+            def signed_in?
+              ! current_user.nil?
+            end
+            
+            protected
+            
+            def authenticate
+              deny_access unless signed_in?
+            end
+
+            def user_from_session
+              if session[:user_id] && session[:salt]
+                user = User.find_by_id_and_salt(session[:user_id], session[:salt])
+              end
+              user && user.email_confirmed? ? user : nil
+            end
+
+            def user_from_cookie
+              if cookies[:remember_token]
+                user = User.find_by_remember_token(cookies[:remember_token])
+              end
+              user && user.remember? ? user : nil
+            end
+
+            # Hook
+            def sign_user_in(user)
+              sign_in(user)
+            end
+
+            def sign_in(user)
+              if user
+                session[:user_id] = user.id
+                session[:salt]    = user.salt
+              end
+            end
+
+            def redirect_back_or(default)
+              session[:return_to] ||= params[:return_to]
+              if session[:return_to] 
+                redirect_to(session[:return_to])
+              else 
+                redirect_to(default)
+              end
+              session[:return_to] = nil
+            end
+
+            def redirect_to_root
+              redirect_to root_url
+            end
+
+            def store_location
+              session[:return_to] = request.request_uri
+            end
+
+            def deny_access(flash_message = nil, opts = {})
+              store_location
+              flash[:failure] = flash_message if flash_message
+              render :template => "/sessions/new", :status => :unauthorized 
+            end
+            
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/clearance/app/controllers/confirmations_controller.rb

@@ -0,0 +1,42 @@
+module Clearance
+  module App
+    module Controllers
+      module ConfirmationsController
+    
+        def self.included(controller)
+          controller.class_eval do
+            
+            before_filter :existing_user?, :only => :new
+            filter_parameter_logging :salt
+        
+            def new
+              create
+            end
+
+            def create
+              @user.confirm_email!
+              sign_user_in(@user)
+              flash[:success] = "Confirmed email and signed in."
+              redirect_to url_after_create
+            end
+        
+            private
+            
+            def existing_user?
+              @user = User.find_by_id_and_salt(params[:user_id], params[:salt])
+              if @user.nil?
+                render :nothing => true, :status => :not_found
+              end
+            end
+
+            def url_after_create
+              root_url
+            end
+            
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/clearance/app/controllers/passwords_controller.rb

@@ -0,0 +1,67 @@
+module Clearance
+  module App
+    module Controllers
+      module PasswordsController
+
+        def self.included(controller)
+          controller.class_eval do
+            
+            before_filter :existing_user?, :only => [:edit, :update]
+            filter_parameter_logging :password, :password_confirmation
+            
+            def new
+            end
+
+            def create
+              user = User.find_by_email(params[:password][:email])
+              if user.nil?
+                flash.now[:notice] = "Unknown email"
+                render :action => :new
+              else
+                ClearanceMailer.deliver_change_password user
+                flash[:notice] = "Details for changing your password have been sent"
+                redirect_to url_after_create
+              end
+            end
+
+            def edit
+              @user = User.find_by_email_and_encrypted_password(params[:email],
+                                                                params[:password])
+            end
+
+            def update
+              @user = User.find_by_email_and_encrypted_password(params[:email],
+                                                                params[:password])
+              if @user.update_attributes params[:user]
+                sign_user_in(@user)
+                redirect_to url_after_update
+              else
+                render :action => :edit
+              end
+            end
+            
+            private
+            
+            def existing_user?
+              user = User.find_by_email_and_encrypted_password(params[:email],
+                                                               params[:password])
+              if user.nil?
+                render :nothing => true, :status => :not_found
+              end
+            end
+
+            def url_after_create
+              new_session_url
+            end
+            
+            def url_after_update
+              root_url
+            end
+            
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/clearance/app/controllers/sessions_controller.rb

@@ -0,0 +1,68 @@
+module Clearance
+  module App
+    module Controllers
+      module SessionsController
+
+        def self.included(controller)
+          controller.class_eval do
+            
+            protect_from_forgery :except => :create
+            filter_parameter_logging :password
+        
+            def create
+              @user = User.authenticate(params[:session][:email], 
+                                        params[:session][:password])
+              if @user.nil?
+                flash.now[:notice] = "Bad email or password."
+                render :action => :new
+              else
+                if @user.email_confirmed?
+                  remember(@user) if remember?
+                  sign_user_in(@user)
+                  flash[:notice] = "Signed in successfully"
+                  redirect_back_or url_after_create
+                else
+                  deny_access("User has not confirmed email.")
+                end
+              end
+            end
+
+            def destroy
+              forget(current_user)
+              reset_session
+              flash[:notice] = "You have been signed out."
+              redirect_to url_after_destroy
+            end
+        
+            private
+            
+            def remember?
+              params[:session] && params[:session][:remember_me] == "1"
+            end
+            
+            def remember(user)
+              user.remember_me!
+              cookies[:remember_token] = { :value   => user.remember_token, 
+                                           :expires => user.remember_token_expires_at }
+            end
+
+            def forget(user)
+              user.forget_me! if user
+              cookies.delete :remember_token
+            end
+
+            def url_after_create
+              root_url
+            end
+
+            def url_after_destroy
+              new_session_url
+            end
+            
+          end
+        end
+          
+      end
+    end
+  end
+end

data/lib/clearance/app/controllers/users_controller.rb

@@ -0,0 +1,40 @@
+module Clearance
+  module App
+    module Controllers
+      module UsersController
+
+        def self.included(controller)
+          controller.class_eval do
+            
+            before_filter :redirect_to_root, :only => [:new, :create], :if => :signed_in?
+            filter_parameter_logging :password
+        
+            def new
+              @user = User.new(params[:user])
+            end
+
+            def create
+              @user = User.new params[:user]
+              if @user.save
+                ClearanceMailer.deliver_confirmation @user
+                flash[:notice] = "You will receive an email within the next few minutes. " <<
+                                 "It contains instructions for you to confirm your account."
+                redirect_to url_after_create
+              else
+                render :action => "new"
+              end
+            end
+        
+            private
+            
+            def url_after_create
+              new_session_url
+            end
+            
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/clearance/app/models/clearance_mailer.rb

@@ -0,0 +1,29 @@
+module Clearance
+  module App
+    module Models
+      module ClearanceMailer
+    
+        def self.included(mailer)
+          mailer.class_eval do
+        
+            def change_password(user)
+              from       DO_NOT_REPLY
+              recipients user.email
+              subject    "Change your password"
+              body       :user => user
+            end
+
+            def confirmation(user)
+              from       DO_NOT_REPLY
+              recipients user.email
+              subject   "Account confirmation"
+              body      :user => user
+            end
+        
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/clearance/app/models/user.rb

@@ -0,0 +1,89 @@
+require 'digest/sha2'
+
+module Clearance
+  module App
+    module Models
+      module User
+    
+        def self.included(model)
+          model.class_eval do
+        
+            attr_accessible :email, :password, :password_confirmation
+            attr_accessor :password, :password_confirmation
+
+            validates_presence_of     :email
+            validates_presence_of     :password, :if => :password_required?
+            validates_confirmation_of :password, :if => :password_required?
+            validates_uniqueness_of   :email, :case_sensitive => false
+            validates_format_of       :email, :with => %r{.+@.+\..+}
+
+            before_save :initialize_salt, :encrypt_password, :downcase_email
+        
+            def self.authenticate(email, password)
+              user = find(:first, :conditions => ['LOWER(email) = ?', email.to_s.downcase])
+              user && user.authenticated?(password) ? user : nil
+            end
+
+            def authenticated?(password)
+              encrypted_password == encrypt(password)
+            end
+
+            def encrypt(string)
+              hash("--#{salt}--#{string}--")
+            end
+
+            def remember?
+              remember_token_expires_at && Time.now.utc < remember_token_expires_at
+            end
+
+            def remember_me!
+              remember_me_until 2.weeks.from_now.utc
+            end
+
+            def remember_me_until(time)
+              self.update_attribute :remember_token_expires_at, time
+              self.update_attribute :remember_token, 
+                encrypt("--#{remember_token_expires_at}--#{password}--")
+            end
+
+            def forget_me!
+              self.update_attribute :remember_token_expires_at, nil
+              self.update_attribute :remember_token, nil
+            end
+
+            def confirm_email!
+              self.update_attribute :email_confirmed, true
+            end
+        
+            protected
+            
+            def hash(string)
+              Digest::SHA512.hexdigest(string)
+            end
+
+            def initialize_salt
+              if new_record?
+                self.salt = hash("--#{Time.now.utc.to_s}--#{password}--")
+              end
+            end
+
+            def encrypt_password
+              return if password.blank?
+              self.encrypted_password = encrypt(password)
+            end
+
+            def password_required?
+              encrypted_password.blank? || !password.blank?
+            end
+            
+            def downcase_email
+              self.email = email.to_s.downcase
+            end
+        
+          end
+        end
+  
+      end
+    end
+  end
+end

data/lib/clearance/test/functional/confirmations_controller_test.rb

@@ -0,0 +1,44 @@
+module Clearance
+  module Test
+    module Functional
+      module ConfirmationsControllerTest
+
+        def self.included(controller_test)
+          controller_test.class_eval do
+            
+            should_filter_params :salt
+            
+            context "Given a user whose email has not been confirmed" do
+              setup { @user = Factory(:registered_user) }
+              
+              context "on GET to #new with correct id and salt" do
+                setup do
+                  get :new, :user_id => @user.to_param, :salt => @user.salt
+                end
+
+                should_set_the_flash_to /confirmed email/i
+                should_set_the_flash_to /signed in/i
+                should_be_signed_in_and_email_confirmed_as { @user }
+                should_redirect_to_url_after_create
+              end
+              
+              context "on GET to #new with incorrect salt" do
+                setup do
+                  salt = ""
+                  assert_not_equal salt, @user.salt
+
+                  get :new, :user_id => @user.to_param, :salt => salt
+                end
+
+                should_respond_with :not_found
+                should_render_nothing
+              end
+            end
+          
+          end
+        end
+
+      end
+    end
+  end
+end