mixpanel 0.6.1 → 0.7.0

data/README.rdoc

@@ -3,7 +3,7 @@
 Mixpanel is a real-time analytics service that helps companies understand how users interact with web applications.
 http://mixpanel.com
 
-== What does this Gem?
+== What does this Gem do?
 
 * Track events with properties directly from your backend.
 * Track events with properties through javascript using a rack middleware.
@@ -22,9 +22,15 @@ In your environment config file add this.
 
     config.middleware.use "MixpanelMiddleware", "YOUR_MIXPANEL_API_TOKEN"
 
+If you want to use the asynchronous version of Mixpanel's javascript API
+
+  Rails::Initializer.run do |config|
+
+    config.middleware.use "MixpanelMiddleware", "YOUR_MIXPANEL_API_TOKEN", :async => true
+
 In your application_controller class add a method to instance mixpanel.
 
-  before_filer :initialize_mixpanel
+  before_filter :initialize_mixpanel
 
   def initialize_mixpanel
     @mixpanel = Mixpanel.new("YOUR_MIXPANEL_API_TOKEN", request.env)
@@ -40,9 +46,20 @@ To track events after response with javascript...
 
   @mixpanel.append_event("Sign in", {:some => "property"})
 
+To execute any javascript API call
+
+  @mixpanel.append_api("register", {:some => "property"})
+  @mixpanel.append_api("identify", "Unique Identifier")
+
 
 == 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.
