event_tracker 0.0.2 → 0.0.3

data/README.md

@@ -1,4 +1,4 @@
-# EventTracker
+# Event Tracker
 
 Easy tracking using mixpanel or kissmetrics
 
@@ -16,6 +16,35 @@ Or install it yourself as:
 
     $ gem install event_tracker
 
+## Usage
+
+```ruby
+# 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

data/lib/event_tracker.rb

@@ -3,7 +3,7 @@ require "event_tracker/mixpanel"
 require "event_tracker/kissmetrics"
 
 module EventTracker
-  module ActionControllerExtension
+  module HelperMethods
     def track_event(event_name, args = {})
       (session[:event_tracker_queue] ||= []) << [event_name, args]
     end
@@ -11,7 +11,9 @@ module EventTracker
     def register_properties(args)
       (session[:registered_properties] ||= {}).merge!(args)
     end
+  end
 
+  module ActionControllerExtension
     def append_event_tracking_tags
       mixpanel_key = Rails.application.config.event_tracker.mixpanel_key
       kissmetrics_key = Rails.application.config.event_tracker.kissmetrics_key
@@ -64,6 +66,8 @@ module EventTracker
     initializer "event_tracker" do |app|
       ActiveSupport.on_load :action_controller do
         include ActionControllerExtension
+        include HelperMethods
+        helper HelperMethods
       end
     end
   end

data/lib/event_tracker/version.rb

@@ -1,3 +1,3 @@
 module EventTracker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/app/views/basic/in_views.html.erb

@@ -0,0 +1 @@
+<% track_event "Register for site" %>

data/spec/event_tracker_spec.rb

@@ -53,6 +53,11 @@ feature 'basic integration' do
     it_should_behave_like "with event"
   end
 
+  context 'visit page with tracking' do
+    background { visit '/basic/in_views' }
+    it_should_behave_like "with event"
+  end
+
   context 'visit page with tracking then without tracking' do
     background do
       visit '/basic/with_tracking'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: event_tracker
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -60,6 +60,7 @@ files:
 - lib/event_tracker/kissmetrics.rb
 - lib/event_tracker/mixpanel.rb
 - lib/event_tracker/version.rb
+- spec/app/views/basic/in_views.html.erb
 - spec/app/views/layouts/application.html.erb
 - spec/event_tracker_spec.rb
 - spec/spec_helper.rb
@@ -77,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2338464354941489983
+      hash: -2292007241673597298
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2338464354941489983
+      hash: -2292007241673597298
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -94,6 +95,7 @@ signing_key:
 specification_version: 3
 summary: Track using javascript from your controllers, even when redirecting
 test_files:
+- spec/app/views/basic/in_views.html.erb
 - spec/app/views/layouts/application.html.erb
 - spec/event_tracker_spec.rb
 - spec/spec_helper.rb