analytic 0.1.0 → 0.3.0

data/app/controllers/analytic/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Analytic
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/analytic/dashboard_controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Analytic
+  class DashboardController < ApplicationController
+    include Analytic::Trackable
+    before_action { analytic_track! }
+
+    # GET /
+    def show
+      @dashboard = Dashboard.new(period: params[:period])
+    end
+  end
+end

data/app/controllers/concerns/analytic/trackable.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Analytic
+  module Trackable
+    # @param params [Hash]
+    def analytic_track!
+      Analytic::View.create!(
+        timestamp: Time.current,
+        session_id: analytic_session_id,
+        visitor_id: analytic_visitor_id,
+        ip: analytic_ip,
+        host: analytic_host,
+        path: analytic_path,
+        referrer: analytic_referrer,
+        user_agent: request.user_agent,
+        params: analytic_params
+      )
+    end
+
+    # @param params [Hash]
+    def analytic_enqueue_track_job!
+      Analytic::TrackJob.perform_later(
+        session_id: analytic_session_id,
+        visitor_id: analytic_visitor_id,
+        ip: analytic_ip,
+        host: analytic_host,
+        path: analytic_path,
+        referrer: analytic_referrer,
+        user_agent: request.user_agent,
+        params: analytic_params
+      )
+    end
+
+    # @return [String]
+    def analytic_session_id
+      session[:analytic_session_id] ||= SecureRandom.uuid
+    end
+
+    # @return [String]
+    def analytic_visitor_id
+      cookies.permanent[:analytic_visitor_id] ||= SecureRandom.uuid
+    end
+
+    # @return [IPAddr]
+    def analytic_ip
+      ip_addr = IPAddr.new(request.remote_ip)
+
+      return ip_addr.mask(Analytic.config.ip_v4_mask) if Analytic.config.ip_v4_mask? && ip_addr.ipv4?
+      return ip_addr.mask(Analytic.config.ip_v6_mask) if Analytic.config.ip_v6_mask? && ip_addr.ipv6?
+
+      ip_addr
+    end
+
+    # @return [String]
+    def analytic_host
+      request.host
+    end
+
+    # @return [String]
+    def analytic_path
+      request.path
+    end
+
+    # @return [String]
+    def analytic_referrer
+      request.referer
+    end
+
+    # @return [String]
+    def analytic_user_agent
+      request.user_agent
+    end
+
+    # @return [Hash]
+    def analytic_params
+      params.permit(:utm_source, :utm_medium, :utm_campaign, :utm_term, :utm_content)
+    end
+  end
+end

data/app/helpers/analytic/application_helper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Analytic
+  module ApplicationHelper
+  end
+end

data/app/jobs/analytic/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Analytic
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/analytic/track_job.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Analytic
+  class TrackJob < ApplicationJob
+    queue_as :default
+
+    # @param timestamp [Timestamp]
+    # @param session_id [String]
+    # @param visitor_id [String]
+    # @param host [String]
+    # @param path [String]
+    # @param params [Hash]
+    def perform(session_id:, visitor_id:, host:, path:, ip:, timestamp: Time.current, params: {})
+      Analytic::View.create!(
+        timestamp:,
+        session_id:,
+        visitor_id:,
+        host:,
+        path:,
+        ip:,
+        params:
+      )
+    end
+  end
+end

data/app/mailers/analytic/application_mailer.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Analytic
+  class ApplicationMailer < ActionMailer::Base
+    layout 'mailer'
+  end
+end

data/app/models/analytic/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Analytic
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/analytic/dashboard.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Analytic
+  class Dashboard
+    PAGES_LIMIT = 8
+
+    # @param period [String] today, yesterday, week, month, year
+    def initialize(period:)
+      @period = period
+    end
+
+    # @return [Integer]
+    delegate :count, to: :views
+
+    # @return [Integer]
+    delegate :distinct_visitors_count, to: :views
+
+    # @return [Integer]
+    delegate :distinct_sessions_count, to: :views
+
+    # @return [String]
+    def name
+      if @period
+        "#{@period.capitalize} | Dashboard"
+      else
+        'Dashboard'
+      end
+    end
+
+    # @return [Array<Array(String, String, Integer)>]
+    def pages
+      views
+        .group(:host)
+        .group(:path)
+        .order(count: :desc)
+        .limit(PAGES_LIMIT)
+        .pluck(:host, :path, Arel.sql('COUNT(*) AS count'))
+    end
+
+    protected
+
+    # @return [Analytic::View::ActiveRecord_Relation]
+    def views
+      @views ||= Analytic::View.within(range)
+    end
+
+    # @return [Range<Time>]
+    def range
+      return unless @period
+
+      case @period
+      when 'today' then timezone.today.all_day
+      when 'yesterday' then timezone.yesterday.all_day
+      when 'week' then timezone.now.all_week
+      when 'month' then timezone.now.all_month
+      when 'year' then timezone.now.all_year
+      end
+    end
+
+    # @return [ActiveSupport::TimeZone]
+    def timezone
+      Analytic.config.timezone || Time.zone
+    end
+  end
+end

