lesli_audit 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff9465d4d130455ae1ef9804d86e17e54754708857234684a0d99237f8545770
-  data.tar.gz: 3455cb58ed202920a07a0faacf21ced66b421201a2832206e22c0495bff8d05c
+  metadata.gz: 6a84c6870b0006a5609054e1c8a311a0b9d57a5220dc8c75c7841eae7ffd1e8c
+  data.tar.gz: 882412cf089844f7c36bb58d492396c521e673374e2a13da8dcd466c23a5dc7f
 SHA512:
-  metadata.gz: 32ea636b6528c49201ba30eb2e972deaeca0ea47bf625f5e8815a81fec5dbb83bdb3c4f450c014cb33f3eef2b9e5b040acaf8a887410d3117880e89a3736dfc6
-  data.tar.gz: 21ee15b705797e0f6871a7432b7044b85bdaee377b376b55f568d77a329e9be51bcfc6426c80290c4ec0c08dab47fa2b8da11024c59751d3af23e7ce0e8c9256
+  metadata.gz: f3d60b2ebcd66549072ace0988c2c4ca40b832c2c50173960b9db99b9c4184d4c65488197633718aacaa568b10144d592d842f667430732cc57d8665e1055fc9
+  data.tar.gz: 7f2c3f56961cb0aaf60dab530de6a7fd30eaf29a64cfafbc84623ee96c50e7162581c9728adf5894fd68f1d290946f49e1136456a913c00cf80cd8ebe4128fd4

data/app/controllers/lesli_audit/users_controller.rb

@@ -34,8 +34,7 @@ module LesliAudit
 
         # GET /users
         def index
-            @requests = UserService.new(current_user, query).requests
-            @registrations = UserService.new(current_user, query).registrations
+            @users = UserService.new(current_user, query).users
             @working_hours = UserService.new(current_user, query).working_hours
         end
     end

data/app/controllers/lesli_audit/visitors_controller.rb

@@ -0,0 +1,14 @@
+module LesliAudit
+    class VisitorsController < ApplicationController
+
+        # GET /analytics
+        def index
+            @visits = VisitorService.new(current_user, query).visits
+            @visitors = VisitorService.new(current_user, query).visitors
+            @requests = VisitorService.new(current_user, query).requests
+            @browsers = VisitorService.new(current_user, query).browsers
+            @devices = VisitorService.new(current_user, query).devices
+            @os = VisitorService.new(current_user, query).os
+        end
+    end
+end

data/app/interfaces/lesli_audit/logger_interface.rb

@@ -29,35 +29,28 @@ Building a better future, one line of code at a time.
 // · ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~     ~·~
 // · 
 =end
-
+require 'device_detector'
 module LesliAudit
     module LoggerInterface
         def get_user_agent(as_string=true)
 
-            http_user_agent = request.env["HTTP_USER_AGENT"]
-
             # parse user agent
-            user_agent = UserAgent.parse(http_user_agent)
+            user_agent = DeviceDetector.new(request.env["HTTP_USER_AGENT"])
 
-            user_agent_version = user_agent.version.to_a.first(2).join(".")
+            #user_agent_version = user_agent.version.to_a.first(2).join(".")
 
             # return user agent as object
-            if as_string == false
-                return {
-                    platform: user_agent.platform,
-                    os: user_agent.os,
-                    browser: user_agent.browser,
-                    version: user_agent_version
-                }
-            end
-
-            # return user agent info as string
-            "#{user_agent.platform} #{user_agent.os} - #{user_agent.browser} #{user_agent_version}"
+            {
+                platform: user_agent.os_name,
+                browser: user_agent.name,
+                device: user_agent.device_type
+            }
         end
 
         def log_requests
             log_account_requests
             log_user_requests
+            log_devices
         end 
 
         def log_account_requests
@@ -86,17 +79,7 @@ module LesliAudit
         def log_user_requests
             return unless current_user
             return unless session[:user_session_id]
