thoughtbot-clearance 0.1.9 → 0.1.10

data/README.textile

@@ -4,13 +4,6 @@ Simple, complete Ruby web app authentication.
 
 "We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
 
-h2. Features
-
-* email & password
-* modules, not a generator
-* gem, not a plugin
-* tests included using "shoulda":http://thoughtbot.com/projects/shoulda & "factory_girl":http://thoughtbot.com/projects/factory_girl
-
 h2. Gem installation (Rails 2.1+)
 
 Specify the gem dependency in your config/environment.rb file:
@@ -27,6 +20,46 @@ Then:
     rake gems:install
     rake gems:unpack
 
+h2. Generator
+
+In a greenfield application, just run the generator:
+
+    script/generate clearance
+
+This will create:
+
+    app/controllers/confirmations_controller.rb
+    app/controllers/passwords_controller.rb
+    app/controllers/sessions_controller.rb
+    app/controllers/users_controller.rb
+    app/models/user.rb
+    app/models/user_mailer.rb
+    app/views/confirmations/new.html.erb
+    app/views/passwords/edit.html.erb
+    app/views/passwords/new.html.erb
+    app/views/sessions/new.html.erb
+    app/views/user_mailer/change_password.html.erb
+    app/views/user_mailer/confirmation.html.erb
+    app/views/users/_form.html.erb
+    app/views/users/edit.html.erb
+    app/views/users/new.html.erb
+    test/functional/confirmations_controller_test.rb
+    test/functional/passwords_controller_test.rb
+    test/functional/sessions_controller_test.rb
+    test/functional/users_controller_test.rb
+    test/unit/user_mailer_test.rb
+    test/unit/user_test.rb
+
+If you already have some of these files created, the generator will:
+
+# NOT overwrite your files
+# print out instructions to include Clearance modules in those files manually
+
+For example: 
+
+    app/models/user.rb already exists. Add this line to it:
+    include Clearance::Models::User
+
 h2. Tests
 
 The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.0.4 and "Factory Girl":http://thoughtbot.com/projects/factory_girl. You should create a User Factory:
@@ -37,8 +70,8 @@ The tests use "Shoulda":http://thoughtbot.com/projects/shoulda >= 2.0.4 and "Fac
 
     Factory.define :user do |user|
       user.email { Factory.next :email }
-      user.password 'sekrit'
-      user.password_confirmation 'sekrit'
+      user.password "password"
+      user.password_confirmation "password"
     end
 
 In test/test_helper.rb: 
@@ -49,71 +82,6 @@ In test/test_helper.rb:
       include Clearance::TestHelper
     end
 
-In test/unit/user_test.rb: 
-
-    class UserTest < Test::Unit::TestCase
-      include Clearance::UserTest
-    end
-
-In test/unit/user_mailer_test.rb: 
-
-    class UserMailerTest < Test::Unit::TestCase
-      include Clearance::UserMailerTest
-    end
-
-In test/functional/sessions_controller_test.rb: 
-
-    class SessionsControllerTest < ActionController::TestCase
-      include Clearance::SessionsControllerTest
-    end
-
-In test/functional/users_controller_test.rb: 
-
-    class UsersControllerTest < ActionController::TestCase
-      include Clearance::UsersControllerTest
-    end
-
-In test/functional/passwords_controller_test.rb: 
-
-    class PasswordsControllerTest < ActionController::TestCase
-      include Clearance::PasswordsControllerTest
-    end
-
-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
-    
-    add_index :users, :email
-    add_index :users, :remember_token
-
-h2. User Model
-
-In app/models/user.rb:
-
-    class User < ActiveRecord::Base
-      include Clearance::Models::User
-    end
-
-h2. User Mailer
-
-In app/models/user_mailer.rb:
-
-    class UserMailer < ActionMailer::Base
-
-		  default_url_options[:host] = HOST
-
-		  include Clearance::Mailers::User
-
-		end
-
 h2. Controllers
 
 In app/controllers/application_controller.rb:
@@ -124,74 +92,27 @@ In app/controllers/application_controller.rb:
       include Clearance::ApplicationController
     end
 
-In app/controllers/sessions_controller.rb:
-
-    class SessionsController < ApplicationController
-      include Clearance::SessionsController
-
-      private
-
-      def url_after_create
-        root_url # the default
-      end
-
-      def url_after_destroy
-        login_url # the default
-      end
-    end
-
-In app/controllers/users_controller.rb:
-
-    class UsersController < ApplicationController
-      include Clearance::UsersController
-
-      private
-
-      def url_after_create
-        root_url # the default
-      end
-
-      def url_after_update
-        root_url # the default
-      end
-    end
-
-In app/controllers/passwords_controller.rb:
-
-    class PasswordsController < ApplicationController
-      include Clearance::PasswordsController
-    end
-
-h2. Routes
-
-    map.with_options :controller => 'sessions'  do |m|
-      m.login  '/login',  :action => 'new'
-      m.logout '/logout', :action => 'destroy'
-    end
-    map.resource :session
-    map.resources :users, :has_one => :password
-
 h2. Views
 
 In app/views/sessions/new.html.erb
 
-  <% form_for :session, :url => session_path do |f| %>
-	  <div class="group">
-	    <%= f.label :email %>
-	    <%= f.text_field :email %>  
-	  </div>
-	  <div class="group">
-	    <%= f.label :password %>
-	    <%= f.password_field :password %>
-	  </div>
-	  <div class="checkbox">
-	    <%= f.check_box :remember_me %>
-	    <%= f.label :remember_me %>
-	  </div>
-	  <div class="group buttons">
-	    <%= f.submit 'Login', :disable_with => 'Please wait...' %>
-	  </div>
-	<% end %>
+    <% form_for :session, :url => session_path do |f| %>
+      <div class="group">
+        <%= f.label :email %>
+        <%= f.text_field :email %>  
+      </div>
+      <div class="group">
+        <%= f.label :password %>
+        <%= f.password_field :password %>
+      </div>
+      <div class="checkbox">
+        <%= f.check_box :remember_me %>
+        <%= f.label :remember_me %>
+      </div>
+      <div class="group buttons">
+        <%= f.submit 'Login', :disable_with => 'Please wait...' %>
+      </div>
+    <% end %>
 
 h2. Authors
 
@@ -200,4 +121,4 @@ h2. Authors
 * Jason Morrison
 * Mike Burns
 * Josh Nichols
-* Mike Breen
+* Mike Breen

data/clearance.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "clearance"
-  s.version = "0.1.9"
-  s.date = "2008-10-10"
+  s.version = "0.1.10"
+  s.date = "2008-10-11"
   s.summary = "Simple, complete Rails authentication."
   s.email = "dcroak@thoughtbot.com"
   s.homepage = "http://github.com/thoughtbot/clearance"
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "lib/clearance/test/functionals/sessions_controller_test.rb",
     "lib/clearance/test/test_helper.rb",
     "lib/clearance/test/units/user_test.rb",
+    "lib/clearance/test/units/user_mailer_test.rb",
     "lib/clearance/app/controllers/users_controller.rb",
     "lib/clearance/test/functionals/users_controller_test.rb",
     "lib/clearance/app/controllers/passwords_controller.rb",

data/lib/clearance.rb

@@ -1,12 +1,14 @@
 require 'clearance/app/controllers/application_controller'
+require 'clearance/app/controllers/confirmations_controller'
+require 'clearance/app/controllers/passwords_controller'
 require 'clearance/app/controllers/sessions_controller'
 require 'clearance/app/controllers/users_controller'
-require 'clearance/app/controllers/passwords_controller'
 require 'clearance/app/models/user'
 require 'clearance/app/models/user_mailer'
-require 'clearance/test/test_helper'
+require 'clearance/test/functionals/confirmations_controller_test'
 require 'clearance/test/functionals/sessions_controller_test'
 require 'clearance/test/functionals/users_controller_test'
 require 'clearance/test/functionals/passwords_controller_test'
+require 'clearance/test/test_helper'
 require 'clearance/test/units/user_test'
 require 'clearance/test/units/user_mailer_test'

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

@@ -58,6 +58,10 @@ module Clearance
           self.update_attribute :remember_token_expires_at, nil
           self.update_attribute :remember_token, nil
         end
+        
+        def confirm!
+          update_attribute :confirmed, true
+        end
       end
     
       module ProtectedInstanceMethods

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

@@ -17,6 +17,13 @@ module Clearance
           subject    "[YOUR APP] Request to change your password"
           body       :user => user
         end
+        
+        def confirmation(user)
+          recipients user.email
+          from "donotreply@example.com"
+          subject 'Account Confirmation'
+          body :user => user
+        end
       end
     end
   end

data/lib/clearance/test/units/user_mailer_test.rb

@@ -0,0 +1,34 @@
+module Clearance
+  module UserMailerTest
+  
+    def self.included(base)
+      base.class_eval do
+        context "A change password email" do
+          setup do
+            @user = Factory :user
+            @email = UserMailer.create_change_password @user
+          end
+
+          should "set its from address to 'donotreply@example.com'" do
+            assert_equal 'donotreply@example.com', @email.from[0]
+          end
+
+          should "contain a link to edit the user's password" do
+            host = ActionMailer::Base.default_url_options[:host]
+            regexp = %r{http://#{host}/users/#{@user.id}/password/edit\?email=#{@user.email.gsub("@", "%40")}&password=#{@user.crypted_password}}
+            assert_match regexp, @email.body
+          end
+
+          should "be sent to the user" do
+            assert_equal [@user.email], @email.to
+          end
+
+          should "have a subject of '[YOUR APP] Request to change your password'" do
+            assert_equal "[YOUR APP] Request to change your password", @email.subject
+          end
+        end
+      end
+    end
+  
+  end
+end

data/lib/clearance/test/units/user_test.rb

@@ -35,10 +35,10 @@ module Clearance
         
         context 'A user' do
           setup do
-            @password = 'mysekrit'
             @salt = 'salt'
             User.any_instance.stubs(:initialize_salt)
-            @user = Factory(:user, :password => @password, :password_confirmation => @password, :salt => @salt)
+            @user = Factory :user, :salt => @salt
+            @password = @user.password
           end
           
           should "require password validation on update" do
@@ -180,6 +180,23 @@ module Clearance
           end
         end
 
+        context "A user" do
+          setup do
+            @user = Factory :user
+          end
+
+          context 'when sent #confirm!' do
+            setup do
+              assert ! @user.confirmed?
+              assert @user.confirm!
+              @user.reload
+            end
+
+            should 'mark the User record as confirmed' do
+              assert @user.confirmed?
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-clearance
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors: 
 - thoughtbot, inc.
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-10 00:00:00 -07:00
+date: 2008-10-11 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -37,6 +37,7 @@ files:
 - lib/clearance/test/functionals/sessions_controller_test.rb
 - lib/clearance/test/test_helper.rb
 - lib/clearance/test/units/user_test.rb
+- lib/clearance/test/units/user_mailer_test.rb
 - lib/clearance/app/controllers/users_controller.rb
 - lib/clearance/test/functionals/users_controller_test.rb
 - lib/clearance/app/controllers/passwords_controller.rb