ga_events 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 205433864fd2efabf0cf787da0be314c9bc48fd644773d8df29f6ca66327ba43
-  data.tar.gz: fa05cd8ee83f4b73fa23a3562e19d0ec2fcbb1a684c7ee49c357d0e78a54c3a7
+  metadata.gz: 2da2467a5f1cf24ef9fdcd30dfea8130a6e5a1c2a8ce6e0903143a909215e30d
+  data.tar.gz: b617a6d911b6666a8b1f0dabae680950565f956adccf26850a443a3109602c23
 SHA512:
-  metadata.gz: 472515474d12c53c4f3d43b8c577a45776ed983149c8347940294ca1128e907d101f48054eee7c00468cafdc3f1e7aba33c3cdfa08f43d81ebc0bd25c91f884f
-  data.tar.gz: 483bbdb595f20e852ec8f6b74366251e91e84b76cde7454721136d42cfd31586e36c88bd015ac6cbf321a673e2779e5f29b96cb345924d7606f648e36da67aa9
+  metadata.gz: 805237d9af985bd8c4cb9d696626f4949d953dcabb3669b1b80771209811f13402f27e25aa618eda39bce2cfdf767ae9f74fa8336f789e5a5ee79a82e59e8026
+  data.tar.gz: 428a307570718be7d541f3c8883cc73141e88e7861e87a98ed5a4263ef8f41f657028220203298ea4ab5053fdbe9e1e85dc9fec59e26b50223ba5a94a0855a0a

data/CHANGELOG.md

@@ -40,7 +40,7 @@ The format suggested at http://keepachangelog.com/ is used.
 - Ensure category, action and label do not include any umlauts or ß chars
 - Fixed an error where events are remaining after a redirect
 
-## 2.0.0 - 2018-04-03
+## 2.0.0 - 2020-11-20
 
 ### Removed
 - Support for rubies < 2.3
@@ -48,3 +48,19 @@ The format suggested at http://keepachangelog.com/ is used.
 
 ### Added
 - Compatibility for Rails 5
+
+## 2.1.0 - 2021-09-07
+
+### Added
+- Optional user consent flag to prevent event flushing until consent was given
+
+## 3.0.0 - 2022-01-10
+
+### Added
+- Universal Analytics Adapter can be configured to use `gtag.js` instead of
+  `analytics.js` event syntax
+  - [Breaking] The constructor interface has changed due to more configuration
+    options that differ between `analytics.js` and `gtag.js`.
+- Universal Analytics Adapter can be configured to use a custom name for the
+  analytics object (defaults to `window.ga()` for `analytics.js` and
+  `window.gtag()` for `gtag.js`)

data/README.md

@@ -43,7 +43,9 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
-### Google Universal Analytics (analytics.js)
+### Google Universal Analytics
+
+#### analytics.js
 
 ```javascript
 GaEvents.Event.adapter = function() {
@@ -51,11 +53,49 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
-Optionally you can specify a custom method to call and a custom tracker name:
+Optionally you can specify a custom send method to call and a custom tracker
+name:
+
+```javascript
+GaEvents.Event.adapter = function() {
+  return new GaEvents.GoogleUniversalAnalyticsAdapter(
+    {send_method_name: "sendNow", tracker_name: "customTracker"}
+  );
+}
+```
+
+#### gtag.js
+
+```javascript
+GaEvents.Event.adapter = function() {
+  return new GaEvents.GoogleUniversalAnalyticsAdapter(
+    {use_gtag_variant: true}
+  );
+}
+```
+
+Optionally you can specify a custom tracker GA_MEASUREMENT_ID where you want
+your events to be sent to:
+
+```javascript
+GaEvents.Event.adapter = function() {
+  return new GaEvents.GoogleUniversalAnalyticsAdapter(
+    {use_gtag_variant: true, tracker_name: "GA_MEASUREMENT_ID"}
+  );
+}
+```
+
+#### Optional custom object name
+
+The default names of the analytics object are `window.ga()` for `analytics.js`
+and `window.gtag()` for `gtag.js`. If you have renamed your analytics object,
+you can specify the name:
 
 ```javascript
 GaEvents.Event.adapter = function() {
-  return new GaEvents.GoogleUniversalAnalyticsAdapter("sendNow", "customTracker");
+  return new GaEvents.GoogleUniversalAnalyticsAdapter(
+    {analytics_object_name: "analytics"} // calls window.analytics()
+  );
 }
 ```
 
@@ -161,5 +201,7 @@ Yes please! Use pull requests.
 ## More docs and tools
 
 * [Google Analytics: Event Tracking](https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide)
+* [Google Universal Analytics: Event Tracking (analytics.js)](https://developers.google.com/analytics/devguides/collection/analyticsjs/events)
+* [Google Universal Analytics: Event Tracking (gtag.js)](https://developers.google.com/analytics/devguides/collection/gtagjs/events)
 * [Google Tag Manager: Custom Events](http://support.google.com/tagmanager/answer/2574372#GoogleAnalytics)
-* [Chrome Web Store: Event Tracking Tracker](https://chrome.google.com/webstore/detail/event-tracking-tracker/npjkfahkbgoagkfpkidpjdemjjmmbcim)
+* [Chrome Web Store: Tag Assistant](https://chrome.google.com/webstore/detail/tag-assistant-legacy-by-g/kejbdjndbnbjgmefkgdddjlbokphdefk)

data/Rakefile

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/app/assets/javascripts/ga_events.js.coffee

@@ -13,7 +13,7 @@ class GaEvents.Event
   @user_consent_given: false
   klass: @
 
-  # Decompose a event-string (ruby side) into an event object.
+  # Decompose an event-string (ruby side) into an event object.
   @from_string: (string) ->
     $.map string.split("$"), (part) =>
       [category, action, label, value] = part.split "|"
@@ -23,7 +23,7 @@ class GaEvents.Event
     dom_events = $("div[data-#{@html_key}]").data @html_key
     @from_string dom_events if dom_events?
 
-  # Events should not be send to an adapter unless the DOM has finished loading.
+  # Events should not be sent to an adapter unless the DOM has finished loading.
   @flush: ->
     return if @require_user_consent && !@user_consent_given
 
@@ -57,7 +57,6 @@ class GaEvents.Event
   to_positive_integer: (n) ->
     if isFinite(n) and parseInt(n) >= 0 then parseInt n else 1
 
-  # https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide#SettingUpEventTracking
   push_to_adapter: -> @klass.adapter().push @to_hash()
 
   jQuery =>
@@ -84,18 +83,45 @@ class GaEvents.GoogleTagManagerAdapter
     window.dataLayer.push data
 
 class GaEvents.GoogleUniversalAnalyticsAdapter
-  constructor: (@method_call_name = "send", tracker_name) ->
-    @method_call_name = "#{tracker_name}.#{@method_call_name}" if tracker_name
+  constructor: (options) ->
+    @use_gtag_variant = options?.use_gtag_variant || false
+    @analytics_object_name =
+      options?.analytics_object_name ||
+      (if @use_gtag_variant then "gtag" else "ga")
+
+    # Only relevant for analytics.js
+    @send_method_name = options?.send_method_name || "send"
 
-  push: (h) ->
-    window.ga @method_call_name, "event", h.category, h.action, h.label,
-              h.value, {"nonInteraction": true}
+    # https://developers.google.com/analytics/devguides/migration/ua/analyticsjs-to-gtagjs#measure_pageviews_with_specified_trackers
+    @tracker_name = options?.tracker_name || false
+  push: (data) ->
+    if @use_gtag_variant
+      options = {
+        "event_category": data.category,
+        "event_label": data.label,
+        "value": data.value,
+        "non_interaction": true
+      }
+      options["send_to"] = @tracker_name if @tracker_name
+      window[@analytics_object_name]("event", data.action, options)
+    else
+      method_call_name =
+        if @tracker_name
+          "#{@tracker_name}.#{@send_method_name}"
+        else
+          @send_method_name
+      window[@analytics_object_name](
+        method_call_name, "event",
+        data.category, data.action, data.label, data.value,
+        {"nonInteraction": true}
+      )
 
 class GaEvents.GoogleAnalyticsAdapter
+  # https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide#SettingUpEventTracking
   # Send events non_interactive => no influence on bounce rates
-  push: (h) ->
+  push: (data) ->
     window._gaq.push(
-      ["_trackEvent", h.category, h.action, h.label, h.value, true]
+      ["_trackEvent", data.category, data.action, data.label, data.value, true]
     )
 
 class GaEvents.NullAdapter

data/ga_events.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |gem|
   gem.name          = 'ga_events'
   gem.require_paths = ['lib']
   gem.version       = GaEvents::VERSION
+  gem.licenses      = ['MIT']
 
+  gem.required_ruby_version = '>= 2.3'
   gem.add_dependency 'rails', '>= 4.2'
 end

data/lib/ga_events/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GaEvents
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Florian Dütsch
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,7 +52,8 @@ files:
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/Nix-wie-weg/ga_events
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -62,14 +63,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project:
+rubygems_version: 2.7.6.2
 signing_key:
 specification_version: 4
 summary: This gem allows you to annotate events everywhere in the code of your Rails