quo_vadis 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f77cea22311c350e1a0671c147db092e3e6c46164a468bff88904eb5fdb742
-  data.tar.gz: 03f0d04ea03e4e84b45d83fb494959a02f0483b5fd145ff550200fdbb6639ab6
+  metadata.gz: e38d43ca3eb42e7fe421725da06631c57c15308a0ee0fcb395043b3c8d922bde
+  data.tar.gz: 2e09223593c598cdfcad8cb5947dc4065b499e9a9dee06e8eec1a7cd6124003a
 SHA512:
-  metadata.gz: b96e1e5398ded302e9efb69c6e268307606535fc63346acc4faf0443098eb500c97daa107be2ccced4151078c90aac9917a72e037023aeea7cf460a7c706dde8
-  data.tar.gz: 6de70ddbe36d8c5334d1a6ab95da333ab59d28a98a0c1a57ca1c47e1375a156df5c689fbc66f90e70ea44d3e46e2a9af3ad4b4b8a7d8e86fd6ed27e2055ab5e4
+  metadata.gz: 69048fb28b48d94329ee3269cb706f583796893a2a8a6d7177adfb2b9b022f7fe84e4076044816d33d6e4a02b6529b3413c12b38f6dc6a3f3672095683a04610
+  data.tar.gz: fd2a1c93a899e07d1e9bb2a393a52eccbdb5f9256c894d03ca1eb34bc867f351dfe12149d45879ab5bc5960f9d393cdbbe7f5dc24ab43a46cc3cfa50a6454b44

data/CHANGELOG.md

@@ -4,6 +4,11 @@
 ## HEAD
 
 
+## 2.2.3 (22 May 2024)
+
+* Add login shortcut for speedier tests.
+
+
 ## 2.2.2 (30 April 2024)
 
 * Do not update last activity time for ActiveStorage (#23).

data/README.md

@@ -12,6 +12,7 @@ Simple to integrate into your application.  The main task is customising the exa
 ### General features
 
 - Works with any model, e.g. `User` or `Person`.
+- Works with multiple models, e.g. `User` and `Admin`.
 - Works with any identifier, e.g. `:username` or `:email`.
 - Minimal footprint in your models and controllers.
 - Does not touch your existing database tables.
@@ -31,6 +32,10 @@ Simple to integrate into your application.  The main task is customising the exa
 - Email-notifications of updates to authentication details.
 - Audit trail.
 
+### Testing
+
+- Can shortcut logging in for speedier tests.
+
 
 ## Installation
 
@@ -384,6 +389,22 @@ They must be in `app/views/quo_vadis/mailer/NAME.{text,html}.erb`.
 You can revoke a user's access by calling `#revoke_authentication_credentials` on the model instance.  This deletes the user's password, TOTP credential, recovery codes, and active sessions.  Their authentication logs, or audit trail, are preserved.
 
 
+## Shortcut logging in for functional, integration, and system tests
+
+Instead of going through your login page to log in before every test, you can tell QuoVadis which model to authenticate as when visiting the first URL in your test.
+
+Use a `login` param pointing to your model's global ID.  Note that the model must be able to log in normally, i.e. it must have a password (and therefore a `qv_account`).
+
+For example:
+
+```ruby
+@user = User.create(email: '...', password: '...')
+visit dashboard_path(login: @user.to_global_id)
+```
+
+This only works in the test environment.
+
+
 ## Configuration
 
 This is QuoVadis' [default configuration](https://github.com/airblade/quo_vadis/blob/master/lib/quo_vadis/defaults.rb):

data/lib/quo_vadis/controller.rb

@@ -4,6 +4,15 @@ module QuoVadis
   module Controller
 
     def self.included(base)
+      if Rails.env.test?
+        base.before_action {
+          if params[:login]
+            model = GlobalID::Locator.locate(params.delete(:login))
+            login model
+          end
+        }
+      end
+
       base.before_action { CurrentRequestDetails.request = request }
 
       base.helper_method :authenticated_model, :logged_in?

data/lib/quo_vadis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QuoVadis
-  VERSION = '2.2.2'
+  VERSION = '2.2.3'
 end

data/test/integration/controller_test.rb

@@ -14,6 +14,14 @@ class ControllerTest < IntegrationTest
   end
 
 
+  test 'shortcut login' do
+    get secret_articles_path(login: User.first.to_global_id)
+
+    assert_response :success
+    assert_equal secret_articles_path, path
+  end
+
+
   test 'require_authentication when not logged in' do
     get secret_articles_path
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quo_vadis
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Andy Stewart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails