switch_user 0.9.1 → 0.9.2

data/Gemfile

@@ -1,4 +1,4 @@
-source :gemcutter
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in switch_user.gemspec
 gemspec

data/README.md

@@ -123,6 +123,10 @@ If you want to redirect user to "/dashboard" page
 
     config.redirect_path = lambda { |request, params| "/dashboard" }
 
+If you want to hide a 'Guest' item in the helper dropdown list
+
+    config.helper_with_guest = false
+
 ## Credit
 
 Copyright © 2010 - 2012 Richard Huang (flyerhzm@gmail.com), released under the MIT license

data/app/controllers/switch_user_controller.rb

@@ -1,9 +1,4 @@
 class SwitchUserController < ApplicationController
-
-  unless Rails.version =~ /^3/
-    unloadable
-  end
-
   before_filter :developer_modes_only
 
   def set_current_user
@@ -12,6 +7,15 @@ class SwitchUserController < ApplicationController
     redirect_to(SwitchUser.redirect_path.call(request, params))
   end
 
+  def remember_user
+    # NOOP unless the user has explicity enabled this feature
+    if SwitchUser.switch_back
+      provider.remember_current_user(params[:remember] == "true")
+    end
+
+    redirect_to(SwitchUser.redirect_path.call(request, params))
+  end
+
   private
 
   def developer_modes_only
@@ -19,7 +23,9 @@ class SwitchUserController < ApplicationController
   end
 
   def available?
-    SwitchUser.controller_guard(provider.current_user, request)
+    SwitchUser.controller_guard(provider.current_user,
+                                request,
+                                provider.original_user)
   end
 
   def handle_request(params)

data/app/helpers/switch_user_helper.rb

@@ -1,10 +1,12 @@
 module SwitchUserHelper
   def switch_user_select
+    # TODO this should be moved in to a view file
     return unless available?
-    options = ""
+    options = ''
 
-    options += content_tag(:option, "Guest", :value => "", :selected => !current_user)
+    options += content_tag(:option, 'Guest', :value => '', :selected => !current_user) if SwitchUser.helper_with_guest
     SwitchUser.available_users.each do |scope, user_proc|
+
       current_user = provider.current_user(scope)
       id_name = SwitchUser.available_users_identifiers[scope]
       name = SwitchUser.available_users_names[scope]
@@ -21,6 +23,9 @@ module SwitchUserHelper
     if options.respond_to?(:html_safe)
       options = options.html_safe
     end
+    if SwitchUser.switch_back
+      concat check_box_tag "remember_user", "remember_user", provider.original_user.present?, :onchange => "location.href = 'switch_user/remember_user?remember=' + encodeURIComponent(this.checked)"
+    end
     select_tag "switch_user_identifier", options,
       :onchange => "location.href = '/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)"
   end

data/config/routes.rb

@@ -1,5 +1,12 @@
+# TODO can this be writting once so that it is rails3 and rails4 compatible?
 if Rails.version =~ /^3/
   Rails.application.routes.draw do
     match 'switch_user' => 'switch_user#set_current_user'
+    match 'switch_user/remember_user' => 'switch_user#remember_user'
   end
-end
+elsif Rails.version =~ /^4/
+  Rails.application.routes.draw do
+    get :switch_user, :to => 'switch_user#set_current_user'
+    get 'switch_user/remember_user', :to => 'switch_user#remember_user'
+  end
+end

data/lib/generators/switch_user/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    This generator will create all the necessary files to use and customize switch_user.
+
+Example:
+    rails generate switch_user:install
+
+    This will create:
+        config/initializer/switch_user.rb

data/lib/generators/switch_user/install/install_generator.rb

@@ -0,0 +1,13 @@
+module SwitchUser
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      TEMPLATES_PATH = File.expand_path('../templates', __FILE__)
+      source_root File.expand_path(Engine.root, __FILE__)
+
+      def install_initializer
+        copy_file "#{TEMPLATES_PATH}/switch_user.rb", 'config/initializers/switch_user.rb'
+      end
+    end
+  end
+end
+

data/lib/generators/switch_user/install/templates/switch_user.rb

