mirror of
https://github.com/heartcombo/devise.git
synced 2022-11-09 12:18:31 -05:00
100 lines
3.3 KiB
Ruby
100 lines
3.3 KiB
Ruby
module Devise
|
|
# Devise::TestHelpers provides a facility to test controllers in isolation
|
|
# when using ActionController::TestCase allowing you to quickly sign_in or
|
|
# sign_out a user. Do not use Devise::TestHelpers in integration tests.
|
|
#
|
|
# Notice you should not test Warden specific behavior (like Warden callbacks)
|
|
# using Devise::TestHelpers since it is a stub of the actual behavior. Such
|
|
# callbacks should be tested in your integration suite instead.
|
|
module TestHelpers
|
|
def self.included(base)
|
|
base.class_eval do
|
|
setup :setup_controller_for_warden, :warden if respond_to?(:setup)
|
|
end
|
|
end
|
|
|
|
# This is a Warden::Proxy customized for functional tests. It's meant to
|
|
# some of Warden::Manager responsibilities, as retrieving configuration
|
|
# options and calling the FailureApp.
|
|
class TestWarden < Warden::Proxy #:nodoc:
|
|
attr_reader :controller
|
|
|
|
def initialize(controller)
|
|
@controller = controller
|
|
manager = Warden::Manager.new(nil) do |config|
|
|
config.merge! Devise.warden_config
|
|
end
|
|
super(controller.request.env, manager)
|
|
end
|
|
|
|
def authenticate!(*args)
|
|
catch_with_redirect { super }
|
|
end
|
|
|
|
def user(*args)
|
|
catch_with_redirect { super }
|
|
end
|
|
|
|
def catch_with_redirect(&block)
|
|
result = catch(:warden, &block)
|
|
|
|
if result.is_a?(Hash) && !custom_failure? && !@controller.send(:performed?)
|
|
result[:action] ||= :unauthenticated
|
|
|
|
env = @controller.request.env
|
|
env["PATH_INFO"] = "/#{result[:action]}"
|
|
env["warden.options"] = result
|
|
Warden::Manager._run_callbacks(:before_failure, env, result)
|
|
|
|
status, headers, body = Devise.warden_config[:failure_app].call(env).to_a
|
|
@controller.send :render, :status => status, :text => body,
|
|
:content_type => headers["Content-Type"], :location => headers["Location"]
|
|
|
|
nil
|
|
else
|
|
result
|
|
end
|
|
end
|
|
end
|
|
|
|
# We need to setup the environment variables and the response in the controller.
|
|
def setup_controller_for_warden #:nodoc:
|
|
@request.env['action_controller.instance'] = @controller
|
|
end
|
|
|
|
# Quick access to Warden::Proxy.
|
|
def warden #:nodoc:
|
|
@warden ||= (@request.env['warden'] = TestWarden.new(@controller))
|
|
end
|
|
|
|
# sign_in a given resource by storing its keys in the session.
|
|
# This method bypass any warden authentication callback.
|
|
#
|
|
# Examples:
|
|
#
|
|
# sign_in :user, @user # sign_in(scope, resource)
|
|
# sign_in @user # sign_in(resource)
|
|
#
|
|
def sign_in(resource_or_scope, resource=nil)
|
|
scope ||= Devise::Mapping.find_scope!(resource_or_scope)
|
|
resource ||= resource_or_scope
|
|
warden.session_serializer.store(resource, scope)
|
|
end
|
|
|
|
# Sign out a given resource or scope by calling logout on Warden.
|
|
# This method bypass any warden logout callback.
|
|
#
|
|
# Examples:
|
|
#
|
|
# sign_out :user # sign_out(scope)
|
|
# sign_out @user # sign_out(resource)
|
|
#
|
|
def sign_out(resource_or_scope)
|
|
scope = Devise::Mapping.find_scope!(resource_or_scope)
|
|
@controller.instance_variable_set(:"@current_#{scope}", nil)
|
|
user = warden.instance_variable_get(:@users).delete(scope)
|
|
warden.session_serializer.delete(scope, user)
|
|
end
|
|
|
|
end
|
|
end
|