trackguard 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90c710c8d2149047c75e5b99151b708e9741e29385d17de7c4f101ad9db697cf
-  data.tar.gz: 49aaf485a932c241d9c18986120f639305485f4c316653923e9ad9a018566e01
+  metadata.gz: 3e13b68029bc80d015c4f69531d17e5b362092d6df2d720dfb7c1563b5b4e24c
+  data.tar.gz: e676a88de14a04d1c42c0a78f7e895a7ef5011c7567e93a168e82e8f950bfeb1
 SHA512:
-  metadata.gz: b1a17b99009baaacee17c4473bf33b811870df411541cee1c055807f2b8981b4ab09ba0c28eeee15adc0a8ab87081f6b463b494435618cafafb2aea424b95226
-  data.tar.gz: 8da17d592514268ced0ab53cb0c2331671eea10702deaac46264f90874f2af33e60f952a1c89b7c1f920b6ad35ad93297bfe6ab786c796816c3704d35a17424d
+  metadata.gz: d4074d349ac565380d3365ef21ca99e61836601f51fe5822cff34a3184f93cea71dc0ab541b2a08f2f0ccb49fade36c89a97f8681a5609748088ecdb661f6f84
+  data.tar.gz: 1783d02fa8caedd5816efce4cca6faab7c305af260549de8ece369c22ff47b279725e9503dc5c3d8cade1f5069516faaee594fd362e16b92939317168f4d7dfc

data/app/controllers/concerns/trackguard/admin/overridable.rb

@@ -0,0 +1,29 @@
+module Trackguard
+  module Admin
+    module Overridable
+      extend ActiveSupport::Concern
+
+      private
+
+      def visitor_scope
+        Visitor.all
+      end
+
+      def page_view_scope
+        PageView.all
+      end
+
+      def after_action_path
+        dashboard_path
+      end
+
+      def set_visitor
+        @visitor = if params[:ip].present?
+                     visitor_scope.find_by!(ip: params[:ip])
+                   else
+                     visitor_scope.find(params[:id])
+                   end
+      end
+    end
+  end
+end

data/app/controllers/trackguard/admin/analytics_controller.rb

@@ -1,46 +1,25 @@
 module Trackguard
   module Admin
     class AnalyticsController < BaseController
+      include Overridable
+
       skip_before_action :verify_authenticity_token, if: :valid_api_token?
 
-      # rubocop:disable Metrics/AbcSize
       def show