-
-            current_user.account.audit.user_journals.create({
-                request_controller: controller_path,
-                request_action: action_name,
-                session_id: session[:user_session_id],
-                user_id: current_user.id,
-                date: Date2.new.date.to_s
-            }) if Lesli.config.audit.dig(:enable_journals)
-            
-            # Determine the correct SQL "now" keyword based on the database connection
-            now_func = ActiveRecord::Base.connection.adapter_name =~ /sqlite/i ? 'CURRENT_TIMESTAMP' : 'NOW()'
+            return unless Lesli.config.audit.dig(:enable_analytics)
 
             # Try to save a unique record for this request configuration
             current_user.account.audit.user_requests.upsert(
@@ -118,7 +101,16 @@ module LesliAudit
                 on_duplicate: Arel.sql(
                     "request_count = lesli_audit_user_requests.request_count + 1,updated_at = #{LesliDate::Compatibility.db_now}"
                 )
-            ) if Lesli.config.audit.dig(:enable_analytics)
+            ) 
+
+            return unless Lesli.config.audit.dig(:enable_journals)
+            current_user.account.audit.user_journals.create({
+                request_controller: controller_path,
+                request_action: action_name,
+                session_id: session[:user_session_id],
+                user_id: current_user.id,
+                date: Date2.new.date.to_s
+            }) 
         end
 
         def log_devices
@@ -133,11 +125,12 @@ module LesliAudit
                     :created_at => Date2.new.date.to_s,
                     :agent_platform => user_agent&.dig(:platform) || "unknown",
                     :agent_browser => user_agent&.dig(:browser) || "unknown",
+                    :agent_device => user_agent&.dig(:device) || "unknown",
                     :agent_count => 1
                 },
 
                 # group of columns to consider a request as unique
-                unique_by: %i[agent_platform agent_browser created_at account_id],
+                unique_by: %i[agent_platform agent_browser agent_device created_at account_id],
 
                 # if request id is not unique
                 #   - increase the counter for this configuration

data/app/services/lesli_audit/user_service.rb

@@ -33,17 +33,104 @@ Building a better future, one line of code at a time.
 module LesliAudit
     class UserService < Lesli::ApplicationLesliService
 
-        def requests
-            current_user.account.audit.user_requests
-            .joins(:user)
-            .group(:email)
-            .limit(5)
-            .order("requests DESC")
-            .select(
-                :email,
-                "count(lesli_audit_user_requests.id) resources", 
-                "sum(lesli_audit_user_requests.request_count) requests"
+        def users
+            users = current_user.account.users
+
+            now = Time.current
+            last_30_days = 30.days.ago
+
+            stats = users.pick(
+                # total users 
+                Arel.sql("COUNT(*)"),
+
+                # total deactivated users 
+                Arel.sql("SUM(CASE WHEN active = 0 AND deleted_at IS NULL THEN 1 ELSE 0 END)"),
+
+                # total locked users 
+                Arel.sql(
+                    "SUM(CASE WHEN (
+                        locked_at IS NOT NULL
+                        OR locked_until > #{ActiveRecord::Base.connection.quote(Time.current)}
+                    ) AND deleted_at IS NULL THEN 1 ELSE 0 END)"
+                ),
+
+                # total not confirmed users
+                Arel.sql("SUM(CASE WHEN confirmed_at IS NULL AND deleted_at IS NULL THEN 1 ELSE 0 END)"),
+
+                # total deleted users 
+                Arel.sql("SUM(CASE WHEN deleted_at IS NOT NULL THEN 1 ELSE 0 END)"),
+
+                # users that never signed in 
+                Arel.sql("SUM(CASE WHEN last_sign_in_at IS NULL AND deleted_at IS NULL THEN 1 ELSE 0 END)"),
+
+                # total active users for the last 30 days 
+                Arel.sql("SUM(CASE WHEN last_sign_in_at >= #{ActiveRecord::Base.connection.quote(last_30_days)} AND deleted_at IS NULL THEN 1 ELSE 0 END)"),
+
+                # users with failed logins
+                Arel.sql("SUM(CASE WHEN failed_attempts > 0 AND deleted_at IS NULL THEN 1 ELSE 0 END)"),
             )
