ga_events 1.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1146cf9971d12382e0aa793841cd4dd0cd76470
-  data.tar.gz: ff69c78fb46afe03a40685cf8f002c82161a3e27
+SHA256:
+  metadata.gz: 2da2467a5f1cf24ef9fdcd30dfea8130a6e5a1c2a8ce6e0903143a909215e30d
+  data.tar.gz: b617a6d911b6666a8b1f0dabae680950565f956adccf26850a443a3109602c23
 SHA512:
-  metadata.gz: b30b861e9b436375c7615d3f3b1aee65163a38236943eaa71482fa1ff6a6ead43929bc8e50ee91532006344995d7809122e4737e0f900e46254583b20aef5049
-  data.tar.gz: 09e3a8b9a027f6cdeda57a5184a6d9b214edba3649bcdc6e666bf24f36d49d51b223a7c523234d47eb3b7c9a853ca77c4f92cbbdd42d54fc536430fe0a7b950d
+  metadata.gz: 805237d9af985bd8c4cb9d696626f4949d953dcabb3669b1b80771209811f13402f27e25aa618eda39bce2cfdf767ae9f74fa8336f789e5a5ee79a82e59e8026
+  data.tar.gz: 428a307570718be7d541f3c8883cc73141e88e7861e87a98ed5a4263ef8f41f657028220203298ea4ab5053fdbe9e1e85dc9fec59e26b50223ba5a94a0855a0a

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg
+vendor

data/.rubocop.yml

@@ -1,13 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
   Exclude:
     - 'vendor/bundle/**/*'
   DisplayCopNames: true
-Rails:
-  Enabled: true
-Style/Encoding:
-  EnforcedStyle: when_needed
-  Enabled: true
 Style/AsciiComments:
   Enabled: false
 Style/Documentation:
@@ -16,13 +11,13 @@ Metrics/MethodLength:
   Enabled: false
 Style/MethodDefParentheses:
   Enabled: false
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   EnforcedStyle: aligned
-Style/MultilineMethodCallIndentation:
+Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented
-Style/MultilineMethodDefinitionBraceLayout:
+Layout/MultilineMethodDefinitionBraceLayout:
   Enabled: true
-Style/MultilineHashBraceLayout:
+Layout/MultilineHashBraceLayout:
   Enabled: true
 Style/SignalException:
   Enabled: false
@@ -38,3 +33,5 @@ Style/CommentAnnotation:
   Enabled: false
 Style/GuardClause:
   Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -33,3 +33,34 @@ The format suggested at http://keepachangelog.com/ is used.
   changes orchestrated by turbolinks, events are no longer processed via the
   injected DOM node. (Because the node would be cached and the event already
   processed.) Instead the the header-strategy is being used.
+
+## 1.4.1 - 2018-04-03
+
+### Fixed
+- 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 - 2020-11-20
+
+### Removed
+- Support for rubies < 2.3
+- Support for rails < 4.2
+
+### 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/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ga_events.gemspec
@@ -6,4 +8,4 @@ gemspec
 gem 'pry'
 gem 'rake'
 gem 'rspec', '~> 3.1.0'
-gem 'rubocop', '~> 0.39.0', require: false
+gem 'rubocop', '~> 0.79.0', require: false

data/README.md

@@ -13,8 +13,8 @@ pushes it to Google Analytics via ga.js or Google Tag Manager.
 
 ## Dependencies
 
-* Ruby >= 1.9
-* Rails 3.1 onwards
+* Ruby >= 2.3
+* Rails 4.2 onwards
 * jQuery
 
 ## Installation