@@ -0,0 +1,42 @@
+SwitchUser.setup do |config|
+  # provider may be :devise, :authlogic, :clearance, :restful_authentication or :sorcery
+  config.provider = :devise
+
+  # available_users is a hash,
+  # key is the model name of user (:user, :admin, or any name you use),
+  # value is a block that return the users that can be switched.
+  config.available_users = { :user => lambda { User.all } }
+
+  # available_users_identifiers is a hash,
+  # keys in this hash should match a key in the available_users hash
+  # value is the name of the identifying column to find by,
+  # defaults to id
+  # this hash is to allow you to specify a different column to
+  # expose for instance a username on a User model instead of id
+  config.available_users_identifiers = { :user => :id }
+
+  # available_users_names is a hash,
+  # keys in this hash should match a key in the available_users hash
+  # value is the column name which will be displayed in select box
+  config.available_users_names = { :user => :email }
+
+  # controller_guard is a block,
+  # if it returns true, the request will continue,
+  # else the request will be refused and returns "Permission Denied"
+  # if you switch from "admin" to user, the current_user param is "admin"
+  config.controller_guard = lambda { |current_user, request| Rails.env.development? }
+
+  # view_guard is a block,
+  # if it returns true, the switch user select box will be shown,
+  # else the select box will not be shown
+  # if you switch from admin to "user", the current_user param is "user"
+  config.view_guard = lambda { |current_user, request| Rails.env.development? }
+
+  # redirect_path is a block, it returns which page will be redirected
+  # after switching a user.
+  config.redirect_path = lambda { |request, params| '/' }
+
+  # helper_with_guest is a boolean value, if it set to false
+  # the guest item in the helper won't be shown
+  config.helper_with_guest = true
+end

data/lib/switch_user.rb

@@ -11,10 +11,10 @@ module SwitchUser
   mattr_accessor :available_users
   mattr_accessor :available_users_identifiers
   mattr_accessor :available_users_names
-  mattr_writer :controller_guard
-  mattr_writer :view_guard
   mattr_accessor :redirect_path
   mattr_accessor :session_key
+  mattr_accessor :helper_with_guest
+  mattr_accessor :switch_back
 
   def self.setup
     yield self
@@ -31,10 +31,12 @@ module SwitchUser
   def self.controller_guard(*args)
     call_guard(@@controller_guard, args)
   end
+  mattr_writer :controller_guard
 
   def self.view_guard(*args)
     call_guard(@@view_guard, args)
   end
+  mattr_writer :view_guard
 
   private
 
@@ -47,6 +49,8 @@ module SwitchUser
     self.view_guard = lambda { |current_user, request| Rails.env.development? }
     self.redirect_path = lambda { |request, params| request.env["HTTP_REFERER"] ? :back : root_path }
     self.session_key = :user_id
+    self.helper_with_guest = true
+    self.switch_back = false
   end
 
   def self.call_guard(guard, args)

data/lib/switch_user/provider.rb

@@ -1,5 +1,6 @@
 module SwitchUser
   module Provider
+    autoload :Base, "switch_user/provider/base"
     autoload :Authlogic, "switch_user/provider/authlogic"
     autoload :Clearance, "switch_user/provider/clearance"
     autoload :Devise, "switch_user/provider/devise"

data/lib/switch_user/provider/authlogic.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Authlogic < Base

data/lib/switch_user/provider/base.rb

@@ -21,6 +21,22 @@ module SwitchUser
           logout(scope)
         end
       end
+
+      def original_user
+        @controller.session[:original_user]
+      end
+
+      def remember_current_user(remember)
+        if remember
+          @controller.session[:original_user] = current_user
+        else
+          @controller.session.delete(:original_user)
+        end
+      end
+
+      def clear_original_user
+        @controller.session.delete(:original_user)
+      end
     end
   end
 end

data/lib/switch_user/provider/clearance.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Clearance < Base

data/lib/switch_user/provider/devise.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Devise < Base
@@ -17,7 +15,7 @@ module SwitchUser
       end
 
       def current_user(scope = :user)
-        @controller.send("current_#{scope}")
+        @warden.user(scope)
       end
     end
   end

data/lib/switch_user/provider/dummy.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Dummy < Base
@@ -18,6 +16,18 @@ module SwitchUser
       def current_user(scope = nil)
         @user
       end
+
+      def original_user
+        @original_user
+      end
+
+      def remember_current_user(remember)
+        if remember
+          @original_user = current_user
+        else
+          @original_user = nil
+        end
+      end
     end
   end
 end

data/lib/switch_user/provider/restful_authentication.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class RestfulAuthentication < Base

