hashrocket-clearance 0.4.0

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,168 @@
+h1. Clearance
+
+Simple, complete Ruby web app authentication. 
+
+"We have clearance, Clarence.":http://www.youtube.com/v/mNRXJEE3Nz8
+
+h2. Gem installation (Rails 2.1+)
+
+In config/environments/test.rb:
+
+    config.gem 'thoughtbot-shoulda', :lib => 'shoulda', :source => "http://gems.github.com"
+    config.gem 'thoughtbot-factory_girl', :lib => 'factory_girl', :source => "http://gems.github.com"
+
+In config/environment.rb:
+
+    config.gem "thoughtbot-clearance", :lib => 'clearance', :source => 'http://gems.github.com/'
+
+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
+
+Add the corresponding Clearance module for any file(s) you don't want to override. They are namespaced exactly like the directory structure of a Rails app: 
+
+    app/models/user.rb already exists.
+    include Clearance::App::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:
+
+    Factory.sequence :email do |n|
+      "user#{n}@example.com"
+    end
+
+    Factory.define :user do |user|
+      user.email { Factory.next :email }
+      user.password "password"
+      user.password_confirmation "password"
+    end
+
+In test/test_helper.rb: 
+
+    class Test::Unit::TestCase
+      self.use_transactional_fixtures = true
+      self.use_instantiated_fixtures  = false
+      include Clearance::Test::TestHelper
+    end
+
+h2. Controllers
+
+In app/controllers/application_controller.rb:
+
+    class ApplicationController < ActionController::Base
+      helper :all
+      protect_from_forgery
+      include Clearance::App::Controllers::ApplicationController
+    end
+
+In app/controllers/sessions_controller.rb:
+
+    class SessionsController < ApplicationController
+  
+      include Clearance::App::Controllers::SessionsController  
+      include Clearance::App::Controllers::FacebookSessionsController
+
+      facebook_to_user_field_mappings \
+        :first_name => :first_name,
+        :last_name => :last_name
+    end
+
+h2. Migration
+
+Your users table needs a few columns.
+
+    create_table(:users) do |t|
+    t.string :facebook_id
+    t.string :first_name
+    t.string :last_name
+    t.string :email
+    t.string :crypted_password, :limit => 40
+    t.string :salt, :limit => 40
+    t.string :remember_token
+    t.datetime :remember_token_expires_at
+    t.boolean :confirmed, :default => false, :null => false
+    t.string :confirmation_code
+    t.string :reset_password_code
+    end
+
+    add_index :users, :email
+    add_index :users, :facebook_id
+    add_index :users, :remember_token
+
+h2. Routes
+
+    map.resources :users
+    map.resource :session
+    map.resources :users, :has_one => :password
+    map.resources :users, :has_one => :confirmation
+    map.resources :passwords
+    map.root :controller => 'sessions', :action => 'new'
+
+    If you want facebook integration
+
+    map.resource  :session, :member => { :facebook_new => :get, :facebook_create => :get }
+    
+h2. Environments
+
+In config/environments/test.rb and config/environments/development.rb:
+
+    HOST = "localhost"
+
+In config/environment.rb:
+
+    DO_NOT_REPLY = "donotreply@example.com"
+    PROJECT_NAME = "my_app_name"
+
+h2. Dependencies
+
+In order to use the Facebook sign-in features, you need to install the Facebooker plugin.
+
+    ./script/plugin install git://github.com/mmangino/facebooker.git
+
+TODO:  talk about disabliing Facebook features by removing includes
+
+
+h2. Authors
+
+* thoughtbot, inc.
+* Dan Croak
+* Jason Morrison
+* Mike Burns
+* Josh Nichols
+* Mike Breen
+* Hashrocket, Inc.
+* Les Hill
+* Jon "Lark" Larkowski
+* Wes Gibbs

data/Rakefile

@@ -0,0 +1,83 @@
+require 'rake'
+require 'rake/testtask'
+require 'date'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+def gem_files
+  FileList["[A-Z]*", "{generators,lib,test}/**/*"]
+end
+
+test_files_pattern = 'test/rails_root/test/{unit,functional,other}/**/*_test.rb'
+namespace :test do
+  Rake::TestTask.new(:all => 'generator:tests') do |t|
+    t.libs << 'lib'
+    t.pattern = test_files_pattern
+    t.verbose = false
+  end
+
+  desc "Run all specs in spec directory (excluding plugin specs)"
+  Spec::Rake::SpecTask.new(:spec) do |t|
+    t.spec_opts = ['--options', "\"test/rails_root/spec/spec.opts\""]
+    t.spec_files = FileList['test/rails_root/spec/**/*_spec.rb']
+  end
+end
+
+desc "Run the test suite"
+task :default => ['test:all', 'test:spec']
+
+
+gemspec_doc = <<-GEMSPEC_DOC
+  s.date = "#{Date.today.strftime('%Y-%m-%d')}"
+  s.name = "clearance"
+  s.summary = "Fork of clearance, not-purely-restful, but with Facebook goodness"
+  s.email = "info@hashrocket.com"
+  s.version = '0.4.0'
+  s.homepage = "http://github.com/hashrocket/clearance"
+  s.description = "Fork of clearance, not-purely-restful, but with Facebook goodness"
+  s.authors = [
+    "thoughtbot, inc.",
+    "Dan Croak",
+    "Josh Nichols",
+    "Jason Morrison",
+    "Mike Burns",
+    "Mike Breen",
+    "Hashrocket, Inc.",
+    "Les Hill",
+    "Jon Larkowski",
+    "Wes Gibbs"
+  ]
+GEMSPEC_DOC
+
+spec = Gem::Specification.new do |s|
+  eval(gemspec_doc)
+  s.files = gem_files
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+namespace :generator do
+  desc "Run the generator on the tests"
+  task :tests do
+    system "mkdir -p test/rails_root/vendor/plugins/clearance"
+    system "cp -R generators test/rails_root/vendor/plugins/clearance"
+    system "cd test/rails_root; ./script/generate clearance"
+  end
+end
+
+desc "Generate the Clearance gemspec"
+task :gemspec do
+  
+  File.open("clearance.gemspec", "w") do |file|
+    file.write "Gem::Specification.new do |s|\n"
+    file.write(gemspec_doc)
+    file.write  "  s.files = [\n"
+    file.write gem_files.map {|f| %Q{    "#{f}"}}.join(",\n")
+    file.write "  ]\n"
+    file.write "end\n"
+  end
+end
+

data/TODO.textile

@@ -0,0 +1,27 @@
+(highest priority first)
+
+# split PROJECT_NAME out into separate code and presentation constants
+# haml-ize
+# parameterize Facebook includes in generators
+# split out PROJECT_NAME and SITE_NAME appropriately, don't want display issues affecting code issues
+# remove dependency on root_url?
+# should_have_form should be pulled into shoulda
+# generator should print out instructions to include modules existing files
+# check to make sure attr_accessible doesn't override and w/ attr_protected
+# move shoulda macros in test_helper to shoulda_macros folder
+# add shoulda and factory girl dependencies to gemspec
+# refactor Mailer default_url_options[:host] to something cleaner
+# application controller uses protected, all other controllers use private
+# add information about url_after_create to README or github wikis
+
+ideas to steal 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
+# 401 and 405 need to be in Exceptions controller or use safety_valve
+# email confirmation is a strategy
+# forgot password is a strategy
+# salted password is a strategy
+
+http://adam.speaksoutofturn.com/articles/entication_vs_orization.html

data/generators/clearance/USAGE

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

data/generators/clearance/clearance_generator.rb

@@ -0,0 +1,84 @@
+class ClearanceGenerator < Rails::Generator::Base
+  
+  def manifest
+    record do |m|
+      m.directory File.join("app", "controllers")
+      [
+        "app/controllers/application.rb",
+        "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", "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/confirmation.html.erb",
+        "app/views/clearance_mailer/facebook_welcome.text.html.haml",
+        "app/views/clearance_mailer/forgot_password.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/new.html.erb",
+       "app/views/users/_password_form.html.erb",
+       "app/views/users/edit_password.html.erb"].each do |file|
+        m.file file, file
+      end
+      
+      m.directory 'config/initializers'
+      [
+        "config/initializers/action_mailer.rb"
+      ].each do |file|
+        m.file file, file
+      end
+      
+      m.directory 'public/images'
+      [
+        "public/images/connect_light_medium_long.gif"
+      ].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
+      
+      ["test/factories.rb"].each do |file|
+        m.file file, file
+      end
+    end
+  end
+  
+end

data/generators/clearance/templates/app/controllers/application.rb

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

data/generators/clearance/templates/app/controllers/confirmations_controller.rb

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

data/generators/clearance/templates/app/controllers/passwords_controller.rb

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

data/generators/clearance/templates/app/controllers/sessions_controller.rb

@@ -0,0 +1,8 @@
+class SessionsController < ApplicationController
+  include Clearance::App::Controllers::SessionsController  
+  include Clearance::App::Controllers::FacebookSessionsController
+  
+  facebook_to_user_field_mappings \
+    :first_name => :first_name,
+    :last_name => :last_name
+end

data/generators/clearance/templates/app/controllers/users_controller.rb

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

data/generators/clearance/templates/app/models/clearance_mailer.rb

@@ -0,0 +1,4 @@
+class ClearanceMailer < ActionMailer::Base
+  include Clearance::App::Models::ClearanceMailer
+  include Clearance::App::Models::ClearanceFacebookMailer
+end

data/generators/clearance/templates/app/models/user.rb

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

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

@@ -0,0 +1 @@
+<%= confirmations_url :confirmation_code => @user.confirmation_code %>

data/generators/clearance/templates/app/views/clearance_mailer/facebook_welcome.text.html.haml

@@ -0,0 +1,4 @@
+:plain
+  Welcome to #{PROJECT_NAME.humanize}!  Sign in at:
+  
+  #{root_url}

data/generators/clearance/templates/app/views/clearance_mailer/forgot_password.html.erb

@@ -0,0 +1,6 @@
+Someone, hopefully you, has requested that we send you a link to reset your password.
+
+Here's the link:
+<%= edit_password_url(:id => @user.reset_password_code) %>
+
+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/passwords/edit.html.erb

@@ -0,0 +1,18 @@
+<p>
+  You are resetting your password. Choose a new password below.
+</p>
+
+<%= error_messages_for :user %>
+<% form_tag(password_path(:id => @user.reset_password_code), :method => :put) do %>
+  <div class="password_field">
+    <%= label_tag :password, 'Choose password' %>
+    <%= password_field_tag :password %>
+  </div>
+  <div class="password_field">
+    <%= label_tag :password_confirmation, 'Verify password' %>
+    <%= password_field_tag :password_confirmation %>
+  </div>
+  <div class="submit_field">
+    <%= submit_tag 'Save this password' %>
+  </div>
+<% end %>

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

@@ -0,0 +1,15 @@
+<h2>Forgot your password</h2>
+
+<p>
+  We will email you a link to reset your password.
+</p>
+
+<% form_tag(passwords_path) do %>
+  <div class="text_field">
+    <%= label_tag :email, 'Email address' %>
+    <%= text_field_tag :email %>
+  </div>
+  <div class="submit_field">
+    <%= submit_tag 'Reset password' %>
+  </div>
+<% end %>

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

@@ -0,0 +1,29 @@
+<% form_for :session, :url => session_path do |form| %>
+  <div class="text_field">
+    <%= form.label :email %>
+    <%= form.text_field :email %>  
+  </div>
+  <div class="text_field">
+    <%= form.label :password %>
+    <%= form.password_field :password %>
+  </div>
+  <div class="text_field">
+    <%= form.check_box :remember_me %>
+    <%= form.label :remember_me %>
+  </div>
+  <div class="submit_field">
+    <%= form.submit 'Login', :disable_with => 'Please wait...' %>
+  </div>
+<% end %>
+
+<ul>
+  <li>
+    Sign in with Facebook <%= link_to image_tag('connect_light_medium_long.gif'), facebook_new_session_path %>
+  </li>
+  <li>
+    <%= link_to "Sign up", new_user_path %>
+  </li>
+  <li>
+    <%= link_to "Forgot My Password", new_password_path %>
+  </li>
+</ul>

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

@@ -0,0 +1,13 @@
+<%= form.error_messages %>
+<div class="text_field">
+  <%= form.label :email %>
+  <%= form.text_field :email %>
+</div>
+<div class="password_field">
+  <%= form.label :password %>
+  <%= form.password_field :password %>
+</div>
+<div class="password_field">
+  <%= form.label :password_confirmation %>
+  <%= form.password_field :password_confirmation %>
+</div>

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

@@ -0,0 +1,13 @@
+<%= form.error_messages %>
+<div class="password_field">
+  <%= form.label :old_password %>
+  <%= form.password_field :old_password %>
+</div>
+<div class="password_field">
+  <%= form.label :password %>
+  <%= form.password_field :password %>
+</div>
+<div class="password_field">
+  <%= form.label :password_confirmation %>
+  <%= form.password_field :password_confirmation %>
+</div>

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

@@ -0,0 +1,4 @@
+<% form_for(@user, :url => change_password_user_path(@user), :html => {:method => :put}) do |form| %>
+  <%= render :partial => '/users/password_form', :locals => {:form => form}  %>
+  <%= form.submit 'Update', :disable_with => 'Please wait...' %>
+<% end %>

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

@@ -0,0 +1,6 @@
+<% form_for @user do |form| %>
+  <%= render :partial => '/users/form', :object => form %>
+  <%= form.submit 'Sign up', :disable_with => 'Please wait...' %>
+<% end %>
+
+Sign in with Facebook <%= link_to image_tag('connect_light_medium_long.gif'), facebook_new_session_path %>

data/generators/clearance/templates/config/initializers/action_mailer.rb

@@ -0,0 +1 @@
+ActionMailer::Base.register_template_extension('haml')

data/generators/clearance/templates/test/factories.rb

@@ -0,0 +1,9 @@
+Factory.sequence :email do |n|
+  "user#{n}@example.com"
+end
+
+Factory.define :user do |user|
+  user.email { Factory.next :email }
+  user.password "password"
+  user.password_confirmation "password"
+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::Test::Functional::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::Test::Functional::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::Test::Functional::SessionsControllerTest
+end

data/generators/clearance/templates/test/functional/users_controller_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UsersControllerTest < ActionController::TestCase
+  include Clearance::Test::Functional::UsersControllerTest
+end

data/generators/clearance/templates/test/unit/clearance_mailer_test.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ClearanceMailerTest < ActionMailer::TestCase
+  tests ClearanceMailer
+  include Clearance::Test::Unit::ClearanceMailerTest
+end

data/generators/clearance/templates/test/unit/user_test.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class UserTest < Test::Unit::TestCase
+  include Clearance::Test::Unit::UserTest
+end