rails_admin_pretender 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4db0cfb54240ae1ec44f3f983c5a59f79cfa11547b2504cedbf5bab0d5fd76f7
+  data.tar.gz: 0b831eb0f39845c385ddcaf33bf67a1c918eab551f92ee75210f36960ded4da1
+SHA512:
+  metadata.gz: 055c3e0e094deac3bb9398f574e8c17b32911172fdf443253db0e3b353e21caf319783bb42edcb1fd84a645578438fae9302aa174d03cf07ed543b7190eab194
+  data.tar.gz: dd9edcee84966a800fe2c317865dca604e9086ac7af3e92b7f2c8bbda0c727906190dec7d813ad5dba434503619c00699b325a5dff544b71d99badfe0906028b

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2019 Chien Tran
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# Why not using [RailsAdminImpersonate](https://github.com/astrails/rails_admin_impersonate)?
+
+I found that the `rails_admin_impersonate` is missing an important feature, to allow Admin to sign out of the current impersonated user and restore the Admin session. It is a bit annoying to sign in after I have finished impersonating someone.
+
+Using [Pretender gem](https://github.com/ankane/pretender) seems to be a solution, but integrating it with RailsAdmin is not straightforward (and no tutorial for doing that so far). This gem is for that purpose. It is inspired by [RailsAdminImpersonate](https://github.com/astrails/rails_admin_impersonate).
+
+# RailsAdminPretender
+
+Add an ability to [rails_admin](https://github.com/sferik/rails_admin) to impersonate as any user or actually any member
+that is devise authenticatable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_admin_pretender'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Add to your `config/initializers/rails_admin.rb` an action `impersonate` to actions:
+
+    config.actions do
+      # root actions
+      dashboard                     # mandatory
+      # collection actions
+      index                         # mandatory
+      new
+      export
+      history_index
+      bulk_delete
+      # member actions
+      show
+      edit
+      delete
+      history_show
+      show_in_app
+      impersonate
+    end
+
+At the bottom of `config/initializers/rails_admin.rb`, add the following line:
+
+    RailsAdminPretender.init
+
+Finally, in your `ApplicationController`, include the following module:
+
+    include RailsAdminPretender
+
+
+Now restart the application and visit User table in the admin. You should see home icon and Impersonate link for every model that uses Devise. In your views, you can use the helper `is_impersonating?` to check whether current_user is an impersonated user or not.
+
+For example:
+
+    <% if is_impersonating? %>
+      <li class="nav-item">
+        <%= link_to "Sign out of this user", stop_impersonating_path, method: :post, class: "nav-link" %>
+      </li>
+    <% else %>
+      <li class="nav-item">
+        <%= link_to "Sign out", destroy_user_session_path, method: :delete, class: "nav-link" %>
+      </li>
+    <% end %>
+
+Note: by default impersonation is disabled for model `Admin`. If you want to
+disable it for some other model you can modify the above code like this:
+
+    config.actions do
+      ...
+      impersonate do
+        authorized do
+          'ModelName' != bindings[:abstract_model].model_name
+        end
+      end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+&copy; 2019 [Chien Tran]

data/config/locales/rails_admin_pretender.yml

@@ -0,0 +1,5 @@
+en:
+  admin:
+    actions:
+      impersonate:
+        menu: "Impersonate"

data/lib/rails_admin_pretender.rb

@@ -0,0 +1,26 @@
+require 'pretender'
+require_relative '../rails_admin/config/actions/impersonate'
+
+module RailsAdminPretender
+  extend ActiveSupport::Concern
+
+  def self.init
+    RailsAdmin::MainController.extend(::Pretender::Methods)
+    RailsAdmin::MainController.impersonates(:user)
+  end
+
+  def is_impersonating?
+    true_user != current_user
+  end
+
+  included do
+    if respond_to?(:impersonates)
+      impersonates(:user)
+    end
+    if respond_to?(:helper_method)
+      helper_method :is_impersonating?
+    end
+  end
+end
+
+I18n.load_path += Dir.glob(File.expand_path("../../config/locales/*.{rb,yml}", __FILE__))

data/rails_admin/config/actions/impersonate.rb

@@ -0,0 +1,37 @@
+module RailsAdmin
+  module Config
+    module Actions
+      class Impersonate < RailsAdmin::Config::Actions::Base
+        register_instance_option :visible? do
+          ('Admin' != bindings[:abstract_model].model_name) &&
+            authorized? && bindings[:object].respond_to?(:devise_modules)
+        end
+
+        register_instance_option :member? do
+          true
+        end
+
+        register_instance_option :pjax? do
+          false
+        end
+
+        register_instance_option :http_methods do
+          [:get]
+        end
+
+        register_instance_option :link_icon do
+          'icon-home'
+        end
+
+        register_instance_option :controller do
+          Proc.new do
+            impersonate_user(@object)
+            redirect_to "/"
+          end
+        end
+
+        RailsAdmin::Config::Actions.register(self)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: rails_admin_pretender
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Chien Tran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pretender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+description: A simple gem to integrate pretender with RailsAdmin
+email: chientranx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- config/locales/rails_admin_pretender.yml
+- lib/rails_admin_pretender.rb
+- rails_admin/config/actions/impersonate.rb
+homepage: http://rubygems.org/gems/rails_admin_pretender
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Rails Admin Pretender
+test_files: []