switch_user 0.5.1 → 0.6.0

data/.gitignore

@@ -1,3 +1,4 @@
 pkg/*
 *.gem
 .bundle
+.rvmrc

data/Gemfile.lock

@@ -0,0 +1,15 @@
+PATH
+  remote: .
+  specs:
+    switch_user (0.5.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  switch_user!

data/README.md

@@ -39,11 +39,11 @@ or haml
     
 If there are too many users (in production), the switch_user_select is not a good choice, you should call the switch user request by yourself.
 
-    <%= link_to user.login, "/switch_user?scope_id=user_#{user.id}" %>
-    <%= link_to admin.login, "/switch_user?scope_id=admin_#{admin.id}" %>
+    <%= link_to user.login, "/switch_user?scope_identifier=user_#{user.id}" %>
+    <%= link_to admin.login, "/switch_user?scope_identifier=admin_#{admin.id}" %>
     
-    = link_to user.login, "/switch_user?scope_id=user_#{user.id}"
-    = link_to admin.login, "/switch_user?scope_id=admin_#{admin.id}"
+    = link_to user.login, "/switch_user?scope_identifier=user_#{user.id}"
+    = link_to admin.login, "/switch_user?scope_identifier=admin_#{admin.id}"
 
 If you use it in a Rails 2 project, you have to add a route manually.
 
@@ -56,28 +56,38 @@ Configuration
 By default, you can switch between Guest and all users in users table, you don't need to do anything. The following is the default configuration.
 
     SwitchUser.setup do |config|
-      # provider may be :devise or :authologic
+      # provider may be :devise or :authlogic
       config.provider = :devise
 
-      # avaliable_users is a hash, 
+      # 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 } }
 
-      # what field should be displayed on select box
-      config.display_field = :email
+      # 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" }
+      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" }
+      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.
@@ -89,10 +99,14 @@ If the default configuration can't meet your requirement, you can define your cu
 If you want to switch both available users and available admins
 
     config.available_users = { :user => lambda { User.available }, :admin => lambda { Admin.available } }
+
+If you want to use name column as the user identifier
+
+		config.available_users_identifiers => { :user => :name }
     
 If you want to display the login field in switch user select box
 
-    config.display_field = :login
+    config.available_users_names = { :user => :login }
     
 If you only allow switching from admin to user in production environment
 

data/app/controllers/switch_user_controller.rb

@@ -17,29 +17,22 @@ class SwitchUserController < ApplicationController
     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)
+      current_user = send("#{SwitchUser.provider}_current_user")
+      SwitchUser.controller_guard.call(current_user, request)
     end
 
     def devise_handle(params)
-      if params[:scope_id].blank?
+      if params[:scope_identifier].blank?
         SwitchUser.available_users.keys.each do |s|
           warden.logout(s)
         end
       else
-        scope, id = params[:scope_id].split('_')
+        params[:scope_identifier] =~ /^([^_]+)_(.*)$/
+        scope, identifier = $1, $2
+
         SwitchUser.available_users.keys.each do |s|
           if scope == s.to_s
-            user = scope.classify.constantize.find(id)
+            user = find_user(scope, s, identifier)
             warden.set_user(user, :scope => scope)
           else
             warden.logout(s)
@@ -49,16 +42,35 @@ class SwitchUserController < ApplicationController
     end
 
     def authlogic_handle(params)
-      if params[:scope_id].blank?
+      if params[:scope_identifier].blank?
         current_user_session.destroy
       else
-        scope, id = params[:scope_id].split('_')
+        params[:scope_identifier] =~ /^([^_]+)_(.*)$/
+        scope, identifier = $1, $2
+
         SwitchUser.available_users.keys.each do |s|
           if scope == s.to_s
-            user = scope.classify.constantize.find(id)
+            user = find_user(scope, s, identifier)
             UserSession.create(user)
           end
         end
       end
     end
+    
+    def find_user(scope, identifier_scope, identifier)
+      identifier_column = SwitchUser.available_users_identifiers[identifier_scope] || :id
+      if identifier_column == :id
+        scope.classify.constantize.find(identifier)
+      else
+        scope.classify.constantize.send("find_by_#{identifier_column}!", identifier)
+      end
+    end
+
+    def devise_current_user
+      current_user
+    end
+
+    def authlogic_current_user
+      UserSession.find.try(:record)
+    end
 end

data/app/helpers/switch_user_helper.rb

@@ -7,20 +7,22 @@ module SwitchUserHelper
         options = "<option selected='selected' value=''>Guest</option>"
       end
       SwitchUser.available_users.each do |scope, user_proc|
+        current = send("current_#{scope}")
+        identifier = SwitchUser.available_users_identifiers[scope]
+        name = SwitchUser.available_users_names[scope]
         user_proc.call.each do |user|
-          current = send("current_#{scope}")
-          if current and current.id == user.id
-            options += "<option selected='selected' value='#{scope}_#{user.id}'>#{user.send(SwitchUser.display_field)}</option>"
+          if current and current.send(identifier) == user.send(identifier)
+            options += "<option selected='selected' value='#{scope}_#{user.send(identifier)}'>#{user.send(name)}</option>"
           else
-            options += "<option value='#{scope}_#{user.id}'>#{user.send(SwitchUser.display_field)}</option>"
+            options += "<option value='#{scope}_#{user.send(identifier)}'>#{user.send(name)}</option>"
           end
         end
       end
       if options.respond_to?(:html_safe)
         options = options.html_safe
       end
-      select_tag "switch_user_id", options,
-                 :onchange => "location.href = '/switch_user?scope_id=' + encodeURIComponent(this.options[this.selectedIndex].value)"
+      select_tag "switch_user_identifier", options,
+                 :onchange => "location.href = '/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)"
     end
   end
 

data/lib/switch_user.rb

@@ -21,17 +21,20 @@ module SwitchUser
   mattr_accessor :available_users
   self.available_users = { :user => lambda { User.all } }
 
-  mattr_accessor :display_field
-  self.display_field = :email
+  mattr_accessor :available_users_identifiers
+  self.available_users_identifiers = { :user => :id }
+
+  mattr_accessor :available_users_names
+  self.available_users_names = { :user => :email }
 
   mattr_accessor :controller_guard
-  self.controller_guard = lambda { |current_user, request| Rails.env == "development" }
+  self.controller_guard = lambda { |current_user, request| Rails.env.development? }
   mattr_accessor :view_guard
-  self.view_guard = lambda { |current_user, request| Rails.env == "development" }
+  self.view_guard = lambda { |current_user, request| Rails.env.development? }
 
   mattr_accessor :redirect_path
   self.redirect_path = lambda { |request, params| 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.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: switch_user
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Richard Huang
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 +08:00
+date: 2010-11-18 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,6 +46,7 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile