dancroak-clearance 0.1.1 → 0.1.2

data/README.textile

@@ -1,6 +1,6 @@
 h1. Clearance
 
-Simple, complete Rails authentication. 
+Simple, complete Ruby web app authentication. 
 
 "We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
 
@@ -9,50 +9,65 @@ h2. Features
 * email & password
 * modules, not a generator
 * gem, not a plugin
-* should & factory_girl tests included
+* shoulda & factory_girl tests included
+
+h2. Gem installation (Rails 2.1+)
+
+Specify the gem dependency in your config/environment.rb file:
+
+    Rails::Initializer.run do |config|
+      # ...
+      config.gem "dancroak-clearance", :lib => 'clearance', 
+        :source => 'http://gems.github.com/'
+    end
+
+Then:
+
+    rake gems:install
+    rake gems:unpack
 
 h2. Schema
 
 Change your User model so it has these attributes.
 
-    change_table(:users) do |t|
-		  t.column :email, :string
-		  t.column :crypted_password, :string, :limit => 40
-		  t.column :salt, :string, :limit => 40
-		  t.column :remember_token, :string
-		  t.column :remember_token_expires_at, :datetime
-		end
+  change_table(:users) do |t|
+    t.column :email, :string
+    t.column :crypted_password, :string, :limit => 40
+    t.column :salt, :string, :limit => 40
+    t.column :remember_token, :string
+    t.column :remember_token_expires_at, :datetime
+  end
 
-	  add_index :users, [:email, :password]
+  add_index :users, [:email, :crypted_password]
 
-h2. Model
+h2. User Model
 
 In app/models/user.rb:
 
-    include Clearance::Model
+  include Clearance::Model
 
 h2. Controllers
 
 In app/controllers/application_controller.rb:
 
-    include Clearance::ApplicationController
+  include Clearance::ApplicationController
 
 In app/controllers/sessions_controller.rb:
 
-    include Clearance::SessionsController
+  include Clearance::SessionsController
 
 In app/controllers/users_controller.rb:
 
-    include Clearance::UsersController
+  include Clearance::UsersController
 
 h2. Routes
 
-    map.root # :controller => 'sessions'
-    map.with_options :controller => 'sessions'  do |m|
-	    m.login  '/login',  :action => 'new'
-	    m.logout '/logout', :action => 'destroy'
-	  end
-	  map.resource :sessions
+  map.root # :controller => 'sessions'
+  map.with_options :controller => 'sessions'  do |m|
+    m.login  '/login',  :action => 'new'
+    m.logout '/logout', :action => 'destroy'
+  end
+  map.resource :sessions
 
 h2. Tests
 
@@ -60,23 +75,23 @@ The tests use Shoulda and Factory Girl.
 
 In test/test_helper.rb: 
 
-    include Clearance::TestHelper
+  include Clearance::TestHelper
 
 In test/unit/user_test.rb: 
 
-    include Clearance::UnitTest
+  include Clearance::UserTest
 
 In test/functional/sessions_controller_test.rb: 
 
-    include Clearance::SessionsControllerTest
+  include Clearance::SessionsControllerTest
 
 In test/functional/users_controller_test.rb: 
 
-    include Clearance::UsersControllerTest
+  include Clearance::UsersControllerTest
 
 h2. Authors
 
 * thoughtbot, inc.
 * Dan Croak
 * Josh Nichols
-* Mike Breen
+* Mike Breen

data/clearance.gemspec

@@ -1,11 +1,21 @@
 Gem::Specification.new do |s|
   s.name = "clearance"
-  s.version = "0.1.1"
-  s.date = "2008-09-10"
+  s.version = "0.1.2"
+  s.date = "2008-09-16"
   s.summary = "Simple, complete Rails authentication."
   s.email = "dcroak@thoughtbot.com"
   s.homepage = "http://github.com/dancroak/clearance"
   s.description = "Simple, complete Rails authentication scheme."
   s.authors = ["thoughtbot, inc.", "Dan Croak", "Josh Nichols", "Mike Breen"]
-  s.files = ["README.textile", "clearance.gemspec", "lib/clearance.rb", "lib/clearance/application_controller.rb", "lib/clearance/model.rb", "lib/clearance/sessions_controller.rb", "lib/clearance/sessions_controller_test.rb", "lib/clearance/test_helper.rb", "lib/clearance/unit_test.rb", "lib/clearance/users_controller.rb", "lib/clearance/users_controller_test.rb"]
+  s.files = ["README.textile", 
+    "clearance.gemspec", 
+    "lib/clearance.rb", 
+    "lib/clearance/app/controllers/application_controller.rb", 
+    "lib/clearance/app/models/model.rb", 
+    "lib/clearance/app/controllers/sessions_controller.rb", 
+    "lib/clearance/test/functionals/sessions_controller_test.rb", 
+    "lib/clearance/test_helper.rb", 
+    "lib/clearance/test/units/user_test.rb", 
+    "lib/clearance/app/controllers/users_controller.rb", 
+    "lib/clearance/test/controllers/users_controller_test.rb"]
 end

data/lib/clearance/{application_controller.rb → app/controllers/application_controller.rb}

@@ -25,7 +25,7 @@ module Clearance
 
     module ProtectedInstanceMethods
       def authenticate
-        deny_access if self.current_user.nil?
+        deny_access unless self.current_user
       end
 
       def user_from_session

data/lib/clearance/{sessions_controller.rb → app/controllers/sessions_controller.rb}

@@ -61,6 +61,5 @@ module Clearance
         cookies.delete :auth_token
       end
     end
-
   end
 end

data/lib/clearance/{users_controller.rb → app/controllers/users_controller.rb}

@@ -18,6 +18,7 @@ module Clearance
 
     module InstanceMethods
       def index
+        @users = User.find :all
       end
       
       def new
@@ -63,6 +64,7 @@ module Clearance
 
     module PrivateInstanceMethods
       def ensure_user_is_accessing_self
+        return if current_user and current_user.respond_to?(:admin?) and current_user.admin?
         deny_access 'You cannot edit that user.' unless current_user.id.to_i == params[:id].to_i
       end
     end

data/lib/clearance/{model.rb → app/models/model.rb}

@@ -8,9 +8,8 @@ module Clearance
         attr_accessor :password, :password_confirmation
 
         validates_presence_of     :email
-        validates_presence_of     :password,                   :if => :password_required?
-        validates_length_of       :password, :within => 3..40, :if => :password_required?
-        validates_confirmation_of :password,                   :if => :password_required?
+        validates_presence_of     :password, :if => :password_required?
+        validates_confirmation_of :password, :if => :password_required?
         validates_uniqueness_of   :email
 
         before_save :initialize_salt, :encrypt_password
@@ -27,14 +26,9 @@ module Clearance
     
     module ClassMethods
       def authenticate(email, password)
-        user = find_by_email(email) # need to get the salt
+        user = find_by_email email
         user && user.authenticated?(password) ? user : nil
       end
-
-      def authenticate_via_auth_token(token)
-        return nil if token.blank?
-        find_by_auth_token(token)
-      end
     end
     
     module InstanceMethods
@@ -43,7 +37,7 @@ module Clearance
       end
 
       def encrypt(password)
-        Digest::SHA1.hexdigest("--#{salt}--#{password}--")
+        Digest::SHA1.hexdigest "--#{salt}--#{password}--"
       end
 
       def remember_token?

data/lib/clearance/{sessions_controller_test.rb → test/functionals/sessions_controller_test.rb}

@@ -10,20 +10,20 @@ module Clearance
 
           should_filter :password
 
-          # context "on GET to /sessions/new" do
-          #   setup { get :new }
-          # 
-          #   should_respond_with :success
-          #   should_render_template :new
-          #   should_not_set_the_flash
-          #   should "render a login form" do
-          #     assert_select "form[action=/session]" do
-          #       assert_select "input[type=text][name=?]",     "session[email]"
-          #       assert_select "input[type=password][name=?]", "session[password]"
-          #       assert_select "input[type=checkbox][name=?]", "session[remember_me]"
-          #     end
-          #   end
-          # end
+          context "on GET to /sessions/new" do
+            setup { get :new }
+          
+            should_respond_with :success
+            should_render_template :new
+            should_not_set_the_flash
+            should "have login form" do
+              assert_select "form[action$=/session]" do
+                assert_select "input[type=text][name=?]",     "session[email]"
+                assert_select "input[type=password][name=?]", "session[password]"
+                assert_select "input[type=checkbox][name=?]", "session[remember_me]"
+              end
+            end
+          end
 
           context "a POST to #create with good credentials" do
             setup do
@@ -32,6 +32,7 @@ module Clearance
 
             should_set_the_flash_to /success/i
             should_redirect_to 'root_url'
+            # should set session
           end
 
           context "a POST to #create with bad credentials" do
@@ -41,7 +42,10 @@ module Clearance
 
             should_set_the_flash_to /bad/i
             should_render_template :new
+            # should not set session
           end
+          
+          # two tests for remember me - success and failure
         end
 
         context "While logged out" do

data/lib/clearance/{unit_test.rb → test/units/user_test.rb}

@@ -1,5 +1,5 @@
 module Clearance
-  module UnitTest
+  module UserTest
     
     def self.included(base)
       base.class_eval do

data/lib/clearance.rb

@@ -1,8 +1,8 @@
-require 'clearance/application_controller'
-require 'clearance/sessions_controller'
-require 'clearance/users_controller'
-require 'clearance/model'
-require 'clearance/test_helper'
-require 'clearance/sessions_controller_test'
-require 'clearance/users_controller_test'
-require 'clearance/unit_test'
+require 'clearance/app/controllers/application_controller'
+require 'clearance/app/controllers/sessions_controller'
+require 'clearance/app/controllers/users_controller'
+require 'clearance/app/models/model'
+require 'clearance/test/test_helper'
+require 'clearance/test/functionals/sessions_controller_test'
+require 'clearance/test/functionals/users_controller_test'
+require 'clearance/test/units/user_test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dancroak-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-10 00:00:00 -07:00
+date: 2008-09-16 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,14 +28,14 @@ files:
 - README.textile
 - clearance.gemspec
 - lib/clearance.rb
