switch_user 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3ef6fc5819f6c63ec874bf35bb37b5cbce4a6e
-  data.tar.gz: 1f255e26cf44ea5bac98b8c7347f09f358dc26c5
+  metadata.gz: 0b175adec75aec167e65b5c1269743f536dbdeb7
+  data.tar.gz: 208fbd14a66917e00d9f9bcac28776bff5b92684
 SHA512:
-  metadata.gz: de790c75e56f9e83a3708536761898f41f8ca372629c12307dd5ccd736a4da76421c137ab51bf9aedf95ff06cfe5c19cebb05e8cc2760cea4aee00f785a42588
-  data.tar.gz: 9eec782dd0b50396b83f716030c20f00fbd15c891118758000d2fc4394dcf829e111d0920d9bf2f9cb3d2b8b2086509ee039bb3022f3a632df7c8f7611a05913
+  metadata.gz: 2c40a13d365afe03d78be753805be4b30f54a9a30813a11771b68f05046c0a808fe2cf36f87dbf58deb9e483b73bd4d0709f203c2ea7542656232fb36f46c5b6
+  data.tar.gz: 132785e64d55ba85b06b80a3677177268ae4f0773d27c84a119f31eb76cb8faae1bd13b88af4faa81e559d94084d3ec26519d5526213a39b5f22e626e8effe56

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 2.2
+  - 2.3.0
 env:
   - DB=sqlite
+before_install:
+  - gem update bundler
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Next Release
 
+## 1.3.0 (07/23/2016)
+
+* Add capybara support
+* Add class and style options to `switch_user_select`
+
 ## 1.2.1 (12/22/2015)
 
 * Fix `grouped_options_for_select` for rails 3.2

data/README.md

@@ -36,6 +36,12 @@ or haml
 
     = switch_user_select
 
+If you want to add a class or styles
+
+    <%= switch_user_select class: 'special-select', styles: 'width: 220px' %>
+
+    = switch_user_select class: 'special-select', styles: 'width: 220px'
+
 If there are too many users (on production), the switch_user_select is not a good choice, you should call the switch user request by yourself.
 
     <%= link_to user.login, "/switch_user?scope_identifier=user_#{user.id}" %>
@@ -47,7 +53,8 @@ If there are too many users (on production), the switch_user_select is not a goo
 If you have a wildcard route in your project, add a route before the wildcard route.
 ```ruby
 # config/routes.rb
-get 'switch_user' => 'switch_user#set_current_user'
+get 'switch_user', to: 'switch_user#set_current_user'
+get 'switch_user/remember_user', to: 'switch_user#remember_user'
 # wildcard route that will get
 get ':id' => 'pages#show'
 ```
@@ -137,6 +144,32 @@ config.controller_guard = lambda { |current_user, request, original_user|
 ```
 This example would allow an admin user to user switch_user, but would only let you switch back to another user if the original user was a super admin.
 
+## Using SwitchUser with RSpec and Capybara
+
+Add the following code to spec/support/switch_user.rb or spec/spec_helper.rb :
+
+```ruby
+require 'switch_user/rspec'
+```
+
+You can now write your specs like so :
+
+```ruby
+feature "Your feature", type: :feature do
+  background do
+    @user = User.make(:email => 'user@example.com', :password => 'password')
+  end
+
+  scenario "Your scenario" do
+    switch_user @user
+    # or
+    # switch_user :user, @user.id
+
+    visit '/'
+  end
+end
+```
+
 ### How it works
 
 Click the checkbox next to switch_user_select menu to remember that user for this session. Once this

data/app/controllers/switch_user_controller.rb

@@ -1,5 +1,5 @@
 class SwitchUserController < ApplicationController
-  before_filter :developer_modes_only
+  before_action :developer_modes_only
 
   def set_current_user
     handle_request(params)

data/app/helpers/switch_user_helper.rb

@@ -1,6 +1,6 @@
 module SwitchUserHelper
   SelectOption = Struct.new(:label, :scope_id)
-  def switch_user_select
+  def switch_user_select(options = {})
     return unless available?
 
     if provider.current_user
@@ -21,7 +21,9 @@ module SwitchUserHelper
 
     render :partial => "switch_user/widget",
            :locals => {
-             :option_tags => option_tags
+             :option_tags => option_tags,
+             :classes => options[:class],
+             :styles => options[:style],
            }
   end
 

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)" %>
 <% end %>
-<%= select_tag "switch_user_identifier", option_tags, :onchange => "location.href = '/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)" %>
+<%= select_tag "switch_user_identifier", option_tags, :onchange => "location.href = '/switch_user?scope_identifier=' + encodeURIComponent(this.options[this.selectedIndex].value)", :class => classes, :style => styles %>

data/lib/switch_user/rspec/feature_helpers.rb

@@ -0,0 +1,44 @@
+module SwitchUser
+  module RSpecFeatureHelpers
+
+    class InvalidArgument < StandardError; end
+
+    def switch_user(user_record_or_scope, user_id=nil)
+      _user_scope =
+        case user_record_or_scope
+        when ActiveRecord::Base
+          user_record_or_scope.model_name.singular
+        else
+          user_record_or_scope
+        end
+
+      _user_scope = _user_scope.to_s
+
+      unless (SwitchUser.available_scopes.include?(_user_scope) or SwitchUser.available_scopes.include?(_user_scope.to_sym))
+        raise SwitchUser::InvalidScope.new("don't allow this user sign in, please check config.available_users")
+      end
+
+      _user_id =
+        case user_record_or_scope
+        when ActiveRecord::Base
+          identifier = SwitchUser.available_users_identifiers[_user_scope] || SwitchUser.available_users_identifiers[_user_scope.to_sym]
+          if identifier.nil?
+            raise SwitchUser::InvalidScope.new("don't allow switch this user, please check config.available_users_identifiers")
+          end
+          user_record_or_scope.send identifier
+        else
+          user_id
+        end
+
+      if _user_id.to_s.empty?
+        raise InvalidArgument.new("don't allow switch this user, user_id is empty")
+      end
+
+      scope_identifier = "#{_user_scope}_#{_user_id}"
+
+      visit "/switch_user?scope_identifier=#{scope_identifier}"
+    end
+
+  end
+
+end

data/lib/switch_user/rspec.rb

@@ -0,0 +1,13 @@
+require 'switch_user/rspec/feature_helpers'
+
+require 'rspec/core'
+
+RSpec.configure do |config|
+
+  config.include SwitchUser::RSpecFeatureHelpers, :type => :feature
+
+  config.before(:each, :type => :feature) do
+    allow_any_instance_of(SwitchUserController).to receive(:available?).and_return(true)
+  end
+
+end

data/lib/switch_user/version.rb

@@ -1,3 +1,3 @@
 module SwitchUser
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/integration/switch_user_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe "Using SwitchUser", :type => :request do
     SwitchUser.reset_config
     SwitchUser.provider = :session
     SwitchUser.controller_guard = lambda { |current_user, request| Rails.env.test? }
-    SwitchUser.redirect_path = lambda {|_,_| "/dummys/open"}
+    SwitchUser.redirect_path = lambda {|_,_| "/dummy/open"}
   end
 
   it "signs a user in using switch_user" do

data/spec/rspec/feature_helpers_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+require 'capybara/rspec'
+require 'capybara/rails'
+Capybara.app = MyApp::Application
+
+require 'switch_user/rspec'
+
+RSpec.feature "SwitchUser::RSpecFeatureHelpers", :type => :feature do
+  background do
+    @user = User.create!(:email => "foo@bar.com", :admin => true)
+    @client = Client.create!(:email => "foo@bar.com")
+  end
+
+  before(:each) do
+    allow(SwitchUser).to receive(:controller_guard).and_return(lambda{|current_user, request| true})
+
+    allow(SwitchUser).to receive(:available_users).and_return({:user => lambda { User.all }})
+
+    allow(SwitchUser).to receive(:available_users_identifiers).and_return({:user => :id})
+
+    allow(SwitchUser).to receive(:available_users_names).and_return({:user => :email})
+  end
+
+  scenario "when controller_guard return false" do
+    allow(SwitchUser).to receive(:controller_guard).and_return(lambda{|current_user, request| false})
+
+    expect do
+      switch_user @user
+    end.to_not raise_error ActionController::RoutingError, /Do not try to hack us/
+  end
+
+  scenario "when controller_guard return false and controller call original available?" do
+    allow(SwitchUser).to receive(:controller_guard).and_return(lambda{|current_user, request| false})
+
+    allow_any_instance_of(SwitchUserController).to receive(:available?).and_call_original
+
+    expect do
+      switch_user @user
+    end.to raise_error ActionController::RoutingError, /Do not try to hack us/
+  end
+
+  scenario "arg is @user, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user @user
+    end.to_not raise_error
+  end
+
+  scenario "arg is @user, available_users is default, and available_users_identifiers is {user: id}" do
+    allow(SwitchUser).to receive(:available_users_identifiers).and_return({user: :id})
+
+    expect do
+      switch_user @user
+    end.to_not raise_error
+  end
+
+  scenario "arg is @user, available_users is default, and available_users_identifiers is {:client => :id}" do
+    allow(SwitchUser).to receive(:available_users_identifiers).and_return({:client => :id})
+    allow(SwitchUser).to receive(:available_users_names).and_return({:client => :email})
+
+    expect do
+      switch_user @user
+    end.to raise_error SwitchUser::InvalidScope, /config.available_users_identifiers/
+  end
+
+  scenario "arg is @client, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user @client
+    end.to raise_error SwitchUser::InvalidScope, /config.available_users/
+  end
+
+  scenario "arg is @client, available_users is {:user => lambda { User.all }, :client => lambda {Client.all}}, and available_users_identifiers is default" do
+    allow(SwitchUser).to receive(:available_users).and_return({:user => lambda { User.all }, :client => lambda {Client.all}})
+
+    expect do
+      switch_user @client
+    end.to raise_error SwitchUser::InvalidScope, /config.available_users_identifiers/
+  end
+
+  scenario "arg is @client, available_users is {:user => lambda { User.all }, :client => lambda {Client.all}}, and available_users_identifiers is {:user => id, :client => id}" do
+    allow(SwitchUser).to receive(:available_users).and_return({:user => lambda { User.all }, :client => lambda {Client.all}})
+
+    allow(SwitchUser).to receive(:available_users_identifiers).and_return({:user => :id, :client => :id})
+    allow(SwitchUser).to receive(:available_users_names).and_return({:user => :email, :client => :email})
+
+    expect do
+      switch_user @client
+    end.to_not raise_error
+  end
+
+  scenario "args is :user and @user.id, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :user, @user.id
+    end.to_not raise_error
+  end
+
+  scenario "arg is :client and @client.id, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :client, @client.id
+    end.to raise_error SwitchUser::InvalidScope, /config.available_users/
+  end
+
+  scenario "args is :user, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :user
+    end.to raise_error SwitchUser::RSpecFeatureHelpers::InvalidArgument, /user_id is empty/
+  end
+
+  scenario "args is :user and nil, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :user, nil
+    end.to raise_error SwitchUser::RSpecFeatureHelpers::InvalidArgument, /user_id is empty/
+  end
+
+  scenario "args is :user and '', available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :user, ''
+    end.to raise_error SwitchUser::RSpecFeatureHelpers::InvalidArgument, /user_id is empty/
+  end
+
+  scenario "args is :user and 0, available_users is default, and available_users_identifiers is default" do
+    expect do
+      switch_user :user, 0
+    end.to_not raise_error
+  end
+
+end

data/spec/support/application.rb

@@ -5,7 +5,7 @@ require 'switch_user/rails'
 
 class ApplicationController < ActionController::Base
   def require_user
-    current_user || redirect_to("/tests/open")
+    current_user || redirect_to("/dummy/open")
   end
 
   def current_user
@@ -16,11 +16,13 @@ class ApplicationController < ActionController::Base
     user = User.find(params[:id])
     session[SwitchUser.session_key] = user.id
 
-    redirect_to("/tests/protected")
+    redirect_to("/dummy/protected")
   end
 
   def logout
     session[SwitchUser.session_key] = nil
+
+    redirect_to("/dummy/open")
   end
 end
 
@@ -46,6 +48,9 @@ module MyApp
     config.secret_key_base = "abc123"
     config.eager_load = true
     config.secret_token = '153572e559247c7aedd1bca5a246874d'
+
+    # should set it
+    config.action_dispatch.show_exceptions = false
   end
 end
 Rails.application.initialize!
@@ -67,3 +72,10 @@ end
 
 class User < ActiveRecord::Base
 end
+
+connection.create_table :clients do |t|
+  t.column :email, :string
+end
+
+class Client < ActiveRecord::Base
+end

data/switch_user.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "activerecord"
   s.add_development_dependency "awesome_print"
   s.add_development_dependency "pry"
+  s.add_development_dependency "capybara"
 
   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: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Richard Huang
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
 description: Easily switch current user to speed up development
 email:
 - flyerhzm@gmail.com
@@ -202,6 +216,8 @@ files:
 - lib/switch_user/provider/session.rb
 - lib/switch_user/provider/sorcery.rb
 - lib/switch_user/rails.rb
+- lib/switch_user/rspec.rb
+- lib/switch_user/rspec/feature_helpers.rb
 - lib/switch_user/user_loader.rb
 - lib/switch_user/user_set.rb
 - lib/switch_user/version.rb
@@ -216,6 +232,7 @@ files:
 - spec/provider/session_spec.rb
 - spec/provider/sorcery_spec.rb
 - spec/provider_spec.rb
+- spec/rspec/feature_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/support/application.rb
 - spec/support/provider.rb
@@ -244,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: switch_user
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Easily switch current user to speed up development