mongoid_traffic 0.2.5 → 1.0.0

data/lib/mongoid_traffic/logger.rb

@@ -1,123 +1,68 @@
-require 'uri'
-require 'useragent'
-
-require_relative './log'
-require_relative './logger/bots'
-require_relative './logger/browser'
-require_relative './logger/geo_ip'
-require_relative './logger/referer'
-
 module MongoidTraffic
   class Logger
-    TIME_SCOPE_OPTIONS = %i(year month week day).freeze
-
-    # ---------------------------------------------------------------------
+    attr_accessor :log_cls
+    attr_accessor :selector
+    attr_accessor :time_scope
+    attr_accessor :additonal_counters
 
     def self.log(log_cls, *args)
       new(log_cls, *args).log
     end
 
-    # ---------------------------------------------------------------------
-
-    def initialize(log_cls, ip_address: nil, referer: nil, scope: nil, time_scope: %i(month day), unique_id: nil, user_agent: nil)
+    def initialize(log_cls, options = {})
       @log_cls = log_cls
-      @ip_address = ip_address
-      @referer_string = referer
-      @scope = scope
-      @time_scope = time_scope
-      @unique_id = unique_id
-      @user_agent_string = user_agent
+      @selector = log_cls.criteria.selector
+      @time_scope = options.fetch(:time_scope, TIME_SCOPE_OPTIONS.keys)
+      @additonal_counters = options.except(:time_scope, :scope)
+
+      raise "Invalid time scope definition: #{time_scope}" unless time_scope.all? { |ts| TIME_SCOPE_OPTIONS.key?(ts) }
     end
 
     def log
-      return if Bots.is_a_bot?(@referer_string)
-      raise "Invalid time scope definition: #{@time_scope}" unless @time_scope.all? { |ts| TIME_SCOPE_OPTIONS.include?(ts) }
-
-      @time_scope.each do |ts|
-        @log_cls.collection.find(find_query(ts)).update_many(upsert_query, upsert: true)
+      time_scope.each do |ts|
+        log_cls.collection
+               .find(find_query(ts))
+               .update_many(upsert_query(ts), upsert: true)
       end
     end
 
-    # ---------------------------------------------------------------------
-
-    def upsert_query
-      {
-        '$inc' => access_count_query
-          .merge(browser_query)
-          .merge(country_query)
-          .merge(referer_query)
-          .merge(unique_id_query),
-        '$set' => { uat: Time.now }
-      }
-    end
-
-    # ---------------------------------------------------------------------
-
-    def access_count_query
-      { ac: 1 }
-    end
-
-    def browser_query
-      return {} unless browser.present?
-      browser_path = [browser.platform, browser.name, browser.version].map { |s| escape_key(s) }.join('.')
-      { "b.#{browser_path}" => 1 }
-    end
+    private
 
-    def country_query
-      return {} unless @ip_address.present?
-      return {} unless country_code2 = GeoIp.country_code2(@ip_address)
-      country_code_key = escape_key(country_code2)
-      { "c.#{country_code_key}" => 1 }
+    def find_query(ts)
+      time_query(ts).merge(selector)
     end
 
-    def referer_query
-      return {} unless referer.present?
-      referer_key = escape_key(referer.to_s)
-      { "r.#{referer_key}" => 1 }
-    end
+    def upsert_query(time_scope)
+      ts = TIME_SCOPE_OPTIONS[time_scope]
 
-    def unique_id_query
-      return {} unless @unique_id.present?
-      unique_id_key = escape_key(@unique_id.to_s)
-      { "u.#{unique_id_key}" => 1 }
+      { '$inc' => access_count_query.merge(additonal_counters_query),
+        '$set' => { ts: ts, uat: Time.now } }
     end
 
-    # ---------------------------------------------------------------------
-
-    def escape_key(key)
-      CGI.escape(key).gsub('.', '%2E')
+    def access_count_query
+      { ac: 1 }
     end
 
-    # ---------------------------------------------------------------------
-
-    def find_query(ts)
-      res = time_query(ts)
-      res = res.merge(scope_query) if @scope.present?
-      res
+    def additonal_counters_query
+      Array(additonal_counters).each_with_object({}) do |(name, value), res|
+        next unless field = find_field(name)
+        res["#{field.name}.#{value}"] = 1
+      end
     end
 
-    def scope_query
-      { s: @scope }
+    def find_field(name)
+      log_cls.fields.detect do |field_name, field|
+        field_name == name.to_s || field.options[:as].to_s == name.to_s
+      end.try(:last)
     end
 
     def time_query(ts)
       date = Date.today
+
       case ts
       when :day then { df: date, dt: date }
       else { df: date.send("at_beginning_of_#{ts}"), dt: date.send("at_end_of_#{ts}") }
       end
     end
-
-    private # =============================================================
-
-    def browser
-      return unless @user_agent_string.present?
-      @browser ||= Browser.new(@user_agent_string)
-    end
-
-    def referer
-      return unless @referer_string.present?
-      @referer ||= Referer.new(@referer_string)
-    end
   end
 end

data/lib/mongoid_traffic/version.rb

@@ -1,3 +1,3 @@
 module MongoidTraffic
-  VERSION = '0.2.5'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/mongoid_traffic.gemspec

@@ -6,29 +6,29 @@ require 'mongoid_traffic/version'
 Gem::Specification.new do |spec|
   spec.name          = 'mongoid_traffic'
   spec.version       = MongoidTraffic::VERSION
-  spec.authors       = ["Tomáš Celizna"]
+  spec.authors       = ['Tomáš Celizna']
   spec.email         = ['tomas.celizna@gmail.com']
   spec.description   = 'Aggregated traffic logs stored in MongoDB.'
   spec.summary       = 'Aggregated traffic logs stored in MongoDB.'
   spec.homepage      = 'https://github.com/tomasc/mongoid_traffic'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'geoip'
   spec.add_dependency 'mongoid', '>= 5', '< 8'
-  spec.add_dependency 'nokogiri'
-  spec.add_dependency 'useragent'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'database_cleaner', '~> 1.5.2'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-minitest'
-  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-around'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_traffic
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Tomáš Celizna
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-08-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: geoip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
@@ -44,48 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: useragent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -146,16 +104,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: minitest-around
   requirement: !ruby/object:Gem::Requirement
@@ -174,16 +132,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 description: Aggregated traffic logs stored in MongoDB.
 email:
 - tomas.celizna@gmail.com
@@ -201,27 +159,10 @@ files:
 - README.md
 - Rakefile
 - lib/mongoid_traffic.rb
-- lib/mongoid_traffic/controller_additions.rb
 - lib/mongoid_traffic/log.rb
 - lib/mongoid_traffic/logger.rb
-- lib/mongoid_traffic/logger/bots.rb
-- lib/mongoid_traffic/logger/browser.rb
-- lib/mongoid_traffic/logger/geo_ip.rb
-- lib/mongoid_traffic/logger/referer.rb
 - lib/mongoid_traffic/version.rb
 - mongoid_traffic.gemspec
-- test/mongoid_traffic/controller_additions_test.rb
-- test/mongoid_traffic/log_test.rb
-- test/mongoid_traffic/logger/bots_test.rb
-- test/mongoid_traffic/logger/browser_test.rb
-- test/mongoid_traffic/logger/geoip_test.rb
-- test/mongoid_traffic/logger/referer_test.rb
-- test/mongoid_traffic/logger_test.rb
-- test/support/database_cleaner.rb
-- test/support/mongoid.rb
-- test/test_helper.rb
-- vendor/mongoid_traffic/GeoIP.dat
-- vendor/mongoid_traffic/allagents.xml
 homepage: https://github.com/tomasc/mongoid_traffic
 licenses:
 - MIT
@@ -242,18 +183,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Aggregated traffic logs stored in MongoDB.
-test_files:
-- test/mongoid_traffic/controller_additions_test.rb
-- test/mongoid_traffic/log_test.rb
-- test/mongoid_traffic/logger/bots_test.rb
-- test/mongoid_traffic/logger/browser_test.rb
-- test/mongoid_traffic/logger/geoip_test.rb
-- test/mongoid_traffic/logger/referer_test.rb
-- test/mongoid_traffic/logger_test.rb
-- test/support/database_cleaner.rb
-- test/support/mongoid.rb
-- test/test_helper.rb
+test_files: []

data/lib/mongoid_traffic/controller_additions.rb

@@ -1,31 +0,0 @@
-module MongoidTraffic
-  module ControllerAdditions
-    def log_traffic(log_cls, scope: nil)
-      MongoidTraffic::Logger.log(
-        log_cls,
-        ip_address: request.remote_ip,
-        referer: request.headers['Referer'],
-        unique_id: request.session_options[:id], # FIXME: not sure about this
-        user_agent: request.headers['User-Agent']
-      )
-    end
-
-    def log_scoped_traffic(_log_cls, scope: nil)
-      log_traffic(scope: (scope || request.fullpath.split('?').first))
-    end
-
-    # ---------------------------------------------------------------------
-
-    def self.included(base)
-      base.extend ClassMethods
-      base.helper_method :log_traffic
-      base.helper_method :log_scoped_traffic
-    end
-  end
-end
-
-if defined? ActionController::Base
-  ActionController::Base.class_eval do
-    include MongoidTraffic::ControllerAdditions
-  end
-end

data/lib/mongoid_traffic/logger/bots.rb

@@ -1,31 +0,0 @@
-require 'nokogiri'
-
-# sourced from https://github.com/charlotte-ruby/impressionist/blob/master/lib/impressionist/bots.rb
-
-module MongoidTraffic
-  class Logger
-    class Bots
-      DATA_URL = 'http://www.user-agents.org/allagents.xml'.freeze
-      FILE_PATH = File.join(File.dirname(__dir__), '..', '..', 'vendor', 'mongoid_traffic', 'allagents.xml')
-
-      class << self
-        def list
-          @list ||= begin
-            response = File.open(FILE_PATH).read
-            doc = Nokogiri::XML(response)
-            doc.xpath('//user-agent').inject([]) do |res, agent|
-              type = agent.xpath('Type').text
-              res << agent.xpath('String').text.gsub('&lt;', '<') if %w(R S).include?(type)
-              res
-            end
-          end
-        end
-
-        def is_a_bot?(referer)
-          return false unless referer.present?
-          list.include?(referer)
-        end
-      end
-    end
-  end
-end

data/lib/mongoid_traffic/logger/browser.rb

@@ -1,29 +0,0 @@
-require 'user_agent'
-
-module MongoidTraffic
-  class Logger
-    class Browser
-      def initialize(user_agent_string)
-        @user_agent_string = user_agent_string
-      end
-
-      def platform
-        user_agent.platform
-      end
-
-      def name
-        user_agent.browser
-      end
-
-      def version
-        user_agent.version.to_s.split('.')[0..1].join('.')
-      end
-
-      private # =============================================================
-
-      def user_agent
-        @user_agent ||= ::UserAgent.parse(@user_agent_string)
-      end
-    end
-  end
-end