universal-track-manager 0.8 → 0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/generators/templates/create_universal_track_manager_tables.rb +11 -8
- data/lib/generators/templates/universal_track_manager.rb +1 -0
- data/lib/generators/universal_track_manager/install_generator.rb +10 -2
- data/lib/universal_track_manager/controllers/concerns/universal_track_manager_concern.rb +14 -11
- data/lib/universal_track_manager/models/browser.rb +4 -2
- data/lib/universal_track_manager/models/campaign.rb +4 -2
- data/lib/universal_track_manager/models/visit.rb +3 -1
- data/lib/universal_track_manager.rb +12 -1
- data/lib/version.rb +1 -1
- metadata +7 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 74a4a72e51d99c98b5b16b49ca2845d022849567444342f4950243a708b47e86
|
|
4
|
+
data.tar.gz: edcc46786f0ac9590f4b1a8301d419d61336b6bf78b2ec9535f99c50311ce980
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b5f2e6d1ac6690b475b19e39578b818609f6e83fd6eb7b7822eebfc8fc438c9798610da4c8a5b32f6849056f1a1ae2721ed3b3d45938dfb0eedccc63505faa08
|
|
7
|
+
data.tar.gz: bb9501a4f90fce92057c71a9c19ab522636c172d812c39e295a9af85b59eb127dc281553d751b6059eac0f885649c7e4f4bfd4847d6da82dbc590000532e7312
|
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_version %>
|
|
2
2
|
def self.up
|
|
3
3
|
ActiveRecord::Base.transaction do
|
|
4
|
+
prefix = "<%= @table_prefix %>"
|
|
4
5
|
|
|
5
|
-
create_table :browsers do |t|
|
|
6
|
+
create_table :"#{prefix}browsers" do |t|
|
|
6
7
|
# this table gets automatically populated by inbound traffic
|
|
7
8
|
t.string :name, limit: 255
|
|
8
9
|
t.timestamps
|
|
9
10
|
end
|
|
10
11
|
|
|
11
|
-
add_index :browsers, :name
|
|
12
|
+
add_index :"#{prefix}browsers", :name
|
|
12
13
|
|
|
13
|
-
create_table :campaigns do |t|
|
|
14
|
+
create_table :"#{prefix}campaigns" do |t|
|
|
14
15
|
# this table gets automatically populated by inbound traffic
|
|
15
16
|
#GENERATOR INSERTS CAMPAIGN COLUMNS HERE
|
|
16
17
|
t.string :sha1, limit: 40
|
|
@@ -18,9 +19,9 @@ class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_v
|
|
|
18
19
|
t.timestamps
|
|
19
20
|
end
|
|
20
21
|
|
|
21
|
-
add_index :campaigns, :sha1
|
|
22
|
+
add_index :"#{prefix}campaigns", :sha1
|
|
22
23
|
|
|
23
|
-
create_table :visits do |t|
|
|
24
|
+
create_table :"#{prefix}visits" do |t|
|
|
24
25
|
t.datetime :first_pageload
|
|
25
26
|
t.datetime :last_pageload
|
|
26
27
|
t.integer :original_visit_id
|
|
@@ -38,9 +39,11 @@ class CreateUniversalTrackManagerTables < ActiveRecord::Migration<%= migration_v
|
|
|
38
39
|
|
|
39
40
|
def self.down
|
|
40
41
|
ActiveRecord::Base.transaction do
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
drop_table :
|
|
42
|
+
prefix = "<%= @table_prefix %>"
|
|
43
|
+
|
|
44
|
+
drop_table :"#{prefix}browsers"
|
|
45
|
+
drop_table :"#{prefix}visits"
|
|
46
|
+
drop_table :"#{prefix}campaigns"
|
|
44
47
|
end
|
|
45
48
|
end
|
|
46
49
|
end
|
|
@@ -5,6 +5,7 @@ UniversalTrackManager.configure do |config|
|
|
|
5
5
|
#GENERATOR INSERTS CAMPAIGN COLUMN CONFIG HERE
|
|
6
6
|
|
|
7
7
|
config.campaign_columns = 'utm_source,utm_medium,utm_campaign,utm_term,utm_content'
|
|
8
|
+
# config.table_prefix = 'utm' # prefix all UTM tables (e.g., utm_campaigns, utm_browsers, utm_visits)
|
|
8
9
|
# config.track_referrer = true
|
|
9
10
|
# config.track_gclid_present = true # be sure to add gclid to campaign_columns
|
|
10
11
|
end
|
|
@@ -17,6 +17,7 @@ module UniversalTrackManager
|
|
|
17
17
|
|
|
18
18
|
class_option :add, type: :string, default: nil
|
|
19
19
|
class_option :only, type: :string, default: nil
|
|
20
|
+
class_option :table_prefix, type: :string, default: ""
|
|
20
21
|
|
|
21
22
|
|
|
22
23
|
def self.next_migration_number(path)
|
|
@@ -55,21 +56,28 @@ module UniversalTrackManager
|
|
|
55
56
|
end
|
|
56
57
|
end
|
|
57
58
|
|
|
59
|
+
@table_prefix = options['table_prefix'].present? ? "#{options['table_prefix']}_" : ""
|
|
60
|
+
|
|
58
61
|
column_defs = ""
|
|
59
62
|
@default_params.each do |p|
|
|
60
63
|
column_defs += " t.string :#{p}, limit:256\n"
|
|
61
64
|
end
|
|
62
65
|
copy_file "create_universal_track_manager_tables.rb", "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged"
|
|
63
66
|
gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMNS HERE", column_defs
|
|
67
|
+
gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "<%= @table_prefix %>", @table_prefix
|
|
68
|
+
gsub_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged", "<%= migration_version %>", migration_version.to_s
|
|
64
69
|
migration_template "create_universal_track_manager_tables.rb-staged", "db/migrate/create_universal_track_manager_tables.rb"
|
|
65
70
|
|
|
66
71
|
remove_file "#{self.class.source_root}/create_universal_track_manager_tables.rb-staged"
|
|
67
72
|
end
|
|
68
73
|
|
|
69
74
|
def create_universal_track_manager_initializer
|
|
70
|
-
|
|
75
|
+
@table_prefix_value = options['table_prefix']
|
|
76
|
+
column_config = "config.campaign_columns = '#{@default_params.join(',')}'"
|
|
77
|
+
table_prefix_config = options['table_prefix'].present? ? "\n config.table_prefix = '#{options['table_prefix']}'" : ""
|
|
78
|
+
|
|
71
79
|
copy_file "universal_track_manager.rb", "#{self.class.source_root}/universal_track_manager.rb-staged"
|
|
72
|
-
gsub_file "#{self.class.source_root}/universal_track_manager.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMN CONFIG HERE", column_config
|
|
80
|
+
gsub_file "#{self.class.source_root}/universal_track_manager.rb-staged", "#GENERATOR INSERTS CAMPAIGN COLUMN CONFIG HERE", "#{column_config}#{table_prefix_config}"
|
|
73
81
|
copy_file 'universal_track_manager.rb-staged', 'config/initializers/universal_track_manager.rb'
|
|
74
82
|
remove_file "#{self.class.source_root}/universal_track_manager.rb-staged"
|
|
75
83
|
end
|
|
@@ -41,7 +41,9 @@ module UniversalTrackManagerConcern
|
|
|
41
41
|
ip_v4_address: ip_address,
|
|
42
42
|
campaign: find_or_create_campaign_by_current
|
|
43
43
|
}
|
|
44
|
-
|
|
44
|
+
if request.referrer && !request.referrer.include?(request.host)
|
|
45
|
+
params[:referer] = request.referer if UniversalTrackManager.track_http_referrer?
|
|
46
|
+
end
|
|
45
47
|
params[:browser] = find_or_create_browser_by_current if request.user_agent
|
|
46
48
|
visit = UniversalTrackManager::Visit.create!(params)
|
|
47
49
|
session[:visit_id] = visit.id
|
|
@@ -68,15 +70,16 @@ module UniversalTrackManagerConcern
|
|
|
68
70
|
existing_visit.browser.name != user_agent
|
|
69
71
|
evict_visit!(existing_visit)
|
|
70
72
|
end
|
|
73
|
+
|
|
74
|
+
if (UniversalTrackManager.track_http_referrer?)
|
|
75
|
+
if existing_visit.referer == request.referer
|
|
71
76
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
!request.referrer.include?(request.host) &&
|
|
76
|
-
existing_visit.referer != request.referer))
|
|
77
|
-
evict_visit!(existing_visit)
|
|
77
|
+
elsif request.referrer && !request.referrer.include?(request.host)
|
|
78
|
+
evict_visit!(existing_visit)
|
|
79
|
+
end
|
|
78
80
|
end
|
|
79
81
|
|
|
82
|
+
|
|
80
83
|
existing_visit.update_columns(:last_pageload => Time.now) if !@visit_evicted
|
|
81
84
|
rescue ActiveRecord::RecordNotFound
|
|
82
85
|
# this happens if the session table is cleared or if the record in the session
|
|
@@ -101,16 +104,16 @@ module UniversalTrackManagerConcern
|
|
|
101
104
|
|
|
102
105
|
def find_or_create_campaign_by_current
|
|
103
106
|
return nil if ! UniversalTrackManager.track_utms?
|
|
104
|
-
|
|
107
|
+
params_without_glcid = permitted_utm_params.tap{|x| x.delete("gclid")}
|
|
105
108
|
|
|
109
|
+
gen_sha1 = gen_campaign_key(params_without_glcid)
|
|
106
110
|
|
|
107
111
|
gclid_present = UniversalTrackManager.track_gclid_present? && permitted_utm_params[:gclid].present?
|
|
108
112
|
|
|
109
113
|
campaign = UniversalTrackManager::Campaign.find_by(sha1: gen_sha1,
|
|
110
|
-
|
|
114
|
+
gclid_present: gclid_present)
|
|
111
115
|
|
|
112
|
-
|
|
113
|
-
campaign ||= UniversalTrackManager::Campaign.create(*(without_glcid.merge({
|
|
116
|
+
campaign ||= UniversalTrackManager::Campaign.create(*(params_without_glcid.merge({
|
|
114
117
|
sha1: gen_sha1,
|
|
115
118
|
gclid_present: gclid_present
|
|
116
119
|
})))
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
class UniversalTrackManager::Visit < ActiveRecord::Base
|
|
2
|
-
self.table_name
|
|
2
|
+
def self.table_name
|
|
3
|
+
UniversalTrackManager.prefixed_table_name("visits")
|
|
4
|
+
end
|
|
3
5
|
|
|
4
6
|
belongs_to :campaign, class_name: "UniversalTrackManager::Campaign"
|
|
5
7
|
belongs_to :browser, class_name: "UniversalTrackManager::Browser"
|
|
@@ -9,12 +9,14 @@ module UniversalTrackManager
|
|
|
9
9
|
:track_user_agent,
|
|
10
10
|
:track_http_referrer,
|
|
11
11
|
:campaign_columns,
|
|
12
|
-
:track_gclid_present
|
|
12
|
+
:track_gclid_present,
|
|
13
|
+
:table_prefix
|
|
13
14
|
end
|
|
14
15
|
|
|
15
16
|
|
|
16
17
|
def self.configure(&block)
|
|
17
18
|
@_settings = Settings.new
|
|
19
|
+
@_settings.table_prefix = "" # default: no prefix (backward compatible)
|
|
18
20
|
|
|
19
21
|
block.call(@_settings)
|
|
20
22
|
end
|
|
@@ -39,6 +41,15 @@ module UniversalTrackManager
|
|
|
39
41
|
@_settings.track_gclid_present
|
|
40
42
|
end
|
|
41
43
|
|
|
44
|
+
def self.table_prefix
|
|
45
|
+
@_settings&.table_prefix || ""
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
def self.prefixed_table_name(base_name)
|
|
49
|
+
prefix = table_prefix
|
|
50
|
+
prefix.present? ? "#{prefix}_#{base_name}" : base_name
|
|
51
|
+
end
|
|
52
|
+
|
|
42
53
|
def self.campaign_column_names
|
|
43
54
|
@campaign_column_names ||= @_settings.campaign_columns.split(',')
|
|
44
55
|
end
|
data/lib/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: universal-track-manager
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: '0.
|
|
4
|
+
version: '0.9'
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Jason Fleetwood-Boldt
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2026-05-08 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rails
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
17
|
+
- - ">="
|
|
18
18
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
19
|
+
version: 7.0.8
|
|
20
20
|
type: :runtime
|
|
21
21
|
prerelease: false
|
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
23
|
requirements:
|
|
24
|
-
- - "
|
|
24
|
+
- - ">="
|
|
25
25
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
26
|
+
version: 7.0.8
|
|
27
27
|
- !ruby/object:Gem::Dependency
|
|
28
28
|
name: simplecov
|
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
112
112
|
- !ruby/object:Gem::Version
|
|
113
113
|
version: '0'
|
|
114
114
|
requirements: []
|
|
115
|
-
rubygems_version: 3.5.
|
|
115
|
+
rubygems_version: 3.5.22
|
|
116
116
|
signing_key:
|
|
117
117
|
specification_version: 4
|
|
118
118
|
summary: A gem to track visitors and their UTMs to your website.
|