veri 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33fc3ba81b0ff4f44df7e5bf8e6f6e25c5c318d8b1ca02988f200bf0039d19b9
-  data.tar.gz: 1433809afa4da2090dac9c75d8e1d6a14579c3ad77ff8ae6db49a5291e708b68
+  metadata.gz: 02bcadafc5e2561e169ce65e920a7009f7549a0dfc1b5199cd471c01a8deac6f
+  data.tar.gz: 9e8b74e83ea6882c5289f6109c9b4f2e8c492874f4ff9794315be7602410ea4a
 SHA512:
-  metadata.gz: 86fcd9a468d1f4fcb0c7fbe820c4e67d40a6c5e96a50bb2804141c4ad9960c5f42e0678bdd6bdf8284e9403c7d77e41fb0f756c78cf4acd019d6094aef95212a
-  data.tar.gz: e50a7bd3673bc9d806e2ed8f3e50820b75373df52720407ccf400073de0ff726ec1e8e89694369878f06b83f8cf8516fdad5ece1645dd62f0afd6ff74e36df95
+  metadata.gz: d7dedc00870041d1271c9c680226533030672546666bfac8a4fc0f5c7d26b4ff0eacd138b9edcb4418e017fd09e642e011b1dd06bb68ec69e2e3a4b96fc9805d
+  data.tar.gz: 492b0c906f34d2f091030c1d3425d21fbc5442c18080107deafe1397079f8b060609be0fd224324987ff502f1f55dcf0a9be08434f387dca2579e148ce478966

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.3.0
+
+### Breaking
+
+- Added account lockout feature
+
 ## v0.2.2
 
 ### Bugs

data/README.md

@@ -8,10 +8,11 @@ Veri is a cookie-based authentication library for Ruby on Rails that provides es
 **Key Features:**
 
 - Cookie-based authentication with database-stored sessions
-- Supports multiple password hashing algorithms (argon2, bcrypt, scrypt)
+- Multiple password hashing algorithms (argon2, bcrypt, scrypt)
 - Granular session management and control
-- Built-in return path handling
+- Return path handling
 - User impersonation feature
+- Account lockout functionality
 
 > ⚠️ **Development Notice**<br>
 > Veri is functional but in early development. Breaking changes may occur in minor releases until v1.0!
@@ -24,11 +25,12 @@ Veri is a cookie-based authentication library for Ruby on Rails that provides es
   - [Password Management](#password-management)
   - [Controller Integration](#controller-integration)
   - [Authentication Sessions](#authentication-sessions)
+  - [Account Lockout](#account-lockout)
   - [View Helpers](#view-helpers)
   - [Testing](#testing)
 
 **Community Resources:**
-  - [Contributing](#contributing)
+  - [Getting Help and Contributing](#getting-help-and-contributing)
   - [License](#license)
   - [Code of Conduct](#code-of-conduct)
 
@@ -108,7 +110,7 @@ end
 
 ### Authentication Methods
 
-This is a simplified example of how to use Veri's authentication methods in your controllers:
+This is a simplified example of how to use Veri's authentication methods:
 
 ```rb
 class SessionsController < ApplicationController
@@ -137,7 +139,7 @@ Available methods:
 
 - `current_user` - Returns authenticated user or `nil`
 - `logged_in?` - Returns `true` if user is authenticated
-- `log_in(user)` - Authenticates user and creates session
+- `log_in(user)` - Authenticates user and creates session, returns `true` on success or `false` if account is locked
 - `log_out` - Terminates current session
 - `return_path` - Returns path user was accessing before authentication
 - `current_session` - Returns current authentication session
@@ -249,6 +251,23 @@ Veri::Session.prune           # All sessions
 Veri::Session.prune(user)     # Specific user's sessions
 ```
 
+## Account Lockout
+
+Veri provides account lockout functionality to temporarily disable user accounts (for example, after too many failed login attempts or for security reasons).
+
+```rb
+# Lock a user account
+user.lock!
+
+# Unlock a user account
+user.unlock!
+
+# Check if account is locked
+user.locked?
+```
+
+When an account is locked, users cannot log in. If they're already logged in, their sessions will be terminated and they'll be treated as unauthenticated users.
+
 ## View Helpers
 
 Access authentication state in your views:
@@ -310,7 +329,7 @@ RSpec.configure do |config|
 end
 ```
 
-## Contributing
+## Getting Help and Contributing
 
 ### Getting Help
 Have a question or need assistance? Open a discussion in our [discussions section](https://github.com/brownboxdev/veri/discussions) for:
@@ -330,7 +349,7 @@ Ready to contribute? You can:
 - Improve documentation
 - Add new features (please discuss first in our [discussions section](https://github.com/brownboxdev/veri/discussions))
 
-Before contributing, please read the [contributing guidelines](https://github.com/brownboxdev/veri/blob/master/CONTRIBUTING.md)
+Before contributing, please read the [contributing guidelines](https://github.com/brownboxdev/veri/blob/main/CONTRIBUTING.md)
 
 ## License
 

data/lib/generators/veri/templates/add_veri_authentication.rb.erb

@@ -2,6 +2,8 @@ class AddVeriAuthentication < ActiveRecord::Migration[<%= ActiveRecord::Migratio
   def change
     add_column <%= table_name.to_sym.inspect %>, :hashed_password, :text
     add_column <%= table_name.to_sym.inspect %>, :password_updated_at, :datetime
+    add_column <%= table_name.to_sym.inspect %>, :locked, :boolean, default: false, null: false
+    add_column <%= table_name.to_sym.inspect %>, :locked_at, :datetime
 
     create_table :veri_sessions<%= ", id: :uuid" if options[:uuid] %> do |t|
       t.string :hashed_token, null: false, index: { unique: true }

data/lib/veri/controllers/concerns/authentication.rb

@@ -39,8 +39,12 @@ module Veri
         as: :authenticatable,
         message: "Expected an instance of #{Veri::Configuration.user_model_name}, got `#{authenticatable.inspect}`"
       )
+
+      return false if processed_authenticatable.locked?
+
       token = Veri::Session.establish(processed_authenticatable, request)
       cookies.encrypted.permanent[:veri_token] = { value: token, httponly: true }
+      true
     end
 
     def log_out
@@ -63,9 +67,18 @@ module Veri
     private
 
     def with_authentication
-      current_session.update_info(request) and return if logged_in? && current_session.active?
+      if logged_in? && current_session.active?
+        if current_user.locked?
+          log_out
+          when_unauthenticated
+        else
+          current_session.update_info(request)
+        end
+
+        return
+      end
 
-      current_session&.terminate
+      log_out
 
       cookies.signed[:veri_return_path] = { value: request.fullpath, expires: 15.minutes.from_now } if request.get? && request.format.html?
 

data/lib/veri/models/concerns/authenticatable.rb

@@ -34,6 +34,14 @@ module Veri
       )
     end
 
+    def lock!
+      update!(locked: true, locked_at: Time.current)
+    end
+
+    def unlock!
+      update!(locked: false, locked_at: nil)
+    end
+
     private
 
     def hasher

data/lib/veri/version.rb

@@ -1,3 +1,3 @@
 module Veri
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: veri
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - enjaku4