ga_events 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8733925b29ae71da3da081d25679727857f92ee7bcb5390c72b97a87fc3c9b53
-  data.tar.gz: 67d86fd9ea6ced7564d851b40faa957d2138a92977a5d3197a2a6f7bdcdd7068
+  metadata.gz: 205433864fd2efabf0cf787da0be314c9bc48fd644773d8df29f6ca66327ba43
+  data.tar.gz: fa05cd8ee83f4b73fa23a3562e19d0ec2fcbb1a684c7ee49c357d0e78a54c3a7
 SHA512:
-  metadata.gz: 0ffaa24b43857c82f369e98861b82ddd99dca42bc88b97148d4a055210e0ed76b2f82961932e83e03b76264e091a7e698577b07a69cb2efef6d40b92616965c0
-  data.tar.gz: 59e2857a160797e12bfec180e10aadae8f66633e303cb9c41e739a77669ee03f2b13c22faea9f10df263e1d43f2eef172f6c5d03cbca90b7a9944597c8390a77
+  metadata.gz: 472515474d12c53c4f3d43b8c577a45776ed983149c8347940294ca1128e907d101f48054eee7c00468cafdc3f1e7aba33c3cdfa08f43d81ebc0bd25c91f884f
+  data.tar.gz: 483bbdb595f20e852ec8f6b74366251e91e84b76cde7454721136d42cfd31586e36c88bd015ac6cbf321a673e2779e5f29b96cb345924d7606f648e36da67aa9

data/README.md

@@ -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,5 +1,3 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-
-task default: :spec

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 = []

data/lib/ga_events/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Florian Dütsch
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails