user_impersonate 0.7.0 → 0.8.0

data/README.md

@@ -131,10 +131,16 @@ The `app/views/user_impersonate/_header.html.haml` HAML partial for this header
 
 By default, when you impersonate and when you stop impersonating a user you are redirected to the root url.
 
-Configure alternate paths using:
+Configure alternate paths in `config/initializers/user_impersonate.rb`, which is created by the generator above.
 
 ``` ruby
-???
+# config/initializers/user_impersonate.rb
+module UserImpersonate
+  class Engine < Rails::Engine
+    config.redirect_on_impersonate = "/"
+    config.redirect_on_revert = "/impersonate"
+  end
+end
 ```
 
 ### User model & lookup
@@ -144,6 +150,7 @@ By default, it assumes the User model is `User`, that you use `User.find(id)` to
 You can fix this default behavior in `config/initializers/user_impersonate.rb`, which is created by the generator above.
 
 ``` ruby
+# config/initializers/user_impersonate.rb
 module UserImpersonate
   class Engine < Rails::Engine
     config.user_class           = "User"

data/app/controllers/user_impersonate/application_controller.rb

@@ -1,4 +1,4 @@
 module UserImpersonate
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
   end
 end

data/app/controllers/user_impersonate/impersonate_controller.rb

@@ -2,7 +2,7 @@ require_dependency "user_impersonate/application_controller"
 
 module UserImpersonate
   class ImpersonateController < ApplicationController
-    before_filter :authenticate_user!
+    before_filter :authenticate_the_user
     before_filter :current_user_must_be_staff!, except: ["destroy"]
     
     # Display list of all users, except current (staff) user
@@ -58,6 +58,31 @@ module UserImpersonate
       redirect_to '/'
     end
 
+    # current_user changes from a staff user to
+    # +new_user+; current user stored in +session[:staff_user_id]+
+    def impersonate(new_user)
+      session[:staff_user_id] = current_user.id # 
+      sign_in_user new_user
+    end
+    
+    # revert the +current_user+ back to the staff user
+    # stored in +session[:staff_user_id]+
+    def revert_impersonate
+      return unless current_staff_user
+      sign_in_user current_staff_user
+      session[:staff_user_id] = nil
+    end
+
+    def sign_in_user(user)
+      method = config_or_default :sign_in_user_method, "sign_in"
+      self.send(method.to_sym, user)
+    end
+
+    def authenticate_the_user
+      method = config_or_default :authenticate_user_method, "authenticate_user!"
+      self.send(method.to_sym)
+    end
+
     # Helper to load a User, using all the UserImpersonate config options
     def find_user(id)
       user_class.send(user_finder_method, id)
@@ -71,11 +96,11 @@ module UserImpersonate
     end
 
     def user_finder_method
-      (UserImpersonate::Engine.config.try(:user_finder) || "find").to_sym
+      (config_or_default :user_finder, "find").to_sym
     end
 
     def user_class_name
-      UserImpersonate::Engine.config.try(:user_class) || "User"
+      config_or_default :user_class, "User"
     end
 
     def user_class
@@ -87,21 +112,31 @@ module UserImpersonate
     end
     
     def user_id_column
-      UserImpersonate::Engine.config.try(:user_id_column) || "id"
+      config_or_default :user_id_column, "id"
     end
     
     def user_is_staff_method
-      UserImpersonate::Engine.config.try(:user_is_staff_method) || "staff?"
+      config_or_default :user_is_staff_method, "staff?"
     end
     
     def redirect_on_impersonate(impersonated_user)
-      url = UserImpersonate::Engine.config.try(:redirect_on_impersonate) || main_app.root_url
+      url = config_or_default :redirect_on_impersonate, main_app.root_url
       redirect_to url
     end
     
     def redirect_on_revert(impersonated_user = nil)
-      url = UserImpersonate::Engine.config.redirect_on_revert || root_url
+      url = config_or_default :redirect_on_revert, root_url
       redirect_to url
     end
+
+    # gets overridden config value for engine, else returns default
+    def config_or_default(attribute, default)
+      attribute = attribute.to_sym
+      if UserImpersonate::Engine.config.respond_to?(attribute)
+        UserImpersonate::Engine.config.send(attribute)
+      else
+        default
+      end
+    end
   end
 end

data/app/helpers/user_impersonate/application_helper.rb

@@ -1,4 +1,11 @@
 module UserImpersonate
   module ApplicationHelper
+    def current_staff_user
+      return unless session[:staff_user_id]
+      user_finder_method = (UserImpersonate::Engine.config.user_finder || "find").to_sym
+      user_class_name = UserImpersonate::Engine.config.user_class || "User"
+      user_class = user_class_name.constantize
+      @staff_user ||= user_class.send(user_finder_method, session[:staff_user_id])
+    end
   end
 end

data/lib/generators/user_impersonate/templates/config/initializers/user_impersonate.rb

@@ -7,5 +7,8 @@ module UserImpersonate
 
     config.redirect_on_impersonate = "/"
     config.redirect_on_revert = "/impersonate"
+
+    config.authenticate_user_method = "authenticate_user!" # protect impersonation controller
+    config.sign_in_user_method      = "sign_in"            # sign_in(user)
   end
 end

data/lib/user_impersonate/engine.rb

@@ -8,5 +8,10 @@ module UserImpersonate
         Devise.include_helpers(UserImpersonate::DeviseHelpers)
       end
     end
+
+    config.to_prepare do
+      ::ApplicationController.helper(UserImpersonate::ApplicationHelper)
+      ::ApplicationController.send(:include, UserImpersonate::ApplicationHelper)
+    end
   end
 end

data/lib/user_impersonate/version.rb

@@ -1,3 +1,3 @@
 module UserImpersonate
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/test/dummy/log/test.log

@@ -10078,3 +10078,70 @@ Processing by HomeController#index as HTML
   Rendered home/index.html.erb within layouts/application (1.1ms)
 Completed 200 OK in 2ms (Views: 2.0ms | ActiveRecord: 0.1ms)
    (1.8ms)  rollback transaction
+Connecting to database specified by database.yml
+   (10.2ms)  begin transaction
+   (0.1ms)  SAVEPOINT active_record_1
+  Fixture Delete (0.4ms)  DELETE FROM "users"
+  Fixture Insert (0.7ms)  INSERT INTO "users" ("id", "name", "email", "staff", "encrypted_password", "created_at", "updated_at") VALUES (1, 'Dr Nic Williams', 'drnicwilliams@gmail.com', 't', '$2a$10$HV6E2Hgk2z6hqow76r6IL.5gcnqCSqJYuOuOT.nbqdPffBLvwglzK', '2012-09-19 23:09:52', '2012-09-19 23:09:52')
+  Fixture Insert (0.1ms)  INSERT INTO "users" ("id", "name", "email", "encrypted_password", "created_at", "updated_at") VALUES (2, 'Normal User', 'normaluser@gmail.com', '$2a$10$HV6E2Hgk2z6hqow76r6IL.5gcnqCSqJYuOuOT.nbqdPffBLvwglzK', '2012-09-19 23:09:52', '2012-09-19 23:09:52')
+   (0.0ms)  RELEASE SAVEPOINT active_record_1
+  User Load (0.2ms)  SELECT "users".* FROM "users" WHERE "users"."name" = 'Normal User' LIMIT 1
+
+
+Started GET "/users/sign_in" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by Devise::SessionsController#new as HTML
+  Rendered /Users/drnic/.rvm/gems/ruby-1.9.3-p194@global/gems/devise-2.1.2/app/views/devise/shared/_links.erb (1.6ms)
+  Rendered /Users/drnic/.rvm/gems/ruby-1.9.3-p194@global/gems/devise-2.1.2/app/views/devise/sessions/new.html.erb within layouts/application (22.0ms)
+Completed 200 OK in 37ms (Views: 36.4ms | ActiveRecord: 0.0ms)
+
+
+Started POST "/users/sign_in" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by Devise::SessionsController#create as HTML
+  Parameters: {"utf8"=>"✓", "user"=>{"email"=>"normaluser@gmail.com", "password"=>"[FILTERED]", "remember_me"=>"0"}, "commit"=>"Sign in"}
+  User Load (0.1ms)  SELECT "users".* FROM "users" WHERE "users"."email" = 'normaluser@gmail.com' LIMIT 1
+   (0.1ms)  SAVEPOINT active_record_1
+   (0.4ms)  UPDATE "users" SET "last_sign_in_at" = '2012-09-19 23:09:53.322713', "current_sign_in_at" = '2012-09-19 23:09:53.322713', "last_sign_in_ip" = '127.0.0.1', "current_sign_in_ip" = '127.0.0.1', "sign_in_count" = 1, "updated_at" = '2012-09-19 23:09:53.323719' WHERE "users"."id" = 2
+   (0.0ms)  RELEASE SAVEPOINT active_record_1
+Redirected to http://www.example.com/
+Completed 302 Found in 104ms (ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by HomeController#index as HTML
+  User Load (0.2ms)  SELECT "users".* FROM "users" WHERE "users"."id" = 2 LIMIT 1
+  Rendered home/index.html.erb within layouts/application (2.0ms)
+Completed 200 OK in 6ms (Views: 5.1ms | ActiveRecord: 0.2ms)
+   (0.4ms)  rollback transaction
+   (0.1ms)  begin transaction
+   (0.1ms)  SAVEPOINT active_record_1
+  Fixture Delete (0.2ms)  DELETE FROM "users"
+  Fixture Insert (0.1ms)  INSERT INTO "users" ("id", "name", "email", "staff", "encrypted_password", "created_at", "updated_at") VALUES (1, 'Dr Nic Williams', 'drnicwilliams@gmail.com', 't', '$2a$10$HV6E2Hgk2z6hqow76r6IL.5gcnqCSqJYuOuOT.nbqdPffBLvwglzK', '2012-09-19 23:09:53', '2012-09-19 23:09:53')
+  Fixture Insert (0.1ms)  INSERT INTO "users" ("id", "name", "email", "encrypted_password", "created_at", "updated_at") VALUES (2, 'Normal User', 'normaluser@gmail.com', '$2a$10$HV6E2Hgk2z6hqow76r6IL.5gcnqCSqJYuOuOT.nbqdPffBLvwglzK', '2012-09-19 23:09:53', '2012-09-19 23:09:53')
+   (0.0ms)  RELEASE SAVEPOINT active_record_1
+  User Load (0.1ms)  SELECT "users".* FROM "users" WHERE "users"."name" = 'Dr Nic Williams' LIMIT 1
+
+
+Started GET "/users/sign_in" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by Devise::SessionsController#new as HTML
+  Rendered /Users/drnic/.rvm/gems/ruby-1.9.3-p194@global/gems/devise-2.1.2/app/views/devise/shared/_links.erb (0.4ms)
+  Rendered /Users/drnic/.rvm/gems/ruby-1.9.3-p194@global/gems/devise-2.1.2/app/views/devise/sessions/new.html.erb within layouts/application (2.8ms)
+Completed 200 OK in 5ms (Views: 4.1ms | ActiveRecord: 0.0ms)
+
+
+Started POST "/users/sign_in" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by Devise::SessionsController#create as HTML
+  Parameters: {"utf8"=>"✓", "user"=>{"email"=>"drnicwilliams@gmail.com", "password"=>"[FILTERED]", "remember_me"=>"0"}, "commit"=>"Sign in"}
+  User Load (0.2ms)  SELECT "users".* FROM "users" WHERE "users"."email" = 'drnicwilliams@gmail.com' LIMIT 1
+   (0.1ms)  SAVEPOINT active_record_1
+   (0.3ms)  UPDATE "users" SET "last_sign_in_at" = '2012-09-19 23:09:53.497475', "current_sign_in_at" = '2012-09-19 23:09:53.497475', "last_sign_in_ip" = '127.0.0.1', "current_sign_in_ip" = '127.0.0.1', "sign_in_count" = 1, "updated_at" = '2012-09-19 23:09:53.498065' WHERE "users"."id" = 1
+   (0.0ms)  RELEASE SAVEPOINT active_record_1
+Redirected to http://www.example.com/
+Completed 302 Found in 91ms (ActiveRecord: 0.0ms)
+
+
+Started GET "/" for 127.0.0.1 at 2012-09-19 16:09:53 -0700
+Processing by HomeController#index as HTML
+  User Load (0.1ms)  SELECT "users".* FROM "users" WHERE "users"."id" = 1 LIMIT 1
+  Rendered home/index.html.erb within layouts/application (1.5ms)
+Completed 200 OK in 3ms (Views: 2.6ms | ActiveRecord: 0.1ms)
+   (1.9ms)  rollback transaction

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_impersonate
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +279,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2825731515616564782
+      hash: 36552099061295841
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2825731515616564782
+      hash: 36552099061295841
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24