loganb-mixpanel 0.7.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alvaro Gil, cuboxsa.com
+
+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.rdoc

@@ -0,0 +1,66 @@
+== What is Mixpanel (the service) ?
+
+Mixpanel is a real-time analytics service that helps companies understand how users interact with web applications.
+http://mixpanel.com
+
+== What does this Gem do?
+
+* Track events with properties directly from your backend.
+* Track events with properties through javascript using a rack middleware.
+
+
+== How to install?
+
+  gem install mixpanel
+
+
+== How to use it with a Rails application?
+
+In your environment config file add this.
+
+  Rails::Initializer.run do |config|
+
+    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_filter :initialize_mixpanel
+
+  def initialize_mixpanel
+    @mixpanel = Mixpanel.new("YOUR_MIXPANEL_API_TOKEN", request.env, true)
+  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"})
+
+To execute any javascript API call
+
+  @mixpanel.append_api("register", {:some => "property"})
+  @mixpanel.append_api("identify", "Unique Identifier")
+
+
+== Notes
+
+There are two forms of async operation: 
+* Using MixpanelMiddleware, events are queued via Mixpanel#append_event and inserted into a JavaScript block within the HTML response.  
+* Using Mixpanel.new(…, …, true), events are sent to a subprocess via a pipe and the sub process which asynchronously send events to Mixpanel.  This process uses a single thread to upload events, and may start dropping events if your application generates them at a very high rate.  
+
+== Collaborators and Maintainers
+
+* {Alvaro Gil}[https://github.com/zevarito] (Author)
+* {Nathan Baxter}[https://github.com/LogicWolfe]
+* {Jake Mallory}[https://github.com/tinomen]
+* {Logan Bowers}[https://github.com/loganb]

data/Rakefile

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+task :default => :spec
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ["-u -c -fs"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/lib/mixpanel.rb

@@ -0,0 +1,2 @@
+require 'mixpanel/mixpanel'
+require 'mixpanel/mixpanel_middleware'

data/lib/mixpanel/mixpanel.rb

@@ -0,0 +1,95 @@
+require "open-uri"
+require 'base64'
+require 'json'
+
+require 'thread'
+
+class Mixpanel
+  def initialize(token, env, async = false)
+    @token = token
+    @env = env
+    @async = async
+    clear_queue
+  end
+
+  def append_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)
+  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
+  
+  class <<self
+    WORKER_MUTEX = Mutex.new
+    
+    def worker
+      WORKER_MUTEX.synchronize do
+        @worker || (@worker = IO.popen(self.cmd, 'w'))
+      end
+    end
+    
+    def dispose_worker(w)
+      WORKER_MUTEX.synchronize do
+        if(@worker == w)
+          @worker = nil
+          w.close
+        end
+      end
+    end
+    
+    def cmd
+      @cmd || begin
+        require 'escape'
+        require 'rbconfig'
+        interpreter = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['RUBY_SO_NAME'])
+        subprocess  = File.join(File.dirname(__FILE__), 'mixpanel_subprocess.rb')
+        @cmd = Escape.shell_command([interpreter, subprocess])
+      end
+    end
+  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}"
+
+    if(@async)
+      w = Mixpanel.worker
+      begin
+        url << "\n"
+        w.write(url)
+      rescue Errno::EPIPE => e
+        Mixpanel.dispose_worker(w)
+      end
+    else
+      open(url).read
+    end
+  end
+
+  def build_event(event, properties)
+    {:event => event, :properties => properties}
+  end
+end

data/lib/mixpanel/mixpanel_middleware.rb

@@ -0,0 +1,119 @@
+require 'rack'
+
+class MixpanelMiddleware
+  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
+
+  private
+
+  def update_response!
+    @response.each do |part|
+      if is_regular_request? && is_html_response?
+        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.insert(0, render_event_tracking_scripts) unless queue.empty?
+      elsif is_ajax_request? && is_javascript_response?
+        part.insert(0, render_event_tracking_scripts(false)) unless queue.empty?
+      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
+    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!
+    @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?
+
+    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) {}"
+
+    include_script_tag ? "<script type='text/javascript'>#{output}</script>" : output
+  end
+end

data/lib/mixpanel/mixpanel_subprocess.rb

@@ -0,0 +1,30 @@
+
+require 'rubygems'
+require 'mixpanel'
+require 'open-uri'
+
+require 'thread'
+
+class Mixpanel::Subprocess
+  Q = Queue.new
+  ENDMARKER = Object.new
+
+  Thread.abort_on_exception = true
+  producer = Thread.new do 
+    STDIN.each_line() do |url|
+      STDERR.puts("Dropped: #{url}") && next if Q.length > 10000
+      Q << url
+    end
+    Q << ENDMARKER
+  end
+
+  loop do
+    url = Q.pop
+    break if(url == ENDMARKER)
+    url.chomp!
+    next if(url.empty?) #for testing
+  
+    open(url).read
+  end
+  producer.join
+end

data/mixpanel.gemspec

@@ -0,0 +1,22 @@
+files = ['README.rdoc', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/*'].map {|f| Dir[f]}.flatten
+
+spec = Gem::Specification.new do |s|
+  s.name = "loganb-mixpanel"
+  s.version = "0.7.1"
+  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 = "logan@datacurrent.com"
+  s.homepage = "http://github.com/loganb/mixpanel"
+  s.platform = Gem::Platform::RUBY
+  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,282 @@
+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 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
+        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 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"})
+        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 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, {})
+      @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

@@ -0,0 +1,113 @@
+require 'spec_helper'
+
+describe Mixpanel do
+  before(:each) do
+    @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", "@env")
+    end
+  end
+
+  context "Cleaning appended events" do
+    it "should clear the queue" do
+      @mixpanel.append_event("Sign up")
+      @mixpanel.queue.size.should == 1
+      @mixpanel.clear_queue
+      @mixpanel.queue.size.should == 0
+    end
+  end
+
+  context "Accessing Mixpanel through direct request" do
+    context "Tracking events" do
+      it "should track simple events" do
+        @mixpanel.track_event("Sign up").should == true
+      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, :ip => "127.0.0.1"}}
+
+        @mixpanel.should_receive(:request).with(params).and_return("1")
+        @mixpanel.track_event("Sign up").should == true
+      end
+    end
+  end
+
+  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_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, "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
+  
+  context "Accessing Mixpanel asynchronously" do
+    it "should open a subprocess successfully" do
+      w = Mixpanel.worker
+      w.should == Mixpanel.worker
+    end
+    
+    it "should be able to write lines to the worker" do
+      w = Mixpanel.worker
+      
+      #On most systems this will exceed the pipe buffer size
+      8.times do
+        9000.times do 
+          w.write("\n")
+        end
+        sleep 0.1
+      end
+    end
+    
+    it "should dispose of a worker" do
+      w = Mixpanel.worker
+      Mixpanel.dispose_worker(w)
+      
+      w.closed?.should == true
+      w2 = Mixpanel.worker
+      w2.should_not == w
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+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_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
+
+# Fakeweb
+FakeWeb.allow_net_connect = false
+FakeWeb.register_uri(:any, /http:\/\/api\.mixpanel\.com.*/, :body => "1")

data/spec/support/rack_apps.rb

@@ -0,0 +1,203 @@
+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
+  <<-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
+
+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

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: loganb-mixpanel
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 1
+  version: 0.7.1
+platform: ruby
+authors: 
+- Alvaro Gil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-24 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !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: logan@datacurrent.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- LICENSE
+- Rakefile
+- mixpanel.gemspec
+- 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/mixpanel_subprocess.rb
+- lib/mixpanel.rb
+has_rdoc: true
+homepage: http://github.com/loganb/mixpanel
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Supports direct request api and javascript requests through a middleware.
+test_files: []
+