merbful_authentication 0.1.0

data/rspec_generators/merbful_authentication_tests/templates/model_spec_helper.rb

@@ -0,0 +1,8 @@
+module <%= class_name %>SpecHelper
+  def valid_<%= singular_name %>_hash
+    { :login                  => "daniel",
+      :email                  => "daniel@example.com",
+      :password               => "sekret",
+      :password_confirmation  => "sekret"}
+  end
+end

data/rspec_generators/merbful_authentication_tests/templates/session_controller_spec.rb

@@ -0,0 +1,101 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+require File.join( File.dirname(__FILE__), "..", "<%= singular_name %>_spec_helper")
+require File.join( File.dirname(__FILE__), "..", "authenticated_system_spec_helper")
+require 'cgi'
+
+describe "<%= controller_class_name %> Controller", "index action" do
+  include <%= class_name %>SpecHelper
+  
+  before(:each) do
+    <%= class_name %>.clear_database_table
+    @quentin = <%= class_name %>.create(valid_<%= singular_name %>_hash.with(:login => "quentin", :password => "test", :password_confirmation => "test"))
+    @controller = <%= controller_class_name %>.build(fake_request)
+<% if include_activation -%>
+    @quentin.activate
+<% end -%>
+  end
+  
+  it "should have a route to <%= controller_class_name %>#new from '/login'" do
+    with_route("/login") do |params|
+      params[:controller].should == "<%= controller_class_name %>"
+      params[:action].should == "create"
+    end   
+  end
+  
+  it "should route to <%= controller_class_name %>#create from '/login' via post" do
+    with_route("/login", "POST") do |params|
+      params[:controller].should  == "<%= controller_class_name %>"
+      params[:action].should      == "create"
+    end      
+  end
+  
+  it "should have a named route :login" do
+    controller.url(:login).should == "/login"
+  end
+  
+  it "should have route to <%= controller_class_name %>#destroy from '/logout' via delete" do
+    with_route("/logout", "DELETE") do |params|
+      params[:controller].should == "<%= controller_class_name %>"
+      params[:action].should    == "destroy"
+    end   
+  end
+  
+  it "should route to <%= controller_class_name %>#destroy from '/logout' via get" do
+    with_route("/logout", "GET") do |params|
+      params[:controller].should == "<%= controller_class_name %>" 
+      params[:action].should     == "destroy"
+    end
+  end
+
+  it 'logins and redirects' do
+    post "/login", :login => 'quentin', :password => 'test'
+    session[:<%= singular_name %>].should_not be_nil
+    session[:<%= singular_name %>].should == @quentin.id
+    controller.should redirect_to("/")
+  end
+   
+  it 'fails login and does not redirect' do
+    post "/login", :login => 'quentin', :password => 'bad password'
+    session[:<%= singular_name %>].should be_nil
+    controller.template.should match(/^new\./)
+    controller.should be_success
+  end
+
+  it 'logs out' do
+    get("/logout"){|response| response.stub!(:current_<%= singular_name %>).and_return(@quentin) }
+    session[:<%= singular_name %>].should be_nil
+    controller.should redirect
+  end
+
+  it 'remembers me' do
+    post "/login", :login => 'quentin', :password => 'test', :remember_me => "1"
+    cookies["auth_token"].should_not be_nil
+  end
+ 
+  it 'does not remember me' do
+    post "login", :login => 'quentin', :password => 'test', :remember_me => "0"
+    cookies["auth_token"].should be_nil
+  end
+  
+  it 'deletes token on logout' do
+    get("/logout") {|request| request.stub!(:current_<%= singular_name %>).and_return(@quentin) }
+    cookies["auth_token"].should == nil
+  end
+  
+  
+  it 'logs in with cookie' do
+    @quentin.remember_me
+    get "/login" do |request|
+      request.env[Merb::Const::HTTP_COOKIE] = "auth_token=#{@quentin.remember_token}"
+    end
+    controller.should be_logged_in
+  end
+
+  def auth_token(token)
+    CGI::Cookie.new('name' => 'auth_token', 'value' => token)
+  end
+    
+  def cookie_for(<%= singular_name %>)
+    auth_token <%= singular_name %>.remember_token
+  end
+end

