strongmind-pageviews 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc87f3d132f28d4832ee629573f7e9297be1de55450ea1c7d73d07c1b6aa71e3
+  data.tar.gz: 9e0c31fbb68ed70f6fada87f4f2c621182e2824a204fddae2b74c20dab5eef12
+SHA512:
+  metadata.gz: c82279018abc6329e12301c11eaa10f9c4f83d6962203f0d082cc7d3cee0ab305fd64bdd16c98fe4c549b14c752132623a8784617536420d2d9ccc192e5508f3
+  data.tar.gz: fb3a0532a36ddd08eb814379665b76031b34843e612bd048b2a91cc022e115d5bda151cfbc4b9cc94c7fc9ae44656bd0483a746f71722039de122e46816ec449

data/LICENSE

@@ -0,0 +1,21 @@
+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/README.md

@@ -0,0 +1,89 @@
+# Pageviews
+Pageviews is a lightweight ruby gem for tracking page views for rails application.
+What about bots? They are ignored.  1200 known bots have been added to the ignore list as of
+February 1, 2011.  Impressionist uses this list: http://www.user-agents.org/allagents.xml
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pageviews'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pageviews
+
+Generate the impressions table migration
+
+    rails g pageviews
+
+Run the migration
+
+    rake db:migrate
+
+The following fields will be generated in the migration:
+
+    t.string   "pageview_type"        # model type: Widget
+    t.integer  "pageview_id"          # model instance ID: @blog_post.id
+    t.integer  "user_id"              # automatically logs @current_user.id
+    t.string   "controller_name"      # logs the controller name
+    t.string   "action_name"          # logs the action_name
+    t.string   "view_name"            # TODO: log individual views (as well as partials and nested partials)
+    t.string   "request_hash"         # unique ID per request, in case you want to log multiple impressions and group them
+    t.string   "session_hash"         # logs the rails session
+    t.string   "ip_address"           # request.remote_ip
+    t.text     "params"               # request.params, except action name, controller name and resource id
+    t.string   "referrer"             # request.referer
+    t.datetime "created_at"           # I am not sure what this is.... Any clue?
+    t.datetime "updated_at"           # never seen this one before either....  Your guess is as good as mine?? ;-)
+
+## Usage
+
+
+1. Log all actions in a controller
+
+        class BlogPostController < ApplicationController
+          track_views
+        end
+
+2. Specify actions you want logged in a controller
+
+        class BlogPostController < ApplicationController
+          track_views actions: [:show,:index]
+        end
+
+3. Make use of the `:session_hash` to keep track of unique views only.
+
+        class BlogPostController < ApplicationController
+          track_views actions: [:show], unique: [:session_hash]
+        end
+
+4. Add `acts_as_pageviews` in your model.  This allows you to attach pageviews to
+   an Active Record model instance.
+
+        class BlogPost < ActiveRecord::Base
+          acts_as_pageviews
+        end
+
+5. Get unique pageviews count from a model.
+
+        @blog_post.views
+
+6. You can also specify pageviews count for specific actions.
+
+        @blog_post.views('show')
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Banta/pageviews. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

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

data/lib/generators/pageviews/pageviews_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class PageviewsGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(dirname)
+    sleep 1
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'create_pageviews_table.rb', 'db/migrate/create_pageviews_table.rb'
+  end
+end

data/lib/generators/pageviews/templates/create_pageviews_table.rb

@@ -0,0 +1,30 @@
+class CreatePageviewsTable < ActiveRecord::Migration
+  def self.up
+    create_table :pageviews, :force => true do |t|
+      t.string :pageview_type
+      t.integer :pageview_id
+      t.integer :user_id
+      t.string :controller_name
+      t.string :action_name
+      t.string :view_name
+      t.string :request_hash
+      t.string :ip_address
+      t.string :session_hash
+      t.text :referrer
+      t.text :params
+      t.timestamps
+    end
+    add_index :pageviews, [:pageview_type, :pageview_id, :request_hash], :name => "poly_request_index", :unique => false
+    add_index :pageviews, [:pageview_type, :pageview_id, :ip_address], :name => "poly_ip_index", :unique => false
+    add_index :pageviews, [:pageview_type, :pageview_id, :session_hash], :name => "poly_session_index", :unique => false
+    add_index :pageviews, [:controller_name,:action_name,:request_hash], :name => "controlleraction_request_index", :unique => false
+    add_index :pageviews, [:controller_name,:action_name,:ip_address], :name => "controlleraction_ip_index", :unique => false
+    add_index :pageviews, [:controller_name,:action_name,:session_hash], :name => "controlleraction_session_index", :unique => false
+    add_index :pageviews, [:pageview_type, :pageview_id, :params], :name => "poly_params_request_index", :unique => false
+    add_index :pageviews, :user_id
+  end
+
+  def self.down
+    drop_table :pageviews
+  end
+end

data/lib/pageviews/acts_as_pageviews.rb

@@ -0,0 +1,21 @@
+module Pageviews
+  module ActiveRecord
+    module InstanceMethods
+      def views(action=nil)
+        if action
+          pageviews.where(action_name: action).count
+        else
+          pageviews.count
+        end
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  def self.acts_as_pageviews
+    include Pageviews::ActiveRecord::InstanceMethods
+    has_many :pageviews, as: :pageview, dependent: :destroy
+  end
+end
+

data/lib/pageviews/engine.rb

@@ -0,0 +1,15 @@
+require 'pageviews'
+require 'rails'
+require 'active_record'
+# require 'active_support'
+
+module Pageviews
+  class Engine < Rails::Engine
+    initializer 'pageviews.controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include PageviewsController::InstanceMethods
+        extend PageviewsController::ClassMethods
+      end
+    end
+  end
+end

data/lib/pageviews/version.rb

@@ -0,0 +1,3 @@
+module Pageviews
+  VERSION = "0.2.0"
+end

data/lib/pageviews.rb

@@ -0,0 +1,10 @@
+require "pageviews/version"
+require 'pageviews/engine' if defined?(Rails)
+require 'pageviews/acts_as_pageviews'
+
+module Pageviews
+  # Load configuration from initializer
+  def self.setup
+    yield self
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: strongmind-pageviews
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- StrongMind
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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:
+- vendor@strongmind.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/setup
+- lib/generators/pageviews/pageviews_generator.rb
+- lib/generators/pageviews/templates/create_pageviews_table.rb
+- lib/pageviews.rb
+- lib/pageviews/acts_as_pageviews.rb
+- lib/pageviews/engine.rb
+- lib/pageviews/version.rb
+homepage: https://github.com/StrongMind/pageviews
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/StrongMind/pageviews
+  source_code_uri: https://github.com/StrongMind/pageviews
+  changelog_uri: https://github.com/StrongMind/pageviews/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Easy way to log Rails page views
+test_files: []