data/lib/switch_user/provider/session.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Session < Base

data/lib/switch_user/provider/sorcery.rb

@@ -1,5 +1,3 @@
-require 'switch_user/provider/base'
-
 module SwitchUser
   module Provider
     class Sorcery < Base

data/lib/switch_user/version.rb

@@ -1,3 +1,3 @@
 module SwitchUser
-  VERSION = "0.9.1"
+  VERSION = "0.9.2"
 end

data/spec/controllers/switch_user_controller_spec.rb

@@ -7,18 +7,65 @@ describe SwitchUserController, :type => :controller do
     SwitchUser.provider = :dummy
   end
 
-  it "redirects the user to the specified location" do
-    SwitchUser.redirect_path = lambda {|_,_| "/path"}
-    controller.stub(:available? => true)
-    get :set_current_user, :scope_identifier => "user_1"
+  let(:admin) { stub(:admin, :admin? => true) }
+  let(:provider) { stub(:provider,
+                        :original_user => admin,
+                        :current_user => nil)
+  }
+  describe "#set_current_user" do
+    it "redirects the user to the specified location" do
+      SwitchUser.redirect_path = lambda {|_,_| "/path"}
+      controller.stub(:available? => true)
+      get :set_current_user, :scope_identifier => "user_1"
 
-    response.should redirect_to("/path")
+      response.should redirect_to("/path")
+    end
+
+    it "denies access according to the guard block" do
+      SwitchUser.controller_guard = lambda {|_,_,_| false }
+      get :set_current_user
+
+      response.should be_forbidden
+    end
+
+    describe "requests with a privileged original_user" do
+      before do
+        SwitchUser.controller_guard = lambda {|current_user, _, original_user|
+          current_user.try(:admin?) || original_user.try(:admin?)
+        }
+      end
+      it "allows access using the original_user param" do
+        controller.stub(:provider => provider)
+
+        provider.should_receive(:logout_all)
+
+        get :set_current_user
+
+        response.should be_redirect
+      end
+    end
   end
 
-  it "denies access according to the guard block" do
-    SwitchUser.controller_guard = lambda {|_,_| false }
-    get :set_current_user
+  describe "#remember_user" do
+    before do
+      controller.stub(:provider => provider)
+      SwitchUser.switch_back = true
+    end
+    it "can remember the current user" do
+      provider.should_receive(:remember_current_user).with(true)
+
+      get :remember_user, :remember => "true"
+    end
+    it "can forget the current user" do
+      provider.should_receive(:remember_current_user).with(false)
+
+      get :remember_user, :remember => "false"
+    end
+    it "does nothing if switch_back is not enabled" do
+      SwitchUser.switch_back = false
+      provider.should_not_receive(:remember_current_user)
 
-    response.should be_forbidden
+      get :remember_user, :remember => "true"
+    end
   end
 end

data/spec/provider/authlogic_spec.rb

@@ -23,7 +23,7 @@ class UserSession
   end
 end
 
-class AuthlogicController
+class AuthlogicController < TestController
   def current_user_session
     UserSession
   end

data/spec/provider/clearance_spec.rb

@@ -1,15 +1,15 @@
 require 'spec_helper'
 require 'switch_user/provider/clearance'
 
-class ClearanceController
+class ClearanceController < TestController
   def sign_in(user)
     @user = user
   end
-  
+
   def sign_out
     @user = nil
   end
-  
+
   def current_user
     @user
   end
@@ -20,4 +20,4 @@ describe SwitchUser::Provider::Clearance do
   let(:provider) { SwitchUser::Provider::Clearance.new(controller) }
 
   it_behaves_like "a provider"
-end
+end

data/spec/provider/devise_spec.rb

@@ -13,22 +13,22 @@ class FakeWarden
     @user_hash[scope] = user
   end
 
+  def user(scope)
+    @user_hash[scope]
+  end
+
   def logout(scope)
     @user_hash.delete(scope)
   end
 end
 
-class DeviseController
+class DeviseController < TestController
   def warden
     @warden ||= FakeWarden.new
   end
 
   def current_user
-    @warden.user_hash[:user]
-  end
-
-  def current_admin
-    @warden.user_hash[:admin]
+    @warder.user
   end
 end
 