-        @total_today  = PageView.today.count
-        @total_week   = PageView.this_week.count
-        @total_month  = PageView.this_month.count
-
-        base = time_scope
-        @top_pages     = base.group(:path).order("count_all DESC").limit(10).count
-        @top_referrers = base.with_referrer.group(:referer).order("count_all DESC").limit(10).count
-        @top_sources   = base.with_source.group(:source).order("count_all DESC").limit(10).count
-
-        @recent = visitor_filtered(
-          time_scope(PageView.order(created_at: :desc).limit(20).includes(visitor: :whitelisted_ip))
+        query = AnalyticsQuery.call(
+          scope: page_view_scope,
+          time_scope: apply_time_scope(page_view_scope),
+          limit: 10
         )
 
         render json: {
-          totals: { today: @total_today, week: @total_week, month: @total_month },
-          top_pages: @top_pages,
-          top_referrers: @top_referrers,
-          top_sources: @top_sources,
-          recent: @recent.map do |pv|
-            {
-              path: pv.path,
-              ip: pv.visitor&.ip,
-              flagged_at: pv.visitor.flagged_at,
-              flagged_by: pv.visitor.flagged_by,
-              whitelisted: pv.visitor.whitelisted_ip&.active? || false,
-              user_agent: pv.user_agent,
-              session_id: pv.session_id,
-              trace_id: pv.trace_id,
-              referer: pv.referer,
-              source: pv.source,
-              created_at: pv.created_at
-            }
-          end
+          totals: query.totals,
+          top_pages: query.top_pages,
+          top_referrers: query.top_referrers,
+          top_sources: query.top_sources,
+          recent: visitor_filtered(apply_time_scope(query.recent)).map { |view| serialize_page_view(view) }
         }
       end
-      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -50,7 +29,7 @@ module Trackguard
         super
       end
 
-      def time_scope(base = PageView.all)
+      def apply_time_scope(base)
         params[:since].present? ? base.where(created_at: parsed_since..) : base.last_30
       end
 
@@ -64,8 +43,8 @@ module Trackguard
 
       def visitor_filtered(scope)
         if params.key?(:flagged)
-          visitor_scope = cast_bool(params[:flagged]) ? Visitor.flagged : Visitor.unflagged
-          scope = scope.joins(:visitor).merge(visitor_scope)
+          flagged_scope = cast_bool(params[:flagged]) ? Visitor.flagged : Visitor.unflagged
+          scope = scope.joins(:visitor).merge(flagged_scope)
         end
         if params.key?(:whitelisted)
           scope = if cast_bool(params[:whitelisted])
@@ -80,6 +59,22 @@ module Trackguard
       def cast_bool(val)
         ActiveRecord::Type::Boolean.new.cast(val)
       end
+
+      def serialize_page_view(view)
+        {
+          path: view.path,
+          ip: view.visitor&.ip,
+          flagged_at: view.visitor.flagged_at,
+          flagged_by: view.visitor.flagged_by,
+          whitelisted: view.visitor.whitelisted_ip&.active? || false,
+          user_agent: view.user_agent,
+          session_id: view.session_id,
+          trace_id: view.trace_id,
+          referer: view.referer,
+          source: view.source,
+          created_at: view.created_at
+        }
+      end
     end
   end
 end

data/app/controllers/trackguard/admin/blocked_user_agents_controller.rb

@@ -12,7 +12,7 @@ module Trackguard
         Rails.cache.delete(BlockedUserAgent::CACHE_KEY)
         render json: { status: "ok", pattern: record.pattern }
       rescue ActionController::ParameterMissing, ActiveRecord::RecordInvalid => e
-        render json: { status: "error", message: e.message }, status: :unprocessable_entity
+        render json: { status: "error", message: e.message }, status: :unprocessable_content
       end
 
       private

data/app/controllers/trackguard/admin/dashboards_controller.rb

@@ -1,16 +1,22 @@
 module Trackguard
   module Admin
     class DashboardsController < BaseController
-      def show
-        @total_today  = PageView.today.count
-        @total_week   = PageView.this_week.count
-        @total_month  = PageView.this_month.count
+      include Overridable
 
-        @top_pages     = PageView.last_30.group(:path).order("count_all DESC").limit(5).count
-        @top_referrers = PageView.last_30.with_referrer.group(:referer).order("count_all DESC").limit(5).count
-        @top_sources   = PageView.last_30.with_source.group(:source).order("count_all DESC").limit(5).count
+      def show
+        query = AnalyticsQuery.call(
+          scope: page_view_scope,
+          time_scope: page_view_scope.last_30,
+          limit: 5
+        )
 
-        @recent = PageView.order(created_at: :desc).limit(20).includes(visitor: :whitelisted_ip)
+        @total_today   = query.totals[:today]
+        @total_week    = query.totals[:week]
+        @total_month   = query.totals[:month]
+        @top_pages     = query.top_pages
+        @top_referrers = query.top_referrers
+        @top_sources   = query.top_sources
+        @recent        = query.recent
       end
     end
   end

data/app/controllers/trackguard/admin/visitors_controller.rb

@@ -1,12 +1,14 @@
 module Trackguard
   module Admin
     class VisitorsController < BaseController
+      include Overridable
+
       skip_before_action :verify_authenticity_token, if: :valid_api_token?
       before_action :set_visitor
 
       rescue_from ActiveRecord::RecordNotFound do
         respond_to do |format|
-          format.html { redirect_to dashboard_path, alert: "Visitor not found." }
+          format.html { redirect_to after_action_path, alert: "Visitor not found." }
           format.json { render json: { error: "Visitor not found" }, status: :not_found }
         end
       end
@@ -20,13 +22,13 @@ module Trackguard
           name: params[:name].presence || BlockedUserAgent.matching_pattern(@visitor.user_agent)
         )
           respond_to do |format|
