universal-track-manager 0.7.0.alpha → 0.7.5.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d480176796bb905c66f3e4eb2904402232548966be5183768033636b9e50d7b
-  data.tar.gz: 0a7762ea705d448444a4113e254c49ba9e77588a4880197c5244e46388266637
+  metadata.gz: 06de91d3860d6f3e8000f622b2ab6209e723f492bce5548891569586e2855c6a
+  data.tar.gz: efb6b01f09df116b2d7b66273f276c907f2da61c3a1a41b9de29886e69b16611
 SHA512:
-  metadata.gz: 99679f236136ab3eed671f2a0319cd01e53ca833589b97fab3e289eaa1fb5647bce188e0d4fbce05c9b5ef9ed0e09f65669e84ac2920c5430fbb1b89f03e0083
-  data.tar.gz: 6997c26bf61ecbcb8e4867a3dfac99158d4b885209248746c364178acd3405698a8e210204d0a619f34c6a0c8fb8ef4badd4f24bb105292a9d5c9dbef47e1bc0
+  metadata.gz: 8ce9e03d5f717be02df2515a91c9e708f6228befbce12d30df9ac6761a8a6d162ac602d17451d28a9100d2f82a32defae3e46ce2881e9d22c6eaa9540328ae25
+  data.tar.gz: 54fb059bf6f826609f4b3c19af8d8be265a13271b1898be044c563f0ce159925f04e0862ff508cbff0303dd1110f9e2cddf3c94dd4ad32d2558be17e51647df1

data/lib/generators/templates/create_universal_track_manager_tables.rb

@@ -4,7 +4,8 @@ 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
@@ -12,10 +13,11 @@ class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_v
       create_table :campaigns do |t|
         # this table gets automatically populated by inbound traffic
 #GENERATOR INSERTS CAMPAIGN COLUMNS HERE
+        t.string :sha1, limit: 40
         t.timestamps
       end
 
-      #GENERATOR INSERTS CAMPAIGN INDEX HERE
+      add_index :campaigns, :sha1
 
       create_table :visits do |t|
         t.datetime :first_pageload
@@ -23,10 +25,12 @@ 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.integer :count, default: 1
+        t.timestamps
       end
     end
   end

data/lib/generators/universal_track_manager/install_generator.rb

@@ -1,8 +1,6 @@
 
 require 'rails/generators'
 
-require 'byebug'
-
 module UniversalTrackManager
   class InstallGenerator < Rails::Generators::Base
     include Rails::Generators::Migration
@@ -12,7 +10,13 @@ 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'
+
+    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)
@@ -21,19 +25,45 @@ module UniversalTrackManager
 
     desc "Creates an initializer for Universal Track Manager and copy files to your application."
     def create_universal_track_manager_migration
-      @params = options['param_list']
+      # 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 = ""
-      @params.split(',').each  do |p|
+      @default_params.each  do |p|
         column_defs += "          t.string :#{p}, limit:256\n"
       end
-
-      index_def = "add_index :campaigns, #{@params.split(',').map{|c| c.to_sym}.to_s}, name: 'utm_all_combined'"
       copy_file "create_universal_track_manager_tables.rb", "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged"
-      byebug
       gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMNS HERE", column_defs
-      byebug
-      gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "#GENERATOR INSERTS CAMPAIGN INDEX HERE", index_def
       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
@@ -41,6 +71,7 @@ module UniversalTrackManager
       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/controllers/concerns/universal_track_manager_concern.rb

@@ -27,7 +27,7 @@ module UniversalTrackManagerConcern
 
   def user_agent
     return nil if ! UniversalTrackManager.track_user_agent?
-    request.user_agent[0..255]
+    request.user_agent[0..254]
   end
 
   def now
@@ -83,9 +83,16 @@ module UniversalTrackManagerConcern
 
   def find_or_create_campaign_by_current
     return nil if ! UniversalTrackManager.track_utms?
-    campaign = UniversalTrackManager::Campaign.find_or_create_by(
-      *permitted_utm_params
-    )
+    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)
@@ -94,12 +101,16 @@ module UniversalTrackManagerConcern
       first_pageload: now,
       last_pageload: now,
       original_visit_id: old_visit.original_visit_id.nil? ?  old_visit.id : old_visit.original_visit_id,
+      count: old_visit.original_visit_id.nil? ?  old_visit.count + 1 : 1,
       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
+    if request.user_agent
+      params[:browser] =  find_or_create_browser_by_current
+    end
+
     visit = UniversalTrackManager::Visit.create!(params)
 
     session[:visit_id] = visit.id

data/lib/universal_track_manager/models/visit.rb

@@ -4,6 +4,7 @@ class UniversalTrackManager::Visit < ActiveRecord::Base
   belongs_to :campaign, class_name: "UniversalTrackManager::Campaign"
   belongs_to :browser, class_name: "UniversalTrackManager::Browser"
 
+  belongs_to :original_visit, optional: true
 
   def matches_all_utms?(params)
     if !campaign
@@ -16,7 +17,7 @@ class UniversalTrackManager::Visit < ActiveRecord::Base
 
     # note params are allowed to be missing
     UniversalTrackManager.campaign_column_symbols.each do |c|
-      if campaign[c] != params[c]
+      if (campaign[c] && (campaign[c] != params[c])) || (!campaign[c] && params[c])
         return false
       end
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module UniversalTrackManager
-  VERSION = "0.7.0.alpha"
+  VERSION = "0.7.5.alpha2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universal-track-manager
 version: !ruby/object:Gem::Version
-  version: 0.7.0.alpha
+  version: 0.7.5.alpha2
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -68,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: []
@@ -84,13 +84,12 @@ files:
 - lib/universal_track_manager/models/campaign.rb
 - lib/universal_track_manager/models/visit.rb
 - lib/version.rb
-homepage: https://blog.jasonfleetwoodboldt.com/my-open-source-projects/universal-track-manager/
+homepage: https://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/
+  homepage_uri: https://github.com/jasonfb/universal_track_manager
 post_install_message: |
   ---------------------------------------------
   Welcome to Universal Track Manager
@@ -112,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.7
+rubygems_version: 3.1.6
 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: []