mixpanel 0.5.1 → 0.6.0

data/README.rdoc

@@ -1,11 +1,12 @@
 == What is Mixpanel (the service) ?
 
-*Mixpanel* is a real-time analytics service that helps companies understand how users interact with web applications.
+Mixpanel is a real-time analytics service that helps companies understand how users interact with web applications.
 http://mixpanel.com
 
 == What does this Gem?
 
-* Track events with properties directly from your backend
+* Track events with properties directly from your backend.
+* Track events with properties through javascript using a rack middleware.
 
 
 == How to install?
@@ -13,13 +14,29 @@ http://mixpanel.com
   gem install mixpanel
 
 
-== How to use?
+== How to use it with a Rails application?
 
-  require 'mixpanel'
+In your application_controller class add a method to instance mixpanel.
 
-  mixpanel = Mixpanel.new("your_mixpanel_project_token")
+  before_filer :initialize_mixpanel
 
-  mixpanel.track("Sign up", {
-    :referer => "http://example.com",
-    :ip => "4.4.4.4"
-  })
+  def initialize_mixpanel
+    @mixpanel = Mixpanel.new("YOUR_MIXPANEL_API_TOKEN", request.env)
+  end
+
+Then in each request you want to track some event you can use:
+
+To track events directly from your backend...
+
+  @mixpanel.track_event("Sign in", {:some => "property"})
+
+To track events after response with javascript...
+
+  @mixpanel.append_event("Sign in", {:some => "property"})
+
+
+== Notes
+
+It is strongly recommended to call Mixpanel#track_event using an async lib
+like delayed job or similar, otherwise you will delay your server responses
+with mixpanel responses.

data/lib/mixpanel.rb

@@ -1,42 +1,2 @@
-require "open-uri"
-require 'base64'
-require 'json'
-
-class Mixpanel
-  attr_reader :events
-
-  def initialize(token, options = {})
-    @token = token
-    @events = []
-  end
-
-  def append_event(event, properties = {})
-    @events << build_event(event, properties)
-  end
-
-  def track_event(event, properties = {})
-    params = build_event(event, properties.merge(:token => @token, :time => Time.now.utc.to_i))
-    parse_response request(params)
-  end
-
-  def clean_queue
-    @events = []
-  end
-
-  private
-
-  def parse_response(response)
-    response == "1" ? true : false
-  end
-
-  def request(params)
-    data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
-    url = "http://api.mixpanel.com/track/?data=#{data}"
-
-    open(url).read
-  end
-
-  def build_event(event, properties)
-    {:event => event, :properties => properties}
-  end
-end
+require 'mixpanel/mixpanel'
+require 'mixpanel/mixpanel_middleware'

data/lib/mixpanel/mixpanel.rb

@@ -0,0 +1,49 @@
+require "open-uri"
+require 'base64'
+require 'json'
+
+class Mixpanel
+  def initialize(token, env)
+    @token = token
+    @env = env
+    clear_queue
+  end
+
+  def append_event(event, properties = {})
+    queue << build_event(event, properties)
+  end
+
+  def track_event(event, properties = {})
+    params = build_event(event, properties.merge(:token => @token, :time => Time.now.utc.to_i, :ip => ip))
+    parse_response request(params)
+  end
+
+  def ip
+    @env.has_key?("REMOTE_ADDR") ? @env["REMOTE_ADDR"] : ""
+  end
+
+  def queue
+    @env["mixpanel_events"]
+  end
+
+  def clear_queue
+    @env["mixpanel_events"] = []
+  end
+
+  private
+
+  def parse_response(response)
+    response == "1" ? true : false
+  end
+
+  def request(params)
+    data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
+    url = "http://api.mixpanel.com/track/?data=#{data}"
+
+    open(url).read
+  end
+
+  def build_event(event, properties)
+    {:event => event, :properties => properties}
+  end
+end

data/lib/mixpanel/mixpanel_middleware.rb

