event_tracker 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in event_tracker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul McMahon
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# EventTracker
+
+Easy tracking using mixpanel or kissmetrics
+
+## 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
+
+## 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

data/Rakefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/event_tracker.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/event_tracker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul McMahon"]
+  gem.email         = ["paul@mobalean.com"]
+  gem.description   = %q{Easy integration with Mixpanel and Kissmetrics for Rails}
+  gem.summary       = %q{Track using javascript from your controllers, even when redirecting}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "event_tracker"
+  gem.require_paths = ["lib"]
+  gem.version       = EventTracker::VERSION
+
+  gem.add_dependency 'rails', '~> 3.0'
+  gem.add_development_dependency 'steak'
+end

data/lib/event_tracker.rb

@@ -0,0 +1,48 @@
+require "event_tracker/version"
+require "event_tracker/mixpanel"
+
+module EventTracker
+  module ActionControllerExtension
+    def track_event(event_name, args = {})
+      (session[:event_tracker_queue] ||= []) << [event_name, args]
+    end
+
+    def register_properties(args)
+      (session[:registered_properties] ||= {}).merge!(args)
+    end
+
+    def append_event_tracking_tags
+      mixpanel_key = Rails.application.config.event_tracker.mixpanel_key
+      return unless mixpanel_key
+
+      body = response.body
+      insert_at = body.index('</head')
+      if insert_at
+        registered_properties = session.delete(:registered_properties)
+        event_tracker_queue = session.delete(:event_tracker_queue)
+        distinct_id = respond_to?(:mixpanel_distinct_id) && mixpanel_distinct_id
+        name_tag = respond_to?(:mixpanel_name_tag) && mixpanel_name_tag
+
+        a = [ %q{<script type="text/javascript">} ]
+        a << EventTracker::Mixpanel.init(mixpanel_key)
+        a << EventTracker::Mixpanel.identify(distinct_id) if distinct_id
+        a << EventTracker::Mixpanel.name_tag(name_tag) if name_tag
+        a << EventTracker::Mixpanel.register(registered_properties) if registered_properties.present?
+        a << EventTracker::Mixpanel.track(event_tracker_queue) if event_tracker_queue.present?
+        a << %q{</script>}
+        body.insert insert_at, a.join("\n")
+        response.body = body
+      end
+    end
+
+  end
+
+  class Railtie < Rails::Railtie
+    config.event_tracker = ActiveSupport::OrderedOptions.new
+    initializer "event_tracker" do |app|
+      ActiveSupport.on_load :action_controller do
+        include ActionControllerExtension
+      end
+    end
+  end
+end

data/lib/event_tracker/mixpanel.rb

@@ -0,0 +1,36 @@
+module EventTracker::Mixpanel
+  def self.init(mixpanel_key)
+    s = <<-EOD
+      (function(c,a){window.mixpanel=a;var b,d,h,e;b=c.createElement("script");
+      b.type="text/javascript";b.async=!0;b.src=("https:"===c.location.protocol?"https:":"http:")+
+      '//cdn.mxpnl.com/libs/mixpanel-2.1.min.js';d=c.getElementsByTagName("script")[0];
+      d.parentNode.insertBefore(b,d);a._i=[];a.init=function(b,c,f){function d(a,b){
+      var c=b.split(".");2==c.length&&(a=a[c[0]],b=c[1]);a[b]=function(){a.push([b].concat(
+      Array.prototype.slice.call(arguments,0)))}}var g=a;"undefined"!==typeof f?g=a[f]=[]:
+      f="mixpanel";g.people=g.people||[];h=['disable','track','track_pageview','track_links',
+      'track_forms','register','register_once','unregister','identify','name_tag',
+      'set_config','people.identify','people.set','people.increment'];for(e=0;e<h.length;e++)d(g,h[e]);
+      a._i.push([b,c,f])};a.__SV=1.1;})(document,window.mixpanel||[]);
+      mixpanel.init("#{mixpanel_key}");
+    EOD
+  end
+
+  def self.register(registered_properties)
+    %Q{mixpanel.register(#{registered_properties.to_json})}
+  end
+
+  def self.track(event_tracker_queue)
+    event_tracker_queue.map do |event_name, properties| 
+      p = properties.empty? ? "" : ", #{properties.to_json}"
+      %Q{mixpanel.track("#{event_name}"#{p});}
+    end.join("\n")
+  end
+
+  def self.name_tag(name_tag)
+    %Q{mixpanel.name_tag("#{name_tag}");}
+  end
+
+  def self.identify(distinct_id)
+    %Q{mixpanel.identify("#{distinct_id}");}
+  end
+end

data/lib/event_tracker/version.rb

@@ -0,0 +1,3 @@
+module EventTracker
+  VERSION = "0.0.1"
+end

data/spec/app/views/layouts/application.html.erb

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/event_tracker_spec.rb

@@ -0,0 +1,126 @@
+require "spec_helper"
+
+shared_examples_for "mixpanel init" do
+  it { should include('mixpanel.init("YOUR_TOKEN")') }
+end
+
+shared_examples_for "without distinct id" do
+  it { should_not include('mixpanel.identify("distinct_id")') }
+end
+
+shared_examples_for "with distinct id" do
+  it { should include('mixpanel.identify("distinct_id")') }
+end
+
+shared_examples_for "without event" do
+  it { should_not include('mixpanel.track("Register for site")') }
+end
+
+shared_examples_for "with event" do
+  it { should include('mixpanel.track("Register for site")') }
+end
+
+feature 'basic integration' do
+  subject { page.find("script").native.content }
+
+  class BasicController < ApplicationController
+    after_filter :append_event_tracking_tags
+    def no_tracking
+      render inline: "OK", layout: true
+    end
+
+    def with_tracking
+      track_event "Register for site"
+      render inline: "OK", layout: true
+    end
+  end
+
+  context 'visit page without tracking' do
+    background { visit '/basic/no_tracking' }
+    it_should_behave_like "mixpanel init"
+    it_should_behave_like "without distinct id"
+    it_should_behave_like "without event"
+  end
+
+  context 'visit page with tracking' do
+    background { visit '/basic/with_tracking' }
+    it_should_behave_like "mixpanel init"
+    it_should_behave_like "without distinct id"
+    it_should_behave_like "with event"
+  end
+
+  context 'visit page with tracking then without tracking' do
+    background do
+      visit '/basic/with_tracking'
+      visit '/basic/no_tracking'
+    end
+    it_should_behave_like "without event"
+  end
+
+  class RedirectsController < ApplicationController
+    after_filter :append_event_tracking_tags
+
+    def index
+      track_event "Register for site"
+      redirect_to action: :redirected
+    end
+
+    def redirected
+      render inline: "OK", layout: true
+    end
+  end
+
+  context 'track event then redirect' do
+    background { visit '/redirects' }
+    it_should_behave_like "with event"
+  end
+
+  class WithPropertiesController < ApplicationController
+    after_filter :append_event_tracking_tags
+
+    def index
+      register_properties age: 19
+      register_properties gender: "female"
+      track_event "Take an action", property1: "a", property2: 1
+      render inline: "OK", layout: true
+    end
+  end
+
+  context "track event with properties" do
+    background { visit "/with_properties" }
+    it { should include %Q{mixpanel.track("Take an action", {"property1":"a","property2":1})} }
+    it { should include %Q{mixpanel.register({"age":19,"gender":"female"})} }
+  end
+
+  class IdentityController < ApplicationController
+    after_filter :append_event_tracking_tags
+    def mixpanel_distinct_id
+      "distinct_id"
+    end
+
+    def index
+      render inline: "OK", layout: true
+    end
+  end
+
+  context "with identity" do
+    background { visit "/identity" }
+    it_should_behave_like "with distinct id"
+  end
+
+  class NameTagController < ApplicationController
+    after_filter :append_event_tracking_tags
+    def mixpanel_name_tag
+      "foo@example.org"
+    end
+
+    def index
+      render inline: "OK", layout: true
+    end
+  end
+
+  context "with name tag" do
+    background { visit "/name_tag" }
+    it { should include(%q{mixpanel.name_tag("foo@example.org")}) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require "bundler"
+require "rails"
+Rails.env = "test"
+Bundler.require(:default, Rails.env)
+require 'action_controller/railtie'
+require 'action_view/railtie'
+
+app = Class.new(Rails::Application)
+app.config.root = File.dirname(__FILE__)
+app.config.secret_token = "3b7cd727ee24e8444053437c36cc66c4"
+app.config.active_support.deprecation = :log
+app.config.action_dispatch.show_exceptions = false
+
+app.config.event_tracker.mixpanel_key = "YOUR_TOKEN"
+
+app.initialize!
+
+app.routes.draw do
+  match ':controller(/:action(/:id))'
+end
+
+class ApplicationController < ActionController::Base; end
+
+require 'rspec/rails'
+require "steak"
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: event_tracker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McMahon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy integration with Mixpanel and Kissmetrics for Rails
+email:
+- paul@mobalean.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- event_tracker.gemspec
+- lib/event_tracker.rb
+- lib/event_tracker/mixpanel.rb
+- lib/event_tracker/version.rb
+- spec/app/views/layouts/application.html.erb
+- spec/event_tracker_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4227757316548368302
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4227757316548368302
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Track using javascript from your controllers, even when redirecting
+test_files:
+- spec/app/views/layouts/application.html.erb
+- spec/event_tracker_spec.rb
+- spec/spec_helper.rb