headstart 0.1.0

data/shoulda_macros/headstart.rb

@@ -0,0 +1,244 @@
+module Headstart
+  module Shoulda
+
+    # STATE OF AUTHENTICATION
+
+    def should_be_signed_in_as(&block)
+      warn "[DEPRECATION] should_be_signed_in_as cannot be used in functional tests anymore now that it depends on cookies, which are unavailable until the next request."
+      should "be signed in as #{block.bind(self).call}" do
+        user = block.bind(self).call
+        assert_not_nil user,
+          "please pass a User. try: should_be_signed_in_as { @user }"
+        assert_equal user, @controller.send(:current_user),
+          "#{user.inspect} is not the current_user, " <<
+          "which is #{@controller.send(:current_user).inspect}"
+      end
+    end
+
+    def should_not_be_signed_in
+      warn "[DEPRECATION] should_not_be_signed_in is no longer a valid test since we now store a remember_token in cookies, not user_id in session"
+      should "not be signed in" do
+        assert_nil session[:user_id]
+      end
+    end
+
+    def should_deny_access_on(http_method, action, opts = {})
+      warn "[DEPRECATION] should_deny_access_on: use a setup & should_deny_access(:flash => ?)"
+      flash_message = opts.delete(:flash)
+      context "on #{http_method} to #{action}" do
+        setup do
+          send(http_method, action, opts)
+        end
+
+        should_deny_access(:flash => flash_message)
+      end
+    end
+
+    def should_deny_access(opts = {})
+      if opts[:flash]
+        should_set_the_flash_to opts[:flash]
+      else
+        should_not_set_the_flash
+      end
+
+      should_redirect_to('sign in page') { sign_in_url }
+    end
+
+    # HTTP FLUENCY
+
+    def should_forbid(description, &block)
+      should "forbid #{description}" do
+        assert_raises ActionController::Forbidden do
+          instance_eval(&block)
+        end
+      end
+    end
+
+    # CONTEXTS
+
+    def signed_in_user_context(&blk)
+      warn "[DEPRECATION] signed_in_user_context: creates a Mystery Guest, causes Obscure Test"
+      context "A signed in user" do
+        setup do
+          @user = Factory(:user)
+          sign_in_as @user
+        end
+        merge_block(&blk)
+      end
+    end
+
+    def public_context(&blk)
+      warn "[DEPRECATION] public_context: common case is no-op. call sign_out otherwise"
+      context "The public" do
+        setup { sign_out }
+        merge_block(&blk)
+      end
+    end
+
+    # CREATING USERS
+
+    def should_create_user_successfully
+      warn "[DEPRECATION] should_create_user_successfully: not meant to be public, no longer used internally"
+      should_assign_to :user
+      should_change 'User.count', :by => 1
+      should_redirect_to_url_after_create
+    end
+
+    # RENDERING
+
+    def should_render_nothing
+      should "render nothing" do
+        assert @response.body.blank?
+      end
+    end
+
+    # REDIRECTS
+
+    def should_redirect_to_url_after_create
+      should_redirect_to("the post-create url") do
+        @controller.send(:url_after_create)
+      end
+    end
+
+    def should_redirect_to_url_after_update
+      should_redirect_to("the post-update url") do
+        @controller.send(:url_after_update)
+      end
+    end
+
+    def should_redirect_to_url_after_destroy
+      should_redirect_to("the post-destroy url") do
+        @controller.send(:url_after_destroy)
+      end
+    end
+
+    def should_redirect_to_url_already_confirmed
+      should_redirect_to("the already confirmed url") do
+        @controller.send(:url_already_confirmed)
+      end
+    end
+
+    # VALIDATIONS
+
+    def should_validate_confirmation_of(attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_of: not meant to be public, no longer used internally"
+      raise ArgumentError if opts[:factory].nil?
+
+      context "on save" do
+        should_validate_confirmation_is_not_blank opts[:factory], attribute
+        should_validate_confirmation_is_not_bad   opts[:factory], attribute
+      end
+    end
+
+    def should_validate_confirmation_is_not_blank(factory, attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_is_not_blank: not meant to be public, no longer used internally"
+      should "validate #{attribute}_confirmation is not blank" do
+        model = Factory.build(factory, blank_confirmation_options(attribute))
+        model.save
+        assert_confirmation_error(model, attribute,
+          "#{attribute}_confirmation cannot be blank")
+      end
+    end
+
+    def should_validate_confirmation_is_not_bad(factory, attribute, opts = {})
+      warn "[DEPRECATION] should_validate_confirmation_is_not_bad: not meant to be public, no longer used internally"
+      should "validate #{attribute}_confirmation is different than #{attribute}" do
+        model = Factory.build(factory, bad_confirmation_options(attribute))
+        model.save
+        assert_confirmation_error(model, attribute, 
+          "#{attribute}_confirmation cannot be different than #{attribute}")
+      end
+    end
+
+    # FORMS
+
+    def should_display_a_password_update_form
+      warn "[DEPRECATION] should_display_a_password_update_form: not meant to be public, no longer used internally"
+      should "have a form for the user's token, password, and password confirm" do
+        update_path = ERB::Util.h(
+          user_password_path(@user, :token => @user.password_reset_token)
+        )
+
+        assert_select 'form[action=?]', update_path do
+          assert_select 'input[name=_method][value=?]', 'put'
+          assert_select 'input[name=?]', 'user[password]'
+          assert_select 'input[name=?]', 'user[password_confirmation]'
+        end
+      end
+    end
+
+    def should_display_a_sign_up_form
+      warn "[DEPRECATION] should_display_a_sign_up_form: not meant to be public, no longer used internally"
+      should "display a form to sign up" do
+        assert_select "form[action=#{users_path}][method=post]",
+        true, "There must be a form to sign up" do
+          assert_select "input[type=text][name=?]",
+            "user[email]", true, "There must be an email field"
+          assert_select "input[type=password][name=?]",
+            "user[password]", true, "There must be a password field"
+          assert_select "input[type=password][name=?]",
+            "user[password_confirmation]", true, "There must be a password confirmation field"
+          assert_select "input[type=submit]", true,
+            "There must be a submit button"
+        end
+      end
+    end
+
+    def should_display_a_sign_in_form
+      warn "[DEPRECATION] should_display_a_sign_in_form: not meant to be public, no longer used internally"
+      should 'display a "sign in" form' do
+        assert_select "form[action=#{session_path}][method=post]",
+          true, "There must be a form to sign in" do
+            assert_select "input[type=text][name=?]",
+              "session[email]", true, "There must be an email field"
+            assert_select "input[type=password][name=?]",
+              "session[password]", true, "There must be a password field"
+            assert_select "input[type=submit]", true,
+              "There must be a submit button"
+        end
+      end
+    end
+  end
+end
+
+module Headstart
+  module Shoulda
+    module Helpers
+      def sign_in_as(user)
+        @controller.current_user = user
+        return user
+      end
+
+      def sign_in
+        sign_in_as Factory(:user)
+      end
+
+      def sign_out
+        @controller.current_user = nil
+      end
+
+      def blank_confirmation_options(attribute)
+        warn "[DEPRECATION] blank_confirmation_options: not meant to be public, no longer used internally"
+        opts = { attribute => attribute.to_s }
+        opts.merge("#{attribute}_confirmation".to_sym => "")
+      end
+
+      def bad_confirmation_options(attribute)
+        warn "[DEPRECATION] bad_confirmation_options: not meant to be public, no longer used internally"
+        opts = { attribute => attribute.to_s }
+        opts.merge("#{attribute}_confirmation".to_sym => "not_#{attribute}")
+      end
+
+      def assert_confirmation_error(model, attribute, message = "confirmation error")
+        warn "[DEPRECATION] assert_confirmation_error: not meant to be public, no longer used internally"
+        assert model.errors.on(attribute).include?("doesn't match confirmation"),
+          message
+      end
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  include Headstart::Shoulda::Helpers
+end
+Test::Unit::TestCase.extend(Headstart::Shoulda)

data/test/controllers/passwords_controller_test.rb

@@ -0,0 +1,184 @@
+require 'test_helper'
+
+class PasswordsControllerTest < ActionController::TestCase
+
+  tests Headstart::PasswordsController
+
+  should_route :get, '/users/1/password/edit',
+    :controller => 'headstart/passwords', :action  => 'edit', :user_id => '1'
+
+  context "a signed up user" do
+    setup do
+      @user = Factory(:user)
+    end
+
+    context "on GET to #new" do
+      setup { get :new, :user_id => @user.to_param }
+
+      should_respond_with :success
+      should_render_template "new"
+    end
+
+    context "on POST to #create" do
+      context "with correct email address" do
+        setup do
+          ActionMailer::Base.deliveries.clear
+          post :create, :password => { :email => @user.email }
+        end
+
+        should "generate a token for the change your password email" do
+          assert_not_nil @user.reload.password_reset_token
+        end
+
+        should "send the change your password email" do
+          Delayed::Job.work_off
+          assert_sent_email do |email|
+            email.subject =~ /change your password/i
+          end
+        end
+
+        should_set_the_flash_to /password/i
+        should_redirect_to_url_after_create
+      end
+
+      context "with incorrect email address" do
+        setup do
+          email = "user1@example.com"
+          assert ! ::User.exists?(['email = ?', email])
+          ActionMailer::Base.deliveries.clear
+          assert_equal @user.password_reset_token,
+                       @user.reload.password_reset_token
+
+          post :create, :password => { :email => email }
+        end
+
+        should "not generate a token for the change your password email" do
+          assert_equal @user.password_reset_token,
+                       @user.reload.password_reset_token
+        end
+
+        should "not send a password reminder email" do
+          assert ActionMailer::Base.deliveries.empty?
+        end
+
+        should "set the failure flash to Unknown email" do
+          assert_match /unknown email/i, flash.now[:failure]
+        end
+
+        should_render_template :new
+      end
+    end
+  end
+
+  context "a signed up user and forgotten password" do
+    setup do
+      @user = Factory(:user)
+      @user.forgot_password!
+    end
+
+    context "on GET to #edit with correct id and token" do
+      setup do
+        get :edit, :user_id => @user.to_param,
+                   :token   => @user.password_reset_token
+      end
+
+      should "find the user" do
+        assert_equal @user, assigns(:user)
+      end
+
+      should_respond_with :success
+      should_render_template "edit"
+      should_display_a_password_update_form
+    end
+
+    should_forbid "on GET to #edit with correct id but blank token" do
+      get :edit, :user_id => @user.to_param, :token => ""
+    end
+
+    should_forbid "on GET to #edit with correct id but no token" do
+      get :edit, :user_id => @user.to_param
+    end
+
+    context "on PUT to #update with matching password and password confirmation" do
+      setup do
+        new_password = "new_password"
+        @encrypted_new_password = @user.send(:encrypt, new_password)
+        assert_not_equal @encrypted_new_password, @user.encrypted_password
+
+        put(:update,
+            :user_id  => @user,
+            :token    => @user.password_reset_token,
+            :user     => {
+              :password              => new_password,
+              :password_confirmation => new_password
+            })
+        @user.reload
+      end
+
+      should "update password" do
+        assert_equal @encrypted_new_password,
+                     @user.encrypted_password
+      end
+
+      should "clear confirmation token" do
+        assert_nil @user.password_reset_token
+      end
+
+      should "set remember token" do
+        assert_not_nil @user.remember_token
+      end
+
+      should_set_the_flash_to(/signed in/i)
+      should_redirect_to_url_after_update
+    end
+
+    context "on PUT to #update with password but blank password confirmation" do
+      setup do
+        new_password = "new_password"
+        @encrypted_new_password = @user.send(:encrypt, new_password)
+
+        put(:update,
+            :user_id => @user.to_param,
+            :token   => @user.password_reset_token,
+            :user    => {
+              :password => new_password,
+              :password_confirmation => ''
+            })
+        @user.reload
+      end
+
+      should "not update password" do
+        assert_not_equal @encrypted_new_password,
+                         @user.encrypted_password
+      end
+
+      should "not clear token" do
+        assert_not_nil @user.password_reset_token
+      end
+
+      should_not_be_signed_in
+      should_not_set_the_flash
+      should_respond_with    :success
+      should_render_template :edit
+
+      should_display_a_password_update_form
+    end
+
+    should_forbid "on PUT to #update with id but no token" do
+      put :update, :user_id => @user.to_param, :token => ""
+    end
+  end
+
+  context "given two users and user one signs in" do
+    setup do
+      @user_one = Factory(:user)
+      @user_two = Factory(:user)
+      sign_in_as @user_one
+    end
+
+    should_forbid "when user one tries to change user two's password on GET with no token" do
+      get :edit, :user_id => @user_two.to_param
+    end
+  end
+
+end

data/test/controllers/sessions_controller_test.rb

@@ -0,0 +1,129 @@
+require 'test_helper'
+
+class SessionsControllerTest < ActionController::TestCase
+
+  tests Headstart::SessionsController
+
+  should_filter_params :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_display_a_sign_in_form
+  end
+
+  context "on POST to #create with good credentials" do
+    setup do
+      @user = Factory(:user)
+      @user.update_attribute(:remember_token, "old-token")
+      post :create, :session => {
+                      :email    => @user.email,
+                      :password => @user.password }
+    end
+
+    should_set_the_flash_to /signed in/i
+    should_redirect_to_url_after_create
+
+    should 'set the cookie' do
+      assert ! cookies['remember_token'].empty?
+    end
+
+    should "not change the remember token" do
+      assert_equal "old-token", @user.reload.remember_token
+    end
+  end
+
+  context "on POST to #create with good credentials and a session return url" do
+    setup do
+      @user = Factory(:user)
+      @return_url = '/url_in_the_session'
+      @request.session[:return_to] = @return_url
+      post :create, :session => {
+                      :email    => @user.email,
+                      :password => @user.password }
+    end
+
+    should_redirect_to("the return URL") { @return_url }
+  end
+
+  context "on POST to #create with good credentials and a request return url" do
+    setup do
+      @user = Factory(:user)
+      @return_url = '/url_in_the_request'
+      post :create, :session => {
+                      :email     => @user.email,
+                      :password  => @user.password },
+                      :return_to => @return_url
+    end
+
+    should_redirect_to("the return URL") { @return_url }
+  end
+
+  context "on POST to #create with good credentials and a session return url and request return url" do
+    setup do
+      @user = Factory(:user)
+      @return_url = '/url_in_the_session'
+      @request.session[:return_to] = @return_url
+      post :create, :session => {
+                      :email     => @user.email,
+                      :password  => @user.password },
+                      :return_to => '/url_in_the_request'
+    end
+
+    should_redirect_to("the return URL") { @return_url }
+  end
+
+  context "on POST to #create with bad credentials" do
+    setup do
+      post :create, :session => {
+                      :email       => 'bad.email@example.com',
+                      :password    => "bad value" }
+    end
+
+    should_set_the_flash_to /bad/i
+    should_respond_with    :unauthorized
+    should_render_template :new
+    should_not_be_signed_in
+
+    should 'not create the cookie' do
+      assert_nil cookies['remember_token']
+    end
+  end
+
+  context "on DELETE to #destroy given a signed out user" do
+    setup do
+      sign_out
+      delete :destroy
+    end
+    should_set_the_flash_to(/signed out/i)
+    should_redirect_to_url_after_destroy
+  end
+
+  context "on DELETE to #destroy with a cookie" do
+    setup do
+      @user = Factory(:user)
+      @user.update_attribute(:remember_token, "old-token")
+      @request.cookies["remember_token"] = "old-token"
+      delete :destroy
+    end
+
+    should_set_the_flash_to(/signed out/i)
+    should_redirect_to_url_after_destroy
+
+    should "delete the cookie token" do
+      assert_nil cookies['remember_token']
+    end
+
+    should "reset the remember token" do
+      assert_not_equal "old-token", @user.reload.remember_token
+    end
+
+    should "unset the current user" do
+      assert_nil @controller.current_user
+    end
+  end
+
+end

data/test/controllers/users_controller_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class UsersControllerTest < ActionController::TestCase
+
+  tests Headstart::UsersController
+
+  should_filter_params :password
+
+  context "when signed out" do
+    setup { sign_out }
+
+    context "on GET to #new" do
+      setup { get :new }
+
+      should_respond_with :success
+      should_render_template :new
+      should_not_set_the_flash
+
+      should_display_a_sign_up_form
+    end
+
+    context "on GET to #new with email" do
+      setup do
+        @email = "a@example.com"
+        get :new, :user => { :email => @email }
+      end
+
+      should "set assigned user's email" do
+        assert_equal @email, assigns(:user).email
+      end
+    end
+
+    context "on POST to #create with valid attributes" do
+      setup do
+        user_attributes = Factory.attributes_for(:user)
+        post :create, :user => user_attributes
+      end
+
+      should_assign_to :user
+      should_change 'User.count', :by => 1
+      should_redirect_to_url_after_create
+    end
+  end
+
+  signed_in_user_context do
+    context "GET to new" do
+      setup { get :new }
+      should_redirect_to("the home page") { root_url }
+    end
+
+    context "POST to create" do
+      setup { post :create, :user => {} }
+      should_redirect_to("the home page") { root_url }
+    end
+  end
+
+end

data/test/models/headstart_mailer_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+class HeadstartMailerTest < ActiveSupport::TestCase
+
+  context "A change password email" do
+    setup do
+      @user  = Factory(:user)
+      @user.forgot_password!
+      HeadstartMailer.deliver_mimi_change_password @user
+      @email = ActionMailer::Base.deliveries.last
+    end
+
+    should "be from DO_NOT_REPLY" do
+      assert_equal Headstart.configuration.mailer_sender, @email.from
+    end
+
+    should "be sent to user" do
+      assert_match /#{@user.email}/i, @email.recipients
+    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\?token=#{@user.password_reset_token}}
+      assert_match regexp, @email.body[:url]
+    end
+    
+    should "set its subject" do
+      assert_match /Change your password/, @email.subject
+    end
+  end
+  
+  context "A welcome email" do
+    setup do
+      @user  = Factory(:user)
+      Delayed::Job.work_off
+      @email = ActionMailer::Base.deliveries.last
+    end
+
+    should "be from DO_NOT_REPLY" do
+      assert_equal Headstart.configuration.mailer_sender, @email.from
+    end
+
+    should "be sent to user" do
+      assert_match /#{@user.email}/i, @email.recipients
+    end
+
+    should "set its subject" do
+      assert_match /welcome/i, @email.subject
+    end
+  end
+
+end

data/test/models/impersonation_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class ImpersonationTest < ActiveSupport::TestCase
+  
+  context 'An Impersonation' do
+    
+    should 'generate a hash based on the id' do
+      hash1 = Impersonation.hash_for(1)
+      hash2 = Impersonation.hash_for(2)
+      assert_not_equal(hash1, hash2)
+    end
+    
+    should 'not generate a nil hash' do
+      assert_not_nil(Impersonation.hash_for(23))
+    end
+    
+    should 'not raise an exception for nil' do
+      assert_raise(ArgumentError) do
+        Impersonation.hash_for(nil)
+      end
+    end
+    
+  end
+  
+end