switch_user 0.3.0 → 0.4.0

data/README.md

@@ -1,16 +1,12 @@
 switch_user
 ===========
 
-Inspired from hobo, switch_user provides a convenient way to switch current user that speed up your development, without logout, login and input login or passowrd.
-
-switch_user promises that it only be activated in the development environment.
-
-It supports only devise now, but it will support authlogic in the future.
+Inspired from [hobo][0], switch_user provides a convenient way to switch current user that speeds up your development, you don't waste your time to logout, login and input login or passowrd any more.
 
 Example
 -------
 
-Visit here: [http://switch-user-example.heroku.com/][0], switch the current user in the select box.
+Visit here: [http://switch-user-example.heroku.com/][1], switch the current user in the select box.
 
 Install
 -------
@@ -37,19 +33,39 @@ Configuration
 
 By default, you can switch between Guest and all users in users table.
 
-But if you want to use different scope users in devise or you want to customize the users that can be switched, you should do like this
+But if you want to use different scope users in devise or you want to customize the users that can be switched, The following is the default configuration.
 
+    # config/initializers/switch_user.rb
     SwitchUser.setup do |config|
-      # provider may be :devise or :authologic, but now we only support devise
+      # provider may be :devise or :authologic
       config.provider = :devise
-      # avaliable_users is a hash, key is the scope of devise user, value is the proc that return the users that can be switched.
-      config.available_users = { :user => lambda { User.all }, :admin => lambda { Admin.all } }
+
+      # avaliable_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 } }
+
       # what field should be displayed on select box
       config.display_field = :email
+
+      # controller_guard is a block, 
+      # if it returns true, the request will continue, 
+      # else the request will be refused and returns "Permission Denied"
+      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
+      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| '/' }
     end
 
 
 Copyright © 2010 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
-[0]: http://switch-user-example.heroku.com/
+[0]: https://github.com/tablatom/hobo
+[1]: http://switch-user-example.heroku.com/
 

data/app/controllers/switch_user_controller.rb

@@ -4,12 +4,26 @@ class SwitchUserController < ApplicationController
 
   def set_current_user
     send("#{SwitchUser.provider}_handle", params)
-    redirect_to(request.env["HTTP_REFERER"] ? :back : root_path)
+    redirect_to(SwitchUser.redirect_path.call(request, params))
   end
 
   private
     def developer_modes_only
-      render :text => "Permission Denied", :status => 403 unless Rails.env == "development"
+      render :text => "Permission Denied", :status => 403 unless available?
+    end
+
+    def available?
+      user = nil
+      if params[:scope_id].present?
+        scope, id = params[:scope_id].split('_')
+        SwitchUser.available_users.keys.each do |s|
+          if scope == s.to_s
+            user = scope.classify.constantize.find(id)
+            break
+          end
+        end
+      end
+      SwitchUser.controller_guard.call(user, request)
     end
 
     def devise_handle(params)
@@ -29,4 +43,18 @@ class SwitchUserController < ApplicationController
         end
       end
     end
+
+    def authlogic_handle(params)
+      if params[:scope_id].blank?
+        current_user_session.destroy
+      else
+        scope, id = params[:scope_id].split('_')
+        SwitchUser.available_users.keys.each do |s|
+          if scope == s.to_s
+            user = scope.classify.constantize.find(id)
+            UserSession.create(user)
+          end
+        end
+      end
+    end
 end

data/app/helpers/switch_user_helper.rb

@@ -1,14 +1,6 @@
 module SwitchUserHelper
   def switch_user_select
-    if Rails.env == "development"
-      options = send("#{SwitchUser.provider}_select_options")
-      select_tag "switch_user_id", options.html_safe, 
-                 :onchange => "location.href = '/switch_user?scope_id=' + encodeURIComponent(this.options[this.selectedIndex].value)"
-    end
-  end
-
-  private
-    def devise_select_options
+    if available?
       if current_user
         options = "<option value=''>Guest</option>"
       else
@@ -24,6 +16,17 @@ module SwitchUserHelper
           end
         end
       end
-      options
+      select_tag "switch_user_id", options.html_safe, 
+                 :onchange => "location.href = '/switch_user?scope_id=' + encodeURIComponent(this.options[this.selectedIndex].value)"
     end
+  end
+
+  def available?
+    user = nil
+    SwitchUser.available_users.keys.each do |scope|
+      user = send("current_#{scope}")
+      break if user
+    end
+    SwitchUser.view_guard.call(user, request)
+  end
 end

data/lib/switch_user.rb

@@ -16,6 +16,14 @@ module SwitchUser
   mattr_accessor :display_field
   self.display_field = :email
 
+  mattr_accessor :controller_guard
+  self.controller_guard = lambda { Rails.env == "development" }
+  mattr_accessor :view_guard
+  self.view_guard = lambda { Rails.evn == "development" }
+
+  mattr_accessor :redirect_path
+  self.redirect_path = lambda { |request| request.env["HTTP_REFERER"] ? :back : root_path }
+
   def self.setup
     yield self
   end

data/lib/switch_user/version.rb

@@ -1,3 +1,3 @@
 module SwitchUser
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: switch_user
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 +08:00
+date: 2010-11-10 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency