activerain-clearance 0.6.6

data/lib/clearance/authentication.rb

@@ -0,0 +1,96 @@
+module Clearance
+  module Authentication
+
+    def self.included(controller)
+      controller.send(:include, InstanceMethods)
+
+      controller.class_eval do
+        helper_method :current_user
+        helper_method :signed_in?
+
+        hide_action :current_user, :signed_in?
+      end
+    end
+
+    module InstanceMethods
+      def current_user
+        @_current_user ||= (user_from_cookie || user_from_session)
+      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]
+          return nil  unless user = ::User.find_by_id(session[:user_id])
+          return user if     user.email_confirmed?
+        end
+      end
+
+      def user_from_cookie
+        if token = cookies[:remember_token]
+          return nil  unless user = ::User.find_by_token(token)
+          return user if     user.remember?
+        end
+      end
+
+      def sign_user_in(user)
+        sign_in(user)
+      end
+
+      def sign_in(user)
+        if user
+          session[:user_id] = user.id
+        end
+      end
+
+      def remember?
+        params[:session] && params[:session][:remember_me] == "1"
+      end
+
+      def remember(user)
+        user.remember_me!
+        cookies[:remember_token] = { :value   => user.token,
+                                     :expires => user.token_expires_at }
+      end
+
+      def forget(user)
+        user.forget_me! if user
+        cookies.delete :remember_token
+        reset_session
+      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 if request.get?
+      end
+
+      def deny_access(flash_message = nil, opts = {})
+        store_location
+        flash[:failure] = flash_message if flash_message
+        redirect_to new_session_url
+      end
+    end
+
+  end
+end

data/lib/clearance/extensions/errors.rb

@@ -0,0 +1,4 @@
+module ActionController
+  class Forbidden < StandardError
+  end
+end

data/lib/clearance/extensions/rescue.rb

@@ -0,0 +1 @@
+ActionController::Base.rescue_responses.update('ActionController::Forbidden' => :forbidden)

data/lib/clearance/user.rb

@@ -0,0 +1,143 @@
+require 'digest/sha1'
+
+module Clearance
+  module User
+
+    def self.included(model)
+      model.extend(ClassMethods)
+
+      model.send(:include, InstanceMethods)
+      model.send(:include, AttrAccessible)
+      model.send(:include, AttrAccessor)
+      model.send(:include, Validations)
+      model.send(:include, Callbacks)
+    end
+
+    module AttrAccessible
+      def self.included(model)
+        model.class_eval do
+          attr_accessible :email, :password, :password_confirmation
+        end
+      end
+    end
+
+    module AttrAccessor
+      def self.included(model)
+        model.class_eval do
+          attr_accessor :password, :password_confirmation
+        end
+      end
+    end
+
+    module Validations
+      def self.included(model)
+        model.class_eval do
+          validates_presence_of     :email
+          validates_uniqueness_of   :email, :case_sensitive => false
+          validates_format_of       :email, :with => %r{.+@.+\..+}
+
+          validates_presence_of     :password, :if => :password_required?
+          validates_confirmation_of :password, :if => :password_required?
+        end
+      end
+    end
+
+    module Callbacks
+      def self.included(model)
+        model.class_eval do
+          before_save :initialize_salt, :encrypt_password, :initialize_token
+        end
+      end
+    end
+
+    module InstanceMethods
+      def authenticated?(password)
+        encrypted_password == encrypt(password)
+      end
+
+      def encrypt(string)
+        generate_hash("--#{salt}--#{string}--")
+      end
+
+      def remember?
+        token_expires_at && Time.now.utc < token_expires_at
+      end
+
+      def remember_me!
+        remember_me_until! 2.weeks.from_now.utc
+      end
+
+      def forget_me!
+        clear_token
+        save(false)
+      end
+
+      def confirm_email!
+        self.email_confirmed  = true
+        self.token            = nil
+        save(false)
+      end
+
+      def forgot_password!
+        generate_token
+        save(false)
+      end
+
+      def update_password(new_password, new_password_confirmation)
+        self.password              = new_password
+        self.password_confirmation = new_password_confirmation
+        clear_token if valid?
+        save
+      end
+
+      protected
+
+      def generate_hash(string)
+        Digest::SHA1.hexdigest(string)
+      end
+
+      def initialize_salt
+        if new_record?
+          self.salt = generate_hash("--#{Time.now.utc.to_s}--#{password}--")
+        end
+      end
+
+      def encrypt_password
+        return if password.blank?
+        self.encrypted_password = encrypt(password)
+      end
+
+      def generate_token
+        self.token = encrypt("--#{Time.now.utc.to_s}--#{password}--")
+        self.token_expires_at = nil
+      end
+
+      def clear_token
+        self.token            = nil
+        self.token_expires_at = nil
+      end
+
+      def initialize_token
+        generate_token if new_record?
+      end
+
+      def password_required?
+        encrypted_password.blank? || !password.blank?
+      end
+
+      def remember_me_until!(time)
+        self.token_expires_at = time
+        self.token = encrypt("--#{token_expires_at}--#{password}--")
+        save(false)
+      end
+    end
+
+    module ClassMethods
+      def authenticate(email, password)
+        return nil  unless user = find_by_email(email)
+        return user if     user.authenticated?(password)
+      end
+    end
+
+  end
+end

data/lib/clearance.rb

@@ -0,0 +1,6 @@
+require 'clearance/extensions/errors'
+require 'clearance/extensions/rescue'
+
+require 'clearance/authentication'
+require 'clearance/user'
+

data/rails/init.rb

@@ -0,0 +1 @@
+require 'clearance'

data/shoulda_macros/clearance.rb

@@ -0,0 +1,261 @@
+module Clearance
+  module Shoulda
+
+    # STATE OF AUTHENTICATION
+
+    def should_be_signed_in_as(&block)
+      should "be signed in as #{block.bind(self).call}" do
+        user = block.bind(self).call
+        assert_not_nil user,
+          "please pass a User. try: should_be_signed_in_as { @user }"
+        assert_equal user.id,   session[:user_id],
+          "session[:user_id] is not set to User's id"
+      end
+    end
+
+    def should_be_signed_in_and_email_confirmed_as(&block)
+      warn "[DEPRECATION] should_be_signed_in_and_email_confirmed_as: questionable usefulness"
+      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
+      should "not be signed in" do
+        assert_nil session[:user_id]
+      end
+    end
+
+    def should_deny_access_on(http_method, action, opts = {})
+      warn "[DEPRECATION] should_deny_access_on: use a setup & should_deny_access(:flash => ?)"
+      flash_message = opts.delete(:flash)
+      context "on #{http_method} to #{action}" do
+        setup do
+          send(http_method, action, opts)
+        end
+
+        should_deny_access(:flash => flash_message)
+      end
+    end
+
+    def should_deny_access(opts = {})
+      if opts[:flash]
+        should_set_the_flash_to opts[:flash]
+      else
+        should_not_set_the_flash
+      end
+
+      should_redirect_to('new_session_url') { new_session_url }
+    end
+
+    # HTTP FLUENCY
+
+    def should_forbid(description, &block)
+      should "forbid #{description}" do
+        assert_raises ActionController::Forbidden do
+          instance_eval(&block)
+        end
+      end
+    end
+
+    # CONTEXTS
+
+    def signed_in_user_context(&blk)
+      warn "[DEPRECATION] signed_in_user_context: creates a Mystery Guest, causes Obscure Test"
+      context "A signed in user" do
+        setup do
+          @user = Factory(:user)
+          @user.confirm_email!
+          sign_in_as @user
+        end
+        merge_block(&blk)
+      end
+    end
+
+    def public_context(&blk)
+      warn "[DEPRECATION] public_context: common case is no-op. call sign_out otherwise"
+      context "The public" do
+        setup { sign_out }
+        merge_block(&blk)
+      end
+    end
+
+    # CREATING USERS
+
+    def should_create_user_successfully
+      warn "[DEPRECATION] should_create_user_successfully: not meant to be public, no longer used internally"
+      should_assign_to :user
+      should_change 'User.count', :by => 1
+
+      should "send the confirmation email" do
+        assert_sent_email do |email|
+          email.subject =~ /account confirmation/i
+        end
+      end
+
+      should_set_the_flash_to /confirm/i
+      should_redirect_to_url_after_create
+    end
+
+    # RENDERING
+
+    def should_render_nothing
+      should "render nothing" do
+        assert @response.body.blank?
+      end
+    end
+
+    # REDIRECTS
+
+    def should_redirect_to_url_after_create
+      should_redirect_to("the post-create url") do
+        @controller.send(:url_after_create)
+      end
+    end
+
+    def should_redirect_to_url_after_update
+      should_redirect_to("the post-update url") do
+        @controller.send(:url_after_update)
+      end
+    end
+
+    def should_redirect_to_url_after_destroy
+      should_redirect_to("the post-destroy url") do
+        @controller.send(:url_after_destroy)
+      end
+    end
+
+    # VALIDATIONS
+
+    def should_validate_confirmation_of(attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_of: not meant to be public, no longer used internally"
+      raise ArgumentError if opts[:factory].nil?
+
+      context "on save" do
+        should_validate_confirmation_is_not_blank opts[:factory], attribute
+        should_validate_confirmation_is_not_bad   opts[:factory], attribute
+      end
+    end
+
+    def should_validate_confirmation_is_not_blank(factory, attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_is_not_blank: not meant to be public, no longer used internally"
+      should "validate #{attribute}_confirmation is not blank" do
+        model = Factory.build(factory, blank_confirmation_options(attribute))
+        model.save
+        assert_confirmation_error(model, attribute,
+          "#{attribute}_confirmation cannot be blank")
+      end
+    end
+
+    def should_validate_confirmation_is_not_bad(factory, attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_is_not_bad: not meant to be public, no longer used internally"
+      should "validate #{attribute}_confirmation is different than #{attribute}" do
+        model = Factory.build(factory, bad_confirmation_options(attribute))
+        model.save
+        assert_confirmation_error(model, attribute, 
+          "#{attribute}_confirmation cannot be different than #{attribute}")
+      end
+    end
+
+    # FORMS
+
+    def should_display_a_password_update_form
+      warn "[DEPRECATION] should_display_a_password_update_form: not meant to be public, no longer used internally"
+      should "have a form for the user's token, password, and password confirm" do
+        update_path = ERB::Util.h(
+          user_password_path(@user, :token => @user.token)
+        )
+
+        assert_select 'form[action=?]', update_path do
+          assert_select 'input[name=_method][value=?]', 'put'
+          assert_select 'input[name=?]', 'user[password]'
+          assert_select 'input[name=?]', 'user[password_confirmation]'
+        end
+      end
+    end
+
+    def should_display_a_sign_up_form
+      warn "[DEPRECATION] should_display_a_sign_up_form: not meant to be public, no longer used internally"
+      should "display a form to sign up" do
+        assert_select "form[action=#{users_path}][method=post]",
+        true, "There must be a form to sign up" do
+          assert_select "input[type=text][name=?]",
+            "user[email]", true, "There must be an email field"
+          assert_select "input[type=password][name=?]",
+            "user[password]", true, "There must be a password field"
+          assert_select "input[type=password][name=?]",
+            "user[password_confirmation]", true, "There must be a password confirmation field"
+          assert_select "input[type=submit]", true,
+            "There must be a submit button"
+        end
+      end
+    end
+
+    def should_display_a_sign_in_form
+      warn "[DEPRECATION] should_display_a_sign_in_form: not meant to be public, no longer used internally"
+      should 'display a "sign in" form' do
+        assert_select "form[action=#{session_path}][method=post]",
+          true, "There must be a form to sign in" do
+            assert_select "input[type=text][name=?]",
+              "session[email]", true, "There must be an email field"
+            assert_select "input[type=password][name=?]",
+              "session[password]", true, "There must be a password field"
+            assert_select "input[type=checkbox][name=?]",
+              "session[remember_me]", true, "There must be a 'remember me' check box"
+            assert_select "input[type=submit]", true,
+              "There must be a submit button"
+        end
+      end
+    end
+  end
+end
+
+module Clearance
+  module Shoulda
+    module Helpers
+      def sign_in_as(user)
+        @controller.class_eval { attr_accessor :current_user }
+        @controller.current_user = user
+        return user
+      end
+
+      def sign_in
+        sign_in_as Factory(:email_confirmed_user)
+      end
+
+      def sign_out
+        @controller.class_eval { attr_accessor :current_user }
+        @controller.current_user = nil
+      end
+
+      def blank_confirmation_options(attribute)
+        warn "[DEPRECATION] blank_confirmation_options: not meant to be public, no longer used internally"
+        opts = { attribute => attribute.to_s }
+        opts.merge("#{attribute}_confirmation".to_sym => "")
+      end
+
+      def bad_confirmation_options(attribute)
+        warn "[DEPRECATION] bad_confirmation_options: not meant to be public, no longer used internally"
+        opts = { attribute => attribute.to_s }
+        opts.merge("#{attribute}_confirmation".to_sym => "not_#{attribute}")
+      end
+
+      def assert_confirmation_error(model, attribute, message = "confirmation error")
+        warn "[DEPRECATION] assert_confirmation_error: not meant to be public, no longer used internally"
+        assert model.errors.on(attribute).include?("doesn't match confirmation"),
+          message
+      end
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include Clearance::Shoulda::Helpers
+end
+Test::Unit::TestCase.extend(Clearance::Shoulda)

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: activerain-clearance
+version: !ruby/object:Gem::Version 
+  version: 0.6.6
+platform: ruby
+authors: 
+- Dan Croak
+- Mike Burns
+- Jason Morrison
+- Joe Ferris
+- Eugene Bolshakov
+- Nick Quaranto
+- Josh Nichols
+- Mike Breen
+- "Marcel G\xC3\xB6rner"
+- Bence Nagy
+- Ben Mabey
+- Eloy Duran
+- Tim Pope
+- Mihai Anca
+- Mark Cornick
+- Shay Arnett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 21:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Rails authentication with email & password.
+email: support@thoughtbot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.textile
+- LICENSE
+- Rakefile
+- README.textile
+- TODO.textile
+- app/controllers
+- app/controllers/clearance
+- 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
+- app/models/clearance_mailer.rb
+- app/views
+- app/views/clearance_mailer
+- app/views/clearance_mailer/change_password.html.erb
+- app/views/clearance_mailer/confirmation.html.erb
+- app/views/passwords
+- app/views/passwords/edit.html.erb
+- app/views/passwords/new.html.erb
+- app/views/sessions
+- app/views/sessions/new.html.erb
+- app/views/users
+- app/views/users/_form.html.erb
+- app/views/users/new.html.erb
+- config/clearance_routes.rb
+- generators/clearance
+- generators/clearance/clearance_generator.rb
+- generators/clearance/lib
+- generators/clearance/lib/insert_commands.rb
+- generators/clearance/lib/rake_commands.rb
+- generators/clearance/templates
+- generators/clearance/templates/factories.rb
+- generators/clearance/templates/migrations
+- generators/clearance/templates/migrations/create_users.rb
+- generators/clearance/templates/migrations/update_users.rb
+- generators/clearance/templates/README
+- generators/clearance/templates/user.rb
+- generators/clearance/USAGE
+- generators/clearance_features
+- generators/clearance_features/clearance_features_generator.rb
+- generators/clearance_features/templates
+- generators/clearance_features/templates/features
+- generators/clearance_features/templates/features/password_reset.feature
+- generators/clearance_features/templates/features/sign_in.feature
+- generators/clearance_features/templates/features/sign_out.feature
+- generators/clearance_features/templates/features/sign_up.feature
+- generators/clearance_features/templates/features/step_definitions
+- generators/clearance_features/templates/features/step_definitions/clearance_steps.rb
+- generators/clearance_features/templates/features/step_definitions/factory_girl_steps.rb
+- generators/clearance_features/templates/features/support
+- generators/clearance_features/templates/features/support/paths.rb
+- generators/clearance_features/USAGE
+- lib/clearance
+- lib/clearance/authentication.rb
+- lib/clearance/extensions
+- lib/clearance/extensions/errors.rb
+- lib/clearance/extensions/rescue.rb
+- lib/clearance/user.rb
+- lib/clearance.rb
+- shoulda_macros/clearance.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/thoughtbot/clearance
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Rails authentication with email & password.
+test_files: []
+