-            format.html { redirect_back_or_to dashboard_path }
+            format.html { redirect_back_or_to after_action_path }
             format.json { render json: { status: "ok", ip: @visitor.ip, flagged_at: @visitor.flagged_at } }
           end
         else
           respond_to do |format|
-            format.html { redirect_back_or_to dashboard_path, alert: @visitor.errors.full_messages.join(", ") }
-            format.json { render json: { errors: @visitor.errors.full_messages }, status: :unprocessable_entity }
+            format.html { redirect_back_or_to after_action_path, alert: @visitor.errors.full_messages.join(", ") }
+            format.json { render json: { errors: @visitor.errors.full_messages }, status: :unprocessable_content }
           end
         end
       end
@@ -35,7 +37,7 @@ module Trackguard
       def unflag
         @visitor.update!(flagged_at: nil, flag_reason: nil, flagged_by: nil)
         respond_to do |format|
-          format.html { redirect_back_or_to dashboard_path }
+          format.html { redirect_back_or_to after_action_path }
           format.json { render json: { status: "ok", ip: @visitor.ip } }
         end
       end
@@ -47,14 +49,6 @@ module Trackguard
 
         super
       end
-
-      def set_visitor
-        @visitor = if params[:ip].present?
-                     Visitor.find_by!(ip: params[:ip])
-                   else
-                     Visitor.find(params[:id])
-                   end
-      end
     end
   end
 end

data/app/controllers/trackguard/admin/visits_controller.rb

@@ -1,16 +1,18 @@
 module Trackguard
   module Admin
     class VisitsController < BaseController
+      include Overridable
+
       PER_PAGE = 20
 
       def index
         @page   = [ (params[:page] || 1).to_i, 1 ].max
-        @total  = PageView.count
+        @total  = page_view_scope.count
         @pages  = (@total.to_f / PER_PAGE).ceil
-        @visits = PageView.order(created_at: :desc)
-                          .limit(PER_PAGE)
-                          .offset((@page - 1) * PER_PAGE)
-                          .includes(visitor: :whitelisted_ip)
+        @visits = page_view_scope.order(created_at: :desc)
+                                 .limit(PER_PAGE)
+                                 .offset((@page - 1) * PER_PAGE)
+                                 .includes(visitor: :whitelisted_ip)
       end
     end
   end

data/app/controllers/trackguard/admin/whitelisted_ips_controller.rb

@@ -1,12 +1,14 @@
 module Trackguard
   module Admin
     class WhitelistedIpsController < BaseController
+      include Overridable
+
       skip_before_action :verify_authenticity_token, if: :valid_api_token?
       before_action :set_visitor
 
       rescue_from ActiveRecord::RecordNotFound do
         respond_to do |format|
-          format.html { redirect_to dashboard_path, alert: "Visitor not found." }
+          format.html { redirect_to after_action_path, alert: "Visitor not found." }
           format.json { render json: { error: "Visitor not found" }, status: :not_found }
         end
       end
@@ -17,13 +19,13 @@ module Trackguard
         record.expires_at = params[:expires_at].presence || 7.days.from_now
         record.save!
         respond_to do |format|
-          format.html { redirect_back_or_to dashboard_path }
+          format.html { redirect_back_or_to after_action_path }
           format.json { render json: { status: "ok", ip: @visitor.ip, expires_at: record.expires_at } }
         end
       rescue ActiveRecord::RecordInvalid => e
         respond_to do |format|
