pretender 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e5acb138e7418d36f5db31434a5804ccd72230
-  data.tar.gz: 9d87f62ab46dd07471752f82d0a323f585c6ffda
+  metadata.gz: 36cb9bc71fad9818f10c20ffe60bfc902cad923f
+  data.tar.gz: 228d7b9633467284d37e210369492f28069c97df
 SHA512:
-  metadata.gz: f1f77c7fb923d3ae2f896ac1d366ef3dcb8d0dc568aaa09ce1fd6dd5fa31ad3cde50f5e9df2712a2b7179483b316d5183b3ff0c32bd1876408a29da5409b82b1
-  data.tar.gz: 1cbd2fe07379ed8f205d6d71e2ccd38fddd90b0766e8a266cccca25660f030652e2cd8ea1cfd5b1f2915e9032ec6e9e6d208b5a08d9f79764dddb6bb296a57ab
+  metadata.gz: ad6b5a8dd18a8821a7ebb4798043e91caea257c403297d3d6df7ee1757c174567bc8d24a2c3650987c22beb90185172ebd4dec41476c9d87c7924870377ebae8
+  data.tar.gz: 0d4940d8440b364b9211d26f75e75e9b62d97229d0fc2e8fd2e4006639733d9481d6f832ae520ac2376b9e7bca327d5906287a1f973a42a0b616ddd9f0ac3631

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.3.0
+
+- Fixed compatibility with Clearance
+- Added support for Rails API
+- Added support for custom primary key
+
 ## 0.2.1
 
 - Better error message

data/README.md

@@ -8,7 +8,7 @@ As an admin, there are times you want to see exactly what another user sees.  Me
 
 :boom: [Rock on](http://www.youtube.com/watch?v=SBjQ9tuuTJQ)
 
-Pretender is flexible and lightweight - less than 40 lines of code :-)
+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.
 
@@ -54,10 +54,16 @@ stop_impersonating_user
 
 ### Sample Implementation
 
+Create a controller
+
 ```ruby
-class Admin::UsersController < ApplicationController
+class UsersController < ApplicationController
   before_filter :require_admin!
 
+  def index
+    @users = User.order(:id)
+  end
+
   def impersonate
     user = User.find(params[:id])
     impersonate_user(user)
@@ -71,12 +77,31 @@ class Admin::UsersController < ApplicationController
 end
 ```
 
-Show when someone is signed in as another user in your application layout.
+Add routes
+
+```ruby
+resources :users, only: [:index] do
+  post :impersonate, on: :member
+  post :stop_impersonating, on: :collection
+end
+```
+
+Create an index view
+
+```erb
+<ul>
+  <% @users.each do |user| %>
+    <li>Sign in as <%= link_to user.name, impersonate_user_path(user), method: :post %></li>
+  <% end %>
+</ul>
+```
+
+And show when someone is signed in as another user in your application layout
 
 ```erb
 <% if current_user != true_user %>
   You (<%= true_user.name %>) are signed in as <%= current_user.name %>
-  <%= link_to "Back to admin", stop_impersonating_path %>
+  <%= link_to "Back to admin", stop_impersonating_users_path, method: :post %>
 <% end %>
 ```
 

data/lib/pretender.rb

@@ -6,21 +6,27 @@ module Pretender
 
   def impersonates(scope = :user, opts = {})
     impersonated_method = opts[:method] || :"current_#{scope}"
-    impersonate_with = opts[:with] || proc { |id| scope.to_s.classify.constantize.where(:id => id).first }
+    impersonate_with = opts[:with] || proc { |id|
+      klass = scope.to_s.classify.constantize
+      primary_key = klass.respond_to?(:primary_key) ? klass.primary_key : :id
+      klass.find_by(primary_key => id)
+    }
     true_method = :"true_#{scope}"
     session_key = :"impersonated_#{scope}_id"
     impersonated_var = :"@impersonated_#{scope}"
 
     # define methods
-    if method_defined?(impersonated_method)
+    if method_defined?(impersonated_method) || private_method_defined?(impersonated_method)
       alias_method true_method, impersonated_method
     else
       define_method true_method do
-        raise Pretender::Error, "#{impersonated_method} must be defined before the impersonates method" unless ActionController::Base.method_defined?(impersonated_method)
-        ActionController::Base.instance_method(impersonated_method).bind(self).call
+        # TODO handle private methods
+        superclass = self.class.superclass
+        raise Pretender::Error, "#{impersonated_method} must be defined before the impersonates method" unless superclass.method_defined?(impersonated_method)
+        superclass.instance_method(impersonated_method).bind(self).call
       end
     end
-    helper_method true_method
+    helper_method(true_method) if respond_to?(:helper_method)
 
     define_method impersonated_method do
       unless instance_variable_get(impersonated_var)
@@ -48,5 +54,5 @@ module Pretender
 end
 
 ActiveSupport.on_load(:action_controller) do
-  ActionController::Base.send(:extend, Pretender)
+  extend Pretender
 end

data/lib/pretender/version.rb

@@ -1,3 +1,3 @@
 module Pretender
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretender
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2017-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Easy to switch back and forth between roles, minimal code changes, and plays