thoughtbot-clearance 0.2.0 → 0.2.2

data/Rakefile

@@ -0,0 +1,99 @@
+require 'rake'
+require 'rake/testtask'
+require 'date'
+require 'activerecord'
+require 'lib/clearance/version'
+
+test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_test.rb'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = test_files_pattern
+  t.verbose = false
+end
+
+desc "Run the test suite"
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name = "clearance"
+  s.version = "#{Clearance::Version::MAJOR}.#{Clearance::Version::MINOR}.#{Clearance::Version::PATCH}"
+  date = DateTime.now
+  s.date = "#{date.year}-#{date.month}-#{date.day}"
+  s.summary = "Simple, complete Rails authentication."
+  s.email = "dcroak@thoughtbot.com"
+  s.homepage = "http://github.com/thoughtbot/clearance"
+  s.description = "Simple, complete Rails authentication scheme."
+  s.authors = ["thoughtbot, inc.", "Dan Croak", "Josh Nichols", "Mike Breen", "Mike Burns", "Jason Morrison"]
+  s.files = FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+end
+
+namespace :gemspec do
+  desc "Generate a gemspec file for GitHub"
+  task :write do
+    File.open("#{spec.name}.gemspec", 'w') do |f|
+      f.write spec.to_ruby
+    end
+  end
+  
+  namespace :bump do
+    desc "Bump the gemspec a major version."
+    task :major do
+      major = Clearance::Version::MAJOR + 1
+      File.open("lib/clearance/version.rb", 'w') do |file|
+        file.write <<-END
+module Clearance
+  module Version
+    MAJOR = #{major}
+    MINOR = 0
+    PATCH = 0
+  end
+end
+        END
+      end
+      
+      spec.version = "#{major}.0.0"
+      Rake::Task["gemspec:write"].invoke
+      puts "Gem bumped to #{spec.version}"
+    end
+    
+    desc "Bump the gemspec a minor version."
+    task :minor do
+      minor = Clearance::Version::MINOR + 1
+      File.open("lib/clearance/version.rb", 'w') do |file|
+        file.write <<-END
+module Clearance
+  module Version
+    MAJOR = #{Clearance::Version::MAJOR}
+    MINOR = #{minor}
+    PATCH = 0
+  end
+end
+        END
+      end
+      
+      spec.version = "#{Clearance::Version::MAJOR}.#{minor}.0"
+      Rake::Task["gemspec:write"].invoke
+      puts "Gem bumped to #{spec.version}"
+    end
+    
+    desc "Bump the gemspec a patch version."
+    task :patch do
+      patch = Clearance::Version::PATCH + 1
+      File.open("lib/clearance/version.rb", 'w') do |file|
+        file.write <<-END
+module Clearance
+  module Version
+    MAJOR = #{Clearance::Version::MAJOR}
+    MINOR = #{Clearance::Version::MINOR}
+    PATCH = #{patch}
+  end
+end
+        END
+      end
+      
+      spec.version = "#{Clearance::Version::MAJOR}.#{Clearance::Version::MINOR}.#{patch}"
+      Rake::Task["gemspec:write"].invoke
+      puts "Gem bumped to #{spec.version}"
+    end
+  end
+end

data/TODO.textile

@@ -0,0 +1,21 @@
+(this is in order of highest priority first)
+
+# Gemspec rake task
+# sessions controller test is missing some tests
+# mailers should not hardcode example.com as from address
+# check to make sure attr_accessible doesn't override and w/ attr_protected
+# helpers and tests shouldn't depend on login/logout routes
+# move shoulda macros in test_helper to shoulda_macros folder
+# refactor Mailer default_url_options[:host] to something cleaner
+
+ideas stolen from merb-auth:
+
+# store current_user on the session, not controller
+# respond with 401 Unauthorized when request requires authentication 
+# respond with 405 Method Not Allowed when action requested isn’t allowed
+# email confirmation is a strategy
+# forgot password is a strategy
+# salted password is a strategy
+# 401 and 405 need to be in Exceptions controller
+
+http://adam.speaksoutofturn.com/articles/entication_vs_orization.html

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

@@ -0,0 +1,17 @@
+<% form_for :session, :url => session_path do |form| %>
+  <div class="group">
+    <%= form.label :email %>
+    <%= form.text_field :email %>  
+  </div>
+  <div class="group">
+    <%= form.label :password %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="checkbox">
+    <%= form.check_box :remember_me %>
+    <%= form.label :remember_me %>
+  </div>
+  <div class="group buttons">
+    <%= form.submit 'Login', :disable_with => 'Please wait...' %>
+  </div>
+<% end %>

data/generators/clearance/templates/app/views/user_mailer/change_password.html.erb

@@ -0,0 +1,6 @@
+Someone, hopefully you, has requested that we send you a link to change your password.
+
+Here's the link:
+<%= edit_user_password_url @user, :email => @user.email, :password => @user.crypted_password %>
+
+If you didn't request this, no need to freak out, your password hasn't been changed.  You can just ignore this email.

