quo_vadis 1.0.0 → 1.0.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    quo_vadis (1.0.0)
+    quo_vadis (1.0.1)
       bcrypt-ruby (~> 2.1.4)
       rails (~> 3.0)
 

data/README.md

@@ -33,6 +33,8 @@ What it doesn't and won't do:
 
 ## Quick Start
 
+If this takes you more than 5 minutes, you can have your money back ;)
+
 Install and run the generator: add `gem 'quo_vadis'` to your Gemfile and run `rails generate quo_vadis:install`.
 
 Edit and run the generated migration to add authentication columns: `rake db:migrate`.  Note the migration (currently) assumes you already have a `User` model.
@@ -47,7 +49,7 @@ Note Quo Vadis validates the presence of the password, but it's up to you to add
 
 Use `:authenticate` in a `before_filter` to protect your controllers' actions.  For example:
 
-    class ArticleController < ActionController::Base
+    class ArticlesController < ActionController::Base
       before_filter :authenticate, :except => [:index, :show]
     end
 
@@ -56,6 +58,8 @@ Write the sign-in view.  Your sign-in form must:
 * be in `app/views/sessions/new.html.:format`
 * post the parameters `:username` and `:password` to `sign_in_url`
 
+You have to write the view yourself because you'd inevitably want to change whatever markup I generated for you.
+
 In your layout, use `current_user` to retrieve the signed-in user, and `sign_in_path` and `sign_out_path` as appropriate.
 
 

data/app/controllers/controller_mixin.rb

@@ -14,7 +14,10 @@ module ControllerMixin
   end
 
   def authenticate
-    session[:quo_vadis_original_url] = request.fullpath
-    redirect_to sign_in_url, :notice => t('quo_vadis.flash.before_sign_in') unless current_user
+    unless current_user
+      session[:quo_vadis_original_url] = request.fullpath
+      flash[:notice] = t('quo_vadis.flash.before_sign_in') unless t('quo_vadis.flash.before_sign_in').blank?
+      redirect_to sign_in_url
+    end
   end
 end

data/app/controllers/quo_vadis/sessions_controller.rb

@@ -1,4 +1,5 @@
 class QuoVadis::SessionsController < ApplicationController
+  layout :quo_vadis_layout
 
   # sign in
   def new
@@ -9,20 +10,22 @@ class QuoVadis::SessionsController < ApplicationController
   def create
     if user = User.authenticate(params[:username], params[:password])
       self.current_user = user
-      QuoVadis.signed_in_hook user, request
-      redirect_to QuoVadis.signed_in_url(user, original_url), :notice => t('quo_vadis.flash.after_sign_in')
+      QuoVadis.signed_in_hook user, self
+      flash[:notice] = t('quo_vadis.flash.after_sign_in') unless t('quo_vadis.flash.after_sign_in').blank?
+      redirect_to QuoVadis.signed_in_url(user, original_url)
     else
-      QuoVadis.failed_sign_in_hook request
-      flash.now[:alert] = t('quo_vadis.flash.failed_sign_in')
+      QuoVadis.failed_sign_in_hook self
+      flash.now[:alert] = t('quo_vadis.flash.failed_sign_in') unless t('quo_vadis.flash.failed_sign_in').blank?
       render 'sessions/new'
     end
   end
 
   # sign out
   def destroy
-    QuoVadis.signed_out_hook current_user, request
+    QuoVadis.signed_out_hook current_user, self
     self.current_user = nil
-    redirect_to QuoVadis.signed_out_url, :notice => t('quo_vadis.flash.sign_out')
+    flash[:notice] = t('quo_vadis.flash.sign_out') unless t('quo_vadis.flash.sign_out').blank?
+    redirect_to QuoVadis.signed_out_url
   end
 
   private
@@ -33,4 +36,8 @@ class QuoVadis::SessionsController < ApplicationController
     url
   end
 
+  def quo_vadis_layout
+    QuoVadis.layout
+  end
+
 end

data/config/initializers/quo_vadis.rb

@@ -28,23 +28,31 @@ QuoVadis.configure do |config|
 
   # Code to run when the user has signed in.  E.g.:
   #
