RubyGems - user_impersonate2 - Versions diffs - 0.9.0 - Mend

user_impersonate2 0.9.0

Files changed (76) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +231 -0
data/Rakefile +41 -0
data/app/assets/javascripts/user_impersonate/application.js +15 -0
data/app/assets/javascripts/user_impersonate/impersonate.js +2 -0
data/app/assets/stylesheets/user_impersonate/application.css +13 -0
data/app/assets/stylesheets/user_impersonate/impersonate.css +4 -0
data/app/controllers/user_impersonate/application_controller.rb +4 -0
data/app/controllers/user_impersonate/impersonate_controller.rb +146 -0
data/app/helpers/user_impersonate/application_helper.rb +11 -0
data/app/views/layouts/user_impersonate/application.html.erb +14 -0
data/app/views/user_impersonate/_header.html.erb +60 -0
data/app/views/user_impersonate/impersonate/index.html.erb +30 -0
data/config/cucumber.yml +8 -0
data/config/routes.rb +6 -0
data/lib/generators/user_impersonate/USAGE +6 -0
data/lib/generators/user_impersonate/templates/app/views/user_impersonate/_header.html.erb +60 -0
data/lib/generators/user_impersonate/templates/config/initializers/user_impersonate.rb +15 -0
data/lib/generators/user_impersonate/user_impersonate_generator.rb +15 -0
data/lib/tasks/user_impersonate_tasks.rake +4 -0
data/lib/user_impersonate.rb +5 -0
data/lib/user_impersonate/devise_helpers.rb +31 -0
data/lib/user_impersonate/engine.rb +17 -0
data/lib/user_impersonate/version.rb +4 -0
data/test/dummy/README.rdoc +261 -0
data/test/dummy/Rakefile +7 -0
data/test/dummy/app/assets/javascripts/application.js +15 -0
data/test/dummy/app/assets/javascripts/home.js +2 -0
data/test/dummy/app/assets/stylesheets/application.css +16 -0
data/test/dummy/app/assets/stylesheets/home.css +7 -0
data/test/dummy/app/controllers/application_controller.rb +3 -0
data/test/dummy/app/controllers/home_controller.rb +4 -0
data/test/dummy/app/helpers/application_helper.rb +2 -0
data/test/dummy/app/helpers/home_helper.rb +2 -0
data/test/dummy/app/models/user.rb +12 -0
data/test/dummy/app/views/home/index.html.erb +11 -0
data/test/dummy/app/views/layouts/application.html.erb +22 -0
data/test/dummy/app/views/user_impersonate/_header.html.erb +65 -0
data/test/dummy/config.ru +4 -0
data/test/dummy/config/application.rb +60 -0
data/test/dummy/config/boot.rb +10 -0
data/test/dummy/config/database.yml +25 -0
data/test/dummy/config/environment.rb +5 -0
data/test/dummy/config/environments/development.rb +40 -0
data/test/dummy/config/environments/production.rb +67 -0
data/test/dummy/config/environments/test.rb +37 -0
data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/test/dummy/config/initializers/devise.rb +232 -0
data/test/dummy/config/initializers/inflections.rb +15 -0
data/test/dummy/config/initializers/mime_types.rb +5 -0
data/test/dummy/config/initializers/secret_token.rb +7 -0
data/test/dummy/config/initializers/session_store.rb +8 -0
data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
data/test/dummy/config/locales/devise.en.yml +58 -0
data/test/dummy/config/locales/en.yml +5 -0
data/test/dummy/config/routes.rb +8 -0
data/test/dummy/db/migrate/20120914174453_devise_create_users.rb +48 -0
data/test/dummy/db/migrate/20120914184123_add_staff_flag_to_users.rb +5 -0
data/test/dummy/db/schema.rb +36 -0
data/test/dummy/db/test.sqlite3 +0 -0
data/test/dummy/lib/tasks/cucumber.rake +65 -0
data/test/dummy/log/test.log +15 -0
data/test/dummy/public/404.html +26 -0
data/test/dummy/public/422.html +26 -0
data/test/dummy/public/500.html +25 -0
data/test/dummy/public/favicon.ico +0 -0
data/test/dummy/script/rails +6 -0
data/test/dummy/test/fixtures/users.yml +14 -0
data/test/dummy/test/unit/helpers/home_helper_test.rb +4 -0
data/test/dummy/test/unit/user_test.rb +7 -0
data/test/integration/navigation_test.rb +10 -0
data/test/test_helper.rb +15 -0
data/test/unit/helpers/user_impersonate/impersonate_helper_test.rb +6 -0
data/test/user_impersonate_test.rb +7 -0
metadata +268 -0