data/generators/clearance/templates/app/views/user_mailer/confirmation.html.erb

@@ -0,0 +1 @@
+<%= new_user_confirmation_url :user_id => @user, :salt => @user.salt %>

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

@@ -0,0 +1,7 @@
+<%= form.error_messages %>
+<%= form.label :email %>
+<%= form.text_field :email %>
+<%= form.label :password %>
+<%= form.password_field :password %>
+<%= form.label :password_confirmation %>
+<%= form.password_field :password_confirmation %>

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

@@ -0,0 +1,4 @@
+<% 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,4 @@
+<% form_for @user do |form| %>
+  <%= render :partial => '/users/form', :object => form %>
+  <%= form.submit 'Sign up', :disable_with => 'Please wait...' %>
+<% 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::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::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::SessionsControllerTest
+end

data/lib/clearance/test/functionals/users_controller_test.rb

@@ -0,0 +1,60 @@
+module Clearance
+  module UsersControllerTest
+
+    def self.included(base)
+      base.class_eval do
+        public_context do
+
+          context "on GET to /users/new" do
+            setup { get :new }
+            should_respond_with :success
+            should_render_template :new
+            should_not_set_the_flash
+            should_have_form :action => "users_path",
+              :method => :post,
+              :fields => { :email => :text,
+                :password => :password,
+                :password_confirmation => :password }
+
+            context "with params" do
+              setup do
+                @email = 'a@example.com'
+                get :new, :user => {:email => @email}
+              end
+
+              should_assign_to :user
+              should "set the @user's params" do
+                assert_equal @email, assigns(:user).email
+              end
+            end
+          end
+
+          context "on POST to /users" do
+            setup do
+              post :create, :user => {
+                :email => Factory.next(:email),
+                :password => 'skerit',
+                :password_confirmation => 'skerit'
+              }
+            end
+            
+            should_set_the_flash_to /created/i
+            should_redirect_to "@controller.send(:url_after_create)"
+            should_assign_to :user
+            should_change 'User.count', :by => 1
+          end
+
+        end
+
+        logged_in_user_context do
+
+          should_deny_access_on "get :new"
+          should_deny_access_on "post :create, :user => {}" 
+          should_filter_params :password
+
+        end
+      end
+    end
+
+  end
+end

data/lib/clearance/version.rb

@@ -0,0 +1,7 @@
+module Clearance
+  module Version
+    MAJOR = 0
+    MINOR = 2
+    PATCH = 2
+  end
+end

data/lib/clearance.rb

@@ -12,3 +12,4 @@ 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'
+require 'clearance/version'

data/test/rails_root/Capfile

@@ -0,0 +1,3 @@
+load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+load 'config/deploy'

data/test/rails_root/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/rails_root/app/controllers/application.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  helper :all
+  protect_from_forgery
+  include Clearance::ApplicationController
+end

data/test/rails_root/app/controllers/confirmations_controller.rb

@@ -0,0 +1,3 @@
+class ConfirmationsController < ApplicationController
+  include Clearance::ConfirmationsController
+end

data/test/rails_root/app/controllers/passwords_controller.rb

@@ -0,0 +1,3 @@
+class PasswordsController < ApplicationController
+  include Clearance::PasswordsController
+end

data/test/rails_root/app/controllers/sessions_controller.rb

@@ -0,0 +1,3 @@
+class SessionsController < ApplicationController
+  include Clearance::SessionsController
+end

data/test/rails_root/app/controllers/users_controller.rb

@@ -0,0 +1,3 @@
+class UsersController < ApplicationController
+  include Clearance::UsersController
+end

data/test/rails_root/app/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def body_class
+    "#{controller.controller_name} #{controller.controller_name}-#{controller.action_name}"
+  end
+end

data/test/rails_root/app/helpers/confirmations_helper.rb

@@ -0,0 +1,2 @@
+module ConfirmationsHelper
+end

data/test/rails_root/app/helpers/passwords_helper.rb

@@ -0,0 +1,2 @@
+module PasswordsHelper
+end

data/test/rails_root/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include Clearance::Models::User
+end

data/test/rails_root/app/models/user_mailer.rb

@@ -0,0 +1,7 @@
+class UserMailer < ActionMailer::Base
+  
+  default_url_options[:host] = HOST
+  
+  include Clearance::Mailers::User
+
+end

data/test/rails_root/app/views/confirmations/new.html.erb

@@ -0,0 +1,4 @@
+<% form_for :user, :url => user_confirmation_path(:user_id => @user,
+                                                  :salt => @user.salt) do |form| %>
+  <%= form.submit 'Confirm' %>
+<% end %>

data/test/rails_root/app/views/layouts/_flashes.erb

@@ -0,0 +1,5 @@
+<div id="flash">
+  <% flash.each do |key, value| -%>
+    <div id="flash_<%= key %>"><%=h value %></div>
+  <% end %>
+</div>

data/test/rails_root/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+    <title><%= PROJECT_NAME.humanize %></title>
+    <%= stylesheet_link_tag 'screen', :media => 'all' %>
+    <%= javascript_include_tag :defaults %>
+  </head>
+  <body class="<%= body_class %>">
+    <%= render :partial => 'layouts/flashes' %>
+    <%= yield %>
+  </body>
+</html>

data/test/rails_root/app/views/passwords/edit.html.erb

@@ -0,0 +1,28 @@
+<div class="page">
+  <div class="plain">
+    <div class="page-header">
+      <h2 class="instructions">
+        Your password has been reset.  Choose a new password below.
+      </h2>
+    </div>
+    <%= error_messages_for :user %>
+    <% form_for(:user,
+                :url => user_password_path(
+                  @user,
+                  :email => @user.email,
+                  :password => @user.crypted_password),
+                :html => { :method => :put }) do |form| %>
+      <div class="text">
+        <%= form.label :password, 'Choose password' %>
+        <%= form.password_field :password %>
+      </div>
+      <div class="text">
+        <%= form.label :password_confirmation, 'Verify password' %>
+        <%= form.password_field :password_confirmation %>
+      </div>
+      <div class="buttons" id="password-submit">
+        <%= form.submit 'Save this password' %>
+      </div>
+    <% end %>
+  </div>
+</div>

data/test/rails_root/app/views/passwords/new.html.erb

@@ -0,0 +1,13 @@
+<h2>Change your password</h2>
+
+<p class="help">We'll email you a link to change your password.</p>
+
+<% form_for :password, :url => passwords_path do |form| %>
+  <div class="text">
+    <%= form.label :email, 'Email address' %>
+    <%= form.text_field :email %>
+  </div>
+  <div class="buttons" id="password-submit">
+    <%= form.submit 'Reset password' %>
+  </div>
+<% end %>

data/test/rails_root/app/views/sessions/new.html.erb

@@ -0,0 +1,17 @@
+<% form_for :session, :url => session_path do |form| %>
+  <div class="group">
+    <%= form.label :email %>
+    <%= form.text_field :email %>  
+  </div>
+  <div class="group">
+    <%= form.label :password %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="checkbox">
+    <%= form.check_box :remember_me %>
+    <%= form.label :remember_me %>
+  </div>
+  <div class="group buttons">
+    <%= form.submit 'Login', :disable_with => 'Please wait...' %>
+  </div>
+<% end %>

data/test/rails_root/app/views/user_mailer/change_password.html.erb

@@ -0,0 +1,6 @@
+Someone, hopefully you, has requested that we send you a link to change your password.
+
+Here's the link:
+<%= edit_user_password_url @user, :email => @user.email, :password => @user.crypted_password %>
+
+If you didn't request this, no need to freak out, your password hasn't been changed.  You can just ignore this email.

data/test/rails_root/app/views/user_mailer/confirmation.html.erb

@@ -0,0 +1 @@
+<%= new_user_confirmation_url :user_id => @user, :salt => @user.salt %>

data/test/rails_root/app/views/users/_form.html.erb

@@ -0,0 +1,7 @@
+<%= form.error_messages %>
+<%= form.label :email %>
+<%= form.text_field :email %>
+<%= form.label :password %>
+<%= form.password_field :password %>
+<%= form.label :password_confirmation %>
+<%= form.password_field :password_confirmation %>

data/test/rails_root/app/views/users/edit.html.erb

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

data/test/rails_root/app/views/users/new.html.erb

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

data/test/rails_root/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/rails_root/config/database.yml

@@ -0,0 +1,13 @@
+development:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+  timeout: 5000
+

data/test/rails_root/config/environment.rb

@@ -0,0 +1,17 @@
+PROJECT_NAME = "clearance"
+RAILS_GEM_VERSION = '2.1.1' unless defined? RAILS_GEM_VERSION
+require File.join(File.dirname(__FILE__), 'boot')
+require 'md5' # Need this up here to generate the session[:secret] value down there
+
+Rails::Initializer.run do |config|
+  config.load_paths += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'gems', '*', 'lib'))
+  config.time_zone = 'Eastern Time (US & Canada)'
+  config.action_controller.session = {
+    :session_key => "_#{PROJECT_NAME}_session",
+    :secret      => [PROJECT_NAME, 'random', 'words', 'here'].map {|k| Digest::MD5.hexdigest(k) }.join
+  }
+  config.gem 'thoughtbot-shoulda', :lib => 'shoulda', :source => 'http://gems.github.com'
+end
+
+
+

data/test/rails_root/config/environments/development.rb

@@ -0,0 +1,20 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_extensions         = false
+config.action_view.debug_rjs                         = true
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false
+
+HOST = "localhost"

data/test/rails_root/config/environments/test.rb

@@ -0,0 +1,24 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+HOST = "localhost"