+
+            summary = { 
+                total_users: stats[0].to_i, 
+                total_users_deactivated: stats[1].to_i, 
+                total_users_locked: stats[2].to_i, 
+                total_users_unconfirmed: stats[3].to_i, 
+                total_users_deleted: stats[4].to_i,
+
+                total_users_never_signed_in: stats[5].to_i, 
+                total_users_active_last_30_days: stats[6].to_i, 
+                total_users_with_failed_attempts: stats[7].to_i
+            }
+
+            {
+                overview: [{
+                    label: "Total users",
+                    value: summary[:total_users],
+                    percentage: 100,
+                    color: "info"
+                }, {
+                    label: "Deactivated users",
+                    value: summary[:total_users_deactivated],
+                    percentage: percentage(summary[:total_users_deactivated], summary[:total_users]),
+                    color: "warning"
+                }, {
+                    label: "Locked users",
+                    value: summary[:total_users_locked],
+                    percentage: percentage(summary[:total_users_locked], summary[:total_users]),
+                    color: "danger"
+                }, {
+                    label: "Unconfirmed users",
+                    value: summary[:total_users_unconfirmed],
+                    percentage: percentage(summary[:total_users_unconfirmed], summary[:total_users]),
+                    color: "warning",
+                }, {
+                    label: "Deleted users",
+                    value: summary[:total_users_deleted],
+                    percentage: percentage(summary[:total_users_deleted], summary[:total_users]),
+                    color: "danger"
+                }],
+                attention_needed: [{
+                    label: "Unconfirmed users",
+                    value: summary[:total_users_unconfirmed],
+                    color: "info",
+                    icon: "user-add-line"
+                }, {
+                    label: "Never signed in",
+                    value: summary[:total_users_never_signed_in],
+                    color: "warning",
+                    icon: "time-line"
+                }, {
+                    label: "Failed login attempts",
+                    value: summary[:total_users_with_failed_attempts],
+                    color: "danger",
+                    icon: "shield-keyhole-line"
+                }, {
+                    label: "Locked users",
+                    value: summary[:total_users_locked],
+                    color: "danger",
+                    icon: "lock-line"
+                }]
+            }
         end
 
         def working_hours
@@ -72,8 +159,7 @@ module LesliAudit
                 "sum(lesli_audit_user_requests.request_count) requests"
             )
            
-            user_requests = user_requests
-                .group(:user_id, group_by)
+            user_requests = user_requests.group(:user_id, group_by)
 
             user_requests.map do |request|
                 request[:first_activity] = Date2.new(request[:first_activity]).time
@@ -118,5 +204,12 @@ module LesliAudit
 
             registrations
         end
+
+        private 
+
+        def percentage(value, total)
+            return 0 if total.to_i.zero?
+            ((value.to_f / total) * 100).round
+        end
     end
 end

data/app/services/lesli_audit/{analytic_service.rb → visitor_service.rb}

@@ -31,15 +31,22 @@ Building a better future, one line of code at a time.
 =end
 
 module LesliAudit
-    class AnalyticService < Lesli::ApplicationLesliService
+    class VisitorService < Lesli::ApplicationLesliService
 
-        LIMIT=5
+        def visits
+            requests = current_user.account.audit.account_requests
+
+            controllers, total_requests = requests.pick(
+                Arel.sql("COUNT(DISTINCT request_controller)"),
+                Arel.sql("SUM(request_count)")
+            )
+
+            {
+                controllers: controllers.to_i,
+                requests: total_requests.to_i
+            }
+        end 
 
-        # @overwrite
-        # @return {Hash} Paginated list of the records
-        # @param {query} Has of the formated queries/filters that will be applied to filter data
-        # @description
-        # @example
         def visitors 
             #Rails.cache.fetch(cache_key_for_account(__method__), expires_in: 1.hour) do 
                 group = 'day' 
@@ -70,7 +77,7 @@ module LesliAudit
 
         def requests
             requests = current_user.account.audit.account_requests
-            .group("request_controller").limit(30)
+            .group("request_controller")
 
             requests = apply_filters(requests, query)
 
@@ -80,32 +87,122 @@ module LesliAudit
             ).as_json
         end
 
+        def os 
+            device_counts = current_user.account.audit.account_devices
+            .group(:agent_platform)
+            .sum(:agent_count)
+
+            total = device_counts.values.sum
+
+            device_counts.map do |device, count|
+                {
+                    device: device,
+                    count: count,
+                    icon: platform_icon(device),
+                    percentage: total.zero? ? 0 : ((count.to_f / total) * 100).round()
+                }
+            end
+        end 
+
         def devices 
-            #Rails.cache.fetch(cache_key_for_account(__method__), expires_in: 4.hour) do 
-                current_user.account.audit.account_devices
-                .group(:agent_platform, :created_at)
-                .select(
-                    'created_at as xaxiskey',
-                    'agent_platform as dataname',
-                    'sum(agent_count) as yaxiskey'
-                ).as_json
-            #end
+            device_counts = current_user.account.audit.account_devices
+            .group(:agent_device)
+            .sum(:agent_count)
+
+            total = device_counts.values.sum
+
+            device_counts.map do |device, count|
+                {
+                    device: device,
+                    count: count,
+                    icon: device_icon(device),
+                    percentage: total.zero? ? 0 : ((count.to_f / total) * 100).round()
+                }
+            end
         end 
 
         def browsers
+            browser_counts = current_user.account.audit.account_devices
+            .group(:agent_browser)
+            .sum(:agent_count)
+
+            total = browser_counts.values.sum
+
+            browser_counts.map do |browser, count|
+                {
+                    browser: browser,
+                    count: count,
+                    icon: browser_icon(browser),
+                    percentage: total.zero? ? 0 : ((count.to_f / total) * 100).round()
+                }
+            end
             #Rails.cache.fetch(cache_key_for_account(__method__), expires_in: 4.hour) do 
-                current_user.account.audit.account_devices
-                .group(:agent_browser, :created_at)
-                .select(
-                    'created_at as xaxiskey',
-                    'agent_browser as dataname',
-                    'sum(agent_count) as yaxiskey'
-                ).as_json
+                # current_user.account.audit.account_devices
+                # .group(:agent_browser, :created_at)
+                # .select(
+                #     'created_at as xaxiskey',
+                #     'agent_browser as dataname',
+                #     'sum(agent_count) as yaxiskey'
+                # ).as_json
             #end
         end
 
         private 
 
+        LIMIT=15
+
+        DEFAULT_PLATFORM_ICON_CLASS = "computer-fill"
+        PLATFORM_ICON_CLASSES = {
+            /chrome os|cros/i           => "chrome-fill",
+            /ios|ipad|iphone|mac/i      => "apple-fill",
+            /windows/i                  => "windows-fill",
+            /ubuntu/i                   => "ubuntu-fill",
+            /debian|fedora|linux/i      => "linux-fill",
+            /android/i                  => "android-fill"
+        }.freeze
+
+        DEFAULT_BROWSER_ICON_CLASS = "global-fill"
+        BROWSER_ICON_CLASSES = {
+            /chrome|chromium/i        => "chrome-fill",
+            /firefox/i                => "firefox-fill",
+            /safari/i                 => "safari-fill",
+            /edge/i                   => "edge-fill",
+            /opera|opr/i              => "opera-fill",
+            /internet explorer|msie/i => "ie-fill",
+            /brave/i                  => "brave-fill"
+        }.freeze
+
+        DEVICE_ICON_CLASSES = {
+            "desktop"       => "mac-line",
+            "tablet"        => "tablet-line",
+            "smartphone"    => "smartphone-line",
+            "unknown"       => "file-unknow-line"
+        }.freeze
+
+        def platform_icon(platform)
+            return DEFAULT_PLATFORM_ICON_CLASS if platform.blank?
+
+            match = PLATFORM_ICON_CLASSES.find do |pattern, _icon_class|
+                platform.match?(pattern)
+            end
+
+            match ? match.last : DEFAULT_PLATFORM_ICON_CLASS
+        end
+
+        def browser_icon(browser)
+            return DEFAULT_BROWSER_ICON_CLASS if browser.blank?
+
+            match = BROWSER_ICON_CLASSES.find do |pattern, _icon_class|
+                browser.match?(pattern)
+            end
+
+            match ? match.last : DEFAULT_BROWSER_ICON_CLASS
+        end
+
+        def device_icon(device)
+            DEVICE_ICON_CLASSES.fetch(device.to_s, DEVICE_ICON_CLASSES["unknown"])
+        end
+
         def apply_filters requests, params
 
             return requests

