warden-rspec-rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 775e119dbbccddb56df09cc3e85b1596416a4566
-  data.tar.gz: c6123ec1878a5ba17db9c7f211118cb3289ec86a
+SHA256:
+  metadata.gz: 8101a75e25a75be2b24e44e5efb58cf3f05bda325adb59ec206817ea8494d2ee
+  data.tar.gz: 24d9b354d4cecb692a63975895edba65da84d687e235b2c41435f5f4295ee36b
 SHA512:
-  metadata.gz: ee985ecdebd18d5467ec4d34ae89dc441ec666fc3a9d994fccff381ce9e7f9821ba70641cc81e5c6f6686c6790d4b6b8aac408d7a4d5d26b1ba3ee574f608b32
-  data.tar.gz: b76c954b5f715e83041ac727045a896a94fa5fbbd332374e6935de3e7ad044df7cc4ec2ccc2eed98891c9b24fe3d4ebaacbca37a9a3fc94f4b6e51a54c075963
+  metadata.gz: 0533fce0ae3ccc3cb454d2211b008e644bbbf80caf1a002954dc73d604ba93792902af5cb24902342ea0224bc37a8f09ff5568a8331beace48c6854747974031
+  data.tar.gz: f71a6cfa1e19727ba1cfe89fdfdce7e21ee3121f8497b65030cecfa504745f3b2563d2157b0af3541d2d301f2f0e0ccfa11b138db6c2c4baa057773c3d9adc10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Alex Sharp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,7 +1,7 @@
 ## What
 
-Rails controller spec helpers for warden. If you're using warden
-without devise in rails, due to how action controller sets up the test
+Rails controller spec helpers for Warden. If you're using Warden
+without Devise in rails, due to how ActionController sets up the test
 environment, custom test setup code is necessary.
 
 ## Usage
@@ -15,13 +15,17 @@ end
 # spec_helper.rb
 RSpec.configure do |c|
   c.include Warden::Test::ControllerHelpers, type: :controller
