strongmind-pageviews 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bc1750d543b14c1b2bafdd7133e90b3ae3b35614cf48cbdfbcfc147ba305840
-  data.tar.gz: 432a28baf26f38a37be9fc47e0ebd15049cd4e65fcea3d4716852f84b6f37cc7
+  metadata.gz: 678cee10c0e6b261df6701f4298e06cfe9128e7147e5ca63c2b0a444488fb5a9
+  data.tar.gz: f17ffca5872f4eeb0e3b3aeca2131570bedf5d2849eb584cfeea0b1bde12d7d8
 SHA512:
-  metadata.gz: dd28a7c5085d81cb5aaa1db2e919a998cc95be7588b195f1d0bf6239645070989d9e272ec1157722eae9054cc41d689e48a71d67a1c9fdbbb4100b770b6796ac
-  data.tar.gz: 5005e5f68dab4a89ecd5cc5f67c2e0940e1ca4cc8acc31d8cd377f66f7d3ede94c87a69cf871f0c961a7c14b61f5e4fb7770f5381cd280e7f44aa758a1d7fa14
+  metadata.gz: 7ced664c75feb480c17023a918ca9e906214638b0250da3be22e00c13e9f9416bd67813375f9ba7026b400f0a491aceb723f0ce1611c50c977ed3abe56644a20
+  data.tar.gz: 1441e5f95048bb73fbc29faab25813684c0922d2c9f09308302d1f119ad3738cda8a6061c6ee1b1916fb348c832852b3aa706b9a0176860b3649a5dadd132c1b

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controllers/pageviews_controller.rb

@@ -0,0 +1,66 @@
+module PageviewsController
+  module ClassMethods
+    def track_views(opts = {})
+      before_action { |c| c.track_views_filter(opts[:actions], opts[:unique]) }
+    end
+  end
+
+  module InstanceMethods
+    def track_views_filter(actions = nil, unique_opts = nil)
+      return if bypass_tracking?
+
+      actions = Array(actions).map(&:to_s)
+      if (actions.blank? || actions.include?(action_name)) && unique?(unique_opts)
+        Pageview.create(create_pageview_params)
+      end
+    end
+
+    private
+
+    def bypass_tracking?
+      bot_user_agent?(request.user_agent)
+    end
+
+    def create_pageview_params
+      {
+        pageview_type: controller_name.singularize.camelize,
+        pageview_id: params[:id],
+        controller_name: controller_name,
+        action_name: action_name,
+        user_id: current_user_id,
+        session_hash: request.session.id,
+        ip_address: request.remote_ip,
+        params: filtered_params,
+        referrer: request.referer
+      }
+    end
+
+    def filtered_params
+      params.except(:controller, :action, :id).permit!.to_h
+    end
+
+    def current_user_id
+      current_user&.id
+    end
+
+    def unique?(unique_opts)
+      return true if unique_opts.blank?
+
+      conditions = create_pageview_params.slice(*unique_opts)
+      !Pageview.exists?(conditions)
+    end
+
+    def bot_user_agent?(user_agent)
+      return false if user_agent.blank?
+      
+      bot_patterns = [
+        /bot/i,
+        /crawler/i,
+        /spider/i,
+        /\b(Baidu|Gigabot|Googlebot|libwww-perl|lwp-trivial|msnbot|SiteUptime|Slurp|WordPress|ZIBB|ZyBorg|Yandex|Jyxobot|ApacheBench|YandexBot)\b/i
+      ]
+      
+      bot_patterns.any? { |pattern| user_agent =~ pattern }
+    end
+  end
+end

data/app/models/pageview.rb

@@ -0,0 +1,8 @@
+class Pageview < ApplicationRecord
+  include PlatformSdk::ActiveRecord::DataPipelineable
+  
+  belongs_to :pageview, polymorphic: true, optional: true
+  belongs_to :user, optional: true
+
+  validates :controller_name, :action_name, presence: true
+end

data/lib/pageviews/version.rb

@@ -1,3 +1,3 @@
 module Pageviews
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strongmind-pageviews
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - StrongMind
@@ -10,6 +10,34 @@ bindir: exe
 cert_chain: []
 date: 2024-12-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.22'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.0'
 description: Pageviews is a page views counting gem for Rails. Log views from Rails
   controller actions.
 email:
@@ -102,10 +116,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
-- bin/console
-- bin/setup
+- Rakefile
+- app/controllers/pageviews_controller.rb
+- app/models/pageview.rb
 - lib/generators/pageviews/pageviews_generator.rb
 - lib/generators/pageviews/templates/create_pageviews_table.rb
 - lib/pageviews.rb

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2015 Bernard Banta
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "pageviews"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here