pretender 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 912488b31e2aedf08cf4370da9cd18f5d9b444e8
-  data.tar.gz: 0277513a5ebf12372667de4503cb6fd1a36c4a13
+  metadata.gz: 7cf9079c429f9aa0c9eb9f298f6c26ca15e983cc
+  data.tar.gz: 79f8b2328f1ec9ea662ee1feb112db4b1bd8d57d
 SHA512:
-  metadata.gz: 563a6e9b4a66732ae8830f2250481029f9a738841efafa457b658952fc1740616dd6a9835534e26d3ba4781083db1881b4c7c40b5a57748557c9923ab5cdcc61
-  data.tar.gz: 8524dae4aef68116d865d8134972b1862e4967a2a0426ef2efdaee71fd2f3e98a098fc9e9aee1029a7fba248966ae0d00356cb57b80ff2c2b86621d3a1922470
+  metadata.gz: b7e6895927961d7cfed49fdc450b0c3102425fbfbf027ae4b6cb12bd3e29eb134399e452d2974d52925146505ec589a74ef5d0beea4719fb1d301424de216c12
+  data.tar.gz: e6695c73ed14d15359114f0a779b77bb186e299a18bf679f5774921e66759c57a6852c3bf4f59b56dfab75e9a5e3c32a3dde543987b868df247dc29cdb20f3da

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.2.0
+
+- Started changelog

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in pretender.gemspec
 gemspec

data/README.md

@@ -1,69 +1,64 @@
 # Pretender
 
-As an admin, there are times you want to see exactly what another user sees or take action on behalf of a user.  Meet Pretender.
+As an admin, there are times you want to see exactly what another user sees.  Meet Pretender.
 
-- Easy to switch back and forth between roles
+- Easily to switch between users
 - Minimal code changes
-- Plays nicely with auditing tools - **this is crucial**
+- Plays nicely with auditing tools
 
-[Rock on](http://www.youtube.com/watch?v=SBjQ9tuuTJQ) :boom:
+:boom: [Rock on](http://www.youtube.com/watch?v=SBjQ9tuuTJQ)
 
-Pretender is also flexible and lightweight - less than 40 lines of code :-)
+Pretender is flexible and lightweight - less than 40 lines of code :-)
 
-Pretender works with Rails 2.3+ and almost any authentication system.
-(devise, authlogic, sorcery, and many more - it’s agnostic)
+Works with any authentication system - [Devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), and [Sorcery](https://github.com/NoamB/sorcery) to name a few.
 
-[Battle-tested at Instacart](https://www.instacart.com)
+:tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-## Get started
+## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-# Gemfile
 gem 'pretender'
 ```
 
-And add this line to your ApplicationController:
+And add this to your `ApplicationController`:
 
 ```ruby
-# app/controllers/application_controller.rb
 class ApplicationController < ActionController::Base
   impersonates :user
 end
 ```
 
-This adds three methods to your controllers:
+If `current_user` is defined in your `ApplicationController`, it must come **before** the `impersonates` method.
 
-```ruby
-true_user
-# returns authenticated user
+## How It Works
+
+Sign in as another user with:
 
+```
 impersonate_user(user)
-# allows you to login as another user
+```
 
-stop_impersonating_user
-# become yourself again
-  ```
+The `current_user` method now returns the impersonated user.
 
-And changes the behavior of another:
+You can access the true user with:
 
-```ruby
-current_user
-# now returns:
-# - if impersonating, the impersonated user
-# - otherwise, the true user
+```
+true_user
 ```
 
-**Note:** the name of this method is configurable (details at the end)
+And stop impersonating with:
 
-Now we need to set up a way to login as another user.  **Pretender makes no assumptions about how you want to do this**.  I like to add this to my admin dashboard.
+```ruby
+stop_impersonating_user
+```
 
 ### Sample Implementation
 
 ```ruby
 class Admin::UsersController < ApplicationController
-  before_filter :require_admin
+  before_filter :require_admin!
 
   def impersonate
     user = User.find(params[:id])
@@ -75,50 +70,42 @@ class Admin::UsersController < ApplicationController
     stop_impersonating_user
     redirect_to root_path
   end
-
 end
 ```
 
-### Show Admins
+Show when someone is signed in as another user in your application layout.
 
-You may want to make it obvious to an admin when he / she is signed in as another user.  I like to add this to the application layout.
-
-#### Haml / Slim
-
-```haml
-- # app/views/layouts/application.html.haml
-- if current_user != true_user
-  .alert
-    You (#{true_user.name}) are signed in as #{current_user.name}
-    = link_to "Back to admin", stop_impersonating_path
+```erb
+<% if current_user != true_user %>
+  You (<%= true_user.name %>) are signed in as <%= current_user.name %>
+  <%= link_to "Back to admin", stop_impersonating_path %>
+<% end %>
 ```
 
-### Audits
+## Audits
 
-If you keep audit logs with a library like [audited](https://github.com/collectiveidea/audited), make sure it uses the **true user**.
+If you keep audit logs with a library like [Audited](https://github.com/collectiveidea/audited), make sure it uses the **true user**.
 
 ```ruby
 Audited.current_user_method = :true_user
 ```
 
-### Configuration
+## Configuration
 
 Pretender is super flexible.  You can change the names of methods and even impersonate multiple roles at the same time.  Here’s the default configuration.
 
 ```ruby
-# app/controllers/application_controller.rb
 impersonates :user,
-             :method => :current_user,
-             :with => proc{|id| User.where(:id => id).first }
+             method: :current_user,
+             with: -> (id) { User.find_by(id: id) }
 ```
 
 Mold it to fit your application.
 
 ```ruby
-# app/controllers/application_controller.rb
 impersonates :account,
-             :method => :authenticated_account,
-             :with => proc{|id| EnterpriseAccount.where(:id => id).first }
+             method: :authenticated_account,
+             with: -> (id) { EnterpriseAccount.find_by(id: id) }
 ```
 
 This creates three methods:
@@ -129,8 +116,6 @@ impersonate_account
 stop_impersonating_account
 ```
 
-Also, authenticated_account is overridden with `EnterpriseAccount.where(:id => id).first`
-
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -139,5 +124,3 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/pretender/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
-
-That’s all folks!

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/pretender.rb

@@ -1,29 +1,32 @@
 require "pretender/version"
+require "active_support"
 
 module Pretender
+  class Error < StandardError; end
 
   def impersonates(scope = :user, opts = {})
     impersonated_method = opts[:method] || :"current_#{scope}"
-    impersonate_with = opts[:with] || proc{|id| scope.to_s.classify.constantize.where(:id => id).first }
+    impersonate_with = opts[:with] || proc { |id| scope.to_s.classify.constantize.where(:id => id).first }
     true_method = :"true_#{scope}"
     session_key = :"impersonated_#{scope}_id"
     impersonated_var = :"@impersonated_#{scope}"
 
     # define methods
-    if respond_to?(impersonated_method)
+    if method_defined?(impersonated_method)
       alias_method true_method, impersonated_method
     else
       define_method true_method do
+        raise Pretender::Error, "Cannot find method: #{impersonated_method}" unless ActionController::Base.method_defined?(impersonated_method)
         ActionController::Base.instance_method(impersonated_method).bind(self).call
       end
     end
     helper_method true_method
 
     define_method impersonated_method do
-      if !instance_variable_get(impersonated_var)
+      unless instance_variable_get(impersonated_var)
         # only fetch impersonation if user is logged in and impersonation_id exists
         true_resource = send(true_method)
-        if session[session_key] and !true_resource
+        if session[session_key] && !true_resource
           session[session_key] = nil
         end
         value = (session[session_key] && impersonate_with.call(session[session_key])) || true_resource
@@ -42,7 +45,8 @@ module Pretender
       session[session_key] = nil
     end
   end
-
 end
 
-ActionController::Base.send(:extend, Pretender) if defined?(ActionController::Base)
+ActiveSupport.on_load(:action_controller) do
+  ActionController::Base.send(:extend, Pretender)
+end

data/lib/pretender/version.rb

@@ -1,3 +1,3 @@
 module Pretender
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/pretender.gemspec

@@ -1,23 +1,26 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'pretender/version'
+require "pretender/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "pretender"
   spec.version       = Pretender::VERSION
   spec.authors       = ["Andrew Kane"]
-  spec.email         = ["acekane1@gmail.com"]
-  spec.description   = %q{Simple, powerful user impersonation for Rails}
-  spec.summary       = %q{Easy to switch back and forth between roles, minimal code changes, and plays nicely with auditing tools}
-  spec.homepage      = "http://ankane.github.com/pretender/"
+  spec.email         = ["andrew@chartkick.com"]
+  spec.description   = "Simple, powerful user impersonation for Rails"
+  spec.summary       = "Easy to switch back and forth between roles, minimal code changes, and plays nicely with auditing tools"
+  spec.homepage      = "https://github.com/ankane/pretender"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "actionpack"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/test/pretender_test.rb

@@ -0,0 +1,60 @@
+require_relative "test_helper"
+
+module TheTruth
+  def test_original_state
+    @controller.current_user = @impersonator
+
+    assert_equal @impersonator, @controller.true_user
+    assert_equal @impersonator, @controller.current_user
+  end
+
+  def test_impersonates
+    @controller.current_user = @impersonator
+    @controller.impersonate_user @impersonated
+
+    assert_equal @impersonator, @controller.true_user
+    assert_equal @impersonated, @controller.current_user
+  end
+
+  def test_impersonated_state
+    @controller.current_user = @impersonator
+    @controller.session[:impersonated_user_id] = @impersonated.id
+
+    assert_equal @impersonator, @controller.true_user
+    assert_equal @impersonated, @controller.current_user
+  end
+
+  def test_stops_impersonating
+    @controller.current_user = @impersonator
+    @controller.session[:impersonated_user_id] = @impersonated.id
+    @controller.stop_impersonating_user
+
+    assert_equal @impersonator, @controller.true_user
+    assert_equal @impersonator, @controller.current_user
+  end
+end
+
+class PretenderTest < Minitest::Test
+  include TheTruth
+
+  def setup
+    @impersonator = User.new("impersonator")
+    @impersonated = User.new("impersonated")
+    @controller = ApplicationController.new
+  end
+end
+
+class SuperPretenderTest < Minitest::Test
+  include TheTruth
+
+  def setup
+    @impersonator = User.new("impersonator")
+    @impersonated = User.new("impersonated")
+    @controller = ApplicationController.new
+    class << @controller
+      def current_user
+        super
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require "bundler/setup"
+Bundler.require(:default)
+require "minitest/autorun"
+require "minitest/pride"
+require "action_controller"
+
+User = Struct.new(:id) do
+  def self.where(id: nil)
+    [new(id)]
+  end
+end
+
+module ActionController
+  class Base
+    attr_reader :session
+
+    def initialize
+      @session = {}
+    end
+  end
+end
+
+class ApplicationController < ActionController::Base
+  attr_accessor :current_user
+  impersonates :user
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pretender
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-24 00:00:00.000000000 Z
+date: 2016-07-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,14 +52,29 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple, powerful user impersonation for Rails
 email:
-- acekane1@gmail.com
+- andrew@chartkick.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,7 +82,9 @@ files:
 - lib/pretender.rb
 - lib/pretender/version.rb
 - pretender.gemspec
-homepage: http://ankane.github.com/pretender/
+- test/pretender_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ankane/pretender
 licenses:
 - MIT
 metadata: {}
@@ -73,9 +104,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Easy to switch back and forth between roles, minimal code changes, and plays
   nicely with auditing tools
-test_files: []
+test_files:
+- test/pretender_test.rb
+- test/test_helper.rb