gtm_on_rails 0.1.13 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/gtm_on_rails/models/data_layer/ecommerce.rb +135 -113
- data/lib/gtm_on_rails/models/data_layer.rb +1 -1
- data/lib/gtm_on_rails/version.rb +1 -1
- metadata +17 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 0a1d30ad5b49fdeae729c10fb879ded9fc61bd3557919aa93e8330c47aa13dd2
|
4
|
+
data.tar.gz: 347f7d18f051cccbe677fd34f67a38bd9122fef7db3bfbd69dc625a2c8f7f860
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f3ab1d893005964e412cd77929cb754a5e7ab75de59ffdfa1ed4eaac3e3c7737470f541a853a9b644126fc6fa26bacec6e64b494bac9089b6be063111990a4a
|
7
|
+
data.tar.gz: d55a79ca0f9c6755c5b4beb9bdfb3ba5f516df376c70945e1ea765175726b3eadd5354a8d3000c2fa5c4b4144cd033b03bc589b362d5ab5b84c78e891404768c
|
@@ -3,15 +3,10 @@ module GtmOnRails
|
|
3
3
|
class DataLayer::Ecommerce < DataLayer::Object
|
4
4
|
ACTIVITY_TYPES = [:product_impression, :product_click, :product_detail, :add_to_cart, :remove_from_cart, :promotion_impression, :promotion_click, :checkout, :purchase, :refund]
|
5
5
|
|
6
|
-
def initialize(activity_type,
|
6
|
+
def initialize(activity_type, **args)
|
7
7
|
raise ArgumentError.new("'#{activity_type}' is undefined activity type.") unless activity_type.in?(ACTIVITY_TYPES)
|
8
8
|
|
9
|
-
|
10
|
-
if args.first.keys.count == 1 && args.first.keys.first.to_sym == :sanitize
|
11
|
-
sanitize = args.shift[:sanitize]
|
12
|
-
end
|
13
|
-
|
14
|
-
@data = send(:"generate_#{activity_type}_hash", *[sanitize, args.first]).with_indifferent_access
|
9
|
+
@data = send(:"generate_#{activity_type}_hash", args).with_indifferent_access
|
15
10
|
end
|
16
11
|
|
17
12
|
class << self
|
@@ -29,187 +24,214 @@ module GtmOnRails
|
|
29
24
|
end
|
30
25
|
|
31
26
|
private
|
27
|
+
def generate_product_impression_hash(args)
|
28
|
+
result = {}
|
32
29
|
|
33
|
-
|
34
|
-
result = get_default_data(args)
|
35
|
-
|
36
|
-
result[:event] = args.delete(:event) if args[:event].present?
|
30
|
+
result[:event] = args[:event] if args[:event].present?
|
37
31
|
|
38
|
-
result[:ecommerce]
|
32
|
+
result[:ecommerce] = {}
|
33
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
39
34
|
|
40
|
-
|
35
|
+
if args[:impressions].present?
|
36
|
+
result[:ecommerce][:impressions] = args[:impressions].map{|impression| impression.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Impression.new(impression) : impression}
|
37
|
+
end
|
41
38
|
|
42
39
|
return result
|
43
40
|
end
|
44
41
|
|
45
|
-
def generate_product_click_hash(
|
46
|
-
result =
|
47
|
-
|
48
|
-
result[:event] = args.delete(:event) || 'productClick'
|
42
|
+
def generate_product_click_hash(args)
|
43
|
+
result = {}
|
49
44
|
|
50
|
-
result[:
|
51
|
-
result[:event_action] = args.delete(:event_action) || 'Product Click'
|
52
|
-
result[:event_label] = args.delete(:event_label) || 'Enhanced Ecommerce Product Click'
|
45
|
+
result[:event] = args[:event] || 'productClick'
|
53
46
|
|
54
|
-
result[:
|
55
|
-
result[:
|
56
|
-
result[:
|
57
|
-
|
58
|
-
result.merge!(args) unless sanitize
|
59
|
-
|
60
|
-
return result
|
61
|
-
end
|
47
|
+
result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
|
48
|
+
result[:event_action] = args[:event_action] || 'Product Click'
|
49
|
+
result[:event_label] = args[:event_label] || 'Enhanced Ecommerce Product Click'
|
62
50
|
|
63
|
-
|
64
|
-
result =
|
51
|
+
result[:ecommerce] = {}
|
52
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
65
53
|
|
66
|
-
result[:
|
54
|
+
result[:ecommerce][:click] = {}
|
67
55
|
|
68
|
-
|
69
|
-
|
70
|
-
|
56
|
+
if args[:action].present?
|
57
|
+
action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
|
58
|
+
result[:ecommerce][:click][:actionField] = action
|
59
|
+
end
|
71
60
|
|
72
|
-
|
61
|
+
if args[:products].present?
|
62
|
+
result[:ecommerce][:click][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
63
|
+
end
|
73
64
|
|
74
65
|
return result
|
75
66
|
end
|
76
67
|
|
77
|
-
def
|
78
|
-
result =
|
68
|
+
def generate_product_detail_hash(args)
|
69
|
+
result = {}
|
79
70
|
|
80
|
-
result[:event] = args
|
71
|
+
result[:event] = args[:event] if args[:event].present?
|
81
72
|
|
82
|
-
result[:
|
83
|
-
result[:
|
84
|
-
result[:event_label] = args.delete(:event_label) || 'Enhanced Ecommerce Add to Cart'
|
73
|
+
result[:ecommerce] = {}
|
74
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
85
75
|
|
86
|
-
result[:ecommerce][:
|
87
|
-
result[:ecommerce][:add][:products] = get_products(args) if args[:products].present?
|
76
|
+
result[:ecommerce][:detail] = {}
|
88
77
|
|
89
|
-
|
78
|
+
if args[:action].present?
|
79
|
+
action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
|
80
|
+
result[:ecommerce][:detail][:actionField] = action
|
81
|
+
end
|
82
|
+
|
83
|
+
if args[:products].present?
|
84
|
+
result[:ecommerce][:detail][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
85
|
+
end
|
90
86
|
|
91
87
|
return result
|
92
88
|
end
|
93
89
|
|
94
|
-
def
|
95
|
-
result =
|
90
|
+
def generate_add_to_cart_hash(args)
|
91
|
+
result = {}
|
96
92
|
|
97
|
-
result[:event] = args
|
93
|
+
result[:event] = args[:event] || 'addToCart'
|
98
94
|
|
99
|
-
result[:event_category] = args
|
100
|
-
result[:event_action] = args
|
101
|
-
result[:event_label] = args
|
95
|
+
result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
|
96
|
+
result[:event_action] = args[:event_action] || 'Add to Cart'
|
97
|
+
result[:event_label] = args[:event_label] || 'Enhanced Ecommerce Add to Cart'
|
102
98
|
|
103
|
-
result[:ecommerce]
|
104
|
-
result[:ecommerce][:
|
99
|
+
result[:ecommerce] = {}
|
100
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
105
101
|
|
106
|
-
result
|
102
|
+
result[:ecommerce][:add] = {}
|
103
|
+
if args[:products].present?
|
104
|
+
result[:ecommerce][:add][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
105
|
+
end
|
107
106
|
|
108
107
|
return result
|
109
108
|
end
|
110
109
|
|
111
|
-
def
|
112
|
-
result =
|
110
|
+
def generate_remove_from_cart_hash(args)
|
111
|
+
result = {}
|
112
|
+
|
113
|
+
result[:event] = args[:event] || 'removeFromCart'
|
113
114
|
|
114
|
-
result[:
|
115
|
+
result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
|
116
|
+
result[:event_action] = args[:event_action] || 'Remove from Cart'
|
117
|
+
result[:event_label] = args[:event_label] || 'Enhanced Ecommerce Remove from Cart'
|
115
118
|
|
116
|
-
result[:ecommerce]
|
117
|
-
result[:ecommerce][:
|
119
|
+
result[:ecommerce] = {}
|
120
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
118
121
|
|
119
|
-
result
|
122
|
+
result[:ecommerce][:remove] = {}
|
123
|
+
if args[:products].present?
|
124
|
+
result[:ecommerce][:remove][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
125
|
+
end
|
120
126
|
|
121
127
|
return result
|
122
128
|
end
|
123
129
|
|
124
|
-
def
|
125
|
-
result =
|
130
|
+
def generate_promotion_impression_hash(args)
|
131
|
+
result = {}
|
126
132
|
|
127
|
-
result[:event] = args
|
133
|
+
result[:event] = args[:event] if args[:event].present?
|
128
134
|
|
129
|
-
result[:
|
130
|
-
result[:
|
131
|
-
result[:event_label] = args.delete(:event_label) || 'Enhanced Ecommerce Promotion Click'
|
135
|
+
result[:ecommerce] = {}
|
136
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
132
137
|
|
133
|
-
result[:ecommerce][:
|
134
|
-
result[:ecommerce][:promoClick][:promotions] = get_promotion(args) if args[:promotions].present?
|
138
|
+
result[:ecommerce][:promoView] = {}
|
135
139
|
|
136
|
-
|
140
|
+
if args[:promotions].present?
|
141
|
+
result[:ecommerce][:promoView][:promotions] = args[:promotions].map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
|
142
|
+
end
|
137
143
|
|
138
144
|
return result
|
139
145
|
end
|
140
146
|
|
141
|
-
def
|
142
|
-
result =
|
147
|
+
def generate_promotion_click_hash(args)
|
148
|
+
result = {}
|
143
149
|
|
144
|
-
result[:event] = args
|
150
|
+
result[:event] = args[:event] || 'promotionClick'
|
145
151
|
|
146
|
-
result[:event_category] = args
|
147
|
-
result[:event_action] = args
|
148
|
-
result[:event_label] = args
|
152
|
+
result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
|
153
|
+
result[:event_action] = args[:event_action] || 'Promotion Click'
|
154
|
+
result[:event_label] = args[:event_label] || 'Enhanced Ecommerce Promotion Click'
|
149
155
|
|
150
|
-
result[:ecommerce]
|
151
|
-
result[:ecommerce][:
|
152
|
-
result[:ecommerce][:checkout][:products] = get_products(args) if args[:products].present?
|
156
|
+
result[:ecommerce] = {}
|
157
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
153
158
|
|
154
|
-
result
|
159
|
+
result[:ecommerce][:promoClick] = {}
|
160
|
+
|
161
|
+
if args[:promotions].present?
|
162
|
+
result[:ecommerce][:promoClick][:promotions] = args[:promotions].map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
|
163
|
+
end
|
155
164
|
|
156
165
|
return result
|
157
166
|
end
|
158
167
|
|
159
|
-
def
|
160
|
-
result =
|
168
|
+
def generate_checkout_hash(args)
|
169
|
+
result = {}
|
170
|
+
|
171
|
+
result[:event] = args[:event] || 'checkout'
|
161
172
|
|
162
|
-
result[:
|
173
|
+
result[:event_category] = args[:event_category] || 'Enhanced Ecommerce'
|
174
|
+
result[:event_action] = args[:event_action] || 'Checkout'
|
175
|
+
result[:event_label] = args[:event_label] || 'Enhanced Ecommerce Checkout'
|
163
176
|
|
164
|
-
result[:ecommerce]
|
165
|
-
result[:ecommerce][:
|
166
|
-
result[:ecommerce][:purchase][:products] = get_products(args) if args[:products].present?
|
177
|
+
result[:ecommerce] = {}
|
178
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
167
179
|
|
168
|
-
result
|
180
|
+
result[:ecommerce][:checkout] = {}
|
181
|
+
|
182
|
+
if args[:action].present?
|
183
|
+
action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
|
184
|
+
result[:ecommerce][:checkout][:actionField] = action
|
185
|
+
end
|
186
|
+
|
187
|
+
if args[:products].present?
|
188
|
+
result[:ecommerce][:checkout][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
189
|
+
end
|
169
190
|
|
170
191
|
return result
|
171
192
|
end
|
172
193
|
|
173
|
-
def
|
174
|
-
result =
|
194
|
+
def generate_purchase_hash(args)
|
195
|
+
result = {}
|
175
196
|
|
176
|
-
result[:event] = args
|
197
|
+
result[:event] = args[:event] if args[:event].present?
|
177
198
|
|
178
|
-
result[:ecommerce]
|
179
|
-
result[:ecommerce][:
|
180
|
-
result[:ecommerce][:refund][:products] = get_products(args) if args[:products].present?
|
199
|
+
result[:ecommerce] = {}
|
200
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
181
201
|
|
182
|
-
result
|
202
|
+
result[:ecommerce][:purchase] = {}
|
203
|
+
|
204
|
+
action = args[:action] || {}
|
205
|
+
action = action.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(action) : action
|
206
|
+
result[:ecommerce][:purchase][:actionField] = action
|
207
|
+
|
208
|
+
if args[:products].present?
|
209
|
+
result[:ecommerce][:purchase][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
210
|
+
end
|
183
211
|
|
184
212
|
return result
|
185
213
|
end
|
186
214
|
|
215
|
+
def generate_refund_hash(args)
|
216
|
+
result = {}
|
187
217
|
|
188
|
-
|
189
|
-
hash = {}
|
190
|
-
hash[:ecommerce] = {}
|
191
|
-
hash[:ecommerce][:currencyCode] = get_currency(args)
|
192
|
-
hash
|
193
|
-
end
|
218
|
+
result[:event] = args[:event] if args[:event].present?
|
194
219
|
|
195
|
-
|
196
|
-
args
|
197
|
-
end
|
220
|
+
result[:ecommerce] = {}
|
221
|
+
result[:ecommerce][:currencyCode] = args[:currency] || GtmOnRails.config.ecommerce_default_currency
|
198
222
|
|
199
|
-
|
200
|
-
args.delete(:impressions).map{|impression| impression.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Impression.new(impression) : impression}
|
201
|
-
end
|
202
|
-
|
203
|
-
def get_promotion(args)
|
204
|
-
args.delete(:promotions).map{|promotion| promotion.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Promotion.new(promotion) : promotion}
|
205
|
-
end
|
223
|
+
result[:ecommerce][:refund] = {}
|
206
224
|
|
207
|
-
|
208
|
-
|
209
|
-
|
225
|
+
if args[:action].present?
|
226
|
+
action = args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args[:action]) : args[:action]
|
227
|
+
result[:ecommerce][:refund][:actionField] = action
|
228
|
+
end
|
229
|
+
|
230
|
+
if args[:products].present?
|
231
|
+
result[:ecommerce][:refund][:products] = args[:products].map{|product| product.is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Product.new(product) : product}
|
232
|
+
end
|
210
233
|
|
211
|
-
|
212
|
-
args[:action].is_a?(Hash) ? GtmOnRails::DataLayer::Ecommerce::Action.new(args.delete(:action)) : args.delete(:action)
|
234
|
+
return result
|
213
235
|
end
|
214
236
|
end
|
215
237
|
end
|
data/lib/gtm_on_rails/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: gtm_on_rails
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.2.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- ykogure
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-05-03 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|
@@ -24,6 +24,20 @@ dependencies:
|
|
24
24
|
- - ">="
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: 3.2.22
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: puma
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
27
41
|
- !ruby/object:Gem::Dependency
|
28
42
|
name: mysql2
|
29
43
|
requirement: !ruby/object:Gem::Requirement
|
@@ -88,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
88
102
|
- !ruby/object:Gem::Version
|
89
103
|
version: '0'
|
90
104
|
requirements: []
|
91
|
-
|
92
|
-
rubygems_version: 2.6.11
|
105
|
+
rubygems_version: 3.4.10
|
93
106
|
signing_key:
|
94
107
|
specification_version: 4
|
95
108
|
summary: An plugin that integrate Google Tag Manager easy with Rails
|