-  # config.signed_in_hook = Proc.new do |user, request|
+  # config.signed_in_hook = Proc.new do |user, controller|
   #   user.increment! :sign_in_count  # assuming this attribute exists
   # end
   config.signed_in_hook = nil
 
   # Code to run when someone has tried but failed to sign in.  E.g.:
   #
-  # config.failed_sign_in_hook = Proc.new do |request|
-  #   logger.info "Failed sign in from #{request.remote_ip}"
+  # config.failed_sign_in_hook = Proc.new do |controller|
+  #   logger.info "Failed sign in from #{controller.request.remote_ip}"
   # end
   config.failed_sign_in_hook = nil
 
   # Code to run just before the user has signed out.  E.g.:
   #
-  # config.signed_out_hook = Proc.new do |user, request|
-  #   session.reset
+  # config.signed_out_hook = Proc.new do |user, controller|
+  #   controller.session.reset
   # end
   config.signed_out_hook = nil
 
+
+  #
+  # Miscellaneous
+  #
+
+  # Layout for the sign-in view.  Pass a string or a symbol.
+  config.layout = 'application'
+
 end

data/lib/quo_vadis/version.rb

@@ -1,3 +1,3 @@
 module QuoVadis
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/quo_vadis.rb

@@ -36,27 +36,36 @@ module QuoVadis
   mattr_accessor :signed_in_hook
   @@signed_in_hook = nil
 
-  def self.signed_in_hook(user, request)
-    @@signed_in_hook.call(user, request) if @@signed_in_hook
+  def self.signed_in_hook(user, controller)
+    @@signed_in_hook.call(user, controller) if @@signed_in_hook
   end
 
   # Code to run when someone has tried but failed to sign in.
   mattr_accessor :failed_sign_in_hook
   @@failed_sign_in_hook = nil
 
-  def self.failed_sign_in_hook(request)
-    @@failed_sign_in_hook.call(request) if @@failed_sign_in_hook
+  def self.failed_sign_in_hook(controller)
+    @@failed_sign_in_hook.call(controller) if @@failed_sign_in_hook
   end
 
   # Code to run just before the user has signed out.
   mattr_accessor :signed_out_hook
   @@signed_out_hook = nil
 
-  def self.signed_out_hook(user, request)
-    @@signed_out_hook.call(user, request) if @@signed_out_hook
+  def self.signed_out_hook(user, controller)
+    @@signed_out_hook.call(user, controller) if @@signed_out_hook
   end
 
 
+  #
+  # Miscellaneous
+  #
+
+  # Layout for the sign-in view.
+  mattr_accessor :layout
+  @@layout = nil
+
+
   # Configure from the initializer.
   def self.configure
     yield self

data/quo_vadis.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Andy Stewart']
   s.email       = ['boss@airbladesoftware.com']
-  s.homepage    = ''
-  s.summary     = 'Simple authentication for Rails 3.'
+  s.homepage    = 'https://github.com/airblade/quo_vadis'
+  s.summary     = 'Simple username/password authentication for Rails 3.'
   s.description = s.summary
 
   s.rubyforge_project = 'quo_vadis'

data/test/dummy/app/views/layouts/sessions.html.erb

@@ -0,0 +1,3 @@
+<div>Sessions layout</div>
+
+<%= yield %>

data/test/integration/config_test.rb

@@ -93,4 +93,10 @@ class ConfigTest < ActiveSupport::IntegrationCase
     end
   end
 
+  test 'layout config' do
+    QuoVadis.layout = 'sessions'
+    visit sign_in_path
+    assert page.has_content?('Sessions layout')
+  end
+
 end

