Pretender

As an admin, there are times you want to see exactly what another user sees. Meet Pretender.

• Easily switch between users
• Minimal code changes
• Plays nicely with Action Cable and auditing tools

💥 Rock on

Pretender is flexible and lightweight - less than 100 lines of code :-)

Works with any authentication system - Devise, Authlogic, and Sorcery to name a few.

🍊 Battle-tested at Instacart

Pretendest is a friendly fork of Pretender, with a handful of extra features:

• An #impersonating_user? helper,
• An option to impersonate a resource by another resource (e.g. a Client impersonated by an Employee).

If you don't need those features, the original Pretender gem is perfectly fine. Otherwise, pretendest is a drop-in replacement for pretender.

Add this line to your application’s Gemfile:

gem "pretendest"

And add this to your ApplicationController:

class ApplicationController < ActionController::Base
  impersonates :user
end

Sign in as another user with:

impersonate_user(user)

The current_user method now returns the impersonated user.

You can access the true user with:

true_user

And stop impersonating with:

stop_impersonating_user

Create a controller

class UsersController < ApplicationController
  before_action :require_admin! # your authorization method

  def index
    @users = User.order(:id)
  end

  def impersonate
    user = User.find(params[:id])
    impersonate_user(user)
    redirect_to root_path
  end

  def stop_impersonating
    stop_impersonating_user
    redirect_to root_path
  end
end

Add routes

resources :users, only: [:index] do
  post :impersonate, on: :member
  post :stop_impersonating, on: :collection
end

Create an index view

<ul>
  <% @users.each do |user| %>
    <li>Sign in as <%= button_to user.name, impersonate_user_path(user), data: {turbo: false} %></li>
  <% end %>
</ul>

And show when someone is signed in as another user in your application layout

<% if impersonating_user? %>
  You (<%= true_user.name %>) are signed in as <%= current_user.name %>
  <%= button_to "Back to admin", stop_impersonating_users_path, data: {turbo: false} %>
<% end %>

If you keep audit logs with a library like Audited, make sure it uses the true user.

Audited.current_user_method = :true_user

And add this to your ApplicationCable::Connection:

module ApplicationCable
  class Connection < ActionCable::Connection::Base
    identified_by :current_user, :true_user
    impersonates :user

    def connect
      self.current_user = find_verified_user
      reject_unauthorized_connection unless current_user
    end

    private

    def find_verified_user
      env["warden"].user # for Devise
    end
  end
end

The current_user method now returns the impersonated user in channels.

Pretendest is super flexible. You can change the names of methods and even impersonate multiple roles at the same time. Here’s the default configuration.

impersonates :user,
             method: :current_user,
             with: ->(id) { User.find_by(id: id) }

Mold it to fit your application.

impersonates :account,
             method: :authenticated_account,
             with: ->(id) { EnterpriseAccount.find_by(id: id) }

This creates five methods:

true_account
impersonate_account
stop_impersonating_account
impersonating_account? # Pretender Plus addition
account_impersonator   # Pretender Plus addition

You can impersonate a role from another role. Consider for instance when Employees are allowed to impersonate Clients:

impersonates :client,
             impersonator: :employee

In that case, when impersonating:

• true_client returns nil (because there is no "true" client),
• client_impersonator returns the current_employee.

View the changelog

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

To get started with development:

git clone https://github.com/enercoop/pretendest.git
cd pretendest
bundle install
bundle exec rake test