ga_events 0.2.0 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTJhMGE3MTIxYTVhNDZlOGI2ZjhmZjgwNDFkZjU4M2ZhYmUxZmQzYg==
+    NDljN2FmMjUyMGVlZTFiY2ZjZGFlYmQ5ZWQ0NmM1NzQxMTBkNmVkMw==
   data.tar.gz: !binary |-
-    N2QzYzE4MWM4NjY0ZjY4MWY4MDk5ZTlmYmU4ZDY1ODZiODNhYTI0Zg==
+    MGE5NzUxMDdkYzA3MjJjYWNhZmI4MDM0ZjcwMzc5OTc4M2RlNjdjYQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MmJmMjJlY2EwOWE4ZDA4N2QwM2QwZjZlM2M5OGIzMWUwZjEzNWFjZGY5NTc3
-    YTNmMjkwMmI0ODViMGJlOTNhYjMyZWVhNmQ5NGEzOGRhOGEyOWUyOTRjZjEx
-    ZjFhOTZmMzRiMWEwZTZkMjEwZDllNzlmMTA3YzhjOTQ2MzU0YTg=
+    ZGJlYTU3ZTExOGJmMTdlY2Q1Yzk2M2VjZDExMGNiMmYxMjg1OGExZDBmNWU4
+    OWJmNmJjNDZkYTk1YWI1NmY0ODFhMGFkZGIyNGIyYWU0NzVlNmE3YzM0YmEy
+    M2E3NjZiOTYxYzg2M2M3YjljNmNjMzExY2RjMmQ3MGMzOTBiMGQ=
   data.tar.gz: !binary |-
-    ZDM3NmFiY2Q1OGFjMTM2ZDQ3NDE2Yzg0NDU1ZTI4MGU0NWU0Yjk3MzcwY2E2
-    ZGY3OWVkMzcwMzdlMTM1MzgwMDhmMGE4MTllZjUyM2VjYjFmZTUzYTM4YWFj
-    OTRkMzU1NTFjYTA2ZDA5MzNiNzJlYTliYjAwZjgwZTU4ZGRmNDQ=
+    YWE3ZTdkZGE3ZjkwNThhYjFhZjhhMDVjMDNjN2E5NzcyN2JhZDI2Yjg5MDA3
+    OTJmOTg0YWY5YzI4NjgxMTEzYTg1ODBkOTk1NWU1M2RmNmMxODU4ODUzOTU4
+    MjlkYTFjZmZkNWJlMzQ3MzBlOWI3YjllMzc3NThhZWVkYTZiYmE=

data/README.md

@@ -42,7 +42,16 @@ GaEvents.Event.adapter = function() {
 }
 ```
 
-If you are using Google Tag Manager you can add custom events which are then passed through to Google Analytics.
+For Google Universal Analytics use:
+
+```javascript
+GaEvents.Event.adapter = function() {
+  return new GaEvents.GoogleUniversalAnalyticsAdapter();
+}
+```
+
+If you are using Google Tag Manager you can add custom events which are then
+passed through to Google Analytics.
 
 ```javascript
 GaEvents.Event.adapter = function() {
@@ -79,6 +88,12 @@ new GaEvents.Event(category, action, label, value)
 We have taken special care of tracking events while the DOM is loading.
 Events get collected until the DOM is ready and flushed afterwards.
 
+### Default values
+
+While collecting hundreds of thousands of events on a daily basis in
+Google Analytics we found corrupted aggregated events when the event label or
+value is omitted. We now enforce a default label ("-") and value (1).
+
 ### Too many events
 
 Use something like this snippet to get informed of bloating HTTP headers with
@@ -101,6 +116,10 @@ end
 
 Yes please! Use pull requests.
 
+### Credits
+
+* [jhilden](https://github.com/jhilden) for ideas and Rails 4 support
+
 ## More docs and tools
 
 * [Google Analytics: Event Tracking](https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide)

data/TODO

@@ -1,3 +1,2 @@
-v0.2
 * Tests
 * Announcement

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

@@ -24,34 +24,23 @@ class GaEvents.Event
       @list = []
 
   # Add all events to a queue to flush them later
-  constructor: (@category, @action, @label, @value) ->
+  constructor: (@category = "-", @action = "-", @label = "-", @value = 1) ->
     @klass.list.push @
     @klass.flush()
 
-  push_to_adapter: ->
-    # https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide#SettingUpEventTracking
-    # Category, Action and Label must be of type string.
-    # Value must be a positive integer.
+  to_hash: ->
+    # Category, action and label must be of type string.
+    action: "#{@action}"
+    category: "#{@category}"
+    label: "#{@label}"
+    # Value has to be a positive integer or defaults to 1
+    value: @to_positive_integer(@value)
 
-    data =
-      action: "#{@action}"
-      category: "#{@category}"
-    data.label = "#{@label}" if @is_present @label
+  to_positive_integer: (n) ->
+    if isFinite(n) and parseInt(n) >= 0 then parseInt n else 1
 
-    if @is_present @value
-      # @value is a number and of type integer.
-      if isFinite(@value) and Number(@value) % 1 is 0
-        # Google Analytics expects a positive integer
-        if (value = parseInt @value) > -1
-          data.value = value
-        else
-          throw "Negative integers are not supported at this time."
-      else
-        throw "The parameter 'value' must be of type integer."
-
-    @klass.adapter().push data
-
-  is_present: (value) -> value? and value != ""
+  # https://developers.google.com/analytics/devguides/collection/gajs/eventTrackerGuide#SettingUpEventTracking
+  push_to_adapter: -> @klass.adapter().push @to_hash()
 
   jQuery =>
     @may_flush = true
@@ -67,17 +56,18 @@ class GaEvents.Event
 class GaEvents.GoogleTagManagerAdapter
   constructor: (@event = "ga_event") ->
   push: (data) ->
-    data["event"] = @event
-    data["non_interaction"] = true
+    data.event = @event
+    data.non_interaction = true
     window.dataLayer.push data
 
+class GaEvents.GoogleUniversalAnalyticsAdapter
+  push: (h) -> window.ga "send", "event", h.category, h.action, h.label, h.value
+
 class GaEvents.GoogleAnalyticsAdapter
-  push: (obj) ->
-    data = ["_trackEvent", obj["category"], obj["action"]]
-    data.push obj["label"]
-    data.push obj["value"]
-    data.push true # opt_noninteraction
-    window._gaq.push data
+  # Send events non_interactive => no influence on bounce rates
+  push: (h) ->
+    window._gaq.push(
+      ["_trackEvent", h.category, h.action, h.label, h.value, true])
 
 class GaEvents.NullAdapter
   push: (obj) -> console.log obj if console?

data/ga_events.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = GaEvents::VERSION
 
-  gem.add_dependency 'rails', '~> 3.1'
+  gem.add_dependency 'rails', '>= 3.1'
 end

data/lib/ga_events/event.rb

@@ -1,6 +1,7 @@
 module GaEvents
   class Event < Struct.new(:category, :action, :label, :value)
-    def initialize(category, action, label = nil, value = nil)
+    # Default values are set here, see README.md for details.
+    def initialize(category = '-', action = '-', label = '-', value = 1)
       super
       GaEvents::List << self
     end

data/lib/ga_events/list.rb

@@ -1,5 +1,5 @@
 # NOTE: Collecting the events is thread-safe, but will cause problems in an
-#       asynchronous environment.
+#       asynchronous/evented environment.
 
 module GaEvents::List
   def self.<<(event)

data/lib/ga_events/middleware.rb

@@ -10,6 +10,10 @@ module GaEvents
       # 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'])
 
       status, headers, response = @app.call(env)
@@ -20,7 +24,6 @@ module GaEvents
 
         # Can outgrow, headers might get too big
         serialized = GaEvents::List.to_s
-
         if request.xhr?
           # AJAX request
           headers['X-GA-Events'] = serialized
@@ -55,4 +58,3 @@ module GaEvents
     end
   end
 end
-

data/lib/ga_events/version.rb

@@ -1,3 +1,3 @@
 module GaEvents
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_events
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Florian Dütsch
@@ -10,20 +10,20 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2013-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
 description: Google Analytics' Event Tracking everywhere in your Rails app