mixpanel 2.0.2 → 2.1.0

data/README.md

@@ -67,6 +67,7 @@ Where **options** is a Hash that accepts the following keys:
 * **config** : a Hash
 
   *Default: {}*.
+
   You can also pass Mixpanel configuration details as seen here
   (https://mixpanel.com/docs/integration-libraries/javascript-full-api#set_config)
 
@@ -106,6 +107,10 @@ Where **options** is a Hash that accepts the following keys:
   once.
   *To enable persistence*, you must set it in both places, Middleware and when you initialize Mixpanel class.
 
+  *To enable import mode* you must set both :import => true and :api_key => YOUR_KEY (not to be confused with the project token.)
+  You can get more information about import mode here
+  (https://mixpanel.com/docs/api-documentation/importing-events-older-than-31-days)
+
 ### Track events directly.
 
 ```ruby
@@ -212,3 +217,4 @@ Use this instead:
 * [Jamie Quint](https://github.com/jamiequint)
 * [Ryan Schmukler](https://github.com/rschmukler)
 * [Travis Pew](https://github.com/travisp)
+* [Sylvain Niles](https://github.com/sylvainsf)

data/lib/mixpanel/tracker.rb

@@ -8,9 +8,11 @@ module Mixpanel
   class Tracker
     def initialize(token, env, options={})
       @token = token
+      @api_key = options.fetch(:api_key, "")
       @env = env
       @async = options.fetch(:async, false)
-      @url = options.fetch(:url, 'http://api.mixpanel.com/track/?data=')
+      @import = options.fetch(:import, false)
+      @url = @import ? 'http://api.mixpanel.com/import/?data' : options.fetch(:url, 'http://api.mixpanel.com/track/?data=')
       @persist = options.fetch(:persist, false)
 
       if @persist
@@ -116,7 +118,7 @@ module Mixpanel
 
     def request(params)
       data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
-      url = @url + data
+      url = @import ? @url + "=" + data + '&api_key=' + @api_key : @url + data
 
       if(@async)
         w = Tracker.worker

data/lib/mixpanel/tracker/middleware.rb

@@ -18,7 +18,7 @@ module Mixpanel
         @env = env
 
         @status, @headers, @response = @app.call(env)
-
+        
         if is_trackable_response?
           merge_queue! if @options[:persist]
           update_response!
@@ -71,6 +71,7 @@ module Mixpanel
 
       def is_trackable_response?
         return false if @status == 302
+        return false if @env.has_key?("HTTP_SKIP_MIXPANEL_MIDDLEWARE")
         is_html_response? || is_javascript_response?
       end
 

data/mixpanel.gemspec

@@ -2,7 +2,7 @@ files = ['README.md', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/
 
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "2.0.2"
+  s.version = "2.1.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/tracker/middleware_spec.rb

@@ -31,7 +31,23 @@ describe Mixpanel::Tracker::Middleware do
       last_response.body.should == html_document
     end
   end
-
+  
+  describe "Dummy app, handles skip requests properly" do
+    before do
+      setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}})
+    end
+    
+    it "should not append mixpanel scripts with skip request" do
+      get "/", {}, {"HTTP_SKIP_MIXPANEL_MIDDLEWARE" => true}
+      Nokogiri::HTML(last_response.body).search('script').should be_empty
+    end
+    
+    it "should append mixpanel scripts without skip request" do
+      get "/"
+      Nokogiri::HTML(last_response.body).search('script').size.should == 1
+    end
+  end
+    
   describe "Appending async mixpanel scripts" do
     describe "With ajax requests" do
       before do

data/spec/mixpanel/tracker_spec.rb

@@ -69,12 +69,12 @@ describe Mixpanel::Tracker 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")
@@ -84,32 +84,32 @@ describe Mixpanel::Tracker 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::Tracker.worker
       w.should == Mixpanel::Tracker.worker
     end
-    
+
     it "should be able to write lines to the worker" do
       w = Mixpanel::Tracker.worker
-      
+
       #On most systems this will exceed the pipe buffer size
       8.times do
-        9000.times do 
+        9000.times do
           w.write("\n")
         end
         sleep 0.1
       end
     end
-    
+
     it "should dispose of a worker" do
       w = Mixpanel::Tracker.worker
       Mixpanel::Tracker.dispose_worker(w)
@@ -119,4 +119,11 @@ describe Mixpanel::Tracker do
       w2.should_not == w
     end
   end
+
+  context "Import mode" do
+    it "should use the import URL" do
+      @mixpanel = Mixpanel::Tracker.new(MIX_PANEL_TOKEN, @env = {"REMOTE_ADDR" => "127.0.0.1"}, { :import => true, :api_key => "ABCDEFG" })
+      @mixpanel.inspect.to_s.include?("import/?data").should == true
+    end
+  end
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 2
+  - 1
   - 0
-  - 2
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Alvaro Gil
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-10 00:00:00 -03:00
+date: 2012-09-17 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency