analytic 0.2.0 → 0.3.0

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

@@ -3,25 +3,31 @@
 module Analytic
   module Trackable
     # @param params [Hash]
-    def analytic_track!(params: {})
+    def analytic_track!
       Analytic::View.create!(
         timestamp: Time.current,
         session_id: analytic_session_id,
         visitor_id: analytic_visitor_id,
-        host: request.host,
-        path: request.path,
-        params:
+        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!(params: {})
+    def analytic_enqueue_track_job!
       Analytic::TrackJob.perform_later(
         session_id: analytic_session_id,
         visitor_id: analytic_visitor_id,
-        host: request.host,
-        path: request.path,
-        params:
+        ip: analytic_ip,
+        host: analytic_host,
+        path: analytic_path,
+        referrer: analytic_referrer,
+        user_agent: request.user_agent,
+        params: analytic_params
       )
     end
 
@@ -34,5 +40,40 @@ module Analytic
     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/jobs/analytic/track_job.rb

@@ -10,12 +10,14 @@ module Analytic
     # @param host [String]
     # @param path [String]
     # @param params [Hash]
-    def perform(session_id:, visitor_id:, host:, path:, timestamp: Time.current, params: {})
+    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

data/app/models/analytic/view.rb

@@ -7,6 +7,7 @@ module Analytic
     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 }
 

data/bin/rails

@@ -1,11 +1,13 @@
 #!/usr/bin/env ruby
 
-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__)
+# frozen_string_literal: true
 
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+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__)
 
-require "rails/all"
-require "rails/engine/commands"
+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/db/migrate/20240805210911_create_analytic_views.rb

@@ -5,16 +5,20 @@ class CreateAnalyticViews < ActiveRecord::Migration[7.1]
     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

@@ -5,8 +5,26 @@ module Analytic
     # @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

@@ -3,5 +3,9 @@
 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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Analytic
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analytic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin Sylvestre