mixpanel 1.1.3 → 2.0.0

data/README.md

@@ -0,0 +1,213 @@
+[![Build Status](https://secure.travis-ci.org/zevarito/mixpanel.png)](http://travis-ci.org/zevarito/mixpanel)
+
+## Table of Contents
+
+- [What is Mixpanel] (#what-is-mixpanel)
+- [What does this Gem do?] (#what-does-this-gem-do)
+- [Install] (#install)
+  - [Rack Middleware] (#rack-middleware) 
+- [Usage] (#usage)
+  - [Initialize Mixpanel class] (#initialize-mixpanel-class) 
+- [Examples] (#examples)
+ - [How to use it from Rails controllers] (#how-to-use-it-from-rails-controllers)
+ - [How to track events using Resque and Rails] (#how-to-track-events-using-resque-and-rails)
+- [Supported Platforms] (#supported-platforms)
+- [Deprecation Notes] (#deprecation-notes)
+- [Collaborators and Maintainers] (#collaborators-and-maintainers)
+
+## What is Mixpanel
+
+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.
+
+## Install
+
+```ruby
+  gem install mixpanel
+```
+
+### Rack Middleware
+
+*Only need if you want to track events from Javascript.*
+
+If you are using Rails you can add this to your specific environment configuration file (located in config/environments/) or create a new
+initializer for it:
+
+```ruby
+  config.middleware.use "Mixpanel::Tracker::Middleware", "YOUR_MIXPANEL_API_TOKEN", options
+```
+
+Where **options** is a Hash that accepts the following keys:
+
+* **insert_js_last** : true | false
+
+  *Default: false*.
+  By default the scripts are inserted into the head of the html response. If you'd prefer the scripts to run after
+  all rendering has completed you can set the insert_js_last flag and they'll be added at the end of the body tag.
+  This will work whether or not you opt for the aynchronous version of the API. However, when inserting js into an
+  ajax response it will have no effect.
+
+* **persist** : true | false
+
+  *Default: false*.
+  If you would like, the Mixpanel gem may be configured to store its queue in a Rack session. This allows events
+  to be stored through redirects, helpful if you sign in and redirect but want to associate an event with that
+  action. The mixpanel gem will also remove duplicate events from your queue for information that should only be
+  trasmitted to the API once, such as `mixpanel.identify`, `mixpanel.name_tag`, `mixpanel.people.set`, and
+  `mixpanel.register`.
+  This allows you to use a before filter to set these variables, redirect, and still have them only transmitted
+  once.
+  *To enable persistence*, you must set it in both places, Middleware and when you initialize Mixpanel class.
+
+* **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)
+
+## Usage
+
+### Initialize Mixpanel class
+
+```ruby
+  @mixpanel = Mixpanel::Tracker.new("YOUR_MIXPANEL_API_TOKEN", request.env, true, options)
+```
+Where **options** is a Hash that accepts the following keys:
+
+* **async** : true | false
+  
+  *Default: false*.
+  Built in async feature. 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.
+  If you like for a more robust async behavior take a look at Resque example.
+
+* **url** : String
+ 
+  *Default: http://api.mixpanel.com/track/?data=*.
+  If you are proxying Mixpanel API requests then you can set a custom url and additionally stop the token from
+  being sent by marking it as false if you're going to let the proxy add it.
+  Example: { url: "http://localhost:8000/mixpanelproxy?data=" }.
+
+* **persist** : true | false
+
+  *Default: false*.
+  If you would like, the Mixpanel gem may be configured to store its queue in a Rack session. This allows events
+  to be stored through redirects, helpful if you sign in and redirect but want to associate an event with that
+  action. The mixpanel gem will also remove duplicate events from your queue for information that should only be
+  trasmitted to the API once, such as `mixpanel.identify`, `mixpanel.name_tag`, `mixpanel.people.set`, and
+  `mixpanel.register`.
+  This allows you to use a before filter to set these variables, redirect, and still have them only transmitted
+  once.
+  *To enable persistence*, you must set it in both places, Middleware and when you initialize Mixpanel class.
+
+### Track events directly.
+
+```ruby
+  @mixpanel.track_event("Sign in", {:some => "property"})
+```
+
+### Append events to be tracked with Javascript.
+
+*Note*: You should setup the [Rack Middleware](#rack-middleware).
+
+```ruby
+  @mixpanel.append_event("Sign in", {:some => "property"})
+```
+
+### Execute Javascript API call
+
+*Note*: You should setup the [Rack Middleware](#rack-middleware).
+
+```ruby
+  @mixpanel.append_api("register", {:some => "property"})
+  @mixpanel.append_api("identify", "Unique Identifier")
+```
+
+## Examples
+
+### How to use it from Rails controllers?
+  
+In your ApplicationController class add a method to instantiate mixpanel.
+
+```ruby
+  before_filter :initialize_mixpanel
+
+  def initialize_mixpanel
+    @mixpanel = Mixpanel::Tracker.new("YOUR_MIXPANEL_API_TOKEN", request.env, options)
+  end
+```
+## How to track events using Resque and Rails
+
+If you don't want to use the built in Mixpanel Gem async feature bellow there is an example about how to make
+async calls using Resque.
+
+[Resque is a Redis-backed Ruby library for creating background jobs](https://github.com/defunkt/resque)
+
+```ruby
+    class MixpanelTrackEventJob
+      @queue = :slow
+
+      def mixpanel(request_env)
+        Mixpanel::Tracker.new(MIXPANEL_TOKEN, request_env)
+      end
+
+      def perform(name, params, request_env)
+        mixpanel(request_env).track_event(name, params)
+      end
+    end
+```
+
+```ruby
+    class UsersController < ApplicationController
+      def create
+        @user = User.new(params[:user])
+
+        if @user.save
+          MixpanelTrackEventJob.enqueue("Sign up", {:invited => params[:invited]}, request.env)
+          redirect_to user_root_path
+        else
+          render :new
+        end
+     end
+   end
+```
+
+## Supported Platforms
+
+- 1.8.7
+- 1.9.2
+- 1.9.3
+- JRuby 1.8 Mode
+
+## Deprecation Notes
+
+This way to initialize Mixpanel gem is not longer allowed. 
+
+```ruby
+  Mixpanel.new
+```
+
+Use this instead:
+
+```ruby
+  Mixpanel::Tracker.new
+```
+
+## 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)
+* [jakemack](https://github.com/jakemack)
+* [James Ferguson](https://github.com/JamesFerguson)
+* [Brad Wilson](https://github.com/bradx3)
+* [Mark Cheverton](https://github.com/ennui2342)
+* [Jamie Quint](https://github.com/jamiequint)
+* [Ryan Schmukler](https://github.com/rschmukler)

data/lib/mixpanel.rb

@@ -1,8 +1,4 @@
 require 'mixpanel/tracker'
 
 module Mixpanel
-  def self.new(token, env, async = false)
-    Kernel.warn("DEPRECATED: Use Mixpanel::Tracker.new instead")
-    Mixpanel::Tracker.new(token, env, async)
-  end
 end

data/lib/mixpanel/tracker.rb

@@ -6,18 +6,41 @@ require 'mixpanel/tracker/middleware'
 
 module Mixpanel
   class Tracker
-    def initialize(token, env, async = false, url = 'http://api.mixpanel.com/track/?data=')
+    def initialize(token, env, options={})
       @token = token
       @env = env
-      @async = async
-      @url = url
-      clear_queue
+      @async = options.fetch(:async, false)
+      @url = options.fetch(:url, 'http://api.mixpanel.com/track/?data=')
+      @persist = options.fetch(:persist, false)
+
+      if @persist
+        @env["rack.session"]["mixpanel_events"] ||= []
+      else
+        clear_queue
+      end
     end
 
     def append_event(event, properties = {})
       append_api('track', event, properties)
     end
 
+    def append_person_event(properties = {})
+      # evaluate symbols and rewrite
+      special_properties = %w{email created first_name last_name last_login username country_code}
+      special_properties.each do |key|
+        symbolized_key = key.to_sym
+        if properties.has_key?(symbolized_key)
+          properties["$#{key}"] = properties[symbolized_key]
+          properties.delete(symbolized_key)
+        end
+      end
+      append_api('people.set', properties)
+    end
+
+    def append_person_increment_event(property, increment=1)
+      append_api('people.increment', property, increment)
+    end
+
     def append_api(type, *args)
       queue << [type, args.map {|arg| arg.to_json}]
     end
@@ -41,11 +64,19 @@ module Mixpanel
     end
 
     def queue
-      @env["mixpanel_events"]
+      if @persist
+        return @env["rack.session"]["mixpanel_events"]
+      else
+        return @env["mixpanel_events"]
+      end
     end
 
     def clear_queue
-      @env["mixpanel_events"] = []
+      if @persist
+        @env["rack.session"]["mixpanel_events"] = []
+      else
+        @env["mixpanel_events"] = []
+      end
     end
 
     class <<self

data/lib/mixpanel/tracker/middleware.rb

@@ -1,4 +1,5 @@
 require 'rack'
+require 'json'
 
 module Mixpanel
   class Tracker
@@ -7,8 +8,9 @@ module Mixpanel
         @app = app
         @token = mixpanel_token
         @options = {
-          :async => false,
-          :insert_js_last => false
+          :insert_js_last => false,
+          :persist => false,
+          :config => {}
         }.merge(options)
       end
 
@@ -18,6 +20,7 @@ module Mixpanel
         @status, @headers, @response = @app.call(env)
 
         if is_trackable_response?
+          merge_queue! if @options[:persist]
           update_response!
           update_content_length!
           delete_event_queue!
@@ -67,56 +70,69 @@ module Mixpanel
       end
 
       def is_trackable_response?
+        return false if @status == 302
         is_html_response? || is_javascript_response?
       end
 
       def render_mixpanel_scripts
-        if @options[:async]
-            <<-EOT
-          <script type='text/javascript'>
-            var mpq = [];
-            mpq.push(["init", "#{@token}"]);
-            (function(){var b,a,e,d,c;b=document.createElement("script");b.type="text/javascript";b.async=true;b.src=(document.location.protocol==="https:"?"https:":"http:")+"//api.mixpanel.com/site_media/js/api/mixpanel.js";a=document.getElementsByTagName("script")[0];a.parentNode.insertBefore(b,a);e=function(f){return function(){mpq.push([f].concat(Array.prototype.slice.call(arguments,0)))}};d=["track","track_links","track_forms","register","register_once","identify","name_tag","set_config"];for(c=0;c<d.length;c++){mpq[d[c]]=e(d[c])}})();
+        <<-EOT
+          <!-- start Mixpanel -->
+          <script type="text/javascript">
+            (function(c,a){var b,d,h,e;b=c.createElement("script");b.type="text/javascript";
+            b.async=!0;b.src=("https:"===c.location.protocol?"https:":"http:")+
+            '//api.mixpanel.com/site_media/js/api/mixpanel.2.js';d=c.getElementsByTagName("script")[0];
+            d.parentNode.insertBefore(b,d);a._i=[];a.init=function(b,c,f){function d(a,b){
+            var c=b.split(".");2==c.length&&(a=a[c[0]],b=c[1]);a[b]=function(){a.push([b].concat(
+            Array.prototype.slice.call(arguments,0)))}}var g=a;"undefined"!==typeof f?g=a[f]=[]:
+            f="mixpanel";g.people=g.people||[];h=['disable','track','track_pageview','track_links',
+            'track_forms','register','register_once','unregister','identify','name_tag',
+            'set_config','people.set','people.increment'];for(e=0;e<h.length;e++)d(g,h[e]);
+            a._i.push([b,c,f])};a.__SV=1.1;window.mixpanel=a})(document,window.mixpanel||[]);
+
+            mixpanel.init("#{@token}");
+            mixpanel.set_config(#{@options[:config].to_json});
           </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 Mixpanel -->
+        EOT
       end
 
       def delete_event_queue!
-        @env.delete('mixpanel_events')
+        if @options[:persist]
+          (@env['rack.session']).delete('mixpanel_events')
+        else
+          @env.delete('mixpanel_events')
+        end
       end
 
       def queue
-        return [] if !@env.has_key?('mixpanel_events') || @env['mixpanel_events'].empty?
-        @env['mixpanel_events']
+        if @options[:persist]
+          return [] if !(@env['rack.session']).has_key?('mixpanel_events') || @env['rack.session']['mixpanel_events'].empty?
+          @env['rack.session']['mixpanel_events']
+        else
+          return [] if !@env.has_key?('mixpanel_events') || @env['mixpanel_events'].empty?
+          @env['mixpanel_events']
+        end
+      end
+
+      def merge_queue!
+        present_hash = {}
+        special_events = ['identify', 'name_tag', 'people.set', 'register']
+        queue.uniq!
+
+        queue.reverse_each do |item|
+          is_special = special_events.include?(item[0])
+          if present_hash[item[0]] and is_special
+            queue.delete(item)
+          else
+            present_hash[item[0]] = true if is_special
+          end
+        end
       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 = queue.map {|type, arguments| %(mixpanel.#{type}(#{arguments.join(', ')});) }.join("\n")
         output = "try {#{output}} catch(err) {}"
 
         include_script_tag ? "<script type='text/javascript'>#{output}</script>" : output

data/mixpanel.gemspec

@@ -1,8 +1,8 @@
-files = ['README.rdoc', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/*'].map {|f| Dir[f]}.flatten
+files = ['README.md', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/**/*'].map {|f| Dir[f]}.flatten
 
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "1.1.3"
+  s.version = "2.0.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"
@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.files = files
   s.require_path = "lib"
   s.has_rdoc = false
-  s.extra_rdoc_files = ["README.rdoc"]
+  s.extra_rdoc_files = ["README.md"]
   s.add_dependency 'json'
   s.add_dependency 'rack'
   s.add_dependency 'escape'
@@ -22,6 +22,7 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'fakeweb'
   s.add_development_dependency 'nokogiri'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'ruby-debug19' if RUBY_VERSION =~ /^1\.9/
+  s.add_development_dependency 'debugger' if RUBY_VERSION =~ /^1\.9\.3/
+  s.add_development_dependency 'ruby-debug19' if RUBY_VERSION =~ /^1\.9\.2/
   s.add_development_dependency 'ruby-debug' if RUBY_VERSION =~ /^1\.8/
 end

data/spec/mixpanel/mixpanel_spec.rb

@@ -2,9 +2,10 @@ require 'spec_helper'
 
 describe Mixpanel do
   context "Deprecated initialization mode" do
-    it "should instantiate the object as it was doing before but drop a deprecation warning" do
-      mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, @env = {"REMOTE_ADDR" => "127.0.0.1"})
-      mixpanel.should be_kind_of(Mixpanel::Tracker)
+    it "should not allow to initialize the class as the old way" do
+      lambda do
+        mixpanel = Mixpanel.new(MIX_PANEL_TOKEN, @env = {"REMOTE_ADDR" => "127.0.0.1"})
+      end.should raise_error(NoMethodError)
     end
   end
 end

data/spec/mixpanel/tracker/middleware_spec.rb

@@ -1,5 +1,23 @@
 require 'spec_helper'
 
+def exec_default_appends_on(mixpanel)
+  mixpanel.append_event("Visit", {:article => 1})
+  mixpanel.append_event("Sign in")
+  mixpanel.append_person_event(:first_name => "foo", :last_name => "bar", :username => "foobar")
+  mixpanel.append_person_increment_event(:sign_in_rate)
+end
+
+def check_for_default_appends_on(txt)
+  txt.should =~ /mixpanel\.track\("Visit",\s?\{"article":1\}\)/
+  txt.should =~ /mixpanel\.track\("Sign in",\s?\{\}\)/
+  txt.should =~ /mixpanel\.people\.set\(.*\);\nmixpanel.people.increment\(\"sign_in_rate\",\s?1\);/
+  match = txt.match(/mixpanel\.people\.set\((.*\));/)
+  match[1].should =~ /\"\$first_name\":\"foo\"/
+  match[1].should =~ /\"\$username\":\"foobar\"/
+  match[1].should =~ /\"\$last_name\":\"bar\"/
+  txt.should =~ /mixpanel\.people\.increment\(\"sign_in_rate\"\s?,\s?1\)/
+end
+
 describe Mixpanel::Tracker::Middleware do
   include Rack::Test::Methods
 
@@ -17,7 +35,7 @@ describe Mixpanel::Tracker::Middleware do
   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})
+        setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}})
         get "/", {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
       end
 
@@ -32,7 +50,7 @@ describe Mixpanel::Tracker::Middleware do
 
     describe "With large ajax response" do
       before do
-        setup_rack_application(DummyApp, {:body => large_script, :headers => {"Content-Type" => "text/html"}}, {:async => true})
+        setup_rack_application(DummyApp, {:body => large_script, :headers => {"Content-Type" => "text/html"}})
         get "/", {}, {"HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
       end
 
@@ -48,7 +66,7 @@ describe Mixpanel::Tracker::Middleware do
     describe "With regular requests" do
       describe "With js in head" do
         before do
-          setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:async => true, :insert_js_last => false})
+          setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:insert_js_last => false})
           get "/"
         end
 
@@ -62,7 +80,7 @@ describe Mixpanel::Tracker::Middleware do
         end
 
         it "should use the specified token instantiating mixpanel lib" do
-          last_response.should =~ /mpq.push\(\["init", "#{MIX_PANEL_TOKEN}"\]\)/
+          last_response.body.should =~ /mixpanel\.init\("#{MIX_PANEL_TOKEN}"\)/
         end
 
         it "should define Content-Length if not exist" do
@@ -76,7 +94,7 @@ describe Mixpanel::Tracker::Middleware do
 
       describe "With js last" do
         before do
-          setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:async => true, :insert_js_last => true})
+          setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:insert_js_last => true})
           get "/"
         end
 
@@ -131,12 +149,12 @@ describe Mixpanel::Tracker::Middleware do
           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
+        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 =~ /new MixpanelLib\('#{MIX_PANEL_TOKEN}'\)/
+          last_response.body.should =~ /mixpanel\.init\("#{MIX_PANEL_TOKEN}"\)/
         end
 
         it "should define Content-Length if not exist" do
@@ -165,13 +183,12 @@ describe Mixpanel::Tracker::Middleware do
   describe "Tracking async appended events" do
     before do
       @mixpanel = Mixpanel::Tracker.new(MIX_PANEL_TOKEN, {})
-      @mixpanel.append_event("Visit", {:article => 1})
-      @mixpanel.append_event("Sign in")
+      exec_default_appends_on @mixpanel
     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})
+        setup_rack_application(DummyApp, {:body => "<p>response</p>", :headers => {"Content-Type" => "text/html"}})
 
         get "/", {}, {"mixpanel_events" => @mixpanel.queue, "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
       end
@@ -182,9 +199,7 @@ describe Mixpanel::Tracker::Middleware do
 
       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?\{\}\]\)/
+        check_for_default_appends_on script.inner_html
       end
 
       it "should delete events queue after use it" do
@@ -194,7 +209,7 @@ describe Mixpanel::Tracker::Middleware do
 
     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})
+        setup_rack_application(DummyApp, {:body => "alert('response')", :headers => {"Content-Type" => "text/javascript"}})
         get "/", {}, {"mixpanel_events" => @mixpanel.queue, "HTTP_X_REQUESTED_WITH" => "XMLHttpRequest"}
       end
 
@@ -204,8 +219,7 @@ describe Mixpanel::Tracker::Middleware do
 
       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?\{\}\]\)/
+        check_for_default_appends_on script
       end
 
       it "should delete events queue after use it" do
@@ -215,7 +229,7 @@ describe Mixpanel::Tracker::Middleware do
 
     describe "With regular requests" do
       before do
-        setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:async => true})
+        setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}})
 
         get "/", {}, {"mixpanel_events" => @mixpanel.queue}
       end
@@ -225,8 +239,7 @@ describe Mixpanel::Tracker::Middleware do
       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?\{\}\]\)/
+        check_for_default_appends_on last_response.body
       end
 
       it "should delete events queue after use it" do
@@ -238,8 +251,7 @@ describe Mixpanel::Tracker::Middleware do
   describe "Tracking appended events" do
     before do
       @mixpanel = Mixpanel::Tracker.new(MIX_PANEL_TOKEN, {})
-      @mixpanel.append_event("Visit", {:article => 1})
-      @mixpanel.append_event("Sign in")
+      exec_default_appends_on @mixpanel
     end
 
     describe "With ajax requests and text/html response" do
@@ -255,9 +267,7 @@ describe Mixpanel::Tracker::Middleware do
 
       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?\{\}\)/
+        check_for_default_appends_on script.inner_html
       end
 
       it "should delete events queue after use it" do
@@ -277,8 +287,7 @@ describe Mixpanel::Tracker::Middleware do
 
       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?\{\}\)/
