universal-track-manager 0.6.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3906b1056d94f2c92bdf86c2e3899d463a77a94a76a3fbd45e0afd751f9e7945
-  data.tar.gz: 36f420592997d79741c34e063ac4fe57899745cf38c8dce0316e8e334e6a7142
+  metadata.gz: effef80c0b51a369cb052778fd2302cbbc1d539eeaf4d784ad72957c3e457ffb
+  data.tar.gz: 1a9d7c3be57907198257122951066fec7174070722259c02d160b4fa05f84eb3
 SHA512:
-  metadata.gz: 106a32e556cb93a3654d4b0efe240fb265405065e00248383eb034101ed2699077fb537fe2404db0d4087235ffbe91be2ba0b5361aad3b95b811d07258af5d7f
-  data.tar.gz: 8d926fb725317451e5a94a76a2509196c5abfcfd280ce1dc20cd34a645bbcc82887fe08e27f5e08549a2b3fb5d5b1bc9aa30e3ab492e559265a173b9316315a9
+  metadata.gz: d867d446f49b6fb992028a386ff14923c2bd119f0ccd15094e8dd29711c425c7da8e693ee92ca096c9957a5e98695c6887f62e61763e73f3f183df05419c9e8e
+  data.tar.gz: 90d080c638b06defa502d1e04b81dfe88ca42f7c9d33311b0db01fd39420c5bb3a1d9d993471ff12ccf2a7b93ba0a6b78ea6119af41b0f0a2edd446fa041ade4

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,5 @@
-require 'rails/generators/active_record'
+
+require 'rails/generators'
 
 module UniversalTrackManager
   class InstallGenerator < Rails::Generators::Base
@@ -10,6 +11,13 @@ module UniversalTrackManager
 
     class_option :orm, type: 'boolean'
 
+    class_option :param_list, type: :string, default: nil # DEPRECATED --- DO NOT USE
+
+
+
+    class_option :add, type: :string, default: nil
+    class_option :only, type: :string, default: nil
+
 
     def self.next_migration_number(path)
       Time.now.utc.strftime("%Y%m%d%H%M%S")
@@ -17,11 +25,53 @@ 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"
+      # guard against pre-0.7.3 sytnax
+      if options['param_list']
+        puts "Oops (FATAL): param_list is removed; use 'add' to augment the default list of fields or use 'only' to replace it"
+        exit
+      end
+
+      # guard against using both 'add' and 'only'
+      if options['add'] && options['only']
+        puts "Oops (FATAL): You specified both 'add' and 'only'; use 'add' to augment the default list of fields OR use 'only' to replace it"
+        exit
+      end
+
+      @default_params = %w{utm_source utm_medium utm_campaign utm_content utm_term}
+
+      if options['add']
+        options['add'].split(",").each  do |p|
+          if !@default_params.include?(p)
+            @default_params << p
+          end
+        end
+      end
+
+
+      if options['only']
+        @default_params = []
+        options['only'].split(",").each  do |p|
+          @default_params << p
+        end
+      end
+
+      column_defs = ""
+      @default_params.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"
+
+      remove_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged"
     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'
+      remove_file "#{self.class.source_root}/universal_track_manager.rb-staged"
     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

@@ -2,12 +2,21 @@ 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
 
 
@@ -18,33 +27,7 @@ module UniversalTrackManagerConcern
 
   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]
+    request.user_agent[0..254]
   end
 
   def now
@@ -71,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
@@ -92,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
@@ -104,13 +83,16 @@ 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)

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.6.2"
+  VERSION = "0.7.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universal-track-manager
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-01 00:00:00.000000000 Z
+date: 2021-03-19 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
@@ -54,7 +68,7 @@ dependencies:
         version: '2.2'
 description: Simple, plug & play visitor tracking by user agent (browser), IP address,
   referrer, and UTM parameters.
-email: jason.fb@datatravels.com
+email: tech@datatravels.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -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.1.4
-signing_key: 
+rubygems_version: 3.2.7
+signing_key:
 specification_version: 4
-summary: A gem to track visitors to your website.
+summary: A gem to track visitors and their UTMs to your website.
 test_files: []