mixpanel 1.0.0 → 1.1.1

data/README.rdoc

@@ -28,6 +28,12 @@ If you want to use the asynchronous version of Mixpanel's javascript API
 
     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
@@ -51,6 +57,36 @@ To execute any javascript API call
   @mixpanel.append_api("register", {:some => "property"})
   @mixpanel.append_api("identify", "Unique Identifier")
 
+== 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
 
@@ -64,10 +100,15 @@ 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]
+* {jakemack}[https://github.com/jakemack]
+* {James Ferguson}[https://github.com/JamesFerguson]

data/Rakefile

@@ -1,9 +1,10 @@
-require 'spec/rake/spectask'
+require 'rubygems'
+require 'rspec/core/rake_task'
 
 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']
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["-c -fs"]
+  t.pattern = 'spec/**/*_spec.rb'
 end

data/lib/mixpanel/tracker/middleware.rb

@@ -7,7 +7,8 @@ module Mixpanel
         @app = app
         @token = mixpanel_token
         @options = {
-          :async => false
+          :async => false,
+          :insert_js_last => false
         }.merge(options)
       end
 
@@ -16,9 +17,11 @@ module Mixpanel
 
         @status, @headers, @response = @app.call(env)
 
-        update_response!
-        update_content_length!
-        delete_event_queue!
+        if is_trackable_response?
+          update_response!
+          update_content_length!
+          delete_event_queue!
+        end
 
         [@status, @headers, @response]
       end
@@ -28,7 +31,7 @@ module Mixpanel
       def update_response!
         @response.each do |part|
           if is_regular_request? && is_html_response?
-            insert_at = part.index('</head')
+            insert_at = part.index(@options[:insert_js_last] ? '</body' : '</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.
@@ -63,6 +66,10 @@ module Mixpanel
         @headers["Content-Type"].include?("text/javascript") if @headers.has_key?("Content-Type")
       end
 
+      def is_trackable_response?
+        is_html_response? || is_javascript_response?
+      end
+
       def render_mixpanel_scripts
         if @options[:async]
             <<-EOT

data/mixpanel.gemspec

@@ -2,12 +2,12 @@ files = ['README.rdoc', 'LICENSE', 'Rakefile', 'mixpanel.gemspec', '{spec,lib}/*
 
 spec = Gem::Specification.new do |s|
   s.name = "mixpanel"
-  s.version = "1.0.0"
+  s.version = "1.1.1"
   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"
   s.email = "zevarito@gmail.com"
-  s.homepage = "http://cuboxsa.com"
+  s.homepage = "http://github.com/zevarito/mixpanel"
   s.platform = Gem::Platform::RUBY
   s.summary = "Supports direct request api and javascript requests through a middleware."
   s.files = files
@@ -21,4 +21,7 @@ spec = Gem::Specification.new do |s|
   s.add_development_dependency 'rack-test'
   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 'ruby-debug' if RUBY_VERSION =~ /^1\.8/
 end

data/spec/mixpanel/tracker/middleware_spec.rb

@@ -29,13 +29,13 @@ describe Mixpanel::Tracker::Middleware 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
@@ -44,32 +44,46 @@ describe Mixpanel::Tracker::Middleware 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
+      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})
+          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 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 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 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 define Content-Length if not exist" do
-        last_response.headers.has_key?("Content-Length").should == true
+        it "should update Content-Length in headers" do
+          last_response.headers["Content-Length"].should_not == html_document.length.to_s
+        end
       end
 
-      it "should update Content-Length in headers" do
-        last_response.headers["Content-Length"].should_not == html_document.length.to_s
+      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})
+          get "/"
+        end
+
+        it "should append mixpanel scripts to end of body element" do
+          Nokogiri::HTML(last_response.body).search('head script').should be_empty
+          Nokogiri::HTML(last_response.body).search('body script').should_not be_empty
+        end
       end
     end
   end
@@ -89,13 +103,13 @@ describe Mixpanel::Tracker::Middleware 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
@@ -104,32 +118,46 @@ describe Mixpanel::Tracker::Middleware 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
+    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"}}, {:insert_js_last => false})
+          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
+
+      describe "With js last" do
+        before do
+          setup_rack_application(DummyApp, {:body => html_document, :headers => {"Content-Type" => "text/html"}}, {:insert_js_last => true})
+          get "/"
+        end
+
+        it "should append mixpanel scripts to end of body element" do
+          Nokogiri::HTML(last_response.body).search('head script').should be_empty
+          Nokogiri::HTML(last_response.body).search('body script').should_not be_empty
+        end
       end
     end
   end

data/spec/mixpanel/tracker_spec.rb

@@ -7,7 +7,7 @@ describe Mixpanel::Tracker do
 
   context "Initializing object" do
     it "should have an instance variable for token and events" do
-      @mixpanel.instance_variables.should include("@token", "@env")
+      @mixpanel.instance_variables.map(&:to_s).should include("@token", "@env")
     end
   end
 

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mixpanel
 version: !ruby/object:Gem::Version 
-  hash: 23
   prerelease: false
   segments: 
   - 1
-  - 0
-  - 0
-  version: 1.0.0
+  - 1
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Alvaro Gil
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-28 00:00:00 -03:00
+date: 2011-11-23 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,7 +38,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -54,7 +51,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -68,7 +64,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -82,7 +77,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -96,7 +90,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -110,12 +103,37 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         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"
+  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"
+  type: :development
+  version_requirements: *id009
 description: Simple lib to track events in Mixpanel service. It can be used in any rack based framework.
 email: zevarito@gmail.com
 executables: []
@@ -139,7 +157,7 @@ files:
 - lib/mixpanel/tracker.rb
 - lib/mixpanel.rb
 has_rdoc: true
-homepage: http://cuboxsa.com
+homepage: http://github.com/zevarito/mixpanel
 licenses: []
 
 post_install_message: 
@@ -152,7 +170,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -161,7 +178,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"