data/app/models/analytic/view.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Analytic
+  class View < ApplicationRecord
+    validates :timestamp, presence: true
+    validates :visitor_id, presence: true
+    validates :session_id, presence: true
+    validates :path, presence: true
+    validates :host, presence: true
+    validates :ip, presence: true
+
+    scope :within, ->(range) { where(timestamp: range) if range }
+
+    # @return [Integer]
+    def self.distinct_visitors_count
+      count('DISTINCT "analytic_views"."visitor_id"')
+    end
+
+    # @return [Integer]
+    def self.distinct_sessions_count
+      count('DISTINCT "analytic_views"."session_id"')
+    end
+  end
+end

data/app/packs/analytic/application/index.ts

@@ -0,0 +1 @@
+import "./initializers";

data/app/packs/analytic/application/initializers/fontawesome.ts

@@ -0,0 +1,23 @@
+import "@fortawesome/fontawesome-free";
+
+import { library } from "@fortawesome/fontawesome-svg-core";
+
+import { faClock } from "@fortawesome/free-solid-svg-icons/faClock";
+import { faEye } from "@fortawesome/free-solid-svg-icons/faEye";
+import { faFileCode } from "@fortawesome/free-solid-svg-icons/faFileCode";
+import { faGauge } from "@fortawesome/free-solid-svg-icons/faGauge";
+import { faGlobe } from "@fortawesome/free-solid-svg-icons/faGlobe";
+import { faHouse } from "@fortawesome/free-solid-svg-icons/faHouse";
+import { faSliders } from "@fortawesome/free-solid-svg-icons/faSliders";
+import { faUsers } from "@fortawesome/free-solid-svg-icons/faUsers";
+
+library.add(
+  faClock,
+  faEye,
+  faGauge,
+  faGlobe,
+  faHouse,
+  faSliders,
+  faUsers,
+  faFileCode
+);

data/app/packs/analytic/application/initializers/index.ts

@@ -0,0 +1 @@
+import "./fontawesome";

data/app/packs/analytic/entrypoints/application.tailwind.css

@@ -0,0 +1,65 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+@layer components {
+  .pill {
+    @apply bg-slate-200 text-slate-800 hover:text-white hover:bg-indigo-600 rounded-full px-3 py-2;
+  }
+
+  .card {
+    @apply shadow-md rounded bg-white;
+  }
+
+  .card__header {
+    @apply px-5 py-4 border-b border-slate-200;
+  }
+
+  .card__footer {
+    @apply px-5 py-4 border-t border-slate-200;
+  }
+
+  .card__content {
+    @apply px-5 py-4
+  }
+
+  .card__title {
+    @apply uppercase text-slate-600 font-semibold text-sm flex gap-2 items-center;
+  }
+
+  .card__value {
+    @apply uppercase text-slate-800 font-extrabold text-lg;
+  }
+
+  .table {
+    @apply w-full divide-y divide-slate-200;
+  }
+
+  .table tbody {
+    @apply divide-y divide-slate-200;
+  }
+
+  .table td {
+    @apply px-3 py-2 text-left;
+  }
+
+  .table th {
+    @apply px-3 py-2 text-left;
+  }
+
+  .table td:first-child {
+    @apply pl-0;
+  }
+
+  .table td:last-child {
+    @apply pr-0;
+  }
+
+  .table th:first-child {
+    @apply pl-0;
+  }
+
+  .table th:last-child {
+    @apply pr-0;
+  }
+}

data/app/packs/analytic/entrypoints/application.ts

@@ -0,0 +1 @@
+import "../application";

data/app/views/analytic/dashboard/show.html.erb

@@ -0,0 +1,84 @@
+<%- provide(:title, @dashboard.name) %>
+
+<div class="space-y-4">
+  <div class="flex gap-2">
+    <%= link_to 'Today', analytic.dashboard_path(period: 'today'), class: 'pill' %>
+    <%= link_to 'Yesterday', analytic.dashboard_path(period: 'yesterday'), class: 'pill' %>
+    <%= link_to 'Week', analytic.dashboard_path(period: 'week'), class: 'pill' %>
+    <%= link_to 'Month', analytic.dashboard_path(period: 'month'), class: 'pill' %>
+    <%= link_to 'Year', analytic.dashboard_path(period: 'year'), class: 'pill' %>
+  </div>
+
+  <div class="grid grid-flow-col justify-stretch gap-4">
+    <div class="card">
+      <div class="card__header">
+        <div class="card__title">
+          <%= tag.i class: "fa-solid fa-users" %>
+          Visitors
+        </div>
+      </div>
+      <div class="card__content">
+        <div class="card__value">
+          <%= number_with_delimiter @dashboard.distinct_visitors_count %>
+        </div>
+      </div>
+    </div>
+
+    <div class="card">
+      <div class="card__header">
+        <div class="card__title">
+          <%= tag.i class: "fa-solid fa-globe" %>
+          Sessions
+        </div>
+      </div>
+      <div class="card__content">
+        <div class="card__value">
+          <%= number_with_delimiter @dashboard.distinct_sessions_count %>
+        </div>
+      </div>
+    </div>
+
+    <div class="card">
+      <div class="card__header">
+        <div class="card__title">
+          <%= tag.i class: "fa-solid fa-eye" %>
+          Views
+        </div>
+      </div>
+      <div class="card__content">
+        <div class="card__value">
+          <%= number_with_delimiter @dashboard.count %>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <div class="card">
+    <div class="card__header">
+      <div class="card__title">
+        <%= tag.i class: "fa-solid fa-file-code" %>
+        Pages
+      </div>
+    </div>
+    <div class="card__content">
+      <table class="table">
+        <thead>
+          <tr>
+            <th scope="col">Host</th>
+            <th scope="col">Path</th>
+            <th scope="col">Views</th>
+          </tr>
+        </thead>
+        <tbody>
+          <%- @dashboard.pages.each do |(host, path, views)| -%>
+            <tr>
+              <td><%= host %></td>
+              <td><%= path %></td>
+              <td><%= number_with_delimiter views %></td>
+            </tr>
+          <%- end -%>
+        </tbody>
+      </table>
+    </div>
+  </div>
+</div>

