veri 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac32f0c6d36a07d566aec8905648f0e27811876d52929ab1753f3109af5648b7
-  data.tar.gz: eaaec22fa0215df1896cf3baadf7b8ce5e7ff4ebcb61094443a020e54c63023c
+  metadata.gz: '0782d4bd585ca9ca0aaa91cb51fe4b240d9e97ccf829c69890bc2079b38dda18'
+  data.tar.gz: 56cd6f6147a7b23ea2a5cc0b12dd9d573fcae55dcbf49462f93a4db59d5ef724
 SHA512:
-  metadata.gz: d75c20d2484660914c53ead2394f376bc915c45833bfe8b643b7e4964dc104c94d64747ce8be312bae24930e27216296060f1971a8356c9ec4c347372106c080
-  data.tar.gz: 4166c688264ac0cfa34866487a2ac572deb70972656c59fd724608841ea50d8b5436e64d70c7a45990302e4a8111cf0e47b103aff78075f0d792d05953c5a2b7
+  metadata.gz: 29763c6104a41dd4987ff30d4c75089d8390d5c36afb7d9f9f297fe627380f0b674d46d4c52aedb27865776d6915bd38ca4acacc2adda7894fe66d9e457bfeec
+  data.tar.gz: '038ae16e36b31d87b4b83f7d51f51bb4c9d9318e6c161c9249f6eeff0a6a970343a2b1acbcb256edb4622bd03e01d1b6dda5c90c441274ef3b841f792dbc8ba6'

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v0.2.0
+
+### Breaking
+
+- Added `password_updated_at` timestamp tracking for authenticatable models
+- Added shapeshifter functionality for impersonation/session switching
+
+### Features
+
+- Added `Session#identity` method
+- Added `current_session` helper method for views
+
 ## v0.1.0
 
 - Initial release

data/README.md

@@ -10,9 +10,8 @@ Veri is a cookie-based authentication library for Ruby on Rails that provides es
 - Cookie-based authentication with database-stored sessions
 - Supports multiple password hashing algorithms (argon2, bcrypt, scrypt)
 - Granular session management and control
-- Flexible authentication callbacks
-- No pre-defined business logic, no views, controllers, or mailers — just the essential methods
 - Built-in return path handling
+- User impersonation feature
 
 > ⚠️ **Development Notice**<br>
 > Veri is functional but in early development. Breaking changes may occur in minor releases until v1.0!
@@ -99,11 +98,11 @@ Include the authentication module and configure protection:
 class ApplicationController < ActionController::Base
   include Veri::Authentication
 
-  with_authentication  # Require authentication by default
+  with_authentication # Require authentication by default
 end
 
 class PicturesController < ApplicationController
-  skip_authentication only: [:index, :show]  # Allow public access to index and show actions
+  skip_authentication only: [:index, :show] # Allow public access to index and show actions
 end
 ```
 
@@ -136,16 +135,49 @@ end
 
 Available methods:
 
-- `current_user` - returns the authenticated user or `nil`
-- `logged_in?` - returns `true` if user is authenticated
-- `log_in(user)` - authenticates the user and creates a session
-- `log_out` - terminates the current session
-- `return_path` - returns the path the user was trying to access before authentication
-- `current_session` - returns the current authentication session
+- `current_user` - Returns authenticated user or `nil`
+- `logged_in?` - Returns `true` if user is authenticated
+- `log_in(user)` - Authenticates user and creates session
+- `log_out` - Terminates current session
+- `return_path` - Returns path user was accessing before authentication
+- `current_session` - Returns current authentication session
 
-### Authentication Callbacks
+### User Impersonation (Shapeshifting)
 
-Override these private methods to customize authentication behavior:
+Veri provides user impersonation functionality that allows, for example, administrators to temporarily assume another user's identity:
+
+```rb
+module Admin
+  class ImpersonationController < ApplicationController
+    def create
+      user = User.find(params[:user_id])
+      current_session.shapeshift(user)
+      redirect_to root_path, notice: "Now viewing as #{user.name}"
+    end
+
+    def destroy
+      original_user = current_session.true_identity
+      current_session.revert_to_true_identity
+      redirect_to admin_dashboard_path, notice: "Returned to #{original_user.name}"
+    end
+  end
+end
+```
+
+Available session methods:
+
+- `shapeshift(user)` - Assume another user's identity (maintains original identity)
+- `revert_to_true_identity` - Return to original identity
+- `shapeshifted?` - Returns true if currently shapeshifted
+- `true_identity` - Returns original user when shapeshifted, otherwise current user
+
+Controller helper:
+
+- `shapeshifter?` - Returns true if the current session is shapeshifted
+
+### When unauthenticated
+
+Override this private method to customize authentication behavior:
 
 ```rb
 class ApplicationController < ActionController::Base
@@ -157,18 +189,6 @@ class ApplicationController < ActionController::Base
 
   private
 
-  # Called after successful login
-  def after_login(user)
-    Rails.logger.info "User #{user.id} logged in"
-    # Custom redirect logic, analytics, etc.
-  end
-
-  # Called after logout
-  def after_logout
-    Rails.logger.info "User logged out"
-    # Cleanup, analytics, etc.
-  end
-
   # Customize unauthenticated user handling
   def when_unauthenticated
     # By default redirects back with a fallback to the root path if the request format is HTML,
@@ -180,7 +200,7 @@ end
 
 ## Authentication Sessions
 
-Veri stores authentication sessions in the database, enabling powerful session management:
+Veri stores authentication sessions in the database, providing session management capabilities:
 
 ### Session Access
 
@@ -195,13 +215,15 @@ current_session
 ### Session Information
 
 ```rb
+session.identity
+# => authenticated user
 session.info
 # => {
 #   device: "Desktop",
 #   os: "macOS",
 #   browser: "Chrome",
 #   ip_address: "1.2.3.4",
-#   last_activity: "2023-10-01 12:00:00"
+#   last_seen_at: "2023-10-01 12:00:00"
 # }
 ```
 
@@ -234,6 +256,10 @@ Access authentication state in your views:
 ```erb
 <% if logged_in? %>
   <p>Welcome, <%= current_user.name %>!</p>
+  <% if shapeshifter? %>
+    <p><em>Currently viewing as <%= current_user.name %> (Original: <%= current_session.true_identity.name %>)</em></p>
+    <%= link_to "Return to Original Identity", revert_path, method: :patch %>
+  <% end %>
   <%= link_to "Logout", logout_path, method: :delete %>
 <% else %>
   <%= link_to "Login", login_path %>

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

@@ -1,11 +1,14 @@
 class AddVeriAuthentication < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version.to_s %>]
   def change
     add_column <%= table_name.to_sym.inspect %>, :hashed_password, :text
+    add_column <%= table_name.to_sym.inspect %>, :password_updated_at, :datetime
 
     create_table :veri_sessions<%= ", id: :uuid" if options[:uuid] %> do |t|
       t.string :hashed_token, null: false, index: { unique: true }
       t.datetime :expires_at, null: false
       t.belongs_to :authenticatable, null: false, foreign_key: { to_table: <%= table_name.to_sym.inspect %> }, index: true<%= ", type: :uuid" if options[:uuid] %>
+      t.belongs_to :original_authenticatable, foreign_key: { to_table: <%= table_name.to_sym.inspect %> }, index: true<%= ", type: :uuid" if options[:uuid] %>
+      t.datetime :shapeshifted_at
       t.datetime :last_seen_at, null: false
       t.string :ip_address
       t.string :user_agent

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

@@ -5,7 +5,7 @@ module Veri
     included do
       include ActionController::Cookies unless self < ActionController::Cookies
 
-      helper_method(:current_user, :logged_in?) if respond_to?(:helper_method)
+      helper_method(:current_user, :logged_in?, :shapeshifter?, :current_session) if respond_to?(:helper_method)
     end
 
     class_methods do
@@ -23,7 +23,7 @@ module Veri
     end
 
     def current_user
-      @current_user ||= current_session&.authenticatable
+      @current_user ||= current_session&.identity
     end
 
     def current_session
@@ -34,13 +34,11 @@ module Veri
     def log_in(authenticatable)
       token = Veri::Session.establish(Veri::Inputs.process(authenticatable, as: :authenticatable), request)
       cookies.encrypted.permanent[:veri_token] = { value: token, httponly: true }
-      after_login
     end
 
     def log_out
       current_session&.terminate
       cookies.delete(:veri_token)
-      after_logout
     end
 
     def logged_in?
@@ -51,6 +49,10 @@ module Veri
       cookies.signed[:veri_return_path]
     end
 
+    def shapeshifter?
+      !!current_session&.shapeshifted?
+    end
+
     private
 
     def with_authentication
@@ -66,8 +68,5 @@ module Veri
     def when_unauthenticated
       request.format.html? ? redirect_back(fallback_location: root_path) : head(:unauthorized)
     end
-
-    def after_login = nil
-    def after_logout = nil
   end
 end

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

@@ -11,7 +11,10 @@ module Veri
     end
 
     def update_password(password)
-      update!(hashed_password: hasher.create(Veri::Inputs.process(password, as: :string)))
+      update!(
+        hashed_password: hasher.create(Veri::Inputs.process(password, as: :string)),
+        password_updated_at: Time.current
+      )
     end
 
     def verify_password(password)

data/lib/veri/models/session.rb

@@ -4,11 +4,12 @@ module Veri
   class Session < ActiveRecord::Base
     self.table_name = "veri_sessions"
 
-    belongs_to :authenticatable, class_name: Veri::Configuration.user_model_name # rubocop:disable Rails/ReflectionClassName
+    # rubocop:disable Rails/ReflectionClassName
+    belongs_to :authenticatable, class_name: Veri::Configuration.user_model_name
+    belongs_to :original_authenticatable, class_name: Veri::Configuration.user_model_name, optional: true
+    # rubocop:enable Rails/ReflectionClassName
 
-    def active?
-      !expired? && !inactive?
-    end
+    def active? = !expired? && !inactive?
 
     def expired?
       expires_at < Time.current
@@ -46,6 +47,26 @@ module Veri
       }
     end
 
+    def identity = authenticatable
+    def shapeshifted? = original_authenticatable.present?
+    def true_identity = original_authenticatable || authenticatable
+
+    def shapeshift(user)
+      update!(
+        shapeshifted_at: Time.current,
+        original_authenticatable: authenticatable,
+        authenticatable: Veri::Inputs.process(user, as: :authenticatable)
+      )
+    end
+
+    def revert_to_true_identity
+      update!(
+        shapeshifted_at: nil,
+        authenticatable: original_authenticatable,
+        original_authenticatable: nil
+      )
+    end
+
     class << self
       def establish(authenticatable, request)
         token = SecureRandom.hex(32)

data/lib/veri/version.rb

@@ -1,3 +1,3 @@
 module Veri
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

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