data/test/integration/locale_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class LocaleTest < ActiveSupport::IntegrationCase
+
+  teardown do
+    Capybara.reset_sessions!
+  end
+
+  test 'before_sign_in flash' do
+    visit new_article_path
+    within '.flash' do
+      assert page.has_content?('Please sign in first.')
+    end
+  end
+
+  test 'after_sign_in flash' do
+    user_factory 'Bob', 'bob', 'secret'
+    sign_in_as 'bob', 'secret'
+    within '.flash' do
+      assert page.has_content?('You have successfully signed in.')
+    end
+  end
+
+  test 'failed_sign_in flash' do
+    sign_in_as 'bob', 'secret'
+    within '.flash' do
+      assert page.has_content?('Sorry, we did not recognise you.')
+    end
+  end
+
+  test 'sign_out flash' do
+    visit sign_out_path
+    within '.flash' do
+      assert page.has_content?('You have successfully signed out.')
+    end
+  end
+
+  test 'before_sign_in flash is optional' do
+    begin
+      I18n.backend.store_translations :en, {:quo_vadis => {:flash => {:before_sign_in => ''}}}
+      visit new_article_path
+      assert page.has_no_css?('div.flash')
+    ensure
+      I18n.reload!
+    end
+  end
+
+  test 'after_sign_in flash is optional' do
+    user_factory 'Bob', 'bob', 'secret'
+    begin
+      I18n.backend.store_translations :en, {:quo_vadis => {:flash => {:after_sign_in => ''}}}
+      sign_in_as 'bob', 'secret'
+      assert page.has_no_css?('div.flash')
+    ensure
+      I18n.reload!
+    end
+  end
+
+  test 'failed_sign_in flash is optional' do
+    begin
+      I18n.backend.store_translations :en, {:quo_vadis => {:flash => {:failed_sign_in => ''}}}
+      sign_in_as 'bob', 'secret'
+      assert page.has_no_css?('div.flash')
+    ensure
+      I18n.reload!
+    end
+  end
+
+  test 'sign_out flash is optional' do
+    begin
+      I18n.backend.store_translations :en, {:quo_vadis => {:flash => {:sign_out => ''}}}
+      visit sign_out_path
+      assert page.has_no_css?('div.flash')
+    ensure
+      I18n.reload!
+    end
+  end
+end

data/test/test_helper.rb

@@ -37,10 +37,11 @@ def user_factory(name, username, password)
 end
 
 def reset_quo_vadis_configuration
-  QuoVadis.signed_in_url = :root
+  QuoVadis.signed_in_url         = :root
   QuoVadis.override_original_url = false
-  QuoVadis.signed_out_url = :root
-  QuoVadis.signed_in_hook = nil
-  QuoVadis.failed_sign_in_hook = nil
-  QuoVadis.signed_out_hook = nil
+  QuoVadis.signed_out_url        = :root
+  QuoVadis.signed_in_hook        = nil
+  QuoVadis.failed_sign_in_hook   = nil
+  QuoVadis.signed_out_hook       = nil
+  QuoVadis.layout                = 'application'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: quo_vadis
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Andy Stewart
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-25 00:00:00 +00:00
+date: 2011-01-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -93,7 +93,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
-description: Simple authentication for Rails 3.
+description: Simple username/password authentication for Rails 3.
 email: 
 - boss@airbladesoftware.com
 executables: []
@@ -130,6 +130,7 @@ files:
 - test/dummy/app/views/articles/index.html.erb
 - test/dummy/app/views/articles/new.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/sessions.html.erb
 - test/dummy/app/views/sessions/new.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
@@ -169,6 +170,7 @@ files:
 - test/integration/authenticate_test.rb
 - test/integration/config_test.rb
 - test/integration/helper_test.rb
+- test/integration/locale_test.rb
 - test/integration/navigation_test.rb
 - test/integration/sign_in_test.rb
 - test/integration/sign_out_test.rb
@@ -176,7 +178,7 @@ files:
 - test/support/integration_case.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: https://github.com/airblade/quo_vadis
 licenses: []
 
 post_install_message: 
@@ -208,7 +210,7 @@ rubyforge_project: quo_vadis
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Simple authentication for Rails 3.
+summary: Simple username/password authentication for Rails 3.
 test_files: 
 - test/dummy/.gitignore
 - test/dummy/app/controllers/application_controller.rb
@@ -220,6 +222,7 @@ test_files:
 - test/dummy/app/views/articles/index.html.erb
 - test/dummy/app/views/articles/new.html.erb
 - test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/sessions.html.erb
 - test/dummy/app/views/sessions/new.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
@@ -259,6 +262,7 @@ test_files:
 - test/integration/authenticate_test.rb
 - test/integration/config_test.rb
 - test/integration/helper_test.rb
+- test/integration/locale_test.rb
 - test/integration/navigation_test.rb
 - test/integration/sign_in_test.rb
 - test/integration/sign_out_test.rb