data/app/views/layouts/analytic/application.html.erb

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= yield(:title) %> | Analytic</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= javascript_include_tag 'analytic/application' %>
+  <%= stylesheet_link_tag 'analytic/application' %>
+  <%= %>
+</head>
+<body class="bg-slate-50">
+
+  <header class="bg-indigo-600 text-white py-2">
+    <div class="container mx-auto px-4">
+      <div class="flex justify-between">
+        <nav class="flex gap-2">
+          <%= link_to analytic.root_path, class: "flex gap-2 rounded items-center px-3 py-2 font-semibold hover:bg-indigo-800" do %>
+            <%= tag.i class: "fa-solid fa-gauge" %>
+            Analytic
+          <% end %>
+        </nav>
+        <nav class="flex gap-2">
+          <%= link_to analytic.root_path, class: "flex gap-2 rounded items-center px-3 py-2 hover:bg-indigo-800" do %>
+            <%= tag.i class: "fa-solid fa-house" %>
+            Dashboard
+          <% end %>
+        </nav>
+      </div>
+    </div>
+  </header>
+
+  <main class="container mx-auto px-4 py-8">
+    <%= yield %>
+  </main>
+
+  <footer class="container mx-auto px-4 text-center">
+    <div class="flex gap-2 justify-center">
+      <%= time_tag(Time.current) %>
+    </div>
+  </footer>
+</body>
+</html>

data/bin/dev

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+foreman start -f Procfile.dev

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/analytic/engine', __dir__)
+APP_PATH = File.expand_path('../spec/dummy/config/application', __dir__)
+
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/routes.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+Analytic::Engine.routes.draw do
+  root to: 'dashboard#show'
+
+  get '/dashboard/(period/:period)', to: 'dashboard#show', as: :dashboard
+end

data/db/migrate/20240805210911_create_analytic_views.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CreateAnalyticViews < ActiveRecord::Migration[7.1]
+  def change
+    create_table :analytic_views do |t|
+      t.uuid :visitor_id, null: false
+      t.uuid :session_id, null: false
+      t.inet :ip, null: false
+      t.string :path, null: false
+      t.string :host, null: false
+      t.jsonb :params, null: false, default: {}
+      t.datetime :timestamp, null: false
+      t.text :referrer, null: true
+      t.text :user_agent, null: true
+
+      t.timestamps
+
+      t.index %i[timestamp path]
+      t.index %i[timestamp visitor_id]
+      t.index %i[timestamp session_id]
+      t.index %i[timestamp referrer]
+    end
+  end
+end

data/lib/analytic/config.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Analytic
+  class Config
+    # @return [String]
+    attr_accessor :timezone
+
+    # @return [Integer]
+    attr_accessor :ip_v4_mask
+
+    # @return [Integer]
+    attr_accessor :ip_v6_mask
+
+    def initialize
+      @timezone = Time.zone
+      @ip_v4_mask = 24 # e.g. 255.255.255.255 => '255.255.255.0/255.255.255.0'
+      @ip_v6_mask = 48 # e.g. 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff' => 'ffff:ffff:ffff:0000:0000:0000:0000:0000'
+    end
+
+    # @return [Boolean]
+    def ip_v4_mask?
+      @ip_v4_mask.present?
+    end
+
+    # @return [Boolean]
+    def ip_v6_mask?
+      @ip_v6_mask.present?
+    end
+  end
+end

data/lib/analytic/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Analytic
+  class Engine < ::Rails::Engine
+    isolate_namespace Analytic
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/analytic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Analytic
-  VERSION = "0.1.0"
+  VERSION = '0.3.0'
 end

data/lib/analytic.rb

@@ -1,6 +1,18 @@
-require "analytic/version"
-require "analytic/railtie"
+# frozen_string_literal: true
+
+require 'analytic/config'
+require 'analytic/version'
+require 'analytic/engine'
 
 module Analytic
-  # Your code goes here...
+  # @return [Analytic::Config]
+  def self.config
+    @config ||= Config.new
+  end
+
+  # @yield [config]
+  # @yieldparam config [Analytic::Config]
+  def self.configure
+    yield config
+  end
 end