data/rspec_generators/merbful_authentication_tests/templates/user_mailer_spec.rb

@@ -0,0 +1,70 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper.rb')
+require File.join( File.dirname(__FILE__), "..", "<%= singular_name %>_spec_helper")
+require File.join( File.dirname(__FILE__), "..", "authenticated_system_spec_helper")
+
+describe <%= class_name %>Mailer do
+  
+  def deliver(action, mail_opts= {},opts = {})
+    <%= class_name %>Mailer.dispatch_and_deliver action, mail_opts, opts
+    @delivery = Merb::Mailer.deliveries.last
+  end
+  
+  before(:each) do
+    @u = <%= class_name %>.new(:email => "homer@simpsons.com", :login => "homer", :activation_code => "12345")
+    @mailer_params = { :from      => "info@mysite.com",
+                       :to        => @u.email,
+                       :subject   => "Welcome to MySite.com" }
+  end
+  
+  after(:each) do
+    Merb::Mailer.deliveries.clear
+  end
+  
+  it "should send mail to homer@simpsons.com for the signup email" do
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.assigns(:headers).should include("to: homer@simpsons.com")
+  end
+  
+  it "should send the mail from 'info@mysite.com' for the signup email" do
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.assigns(:headers).should include("from: info@mysite.com")
+  end
+  
+  it "should mention the <%= plural_name %> login in the text signup mail" do
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.text.should include(@u.login)
+  end
+  
+  it "should mention the <%= plural_name %> login in the HTML signup mail" do
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.html.should include(@u.login)
+  end
+  
+  it "should mention the activation link in the signup emails" do
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @u)
+    the_url = <%= class_name %>Mailer.new.url(:<%= singular_name %>_activation, :activation_code => @u.activation_code)
+    the_url.should_not be_nil
+    @delivery.text.should include( the_url )   
+    @delivery.html.should include( the_url )
+  end
+  
+  it "should send mail to homer@simpson.com for the activation email" do
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.assigns(:headers).should include("to: homer@simpsons.com")
+  end
+  
+  it "should send the mail from 'info@mysite.com' for the activation email" do
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.assigns(:headers).should include("from: info@mysite.com")    
+  end
+  
+  it "should mention ther <%= plural_name %> login in the text activation mail" do
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.text.should include(@u.login)
+  end
+
+  it "should mention the suers login in the html activation mail" do
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @u)
+    @delivery.html.should include(@u.login)    
+  end
+end

data/test_unit_generators/merbful_authentication_tests/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/test_unit_generators/merbful_authentication_tests/merbful_authentication_tests_generator.rb

@@ -0,0 +1,84 @@
+class MerbfulAuthenticationTestsGenerator < RubiGen::Base
+  
+  attr_reader   :name,  
+                :class_name, 
+                :class_path, 
+                :file_name, 
+                :class_nesting, 
+                :class_nesting_depth, 
+                :plural_name, 
+                :singular_name,
+                :controller_name,
+                :controller_class_path,
+                :controller_file_path,
+                :controller_class_nesting,
+                :controller_class_nesting_depth,
+                :controller_class_name,
+                :controller_singular_name,
+                :controller_plural_name,
+                :model_controller_name,
+                :model_controller_class_path,
+                :model_controller_file_path,
+                :model_controller_class_nesting,
+                :model_controller_class_nesting_depth,
+                :model_controller_class_name,
+                :model_controller_singular_name,
+                :model_controller_plural_name,
+                :include_activation
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+    runtime_options.each{ |k,v| self.instance_variable_set("@#{k}", v) }    
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory "test"
+      m.directory "test/unit"
+      m.directory "test/functional"
+      
+      m.directory "test/mailers" if include_activation
+      # Create stubs
+      m.template "model_test_helper.rb", File.join("test",  "#{file_name}_test_helper.rb")
+      m.template "authenticated_system_test_helper.rb", File.join("test", "authenticated_system_test_helper.rb")
+      m.template "model_functional_test.rb", File.join("test", "functional", "#{model_controller_file_path}_test.rb")
+      m.template "functional_test.rb", File.join("test", "functional", "#{controller_file_path}_test.rb")
+      m.template "unit_test.rb", File.join("test", "unit", "#{singular_name}_test.rb")
+    
+      if include_activation
+        m.template "mailer_test.rb", File.join("test/mailers", "#{singular_name}_mailer_test.rb")
+      end
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name"
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/test_unit_generators/merbful_authentication_tests/templates/authenticated_system_test_helper.rb

@@ -0,0 +1,50 @@
+class Merb::Controller
+  require "merb/session/memory_session"
+  Merb::MemorySessionContainer.setup
+  include ::Merb::SessionMixin
+  self.session_secret_key = "foo to the bar to the baz"
+end
+
+class Merb::Mailer
+  self.delivery_method = :test_send
+end
+
+class Hash
+  
+  def with( opts )
+    self.merge(opts)
+  end
+  
+  def without(*args)
+    self.dup.delete_if{ |k,v| args.include?(k)}
+  end
+  
+end
+
+# Assert difference(s) methods were taken from RubyOnRails to support the port of restful_authentication
+
+def assert_difference(expressions, difference = 1, message = nil, &block)
+  expression_evaluations = Array(expressions).collect{ |expression| lambda { eval(expression, block.send(:binding)) } }
+
+  original_values = expression_evaluations.inject([]) { |memo, expression| memo << expression.call }
+  yield
+  expression_evaluations.each_with_index do |expression, i|
+    assert_equal original_values[i] + difference, expression.call, message
+  end
+end
+
+def assert_no_difference(expressions, message = nil, &block)
+  assert_difference expressions, 0, message, &block
+end
+
+
+def assert_response(code = :success)
+  case code
+  when :success
+    assert_equal 200, controller.status
+  when :redirect
+    assert_equal 302, controller.status
+  end
+end
+
+

data/test_unit_generators/merbful_authentication_tests/templates/functional_test.rb

@@ -0,0 +1,92 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require (File.dirname(__FILE__) / '../authenticated_system_test_helper')
+require (File.dirname(__FILE__) / ".." / "<%= singular_name %>_test_helper")
+include <%= class_name %>TestHelper
+
+# Re-raise errors caught by the controller.
+class <%= controller_class_name %>; def rescue_action(e) raise e end; end
+
+class <%= controller_class_name %>ControllerTest < Test::Unit::TestCase
+
+  def setup
+    <%= class_name %>.clear_database_table
+    @controller = <%= controller_class_name %>.build(fake_request)
+    @request = @controller.request
+    @response = @controller.response
+      
+    @<%= singular_name %> = <%= class_name %>.new(valid_<%= singular_name %>_hash.with(:login => 'quentin', :password => 'test', :password_confirmation => 'test'))
+    @<%= singular_name %>.save
+<% if options[:include_activation] -%>
+    @<%= singular_name %>.activate
+<% end -%>
+  end
+
+  def test_should_login_and_redirect
+    controller.params.merge!(:login => 'quentin', :password => 'test')
+    controller.dispatch(:create)
+    assert controller.session[:<%= singular_name %>]
+    assert_response :redirect
+  end
+
+  def test_should_fail_login_and_not_redirect
+    controller.params.merge!(:login => 'quentin', :password => 'bad password')
+    controller.dispatch(:create)
+    assert_nil controller.session[:<%= file_name %>]
+    assert_response :success
+  end
+
+  def test_should_logout
+    login_as :quentin
+    controller.dispatch(:destroy)
+    assert_nil controller.session[:<%= file_name %>]
+    assert_response :redirect
+  end
+
+  def test_should_remember_me
+    controller.params.merge!(:login => 'quentin', :password => 'test', :remember_me => '1')
+    controller.dispatch(:create)
+    assert_not_nil controller.cookies["auth_token"]
+  end
+
+  def test_should_not_remember_me
+    controller.params.merge!(:login => 'quentin', :password => 'test', :remember_me => '0')
+    controller.dispatch(:create)
+    assert_nil controller.cookies["auth_token"]
+  end
+  
+  def test_should_delete_token_on_logout
+    login_as :quentin
+    controller.dispatch(:destroy)
+    assert_nil controller.cookies["auth_token"]
+  end
+
+  def test_should_login_with_cookie
+    @user.remember_me
+    controller.cookies["auth_token"] = @<%= singular_name %>.remember_token
+    controller.dispatch(:new)
+    assert controller.send(:logged_in?)
+  end
+  
+  def test_should_fail_expired_cookie_login
+    @<%= singular_name %>.remember_me
+    @<%= singular_name %>.remember_token_expires_at = (Time.now - (5 * 60))
+    @<%= singular_name %>.save
+    controller.cookies["auth_token"] = @<%= singular_name %>.remember_token
+    controller.dispatch(:new)
+    assert !(controller.send(:logged_in?))
+  end
+  
+  def test_should_fail_cookie_login
+    @<%= singular_name %>.remember_me
+    controller.cookies["auth_token"] = 'invalid_auth_token'
+    controller.dispatch(:new)
+    assert !controller.send(:logged_in?)
+  end
+
+  protected
+    
+    def login_as(login = :quentin)
+      <%= singular_name %> = <%= class_name %>.find_with_conditions(:login => login.to_s)
+      @controller.session[:<%= singular_name %>] = <%= singular_name %> ? <%= singular_name %>.id : nil
+    end
+end

data/test_unit_generators/merbful_authentication_tests/templates/mailer_test.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require (File.dirname(__FILE__) / '../authenticated_system_test_helper')
+require (File.dirname(__FILE__) / ".." / "<%= singular_name %>_test_helper")
+include <%= class_name %>TestHelper
+
+class <%= class_name %>MailerTest < Test::Unit::TestCase
+
+  def setup
+    @<%= singular_name %> = <%= class_name %>.new(:email => "homer@simpsons.com", :login => "homer", :activation_code => "12345")
+    @mailer_params = { :from      => "info@mysite.com",
+                       :to        => @<%= singular_name %>.email,
+                       :subject   => "Welcome to MySite.com" }
+  end
+  
+  def tear_down
+    Merb::Mailer.deliveries.clear
+  end
+  
+  def test_signup_email_goes_to_the_right_place
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert @delivery.assigns(:headers).any? {|v| v == "to: homer@simpsons.com"} 
+  end
+
+  def test_signup_email_should_come_from_the_right_place
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert @delivery.assigns(:headers).any? {|v| v == "from: info@mysite.com"} 
+  end
+  
+  def test_signup_email_should_mention_the_login_name
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert_match %r(#{@<%= singular_name %>.login}), @delivery.text
+  end
+
+  def test_signup_html_email_should_mention_the_login_name
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert_match %r(#{@<%= singular_name %>.login}), @delivery.html
+  end
+
+  def test_signup_email_should_mention_the_activation_link
+    deliver(:signup_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert_match %r(#{@<%= singular_name %>.activation_code}), @delivery.text
+    assert_match %r(#{@<%= singular_name %>.activation_code}), @delivery.html
+  end
+
+  def test_activation_email_should_go_to_the_right_place
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert @delivery.assigns(:headers).any?{|v| v == "to: homer@simpsons.com"}
+  end
+
+  def test_activation_email_should_come_from_the_right_place
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert @delivery.assigns(:headers).any?{|v| v == "from: info@mysite.com"}
+  end
+  
+  def test_should_mention_the_login_in_the_activation_email
+    deliver(:activation_notification, @mailer_params, :<%= singular_name %> => @<%= singular_name %>)
+    assert_match %r(#{@<%= singular_name %>.login}), @delivery.text
+    assert_match %r(#{@<%= singular_name %>.login}), @delivery.html
+  end
+  private
+  def deliver(action, mail_opts= {},opts = {})
+    <%= class_name %>Mailer.dispatch_and_deliver action, mail_opts, opts
+    @delivery = Merb::Mailer.deliveries.last
+  end
+
+end