switch_user 0.9.3 → 0.9.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmQwZjYwMDUxNGZmNGVjMjY2ZWQ2YTE3MzUwYWUwOTA5NjA1MWEzZQ==
+  data.tar.gz: !binary |-
+    ZTBiZTg2NDBkOGE3OTM3NDQ1ODczNzIyOWUxNzYwZGQwYzFlNDRjMg==
+SHA512:
+  metadata.gz: !binary |-
+    NGRkMDQwOGIzYjA2YThiMDc2NzU2OGUzYThhY2UyMDE2NGRiYTFlNGJiYWI5
+    MTU4YTBjMTIyOTBkNDdlM2U4MzVmZTBkODEzZTI5ZDJjYzQyMmNmMzk1MGNl
+    MmY4MjU1OTQ3NWM1NWU1NGUyZDI5ZTY3YTNhYTNjMWYwODEyNGQ=
+  data.tar.gz: !binary |-
+    YThmODEyMjBmNjUzMjNiNGZmMTUzYzUxOWMzMWZlYmQ2NzU4ZjZjYzA0MTFj
+    M2EyMjcyNGRmZWI2MWUxNWY2MjNkM2NmMjg3ODE1ZTdjMWIyODEwYTQwNDUz
+    YjQ5NWViMWIyZGEyMjU3NmMzNWIwOTdlMmQxNGMxMjQyZTI2NWI=

data/.gitignore

@@ -4,3 +4,4 @@ pkg/*
 .rvmrc
 Gemfile.lock
 log/*.log
+.DS_Store

data/README.md

@@ -127,7 +127,7 @@ Sometimes you'll want to be able to switch to an unprivileged user and then back
 
 You will need to make the following modifications to your configuration:
 ```ruby
-config.switch_user = true
+config.switch_back = true
 config.controller_guard = lambda { |current_user, request, original_user|
   current_user && current_user.admin? || original_user && original_user.super_admin?
 }

data/app/helpers/switch_user_helper.rb

@@ -1,41 +1,29 @@
 module SwitchUserHelper
-  class SelectOption < Struct.new(:label, :scope_id); end
+  SelectOption = Struct.new(:label, :scope_id)
   def switch_user_select
     return unless available?
     options = []
     selected_user = nil
 
-    options << SelectOption.new("Guest", "") if SwitchUser.helper_with_guest
-    SwitchUser.available_users.each do |scope, user_proc|
-      current_user = provider.current_user(scope)
-      id_name = SwitchUser.available_users_identifiers[scope]
-      name = SwitchUser.available_users_names[scope]
-
-      user_proc.call.each do |user|
-        if user == current_user
-          selected_user = tag_value(user, id_name, scope)
-        end
-        options << SelectOption.new(tag_label(user, name), tag_value(user, id_name, scope))
-      end
-    end
-
+    users = SwitchUser::UserSet.users
+    users << SelectOption.new("Guest", "") if SwitchUser.helper_with_guest
     render :partial => "switch_user/widget",
            :locals => {
-             :options => options,
+             :options => users,
              :current_scope => selected_user
            }
   end
 
   private
 
-  def tag_value(user, id_name, scope)
+  def user_tag_value(user, id_name, scope)
     identifier = user.send(id_name)
 
     "#{scope}_#{identifier}"
   end
 
-  def tag_label(user, name)
-    user.send(name)
+  def user_tag_label(user, name)
+    name.respond_to?(:call) ? name.call(user) : user.send(name)
   end
 
   def available?

data/app/views/switch_user/_widget.html.erb

@@ -1,4 +1,4 @@
 <% if SwitchUser.switch_back %>
-  <%= check_box_tag "remember_user", "remember_user", provider.original_user.present?, :onchange => "location.href = 'switch_user/remember_user?remember=' + encodeURIComponent(this.checked)" %>
+  <%= check_box_tag "remember_user", "remember_user", provider.original_user.present?, :onchange => "location.href = '/switch_user/remember_user?remember=' + encodeURIComponent(this.checked)" %>
 <% end %>
 <%= select_tag "switch_user_identifier", options_from_collection_for_select(options, :scope_id, :label, current_scope), :onchange => "location.href = '/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)" %>

data/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/lib/switch_user.rb

@@ -3,6 +3,7 @@ if defined?(Rails)
 end
 
 module SwitchUser
+  autoload :UserSet, "switch_user/user_set"
   autoload :UserLoader, "switch_user/user_loader"
   autoload :Provider, "switch_user/provider"
   autoload :BaseGuard, "switch_user/base_guard"
@@ -35,8 +36,6 @@ module SwitchUser
     @@guard_class = klass.constantize
   end
 
-  private
-
   def self.reset_config
     self.provider = :devise
     self.available_users = { :user => lambda { User.all } }

data/lib/switch_user/provider/base.rb

@@ -30,19 +30,30 @@ module SwitchUser
       end
 
       def original_user
-        @controller.session[:original_user]
+        user_identifier = @controller.session[:original_user_scope_identifier]
+
+        if user_identifier
+          UserLoader.prepare(:scope_identifier => user_identifier).user
+        end
+      end
+
+      def original_user=(user)
+        user_type       = user.class.to_s.underscore
+        user_identifier = "#{user_type}_#{user.id}"
+
+        @controller.session[:original_user_scope_identifier] = user_identifier
       end
 
       def remember_current_user(remember)
         if remember
-          @controller.session[:original_user] = current_user
+          self.original_user = current_user
         else
-          @controller.session.delete(:original_user)
+          clear_original_user
         end
       end
 
       def clear_original_user
-        @controller.session.delete(:original_user)
+        @controller.session.delete(:original_user_scope_identifier)
       end
     end
   end

data/lib/switch_user/user_loader.rb

@@ -30,7 +30,7 @@ module SwitchUser
       if scope && SwitchUser.available_scopes.include?(scope.to_sym)
         @scope = scope
       else
-        raise InvalidScope
+        raise InvalidScope.new("#{scope} is invalid and is not listed in SwitchUser#available_users")
       end
     end
 

data/lib/switch_user/user_set.rb

@@ -0,0 +1,71 @@
+module SwitchUser
+  class UserSet
+    def self.init_from_config
+      SwitchUser.available_users.map do |scope, base_scope|
+        identifier = SwitchUser.available_users_identifiers[scope]
+        label      = SwitchUser.available_users_names[scope]
+        new(scope, identifier, label, base_scope)
+      end
+    end
+
+    def self.users
+      init_from_config.flat_map {|user_set|
+        user_set.users.map {|user| Record.build(user, user_set) }
+      }
+    end
+
+    attr_reader :scope, :user_class, :identifier, :label, :base_scope
+    def initialize(scope, identifier, label, base_scope)
+      @scope      = scope
+      @user_class = normalize_class(scope)
+      @identifier = identifier
+      @label      = label
+      @base_scope = normalize_scope(base_scope)
+    end
+
+    def find_user(id)
+      Record.build(users.where(:id => id).first, self)
+    end
+    alias :[] :find_user
+
+    def users
+      base_scope
+    end
+
+    private
+
+    def normalize_class(klass)
+      if klass.is_a?(Class)
+        klass
+      else
+        klass.to_s.classify.constantize
+      end
+    end
+
+    def normalize_scope(scope)
+      if scope.respond_to?(:call)
+        scoped = scope.call
+        if scoped.respond_to?(:scoped)
+          scoped
+        else
+          user_class.scoped
+        end
+      else
+        user_class.scoped
+      end
+    end
+    class Record < Struct.new(:id, :label, :scope)
+      def self.build(user, set)
+        id    = user.send(set.identifier)
+        label = user.send(set.label)
+        scope = set.scope
+
+        new(id, label, scope)
+      end
+
+      def scope_id
+        "#{scope}_#{id}"
+      end
+    end
+  end
+end

data/lib/switch_user/version.rb

@@ -1,3 +1,3 @@
 module SwitchUser
-  VERSION = "0.9.3"
+  VERSION = "0.9.4"
 end

data/spec/integration/switch_user_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "Using SwitchUser", :type => :request do
+  let(:user) { User.create!(:email => "foo@bar.com", :admin => true) }
+  let(:other_user) { User.create!(:email => "other@bar.com", :admin => false) }
+  before do
+    SwitchUser.reset_config
+    SwitchUser.provider = :session
+    SwitchUser.controller_guard = lambda { |current_user, request| Rails.env.test? }
+    SwitchUser.redirect_path = lambda {|_,_| "/dummys/open"}
+  end
+  it "signs a user in using switch_user" do
+    # can't access protected url
+    get "/dummy/protected"
+    response.should be_redirect
+
+    get "/switch_user?scope_identifier=user_#{other_user.id}"
+    response.should be_redirect
+
+    # now that we are logged in via switch_user we can access
+    get "/dummy/protected"
+    response.should be_success
+  end
+  context "using switch_back" do
+    before do
+      SwitchUser.switch_back = true
+      SwitchUser.controller_guard = lambda { |current_user, request, original_user|
+        current_user && current_user.admin? || original_user && original_user.admin?
+      }
+    end
+    it "can switch back to a different user" do
+      # login
+      post "/login", :id => user.id
+      follow_redirect!
+
+      # have SwitchUser remember us
+      get "/switch_user/remember_user", :remember => true
+      session["original_user_scope_identifier"].should be_present
+
+      # check that we can switch to another user
+      get "/switch_user?scope_identifier=user_#{other_user.id}"
+      session["user_id"].should == other_user.id
+
+      # logout
+      get "/logout"
+      session["user_id"].should be_nil
+
+      # check that we can still switch to another user
+      get "/switch_user?scope_identifier=user_#{user.id}"
+      session["user_id"].should == user.id
+
+      # check that we can be un-remembered
+      get "/switch_user/remember_user", :remember => false
+      session["original_user"].should be_nil
+    end
+  end
+end

data/spec/provider/session_spec.rb

@@ -9,9 +9,6 @@ end
 
 describe SwitchUser::Provider::Session do
   before do
-    user.stub(:id => 100)
-    User.stub(:find_by_id).with(100).and_return(user)
-    User.stub(:find_by_id).with(101).and_return(other_user)
     SwitchUser.session_key = :uid
   end
   let(:controller) { SessionController.new }

data/spec/spec_helper.rb

@@ -1,15 +1,15 @@
+ENV["RAILS_ENV"] = "test"
 require 'support/provider'
 require 'support/application'
 require 'rspec/rails'
 require 'switch_user'
+require 'pry'
+require 'awesome_print'
 
 RSpec.configure do |config|
   config.filter_run :focus => true
   config.run_all_when_everything_filtered = true
-end
-
-class ApplicationController < ActionController::Base
-
+  config.use_transactional_fixtures = true
 end
 
 class TestController
@@ -17,10 +17,3 @@ class TestController
     @session_hash ||= {}
   end
 end
-
-class User
-  def self.where(*)
-    []
-  end
-end
-

data/spec/support/application.rb

@@ -1,7 +1,70 @@
 require "rails"
 require "rails/all"
+require 'switch_user/rails'
 
-class MyApp < Rails::Application
-  config.active_support.deprecation = :log
+
+class ApplicationController < ActionController::Base
+  def require_user
+    current_user || redirect_to("/tests/open")
+  end
+
+  def current_user
+    User.find_by_id(session[SwitchUser.session_key])
+  end
+
+  def login
+    user = User.find(params[:id])
+    session[SwitchUser.session_key] = user.id
+
+    redirect_to("/tests/protected")
+  end
+
+  def logout
+    session[SwitchUser.session_key] = nil
+  end
+end
+
+class DummyController < ApplicationController
+  before_filter :require_user, :only => :protected
+
+  def authenticated
+    render :text => current_user.inspect
+  end
+
+  def open
+    render :text => view_context.switch_user_select
+  end
+
+  def protected
+    render :text => view_context.switch_user_select
+  end
+end
+
+module MyApp
+  class Application < Rails::Application
+    config.active_support.deprecation = :log
+    config.threadsafe!
+    config.secret_key_base = "abc123"
+    config.eager_load = true
+    config.secret_token = '153572e559247c7aedd1bca5a246874d'
+  end
+end
+Rails.application.initialize!
+Rails.application.routes.draw do
+  get 'dummy/protected', :to => "dummy#protected"
+  get 'dummy/open', :to => "dummy#open"
+  post 'login', :to => "dummy#login"
+  get 'logout', :to => "dummy#logout"
+  get 'authenticated', :to => "dummy#authenticated"
+  get :switch_user, :to => 'switch_user#set_current_user'
+  get 'switch_user/remember_user', :to => 'switch_user#remember_user'
+end
+
+connection = ActiveRecord::Base.connection
+connection.create_table :users do |t|
+  t.column :email, :string
+  t.column :admin, :boolean
+end
+
+class User < ActiveRecord::Base
 end
-MyApp.initialize!

data/spec/support/provider.rb

@@ -1,6 +1,6 @@
 shared_examples_for "a provider" do
-  let(:user) { stub(:user) }
-  let(:other_user) { stub(:other_user, :id => 101) }
+  let(:user) { User.create! }
+  let(:other_user) { User.create! }
 
   it "can log a user in" do
     provider.login(user)

data/spec/switch_user/user_loader_spec.rb

@@ -40,7 +40,9 @@ describe SwitchUser::UserLoader do
   end
 
   it "returns nil if no user is found" do
-    loader = SwitchUser::UserLoader.new("user", 2)
+    loader = SwitchUser::UserLoader.new("user", 3)
+
+    User.find_by_id(3).should be_nil
     loader.user.should == nil
   end
 

data/spec/switch_user/user_set_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'switch_user/user_set'
+
+module SwitchUser
+  describe UserSet do
+    let!(:user) { User.create(:email => "test@example.com") }
+    let(:set) { UserSet.new(:user, :id, :email, lambda { User.scoped}) }
+    after { User.delete_all }
+    it "returns an object that knows it's scope, id and label" do
+      found_user = set[user.id]
+
+      found_user.id.should == user.id
+      found_user.scope.should == :user
+      found_user.label.should == "test@example.com"
+    end
+    it "returns all available users for a scope" do
+      set.users.should == [user]
+    end
+    it "chains the where on to the provided scope" do
+      set = UserSet.new(:user, :id, :email, lambda { User.all })
+      set.find_user(user.id).label.should == user.email
+    end
+  end
+  describe UserSet::Record do
+    it "correctly configures the record using the set" do
+      user = stub(:user, :id => 100, :email => "test@example.com")
+      set = stub(:set, :identifier  => :id, :label => :email, :scope => :user)
+      record = UserSet::Record.build(user, set)
+      record.id.should == 100
+      record.label.should == "test@example.com"
+      record.scope.should == :user
+    end
+  end
+end

data/switch_user.gemspec

@@ -20,6 +20,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency "railties"
   s.add_development_dependency "rspec-rails", "~> 2.11.0"
   s.add_development_dependency "tzinfo"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "awesome_print"
+  s.add_development_dependency "pry"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switch_user
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Richard Huang
@@ -10,104 +9,148 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: activesupport
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
-  name: bundler
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: actionpack
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
-  name: railties
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
-    none: false
-  name: rspec-rails
   type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
-    none: false
 - !ruby/object:Gem::Dependency
+  name: tzinfo
+  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'
-    none: false
-  name: tzinfo
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: activerecord
+  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: awesome_print
+  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: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-    none: false
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easily switch current user to speed up development
 email:
 - flyerhzm@gmail.com
@@ -124,6 +167,7 @@ files:
 - app/controllers/switch_user_controller.rb
 - app/helpers/switch_user_helper.rb
 - app/views/switch_user/_widget.html.erb
+- config/database.yml
 - config/routes.rb
 - lib/generators/switch_user/install/USAGE
 - lib/generators/switch_user/install/install_generator.rb
@@ -142,8 +186,10 @@ files:
 - lib/switch_user/provider/sorcery.rb
 - lib/switch_user/rails.rb
 - lib/switch_user/user_loader.rb
+- lib/switch_user/user_set.rb
 - lib/switch_user/version.rb
 - spec/controllers/switch_user_controller_spec.rb
+- spec/integration/switch_user_spec.rb
 - spec/provider/authlogic_spec.rb
 - spec/provider/clearance_spec.rb
 - spec/provider/devise_spec.rb
@@ -157,10 +203,12 @@ files:
 - spec/support/provider.rb
 - spec/switch_user/lambda_guard_spec.rb
 - spec/switch_user/user_loader_spec.rb
+- spec/switch_user/user_set_spec.rb
 - spec/switch_user_spec.rb
 - switch_user.gemspec
 homepage: http://rubygems.org/gems/switch_user
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -170,17 +218,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-  none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
-  none: false
 requirements: []
 rubyforge_project: switch_user
-rubygems_version: 1.8.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Easily switch current user to speed up development
 test_files: []