switch_user 0.9.0 → 0.9.1

data/.gitignore

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

data/README.md

@@ -12,7 +12,9 @@ switch_user is very useful in such use cases
 
 ## Example
 
-Visit here: [http://switch-user-example.heroku.com/][1], switch the current user in the select box.
+Visit here: <http://switch-user-example.heroku.com>, switch the current user in the select box.
+
+And source code here: <https://github.com/flyerhzm/switch_user_example>
 
 ## Install
 
@@ -57,7 +59,7 @@ If you have a wildcard route in your Rails 3 project, add a route before the wil
 By default, you can switch between Guest and all users in users table, you don't need to do anything. The following is the default configuration.
 
     SwitchUser.setup do |config|
-      # provider may be :devise, :authlogic, :restful_authentication or :sorcery
+      # provider may be :devise, :authlogic, :clearance, :restful_authentication or :sorcery
       config.provider = :devise
 
       # available_users is a hash,
@@ -126,5 +128,3 @@ If you want to redirect user to "/dashboard" page
 Copyright © 2010 - 2012 Richard Huang (flyerhzm@gmail.com), released under the MIT license
 
 [0]: https://github.com/tablatom/hobo
-[1]: http://switch-user-example.heroku.com/
-

data/app/controllers/switch_user_controller.rb

@@ -19,18 +19,15 @@ class SwitchUserController < ApplicationController
   end
 
   def available?
-    SwitchUser.controller_guard.call(provider.current_user, request)
+    SwitchUser.controller_guard(provider.current_user, request)
   end
 
   def handle_request(params)
     if params[:scope_identifier].blank?
       provider.logout_all
     else
-      params[:scope_identifier] =~ /^([^_]+)_(.*)$/
-      scope, identifier = $1, $2
-
-      user = SwitchUser::UserLoader.new(scope, identifier).load
-      provider.login_exclusive(user, :scope => scope)
+      loader = SwitchUser::UserLoader.prepare(params)
+      provider.login_exclusive(loader.user, :scope => loader.scope)
     end
   end
 

data/app/helpers/switch_user_helper.rb

@@ -39,7 +39,7 @@ module SwitchUserHelper
 
   def available?
     user = provider.current_users_without_scope.first
-    SwitchUser.view_guard.call(user, request)
+    SwitchUser.view_guard(user, request)
   end
 
   def provider

data/lib/switch_user.rb

@@ -11,9 +11,10 @@ module SwitchUser
   mattr_accessor :available_users
   mattr_accessor :available_users_identifiers
   mattr_accessor :available_users_names
-  mattr_accessor :controller_guard
-  mattr_accessor :view_guard
+  mattr_writer :controller_guard
+  mattr_writer :view_guard
   mattr_accessor :redirect_path
+  mattr_accessor :session_key
 
   def self.setup
     yield self
@@ -27,6 +28,14 @@ module SwitchUser
     available_users.keys
   end
 
+  def self.controller_guard(*args)
+    call_guard(@@controller_guard, args)
+  end
+
+  def self.view_guard(*args)
+    call_guard(@@view_guard, args)
+  end
+
   private
 
   def self.reset_config
@@ -37,6 +46,12 @@ module SwitchUser
     self.controller_guard = lambda { |current_user, request| Rails.env.development? }
     self.view_guard = lambda { |current_user, request| Rails.env.development? }
     self.redirect_path = lambda { |request, params| request.env["HTTP_REFERER"] ? :back : root_path }
+    self.session_key = :user_id
+  end
+
+  def self.call_guard(guard, args)
+    arity = guard.arity
+    guard.call(*args[0...arity])
   end
 
   reset_config

data/lib/switch_user/provider.rb

@@ -1,8 +1,11 @@
 module SwitchUser
   module Provider
     autoload :Authlogic, "switch_user/provider/authlogic"
+    autoload :Clearance, "switch_user/provider/clearance"
     autoload :Devise, "switch_user/provider/devise"
     autoload :RestfulAuthentication, "switch_user/provider/restful_authentication"
     autoload :Sorcery, "switch_user/provider/sorcery"
+    autoload :Dummy, "switch_user/provider/dummy"
+    autoload :Session, "switch_user/provider/session"
   end
 end

data/lib/switch_user/provider/clearance.rb

@@ -0,0 +1,23 @@
+require 'switch_user/provider/base'
+
+module SwitchUser
+  module Provider
+    class Clearance < Base
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def login(user, scope = nil)
+        @controller.sign_in(user)
+      end
+
+      def logout(scope = nil)
+        @controller.sign_out
+      end
+
+      def current_user(scope = nil)
+        @controller.current_user
+      end
+    end
+  end
+end

data/lib/switch_user/provider/dummy.rb

@@ -0,0 +1,23 @@
+require 'switch_user/provider/base'
+
+module SwitchUser
+  module Provider
+    class Dummy < Base
+      def initialize(controller)
+        @user = nil
+      end
+
+      def login(user, scope = nil)
+        @user = user
+      end
+
+      def logout(scope = nil)
+        @user = nil
+      end
+
+      def current_user(scope = nil)
+        @user
+      end
+    end
+  end
+end

data/lib/switch_user/provider/session.rb

@@ -0,0 +1,29 @@
+require 'switch_user/provider/base'
+
+module SwitchUser
+  module Provider
+    class Session < Base
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def login(user, scope = nil)
+        @controller.session[session_key] = user.id
+      end
+
+      def logout(scope = nil)
+        @controller.session.delete(session_key)
+      end
+
+      def current_user(scope = nil)
+        @controller.current_user
+      end
+
+      private
+
+      def session_key
+        SwitchUser.session_key
+      end
+    end
+  end
+end

data/lib/switch_user/rails.rb

@@ -1,8 +1,10 @@
 if defined?(Rails)
   if defined? Rails::Engine
-    class Engine < Rails::Engine
-      config.to_prepare do
-        ActionView::Base.send :include, SwitchUserHelper
+    module SwitchUser
+      class Engine < Rails::Engine
+        config.to_prepare do
+          ActionView::Base.send :include, SwitchUserHelper
+        end
       end
     end
   else

data/lib/switch_user/user_loader.rb

@@ -3,19 +3,31 @@ module SwitchUser
     attr_reader :scope
     attr_accessor :id
 
+    def self.prepare(*args)
+      options = args.extract_options!
+
+      if options[:scope_identifier]
+        options[:scope_identifier] =~ /^(.*)_([^_]+)$/
+        scope, id = $1, $2
+      else
+        scope, id = args
+      end
+      new(scope, id)
+    end
+
     def initialize(scope, id)
       self.scope = scope
       self.id = id
     end
 
-    def load
-      user_class.send(finder, id)
+    def user
+      user_class.where(column_name => id).first
     end
 
     private
 
     def scope=(scope)
-      if SwitchUser.available_scopes.include?(scope.to_sym)
+      if scope && SwitchUser.available_scopes.include?(scope.to_sym)
         @scope = scope
       else
         raise InvalidScope
@@ -26,10 +38,8 @@ module SwitchUser
       scope.classify.constantize
     end
 
-    def finder
-      column_name = SwitchUser.available_users_identifiers[scope.to_sym]
-
-      "find_by_#{column_name}"
+    def column_name
+      SwitchUser.available_users_identifiers[scope.to_sym]
     end
   end
 end

data/lib/switch_user/version.rb

@@ -1,3 +1,3 @@
 module SwitchUser
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/spec/controllers/switch_user_controller_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'switch_user'
+require 'switch_user_controller'
+
+describe SwitchUserController, :type => :controller do
+  before do
+    SwitchUser.provider = :dummy
+  end
+
+  it "redirects the user to the specified location" do
+    SwitchUser.redirect_path = lambda {|_,_| "/path"}
+    controller.stub(:available? => true)
+    get :set_current_user, :scope_identifier => "user_1"
+
+    response.should redirect_to("/path")
+  end
+
+  it "denies access according to the guard block" do
+    SwitchUser.controller_guard = lambda {|_,_| false }
+    get :set_current_user
+
+    response.should be_forbidden
+  end
+end

data/spec/provider/clearance_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'switch_user/provider/clearance'
+
+class ClearanceController
+  def sign_in(user)
+    @user = user
+  end
+  
+  def sign_out
+    @user = nil
+  end
+  
+  def current_user
+    @user
+  end
+end
+
+describe SwitchUser::Provider::Clearance do
+  let(:controller) { ClearanceController.new }
+  let(:provider) { SwitchUser::Provider::Clearance.new(controller) }
+
+  it_behaves_like "a provider"
+end

data/spec/provider/session_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'switch_user/provider/session'
+
+class SessionController
+  def session
+    @session_hash ||= {}
+  end
+
+  def current_user
+    User.find_by_id(session[:uid]) if session[:uid]
+  end
+end
+
+describe SwitchUser::Provider::Session do
+  before do
+    user.stub(:id => 100)
+    User.stub(:find_by_id).with(100).and_return(user)
+    SwitchUser.session_key = :uid
+  end
+  let(:controller) { SessionController.new }
+  let(:provider) { SwitchUser::Provider::Session.new(controller) }
+
+  it_behaves_like "a provider"
+end

data/spec/spec_helper.rb

@@ -1 +1,12 @@
 require 'support/provider'
+require 'support/application'
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+end
+
+class ApplicationController < ActionController::Base
+
+end

data/spec/support/application.rb

@@ -0,0 +1,7 @@
+require "rails"
+require "rails/all"
+
+class MyApp < Rails::Application
+  config.active_support.deprecation = :log
+end
+MyApp.initialize!

data/spec/switch_user/user_loader_spec.rb

@@ -2,35 +2,59 @@ require 'spec_helper'
 require 'switch_user/user_loader'
 
 class User
-  def self.find_by_id(id)
+  def self.where(*)
+    []
   end
 end
 
 describe SwitchUser::UserLoader do
   let(:user) { stub(:user) }
+  let(:user_result) { [user] }
 
   it "raises an exception if we are passed an invalid scope" do
     expect { SwitchUser::UserLoader.new("useeer", 1) }.to raise_error(SwitchUser::InvalidScope)
   end
 
-  it "loads a user" do
-    User.stub(:find_by_id).with(1).and_return(user)
+  describe ".user" do
+    before do
+      SwitchUser.available_users_identifiers = {:user => :id}
+      User.stub(:where).with(:id => "1").and_return(user_result)
+    end
+    it "can be loaded from a scope and identifier" do
+      loaded_user = SwitchUser::UserLoader.prepare("user","1").user
+
+      loaded_user.should == user
+    end
+    it "can be loaded by a passing an unprocessed scope identifier" do
+      loaded_user = SwitchUser::UserLoader.prepare(:scope_identifier => "user_1").user
+
+      loaded_user.should == user
+    end
+    it "raises an error for an invalid scope" do
+      expect {
+        loaded_user = SwitchUser::UserLoader.prepare(nil, "1")
+      }.to raise_error(SwitchUser::InvalidScope)
+    end
+  end
+
+  it "returns a user" do
+    User.stub(:where).with(:id => 1).and_return(user_result)
 
     loader = SwitchUser::UserLoader.new("user", 1)
 
-    loader.load.should == user
+    loader.user.should == user
   end
 
   it "returns nil if no user is found" do
     loader = SwitchUser::UserLoader.new("user", 2)
-    loader.load.should == nil
+    loader.user.should == nil
   end
 
   it "loads a user with an alternate identifier column" do
-    User.stub(:find_by_email).with(2).and_return(user)
+    User.stub(:where).with(:email => 2).and_return(user_result)
     SwitchUser.available_users_identifiers = {:user => :email}
 
     loader = SwitchUser::UserLoader.new("user", 2)
-    loader.load.should == user
+    loader.user.should == user
   end
 end

data/spec/switch_user_spec.rb

@@ -2,10 +2,6 @@ require 'spec_helper'
 require 'switch_user'
 
 describe SwitchUser do
-  it "has a default provider" do
-    SwitchUser.provider.should == :devise
-  end
-
   describe "#available_scopes" do
     it "returns a list of available scopes" do
       SwitchUser.available_scopes.should == [:user]
@@ -23,4 +19,21 @@ describe SwitchUser do
       SwitchUser.provider_class.should == SwitchUser::Provider::Devise
     end
   end
+
+  describe "guards" do
+    it "can have a 1 argument lambda" do
+      a = 0
+      SwitchUser.controller_guard = lambda {|p1| a = p1 }
+      SwitchUser.controller_guard(1,2,3)
+
+      a.should == 1
+    end
+    it "can have a 3 argument lambda" do
+      a = 0
+      SwitchUser.view_guard = lambda {|p1,p2,p3| a = p3 }
+      SwitchUser.view_guard(1,2,3)
+
+      a.should == 3
+    end
+  end
 end

data/switch_user.gemspec

@@ -14,9 +14,12 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "switch_user"
 
-  s.add_dependency "activesupport"
+  s.add_development_dependency "activesupport"
   s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rspec", "~> 2.11.0"
+  s.add_development_dependency "actionpack"
+  s.add_development_dependency "railties"
+  s.add_development_dependency "rspec-rails", "~> 2.11.0"
+  s.add_development_dependency "tzinfo"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: switch_user
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -20,7 +20,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -45,7 +45,39 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,6 +92,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easily switch current user to speed up development
 email:
 - flyerhzm@gmail.com
@@ -80,18 +128,25 @@ files:
 - lib/switch_user/provider.rb
 - lib/switch_user/provider/authlogic.rb
 - lib/switch_user/provider/base.rb
+- lib/switch_user/provider/clearance.rb
 - lib/switch_user/provider/devise.rb
+- lib/switch_user/provider/dummy.rb
 - lib/switch_user/provider/restful_authentication.rb
+- lib/switch_user/provider/session.rb
 - lib/switch_user/provider/sorcery.rb
 - lib/switch_user/rails.rb
 - lib/switch_user/user_loader.rb
 - lib/switch_user/version.rb
 - rails/init.rb
+- spec/controllers/switch_user_controller_spec.rb
 - spec/provider/authlogic_spec.rb
+- spec/provider/clearance_spec.rb
 - spec/provider/devise_spec.rb
-- spec/provider/restful_authrentication_spec.rb
+- spec/provider/restful_authentication_spec.rb
+- spec/provider/session_spec.rb
 - spec/provider/sorcery_spec.rb
 - spec/spec_helper.rb
+- spec/support/application.rb
 - spec/support/provider.rb
 - spec/switch_user/user_loader_spec.rb
 - spec/switch_user_spec.rb