@@ -0,0 +1,95 @@
+require 'rack'
+
+class MixpanelMiddleware
+  def initialize(app, mixpanel_token)
+    @app = app
+    @token = mixpanel_token
+  end
+
+  def call(env)
+    @env = env
+
+    @status, @headers, @response = @app.call(env)
+
+    update_response!
+    update_content_length!
+    delete_event_queue!
+
+    [@status, @headers, @response]
+  end
+
+  private
+
+  def update_response!
+    @response.each do |part|
+      if is_regular_request? && is_html_response?
+        part.gsub!("</head>", "#{render_mixpanel_scripts}</head>")
+        part.gsub!("</head>", "#{render_event_tracking_scripts}</head>")
+      elsif is_ajax_request? && is_html_response?
+        part.gsub!(part, render_event_tracking_scripts + part)
+      elsif is_ajax_request? && is_javascript_response?
+        part.gsub!(part, render_event_tracking_scripts(false) + part)
+      end
+    end
+  end
+
+  def update_content_length!
+    new_size = 0
+    @response.each{|part| new_size += part.bytesize}
+    @headers.merge!("Content-Length" => new_size.to_s)
+  end
+
+  def is_regular_request?
+    !is_ajax_request?
+  end
+
+  def is_ajax_request?
+    @env.has_key?("HTTP_X_REQUESTED_WITH") && @env["HTTP_X_REQUESTED_WITH"] == "XMLHttpRequest"
+  end
+
+  def is_html_response?
+    @headers["Content-Type"].include?("text/html") if @headers.has_key?("Content-Type")
+  end
+
+  def is_javascript_response?
+    @headers["Content-Type"].include?("text/javascript") if @headers.has_key?("Content-Type")
+  end
+
+  def render_mixpanel_scripts
+    <<-EOT
+  <script type='text/javascript'>
+    var mp_protocol = (('https:' == document.location.protocol) ? 'https://' : 'http://');
+    document.write(unescape('%3Cscript src="' + mp_protocol + 'api.mixpanel.com/site_media/js/api/mixpanel.js" type="text/javascript"%3E%3C/script%3E'));
+  </script>
+  <script type='text/javascript'>
+    try {
+      var mpmetrics = new MixpanelLib('#{@token}');
+    } catch(err) {
+      null_fn = function () {};
+      var mpmetrics = {
+        track: null_fn,  track_funnel: null_fn,  register: null_fn,  register_once: null_fn, register_funnel: null_fn
+      };
+    }
+  </script>
+    EOT
+  end
+
+  def delete_event_queue!
+    @env.delete('mixpanel_events')
+  end
+
+  def queue
+    return [] if !@env.has_key?('mixpanel_events') || @env['mixpanel_events'].empty?
+    @env['mixpanel_events']
+  end
+
+  def render_event_tracking_scripts(include_script_tag=true)
+    return "" if queue.empty?
+
+    output = queue.map {|event| %(mpmetrics.track("#{event[:event]}", #{event[:properties].to_json});) }.join("\n")
+
+    output = "try {#{output}} catch(err) {}"
+
+    include_script_tag ? "<script type='text/javascript'>#{output}</script>" : output
+  end
+end

data/mixpanel.gemspec

@@ -1,27 +1,23 @@
+files = ['README.rdoc', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/*'].map {|f| Dir[f]}.flatten
+
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "0.5.1"
+  s.version = "0.6.0"
   s.rubyforge_project = "mixpanel"
-  s.description = "Simple lib to track events in Mixpanel service."
+  s.description = "Simple lib to track events in Mixpanel service. It can be used in any rack based framework."
   s.author = "Alvaro Gil"
   s.email = "zevarito@gmail.com"
   s.homepage = "http://cuboxsa.com"
   s.platform = Gem::Platform::RUBY
-  s.summary = "Supports direct request api and javascript requests."
-  s.files = %w[
-    .gitignore
-    README.rdoc
-    LICENSE
-    Rakefile
-    mixpanel.gemspec
-    lib/mixpanel.rb
-    spec/spec_helper.rb
-    spec/mixpanel/mixpanel_spec.rb
-  ]
+  s.summary = "Supports direct request api and javascript requests through a middleware."
+  s.files = files
   s.require_path = "lib"
   s.has_rdoc = false
   s.extra_rdoc_files = ["README.rdoc"]
   s.add_dependency 'json'
+  s.add_dependency 'rack'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rack-test'
   s.add_development_dependency 'fakeweb'
+  s.add_development_dependency 'nokogiri'
 end

data/spec/mixpanel/mixpanel_middleware_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe MixpanelMiddleware do
+  include Rack::Test::Methods
+
+  describe "Dummy apps, no text/html" do
+    before do
+      setup_rack_application(DummyApp, :body => html_document, :headers => {})
+      get "/"
+    end
+
+    it "should pass through if the document is not text/html content type" do
+      last_response.body.should == html_document
+    end
+  end
+
+  describe "Appending mixpanel scripts" do
+    describe "With ajax requests" do
+      before do
+        setup_rack_application(DummyApp, :body => html_document, :headers => {"Content-Type" => "text/html"})
+        get "/", {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+      end
+
+      it "should not append mixpanel scripts to head element" do
+        Nokogiri::HTML(last_response.body).search('script').should be_empty
+      end
+
+      it "should not update Content-Length in headers" do
+        last_response.headers["Content-Length"].should == html_document.length.to_s
+      end
+    end
+
+    describe "With regular requests" do
+      before do
+        setup_rack_application(DummyApp, :body => html_document, :headers => {"Content-Type" => "text/html"})
+        get "/"
+      end
+
+      it "should append mixpanel scripts to head element" do
+        Nokogiri::HTML(last_response.body).search('head script').should_not be_empty
+        Nokogiri::HTML(last_response.body).search('body script').should be_empty
+      end
+
+      it "should have 2 included scripts" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 2
+      end
+
+      it "should use the specified token instantiating mixpanel lib" do
+        last_response.should =~ /new MixpanelLib\('#{MIX_PANEL_TOKEN}'\)/
+      end
+
+      it "should define Content-Length if not exist" do
+        last_response.headers.has_key?("Content-Length").should == true
+      end
+
+      it "should update Content-Length in headers" do
+        last_response.headers["Content-Length"].should_not == html_document.length.to_s
+      end
+    end
+  end
+
+  describe "Tracking appended events" do
+    before do
+      @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, {})
+      @mixpanel.append_event("Visit", {:article => 1})
+      @mixpanel.append_event("Sign in")
+    end
+
+    describe "With ajax requests and text/html response" do
+      before do
+        setup_rack_application(DummyApp, :body => "<p>response</p>", :headers => {"Content-Type" => "text/html"})
+
+        get "/", {}, {"mixpanel_events" => @mixpanel.queue, "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+      end
+
+      it "should render only one script tag" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 1
+      end
+
+      it "should be tracking the correct events inside a script tag" do
+        script = Nokogiri::HTML(last_response.body).search('script')
+        script.inner_html.should =~ /try\s?\{(.*)\}\s?catch/m
+        script.inner_html.should =~ /mpmetrics\.track\("Visit",\s?\{"article":1\}\)/
+        script.inner_html.should =~ /mpmetrics\.track\("Sign in",\s?\{\}\)/
+      end
+
+      it "should delete events queue after use it" do
+        last_request.env.has_key?("mixpanel_events").should == false
+      end
+    end
+
+    describe "With ajax requests and text/javascript response" do
+      before do
+        setup_rack_application(DummyApp, :body => "alert('response')", :headers => {"Content-Type" => "text/javascript"})
+        get "/", {}, {"mixpanel_events" => @mixpanel.queue, "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+      end
+
+      it "should not render a script tag" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 0
+      end
+
+      it "should be tracking the correct events inside a try/catch" do
+        script = last_response.body.match(/try\s?\{(.*)\}\s?catch/m)[1]
+        script.should =~ /mpmetrics\.track\("Visit",\s?\{"article":1\}\)/
+        script.should =~ /mpmetrics\.track\("Sign in",\s?\{\}\)/
+      end
+
+      it "should delete events queue after use it" do
+        last_request.env.has_key?("mixpanel_events").should == false
+      end
+    end
+
+    describe "With regular requests" do
+      before do
+        setup_rack_application(DummyApp, :body => html_document, :headers => {"Content-Type" => "text/html"})
+
+        get "/", {}, {"mixpanel_events" => @mixpanel.queue}
+      end
+
+      it "should render 3 script tags" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 3
+      end
+
+      it "should be tracking the correct events" do
+        last_response.body.should =~ /mpmetrics\.track\("Visit",\s?\{"article":1\}\)/
+        last_response.body.should =~ /mpmetrics\.track\("Sign in",\s?\{\}\)/
+      end
+
+      it "should delete events queue after use it" do
+        last_request.env.has_key?("mixpanel_events").should == false
+      end
+    end
+  end
+end

data/spec/mixpanel/mixpanel_spec.rb

@@ -2,21 +2,21 @@ require 'spec_helper'
 
 describe Mixpanel do
   before do
-    @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN)
+    @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, @env = {"REMOTE_ADDR" => "127.0.0.1"})
   end
 
   context "Initializing object" do
     it "should have an instance variable for token and events" do
-      @mixpanel.instance_variables.should include("@token", "@events")
+      @mixpanel.instance_variables.should include("@token", "@env")
     end
   end
 
-  context "Cleaning events" do
-    it "should clean the queue" do
+  context "Cleaning appended events" do
+    it "should clear the queue" do
       @mixpanel.append_event("Sign up")
-      @mixpanel.events.size.should == 1
-      @mixpanel.clean_queue
-      @mixpanel.events.size.should == 0
+      @mixpanel.queue.size.should == 1
+      @mixpanel.clear_queue
+      @mixpanel.queue.size.should == 0
     end
   end
 
@@ -27,7 +27,7 @@ describe Mixpanel do
       end
 
       it "should call request method with token and time value" do
-        params = {:event => "Sign up", :properties => {:token => MIX_PANEL_TOKEN, :time => Time.now.utc.to_i}}
+        params = {:event => "Sign up", :properties => {:token => MIX_PANEL_TOKEN, :time => Time.now.utc.to_i, :ip => "127.0.0.1"}}
 
         @mixpanel.should_receive(:request).with(params).and_return("1")
         @mixpanel.track_event("Sign up").should == true
@@ -37,19 +37,28 @@ describe Mixpanel do
 
   context "Accessing Mixpanel through javascript API" do
     context "Appending events" do
+      it "should store the event under the appropriate key" do
+        @mixpanel.append_event("Sign up")
+        @env.has_key?("mixpanel_events").should == true
+      end
+
+      it "should be the same the queue than env['mixpanel_events']" do
+        @env['mixpanel_events'].object_id.should == @mixpanel.queue.object_id
+      end
+
       it "should append simple events" do
         @mixpanel.append_event("Sign up")
-        mixpanel_events_should_include(@mixpanel, "Sign up", {})
+        mixpanel_queue_should_include(@mixpanel, "Sign up", {})
       end
 
       it "should append events with properties" do
         @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
-        mixpanel_events_should_include(@mixpanel, "Sign up", {:referer => 'http://example.com'})
+        mixpanel_queue_should_include(@mixpanel, "Sign up", {:referer => 'http://example.com'})
       end
 
-      it "should give direct access to events" do
+      it "should give direct access to queue" do
         @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
-        @mixpanel.events.size.should == 1
+        @mixpanel.queue.size.should == 1
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,10 +1,14 @@
+require 'ruby-debug'
 require File.join(File.dirname(__FILE__), "../lib", "mixpanel")
+require 'rack/test'
 require 'fakeweb'
+require 'nokogiri'
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
 MIX_PANEL_TOKEN = "e2d8b0bea559147844ffab3d607d26a6"
 
-def mixpanel_events_should_include(mixpanel, event, properties)
-  mixpanel.events.each do |event_hash|
+def mixpanel_queue_should_include(mixpanel, event, properties)
+  mixpanel.queue.each do |event_hash|
     event_hash[:event].should == event
     event_hash[:properties].should == properties if properties
   end

data/spec/support/rack_apps.rb

@@ -0,0 +1,27 @@
+def setup_rack_application(application, options = {})
+  stub!(:app).and_return(MixpanelMiddleware.new(application.new(options), MIX_PANEL_TOKEN))
+end
+
+def html_document
+  <<-EOT
+    <html>
+      <head>
+      </head>
+      <body>
+      </body>
+    </html>
+  EOT
+end
+
+class DummyApp
+  def initialize(options)
+    @response_with = {}
+    @response_with[:status] = options[:status] || "200"
+    @response_with[:headers] = options[:headers] || {}
+    @response_with[:body] = options[:body] || ""
+  end
+
+  def call(env)
+    [@response_with[:status], @response_with[:headers], [@response_with[:body]]]
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 1
-  version: 0.5.1
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Alvaro Gil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-05 00:00:00 -03:00
+date: 2010-07-16 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,7 +33,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rack
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -44,10 +44,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -60,7 +60,49 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: Simple lib to track events in Mixpanel service.
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: Simple lib to track events in Mixpanel service. It can be used in any rack based framework.
 email: zevarito@gmail.com
 executables: []
 
@@ -69,14 +111,17 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - README.rdoc
 - LICENSE
 - Rakefile
 - mixpanel.gemspec
-- lib/mixpanel.rb
-- spec/spec_helper.rb
+- spec/mixpanel/mixpanel_middleware_spec.rb
 - spec/mixpanel/mixpanel_spec.rb
+- spec/spec_helper.rb
+- spec/support/rack_apps.rb
+- lib/mixpanel/mixpanel.rb
+- lib/mixpanel/mixpanel_middleware.rb
+- lib/mixpanel.rb
 has_rdoc: true
 homepage: http://cuboxsa.com
 licenses: []
@@ -110,6 +155,6 @@ rubyforge_project: mixpanel
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Supports direct request api and javascript requests.
+summary: Supports direct request api and javascript requests through a middleware.
 test_files: []
 

data/.gitignore

@@ -1,2 +0,0 @@
-.bundle
-mixpanel*.gem