browser_sense 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e198b13035e5ca4775150f1413cd09e67b84e0be7d6817e8855a4358d5f80b22
+  data.tar.gz: a479aff279f85768b99442bc4de1546c2c74c9830e65dea7d780305639c7c0c5
+SHA512:
+  metadata.gz: e642b21b603aa52382ce1b94f838c6c66f4872e28f5f8aa470d523ae9e9a846a12081972b1a81e92b12b0445fbf84a609d5b049d12e95e36c89316810dbbf325
+  data.tar.gz: 9ff5e4816096babc640372678d7a11186ab39318435d433a9b8142e06b8291a83a0c4597771f9b97297ee876d16f3a2720a8f864ccae840ae91940d9ba8d7637

data/.rubocop.yml

@@ -0,0 +1,62 @@
+# plugins:
+#   - rubocop-rails
+#   - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+  Exclude:
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'bin/{rails,rake}'
+    - !ruby/regexp /old_and_unused\.rb$/
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Lambda:
+  Enabled: false
+
+# Style/Lambda:
+#   Enabled: true
+#   EnforcedStyle: lambda
+
+Metrics/ModuleLength:
+  Max: 200
+  CountAsOne: [
+    'array', 'hash', 'heredoc', 'method_call'
+  ]
+
+Metrics/ClassLength:
+  Max: 200
+  CountAsOne: [
+    'array', 'hash', 'heredoc', 'method_call'
+  ]
+
+Metrics/MethodLength:
+  Max: 25
+  CountAsOne: [
+    'array', 'hash', 'heredoc', 'method_call'
+  ]
+
+Layout/LineLength:
+  Max: 80
+
+Layout:
+  # ArgumentAlignment: with_first_argument
+  # ArrayAlignment: with_first_argument
+  # BeginEndAlignment: start_of_line
+  # EnforcedStyleAlignWith: start_of_line
+  # FirstArrayElementIndentation: consistent
+  # FirstHashIndentation: consistent
+  #MultilineMethodCallIndentation:
+  #  EnforcedStyle: indented_relative_to_receiver

data/CHANGELOG.org

@@ -0,0 +1,10 @@
+#+TITLE: Browser Info ChangeLog
+
+* [1.0.0] - 2025-08-31
+
+- First public release
+- Changes and improvements to the documenation for public release
+
+* [0.1.0] - 2022-11-23
+
+- Initial release (private)

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in browser_sense.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    browser_sense (0.2.3)
+      browser (~> 6.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    browser (6.2.0)
+    json (2.11.3)
+    language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.75.5)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  browser_sense!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.5.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Adolfo Villafiorita
+
+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.org

@@ -0,0 +1,120 @@
+#+TITLE: BrowserSense
+#+AUTHOR: Shair.Tech
+#+DATE: <2025-08-31 Sun>
+
+Log information about the browsers accessings your Rails application.
+
+* Installation
+
+BrowserSense monitors which browser is accessing your Ruby on Rails app.
+
+Add the gem to your application's Gemfile and then bundle:
+
+#+begin_example sh
+    gem "browser_sense"
+#+end_example
+
+#+begin_example sh
+   bundle
+#+end_example
+
+To enable logging, add =browser_infro= to the =application_controller.rb= of
+your app, e.g.:
+
+#+begin_src ruby
+  class ApplicationController < ActionController::Base
+    [...]
+
+    browser_sense
+
+    [...]
+  end
+#+end_src
+
+
+* Data logged
+
+Each invocation of a route of your application generates a line in the log storing the
+following details:
+
+1. Browser name
+2. Platform
+3. Device name  
+4. Controller being invoked
+5. Method of the controller being invoked
+6. Request format (e.g. html, json)
+7. Hashed IP, which allows to track requests from the same IP, while preserving
+   privacy
+8. Timestamp
+
+Information is stored in the application log, each line prefixed by
+=BrowserSense= and data presented in CSV.
+
+*Example*
+
+#+begin_example bash
+  $ cat production.log
+  [...]
+  BrowserSense: "Firefox","linux","Unknown","Devise::SessionsController","new","12ca17b49af2289436f303e0166030a21e525d266e209267433801a8fd4071a0","2022-06-09T10:08:09+02:00"
+  [...]
+#+end_example
+
+
+* Analyzing Data
+
+When you want to analyze data, extract the information with:
+
+#+begin_example
+grep BrowserSense production.log | cut -f2- -d: > data.csv
+#+end_example
+
+and then, e.g., open the resulting file in a spreadsheet.
+
+There is also a ruby script =browser_sense=. The script takes as input the
+pathname of the file with the log and prints to stdout the result of various
+analyses.  The script is a quick hack, wrapping =sed=, =grep= and =miller=
+([[https://github.com/johnkerl/miller][Miller)]], which must be installed on your machine for the script to succeed.
+
+If you want more reports and plots, you can use the =log_sense= gem
+(https://rubygems.org/gems/log_sense), which understands the data generated by
+this gem.
+        
+
+* Development
+
+After checking out the repo, run =bin/setup= to install dependencies. Then,
+run =rake test= to run the tests. You can also run =bin/console= for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run =bundle exec rake
+install=. To release a new version, update the version number in =version.rb=,
+and then run =bundle exec rake release=, which will create a git tag for the
+version, push git commits and the created tag, and push the =.gem= file to
+[[https://rubygems.org][rubygems.org]]
+
+
+* Contributing
+
+TODO
+
+
+* Changelog
+
+[[./CHANGELOG.org]]
+
+
+* Authors and Contributors
+
+[[https://shair.tech][Shair.Tech]]
+
+* Known Bugs
+
+We have been running BrowserSense for quite a few years with no particular
+issues. There are no known bugs; there is an unknown number of unknown bugs.
+
+You are most welcome to report issues and missing features, using the Issue
+tracker.
+
+* License
+
+The gem is available as open source under the terms of the [[https://opensource.org/licenses/MIT][MIT License]].

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/app/controllers/browser_sense_filter.rb

@@ -0,0 +1,34 @@
+require "active_support/concern"
+require "browser"
+
+module BrowserSenseFilter
+  extend ActiveSupport::Concern
+
+  included do
+    def self.browser_sense
+      # monitor which browser is being used
+      # stored in csv format in the log for each method invocation, extract with:
+      # grep BrowserSense development.log | cut -f2- -d:
+      before_action do |controller|
+        user_agent = request.env["HTTP_USER_AGENT"]
+        ip = request.env["REMOTE_ADDR"]
+
+        hashed_ip = Digest::SHA256.hexdigest ip
+        b = Browser.new(user_agent)
+        now = DateTime.now
+
+        logger = Rails.logger
+        browser_data = [
+          b.name, b.platform, b.device.name,
+          controller.class.name, controller.action_name,
+          request.format.symbol,
+          hashed_ip,
+          now
+        ]
+
+        browser_data_str = browser_data.map { |x| "\"#{x}\"" }.join(",")
+        logger.info "BrowserSense: #{browser_data_str}"
+      end
+    end
+  end
+end

data/browser_sense.gemspec

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "lib/browser_sense/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "browser_sense"
+  spec.version = BrowserSense::VERSION
+  spec.authors = ["Adolfo Villafiorita"]
+  spec.email = ["adolfo@shair.tech"]
+
+  spec.summary = "Monitor which browser is accessing your Ruby on Rails app."
+  spec.description = <<-EOS
+     BrowserSense logs information about the browser accessing your
+     RubyOnRails app.  
+
+     Installation is pretty simple:
+
+     1. Add =gem "browser_sense"= to your Gemfile
+
+     2. Add the following line to your =application_controller.rb=:
+
+        browser_sense
+
+     Data is stored in csv format in Rails' production log.  Each URL invocation
+     generates a log line.
+
+     Extract browser info data with:
+
+        grep BrowserSense development.log | cut -f2- -d:
+
+     Analyize with
+
+        browser-info log/production.log > output.txt
+
+     or with log_sense (https://rubygems.org/gems/log_sense)
+
+     BrowserSense relies on the browser gem to get informaton about the browsers.
+  EOS
+  spec.homepage = "https://github.com/shair-tech/browser_sense"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/shair-tech/browser_sense"
+  spec.metadata["changelog_uri"] = "https://github.com/shair-tech/browser_sense/blob/main/CHANGELOG.org"
+
+  # Specify which files should be added to the gem when it is released.  The
+  # `git ls-files -z` loads the files in the RubyGem that have been added into
+  # git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "browser", "~> 6.2.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/exe/browser_sense

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+# -*- ruby -*-
+# A quick hack to analyze data produced by browser info
+
+require "tempfile"
+
+if ARGV.length != 1
+  puts "Usage browser_sense log_filename"
+  exit
+end
+
+LOG_FILE=ARGV[0]
+TMP_FILE= Tempfile.new("browser_sense").path
+
+def title(string)
+  puts %Q(
+==============================================================================
+#{string}
+==============================================================================)
+end
+
+# Look for BrowserSense | cut info by Rails | remove lines with less than 7 fields
+# No need to remove double quotes with sed -e 's/\"//g'
+`grep -E -e 'Browser(Info|Sense)' #{LOG_FILE} | sed -E 's/.*Browser(Info|Sense): (.+,.+,.+,.+,.+,.+,.+,.+)/\\2/g' > #{TMP_FILE}`
+
+# Look at the README file of BrowserSense for the field specification
+#
+# mlr template
+#
+# 1. Browser name
+# 2. Platform
+# 3. Device name  
+# 4. Controller being invoked
+# 5. Method of the controller being invoked
+# 6. Request format (e.g. html, json)
+# 7. Hashed IP, which allows to track requests from the same IP, while preserving privacy
+# 8. Timestamp
+#
+
+# methods by os
+# the usage of reshape and unsparsify is still kind of magic to me.
+# https://unix.stackexchange.com/questions/557124/bash-awk-pivot-csv-into-desired-table
+title "Methods vs OS"
+
+puts `mlr --icsv --implicit-csv-header --opprint put 'if ($2 == "android" || $2 == "ios") { $os_type="mobile"} elif ($2 == "unknown_platform") {$os_type = "unknown" } else {$os_type = "desktop"}' then cut -f 4,5,os_type then label controller,method,os_type then count-distinct -f controller,method,os_type then reshape -s os_type,count then unsparsify then sort -f controller,method #{TMP_FILE}`
+
+# how many browser types?
+title "Browsers"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 1 then label browser,count then sort -nr count #{TMP_FILE}`
+
+
+# how many os?
+title "OS"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 2 then label os,count then sort -nr count #{TMP_FILE}`
+
+# how many os,browser?
+title "OS and Browsers"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 2,1 then label os,browser,count then sort -nr count #{TMP_FILE}`
+
+# how many distinct ips?
+title "IP"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 7 then label ip,count then sort -nr count #{TMP_FILE}`
+
+# ip,os,browser?
+title "IP,OS,Browser"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 7,2,1 then label ip,platform,browser,count then sort -nr count #{TMP_FILE}`
+
+# methods used on mobile
+title "Methods on Mobile"
+
+puts `mlr --icsv --implicit-csv-header --opprint filter '$2 == "android" || $2 == "ios"' then count-distinct -f 2,1,4,5 then label os,browser,controller,method,count then sort -f os,browser,controller,method then put '$count2=$count' then bar -f count2 -b ' '  #{TMP_FILE}`
+
+# methods used on desktops
+title "Methods on PC"
+
+puts `mlr --icsv --implicit-csv-header --opprint filter '$2 != "android" && $2 != "ios"' then count-distinct -f 2,1,4,5 then label os,browser,controller,method,count then sort -f os,browser,controller,method,count then sort -nr count #{TMP_FILE}`
+
+# methods used
+title "Methods"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 4,5 then label controller,method then sort -nr count #{TMP_FILE}`
+
+# methods vs format
+title "Methods"
+
+puts `mlr --icsv --implicit-csv-header --opprint count-distinct -f 4,5,6 then label controller,method,format then sort -nr count #{TMP_FILE}`

data/lib/browser_sense/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BrowserSense
+  VERSION = "1.0.0"
+end

data/lib/browser_sense.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "browser_sense/version"
+
+module BrowserSense
+  #
+  # Mount us as an Engine
+  # (or the Rails app will know nothing about us)
+  #
+  class Engine < ::Rails::Engine
+  end
+end

data/sig/browser_sense.rbs

@@ -0,0 +1,4 @@
+module BrowserSense
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: browser_sense
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adolfo Villafiorita
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: browser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.0
+description: "     BrowserSense logs information about the browser accessing your\n
+  \    RubyOnRails app.  \n\n     Installation is pretty simple:\n\n     1. Add =gem
+  \"browser_sense\"= to your Gemfile\n\n     2. Add the following line to your =application_controller.rb=:\n\n
+  \       browser_sense\n\n     Data is stored in csv format in Rails' production
+  log.  Each URL invocation\n     generates a log line.\n\n     Extract browser info
+  data with:\n\n        grep BrowserSense development.log | cut -f2- -d:\n\n     Analyize
+  with\n\n        browser-info log/production.log > output.txt\n\n     or with log_sense
+  (https://rubygems.org/gems/log_sense)\n\n     BrowserSense relies on the browser
+  gem to get informaton about the browsers.\n"
+email:
+- adolfo@shair.tech
+executables:
+- browser_sense
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.org
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.org
+- Rakefile
+- app/controllers/browser_sense_filter.rb
+- browser_sense.gemspec
+- exe/browser_sense
+- lib/browser_sense.rb
+- lib/browser_sense/version.rb
+- sig/browser_sense.rbs
+homepage: https://github.com/shair-tech/browser_sense
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/shair-tech/browser_sense
+  source_code_uri: https://github.com/shair-tech/browser_sense
+  changelog_uri: https://github.com/shair-tech/browser_sense/blob/main/CHANGELOG.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Monitor which browser is accessing your Ruby on Rails app.
+test_files: []