Nitrodist/event_tracker

★ 1Forks 0RubyGitHub ↗Compare

Project website ↗

README

Event Tracker

Easy tracking using mixpanel or kissmetrics.

For details, see our guide to tracking events.

Installation

Add this line to your application's Gemfile:

gem 'event_tracker'

And then execute:

$ bundle

Or install it yourself as:

$ gem install event_tracker

Usage

# config/application.rb
config.event_tracker.mixpanel_key = "YOUR_KEY"
config.event_tracker.kissmetrics_key = "YOUR_KEY"

class ApplicationController < ActionController::Base
  after_filter :append_event_tracking_tags

  # optionally identify users
  def mixpanel_distinct_id
    current_visitor_id
  end

  def mixpanel_name_tag
    current_user && current_user.email
  end

  def kissmetrics_identity
    current_user && current_user.email
  end
end

# in controller or views
track_event("Event Name", optional_property: "value")
register_properties(name: "value")

Todos

  • AJAX handling
  • External redirects

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Contributors

pwimtricknoteseemi

Issues