data/app/helpers/user_impersonate/application_helper.rb ADDED Viewed

@@ -0,0 +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/app/views/layouts/user_impersonate/application.html.erb ADDED Viewed

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>User Impersonate</title>
+  <%= stylesheet_link_tag    "user_impersonate/application", :media => "all" %>
+  <%= javascript_include_tag "user_impersonate/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

data/app/views/user_impersonate/_header.html.erb ADDED Viewed

@@ -0,0 +1,60 @@
+<style>
+#impersonating {
+  width: 100%;
+  margin: 0;
+  padding: 12px 0;
+  background: #c70000;
+  border-bottom: 1px solid black;
+  line-height: 1.9;
+  font-size: 12px;
+  font-family: "Lucida Sans Unicode","Lucida Grande",Verdana,Arial,Helvetica,sans-serif;
+}
+#impersonating .impersonate-controls {
+  color: white;
+  font-weight: normal;
+  font-size: 15px;
+  max-width: 960px;
+  margin-left: auto;
+  margin-right: auto;
+}
+#impersonating .impersonate-controls .impersonate-info {
+  margin-bottom: 6px;
+  padding-bottom: 2px;
+  border-bottom: 1px solid #dd0000;
+}
+#impersonating .impersonate-controls form {
+  display: inline;
+  margin-right: 16px;
+}
+#impersonating .impersonate-controls .revert-form {
+  margin-left: 16px;
+}
+#impersonating .impersonate-controls select {
+  background: white;
+}
+#impersonating .impersonate-controls .admin_name, #impersonating .impersonate-controls .user_name, #impersonating .impersonate-controls .user_id, #impersonating .impersonate-controls .account_id {
+  font-weight: bold;
+}
+#impersonating .impersonate-controls a {
+  text-decoration: underline;
+  color: white;
+}
+</style>
+<div id="impersonating">
+  <div class="impersonate-controls">
+    <div class="impersonate-info">
+      You (
+      <span class="admin_name"><%= current_staff_user %></span>
+      ) are impersonating
+      <span class="admin_name"><%= current_user %></span>
+      ( User id: <%= current_user.to_param %> )
+    </div>
+    <div class="impersonate-buttons">
+      <%= form_tag impersonate_engine.revert_impersonate_user_url,
+          :method => :delete, :class => 'revert-form' do %>
+        <button type = "submit"> Revert to admin</button>
+      <% end %>
+    </div>
+  </div>
+</div>

data/app/views/user_impersonate/impersonate/index.html.erb ADDED Viewed

@@ -0,0 +1,30 @@
+<h1>Default impersonation home page</h1>
+<p>
+  It is recommended you ignore this page and integrate the
+  <code>impersonate_engine.impersonate_user_path(user)</code> URL helpers into your main app.
+</p>
+<p>Search for a user to impersonate:</p>
+<%= form_tag root_url, :method => 'get' do %>
+  <p>
+    <%= text_field_tag :search, params[:search] %>
+    <%= submit_tag "Search", :name => nil %>
+  </p>
+<% end %>
+<% if @users %>
+<% if @users.empty? %>
+<p>No users found</p>
+<% else %>
+<ul>
+  <% @users.each do |user| %>
+  <li>
+    <%= user %>
+    <%= link_to "Impersonate", impersonate_user_path(user) %>
+  </li>
+  <% end %>
+</ul>
+<% end %>
+<% end %>

data/config/cucumber.yml ADDED Viewed

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,6 @@
+UserImpersonate::Engine.routes.draw do
+  get "/user/:user_id" , to: "impersonate#create", as: :impersonate_user
+  delete "/revert" , to: "impersonate#destroy", as: :revert_impersonate_user
+  root to: "impersonate#index"
+end

data/lib/generators/user_impersonate/USAGE ADDED Viewed

@@ -0,0 +1,6 @@
+Description:
+    Installs the routes and configurable portions of the
+    user_impersonate engine.
+Example:
+    rails g user_impersonate

data/lib/generators/user_impersonate/templates/app/views/user_impersonate/_header.html.erb ADDED Viewed