data/app/views/lesli_audit/partials/_navigation.html.erb

@@ -33,6 +33,6 @@ Building a better future, one line of code at a time.
 %>
 
 <%= navigation_item(lesli_audit.users_path, 'Users', 'ri-team-line'); %>
-<%= navigation_item(lesli_audit.analytics_path, 'Analytics', 'ri-pie-chart-line'); %>
+<%= navigation_item(lesli_audit.visitors_path, 'Visitors', 'ri-line-chart-fill'); %>
 <%= navigation_item(lesli_audit.requests_path, 'Requests', 'ri-arrow-left-right-fill'); %>
 <%= navigation_item(lesli_audit.logs_path, 'Logs', 'ri-history-line'); %>

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

@@ -1,6 +1,6 @@
 <%= render(LesliView::Layout::Container.new("audit-requests")) do %>
     <%= render(LesliView::Components::Header.new("Requests")) %>
-    <%= render LesliView::Components::Toolbar.new() %>
+    <%= render(LesliView::Components::Toolbar.new()) %>
     <%= render(LesliView::Elements::Table.new(
         columns: [{
             label: "ID",

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

@@ -3,11 +3,41 @@
     <%= render(LesliView::Components::Header.new("Users")) %>
 
     <div class="columns">
+        <% @users[:overview].each do |user| %>
+            <div class="column">
+                <div class="box">
+                    <h4><%= user[:label] %></h4>
+                    <p class="is-size-3 has-text-<%= user[:color] %>"><%= user[:value] %></p>
+                </div>
+            </div>
+        <% end %>
+    </div>
+
+    <div class="columns">    
         <div class="column">
-            <%= render(LesliView::Charts::Bar.new(
-                title:"Registered users", 
-                database_to_dataset: @registrations.as_json
-            ))%>
+            <div class="box">
+                <%= render(LesliView::Elements::Table.new(columns: [])) do |table| %>
+                    <% @users[:attention_needed].each do |user| %>
+                        <% table.with_row(css_class:"is-white") do |row| %>
+                            <% row.with_cell(css_class:"") do %>
+                                <span class="icon has-text-<%= user[:color] %>">
+                                    <span class="is-size-4 ri-<%= user[:icon] %>"></span>
+                                </span>
+                            <% end %>
+                            <% row.with_cell(css_class:"is-fullwidth") do %>
+                                <%= user[:label] %>
+                            <% end %>
+                            <% row.with_cell(css_class:"has-text-right") do %>
+                                <span class="is-size-6 has-text-weight-bold">
+                                    <%= user[:value] %>
+                                </span>
+                            <% end %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            </div>
+        </div>
+        <div class="column is-three-fifths">
         </div>
     </div>
 
@@ -40,4 +70,6 @@
             )) %>
         </div>
     </div>
+
+    <br>
 <% end %>

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

@@ -0,0 +1,118 @@
+
+<% @visitors = @visitors.reverse %>
+<% top_days = (@visitors.last(3)) %>
+
+<%= render(LesliView::Layout::Container.new("audit-analytics")) do %>
+    <%= render(LesliView::Components::Header.new("Analytics")) %>
+
+    <div class="columns">
+        <div class="column">
+            <div class="box">
+                <h4>Controllers</h4>
+                <p class="is-size-3"><%= @visits[:controllers] %></p>
+            </div>
+        </div>
+        <div class="column">
+            <div class="box">
+                <h4>Requests</h4>
+                <p class="is-size-3"><%= @visits[:requests] %></p>
+            </div>
+        </div>
+        <% top_days.each do |day| %>
+            <div class="column">
+                <div class="box">
+                    <h4><%= day['xaxiskey'] %></h4>
+                    <p class="is-size-3"><%= day['yaxiskey'] %></p>
+                </div>
+            </div>
+        <% end %>
+    </div>
+
+    <div class="box">
+        <%= render(LesliView::Charts::Line.new(
+            title:"Visitors",
+            database_to_dataset: @visitors
+        ))%>
+    </div>
+
+    <div class="columns">
+        <div class="column">
+            <%= render(LesliView::Elements::Table.new(columns: [{label:'Browsers', align:'left'},{label:'Visitors', align:'center'}])) do |table| %>
+                <% @browsers.each do |browser| %>
+                    <% table.with_row(css_class:"") do |row| %>
+                        <% row.with_cell(css_class:"p-0") do %>
+                            <p style="padding:8px;background: linear-gradient(to right, #E5EAF0 <%= browser[:percentage] %>%, transparent 0%);">
+                                <span class="icon-text">
+                                    <span class="icon">
+                                        <span class="ri-<%= browser[:icon] %>"></span>
+                                    </span>
+                                    <span><%= browser[:browser] %></span>
+                                </span>
+                            </p>
+                        <% end %>
+                        <% row.with_cell(css_class:"has-text-centered") do %>
+                            <%= browser[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </div>
+        <div class="column">
+            <%= render(LesliView::Elements::Table.new(columns: [{label:'OS', align:'left'},{label:'Visitors', align:'center'}])) do |table| %>
+                <% @os.each do |device| %>
+                    <% table.with_row(css_class:"") do |row| %>
+                        <% row.with_cell(css_class:"p-0") do %>
+                            <p style="padding:8px;background: linear-gradient(to right, #E5EAF0 <%= device[:percentage] %>%, transparent 0%);">
+                                <span class="icon-text">
+                                    <span class="icon">
+                                        <span class="ri-<%= device[:icon].downcase %>"></span>
+                                    </span>
+                                    <span><%= device[:device] %></span>
+                                </span>
+                            </p>
+                        <% end %>
+                        <% row.with_cell(css_class:"has-text-centered") do %>
+                            <%= device[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </div>
+        <div class="column">
+            <%= render(LesliView::Elements::Table.new(columns: [{label:'Device', align:'left'},{label:'Visitors', align:'center'}])) do |table| %>
+                <% @devices.each do |device| %>
+                    <% table.with_row(css_class:"") do |row| %>
+                        <% row.with_cell(css_class:"p-0") do %>
+                            <p style="padding:8px;background: linear-gradient(to right, #E5EAF0 <%= device[:percentage] %>%, transparent 0%);">
+                                <span class="icon-text">
+                                    <span class="icon">
+                                        <span class="ri-<%= device[:icon] %>"></span>
+                                    </span>
+                                    <span><%= device[:device] %></span>
+                                </span>
+                            </p>
+                        <% end %>
+                        <% row.with_cell(css_class:"has-text-centered") do %>
+                            <%= device[:count] %>
+                        <% end %>
+                    <% end %>
+                <% end %>
+            <% end %>
+        </div>
+    </div>
+    
+    <div class="columns">
+        <div class="column">
+            <%= render(LesliView::Elements::Table.new(
+                columns: [{
+                    label: "Top controllers",
+                    field: "request_controller"
+                },{
+                    label:"Requests",
+                    field:"requests"
+                }],
+                records: @requests
+            )) %>
+        </div>
+    </div>
+<% 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