mr_mime 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3e2047a91eb58ca1d3f799031c3649fc8e4add6
-  data.tar.gz: b08268e26e4b204ac74b67d8aea4d7efec4b4482
+  metadata.gz: 46b3168826cd9ed3532de109b2b15953cf8430b8
+  data.tar.gz: 123556f6e10c5e994ee771417e5b74120ee8c7b7
 SHA512:
-  metadata.gz: 3cdf3560ca2b5b0fcf659633cfeefbcb0c5fad2cde0020eb2ee34a38ebaaaf01881a62d7be38d3ba5ac94ca7fad4b54b51ccafdbb055e51e255bbcf4f7a90906
-  data.tar.gz: 7da15de7885351774d7230e7580045783a21de7dc989dc1a07597d6e1e160b57264cac6fd9d0827d7a4e95284278bc3d295cc75d2015c6522ea5c830777abef0
+  metadata.gz: a7312bcd3eadb43e4b859bbf86a9cf6ec583d0908a0f0cbafdcc3450405e84fb82d99ec953fd81a21abb992bd46923a23f325518eea67d8e8c739d6bfb6e2e57
+  data.tar.gz: 65433e6d3fce5b555565e24889aff8d014392c69b7d4533c49fc47bc8e0d4515527ed14f503f0bfb2ab0fba7f026d47cf03f1cb9e7d9318567c011453ea18a35

data/app/controllers/mr_mime/impersonations_controller.rb

@@ -1,10 +1,10 @@
 module MrMime
   class ImpersonationsController < MrMime::ApplicationController
-    before_filter :require_login
+    before_action :require_login
 
     def create
       if impersonation.save
-        redirect_to main_app.root_url, notice: 'Impersonation started'
+        redirect_to after_impersonation_url, notice: 'Impersonation started'
       else
         redirect_to :back, flash: { error: impersonation.error_messages }
       end
@@ -13,7 +13,7 @@ module MrMime
     def destroy
       impersonation.revert
 
-      redirect_to impersonation.return_to, notice: 'Impersonation ended'
+      redirect_to return_to_url, notice: 'Impersonation ended'
     end
 
     private
@@ -45,5 +45,18 @@ module MrMime
         }
       end
     end
+
+    def after_impersonation_url
+      MrMime::UrlResolver.resolve(
+        MrMime::Config.after_impersonation_url,
+        context: self,
+        args: current_user,
+        default: main_app.root_url
+      )
+    end
+
+    def return_to_url
+      impersonation.return_to || main_app.root_url
+    end
   end
 end

data/app/helpers/mr_mime/impersonation_helper.rb

@@ -3,5 +3,9 @@ module MrMime
     def button_to_impersonate(user_id, options = {})
       render 'mr_mime/impersonate_button', options.merge(user_id: user_id)
     end
+
+    def impersonated_email
+      current_user.try(:email)
+    end
   end
 end

data/app/models/mr_mime/adapters/devise_adapter.rb

@@ -1,9 +1,11 @@
 module MrMime
   module Adapters
     class DeviseAdapter < Base
+      delegate :user_class, to: MrMime::Config
+
       def set_current_user(user)
         context.sign_out
-        context.sign_in(user)
+        context.sign_in user.becomes(user_class)
       end
     end
   end

data/app/models/mr_mime/url_resolver.rb

@@ -0,0 +1,39 @@
+module MrMime
+  class UrlResolver
+    delegate :main_app, to: :context, allow_nil: true
+
+    def self.resolve(*args)
+      new(*args).resolve
+    end
+
+    def initialize(url, options = {})
+      @url = evaluate(url, *options[:args])
+      @context = options[:context]
+      @default = options[:default]
+    end
+
+    def resolve
+      case
+      when method_name? then main_app.send(url)
+      when url_name?    then url
+      else default
+      end
+    end
+
+    private
+
+    attr_reader :url, :context, :default
+
+    def method_name?
+      url.is_a?(Symbol)
+    end
+
+    def url_name?
+      url.is_a?(String)
+    end
+
+    def evaluate(url, *args)
+      url.is_a?(Proc) ? url.call(*args) : url
+    end
+  end
+end

data/app/views/mr_mime/_impersonation_warning.html.erb

@@ -1,6 +1,6 @@
 <% if impersonator? %>
   <div class='mr-mime-impersonation-footer'>
-    You are impersonating <strong><%= current_user.email %></strong>. At any time you may
+    You are impersonating <strong><%= impersonated_email %></strong>. At any time you may
     <%= link_to 'return to your regular account', mr_mime.impersonation_path, method: :delete %>.
   </div>
 <% end %>

