universal-track-manager 0.4 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d48794e98ac66bd550a5f0bc89582f60b5bb82c439c45f6e3d0a8390826ccf2b
-  data.tar.gz: d7d09b5ac92ece9105755d45bb96a122ce3c1c7e71b3f784bc8ee63fbe25d1fe
+  metadata.gz: 3906b1056d94f2c92bdf86c2e3899d463a77a94a76a3fbd45e0afd751f9e7945
+  data.tar.gz: 36f420592997d79741c34e063ac4fe57899745cf38c8dce0316e8e334e6a7142
 SHA512:
-  metadata.gz: 4605e21f5e796428900637174281783678d29fa178fb6d328bb66f052669de39a37deffad718fdcbc3331f04656e9d09e26384c7ba4d86feedfba693afc15e51
-  data.tar.gz: 12d8bbca72e630abf4753fa8fe5f5bf736db2b0cf2fad35187a4b53a2a272fc5d7aaae06db2f27d840ded2a375824b46aa1abc9b4d10d5849b38a713e28476bf
+  metadata.gz: 106a32e556cb93a3654d4b0efe240fb265405065e00248383eb034101ed2699077fb537fe2404db0d4087235ffbe91be2ba0b5361aad3b95b811d07258af5d7f
+  data.tar.gz: 8d926fb725317451e5a94a76a2509196c5abfcfd280ce1dc20cd34a645bbcc82887fe08e27f5e08549a2b3fb5d5b1bc9aa30e3ab492e559265a173b9316315a9

data/lib/generators/templates/universal_track_manager.rb

@@ -0,0 +1,9 @@
+UniversalTrackManager.configure do |config|
+  config.track_ips = true
+  config.track_utms = true
+  config.track_user_agent = true
+
+
+  # config.track_referrer = false
+
+end

data/lib/generators/universal_track_manager/install_generator.rb

@@ -8,18 +8,22 @@ module UniversalTrackManager
 
     source_root File.expand_path('../templates', __dir__)
 
-
     class_option :orm, type: 'boolean'
 
+
     def self.next_migration_number(path)
       Time.now.utc.strftime("%Y%m%d%H%M%S")
     end
 
     desc "Creates an initializer for Universal Track Manager and copy files to your application."
-    def copy_initializer
+    def create_universal_track_manager_migration
       migration_template "create_universal_track_manager_tables.rb",  "db/migrate/create_universal_track_manager_tables.rb"
     end
 
+    def create_universal_track_manager_initializer
+      copy_file 'universal_track_manager.rb', 'config/initializers/universal_track_manager.rb'
+    end
+
     def migration_version
       "[#{ActiveRecord::Migration.current_version}]" if ActiveRecord::Migration.respond_to?(:current_version)
     end

data/lib/universal-track-manager.rb

@@ -1,3 +1,8 @@
+# note this file must be named identically to the gem's name (using hyphen)
+# for it to be picked up in the Gem build
+#
+# THIS FILE IS NOT in the specs and is for the gem builder
+
 $LOAD_PATH.unshift __dir__
 
 def require_all(path)
@@ -7,15 +12,9 @@ def require_all(path)
   end
 end
 
-
 # require_all("generators/templates")
-
 require_all("generators/universal_track_manager")
 require_all("universal_track_manager/controllers/concerns")
 require_all("universal_track_manager/models")
 
-module UniversalTrackManager
-  require "railtie.rb" if defined?(Rails)
-end
-
-
+require("universal_track_manager")

data/lib/universal_track_manager.rb

@@ -0,0 +1,34 @@
+# primary module for UTM. note this file is included in the specs
+
+module UniversalTrackManager
+  require "railtie.rb" if defined?(Rails)
+
+  class Settings
+    attr_accessor :track_ips, :track_utms, :track_user_agent, :track_http_referrer
+  end
+
+  def self.configure(&block)
+    @_settings =  Settings.new
+
+    block.call(@_settings)
+  end
+
+
+  def self.track_ips?
+    @_settings.track_ips
+  end
+
+  def self.track_utms?
+    @_settings.track_utms
+  end
+
+  def self.track_user_agent?
+    @_settings.track_user_agent
+  end
+
+  def self.track_http_referrer?
+    @_settings.track_http_referrer
+  end
+end
+
+

data/lib/universal_track_manager/controllers/concerns/universal_track_manager_concern.rb

@@ -1,6 +1,5 @@
 module UniversalTrackManagerConcern
   extend ActiveSupport::Concern
-
   attr_accessor :visit_evicted
 
   included do
@@ -13,31 +12,38 @@ module UniversalTrackManagerConcern
 
 
   def ip_address
+    return nil if ! UniversalTrackManager.track_ips?
     request.ip
   end
 
   def user_agent
+    return nil if ! UniversalTrackManager.track_user_agent?
     request.user_agent[0..255]
   end
 
 
   def utm_campaign
+    return nil if ! UniversalTrackManager.track_utms?
     permitted_utm_params[:utm_campaign]
   end
 
   def utm_source
+    return nil if ! UniversalTrackManager.track_utms?
     permitted_utm_params[:utm_source]
   end
 
   def utm_term
+    return nil if ! UniversalTrackManager.track_utms?
     permitted_utm_params[:utm_term]
   end
 
   def utm_content
+    return nil if ! UniversalTrackManager.track_utms?
     permitted_utm_params[:utm_content]
   end
 
   def utm_medium
+    return nil if ! UniversalTrackManager.track_utms?
     permitted_utm_params[:utm_medium]
   end
 
@@ -45,46 +51,59 @@ module UniversalTrackManagerConcern
     @now ||= Time.now
   end
 
+  def new_visitor
+    params = {
+      first_pageload: now,
+      last_pageload: now,
+      ip_v4_address: ip_address,
+      campaign: find_or_create_campaign_by_current
+    }
+    params[:browser] =  find_or_create_browser_by_current if request.user_agent
+    visit = UniversalTrackManager::Visit.create!(params)
+    session[:visit_id] = visit.id
+  end
+
   def track_visitor
     if !session['visit_id']
-
-      visit = UniversalTrackManager::Visit.create!(
-        first_pageload: now,
-        last_pageload: now,
-        ip_v4_address: ip_address,
-        browser: find_or_create_browser_by_current,
-        campaign: find_or_create_campaign_by_current)
-      session[:visit_id] = visit.id
+      new_visitor
     else
-      # existing visit, maybe
-      existing_visit = UniversalTrackManager::Visit.find(session['visit_id'])
-
-      evict_visit!(existing_visit) if any_utm_params? && !existing_visit.matches_all_utms?({utm_campaign: utm_campaign,
-                                                                      utm_source: utm_source,
-                                                                      utm_term: utm_term,
-                                                                      utm_content: utm_content,
-                                                                      utm_medium: utm_medium})
-
-      evict_visit!(existing_visit) if existing_visit.ip_v4_address != ip_address
-      evict_visit!(existing_visit) if existing_visit.browser.name != user_agent
-
-      existing_visit.update_columns(:last_pageload => Time.now) if !@visit_evicted
-
+      # existing visit
+      begin
+        existing_visit = UniversalTrackManager::Visit.find(session['visit_id'])
+
+        evict_visit!(existing_visit) if any_utm_params? && !existing_visit.matches_all_utms?({utm_campaign: utm_campaign,
+                                                                        utm_source: utm_source,
+                                                                        utm_term: utm_term,
+                                                                        utm_content: utm_content,
+                                                                        utm_medium: utm_medium})
+
+        evict_visit!(existing_visit) if existing_visit.ip_v4_address != ip_address
+        evict_visit!(existing_visit) if existing_visit.browser && existing_visit.browser.name != user_agent
+
+        existing_visit.update_columns(:last_pageload => Time.now) if !@visit_evicted
+      rescue ActiveRecord::RecordNotFound
+        # this happens if the session table is cleared or if the record in the session
+        # table points to a visit that has been cleared
+        new_visitor
+      end
     end
   end
 
 
   def any_utm_params?
+    return false if ! UniversalTrackManager.track_utms?
     [:utm_campaign, :utm_source, :utm_medium, :utm_term, :utm_content].any? do |key|
       params[key].present?
     end
   end
 
   def find_or_create_browser_by_current
+    return nil if ! UniversalTrackManager.track_user_agent?
     browser = UniversalTrackManager::Browser.find_or_create_by(name: user_agent)
   end
 
   def find_or_create_campaign_by_current
+    return nil if ! UniversalTrackManager.track_utms?
     campaign = UniversalTrackManager::Campaign.find_or_create_by(
       utm_campaign: utm_campaign,
       utm_source: utm_source,
@@ -96,14 +115,18 @@ module UniversalTrackManagerConcern
 
   def evict_visit!(old_visit)
     @visit_evicted = true
-    visit = UniversalTrackManager::Visit.create!(
-              first_pageload: now,
-              last_pageload: now,
-              original_visit_id: old_visit.original_visit_id.nil? ?  old_visit.id : old_visit.original_visit_id,
-              ip_v4_address: ip_address,
-              browser: find_or_create_browser_by_current,
-              campaign: find_or_create_campaign_by_current)
+    params = {
+      first_pageload: now,
+      last_pageload: now,
+      original_visit_id: old_visit.original_visit_id.nil? ?  old_visit.id : old_visit.original_visit_id,
+      ip_v4_address: ip_address,
+      campaign: find_or_create_campaign_by_current
+    }
+
+    # fail silently if there is no user agent
+    params[:browser] =  find_or_create_browser_by_current if request.user_agent
+    visit = UniversalTrackManager::Visit.create!(params)
 
     session[:visit_id] = visit.id
   end
-end
+end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module UniversalTrackManager
-  VERSION = "0.4"
-end
+  VERSION = "0.6.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universal-track-manager
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.6.2
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-23 00:00:00.000000000 Z
+date: 2020-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -60,10 +60,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/generators/templates/create_universal_track_manager_tables.rb
+- lib/generators/templates/universal_track_manager.rb
 - lib/generators/universal_track_manager/install_generator.rb
 - lib/railtie.rb
 - lib/universal-track-manager.rb
-- lib/universal_track_manager/base.rb
+- lib/universal_track_manager.rb
 - lib/universal_track_manager/controllers/concerns/universal_track_manager_concern.rb
 - lib/universal_track_manager/models/browser.rb
 - lib/universal_track_manager/models/campaign.rb
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A gem to track visitors to your website.

data/lib/universal_track_manager/base.rb

@@ -1,7 +0,0 @@
-module UniversalTrackManager
-  def self.config(options)
-    # set the config options
-    
-    
-  end
-end