@@ -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("sendNow", "customTracker");
+  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(
+    {analytics_object_name: "analytics"} // calls window.analytics()
+  );
 }
 ```
 
@@ -70,6 +110,15 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
+### Optional consent settings
+
+Events are flushed immediatly by default. If you need to wait for user consent
+you can set `GaEvents.Event.require_user_consent = true`.
+
+With `require_user_consent` enabled all events are buffered until
+`GaEvents.Event.user_consent_given = true` is set. Events are flushed as soon
+as `GaEvents.Event.flush()` is called.
+
 ### Testing
 
 For your testing pleasure we included `NullAdapter`.
@@ -152,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,4 +1,5 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

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

@@ -9,9 +9,11 @@ class GaEvents.Event
   @may_flush: false
   @header_key: "X-GA-Events"
   @html_key: "ga-events"
+  @require_user_consent: false
+  @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 "|"
@@ -21,8 +23,10 @@ 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
+
     if @list.length > 0 and @may_flush
       $.map @list, (event) -> event.push_to_adapter()
       @list = []
@@ -32,18 +36,27 @@ class GaEvents.Event
     @klass.list.push @
     @klass.flush()
 
+  escape: (str) ->
+    return unless str
+    "#{str}".replace(/ä/g, "ae")
+            .replace(/ö/g, "oe")
+            .replace(/ü/g, "ue")
+            .replace(/Ä/g, "Ae")
+            .replace(/Ö/g, "Oe")
+            .replace(/Ü/g, "Ue")
+            .replace(/ß/g, "ss")
+
   to_hash: ->
-    # Category, action and label must be of type string.
-    action: "#{@action}"
-    category: "#{@category}"
-    label: "#{@label}"
+    # Category, action and label must be escaped and of type string.
+    action: @escape(@action)
+    category: @escape(@category)
+    label: @escape(@label)
     # Value has to be a positive integer or defaults to 1
     value: @to_positive_integer(@value)
 
   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 =>
@@ -70,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")
 
-  push: (h) ->
-    window.ga @method_call_name, "event", h.category, h.action, h.label,
-              h.value, {"nonInteraction": true}
+    # Only relevant for analytics.js
+    @send_method_name = options?.send_method_name || "send"
+
+    # 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

@@ -1,5 +1,6 @@
-# encoding: utf-8
-require File.expand_path('../lib/ga_events/version', __FILE__)
+# frozen_string_literal: true
+
+require File.expand_path('lib/ga_events/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ['Florian Dütsch', 'Sven Winkler']
@@ -24,6 +25,8 @@ Gem::Specification.new do |gem|
   gem.name          = 'ga_events'
   gem.require_paths = ['lib']
   gem.version       = GaEvents::VERSION
+  gem.licenses      = ['MIT']
 
-  gem.add_dependency 'rails', '>= 3.1'
+  gem.required_ruby_version = '>= 2.3'
+  gem.add_dependency 'rails', '>= 4.2'
 end

data/lib/ga_events/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GaEvents
   class Engine < ::Rails::Engine
     config.app_middleware.use GaEvents::Middleware

data/lib/ga_events/event.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GaEvents
   Event = Struct.new(:category, :action, :label, :value) do
     # Default values are set here, see README.md for details.

data/lib/ga_events/list.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # NOTE: Collecting the events is thread-safe, but will cause problems in an
 #       asynchronous/evented environment.
 

data/lib/ga_events/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/utils'
 
 module GaEvents
@@ -35,31 +37,29 @@ module GaEvents
     private
 
     def init_event_list(env)
-      # Handle events stored in flash
-      # Parts borrowed from Rails:
-      # https://github.com/rails/rails/blob/v3.2.14/actionpack/lib/action_dispatch/middleware/flash.rb
-      flash = env['rack.session'] && env['rack.session']['flash']
-
-      # Fix for Rails 4
-      flash &&= flash['flashes'] if Rails::VERSION::MAJOR > 3
-
-      GaEvents::List.init(flash && flash['ga_events'])
+      flash = env['rack.session'] && env['rack.session']['flash'] &&
+              env['rack.session']['flash']['flashes']
+
+      # The key has to be removed from the flash here to ensure it does not
+      # remain after the finished redirect. This copies the behaviour of the
+      # "#use" and "#sweep" methods of the rails flash middleware:
+      # https://github.com/rails/rails/blob/v3.2.14/actionpack/lib/action_dispatch/middleware/flash.rb#L220
+      GaEvents::List.init(flash&.delete('ga_events'))
     end
 
     def add_events_to_flash env, serialized_data
-      flash_hash = env[ActionDispatch::Flash::KEY]
-      flash_hash ||= ActionDispatch::Flash::FlashHash.new
-      flash_hash['ga_events'] = serialized_data
-      # Discard the flash after the action completes.
-      flash_hash.discard('ga_events')
+      flash = env['rack.session'] && env['rack.session']['flash'] &&
+              env['rack.session']['flash']['flashes']
+
+      return unless flash
 
-      env[ActionDispatch::Flash::KEY] = flash_hash
+      flash['ga_events'] = serialized_data
     end
 
-    def normalize_response(r)
-      r = r.body if r.respond_to?(:body)
-      r = r.join if r.respond_to?(:join)
-      r
+    def normalize_response(response)
+      response = response.body if response.respond_to?(:body)
+      response = response.join if response.respond_to?(:join)
+      response
     end
 
     def inject_div(response, serialized_data)

data/lib/ga_events/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GaEvents
-  VERSION = '1.4.0'.freeze
+  VERSION = '3.0.0'
 end

data/lib/ga_events.rb

@@ -1 +1,3 @@
-%w(middleware engine event list version).each { |f| require "ga_events/#{f}" }
+# frozen_string_literal: true
+
+%w[middleware engine event list version].each { |f| require "ga_events/#{f}" }

data/spec/middleware_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe GaEvents::Middleware do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'pry'
 require 'rspec'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Florian Dütsch
 - Sven Winkler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-12 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
 description: Google Analytics' Event Tracking everywhere in your Rails app)
 email:
 - florian.duetsch@nix-wie-weg.de
@@ -52,9 +52,10 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,16 +63,16 @@ 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: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+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
   app. A rack middleware is automatically inserted into the stack. It transports the