+
+== Collaborators and Maintainers
+
+* {Alvaro Gil}[https://github.com/zevarito] (Author)
+* {Nathan Baxter}[https://github.com/LogicWolfe]
+* {Jake Mallory}[https://github.com/tinomen]

data/lib/mixpanel/mixpanel.rb

@@ -10,9 +10,13 @@ class Mixpanel
   end
 
   def append_event(event, properties = {})
-    queue << build_event(event, properties)
+    append_api('track', event, properties)
   end
-
+  
+  def append_api(type, *args)
+    queue << [type, args.map {|arg| arg.to_json}]
+  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)

data/lib/mixpanel/mixpanel_middleware.rb

@@ -1,20 +1,23 @@
 require 'rack'
 
 class MixpanelMiddleware
-  def initialize(app, mixpanel_token)
+  def initialize(app, mixpanel_token, options={})
     @app = app
     @token = mixpanel_token
+    @options = {
+      :async => false
+    }.merge(options)
   end
 
   def call(env)
     @env = env
 
     @status, @headers, @response = @app.call(env)
-
+    
     update_response!
     update_content_length!
     delete_event_queue!
-
+    
     [@status, @headers, @response]
   end
 
@@ -23,12 +26,15 @@ class MixpanelMiddleware
   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>")
+        insert_at = part.index('</head')
+        unless insert_at.nil?
+          part.insert(insert_at, render_event_tracking_scripts) unless queue.empty?
+          part.insert(insert_at, render_mixpanel_scripts) #This will insert the mixpanel initialization code before the queue of tracking events.
+        end
       elsif is_ajax_request? && is_html_response?
-        part.gsub!(part, render_event_tracking_scripts + part)
+        part.insert(0, render_event_tracking_scripts) unless queue.empty?
       elsif is_ajax_request? && is_javascript_response?
-        part.gsub!(part, render_event_tracking_scripts(false) + part)
+        part.insert(0, render_event_tracking_scripts(false)) unless queue.empty?
       end
     end
   end
@@ -56,22 +62,36 @@ class MixpanelMiddleware
   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
+    if @options[:async]
+        <<-EOT
+      <script type='text/javascript'>
+        var mpq = [];
+        mpq.push(["init", "#{@token}"]);
+        (function() {
+        var mp = document.createElement("script"); mp.type = "text/javascript"; mp.async = true;
+        mp.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + "//api.mixpanel.com/site_media/js/api/mixpanel.js";
+        var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(mp, s);
+        })();
+      </script>
+        EOT
+    else
+      <<-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
   end
 
   def delete_event_queue!
@@ -86,7 +106,11 @@ class MixpanelMiddleware
   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")
+    if @options[:async]
+      output = queue.map {|type, arguments| %(mpq.push(["#{type}", #{arguments.join(', ')}]);) }.join("\n")
+    else
+      output = queue.map {|type, arguments| %(mpmetrics.#{type}(#{arguments.join(', ')});) }.join("\n")
+    end
 
     output = "try {#{output}} catch(err) {}"
 

data/mixpanel.gemspec

@@ -2,7 +2,7 @@ files = ['README.rdoc', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/*
 
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "0.6.1"
+  s.version = "0.7.0"
   s.rubyforge_project = "mixpanel"
   s.description = "Simple lib to track events in Mixpanel service. It can be used in any rack based framework."
   s.author = "Alvaro Gil"

data/spec/mixpanel/mixpanel_middleware_spec.rb

@@ -14,6 +14,66 @@ describe MixpanelMiddleware do
     end
   end
 
+  describe "Appending async mixpanel scripts" do
+    describe "With ajax requests" do
+      before do
+        setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:async => true})
+        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 large ajax response" do
+      before do
+        setup_rack_application(DummyApp, {:body => large_script, :headers => {"Content-Type" => "text/html"}}, {:async => true})
+        get "/", {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+      end
+      
+      it "should not append mixpanel scripts to head element" do
+        last_response.body.index('var mp_protocol').should be_nil
+      end
+
+      it "should pass through if the document is not text/html content type" do
+        last_response.body.should == large_script
+      end
+    end
+    
+    describe "With regular requests" do
+      before do
+        setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:async => true})
+        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 1 included script" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 1
+      end
+
+      it "should use the specified token instantiating mixpanel lib" do
+        last_response.should =~ /mpq.push\(\["init", "#{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 "Appending mixpanel scripts" do
     describe "With ajax requests" do
       before do
@@ -29,7 +89,22 @@ describe MixpanelMiddleware do
         last_response.headers["Content-Length"].should == html_document.length.to_s
       end
     end
+    
+    describe "With large ajax response" do
+      before do
+        setup_rack_application(DummyApp, :body => large_script, :headers => {"Content-Type" => "text/html"})
+        get "/", {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
+      end
+      
+      it "should not append mixpanel scripts to head element" do
+        last_response.body.index('var mp_protocol').should be_nil
+      end
 
+      it "should pass through if the document is not text/html content type" do
+        last_response.body.should == large_script
+      end
+    end
+    
     describe "With regular requests" do
       before do
         setup_rack_application(DummyApp, :body => html_document, :headers => {"Content-Type" => "text/html"})
@@ -59,6 +134,79 @@ describe MixpanelMiddleware do
     end
   end
 
+  describe "Tracking async 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"}}, {:async => true})
+
+        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 =~ /mpq\.push\(\["track",\s?"Visit",\s?\{"article":1\}\]\)/
+        script.inner_html.should =~ /mpq\.push\(\["track",\s?"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"}}, {:async => true})
+        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 =~ /mpq\.push\(\["track",\s?"Visit",\s?\{"article":1\}\]\)/
+        script.should =~ /mpq\.push\(\["track",\s?"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"}}, {:async => true})
+
+        get "/", {}, {"mixpanel_events" => @mixpanel.queue}
+      end
+
+      it "should render 2 script tags" do
+        Nokogiri::HTML(last_response.body).search('script').size.should == 2
+      end
+
+      it "should be tracking the correct events" do
+        last_response.body.should =~ /mpq\.push\(\["track",\s?"Visit",\s?\{"article":1\}\]\)/
+        last_response.body.should =~ /mpq\.push\(\["track",\s?"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
+
   describe "Tracking appended events" do
     before do
       @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, {})

data/spec/mixpanel/mixpanel_spec.rb

@@ -48,18 +48,38 @@ describe Mixpanel do
 
       it "should append simple events" do
         @mixpanel.append_event("Sign up")
-        mixpanel_queue_should_include(@mixpanel, "Sign up", {})
+        mixpanel_queue_should_include(@mixpanel, "track", "Sign up", {})
       end
 
       it "should append events with properties" do
         @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
-        mixpanel_queue_should_include(@mixpanel, "Sign up", {:referer => 'http://example.com'})
+        mixpanel_queue_should_include(@mixpanel, "track", "Sign up", {:referer => 'http://example.com'})
       end
 
       it "should give direct access to queue" do
         @mixpanel.append_event("Sign up", {:referer => 'http://example.com'})
         @mixpanel.queue.size.should == 1
       end
+      
+      it "should provide direct access to the JS api" do
+        @mixpanel.append_api('track', "Sign up", {:referer => 'http://example.com'})
+        mixpanel_queue_should_include(@mixpanel, "track", "Sign up", {:referer => 'http://example.com'})
+      end
+      
+      it "should allow identify to be called through the JS api" do
+        @mixpanel.append_api('identify', "some@one.com")
+        mixpanel_queue_should_include(@mixpanel, "identify", "some@one.com")
+      end
+
+      it "should allow identify to be called through the JS api" do
+        @mixpanel.append_api('identify', "some@one.com")
+        mixpanel_queue_should_include(@mixpanel, "identify", "some@one.com")
+      end
+      
+      it "should allow the tracking of super properties in JS" do
+        @mixpanel.append_api('register', {:user_id => 12345, :email => "some@one.com"})
+        mixpanel_queue_should_include(@mixpanel, 'register', {:user_id => 12345, :email => "some@one.com"})
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -7,10 +7,11 @@ Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].e
 
 MIX_PANEL_TOKEN = "e2d8b0bea559147844ffab3d607d26a6"
 
-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
+
+def mixpanel_queue_should_include(mixpanel, type, *arguments)
+  mixpanel.queue.each do |event_type, event_arguments|
+    event_arguments.should == arguments.map{|arg| arg.to_json}
+    event_type.should == type
   end
 end
 

data/spec/support/rack_apps.rb

@@ -1,5 +1,5 @@
-def setup_rack_application(application, options = {})
-  stub!(:app).and_return(MixpanelMiddleware.new(application.new(options), MIX_PANEL_TOKEN))
+def setup_rack_application(application, options = {}, mixpanel_options = {})
+  stub!(:app).and_return(MixpanelMiddleware.new(application.new(options), MIX_PANEL_TOKEN, mixpanel_options))
 end
 
 def html_document
@@ -25,3 +25,179 @@ class DummyApp
     [@response_with[:status], @response_with[:headers], [@response_with[:body]]]
   end
 end
+
+def large_script
+  <<-EOT
+    <script type='text/javascript'>
+      //<![CDATA[
+        function update_milestone_divs(obj){
+          $('#milestones').show();
+          $('#milestones').children('div').hide();
+
+          divid = obj.options[obj.selectedIndex].value;
+
+          divid = '#milestone_' + divid
+          $(divid).show()
+        }
+
+        $(document).ready(function() {
+          /*
+          * First step is to create title attributes for the rows in the table
+          * This isn't needed if the required 'title' attribute is already set in the HTML in the
+          * DOM
+          */
+          $('#milestone_table tbody tr').each( function() {
+            var sTitle;
+            var nTds = $('td', this);
+            var sPic = $(nTds[3]).text();
+            var sName = $(nTds[1]).text();
+
+            sTitle =  '<img src='+sPic+' height=60 width=60/><br>'+sName;
+            this.setAttribute( 'title', sTitle );
+
+          } );
+
+          /* Apply the tooltips */
+          $('#milestone_table tbody tr[title]').tooltip( {
+            "delay": 0,
+            "track": true,
+            "fade": 250
+          } );
+
+          /* Init DataTables */
+          $('#milestone_table').dataTable({
+            "iDisplayLength": 10,
+            "aaSorting": [[ 2, "desc" ]],
+          });
+        });
+      //]]>
+    </script>
+    <style type='text/css'>
+      /*<![CDATA[*/
+        #milestone_table {
+          width:550px;
+
+        }
+
+        td { vertical-align:middle;}
+        td.select { width: 50px; padding-left:10px;}
+        td.title { text-align:left; font-size:120%; }
+        td.picture { width: 60px; display:none;}
+        td.when {  text-align: center; width: 100px; }
+      /*]]>*/
+    </style>
+    <div class='item_box' id='milestone_attachment'>
+      <form action="http://big.application.com/inbox_items/28" enctype="multipart/form-data" method="post"><div style="margin:0;padding:0;display:inline"><input name="_method" type="hidden" value="put" /><input name="authenticity_token" type="hidden" value="QF1y2YhiuVJv7qS3u5jShr6mvqjx0NWAD1FPPJTwY/w=" /></div>
+        <input id="transform_to" name="transform_to" type="hidden" value="milestone_attachment" />
+        <div>
+          <div class='addBox roundo' style='float:left; display:block; margin:5px 0; padding:0 5px 5px 5px;'>
+            <p>
+              Attach to memory for
+              <select name='person_id' onchange='update_milestone_divs(this)'>
+                <option></option>
+                <option value='40'>  Bill</option>
+                <option disabled='disabled'>  Sally (no memories)</option>
+                <option value='169'>  Tim</option>
+                <option disabled='disabled'>  Betty (no memories)</option>
+                <option value='173'>  Ted</option>
+              </select>
+            </p>
+          </div>
+        </div>
+        <div id='milestones'>
+          <div id='milestone_40' style='display:none;'>
+            <h4>Memories for Bill</h4>
+            <table id='milestone_table'>
+              <thead>
+                <tr>
+                  <th>Select</th>
+                  <th>Title</th>
+                  <th>When?</th>
+                  <th style='display:none;'>Picture</th>
+                </tr>
+              </thead>
+              <tr>
+                <td class='select'><input id="milestone_40_179" name="milestone_40" type="radio" value="179" /></td>
+                <td class='title'>Ran a race</td>
+                <td class='when'>10/07/2010</td>
+                <td class='picture'>
+                  /system/photos/first_and_milestones/179/thumb/ed0e4428.jpeg
+                </td>
+              </tr>
+            </table>
+          </div>
+          <div id='milestone_169' style='display:none;'>
+            <h4>Memories for Tim</h4>
+            <table id='milestone_table'>
+              <thead>
+                <tr>
+                  <th>Select</th>
+                  <th>Title</th>
+                  <th>When?</th>
+                  <th style='display:none;'>Picture</th>
+                </tr>
+              </thead>
+              <tr>
+                <td class='select'><input id="milestone_169_204" name="milestone_169" type="radio" value="204" /></td>
+                <td class='title'>Kicked ball first time</td>
+                <td class='when'>03/12/1978</td>
+                <td class='picture'>
+                </td>
+              </tr>
+            </table>
+          </div>
+          <div id='milestone_173' style='display:none;'>
+            <h4>Memories for Ted</h4>
+            <table id='milestone_table'>
+              <thead>
+                <tr>
+                  <th>Select</th>
+                  <th>Title</th>
+                  <th>When?</th>
+                  <th style='display:none;'>Picture</th>
+                </tr>
+              </thead>
+              <tr>
+                <td class='select'><input id="milestone_173_195" name="milestone_173" type="radio" value="195" /></td>
+                <td class='title'>Testing the log</td>
+                <td class='when'>11/03/2010</td>
+                <td class='picture'>
+                </td>
+              </tr>
+              <tr>
+                <td class='select'><input id="milestone_173_196" name="milestone_173" type="radio" value="196" /></td>
+                <td class='title'>another test</td>
+                <td class='when'>11/03/2010</td>
+                <td class='picture'>
+                </td>
+              </tr>
+              <tr>
+                <td class='select'><input id="milestone_173_197" name="milestone_173" type="radio" value="197" /></td>
+                <td class='title'>one more</td>
+                <td class='when'>11/01/2010</td>
+                <td class='picture'>
+                </td>
+              </tr>
+              <tr>
+                <td class='select'><input id="milestone_173_198" name="milestone_173" type="radio" value="198" /></td>
+                <td class='title'>great time</td>
+                <td class='when'>11/03/2010</td>
+                <td class='picture'>
+                </td>
+              </tr>
+              <tr>
+                <td class='select'><input id="milestone_173_199" name="milestone_173" type="radio" value="199" /></td>
+                <td class='title'>please</td>
+                <td class='when'>11/03/2010</td>
+                <td class='picture'>
+                </td>
+              </tr>
+            </table>
+          </div>
+          <div class='clear'></div>
+        </div>
+        <div class="clear"></div><div id="buttonArea" style="width: 550px; margin-left: -20px"><input class="btn topper botter lbump20 blue " disabled="disabled" name="commit" style="display:none;" type="submit" value=".. saving .." /><input class="btn topper botter lbump20 blue " id="submit_btn" name="commit" onclick="$(this).hide(); $(this).prev().show();" type="submit" value="Save" /><a href="/inbox_items" class="btnSm topper botter lbump20">Cancel</a><a href="/inbox_items/28" class="btnSm red topper botter lbump20" id="delete_btn" onclick="if (confirm('Are you sure you want to delete this?')) { var f = document.createElement('form'); f.style.display = 'none'; this.parentNode.appendChild(f); f.method = 'POST'; f.action = this.href;var m = document.createElement('input'); m.setAttribute('type', 'hidden'); m.setAttribute('name', '_method'); m.setAttribute('value', 'delete'); f.appendChild(m);var s = document.createElement('input'); s.setAttribute('type', 'hidden'); s.setAttribute('name', 'authenticity_token'); s.setAttribute('value', 'QF1y2YhiuVJv7qS3u5jShr6mvqjx0NWAD1FPPJTwY/w='); f.appendChild(s);f.submit(); };return false;">Delete</a></div><div class="clear"></div>
+      </form>
+    </div>
+  EOT
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 1
-  version: 0.6.1
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Alvaro Gil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-16 00:00:00 -03:00
+date: 2010-11-26 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency