Google Analytics' Event Tracking everywhere in your Rails app
Ruby CoffeeScript
Latest commit 1fffb84 Dec 18, 2014 @hoffi hoffi Merge pull request #17 from Nix-wie-weg/15562-urfi-ga-event
#15562: Added TestAdapter
Permalink
Failed to load latest commit information.
app/assets/javascripts #15562: Added TestAdapter Dec 16, 2014
lib #15562: Version bump Dec 17, 2014
spec Ruby 1.9 assumed Oct 10, 2014
.gitignore
CHANGELOG.md Update CHANGELOG.md Oct 17, 2014
Gemfile @brain-geek used newer rspec features Oct 10, 2014
LICENSE Bump year Apr 29, 2014
README.md Merge branch 'master' of https://github.com/Nix-wie-weg/ga_events Oct 17, 2014
Rakefile Ruby 1.9 assumed Oct 10, 2014
TODO #10116: Prepared fixed label and value Oct 17, 2013
ga_events.gemspec

README.md

GaEvents

Use Google Analytics' Event Tracking everywhere in your Rails app!

This gem alllows you to annotate events everywhere in the code of your Rails app. A rack middleware is automatically inserted into the stack. It transports the event data to the client. Normal requests get a DIV injected, Ajax requests get a data-pounded custom HTTP header appended. In case of redirects the data survives inside Rails' flash. The asset pipeline-ready CoffeeScript extracts this data on the client-side and pushes it to Google Analytics via ga.js or Google Tag Manager.

Dependencies

  • Ruby >= 1.9
  • Rails 3.1 onwards
  • jQuery

Installation

Add it to your Gemfile with:

gem 'ga_events'

Run the bundle command to install it.

Add to the top of your application.js (but after requiring jQuery):

//= require ga_events.js

After requiring ga_events.js, you have to choose an adapter.

Google Analytics (ga.js)

GaEvents.Event.adapter = function() {
  return new GaEvents.GoogleAnalyticsAdapter();
}

Google Universal Analytics (analytics.js)

GaEvents.Event.adapter = function() {
  return new GaEvents.GoogleUniversalAnalyticsAdapter();
}

Optionally you can specify a custom method to call and a custom tracker name:

GaEvents.Event.adapter = function() {
  return new GaEvents.GoogleUniversalAnalyticsAdapter("sendNow", "customTracker");
}

Google TagManager

If you are using Google Tag Manager you can add custom events which are then passed through to Google Analytics.

GaEvents.Event.adapter = function() {
  return new GaEvents.GoogleTagManagerAdapter("event_name"); // defaults to ga_event
}

Testing

For your testing pleasure we included NullAdapter.

GaEvents.Event.adapter = function() {
  return new GaEvents.NullAdapter();
}

Usage

On the server-side a new event is added to a list, serialized into a container element and then added to your HTML response. On Ajax requests a custom HTTP header is added to the response.

You can create a new event like this:

GaEvents::Event.new(category, action, label, value)

On the client-side there is a similar interface to GaEvents:

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 event data:

class ApplicationController < ActionController::Base
  after_filter :too_many_ga_events?
  private
  def too_many_ga_events?
    if (serialized = GaEvents::List.to_s).length > 1_024
      notify("GaEvents too big: #{serialized}")
    end
    true
  end
end

Testing

Middlewares aren't loaded in controller specs, so you have to initialize GaEvents by hand. You can do this eg. in your spec_helper.rb:

RSpec.configure do |config|
  [...]
  config.before(:each, type: :controller) do
    GaEvents::List.init
  end
end

Contributing

Yes please! Use pull requests.

Credits

More docs and tools