data/spec/provider/dummy_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'switch_user/provider/dummy'
+
+class SessionController < TestController
+end
+
+describe SwitchUser::Provider::Session do
+  let(:controller) { SessionController.new }
+  let(:provider) { SwitchUser::Provider::Dummy.new(controller) }
+
+  it_behaves_like "a provider"
+end

data/spec/provider/restful_authentication_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'switch_user/provider/restful_authentication'
 
-class RestfulAuthenticationController
+class RestfulAuthenticationController < TestController
   attr_accessor :current_user
 
   def logout_killing_session!

data/spec/provider/session_spec.rb

@@ -1,11 +1,7 @@
 require 'spec_helper'
 require 'switch_user/provider/session'
 
-class SessionController
-  def session
-    @session_hash ||= {}
-  end
-
+class SessionController < TestController
   def current_user
     User.find_by_id(session[:uid]) if session[:uid]
   end
@@ -15,6 +11,7 @@ describe SwitchUser::Provider::Session do
   before do
     user.stub(:id => 100)
     User.stub(:find_by_id).with(100).and_return(user)
+    User.stub(:find_by_id).with(101).and_return(other_user)
     SwitchUser.session_key = :uid
   end
   let(:controller) { SessionController.new }

data/spec/provider/sorcery_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'switch_user/provider/sorcery'
 
-class SorceryController
+class SorceryController < TestController
   def logout
     @user = nil
   end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'support/provider'
 require 'support/application'
 require 'rspec/rails'
+require 'switch_user'
 
 RSpec.configure do |config|
   config.filter_run :focus => true
@@ -10,3 +11,16 @@ end
 class ApplicationController < ActionController::Base
 
 end
+
+class TestController
+  def session
+    @session_hash ||= {}
+  end
+end
+
+class User
+  def self.where(*)
+    []
+  end
+end
+

data/spec/support/provider.rb

@@ -1,5 +1,6 @@
 shared_examples_for "a provider" do
   let(:user) { stub(:user) }
+  let(:other_user) { stub(:other_user, :id => 101) }
 
   it "can log a user in" do
     provider.login(user)
@@ -24,4 +25,23 @@ shared_examples_for "a provider" do
 
     provider.current_users_without_scope.should == [user]
   end
+
+  it "can lock the original user, allowing us to change current_user" do
+    provider.login(user)
+    provider.remember_current_user(true)
+    provider.login(other_user)
+
+    provider.original_user.should == user
+    provider.current_user.should == other_user
+  end
+
+  it "can forget the original_user" do
+    provider.login(user)
+    provider.remember_current_user(true)
+
+    provider.original_user.should == user
+    provider.remember_current_user(false)
+
+    provider.original_user.should == nil
+  end
 end

data/spec/switch_user/user_loader_spec.rb

@@ -1,12 +1,6 @@
 require 'spec_helper'
 require 'switch_user/user_loader'
 
-class User
-  def self.where(*)
-    []
-  end
-end
-
 describe SwitchUser::UserLoader do
   let(:user) { stub(:user) }
   let(:user_result) { [user] }

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: switch_user
 version: !ruby/object:Gem::Version
-  version: 0.9.1
   prerelease: 
+  version: 0.9.2
 platform: ruby
 authors:
 - Richard Huang
@@ -10,104 +10,104 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: activesupport
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
+    none: false
+  name: bundler
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: actionpack
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: railties
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: railties
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
+    none: false
+  name: rspec-rails
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: tzinfo
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
 description: Easily switch current user to speed up development
 email:
 - flyerhzm@gmail.com
@@ -124,6 +124,9 @@ files:
 - app/controllers/switch_user_controller.rb
 - app/helpers/switch_user_helper.rb
 - config/routes.rb
+- lib/generators/switch_user/install/USAGE
+- lib/generators/switch_user/install/install_generator.rb
+- lib/generators/switch_user/install/templates/switch_user.rb
 - lib/switch_user.rb
 - lib/switch_user/provider.rb
 - lib/switch_user/provider/authlogic.rb
@@ -142,6 +145,7 @@ files:
 - spec/provider/authlogic_spec.rb
 - spec/provider/clearance_spec.rb
 - spec/provider/devise_spec.rb
+- spec/provider/dummy_spec.rb
 - spec/provider/restful_authentication_spec.rb
 - spec/provider/session_spec.rb
 - spec/provider/sorcery_spec.rb
@@ -158,17 +162,17 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
+  none: false
 requirements: []
 rubyforge_project: switch_user
 rubygems_version: 1.8.23