pretender 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc80b6979512a9246224aa4d68f4dbda8b0c70f8
-  data.tar.gz: 71aadf8f167f0f0350f0c0c3b89743753fe8ef78
+  metadata.gz: c0ab4d0149f46b7e67a8dce743f1ca1af138dc83
+  data.tar.gz: 024cda09d36830a14181e4c2804f0e0de91e79d0
 SHA512:
-  metadata.gz: c6e774897e0fc2b2b7a4bb2044ce22c6ea32d6263d20cf9ab441dc5a7d83dc6b218fcce333b661076a06c669047ec951671aa9c47f0bdf30c6b833465e60e080
-  data.tar.gz: 503223df0e48c6afce6e0d830a28ffac72bf55965e0db6ac7d4c8a439ef422a46bad0bbce06a6cfaae560a540c2ded2788f5919c81eec9c3f91dc595f5d94abd
+  metadata.gz: c9363670918c4f314ca836ef35e0f605e072592ec52bcd71bd8e24302338a06f6acc004dfe38daf83a9071305edc522b811aab9537e7bea450e233b6ced32e10
+  data.tar.gz: 372bde2ce4d5e55abaa2ef747afa726b243e2fe6dc9bbcf7a90f72722f454bb1f5d33e561147e0e35e34959a4a44656f03c970bc3fa514d0f56eb1ee1a37dd83

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.3.2
+
+- Support for Mongoid `BSON::ObjectId` out of the box
+- Fixed issue with impersonated resource caching
+
 ## 0.3.1
 
 - Fixed `stack level too deep` error

data/README.md

@@ -10,7 +10,7 @@ As an admin, there are times you want to see exactly what another user sees.  Me
 
 Pretender is flexible and lightweight - less than 60 lines of code :-)
 
-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.
+Works with any authentication system - [Devise](https://github.com/plataformatec/devise), [Authlogic](https://github.com/binarylogic/authlogic), and [Sorcery](https://github.com/Sorcery/sorcery) to name a few.
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
@@ -58,7 +58,7 @@ Create a controller
 
 ```ruby
 class UsersController < ApplicationController
-  before_filter :require_admin!
+  before_action :require_admin! # your authorization method
 
   def index
     @users = User.order(:id)

data/lib/pretender.rb

@@ -15,6 +15,7 @@ module Pretender
       true_method = :"true_#{scope}"
       session_key = :"impersonated_#{scope}_id"
       impersonated_var = :"@impersonated_#{scope}"
+      stop_impersonating_method = :"stop_impersonating_#{scope}"
 
       # define methods
       if method_defined?(impersonated_method) || private_method_defined?(impersonated_method)
@@ -30,26 +31,39 @@ module Pretender
       helper_method(true_method) if respond_to?(:helper_method)
 
       define_method impersonated_method do
-        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] && !true_resource
-            session[session_key] = nil
+        impersonated_resource = instance_variable_get(impersonated_var) if instance_variable_defined?(impersonated_var)
+
+        if !impersonated_resource && session[session_key]
+          # only fetch impersonation if user is logged in
+          # this is a safety check (once per request) so
+          # if a user logs out without session being destroyed
+          # or stop_impersonating_user being called,
+          # we can stop the impersonation
+          if send(true_method)
+            impersonated_resource = impersonate_with.call(session[session_key])
+            instance_variable_set(impersonated_var, impersonated_resource) if impersonated_resource
+          else
+            # TODO better message
+            warn "[pretender] Stopping impersonation due to safety check"
+            send(stop_impersonating_method)
           end
-          value = (session[session_key] && impersonate_with.call(session[session_key])) || true_resource
-          instance_variable_set(impersonated_var, value) if value
         end
-        instance_variable_get(impersonated_var)
+
+        impersonated_resource || send(true_method)
       end
 
       define_method :"impersonate_#{scope}" do |resource|
+        raise ArgumentError, "No resource to impersonate" unless resource
+        raise Pretender::Error, "Must be logged in to impersonate" unless send(true_method)
+
         instance_variable_set(impersonated_var, resource)
-        session[session_key] = resource.id
+        # use to_s for Mongoid for BSON::ObjectId
+        session[session_key] = resource.id.is_a?(Numeric) ? resource.id : resource.id.to_s
       end
 
-      define_method :"stop_impersonating_#{scope}" do
-        instance_variable_set(impersonated_var, nil)
-        session[session_key] = nil
+      define_method stop_impersonating_method do
+        remove_instance_variable(impersonated_var) if instance_variable_defined?(impersonated_var)
+        session.delete(session_key)
       end
     end
   end

data/lib/pretender/version.rb

@@ -1,3 +1,3 @@
 module Pretender
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/pretender.gemspec

@@ -8,19 +8,20 @@ Gem::Specification.new do |spec|
   spec.version       = Pretender::VERSION
   spec.authors       = ["Andrew Kane"]
   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.summary       = "Log in as another user in Rails"
   spec.homepage      = "https://github.com/ankane/pretender"
   spec.license       = "MIT"
 
-  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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "actionpack"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretender
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-06-18 00:00:00.000000000 Z
+date: 2018-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Simple, powerful user impersonation for Rails
+description: 
 email:
 - andrew@chartkick.com
 executables: []
@@ -82,8 +82,6 @@ files:
 - lib/pretender.rb
 - lib/pretender/version.rb
 - pretender.gemspec
-- test/pretender_test.rb
-- test/test_helper.rb
 homepage: https://github.com/ankane/pretender
 licenses:
 - MIT
@@ -104,11 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 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/pretender_test.rb
-- test/test_helper.rb
+summary: Log in as another user in Rails
+test_files: []

data/test/pretender_test.rb

@@ -1,60 +0,0 @@
-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

@@ -1,26 +0,0 @@
-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