ga_events 1.3.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5f618bcb8b6143f0b27f0635ba07f7a03bf43314
-  data.tar.gz: 243dbd6ab50485f12ef605804645f31a216b57c7
+SHA256:
+  metadata.gz: 205433864fd2efabf0cf787da0be314c9bc48fd644773d8df29f6ca66327ba43
+  data.tar.gz: fa05cd8ee83f4b73fa23a3562e19d0ec2fcbb1a684c7ee49c357d0e78a54c3a7
 SHA512:
-  metadata.gz: 5f6d47efb06212449d9c5d73ef7b7a9dd7fc159ec96083791e161bccfba041e153442b3eef6d9c4cf785bf60a1d465e740b78158e4a2e14ed360ff8f07c8d65d
-  data.tar.gz: 72d65902c21450bcb1f6e2220d7d01680a3c1745bfdd38d57785831a5c93d8bc07536082a630b2d7f45049ad1a791cb27ca9699261df1afe2931b0bd2d1c0baa
+  metadata.gz: 472515474d12c53c4f3d43b8c577a45776ed983149c8347940294ca1128e907d101f48054eee7c00468cafdc3f1e7aba33c3cdfa08f43d81ebc0bd25c91f884f
+  data.tar.gz: 483bbdb595f20e852ec8f6b74366251e91e84b76cde7454721136d42cfd31586e36c88bd015ac6cbf321a673e2779e5f29b96cb345924d7606f648e36da67aa9

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,37 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'vendor/bundle/**/*'
+  DisplayCopNames: true
+Style/AsciiComments:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/MethodDefParentheses:
+  Enabled: false
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Layout/MultilineMethodDefinitionBraceLayout:
+  Enabled: true
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+Style/SignalException:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/CommentAnnotation:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -25,3 +25,26 @@ The format suggested at http://keepachangelog.com/ is used.
 
 ### Added
 - Support for turbolinks.
+
+## 1.4.0 - 2018-03-09
+
+### Fixed
+- Fixed turbolinks events. To prevent older events the be processed again after page
+  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 - 2018-04-03
+
+### Removed
+- Support for rubies < 2.3
+- Support for rails < 4.2
+
+### Added
+- Compatibility for Rails 5

data/Gemfile

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ga_events.gemspec
 gemspec
 
+gem 'pry'
 gem 'rake'
 gem 'rspec', '~> 3.1.0'
-gem 'pry'
+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
@@ -70,6 +70,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`.

data/Rakefile

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

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

@@ -9,6 +9,8 @@ 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.
@@ -23,6 +25,8 @@ class GaEvents.Event
 
   # Events should not be send 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,11 +36,21 @@ 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)
 
@@ -50,12 +64,17 @@ class GaEvents.Event
     @may_flush = true
     @flush()
 
-    $(document).ajaxComplete (event, xhr) =>
+    process_xhr = (xhr) =>
       xhr_events = xhr.getResponseHeader @header_key
       @from_string xhr_events if xhr_events?
 
+    $(document).ajaxComplete((_, xhr) -> process_xhr(xhr))
+    $(document).on "turbolinks:request-end", (event) ->
+      xhr = event.originalEvent.data.xhr
+      process_xhr(xhr)
+
     @from_dom()
-    $(document).on "turbolinks:load", => @from_dom()
+
 
 class GaEvents.GoogleTagManagerAdapter
   constructor: (@event = "ga_event") ->

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']
@@ -19,11 +20,11 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/Nix-wie-weg/ga_events'
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
-  gem.executables   = gem.files.grep(/^bin\//).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(/^(test|spec|features)\//)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'ga_events'
   gem.require_paths = ['lib']
   gem.version       = GaEvents::VERSION
 
-  gem.add_dependency 'rails', '>= 3.1'
+  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,5 +1,7 @@
+# frozen_string_literal: true
+
 module GaEvents
-  class Event < Struct.new(:category, :action, :label, :value)
+  Event = Struct.new(:category, :action, :label, :value) do
     # Default values are set here, see README.md for details.
     def initialize(category = '-', action = '-', label = '-', value = 1)
       super

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
@@ -16,11 +18,11 @@ module GaEvents
 
         # Can outgrow, headers might get too big
         serialized = GaEvents::List.to_s
-        if request.xhr?
+        if xhr_or_turbolinks?(request)
           # AJAX request
           headers['X-GA-Events'] = serialized
 
-        elsif (300..399).include?(status)
+        elsif redirect?(status)
           # 30x/redirect? Then add event list to flash to survive the redirect.
           add_events_to_flash(env, serialized)
 
@@ -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)
@@ -74,5 +74,13 @@ module GaEvents
         headers.key?('Content-Type') &&
         headers['Content-Type'].include?('text/html')
     end
+
+    def redirect?(status)
+      (300..399).cover?(status)
+    end
+
+    def xhr_or_turbolinks?(request)
+      request.xhr? || request.env['HTTP_TURBOLINKS_REFERRER']
+    end
   end
 end

data/lib/ga_events/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GaEvents
-  VERSION = '1.3.1'
+  VERSION = '2.1.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.3.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Florian Dütsch
 - Sven Winkler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-01 00:00:00.000000000 Z
+date: 2021-09-07 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
@@ -34,6 +34,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -53,7 +54,7 @@ files:
 homepage: https://github.com/Nix-wie-weg/ga_events
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -68,9 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+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