-          format.html { redirect_back_or_to dashboard_path, alert: e.message }
-          format.json { render json: { status: "error", message: e.message }, status: :unprocessable_entity }
+          format.html { redirect_back_or_to after_action_path, alert: e.message }
+          format.json { render json: { status: "error", message: e.message }, status: :unprocessable_content }
         end
       end
 
@@ -33,12 +35,12 @@ module Trackguard
         if record
           record.destroy!
           respond_to do |format|
-            format.html { redirect_back_or_to dashboard_path }
+            format.html { redirect_back_or_to after_action_path }
             format.json { render json: { status: "ok", ip: @visitor.ip } }
           end
         else
           respond_to do |format|
-            format.html { redirect_back_or_to dashboard_path, alert: "No whitelist entry found." }
+            format.html { redirect_back_or_to after_action_path, alert: "No whitelist entry found." }
             format.json { render json: { error: "Not whitelisted" }, status: :not_found }
           end
         end
@@ -51,14 +53,6 @@ module Trackguard
 
         super
       end
-
-      def set_visitor
-        @visitor = if params[:ip].present?
-                     Visitor.find_by!(ip: params[:ip])
-                   else
-                     Visitor.find(params[:id])
-                   end
-      end
     end
   end
 end

data/app/services/trackguard/analytics_query.rb

@@ -0,0 +1,27 @@
+module Trackguard
+  class AnalyticsQuery < ApplicationService
+    attr_reader :totals, :top_pages, :top_referrers, :top_sources, :recent
+
+    def initialize(scope:, time_scope:, limit:)
+      @scope      = scope
+      @time_scope = time_scope
+      @limit      = limit
+    end
+
+    def call
+      @totals = {
+        today: @scope.today.count,
+        week: @scope.this_week.count,
+        month: @scope.this_month.count
+      }
+
+      @top_pages     = @time_scope.group(:path).order("count_all DESC").limit(@limit).count
+      @top_referrers = @time_scope.with_referrer.group(:referer).order("count_all DESC").limit(@limit).count
+      @top_sources   = @time_scope.with_source.group(:source).order("count_all DESC").limit(@limit).count
+
+      @recent = @scope.order(created_at: :desc).limit(20).includes(visitor: :whitelisted_ip)
+
+      self
+    end
+  end
+end

data/lib/generators/trackguard/templates/create_trackguard_tables.rb

@@ -2,6 +2,7 @@ class CreateTrackguardTables < ActiveRecord::Migration[<%= ActiveRecord::Migrati
   def change
     create_table :trackguard_visitors do |t|
       t.string   :ip
+      t.string   :name
       t.string   :user_agent
       t.datetime :first_seen_at, null: false
       t.datetime :last_seen_at,  null: false

data/lib/trackguard/version.rb

@@ -1,3 +1,3 @@
 module Trackguard
-  VERSION = "0.19.0".freeze
+  VERSION = "0.20.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackguard
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Krzysztof Rygielski
@@ -46,6 +46,7 @@ files:
 - app/assets/images/trackguard/logo.png
 - app/assets/javascripts/controllers/page_tracker_controller.js
 - app/assets/stylesheets/trackguard/admin.css
+- app/controllers/concerns/trackguard/admin/overridable.rb
 - app/controllers/concerns/trackguard/page_tracker.rb
 - app/controllers/trackguard/admin/analytics_controller.rb
 - app/controllers/trackguard/admin/base_controller.rb
@@ -65,6 +66,7 @@ files:
 - app/models/trackguard/visit.rb
 - app/models/trackguard/visitor.rb
 - app/models/trackguard/whitelisted_ip.rb
+- app/services/trackguard/analytics_query.rb
 - app/services/trackguard/application_service.rb
 - app/services/trackguard/page_view_recorder.rb
 - app/views/layouts/trackguard/admin.html.erb