lesli_audit 1.0.2 → 1.1.1

data/app/views/lesli_audit/visitors/index.html.erb

@@ -0,0 +1,164 @@
+
+<%
+visitors = @visitors.reverse
+top_days = visitors.last(3)
+%>
+
+<%= render(LesliView::Layout::Container.new("audit-analytics")) do %>
+    <%= render(LesliView::Components::Header.new("Analytics")) %>
+
+    <section
+        class="grid grid-cols-1 gap-4 sm:grid-cols-2 lg:grid-cols-5"
+        aria-label="Visitor overview">
+        <article class="rounded-2xl border border-slate-200 bg-white p-5 shadow-sm">
+            <h2 class="text-sm font-medium text-slate-500">Controllers</h2>
+            <p class="mt-3 text-3xl font-semibold tracking-tight text-slate-900 tabular-nums">
+                <%= @visits[:controllers] %>
+            </p>
+        </article>
+
+        <article class="rounded-2xl border border-slate-200 bg-white p-5 shadow-sm">
+            <h2 class="text-sm font-medium text-slate-500">Requests</h2>
+            <p class="mt-3 text-3xl font-semibold tracking-tight text-slate-900 tabular-nums">
+                <%= @visits[:requests] %>
+            </p>
+        </article>
+
+        <% top_days.each do |day| %>
+            <article class="rounded-2xl border border-slate-200 bg-white p-5 shadow-sm">
+                <h2 class="text-sm font-medium text-slate-500"><%= day["xaxiskey"] %></h2>
+                <p class="mt-3 text-3xl font-semibold tracking-tight text-slate-900 tabular-nums">
+                    <%= day["yaxiskey"] %>
+                </p>
+            </article>
+        <% end %>
+    </section>
+
+    <section class="mt-6 rounded-2xl border border-slate-200 bg-white p-5 shadow-sm">
+        <%= render(LesliView::Charts::Line.new(
+            title: "Visitors",
+            database_to_dataset: visitors
+        )) %>
+    </section>
+
+    <section class="mt-6 grid grid-cols-1 gap-6 lg:grid-cols-3" aria-label="Visitor breakdown">
+        <article class="min-w-0">
+            <%= render(LesliView::Elements::Table.new(
+                columns: [
+                    { label: "Browsers", align: :left },
+                    { label: "Visitors", align: :center }
+                ],
+                class_name: "!min-w-0",
+                compact: true,
+                caption: "Visitors by browser"
+            )) do |table| %>
+                <% @browsers.each do |browser| %>
+                    <% percentage = browser[:percentage].to_i.clamp(0, 100) %>
+                    <% table.with_row do |row| %>
+                        <% row.with_cell(class_name: "!p-0") do %>
+                            <div class="relative isolate overflow-hidden px-3 py-2.5">
+                                <span
+                                    class="absolute inset-y-0 left-0 -z-10 bg-slate-100"
+                                    style="width: <%= percentage %>%"
+                                    aria-hidden="true"></span>
+                                <span class="flex items-center gap-2 text-slate-700">
+                                    <span class="inline-flex h-7 w-7 shrink-0 items-center justify-center text-slate-500">
+                                        <span class="ri-<%= browser[:icon] %> text-lg leading-none" aria-hidden="true"></span>
+                                    </span>
+                                    <span class="truncate"><%= browser[:browser] %></span>
+                                </span>
+                            </div>
+                        <% end %>
+                        <% row.with_cell(class_name: "font-semibold tabular-nums text-slate-900", align: :center) do %>
+                            <%= browser[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </article>
+
+        <article class="min-w-0">
+            <%= render(LesliView::Elements::Table.new(
+                columns: [
+                    { label: "OS", align: :left },
+                    { label: "Visitors", align: :center }
+                ],
+                class_name: "!min-w-0",
+                compact: true,
+                caption: "Visitors by operating system"
+            )) do |table| %>
+                <% @os.each do |device| %>
+                    <% percentage = device[:percentage].to_i.clamp(0, 100) %>
+                    <% table.with_row do |row| %>
+                        <% row.with_cell(class_name: "!p-0") do %>
+                            <div class="relative isolate overflow-hidden px-3 py-2.5">
+                                <span
+                                    class="absolute inset-y-0 left-0 -z-10 bg-slate-100"
+                                    style="width: <%= percentage %>%"
+                                    aria-hidden="true"></span>
+                                <span class="flex items-center gap-2 text-slate-700">
+                                    <span class="inline-flex h-7 w-7 shrink-0 items-center justify-center text-slate-500">
+                                        <span class="ri-<%= device[:icon].downcase %> text-lg leading-none" aria-hidden="true"></span>
+                                    </span>
+                                    <span class="truncate"><%= device[:device] %></span>
+                                </span>
+                            </div>
+                        <% end %>
+                        <% row.with_cell(class_name: "font-semibold tabular-nums text-slate-900", align: :center) do %>
+                            <%= device[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </article>
+
+        <article class="min-w-0">
+            <%= render(LesliView::Elements::Table.new(
+                columns: [
+                    { label: "Device", align: :left },
+                    { label: "Visitors", align: :center }
+                ],
+                class_name: "!min-w-0",
+                compact: true,
+                caption: "Visitors by device"
+            )) do |table| %>
+                <% @devices.each do |device| %>
+                    <% percentage = device[:percentage].to_i.clamp(0, 100) %>
+                    <% table.with_row do |row| %>
+                        <% row.with_cell(class_name: "!p-0") do %>
+                            <div class="relative isolate overflow-hidden px-3 py-2.5">
+                                <span
+                                    class="absolute inset-y-0 left-0 -z-10 bg-slate-100"
+                                    style="width: <%= percentage %>%"
+                                    aria-hidden="true"></span>
+                                <span class="flex items-center gap-2 text-slate-700">
+                                    <span class="inline-flex h-7 w-7 shrink-0 items-center justify-center text-slate-500">
+                                        <span class="ri-<%= device[:icon] %> text-lg leading-none" aria-hidden="true"></span>
+                                    </span>
+                                    <span class="truncate"><%= device[:device] %></span>
+                                </span>
+                            </div>
+                        <% end %>
+                        <% row.with_cell(class_name: "font-semibold tabular-nums text-slate-900", align: :center) do %>
+                            <%= device[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </article>
+    </section>
+
+    <section class="mt-6 pb-8" aria-label="Top controllers">
+        <%= render(LesliView::Elements::Table.new(
+            columns: [{
+                label: "Top controllers",
+                field: "request_controller"
+            }, {
+                label: "Requests",
+                field: "requests"
+            }],
+            records: @requests,
+            caption: "Requests by controller"
+        )) %>
+    </section>
+<% end %>

data/config/routes.rb

@@ -47,7 +47,7 @@ LesliAudit::Engine.routes.draw do
     #   Trends by date
     #   Most active users
     #   Most active controllers
-    resources :analytics, only: [:index] 
+    resources :visitors, only: [:index] 
 
     resources :logs, only: [:index, :show]
 

data/db/migrate/v1.0/0501110210_create_lesli_audit_account_devices.rb

@@ -35,11 +35,12 @@ class CreateLesliAuditAccountDevices < ActiveRecord::Migration[8.1]
         create_table :lesli_audit_account_devices do |t|
             t.string  :agent_platform
             t.string  :agent_browser
+            t.string  :agent_device
             t.integer :agent_count
             t.date    :created_at
         end
 
         add_reference(:lesli_audit_account_devices, :account, foreign_key: { to_table: :lesli_audit_accounts })
-        add_index(:lesli_audit_account_devices, %i[agent_platform agent_browser created_at account_id], unique: true, name: "lesli_audit_devices_index")
+        add_index(:lesli_audit_account_devices, %i[agent_platform agent_browser agent_device created_at account_id], unique: true, name: "lesli_audit_devices_index")
     end
 end

data/db/seed/devices.rb

@@ -44,25 +44,33 @@ current_user = Lesli::User.first
 
 # controllers to seed
 [
-    "Macintosh", 
+    "Mac", 
     "Windows"
 ].each do |platform|
 
     [
-        "Firefox", 
-        "Chrome",
-        "Safari"
-    ].each do |browser|
-        # Iterate through the dates
-        (start_date..end_date).each do |date|
-
-            current_user.account.audit.account_devices.create_with(
-                :agent_count => rand(40..80),
-            ).find_or_create_by(
-                :agent_platform => platform,
-                :agent_browser => browser,
-                :created_at => date,
-            )
+        "smartphone",
+        "tablet",
+        "desktop"
+    ].each do |device|
+
+        [
+            "Firefox", 
+            "Chrome",
+            "Safari"
+        ].each do |browser|
+            # Iterate through the dates
+            (start_date..end_date).each do |date|
+
+                current_user.account.audit.account_devices.create_with(
+                    :agent_count => rand(40..80),
+                ).find_or_create_by(
+                    :agent_platform => platform,
+                    :agent_browser => browser,
+                    :agent_device => device,
+                    :created_at => date,
+                )
+            end
         end
     end
 end

data/db/seed/users.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+return unless Rails.env.development?
+
+account = Lesli::Account.first!
+
+password = if defined?(Devise)
+    Devise::Encryptor.digest(Lesli::User, "password123")
+else
+    BCrypt::Password.create("password123")
+end
+
+now = Time.current
+
+# Adjust these numbers freely while building the dashboard.
+TOTAL_USERS                     = 1_000
+TOTAL_INACTIVE_USERS            = 120
+TOTAL_LOCKED_USERS              = 45
+TOTAL_UNCONFIRMED_USERS         = 80
+TOTAL_USERS_NEVER_SIGNED_IN     = 140
+TOTAL_USERS_ACTIVE_LAST_30_DAYS = 520
+TOTAL_NEW_USERS_LAST_30_DAYS    = 75
+TOTAL_USERS_WITH_FAILED_ATTEMPTS = 60
+TOTAL_DELETED_USERS             = 25
+
+users = []
+
+TOTAL_USERS.times do |index|
+    uid = "DEV-USR-#{index.to_s.rjust(5, "0")}"
+
+    users << {
+        uid: uid,
+        account_id: account.id,
+
+        active: true,
+
+        first_name: "Demo",
+        last_name: "User #{index + 1}",
+        email: "demo.user.#{index + 1}@lesli.dev",
+        encrypted_password: password,
+
+        confirmed_at: now - rand(1..180).days,
+        confirmation_sent_at: nil,
+        confirmation_token: nil,
+
+        sign_in_count: rand(1..80),
+        current_sign_in_at: now - rand(1..90).days,
+        last_sign_in_at: now - rand(1..90).days,
+        current_sign_in_ip: "127.0.0.1",
+        last_sign_in_ip: "127.0.0.1",
+
+        failed_attempts: 0,
+
+        locked_at: nil,
+        locked_until: nil,
+        unlock_token: nil,
+
+        created_at: now - rand(31..365).days,
+        updated_at: now,
+        deleted_at: nil
+    }
+end
+
+# Inactive users
+users.first(TOTAL_INACTIVE_USERS).each do |user|
+    user[:active] = false
+end
+
+# Locked users
+users.slice(120, TOTAL_LOCKED_USERS).each do |user|
+    user[:locked_at] = now - rand(1..15).days
+    user[:locked_until] = now + rand(1..15).days
+end
+
+# Unconfirmed users
+users.slice(200, TOTAL_UNCONFIRMED_USERS).each do |user|
+    user[:confirmed_at] = nil
+    user[:confirmation_sent_at] = now - rand(1..10).days
+    user[:confirmation_token] = SecureRandom.hex(16)
+end
+
+# Never signed in
+users.slice(300, TOTAL_USERS_NEVER_SIGNED_IN).each do |user|
+    user[:sign_in_count] = 0
+    user[:current_sign_in_at] = nil
+    user[:last_sign_in_at] = nil
+    user[:current_sign_in_ip] = nil
+    user[:last_sign_in_ip] = nil
+end
+
+# Active in the last 30 days
+users.slice(450, TOTAL_USERS_ACTIVE_LAST_30_DAYS).each do |user|
+    user[:sign_in_count] = rand(1..100)
+    user[:last_sign_in_at] = now - rand(0..29).days
+    user[:current_sign_in_at] = user[:last_sign_in_at]
+end
+
+# New users in the last 30 days
+users.last(TOTAL_NEW_USERS_LAST_30_DAYS).each do |user|
+    user[:created_at] = now - rand(0..29).days
+    user[:updated_at] = now
+end
+
+# Users with failed attempts
+users.slice(700, TOTAL_USERS_WITH_FAILED_ATTEMPTS).each do |user|
+    user[:failed_attempts] = rand(1..5)
+end
+
+# Soft-deleted users
+users.last(TOTAL_DELETED_USERS).each do |user|
+    user[:deleted_at] = now - rand(1..30).days
+end
+
+# Remove previous generated users only
+Lesli::User.where("uid LIKE ?", "DEV-USR-%").delete_all
+
+Lesli::User.insert_all!(users)

data/db/seeds.rb

@@ -30,12 +30,12 @@ Building a better future, one line of code at a time.
 // · 
 =end
 
-
-L2.msg("LesliAudit", "Version: #{LesliAudit::VERSION}", "Build: #{LesliAudit::BUILD}")
+Termline.info("Loading seeds for: LesliAudit #{LesliAudit::VERSION} (#{LesliAudit::BUILD})")
 
 
 # · load specific environment seeds
 if Rails.env.development? || Lesli.config.demo 
     load LesliAudit::Engine.root.join("db", "seed", "requests.rb")
     load LesliAudit::Engine.root.join("db", "seed", "devices.rb")
+    load LesliAudit::Engine.root.join("db", "seed", "users.rb")
 end

data/lib/lesli_audit/engine.rb

@@ -3,6 +3,12 @@ module LesliAudit
     class Engine < ::Rails::Engine
         isolate_namespace LesliAudit
 
+        config.to_prepare do
+            unless Lesli::User < LesliAudit::UserAssociations
+                Lesli::User.include(LesliAudit::UserAssociations)
+            end
+        end
+
         initializer :lesli_admin do |app|
 
             # register assets manifest

data/lib/lesli_audit/version.rb

@@ -1,4 +1,4 @@
 module LesliAudit
-    VERSION = "1.0.2"
-    BUILD = "1771710537"
+    VERSION = "1.1.1"
+    BUILD = "1791607001"
 end

data/readme.md

@@ -1,14 +1,15 @@
 <div align="center">
-    <img width="100" alt="LesliAudit logo" src="./app/assets/images/lesli_audit/audit-logo.svg" />
-    <h3 align="center">Activity, logs, security and more... for the Lesli Framework.</h3>
+    <h1 align="center">
+        <img width="100" alt="LesliAudit" src="./app/assets/images/lesli_audit/audit-logo.svg" />
+    </h1>
+    <h3 align="center">Audit trails and analytics for the Lesli Framework.</h3>
 </div>
 
 <br />
-<hr/>
 
 <div align="center">
-    <a target="_blank" href="https://github.com/LesliTech/LesliAudit/actions">
-        <img alt="Tests passing" src="https://img.shields.io/badge/Tests-passing-green?style=for-the-badge&logo=github">
+    <a target="_blank" href="https://github.com/LesliTech/LesliAudit/actions/workflows/lesli-ci-tests.yaml">
+        <img alt="LesliAudit test status" src="https://img.shields.io/github/actions/workflow/status/LesliTech/LesliAudit/lesli-ci-tests.yaml?branch=master&style=for-the-badge&logo=github&label=tests">
     </a>
     <a target="_blank" href="https://rubygems.org/gems/lesli_audit">
         <img alt="Gem Version" src="https://img.shields.io/gem/v/lesli_audit?style=for-the-badge&logo=ruby">
@@ -16,83 +17,149 @@
     <a target="_blank" href="https://codecov.io/github/LesliTech/LesliAudit">
         <img alt="Codecov" src="https://img.shields.io/codecov/c/github/LesliTech/LesliAudit?style=for-the-badge&logo=codecov">
     </a>
+    <a target="_blank" href="https://sonarcloud.io/project/overview?id=LesliTech_LesliAudit">
+        <img alt="Sonar Quality Gate" src="https://img.shields.io/sonar/quality_gate/LesliTech_LesliAudit?server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge&logo=sonarqubecloud&label=Quality">
+    </a>
 </div>
 
-<hr/>
 <br />
 
 <div align="center">
     <img
         style="width:100%;max-width:800px;border-radius:6px;"
-        alt="Lesli screenshot" src="./docs/images/screenshot.png" />
+        alt="LesliAudit activity and request history"
+        src="./docs/images/screenshot.png" />
 </div>
 
+---
+
+<br />
+
+## Introduction
+
+LesliAudit is the official audit trail and analytics engine for the [Lesli Framework](https://github.com/LesliTech/Lesli).
+
+It records account activity and provides administrators with searchable operational history and usage insights.
+
 <br />
-<hr/>
+
+## Features
+
+- Account activity and audit logs
+- Request and navigation history
+- Visitor and authenticated-user analytics
+- Device and user-agent information
+- Detailed views for investigating recorded activity
+
+<br />
+
+## Try LesliAudit
+
+- [Try the online demo](https://demo.lesli.dev/)
+- [Run the Docker demo](https://github.com/LesliTech/lesli-docker-demo)
+
 <br />
 
-### Installation
+## Quick Start
+
+### Requirements
+
+- A Rails application with [Lesli](https://rubygems.org/gems/lesli)
+- SQLite by default, or PostgreSQL when preferred by the host application
+
+### Install LesliAudit
+
+Add the engine to the host Rails application and prepare its database:
 
 ```shell
-# Add LesliAudit engine gem
 bundle add lesli_audit
+bin/rails lesli:db:prepare
+```
+
+### Mount the engine
 
-# Setup & initialize the database
-rake lesli:db:setup
+Applications using Lesli's standard router mount LesliAudit automatically at `/audit`:
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+    Lesli::Router.mount(self)
+end
 ```
 
+If the application does not use the standard Lesli router, mount the engine directly:
+
 ```ruby
-# Load LesliAudit engine
+# config/routes.rb
 Rails.application.routes.draw do
     mount LesliAudit::Engine => "/audit"
 end
 ```
 
-<br />
-<hr/>
+Start Rails and visit [http://127.0.0.1:3000/audit](http://127.0.0.1:3000/audit):
+
+```shell
+bin/rails server
+```
+
 <br />
 
-### Development 
+## Development
+
+Clone LesliAudit into the host application's `engines` directory:
 
 ```shell
-# clone the lesli repo inside your engine folder: RailsApp/engines
-git clone https://github.com/LesliTech/LesliAudit.git
+cd RailsApp
+mkdir -p engines
+git clone https://github.com/LesliTech/LesliAudit.git engines/LesliAudit
+```
 
-# Load LesliAudit as a Gem
-gem "lesli", path: "engines/LesliAudit"
+Reference the local engine from the host application's `Gemfile`:
 
-# Install the necessary Gems to run LesliAudit
+```ruby
+gem "lesli_audit", path: "engines/LesliAudit"
+```
+
+Install dependencies, prepare the host database, and start Rails:
+
+```shell
 bundle install
+bin/rails lesli:db:prepare
+bin/rails server
+```
+
+### Tests
 
-# Setup & initialize the database
-rake lesli:db:setup
+From a complete Lesli development workspace, run the engine test suite from the LesliAudit directory:
 
+```shell
+cd engines/LesliAudit
+bin/rails test
 ```
 
 <br />
-<hr/>
-<br />
-
-### Demo
 
-* [online demo](https://demo.lesli.dev/)
-* [docker demo](https://github.com/LesliTech/lesli-docker-demo)
+## Documentation
 
+- [Lesli website](https://www.lesli.dev/)
+- [Documentation](https://www.lesli.dev/engines/audit)
+- [Frontend development](./docs/about/frontend.md)
+- [Release notes](https://github.com/LesliTech/LesliAudit/releases)
+- [Issue tracker](https://github.com/LesliTech/LesliAudit/issues)
+- [Source code](https://github.com/LesliTech/LesliAudit)
 
-### Documentation
-* [website](https://www.lesli.dev/)
-* [documentation](https://www.lesli.dev/engines/audit)
+<br />
 
+## Community
 
-### Connect with Lesli
+- [X: @LesliTech](https://x.com/LesliTech)
+- [hello@lesli.tech](mailto:hello@lesli.tech)
+- [https://www.lesli.tech](https://www.lesli.tech)
 
-* [X: @LesliTech](https://x.com/LesliTech)
-* [Email: hello@lesli.tech](hello@lesli.tech)
-* [Website: https://www.lesli.tech](https://www.lesli.tech)
+<br />
 
+## License
 
-### License
--------
 Copyright (c) 2026, Lesli Technologies, S. A.
 
 This program is free software: you can redistribute it and/or modify
@@ -106,19 +173,16 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
-along with this program. If not, see http://www.gnu.org/licenses/.
+along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).
 
-<br />
-<hr />
-<br />
-<br />
+The complete license text is available in the [license file](./license).
 
-<div align="center" class="has-text-centered">
-    <img width="200" alt="Lesli logo" src="https://cdn.lesli.tech/lesli/brand/app-logo.svg" />
-    <h3 align="center" class="mt-0">
-        The Open-Source SaaS Development Framework for Ruby on Rails.
-    </h3>
-</div>
+---
 
 <br />
 <br />
+
+<div align="center">
+    <img width="80" alt="Lesli icon" src="https://cdn.lesli.tech/lesli/brand/app-icon.svg" />
+    <h3 align="center">The Open-Source SaaS Development Framework for Ruby on Rails.</h3>
+</div>