kellyfelkins-clearance 0.5.6

data/CHANGELOG.textile

@@ -0,0 +1,84 @@
+h1. 0.5.5 (3/23/2009)
+
+* Removing duplicate test to get rid of warning. (Nick Quaranto)
+
+h1. 0.5.4 (3/21/2009)
+
+* When users fail logging in, redirect them instead of rendering. (Matt
+Jankowski)
+
+h1. 0.5.3 (3/5/2009)
+
+* Clearance now works with (and requires) Shoulda 2.10.0. (Mark Cornick, Joe
+Ferris, Dan Croak)
+* Prefer flat over nested contexts in sessions_controller_test. (Joe Ferris,
+Dan Croak)
+
+h1. 0.5.2 (3/2/2009)
+
+* Fixed last remaining errors in Rails 2.3 tests. Now fully compatible. (Joe
+Ferris, Dan Croak)
+
+h1. 0.5.1 (2/27/2009)
+
+* [#46] A user with unconfirmed email who resets password now confirms email.
+(Marcel Görner)
+* Refactored user_from_cookie, user_from_session, User#authenticate to use
+more direct return code instead of ugly, harder to read ternary. (Dan Croak)
+* Switch order of cookies and sessions to take advantage of Rails 2.3's "Rack-based lazy-loaded sessions":http://is.gd/i23E. (Dan Croak)
+* Altered generator to interact with application_controller.rb instead of
+application.rb in Rails 2.3 apps. (Dan Croak)
+* [#42] Bug fix. Rack-based session change altered how to test remember me
+cookie. (Mihai Anca)
+
+h2. 0.5.0 (2/27/2009)
+
+* Fixed problem with Cucumber features. (Dan Croak)
+* Fixed mising HTTP fluency use case. (Dan Croak)
+* Refactored User#update_password to take just parameters it needs. (Dan
+Croak)
+* Refactored User unit tests to be more readable. (Dan Croak)
+
+h2. 0.4.9 (2/20/2009)
+
+* Protect passwords & confirmations actions with forbidden filters. (Dan Croak)
+* Return 403 Forbidden status code in those cases. (Tim Pope)
+* Test 403 Forbidden status code in Cucumber feature. (Dan Croak, Joe Ferris)
+* Raise custom ActionController::Forbidden error internally. (Joe Ferris, Mike Burns, Jason Morrison)
+* Test ActionController::Forbidden error is raised in functional test. (Joe Ferris, Mike Burns, Dan Croak)
+* [#45] Fixed bug that allowed anyone to edit another user's password (Marcel Görner)
+* Required Factory Girl >= 1.2.0. (Dan Croak)
+
+h2. 0.4.8 (2/16/2009)
+
+* Added support paths for Cucumber. (Ben Mabey)
+* Added documentation for the flash. (Ben Mabey)
+* Generators require "test_helper" instead of File.join. for rr compatibility. (Joe Ferris)
+* Removed interpolated email address from flash message to make i18n easier. (Bence Nagy)
+* Standardized flash messages that refer to email delivery. (Dan Croak)
+
+h2. 0.4.7 (2/12/2009)
+
+* Removed Clearance::Test::TestHelper so there is one less setup step. (Dan Croak)
+* All test helpers now in shoulda_macros. (Dan Croak)
+
+h2. 0.4.6 (2/11/2009)
+
+* Made the modules behave like mixins again. (hat-tip Eloy Duran)
+* Created Actions and PrivateMethods modules on controllers for future RDoc reasons. (Dan Croak, Joe Ferris)
+
+h2. 0.4.5 (2/9/2009)
+
+* [#43] Removed email downcasing because local-part is case sensitive per RFC5321. (Dan Croak)
+* [#42] Removed dependency on Mocha. (Dan Croak)
+* Required Shoulda >= 2.9.1. (Dan Croak)
+* Added password reset feature to clearance_features generator. (Eugene Bolshakov, Dan Croak)
+* Removed unnecessary session[:salt]. (Dan Croak)
+* [#41] Only store location for session[:return_to] for GET requests. (Dan Croak)
+* Audited "sign up" naming convention. "Register" had slipped in a few places. (Dan Croak)
+* Switched to SHA1 encryption. Cypher doesn't matter much for email confirmation, password reset. Better to have shorter hashes in the emails for clients who line break on 72 chars. (Dan Croak)
+
+h2. 0.4.4 (2/2/2009)
+
+* Added a generator for Cucumber features. (Joe Ferris, Dan Croak)
+* Standarized naming for "Sign up," "Sign in," and "Sign out". (Dan Croak) 

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 thoughtbot, inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.textile

@@ -0,0 +1,76 @@
+h1. Clearance
+
+Rails authentication for developers who write tests.
+
+"We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
+
+h2. Wiki
+
+Most information regarding Clearance is on the "Github Wiki":http://wiki.github.com/thoughtbot/clearance.
+
+h2. Integration with Suspenders
+
+Clearance is based on the same conventions and tools as "Suspenders":http://github.com/thoughtbot/suspenders If you use it, you already have some configuration mentioned below.
+
+h2. Gem installation (Rails 2.1+)
+
+In config/environment.rb:
+
+    config.gem "thoughtbot-clearance", 
+      :lib     => 'clearance', 
+      :source  => 'http://gems.github.com', 
+      :version => '0.5.3'
+
+In config/environments/test.rb:
+
+    config.gem 'thoughtbot-shoulda',
+      :lib     => 'shoulda',
+      :source  => "http://gems.github.com", 
+      :version => '2.10.0'
+    config.gem 'thoughtbot-factory_girl',
+      :lib     => 'factory_girl',
+      :source  => "http://gems.github.com", 
+      :version => '1.2.0'
+
+Then:
+
+    rake gems:install
+    rake gems:unpack 
+    rake gems:install RAILS_ENV=test
+    rake gems:unpack  RAILS_ENV=test
+
+h2. The generator
+
+Make sure the development database exists and run the generator:
+
+    script/generate clearance
+
+A number of files will be created and instructions will be printed.
+
+You may already have some of these files. Don't worry. You'll be asked if you want to overwrite them.
+
+h2. Features
+
+If you are using Cucumber on your application Clearance comes with a feature generator:
+
+    script/generate clearance_features
+
+All of the files generated should be new with the exception of the features/support/paths.rb file.  If you have not modified your paths.rb then you will be okay to replace it with this one.  If you need to keep your paths.rb file then you will need to add these locations in your paths.rb manually:
+
+    def path_to(page_name)
+      case page_name
+       ...
+      when /the sign up page/i
+       new_user_path
+      when /the sign in page/i
+       new_session_path 
+      when /the password reset request page/i
+       new_password_path
+      ...
+    end
+
+h2. Authors
+
+Clearance was extracted out of "Hoptoad":http://hoptoadapp.com. We merged the authentication code from two of thoughtbot's client's Rails apps. The following people have made significant contributions, suggestions, and generally improved the library. Thank you!
+
+Dan Croak, Mike Burns, Jason Morrison, Joe Ferris, Eugene Bolshakov, Josh Nichols, Mike Breen, Marcel Görner, Bence Nagy, Ben Mabey, Eloy Duran, Tim Pope, Mihai Anca, & Mark Cornick.

data/Rakefile

@@ -0,0 +1,73 @@
+require 'rake'
+require 'rake/testtask'
+require 'cucumber/rake/task'
+
+test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_test.rb'
+
+namespace :test do
+  Rake::TestTask.new(:all => ['generator:cleanup', 
+                              'generator:generate']) do |task|
+    task.libs << 'lib'
+    task.libs << File.join(File.dirname(__FILE__), "test/rails_root/test")
+    task.pattern = test_files_pattern
+    task.verbose = false
+  end
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--format pretty"
+    t.feature_pattern = 'test/rails_root/features/*.feature'
+  end
+end
+
+generators = %w(clearance clearance_features)
+
+namespace :generator do
+  desc "Cleans up the test app before running the generator"
+  task :cleanup do
+    generators.each do |generator|
+      FileList["generators/#{generator}/templates/**/*.*"].each do |each|
+        file = "test/rails_root/#{each.gsub("generators/#{generator}/templates/",'')}"
+        File.delete(file) if File.exists?(file)
+      end
+    end
+
+    FileList["test/rails_root/db/**/*"].each do |each| 
+      FileUtils.rm_rf(each)
+    end
+    FileUtils.rm_rf("test/rails_root/vendor/plugins/clearance")
+    system "mkdir -p test/rails_root/vendor/plugins/clearance"
+    system "cp -R generators test/rails_root/vendor/plugins/clearance"
+  end
+
+  desc "Run the generator on the tests"
+  task :generate do
+    generators.each do |generator|
+      system "cd test/rails_root && ./script/generate #{generator}"
+    end
+  end
+end
+
+desc "Run the test suite"
+task :default => ['test:all', 'test:features']
+
+gem_spec = Gem::Specification.new do |gem_spec|
+  gem_spec.name        = "clearance"
+  gem_spec.version     = "0.5.3"
+  gem_spec.summary     = "Rails authentication for developers who write tests."
+  gem_spec.email       = "support@thoughtbot.com"
+  gem_spec.homepage    = "http://github.com/thoughtbot/clearance"
+  gem_spec.description = "Simple, complete Rails authentication scheme."
+  gem_spec.authors     = ["thoughtbot, inc.", "Dan Croak", "Mike Burns", 
+                          "Jason Morrison", "Eugene Bolshakov", "Josh Nichols",
+                          "Mike Breen", "Joe Ferris", "Bence Nagy", 
+                          "Marcel Görner", "Ben Mabey", "Tim Pope", 
+                          "Eloy Duran", "Mihai Anca", "Mark Cornick"]
+  gem_spec.files       = FileList["[A-Z]*", "{generators,lib,shoulda_macros,rails}/**/*"]
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{gem_spec.name}.gemspec", 'w') do |f|
+    f.write gem_spec.to_yaml
+  end
+end

data/generators/clearance/USAGE

@@ -0,0 +1 @@
+script/generate clearance

data/generators/clearance/clearance_generator.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+require 'factory_girl'
+
+class ClearanceGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory File.join("app", "controllers")
+      if Rails.version >= "2.3.0"
+        file = "app/controllers/application_controller.rb"
+      else
+        file = "app/controllers/application.rb"
+      end
+      if File.exists?(file)
+        m.insert_into file, "include Clearance::App::Controllers::ApplicationController"
+      else
+        m.file file, file 
+      end
+
+      ["app/controllers/confirmations_controller.rb",
+       "app/controllers/passwords_controller.rb", 
+       "app/controllers/sessions_controller.rb", 
+       "app/controllers/users_controller.rb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("app", "models")
+      ["app/models/user.rb", "app/models/clearance_mailer.rb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("app", "views")
+
+      m.directory File.join("app", "views", "passwords")
+      ["app/views/passwords/new.html.erb",
+       "app/views/passwords/edit.html.erb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("app", "views", "sessions")
+      ["app/views/sessions/new.html.erb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("app", "views", "clearance_mailer")
+      ["app/views/clearance_mailer/change_password.html.erb",
+       "app/views/clearance_mailer/confirmation.html.erb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("app", "views", "users")
+      ["app/views/users/_form.html.erb",
+       "app/views/users/edit.html.erb",
+       "app/views/users/new.html.erb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("test", "functional")
+      ["test/functional/confirmations_controller_test.rb",
+       "test/functional/passwords_controller_test.rb",
+       "test/functional/sessions_controller_test.rb",
+       "test/functional/users_controller_test.rb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("test", "unit")
+      ["test/unit/clearance_mailer_test.rb",
+       "test/unit/user_test.rb"].each do |file|
+        m.file file, file
+      end
+
+      m.directory File.join("test", "factories")
+      ["test/factories/clearance.rb"].each do |file|
+        m.file file, file
+      end
+
+      m.route_resources ':passwords'
+      m.route_resource  ':session'
+      m.route_resources ':users, :has_one => [:password, :confirmation]'
+
+      if ActiveRecord::Base.connection.table_exists?(:users)
+        m.migration_template 'db/migrate/update_users_with_clearance_columns.rb', 
+          'db/migrate', :migration_file_name => 'create_or_update_users_with_clearance_columns'
+      else
+        m.migration_template 'db/migrate/create_users_with_clearance_columns.rb', 
+          'db/migrate', :migration_file_name => 'create_or_update_users_with_clearance_columns'
+      end
+
+      m.rake_db_migrate
+
+      m.readme "README"
+    end
+  end
+
+end

data/generators/clearance/lib/insert_commands.rb

@@ -0,0 +1,103 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+
+  def route_resources(resource_list)
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.resources #{resource_list}"
+    unless options[:pretend] || file_contains?('config/routes.rb', resource_list)
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resources #{resource_list}"
+      end
+    end
+  end
+
+  def route_resource(resource_list)
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.resource #{resource_list}"
+    unless options[:pretend] || file_contains?('config/routes.rb', resource_list)
+      gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.resource #{resource_list}"
+      end
+    end
+  end
+  
+  def route_name(name, path, route_options = {})
+    sentinel = 'ActionController::Routing::Routes.draw do |map|'
+    
+    logger.route "map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend] 
+      gsub_file_once 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+      end
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      gsub_file file, /^(class|module) .+$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def route_resource(resource_list)
+    look_for = "  map.resource #{resource_list}\n".gsub(/[\[\]]/, '\\\\\0')
+    logger.route "map.resource #{resource_list} #{look_for}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def route_resources(resource_list)
+    look_for = "  map.resources #{resource_list}\n".gsub(/[\[\]]/, '\\\\\0')
+    logger.route "map.resources #{resource_list} #{look_for}"
+    unless options[:pretend]
+      gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end  
+  
+  def route_name(name, path, route_options = {})
+    look_for =   "\n  map.#{name} '#{path}', :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    logger.route "map.#{name} '#{path}',     :controller => '#{route_options[:controller]}', :action => '#{route_options[:action]}'"
+    unless options[:pretend]
+      gsub_file    'config/routes.rb', /(#{look_for})/mi, ''
+    end
+  end
+  
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def route_resource(resources_list)
+    logger.route "map.resource #{resource_list}"
+  end
+  
+  def route_resources(resources_list)
+    logger.route "map.resource #{resource_list}"
+  end  
+  
+  def route_name(name, path, options = {})
+    logger.route "map.#{name} '#{path}', :controller => '{options[:controller]}', :action => '#{options[:action]}'"
+  end
+  
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end