mixpanel 0.7.0 → 0.8.0

data/README.rdoc

@@ -33,7 +33,7 @@ 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)
+    @mixpanel = Mixpanel.new("YOUR_MIXPANEL_API_TOKEN", request.env, true)
   end
 
 Then in each request you want to track some event you can use:
@@ -54,12 +54,13 @@ To execute any javascript API call
 
 == 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.
+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/lib/mixpanel/mixpanel.rb

@@ -2,10 +2,13 @@ require "open-uri"
 require 'base64'
 require 'json'
 
+require 'thread'
+
 class Mixpanel
-  def initialize(token, env)
+  def initialize(token, env, async = false)
     @token = token
     @env = env
+    @async = async
     clear_queue
   end
 
@@ -33,6 +36,35 @@ class Mixpanel
   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
 
@@ -44,7 +76,17 @@ class Mixpanel
     data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
     url = "http://api.mixpanel.com/track/?data=#{data}"
 
-    open(url).read
+    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)

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

@@ -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.7.0"
+  s.version = "0.8.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"
@@ -16,6 +16,7 @@ spec = Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.rdoc"]
   s.add_dependency 'json'
   s.add_dependency 'rack'
+  s.add_dependency 'escape'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'fakeweb'

data/spec/mixpanel/mixpanel_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Mixpanel do
-  before do
+  before(:each) do
     @mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, @env = {"REMOTE_ADDR" => "127.0.0.1"})
   end
 
@@ -82,4 +82,32 @@ describe Mixpanel do
       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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
+  - 8
   - 0
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Alvaro Gil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 -02:00
+date: 2011-01-25 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: escape
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -58,10 +58,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rack-test
+  name: rspec
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -75,7 +75,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: rack-test
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -89,7 +89,7 @@ dependencies:
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
+  name: fakeweb
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
@@ -102,6 +102,20 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: Simple lib to track events in Mixpanel service. It can be used in any rack based framework.
 email: zevarito@gmail.com
 executables: []
@@ -121,6 +135,7 @@ files:
 - 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://cuboxsa.com