mixpanel 3.5.1 → 3.5.2

data/README.md

@@ -346,6 +346,12 @@ Occasionally you may need to send a request for HTML that you don't want the mid
   });
 ```
 
+Alternatively, you can add this line of code to your controller to temporarily disable the middleware:
+
+ ```ruby
+   Mixpanel::Middleware.skip_this_request
+ ```
+
 ## Examples
 
 ### How to use it from Rails controllers?
@@ -415,6 +421,61 @@ end
   end
 ```
 
+## How to track events using Delayed Job and Rails
+Below is an example of implementing async even tracking with Delayed Job
+
+**Create a new worker**
+```ruby
+class MixpanelWorker < Struct.new(:name, :properties, :request_env)
+  def perform
+      if defined?(MIXPANEL_TOKEN)
+        @mixpanel = Mixpanel::Tracker.new(MIXPANEL_TOKEN, { :env => request_env })
+      else
+        @mixpanel = DummyMixpanel.new
+      end
+
+      @mixpanel.track(name, properties)
+  end
+end
+```
+
+**Add the following to your Application controller**
+```ruby
+class ApplicationController < ActionController::Base
+  before_filter :initialize_env
+  
+  private
+  ##
+  # Initialize env for mixpanel
+  def initialize_env
+    # Similar to the Resque problem above, we need to help DJ serialize the 
+    # request object. 
+    @request_env = {
+      'REMOTE_ADDR' => request.env['REMOTE_ADDR'],
+      'HTTP_X_FORWARDED_FOR' => request.env['HTTP_X_FORWARDED_FOR'],
+      'rack.session' => request.env['rack.session'].to_hash,
+      'mixpanel_events' => request.env['mixpanel_events']
+    }
+  end
+```
+**You can optionally create a nice model wrapper to tidy things up**
+```ruby
+#app/models/mix_panel.rb
+class MixPanel
+  def self.track(name, properties, env)
+    # Notice we are using the 'mixpanel' queue
+		Delayed::Job.enqueue MixpanelWorker.new(name, properties, env), queue: 'mixpanel'
+	end
+end
+```
+**Sample Usage**
+```ruby
+MixPanel.track("Front Page Load", { 
+                url_type: short_url.uid_type, 
+                page_name: short_url.page.name, 
+                distinct_id: @client_uid }, @request_env)
+```
+
 ## Supported Ruby Platforms
 
 - 1.8.7
@@ -444,3 +505,6 @@ end
 * [Jon Pospischil] (https://github.com/pospischil)
 * [Tom Brown] (https://github.com/nottombrown)
 * [Murilo Pereira] (https://github.com/mpereira)
+* [Marko Vasiljevic] (https://github.com/marmarko)
+* [Joel] (https://github.com/jclay)
+* [adimichele] (https://github.com/adimichele)

data/lib/mixpanel/middleware.rb

@@ -3,6 +3,15 @@ require 'json'
 
 module Mixpanel
   class Middleware
+    class << self
+      attr_accessor :skip_request
+      def skip_this_request
+        @skip_request = true
+      end
+    end
+
+    @skip_request = false
+
     def initialize(app, mixpanel_token, options={})
       @app = app
       @token = mixpanel_token
@@ -18,14 +27,16 @@ module Mixpanel
       @env = env
 
       @status, @headers, @response = @app.call(env)
-      
-      if is_trackable_response?
+
+      if is_trackable_response? && !Mixpanel::Middleware.skip_request
         merge_queue! if @options[:persist]
         update_response!
         update_content_length!
         delete_event_queue!
       end
 
+      Mixpanel::Middleware.skip_request = false
+
       [@status, @headers, @response]
     end
 

data/lib/mixpanel/person.rb

@@ -7,6 +7,10 @@ module Mixpanel::Person
     engage :set, distinct_id, properties, options
   end
 
+  def unset(distinct_id, property, options={})
+    engage :unset, distinct_id, property, options
+  end
+
   def increment(distinct_id, properties={}, options={})
     engage :add, distinct_id, properties, options
   end
@@ -53,7 +57,12 @@ module Mixpanel::Person
 
     request_properties = person_request_properties(request_properties_or_distinct_id)
 
-    data = build_person action, request_properties, properties
+    if action == :unset
+      data = build_person_unset request_properties, properties
+    else
+      data = build_person action, request_properties, properties
+    end
+
     url = "#{options[:url]}?data=#{encoded_data(data)}"
     parse_response request(url, options[:async])
   end
@@ -70,4 +79,8 @@ module Mixpanel::Person
   def build_person(action, request_properties, person_properties)
     properties_hash(request_properties, PERSON_REQUEST_PROPERTIES).merge({ "$#{action}".to_sym => properties_hash(person_properties, PERSON_PROPERTIES) })
   end
+
+  def build_person_unset(request_properties, property)
+    properties_hash(request_properties, PERSON_REQUEST_PROPERTIES).merge({ "$unset".to_sym => [property] })
+  end
 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 = "3.5.1"
+  s.version = "3.5.2"
   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

@@ -47,6 +47,18 @@ describe Mixpanel::Middleware do
       get "/"
       Nokogiri::HTML(last_response.body).search('script').size.should == 1
     end
+
+    context "when disabling with #skip_this_request" do
+      before{ Mixpanel::Middleware.skip_this_request }
+
+      it "should skip this request but not the next request" do
+        get "/"
+        Nokogiri::HTML(last_response.body).search('script').should be_empty
+        get "/"
+        Nokogiri::HTML(last_response.body).search('script').size.should == 1
+      end
+
+    end
   end
     
   describe "Appending async mixpanel scripts" do

data/spec/mixpanel/tracker_spec.rb

@@ -71,6 +71,10 @@ describe Mixpanel::Tracker do
       it "should reset charges" do
         @mixpanel.reset_charges('person-a').should == true
       end
+
+      it "should unset property" do
+        @mixpanel.unset('person-a', 'property').should == true
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000Z
+date: 2013-02-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2152815840 !ruby/object:Gem::Requirement
+  requirement: &2153291720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152815840
+  version_requirements: *2153291720
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152815400 !ruby/object:Gem::Requirement
+  requirement: &2153291280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152815400
+  version_requirements: *2153291280
 - !ruby/object:Gem::Dependency
   name: escape
-  requirement: &2152814980 !ruby/object:Gem::Requirement
+  requirement: &2153290860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152814980
+  version_requirements: *2153290860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152814560 !ruby/object:Gem::Requirement
+  requirement: &2153290440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152814560
+  version_requirements: *2153290440
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152814140 !ruby/object:Gem::Requirement
+  requirement: &2153290020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152814140
+  version_requirements: *2153290020
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2152813720 !ruby/object:Gem::Requirement
+  requirement: &2153289600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152813720
+  version_requirements: *2153289600
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152813300 !ruby/object:Gem::Requirement
+  requirement: &2153289180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152813300
+  version_requirements: *2153289180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152812880 !ruby/object:Gem::Requirement
+  requirement: &2153288760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152812880
+  version_requirements: *2153288760
 description: Simple lib to track events in Mixpanel service. It can be used in any
   rack based framework.
 email: zevarito@gmail.com