+        check_for_default_appends_on script
       end
 
       it "should delete events queue after use it" do
@@ -293,13 +302,12 @@ describe Mixpanel::Tracker::Middleware do
         get "/", {}, {"mixpanel_events" => @mixpanel.queue}
       end
 
-      it "should render 3 script tags" do
-        Nokogiri::HTML(last_response.body).search('script').size.should == 3
+      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 =~ /mpmetrics\.track\("Visit",\s?\{"article":1\}\)/
-        last_response.body.should =~ /mpmetrics\.track\("Sign in",\s?\{\}\)/
+        check_for_default_appends_on last_response.body
       end
 
       it "should delete events queue after use it" do

metadata

@@ -1,149 +1,169 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mixpanel
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 3
-  version: 1.1.3
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Alvaro Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-11 00:00:00 -02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: escape
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: fakeweb
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug19
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-description: Simple lib to track events in Mixpanel service. It can be used in any rack based framework.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple lib to track events in Mixpanel service. It can be used in any
+  rack based framework.
 email: zevarito@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- README.rdoc
+extra_rdoc_files:
+- README.md
+files:
+- README.md
 - LICENSE
 - Rakefile
 - mixpanel.gemspec
@@ -156,37 +176,28 @@ files:
 - lib/mixpanel/tracker/subprocess.rb
 - lib/mixpanel/tracker.rb
 - lib/mixpanel.rb
-has_rdoc: true
 homepage: http://github.com/zevarito/mixpanel
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mixpanel
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Supports direct request api and javascript requests through a middleware.
 test_files: []
-

data/README.rdoc

@@ -1,120 +0,0 @@
-== 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 "Mixpanel::Tracker::Middleware", "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 "Mixpanel::Tracker::Middleware", "YOUR_MIXPANEL_API_TOKEN", :async => true
-
-By default the scripts are inserted into the head of the html response. If you'd prefer the scripts to run after all rendering has completed you can set the insert_js_last flag and they'll be added at the end of the body tag. This will work whether or not you opt for the aynchronous version of the API. However, when inserting js into an ajax response it will have no effect:
-
-  Rails::Initializer.run do |config|
-
-    config.middleware.use "Mixpanel::Tracker::Middleware", "YOUR_MIXPANEL_API_TOKEN", :async => true, :insert_js_last => true
-
-In your application_controller class add a method to instance mixpanel.
-
-  before_filter :initialize_mixpanel
-
-  def initialize_mixpanel
-    @mixpanel = Mixpanel::Tracker.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")
-
-If you are proxying Mixpanel API requests then you can set a custom url and additionally stop the token from being sent by marking it as false if you're going to let the proxy add it...
-
-  @mixpanel = Mixpanel::Tracker.new(flase, request.env, true, 'http://localhost:8000/mixpanelproxy?data=')
-
-== Resque and Rails example
-
-If you don't want to use the built in Mixpanel Gem async feature bellow there is an example about how to make async calls using Resque.
-
-{Resque is a Redis-backed Ruby library for creating background jobs}[https://github.com/defunkt/resque]
-
-    class MixpanelTrackEventJob
-      @queue = :slow
-
-      def mixpanel(request_env)
-        Mixpanel.new(MIXPANEL_TOKEN, request_env)
-      end
-
-      def perform(name, params, request_env)
-        mixpanel(request_env).track_event(name, params)
-      end
-    end
-
-    class UsersController < ApplicationController
-      def create
-        @user = User.new(params[:user])
-
-        if @user.save
-          MixpanelTrackEventJob.enqueue("Sign up", {:invited => params[:invited]}, request.env)
-          redirect_to user_root_path
-        else
-          render :new
-        end
-     end
-   end
-
-== 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.  
-
-== Deprecation Notes
-
-For a short term this method will be accepted but it will be deprecated soon.
-
-  Mixpanel.new
-
-== Collaborations
-
-All collaborations are welcome to this project, please fork and make a pull request.
-
-== 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]
-* {jakemack}[https://github.com/jakemack]
-* {James Ferguson}[https://github.com/JamesFerguson]
-* {Brad Wilson}[https://github.com/bradx3]
-* {Mark Cheverton}[https://github.com/ennui2342]