-  
-  def sign_in(user)
-    warden.set_user(user)
-  end
 end
 ```
 
+This will define helper methods in controller tests that you can use to manage
+authentication, such as:
+- `warden`: Access the `Warden::Proxy`.
+- `login_as`: Same as the `Warden::Test::Helpers` `login_as` method.
+- `logout`: Same as the `Warden::Test::Helpers` `logout` method.
+- `unlogin`: Removes the user(s) from the logged-in list, but leaves the
+    session value so the user can be fetched on access.
+
 ## Thanks
 
 * Devise: https://github.com/platformatec/devise

data/lib/warden/test/controller_helpers.rb

@@ -1,21 +1,24 @@
-# test/test_helpers/warden.rb
+# frozen_string_literal: true
+
+require "warden" # just in case
 
 # Based on http://stackoverflow.com/questions/13420923/configuring-warden-for-use-in-rspec-controller-specs
 module Warden
   # Warden::Test::ControllerHelpers provides a facility to test controllers in isolation
-  # Most of the code was extracted from Devise's Devise::TestHelpers.
+  # Most of the code was extracted from Devise's Devise::Test::ControllerHelpers.
   module Test
     module ControllerHelpers
-      def self.included(base)
-        base.class_eval do
-          setup :setup_controller_for_warden, :warden if respond_to?(:setup)
-        end
+      extend ActiveSupport::Concern
+
+      included do
+        setup :setup_controller_for_warden, :warden # if respond_to?(:setup)
       end
 
       # Override process to consider warden.
-      def process(*)
-        # Make sure we always return @response, a la ActionController::TestCase::Behavior#process, even if warden interrupts
-        _catch_warden {super} || @response
+      def process(*, **)
+        _catch_warden { super }
+
+        @response
       end
 
       # We need to setup the environment variables and the response in the controller
@@ -24,10 +27,31 @@ module Warden
       end
 
       # Quick access to Warden::Proxy.
-      def warden
-        @warden ||= begin
-          manager = Warden::Manager.new(nil, &Rails.application.config.middleware.detect{|m| m.name == 'Warden::Manager'}.block)
-          @request.env['warden'] = Warden::Proxy.new(@request.env, manager)
+      def warden #:nodoc:
+        @request.env['warden'] ||= begin
+          manager = Warden::Manager.new(nil, &Rails.application.config.middleware.detect { |m| m.name.include?('Warden::Manager') }.block)
+          Warden::Proxy.new(@request.env, manager)
+        end
+      end
+
+      # Warden::Test::Helpers style login_as for controller tests.
+      def login_as(user, opts = {})
+        opts[:event] ||= :authentication
+        warden.set_user(user, opts)
+      end
+
+      # Warden::Test::Helpers style logout for controller tests.
+      def logout(*scopes)
+        warden.logout(*scopes)
+      end
+
+      # Reset the logins without logging out, so the next request will fetch.
+      def unlogin(*scopes)
+        users = warden.instance_variable_get(:@users)
+        if scopes.empty?
+          users.clear
+        else
+          scopes.each { |scope| users.delete(scope) }
         end
       end
 
@@ -38,23 +62,67 @@ module Warden
       def _catch_warden(&block)
         result = catch(:warden, &block)
 
-        if result.is_a?(Hash) && !warden.custom_failure? && !@controller.send(:performed?)
-          result[:action] ||= :unauthenticated
+        env = @controller.request.env
 
-          env = @controller.request.env
-          env['PATH_INFO'] = "/#{result[:action]}"
-          env['warden.options'] = result
-          Warden::Manager._run_callbacks(:before_failure, env, result)
+        result ||= {}
 
-          status, headers, body = warden.config[:failure_app].call(env).to_a
-          @controller.send :render, :status => status, :text => body,
-            :content_type => headers['Content-Type'], :location => headers['Location']
-
-          nil
+        # Set the response. In production, the rack result is returned
+        # from Warden::Manager#call, which the following is modelled on.
+        case result
+        when Array
+          if result.first == 401 && intercept_401?(env) # does this happen during testing?
+            _process_unauthenticated(env)
+          else
+            result
+          end
+        when Hash
+          _process_unauthenticated(env, result)
         else
           result
         end
       end
+
+      def _process_unauthenticated(env, options = {})
+        proxy = request.env['warden']
+        options[:action] ||= begin
+          opts = proxy.config[:scope_defaults][proxy.config.default_scope] || {}
+          opts[:action] || "unauthenticated"
+        end
+        result = options[:result] || proxy.result
+
+        ret = case result
+        when :redirect
+          body = proxy.message || "You are being redirected to #{proxy.headers['Location']}"
+          [proxy.status, proxy.headers, [body]]
+        when :custom
+          proxy.custom_response
+        else
+          request.env["PATH_INFO"] = "/#{options[:action]}"
+          request.env["warden.options"] = options
+          Warden::Manager._run_callbacks(:before_failure, env, options)
+
+          status, headers, response = warden.config[:failure_app].call(env).to_a
+          @controller.response.headers.merge!(headers)
+          @controller.status = status
+          @controller.response.body = response.body
+          nil # causes process return @response
+        end
+
+        # ensure that the controller response is set up. In production, this is
+        # not necessary since warden returns the results to rack. However, at
+        # testing time, we want the response to be available to the testing
+        # framework to verify what would be returned to rack.
+        if ret.is_a?(Array)
+          status, headers, body = *ret
+          # ensure the controller response is set to our response.
+          @controller.response ||= @response
+          @response.status = status
+          @response.headers.merge!(headers)
+          @response.body = body
+        end
+
+        ret
+      end
     end
   end
-end
+end

data/lib/warden-rspec-rails.rb

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 
 require 'warden/test/controller_helpers'

data/warden-rspec-rails.gemspec

@@ -3,7 +3,8 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "warden-rspec-rails"
-  s.version     = '0.2.0'
+  s.version     = '0.3.0'
+  s.licenses    = ['MIT']
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Alex Sharp"]
   s.email       = ["ajsharp@gmail.com"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warden-rspec-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alex Sharp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies: []
 description: Rails controller spec helpers for warden.
 email:
@@ -17,12 +17,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/warden-rspec-rails.rb
 - lib/warden/test/controller_helpers.rb
 - warden-rspec-rails.gemspec
 homepage: https://github.com/ajsharp/warden-rspec-rails
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -39,8 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Rails controller spec helpers for warden.