-- lib/clearance/application_controller.rb
-- lib/clearance/model.rb
-- lib/clearance/sessions_controller.rb
-- lib/clearance/sessions_controller_test.rb
+- lib/clearance/app/controllers/application_controller.rb
+- lib/clearance/app/models/model.rb
+- lib/clearance/app/controllers/sessions_controller.rb
+- lib/clearance/test/functionals/sessions_controller_test.rb
 - lib/clearance/test_helper.rb
-- lib/clearance/unit_test.rb
-- lib/clearance/users_controller.rb
-- lib/clearance/users_controller_test.rb
+- lib/clearance/test/units/user_test.rb
+- lib/clearance/app/controllers/users_controller.rb
+- lib/clearance/test/controllers/users_controller_test.rb
 has_rdoc: false
 homepage: http://github.com/dancroak/clearance
 post_install_message: 

data/lib/clearance/test_helper.rb

@@ -1,73 +0,0 @@
-module Clearance 
-  module TestHelper
-    
-    def self.included(base)
-      base.class_eval do
-        include InstanceMethods
-        extend ClassMethods
-      end
-    end
-
-    module InstanceMethods
-      def login_as(user = nil)
-        user ||= Factory(:user)
-        @request.session[:user_id] = user.id
-        return user
-      end
-
-      def logout 
-        @request.session[:user_id] = nil
-      end
-    end
-    
-    module ClassMethods
-      def should_deny_access_on(command, opts = {})
-        opts[:redirect] ||= "root_url"
-
-        context "on #{command}" do
-          setup { eval command }
-          should_redirect_to opts[:redirect]
-          if opts[:flash]
-            should_set_the_flash_to opts[:flash]
-          else
-            should_not_set_the_flash
-          end
-        end
-      end
-      
-      def should_filter(*keys)
-        keys.each do |key|
-          should "filter #{key}" do
-            assert @controller.respond_to?(:filter_parameters),
-              "The key #{key} is not filtered"
-            filtered = @controller.send(:filter_parameters, {key.to_s => key.to_s})
-            assert_equal '[FILTERED]', filtered[key.to_s],
-              "The key #{key} is not filtered"
-          end
-        end
-      end
-      
-      def should_have_user_form
-        should "have the user form" do
-          assert_select "form" do
-            assert_select "input[type=text][name=?]", "user[email]"
-            %w(password password_confirmation).each do |field|
-              assert_select "input[type=password][name=?]", "user[#{field}]"
-            end
-          end
-        end
-      end
-
-      def logged_in_user_context(&blk)
-        context "When logged in as a user" do
-          setup do
-            @user = Factory :user
-            login_as @user
-          end
-          merge_block(&blk)
-        end
-      end
-    end
-  
-  end
-end

data/lib/clearance/users_controller_test.rb

@@ -1,75 +0,0 @@
-module Clearance
-  module UsersControllerTest
-  
-    def self.included(base)
-      base.class_eval do
-        logged_in_user_context do
-
-          should_deny_access_on "get :new"
-          should_deny_access_on "post :create, :user => {}" 
-          should_filter :password
-
-          context "viewing their account" do
-            context "on GET to /users/:id/show" do
-              setup { get :show, :id => @user.to_param }
-              should_respond_with :success
-              should_render_template :show
-              should_not_set_the_flash
-              
-              should 'assign to @user' do
-                assert_equal @user, assigns(:user)
-              end
-            end
-
-            should_deny_access_on "delete :destroy, :id => @user.to_param"
-
-            context "on GET to /users/:id/edit" do
-              setup { get :edit, :id => @user.to_param }
-
-              should_respond_with :success
-              should_render_template :edit
-              should_not_set_the_flash
-              should_assign_to :user
-              should_have_user_form
-            end
-
-            context "on PUT to /users/:id" do
-              setup do
-                put :update, 
-                  :id => @user.to_param, 
-                  :user => { :email => "none@example.com" }
-              end
-              should_set_the_flash_to /updated/i
-              should_redirect_to "root_url"
-              should_assign_to :user
-              should "update the user's attributes" do
-                assert_equal "none@example.com", assigns(:user).email
-              end
-            end
-
-            context "on PUT to /users/:id with invalid attributes" do
-              setup { put :update, :id => @user.to_param, :user => {:email => ''} }
-              should_not_set_the_flash
-              should_assign_to :user
-              should_render_template 'edit'
-              should "display errors" do
-                assert_select '#errorExplanation'
-              end
-            end
-          end
-
-          context "dealing with another user's account" do
-            setup do
-              @user = Factory :user
-            end
-
-            should_deny_access_on "get :show, :id => @user.to_param",                :flash => /cannot edit/i
-            should_deny_access_on "get :edit, :id => @user.to_param",                :flash => /cannot edit/i
-            should_deny_access_on "put :update, :id => @user.to_param, :user => {}", :flash => /cannot edit/i
-          end
-        end
-      end
-    end
-
-  end
-end