universal-track-manager 0.5 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4312fd929dea85d8ab47c55a838559798b283ff744bccc41fdc520ed70b87f64
-  data.tar.gz: ca80c8c79dfe048917d9bdbb9e18dd6eec77ff3fb4aed584a7e7bf4fc52cd634
+  metadata.gz: 8712d19c21825899298ab6fb39d7d1d97299261003898e730db82e6b72fe44bf
+  data.tar.gz: c215ac7ba9ef0ce32bc9abf0c9d3742ed68e108103725b3b1ef74b71635336d1
 SHA512:
-  metadata.gz: 4b78e693a629d239e00344c42d518e77610376bd458c2d3e90bb07e387e1f0d6f3e7701200ec2cc923d07e49f9d7a647db4c1df2acab7d73decfdfffa511c967
-  data.tar.gz: c9e25b5b7bd96755ed6a889647662efa8c2c4d7ff723ace67783b4073b5b3c00c4395f8c5c6e4273bce81f85b23f53819a6df5cc9f27b6266a6047a5e4975934
+  metadata.gz: 513b88940fbd32c3e535c4b8e4eb4e43ffc797bbb5df8f8dd90b4b2faa94075557d44975c1a44714eaca871476095ff02ee73bc9f4790e937c4cb93d336e258a
+  data.tar.gz: 42a4c1af1fb267ca4280b3e25028d7a130ca76c0fbd79f4f0ad947eb1d167e5ce6c3f78211763ec7e652fecc09d9b5be6d645a0719606ec0f735aa1b179f5814

data/lib/generators/templates/create_universal_track_manager_tables.rb

@@ -4,22 +4,20 @@ class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_v
 
       create_table :browsers do |t|
         # this table gets automatically populated by inbound traffic
-        t.string :name, size: 255
+        t.string :name, limit: 255
+        t.timestamps
       end
 
       add_index :browsers, :name
 
       create_table :campaigns do |t|
         # this table gets automatically populated by inbound traffic
-        t.string :utm_source, limit: 50
-        t.string :utm_medium, limit: 50
-        t.string :utm_campaign, limit: 50
-        t.string :utm_content, limit: 50
-        t.string :utm_term, limit: 50
+#GENERATOR INSERTS CAMPAIGN COLUMNS HERE
+        t.string :sha1, limit: 40
         t.timestamps
       end
 
-      add_index :campaigns, [:utm_source, :utm_medium, :utm_campaign, :utm_content, :utm_term], name: "utm_all_combined"
+      add_index :campaigns, :sha1
 
       create_table :visits do |t|
         t.datetime :first_pageload
@@ -27,10 +25,11 @@ class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_v
         t.integer :original_visit_id
         t.integer :campaign_id
         t.integer :browser_id
-        t.string :ip_v4_address, length: 15
+        t.string :ip_v4_address, limit: 15
 
         t.integer :viewport_width
         t.integer :viewport_height
+        t.timestamps
       end
     end
   end

data/lib/generators/templates/universal_track_manager.rb

@@ -2,8 +2,8 @@ UniversalTrackManager.configure do |config|
   config.track_ips = true
   config.track_utms = true
   config.track_user_agent = true
-
+  #GENERATOR INSERTS CAMPAIGN COLUMN CONFIG HERE
 
   # config.track_referrer = false
 
-end
+end

data/lib/generators/universal_track_manager/install_generator.rb

@@ -1,4 +1,7 @@
-require 'rails/generators/active_record'
+
+require 'rails/generators'
+
+require 'byebug'
 
 module UniversalTrackManager
   class InstallGenerator < Rails::Generators::Base
@@ -9,6 +12,7 @@ module UniversalTrackManager
     source_root File.expand_path('../templates', __dir__)
 
     class_option :orm, type: 'boolean'
+    class_option :param_list, type: :string, default: 'utm_source,utm_medium,utm_campaign,utm_content,utm_term'
 
 
     def self.next_migration_number(path)
@@ -17,11 +21,21 @@ module UniversalTrackManager
 
     desc "Creates an initializer for Universal Track Manager and copy files to your application."
     def create_universal_track_manager_migration
-      migration_template "create_universal_track_manager_tables.rb",  "db/migrate/create_universal_track_manager_tables.rb"
+      @params = options['param_list']
+      column_defs = ""
+      @params.split(',').each  do |p|
+        column_defs += "          t.string :#{p}, limit:256\n"
+      end
+      copy_file "create_universal_track_manager_tables.rb", "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged"
+      gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMNS HERE", column_defs
+      migration_template "create_universal_track_manager_tables.rb-staged",  "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'
+      column_config = "config.campaign_columns = '#{options.param_list}'"
+      copy_file "universal_track_manager.rb", "#{self.class.source_root}/universal_track_manager.rb-staged"
+      gsub_file "#{self.class.source_root}/universal_track_manager.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMN CONFIG HERE", column_config
+      copy_file 'universal_track_manager.rb-staged', 'config/initializers/universal_track_manager.rb'
     end
 
     def migration_version

data/lib/universal_track_manager.rb

@@ -4,7 +4,7 @@ module UniversalTrackManager
   require "railtie.rb" if defined?(Rails)
 
   class Settings
-    attr_accessor :track_ips, :track_utms, :track_user_agent, :track_http_referrer
+    attr_accessor :track_ips, :track_utms, :track_user_agent, :track_http_referrer, :campaign_columns
   end
 
   def self.configure(&block)
@@ -13,7 +13,6 @@ module UniversalTrackManager
     block.call(@_settings)
   end
 
-
   def self.track_ips?
     @_settings.track_ips
   end
@@ -29,6 +28,15 @@ module UniversalTrackManager
   def self.track_http_referrer?
     @_settings.track_http_referrer
   end
+
+  def self.campaign_column_names
+    @campaign_column_names ||= @_settings.campaign_columns.split(',')
+  end
+
+    def self.campaign_column_symbols
+    @campaign_column_symbols ||= @_settings.campaign_columns.split(',').map{|c| c.to_sym}
+  end
+
 end
 
 

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

@@ -1,14 +1,22 @@
 module UniversalTrackManagerConcern
   extend ActiveSupport::Concern
-
   attr_accessor :visit_evicted
 
+
+
   included do
     before_action :track_visitor
+
+    UniversalTrackManager.campaign_column_symbols.each do |s|
+      define_method(s) do
+        return nil if ! UniversalTrackManager.track_utms?
+        permitted_utm_params[s]
+      end
+    end
   end
 
   def permitted_utm_params
-    params.permit(:utm_campaign, :utm_source, :utm_term, :utm_content, :utm_medium)
+    params.permit(*(UniversalTrackManager.campaign_column_symbols))
   end
 
 
@@ -22,43 +30,19 @@ module UniversalTrackManagerConcern
     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
-
   def now
     @now ||= Time.now
   end
 
   def new_visitor
-    visit = UniversalTrackManager::Visit.create!(
+    params = {
       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)
+      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
 
@@ -70,11 +54,7 @@ module UniversalTrackManagerConcern
       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 any_utm_params? && !existing_visit.matches_all_utms?(permitted_utm_params)
 
         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
@@ -91,7 +71,7 @@ module UniversalTrackManagerConcern
 
   def any_utm_params?
     return false if ! UniversalTrackManager.track_utms?
-    [:utm_campaign, :utm_source, :utm_medium, :utm_term, :utm_content].any? do |key|
+    UniversalTrackManager.campaign_column_symbols.any? do |key|
       params[key].present?
     end
   end
@@ -103,25 +83,32 @@ module UniversalTrackManagerConcern
 
   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,
-      utm_term: utm_term,
-      utm_content: utm_content,
-      utm_medium: utm_medium
-    )
+    gen_sha1 = gen_campaign_key(permitted_utm_params)
+
+    # find_or_create_by finding only by sha1 would be nice here, but how to do so with a dynamic set of columns?
+    # we've got a small chance of dups here due to the non-atomic find/create and sha1, but that's ok for this application.
+    c = UniversalTrackManager::Campaign.find_by(sha1: gen_sha1)
+    c ||= UniversalTrackManager::Campaign.create(*(permitted_utm_params.merge({"sha1": gen_sha1})))
+  end
+
+  def gen_campaign_key(params)
+    Digest::SHA1.hexdigest(params.keys.map{|k| k.downcase()}.sort.map{|k| {"#{k}":  params[k]}}.to_s)
   end
 
   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/universal_track_manager/models/visit.rb

@@ -9,16 +9,17 @@ class UniversalTrackManager::Visit < ActiveRecord::Base
     if !campaign
       # this visit has no campaign, which means all UTMs = null
       # if any of the UTMs are present, return false (they don't match null)
-      return ! [:utm_campaign, :utm_source, :utm_medium, :utm_term, :utm_content].any? do |key|
+      return ! UniversalTrackManager.campaign_column_symbols.any? do |key|
         params[key].present?
       end
     end
 
     # note params are allowed to be missing
-    return campaign.utm_campaign == params[:utm_campaign] &&
-      campaign.utm_source == params[:utm_source] &&
-      campaign.utm_medium == params[:utm_medium] &&
-      campaign.utm_term == params[:utm_term] &&
-      campaign.utm_content == params[:utm_content]
+    UniversalTrackManager.campaign_column_symbols.each do |c|
+      if (campaign[c] && (campaign[c] != params[c])) || (!campaign[c] && params[c])
+        return false
+      end
+    end
+    return true
   end
 end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module UniversalTrackManager
-  VERSION = "0.5"
-end
+  VERSION = "0.7.1"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universal-track-manager
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: 0.7.1
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,30 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -70,11 +84,13 @@ files:
 - lib/universal_track_manager/models/campaign.rb
 - lib/universal_track_manager/models/visit.rb
 - lib/version.rb
-homepage: http://rubygems.org/gems/unverisal-track-manager
+homepage: https://blog.jasonfleetwoodboldt.com/my-open-source-projects/universal-track-manager/
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/jasonfb/universal_track_manager
+  documentation_uri: https://jfb.teachable.com/p/gems-by-jason
+  homepage_uri: https://blog.jasonfleetwoodboldt.com/my-open-source-projects/universal-track-manager/
 post_install_message: |
   ---------------------------------------------
   Welcome to Universal Track Manager
@@ -96,8 +112,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
 summary: A gem to track visitors to your website.
 test_files: []