data/lib/generators/templates/mr_mime.rb

@@ -12,4 +12,16 @@ MrMime.configure do |config|
   # If the method returns truthy, the user will be permitted to impersonate
   # Default: nil
   # config.user_permission_check = :admin?
+
+  # Configure the URL that users will be redirected to after beginning impersonation.
+  # Accepts the following formats (with examples):
+  #
+  # -- String: A literal URL string
+  # config.after_impersonation_url = '/'
+  #
+  # -- Proc/Lambda: Must return the desired URL. The impersonated user will be passed in.
+  # config.after_impersonation_url = Proc.new { |impersonated| user_url(impersonated) }
+  #
+  # -- Symbol: The name of a URL helper method within your application
+  config.after_impersonation_url = :root_url
 end

data/lib/mr_mime/config.rb

@@ -9,6 +9,9 @@ module MrMime
     mattr_accessor :user_permission_check
     @@user_permission_check = nil
 
+    mattr_accessor :after_impersonation_url
+    @@after_impersonation_url = :root_url
+
     def self.adapters
       {
         sorcery: MrMime::Adapters::SorceryAdapter,

data/lib/mr_mime/version.rb

@@ -1 +1 @@
-VERSION = '0.0.1'
+VERSION = '0.0.3'

data/spec/controllers/mr_mime/impersonations_controller_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+require 'models/mr_mime/store'
+require 'models/mr_mime/adapters/base'
+require 'models/mr_mime/impersonation_policy'
+require 'models/mr_mime/impersonation'
+require 'models/mr_mime/url_resolver'
+require 'helpers/mr_mime/impersonation_helper'
+require 'controllers/mr_mime/impersonation_behavior'
+require 'controllers/mr_mime/application_controller'
+require 'controllers/mr_mime/impersonations_controller'
+
+module MrMime
+  class DummyUser; end
+  class DummyAdapter < Adapters::Base
+    def set_current_user(user)
+      context.session[:current_user_id] = user.id
+    end
+  end
+
+  RSpec.describe ImpersonationsController, type: :controller do
+    let(:main_app) { double(root_url: 'root_url', test_url: 'test') }
+    let(:request) { double(referer: 'test_url') }
+    let(:session) { { current_user_id: 1 } }
+    let(:controller) { described_class.new }
+    let(:users) { [double(id: 1), double(id: 2)] }
+
+    before do
+      stub_config
+      stub_controller_messages
+    end
+
+    describe '#create' do
+      context 'with a valid impersonation' do
+        before do
+          set_params impersonated_id: 2
+        end
+
+        it 'sets the current user' do
+          controller.create
+          expect(controller.current_user).to eq users.last
+        end
+
+        it 'sets the impersonator_id in the session' do
+          controller.create
+          expect(session['mr_mime.impersonator_id']).to eq 1
+        end
+
+        it 'sets the return_to url in the session' do
+          controller.create
+          expect(session['mr_mime.return_to']).to eq 'test_url'
+        end
+
+        it 'redirects to the root_url if no after_impersonation_url is set' do
+          expect(controller).to receive(:redirect_to).with('root_url', anything)
+          controller.create
+        end
+
+        it 'redirects to the correct after_impersonation_url if string' do
+          MrMime::Config.after_impersonation_url = 'string_url'
+          expect(controller).to receive(:redirect_to).with('string_url', anything)
+          controller.create
+        end
+
+        it 'redirects to the correct after_impersonation_url if symbol' do
+          MrMime::Config.after_impersonation_url = :test_url
+          expect(controller).to receive(:redirect_to).with('test', anything)
+          controller.create
+        end
+
+        it 'redirects to the correct after_impersonation_url if proc' do
+          MrMime::Config.after_impersonation_url = Proc.new { |user| "users/#{user.id}" }
+          expect(controller).to receive(:redirect_to).with('users/2', anything)
+          controller.create
+        end
+      end
+
+      context 'with an invalid impersonation' do
+        before do
+          set_params impersonated_id: nil
+        end
+
+        it 'does not change the current user' do
+          controller.create
+          expect(controller.current_user).to eq users.first
+        end
+
+        it 'does not set the impersonator_id' do
+          controller.create
+          expect(session).to_not have_key('mr_mime.impersonator_id')
+        end
+
+        it 'does not set the return_to url' do
+          controller.create
+          expect(session).to_not have_key('mr_mime.return_to')
+        end
+
+        it 'redirects back with error messages' do
+          expect(controller).to receive(:redirect_to)
+            .with(:back, {
+              flash: {
+                error: "Impersonated can't be blank"
+              }
+            })
+          controller.create
+        end
+      end
+    end
+
+    describe '#destroy' do
+      before { create_impersonation }
+
+      it 'sets the current user' do
+        controller.destroy
+        expect(controller.current_user).to eq users.first
+      end
+
+      it 'clears the impersonator_id in the session' do
+        controller.destroy
+        expect(session['mr_mime.impersonator_id']).to be_blank
+      end
+
+      it 'clears the return_to url in the session' do
+        controller.destroy
+        expect(session['mr_mime.return_to']).to be_blank
+      end
+
+      it 'redirects to the return_to url' do
+        expect(controller).to receive(:redirect_to).with('test_path', anything)
+        controller.destroy
+      end
+    end
+
+    def stub_config
+      allow(DummyUser).to receive(:find_by) { |options| find_user(options) }
+      allow(MrMime::Config).to receive_messages(
+        user_class: DummyUser,
+        adapter_class: DummyAdapter
+      )
+    end
+
+    def stub_controller_messages
+      allow(controller).to receive(:current_user) do
+        find_user(id: session[:current_user_id])
+      end
+
+      allow(controller).to receive_messages(
+        main_app: main_app,
+        request: request,
+        session: session,
+        redirect_to: nil
+      )
+    end
+
+    def create_impersonation
+      set_params
+      session.merge!(
+        current_user_id: 2,
+        'mr_mime.impersonator_id' => 1,
+        'mr_mime.return_to' => 'test_path'
+      )
+    end
+
+    def set_params(params = {})
+      allow(controller).to receive_message_chain(:params, :fetch)
+        .with(:impersonation, {})
+        .and_return(params)
+    end
+
+    def find_user(id: id)
+      users.detect{ |user| user.id == id }
+    end
+  end
+end

data/spec/models/mr_mime/url_resolver_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'models/mr_mime/url_resolver'
+
+module MrMime
+  RSpec.describe UrlResolver, type: :model do
+    let(:main_app) { double(url_method: '/method_url', foo: '/proc_url/bar') }
+    let(:model) { double(name: 'foo') }
+
+    describe '.resolve' do
+      it 'returns the correct url for a method proc' do
+        expect_url '/proc_url/bar', from: url_method_proc
+      end
+
+      it 'returns the correct url for a string proc' do
+        expect_url '/proc_url/foo', from: url_string_proc
+      end
+
+      it 'returns the correct url for a method name' do
+        expect_url '/method_url', from: :url_method
+      end
+
+      it 'returns the correct url for a url string' do
+        expect_url '/url_string', from: '/url_string'
+      end
+
+      it 'returns the default url if the given url does not resolve' do
+        expect_url '/default_url', from: double
+      end
+    end
+
+    def expect_url(url, options = {})
+      expect(
+        described_class.resolve(options[:from],
+          context: double(main_app: main_app),
+          args: model,
+          default: '/default_url'
+        )
+      ).to eq url
+    end
+
+    def url_method_proc
+      Proc.new { |model| model.name.to_sym }
+    end
+
+    def url_string_proc
+      Proc.new { |model| "/proc_url/#{model.name}" }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mr_mime
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Kyle Edson
@@ -71,6 +71,7 @@ files:
 - app/models/mr_mime/impersonation.rb
 - app/models/mr_mime/impersonation_policy.rb
 - app/models/mr_mime/store.rb
+- app/models/mr_mime/url_resolver.rb
 - app/views/mr_mime/_impersonate_button.html.erb
 - app/views/mr_mime/_impersonation_warning.html.erb
 - config/routes.rb
@@ -81,9 +82,11 @@ files:
 - lib/mr_mime/engine.rb
 - lib/mr_mime/version.rb
 - spec/controllers/mr_mime/impersonation_behavior_spec.rb
+- spec/controllers/mr_mime/impersonations_controller_spec.rb
 - spec/models/mr_mime/impersonation_policy_spec.rb
 - spec/models/mr_mime/impersonation_spec.rb
 - spec/models/mr_mime/store_spec.rb
+- spec/models/mr_mime/url_resolver_spec.rb
 - spec/spec_helper.rb
 homepage: http://www.github.com/foraker/mr_mime
 licenses:
@@ -105,13 +108,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: User impersonation for Rails applications
 test_files:
 - spec/controllers/mr_mime/impersonation_behavior_spec.rb
+- spec/controllers/mr_mime/impersonations_controller_spec.rb
 - spec/models/mr_mime/impersonation_policy_spec.rb
 - spec/models/mr_mime/impersonation_spec.rb
 - spec/models/mr_mime/store_spec.rb
+- spec/models/mr_mime/url_resolver_spec.rb
 - spec/spec_helper.rb