devise_masquerade 1.3.11 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02fcf52821938df133246e4b36ed07ee85ab96c036cd8da0cf35ace09c229491
-  data.tar.gz: 3247bf4be6fe21dc5ba5c83d804dab155d92286ef8c8c1625e92b181cb0c01dc
+  metadata.gz: 99dc9de6d6af53393db0f0f0a8c8b80191bf203bad2ba604eb50dce7708aa314
+  data.tar.gz: a8a89851d08443baaf4e7106bec7267d7a0c8209f01da40431874672ff56d1c9
 SHA512:
-  metadata.gz: b6f6902ea81dd6d5ffef2cd48cfa7e5b4521906f912a02b3986117ef933ebea89d7b63f2d5eb43372c1ad76a84d63ae433f236394bd1c16e83891efcaa300760
-  data.tar.gz: 40b48f52e4a162e2033c13ccc6a9fabf2b882dcfd64ad236a27f08e20f54862fd3139d07cb8a0c780d50d3f3c6cc06f9e1e9ffaf2dd16ffd3e42a7a67930f144
+  metadata.gz: 13133209d039b4f64ff124fc88935198e4cde0ee181abd6ce973b9d31f2618d6ed2512a27adf9c3f5d32be4fff16084f15135a6f95b97ff96b0a430ba4f9819a
+  data.tar.gz: 0b4455f0adfd73ea7a49794349d686010c47157e4e30a836ea9a811f05005f8533af55a1945401f2595845ccd82cc2a84f4b6aa392ef0dcc3bea5b423f9ef35a

data/Gemfile.lock

@@ -52,7 +52,7 @@ GIT
 PATH
   remote: .
   specs:
-    devise_masquerade (1.3.11)
+    devise_masquerade (2.0.0)
       devise (>= 4.7.0)
       globalid (>= 0.3.6)
       railties (>= 5.2.0)
@@ -98,7 +98,7 @@ GEM
     archive-zip (0.12.0)
       io-like (~> 0.3.0)
     backports (3.15.0)
-    bcrypt (3.1.17)
+    bcrypt (3.1.18)
     bson (1.12.5)
     bson_ext (1.12.5)
       bson (~> 1.12.5)
@@ -118,7 +118,7 @@ GEM
       nokogiri (~> 1.8)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    crass (1.0.5)
+    crass (1.0.6)
     cucumber (3.1.2)
       builder (>= 2.1.2)
       cucumber-core (~> 3.2.0)
@@ -190,7 +190,7 @@ GEM
     listen (3.2.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    loofah (2.3.1)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     lumberjack (1.0.13)
@@ -206,7 +206,7 @@ GEM
     multi_json (1.14.1)
     multi_test (0.1.2)
     nenv (0.3.0)
-    nokogiri (1.13.3)
+    nokogiri (1.13.6)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
     notiffany (0.1.3)
@@ -222,13 +222,13 @@ GEM
       pry (~> 0.10)
     public_suffix (4.0.6)
     racc (1.6.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
     railties (6.0.0)
       actionpack (= 6.0.0)
@@ -260,7 +260,7 @@ GEM
       power_assert
     thor (0.20.3)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     warden (1.2.9)
       rack (>= 2.0.9)

data/README.md

@@ -167,7 +167,7 @@ in `routes.rb`:
     Devise.masquerade_bypass_warden_callback = false
     Devise.masquerade_routes_back = false # if true, route back to the page the user was on via redirect_back
     Devise.masquerading_resource_class = AdminUser
-    # optional: Devise.masquerading_resource_class = 'AdminUser'
+    # optional: Devise.masquerading_resource_class_name = 'AdminUser'
 
     # optional, default: masquerading_resource_class.model_name.param_key
     Devise.masquerading_resource_name = :admin_user
@@ -177,6 +177,10 @@ in `routes.rb`:
 
     # optional, default: masqueraded_resource_class.model_name.param_key
     Devise.masqueraded_resource_name = :user
+
+    # optional, default: masquerade_storage_method = :session
+    # values: :session, :cache
+    Devise.masquerade_storage_method = :session
 ```
 
 ## Demo project

data/app/controllers/devise/masquerades_controller.rb

@@ -77,7 +77,13 @@ class Devise::MasqueradesController < DeviseController
   def find_owner_resource(masqueradable_resource)
     skey = session_key(masqueradable_resource, masquerading_guid)
 
-    GlobalID::Locator.locate_signed(Rails.cache.read(skey), for: 'masquerade')
+    data = if Devise.masquerade_storage_method_session?
+      session[skey]
+    else
+      Rails.cache.read(skey)
+    end
+
+    GlobalID::Locator.locate_signed(data, for: 'masquerade')
   end
 
   def go_back(user, path:)
@@ -157,9 +163,15 @@ class Devise::MasqueradesController < DeviseController
 
     resource_gid = send("current_#{masquerading_resource_name}").to_sgid(for: 'masquerade')
 
-    # skip sharing owner id via session
-    Rails.cache.write(skey, resource_gid)
-    session[skey] = true
+    if Devise.masquerade_storage_method_session?
+      session[skey] = resource_gid
+    else
+      # skip sharing owner id via session
+      Rails.cache.write(skey, resource_gid)
+
+      session[skey] = true
+    end
+
     session[session_key_masquerading_resource_class] = masquerading_resource_class.name
     session[session_key_masqueraded_resource_class] = masqueraded_resource_class.name
     session[session_key_masquerading_resource_guid] = guid
@@ -168,8 +180,8 @@ class Devise::MasqueradesController < DeviseController
   def cleanup_masquerade_owner_session(masqueradable_resource)
     skey = session_key(masqueradable_resource, masquerading_guid)
 
-    Rails.cache.delete(skey)
-    session.delete(skey)
+    Rails.cache.delete(skey) if Devise.masquerade_storage_method_cache?
+
     session.delete(session_key_masqueraded_resource_class)
     session.delete(session_key_masquerading_resource_class)
     session.delete(session_key_masquerading_resource_guid)

data/features/back.feature

@@ -3,8 +3,21 @@ Feature: Use back button for returning to the owner of the masquerade action.
   As an masquerade user
   I want to be able to press a simple button on the page
 
-  Scenario: Use back button
+  Scenario: Use back button with cache
     Given I logged in
+    And devise masquerade configured to use cache
+    And I have a user for masquerade
+
+    When I am on the users page
+    And I login as one user
+      Then I should be login as this user
+
+    When I press back masquerade button
+      Then I should be login as owner user
+
+  Scenario: Use back button with session
+    Given I logged in
+    And devise masquerade configured to use session
     And I have a user for masquerade
 
     When I am on the users page

data/features/expires_masquerade.feature

@@ -3,8 +3,24 @@ Feature: Use back button for returning to the owner despite on expiration time.
   As an masquerade user
   I want to be able to press a simple button on the page
 
-  Scenario: Use back button
+  Scenario: Use back button with cache
     Given I logged in
+    And devise masquerade configured to use cache
+    And I have a user for masquerade
+
+    When I have devise masquerade expiration time in 1 second
+
+    When I am on the users page
+    And I login as one user
+      Then I should be login as this user
+      And I waited for 2 seconds
+
+    When I press back masquerade button
+      Then I should be login as owner user
+
+  Scenario: Use back button with session
+    Given I logged in
+    And devise masquerade configured to use session
     And I have a user for masquerade
 
     When I have devise masquerade expiration time in 1 second

data/features/step_definitions/auth_steps.rb

@@ -9,3 +9,10 @@ Given /^I logged in$/ do
   click_on 'Log in'
 end
 
+Given("devise masquerade configured to use cache") do
+  Devise.masquerade_storage_method = :cache
+end
+
+Given("devise masquerade configured to use session") do
+  Devise.masquerade_storage_method = :session
+end

data/lib/devise_masquerade/controllers/helpers.rb

@@ -43,13 +43,22 @@ module DeviseMasquerade
             return false if current_#{name}.blank?
             return false if session[#{name}_helper_session_key].blank?
 
-            ::Rails.cache.exist?(#{name}_helper_session_key).present?
+            if Devise.masquerade_storage_method_session?
+              session[#{name}_helper_session_key].present?
+            else
+              ::Rails.cache.exist?(#{name}_helper_session_key).present?
+            end
           end
 
           def #{name}_masquerade_owner
             return unless send(:#{name}_masquerade?)
 
-            sgid = ::Rails.cache.read(#{name}_helper_session_key)
+            sgid = if Devise.masquerade_storage_method_session?
+              session[#{name}_helper_session_key]
+            else
+              ::Rails.cache.read(#{name}_helper_session_key)
+            end
+
             GlobalID::Locator.locate_signed(sgid, for: 'masquerade')
           end
 

data/lib/devise_masquerade/version.rb

@@ -1,3 +1,3 @@
 module DeviseMasquerade
-  VERSION = '1.3.11'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/devise_masquerade.rb

@@ -39,6 +39,20 @@ module Devise
   # Example: Devise.masquerading_resource_name = :admin_user
   mattr_accessor :masquerading_resource_name
 
+  # Example: Devise.masquerade_storage_method = :session
+  # - session
+  # - cache
+  mattr_accessor :masquerade_storage_method
+  @@masquerade_storage_method = :session
+
+  def self.masquerade_storage_method_session?
+    Devise.masquerade_storage_method == :session
+  end
+
+  def self.masquerade_storage_method_cache?
+    Devise.masquerade_storage_method == :cache
+  end
+
   @@helpers << DeviseMasquerade::Controllers::Helpers
 end
 

data/spec/controllers/devise/masquerades_controller_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe Devise::MasqueradesController, type: :controller do
+  before { Devise.masquerade_storage_method = :cache }
+  after { Devise.masquerade_storage_method = :session }
+
   context 'with configured devise app' do
     before { @request.env['devise.mapping'] = Devise.mappings[:user] }
 

data/spec/controllers/masquerades_tests_controller_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe MasqueradesTestsController, type: :controller do
+  before { Devise.masquerade_storage_method = :cache }
+  after { Devise.masquerade_storage_method = :session }
+
   before { @request.env['devise.mapping'] = Devise.mappings[:user] }
 
   context 'no access for masquerade' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devise_masquerade
 version: !ruby/object:Gem::Version
-  version: 1.3.11
+  version: 2.0.0
 platform: ruby
 authors:
 - Alexandr Korsak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler