mixpanel 4.0.2 → 4.0.3

data/README.md

@@ -12,6 +12,7 @@
   - [Initialize Mixpanel] (#initialize-mixpanel)
     - [Track Events Directly](#track-events-directly)
     - [Pixel Based Event Tracking](#pixel-based-event-tracking)
+    - [Redirect Based Event Tracking](#redirect-based-event-tracking)
     - [Import Events](#import-events)
     - [Set Person Attributes Directly](#set-person-attributes-directly)
     - [Increment Person Attributes Directly](#increment-person-attributes-directly)
@@ -193,6 +194,12 @@ it will automatically be converted to the correct form (e.g., `{ :os => 'Mac' }`
 
   This can be used to proxy Mixpanel API requests.
 
+* **test**: boolean
+
+  *Default: false*
+
+  Send data to a high priority rate limited queue to make testing easier
+
 Example:
 
 ```ruby
@@ -222,7 +229,13 @@ image_tag @mixpanel.tracking_pixel("Opened Email", { :distinct_id => "bob@email.
 
 Mixpanel docs: https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking
 
+### Redirect Based Event Tracking
+
+```ruby
+@mixpanel.redirect_url "Opened Email", 'http://www.example.com/' { :distinct_id => "bob@email.com", :campaign => "Retarget" }
+```
 
+This allows to track events just when a user clicks a link. It's usually useful for tracking opened emails.
 
 ### Import Events
 
@@ -533,3 +546,4 @@ MixPanel.track("Front Page Load", {
 * [Marko Vasiljevic] (https://github.com/marmarko)
 * [Joel] (https://github.com/jclay)
 * [adimichele] (https://github.com/adimichele)
+* [Francis Gulotta] (https://github.com/reconbot)

data/lib/mixpanel/event.rb

@@ -11,6 +11,10 @@ module Mixpanel::Event
     build_url event, properties, options.merge(:url => TRACK_URL, :img => true)
   end
 
+  def redirect_url(event, redirect, properties={}, options={})
+    build_url event, properties, options.merge(:url => TRACK_URL, :redirect => CGI::escape(redirect))
+  end
+
   def import(event, properties={}, options={})
     track_event event, properties, options, IMPORT_URL
   end
@@ -52,6 +56,8 @@ module Mixpanel::Event
     url = "#{options[:url]}?data=#{encoded_data(data)}"
     url << "&api_key=#{options[:api_key]}" if options.fetch(:api_key, nil)
     url << "&img=1" if options[:img]
+    url << "&test=1" if options[:test]
+    url << "&redirect=#{options[:redirect]}" if options[:redirect]
     url
   end
 end

data/lib/mixpanel/middleware.rb

@@ -89,7 +89,7 @@ module Mixpanel
     end
 
     def is_trackable_response?
-      return false if @status == 302
+      return false if (300..399).include?(@status.to_i)
       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 = "4.0.2"
+  s.version = "4.0.3"
   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/middleware_spec.rb

@@ -48,6 +48,12 @@ describe Mixpanel::Middleware do
       Nokogiri::HTML(last_response.body).search('script').size.should == 1
     end
 
+    it "should skip requests in the 3xx range" do
+      setup_rack_application(DummyApp, :body => html_document, :headers => {"Content-Type" => "text/html"}, :status => 350)
+      get "/"
+      Nokogiri::HTML(last_response.body).search('script').should be_empty
+    end
+
     context "when disabling with #skip_this_request" do
       before{ Mixpanel::Middleware.skip_this_request }
 

data/spec/mixpanel/tracker_spec.rb

@@ -41,6 +41,20 @@ describe Mixpanel::Tracker do
       end
     end
 
+    context "Redirect url" do
+      let(:url) { "http://example.com?foo=bar&bar=foo" }
+
+      it "should return a URL" do
+        @mixpanel.redirect_url("Click Email", url).should be_a(String)
+      end
+
+      it "should include a redirect" do
+        encoded_url = CGI::escape(url)
+        @mixpanel.redirect_url("Click Email", url).should include('&redirect=' + encoded_url)
+      end
+
+    end
+
     context "Importing events" do
       it "should import simple events" do
         @mixpanel.import('Sign up').should == true

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require File.join(File.dirname(__FILE__), "../lib", "mixpanel")
 require 'rack/test'
 require 'fakeweb'
 require 'nokogiri'
+require 'cgi'
 
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000Z
+date: 2013-08-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2153678160 !ruby/object:Gem::Requirement
+  requirement: &2153703060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153678160
+  version_requirements: *2153703060
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2153677720 !ruby/object:Gem::Requirement
+  requirement: &2153702620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153677720
+  version_requirements: *2153702620
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &2153677300 !ruby/object:Gem::Requirement
+  requirement: &2153702200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153677300
+  version_requirements: *2153702200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153676880 !ruby/object:Gem::Requirement
+  requirement: &2153701780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153676880
+  version_requirements: *2153701780
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2153676460 !ruby/object:Gem::Requirement
+  requirement: &2153701360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153676460
+  version_requirements: *2153701360
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2153676040 !ruby/object:Gem::Requirement
+  requirement: &2153700940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153676040
+  version_requirements: *2153700940
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2153675620 !ruby/object:Gem::Requirement
+  requirement: &2153700520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153675620
+  version_requirements: *2153700520
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2153701540 !ruby/object:Gem::Requirement
+  requirement: &2153700100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153701540
+  version_requirements: *2153700100
 description: Simple lib to track events in Mixpanel service. It can be used in any
   rack based framework.
 email: zevarito@gmail.com