@@ -0,0 +1,60 @@
+<style>
+#impersonating {
+  width: 100%;
+  margin: 0;
+  padding: 12px 0;
+  background: #c70000;
+  border-bottom: 1px solid black;
+  line-height: 1.9;
+  font-size: 12px;
+  font-family: "Lucida Sans Unicode","Lucida Grande",Verdana,Arial,Helvetica,sans-serif;
+}
+#impersonating .impersonate-controls {
+  color: white;
+  font-weight: normal;
+  font-size: 15px;
+  max-width: 960px;
+  margin-left: auto;
+  margin-right: auto;
+}
+#impersonating .impersonate-controls .impersonate-info {
+  margin-bottom: 6px;
+  padding-bottom: 2px;
+  border-bottom: 1px solid #dd0000;
+}
+#impersonating .impersonate-controls form {
+  display: inline;
+  margin-right: 16px;
+}
+#impersonating .impersonate-controls .revert-form {
+  margin-left: 16px;
+}
+#impersonating .impersonate-controls select {
+  background: white;
+}
+#impersonating .impersonate-controls .admin_name, #impersonating .impersonate-controls .user_name, #impersonating .impersonate-controls .user_id, #impersonating .impersonate-controls .account_id {
+  font-weight: bold;
+}
+#impersonating .impersonate-controls a {
+  text-decoration: underline;
+  color: white;
+}
+</style>
+<div id="impersonating">
+  <div class="impersonate-controls">
+    <div class="impersonate-info">
+      You (
+      <span class="admin_name"><%= current_staff_user %></span>
+      ) are impersonating
+      <span class="admin_name"><%= current_user %></span>
+      ( User id: <%= current_user.to_param %> )
+    </div>
+    <div class="impersonate-buttons">
+      <%= form_tag impersonate_engine.revert_impersonate_user_url,
+          :method => :delete, :class => 'revert-form' do %>
+        <button type = "submit"> Revert to admin</button>
+      <% end %>
+    </div>
+  </div>
+</div>

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

@@ -0,0 +1,15 @@
+module UserImpersonate
+  class Engine < Rails::Engine
+    config.user_class           = "User"
+    config.user_finder          = "find"   # User.find
+    config.user_id_column       = "id"     # Such that User.find(aUser.id) works
+    config.user_name_column     = "name"   # Such that User.where("#{user_name_column} like ?", "%#{params[:search]}%") works
+    config.user_is_staff_method = "staff?" # current_user.staff?
+    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/generators/user_impersonate/user_impersonate_generator.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class UserImpersonateGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  def engine_routes
+    route 'mount UserImpersonate::Engine => "/impersonate", as: "impersonate_engine"'
+  end
+  def configuration
+    directory "config"
+  end
+  def views
+    directory "app/views"
+  end
+end

data/lib/tasks/user_impersonate_tasks.rake ADDED Viewed

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :user_impersonate do
+#   # Task goes here
+# end

data/lib/user_impersonate.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require "user_impersonate/engine"
+module UserImpersonate
+end

data/lib/user_impersonate/devise_helpers.rb ADDED Viewed

@@ -0,0 +1,31 @@
+# TODO store staff user via Warden
+module UserImpersonate
+  module DeviseHelpers
+    module Helpers
+      # 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 new_user, bypass: true
+      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 current_staff_user, bypass: true
+        session[:staff_user_id] = nil
+      end
+    end
+    module UrlHelpers
+      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
+end

data/lib/user_impersonate/engine.rb ADDED Viewed

@@ -0,0 +1,17 @@
+module UserImpersonate
+  class Engine < ::Rails::Engine
+    isolate_namespace UserImpersonate
+    initializer "user_impersonate.devise_helpers" do
+      if Object.const_defined?("Devise")
+        require "user_impersonate/devise_helpers"
+        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 ADDED Viewed

@@ -0,0 +1,4 @@
+module UserImpersonate
+  VERSION = '0.9.0'
+end

data/test/dummy/README.rdoc ADDED Viewed

@@ -0,0 +1,261 @@
+== Welcome to Rails
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+== Getting Started
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+== Debugging Rails
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+The result will be a message in your log file along the lines of:
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+== Debugger
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+...and even better, you can examine how your runtime objects actually work:
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+Finally, when you're ready to resume execution, you can enter "cont".
+== Console
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+To start the console, run <tt>rails console</tt> from the application
+directory.
+Options:
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+== dbconsole
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+== Description of Contents
+The default directory structure of a generated Ruby on Rails application:
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+app
+  Holds all the code that's specific to this particular application.
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+script
+  Helper scripts for automation and generation.
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.