pretender 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0ab4d0149f46b7e67a8dce743f1ca1af138dc83
-  data.tar.gz: 024cda09d36830a14181e4c2804f0e0de91e79d0
+SHA256:
+  metadata.gz: 624438bfbdcef436923e6f49129b0a9ea5720e40f0ddb00c01049a2550142d53
+  data.tar.gz: 2791622f97f44d0235e4b49df110710236311f8a6ddec028c09a5635f8d7510c
 SHA512:
-  metadata.gz: c9363670918c4f314ca836ef35e0f605e072592ec52bcd71bd8e24302338a06f6acc004dfe38daf83a9071305edc522b811aab9537e7bea450e233b6ced32e10
-  data.tar.gz: 372bde2ce4d5e55abaa2ef747afa726b243e2fe6dc9bbcf7a90f72722f454bb1f5d33e561147e0e35e34959a4a44656f03c970bc3fa514d0f56eb1ee1a37dd83
+  metadata.gz: fadb24776c856be26bbf61b7c374b9720388aacbd334b31727d54a6ee9685e5b8a87dff97d884ac7690c7279c55276ebf703bdd22b927ed3271dd3f15ba7c3cb
+  data.tar.gz: d347f12d73ad8618e82bdcae16101271689810ba1b90cbb83c08b7cf4b9e3513bebeb51d76645b71b2793661f0e0e8414b32379841844d9287b89d4b9cf79afc

data/CHANGELOG.md

@@ -1,22 +1,38 @@
-## 0.3.2
+## 0.5.0 (2023-07-02)
+
+- Dropped support for Ruby < 3 and Rails < 6.1
+
+## 0.4.0 (2022-01-10)
+
+- Dropped support for Ruby < 2.6 and Rails < 5.2
+
+## 0.3.4 (2019-01-31)
+
+- Fixed error with Action Cable and eager loading
+
+## 0.3.3 (2018-09-21)
+
+- Added support for Action Cable
+
+## 0.3.2 (2018-01-21)
 
 - Support for Mongoid `BSON::ObjectId` out of the box
 - Fixed issue with impersonated resource caching
 
-## 0.3.1
+## 0.3.1 (2017-06-18)
 
 - Fixed `stack level too deep` error
 
-## 0.3.0
+## 0.3.0 (2017-06-11)
 
 - Fixed compatibility with Clearance
 - Added support for Rails API
 - Added support for custom primary key
 
-## 0.2.1
+## 0.2.1 (2016-07-07)
 
 - Better error message
 
-## 0.2.0
+## 0.2.0 (2016-07-07)
 
 - Started changelog

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andrew Kane
+Copyright (c) 2013-2023 Andrew Kane
 
 MIT License
 

data/README.md

@@ -1,25 +1,27 @@
 # Pretender
 
-As an admin, there are times you want to see exactly what another user sees.  Meet Pretender.
+As an admin, there are times you want to see exactly what another user sees. Meet Pretender.
 
-- Easily to switch between users
+- Easily switch between users
 - Minimal code changes
-- Plays nicely with auditing tools
+- Plays nicely with Action Cable and auditing tools
 
-:boom: [Rock on](http://www.youtube.com/watch?v=SBjQ9tuuTJQ)
+:boom: [Rock on](https://www.youtube.com/watch?v=SBjQ9tuuTJQ)
 
-Pretender is flexible and lightweight - less than 60 lines of code :-)
+Pretender is flexible and lightweight - less than 100 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/Sorcery/sorcery) to name a few.
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://github.com/ankane/pretender/workflows/build/badge.svg?branch=master)](https://github.com/ankane/pretender/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'pretender'
+gem "pretender"
 ```
 
 And add this to your `ApplicationController`:
@@ -113,14 +115,40 @@ If you keep audit logs with a library like [Audited](https://github.com/collecti
 Audited.current_user_method = :true_user
 ```
 
+## Action Cable
+
+And add this to your `ApplicationCable::Connection`:
+
+```ruby
+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.
+
 ## 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.
+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
 impersonates :user,
              method: :current_user,
-             with: -> (id) { User.find_by(id: id) }
+             with: ->(id) { User.find_by(id: id) }
 ```
 
 Mold it to fit your application.
@@ -128,7 +156,7 @@ Mold it to fit your application.
 ```ruby
 impersonates :account,
              method: :authenticated_account,
-             with: -> (id) { EnterpriseAccount.find_by(id: id) }
+             with: ->(id) { EnterpriseAccount.find_by(id: id) }
 ```
 
 This creates three methods:
@@ -139,6 +167,10 @@ impersonate_account
 stop_impersonating_account
 ```
 
+## History
+
+View the [changelog](https://github.com/ankane/pretender/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
@@ -147,3 +179,12 @@ 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
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/pretender.git
+cd pretender
+bundle install
+bundle exec rake test
+```

data/lib/pretender/version.rb

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

data/lib/pretender.rb

@@ -1,6 +1,9 @@
-require "pretender/version"
+# dependencies
 require "active_support"
 
+# modules
+require_relative "pretender/version"
+
 module Pretender
   class Error < StandardError; end
 
@@ -33,14 +36,14 @@ module Pretender
       define_method impersonated_method do
         impersonated_resource = instance_variable_get(impersonated_var) if instance_variable_defined?(impersonated_var)
 
-        if !impersonated_resource && session[session_key]
+        if !impersonated_resource && request.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])
+            impersonated_resource = impersonate_with.call(request.session[session_key])
             instance_variable_set(impersonated_var, impersonated_resource) if impersonated_resource
           else
             # TODO better message
@@ -58,12 +61,12 @@ module Pretender
 
         instance_variable_set(impersonated_var, resource)
         # use to_s for Mongoid for BSON::ObjectId
-        session[session_key] = resource.id.is_a?(Numeric) ? resource.id : resource.id.to_s
+        request.session[session_key] = resource.id.is_a?(Numeric) ? resource.id : resource.id.to_s
       end
 
       define_method stop_impersonating_method do
         remove_instance_variable(impersonated_var) if instance_variable_defined?(impersonated_var)
-        session.delete(session_key)
+        request.session.delete(session_key)
       end
     end
   end
@@ -72,3 +75,6 @@ end
 ActiveSupport.on_load(:action_controller) do
   extend Pretender::Methods
 end
+
+# ActiveSupport.on_load(:action_cable) runs too late with Unicorn
+ActionCable::Connection::Base.extend(Pretender::Methods) if defined?(ActionCable)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretender
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,77 +16,30 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
   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
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  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'
-- !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: 
-email:
-- andrew@chartkick.com
+        version: '6.1'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/pretender.rb
 - lib/pretender/version.rb
-- pretender.gemspec
 homepage: https://github.com/ankane/pretender
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,16 +47,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Log in as another user in Rails
 test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/Gemfile

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

data/Rakefile

@@ -1,8 +0,0 @@
-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/pretender.gemspec

@@ -1,27 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "pretender/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "pretender"
-  spec.version       = Pretender::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-  spec.summary       = "Log in as another user in Rails"
-  spec.homepage      = "https://github.com/ankane/pretender"
-  spec.license       = "MIT"
-
-  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"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end