mixpanel 2.1.0 → 2.2.0

data/README.md

@@ -90,10 +90,10 @@ Where **options** is a Hash that accepts the following keys:
 
 * **url** : String
  
-  *Default: http://api.mixpanel.com/track/?data=*.
+  *Default: http://api.mixpanel.com*.
   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=" }.
+  Example: { url: "http://localhost:8000/mixpanelproxy" }.
 
 * **persist** : true | false
 
@@ -117,6 +117,13 @@ Where **options** is a Hash that accepts the following keys:
   @mixpanel.track_event("Sign in", {:some => "property"})
 ```
 
+### Interface with People management directly
+
+```ruby
+  @mixpanel.engage_set(@user.id, {:username => @user.username, :email => @user.email})
+  @mixpanel.engage_add(@user.id, {:monkeys_punched => 12})
+```
+
 ### Append events to be tracked with Javascript.
 
 *Note*: You should setup the [Rack Middleware](#rack-middleware).
@@ -134,6 +141,20 @@ Where **options** is a Hash that accepts the following keys:
   @mixpanel.append_api("identify", "Unique Identifier")
 ```
 
+### Prevent middleware from inserting code
+*Note*: Only applies when [Rack Middleware](#rack-middleware) is setup.
+
+Occasionally you may need to send a request for HTML that you don't want the middleware to alter. In your AJAX request include the header "SKIP_MIXPANEL_MIDDLEWARE" to prevent the mixpanel code from being inserted.
+
+```javascript
+$.ajax("/path/to/api/endpoint", {
+	headers: {"SKIP_MIXPANEL_MIDDLEWARE": true},
+	success: function(data) {
+		// Process data here
+	}
+});
+```
+
 ## Examples
 
 ### How to use it from Rails controllers?
@@ -218,3 +239,4 @@ Use this instead:
 * [Ryan Schmukler](https://github.com/rschmukler)
 * [Travis Pew](https://github.com/travisp)
 * [Sylvain Niles](https://github.com/sylvainsf)
+* [GBH](https://github.com/GBH)

data/lib/mixpanel/tracker.rb

@@ -6,14 +6,22 @@ require 'mixpanel/tracker/middleware'
 
 module Mixpanel
   class Tracker
-    def initialize(token, env, options={})
-      @token = token
-      @api_key = options.fetch(:api_key, "")
-      @env = env
-      @async = options.fetch(:async, false)
-      @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)
+    
+    MIXPANEL_API_URL  = 'http://api.mixpanel.com'.freeze
+    TRACK_ENDPOINT    = '/track/?data='.freeze
+    ENGAGE_ENDPOINT   = '/engage/?data='.freeze
+    IMPORT_ENDPOINT   = '/import/?data='.freeze
+    
+    PERSON_PROPERTIES = %w(email first_name last_name created last_login username country_code).freeze
+    
+    def initialize(token, env, options = {})
+      @token    = token
+      @api_key  = options.fetch(:api_key, "")
+      @env      = env
+      @async    = options.fetch(:async, false)
+      @import   = options.fetch(:import, false)
+      @url      = options.fetch(:url, MIXPANEL_API_URL)
+      @persist  = options.fetch(:persist, false)
 
       if @persist
         @env["rack.session"]["mixpanel_events"] ||= []
@@ -27,16 +35,7 @@ module Mixpanel
     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)
+      append_api('people.set', person_properties(properties))
     end
 
     def append_person_increment_event(property, increment=1)
@@ -50,11 +49,29 @@ module Mixpanel
     def track_event(event, properties = {})
       options = { :time => Time.now.utc.to_i, :ip => ip }
       options.merge!( :token => @token ) if @token
-      options.merge!(properties)
-      params = build_event(event, options)
-      parse_response request(params)
+      parse_response request(:track,
+        :event      => event,
+        :properties => options.merge(properties)
+      )
     end
-
+    
+    def engage(action, distinct_id, properties = {})
+      options = { }
+      options.merge!( :$token => @token ) if @token
+      parse_response request(:engage, options.merge(
+        :$distinct_id       => distinct_id, 
+        "$#{action}".to_sym => person_properties(properties)
+      ))
+    end
+    
+    def engage_set(distinct_id, properties = {})
+      engage(:set, distinct_id, properties)
+    end
+    
+    def engage_add(distinct_id, properties = {})
+      engage(:add, distinct_id, properties)
+    end
+    
     def ip
       if @env.has_key?("HTTP_X_FORWARDED_FOR")
         @env["HTTP_X_FORWARDED_FOR"].split(",").last
@@ -81,7 +98,7 @@ module Mixpanel
       end
     end
 
-    class <<self
+    class << self
       WORKER_MUTEX = Mutex.new
 
       def worker
@@ -111,15 +128,34 @@ module Mixpanel
     end
 
     private
+    
+    def person_properties(properties = {})
+      properties.inject({}) do |out, (k, v)|
+        if PERSON_PROPERTIES.member?(k.to_s)
+          out["$#{k}".to_sym] = v
+        else
+          out[k] = v
+        end
+        out
+      end
+    end
 
     def parse_response(response)
       response == "1" ? true : false
     end
 
-    def request(params)
+    def request(mode, params)
       data = Base64.encode64(JSON.generate(params)).gsub(/\n/,'')
-      url = @import ? @url + "=" + data + '&api_key=' + @api_key : @url + data
-
+      
+      mode = :import if @import
+      endpoint = case mode
+        when :track   then TRACK_ENDPOINT
+        when :engage  then ENGAGE_ENDPOINT
+        when :import  then IMPORT_ENDPOINT
+      end
+      url = "#{@url}#{endpoint}#{data}"
+      url += "&api_key=#{@api_key}" if mode == :import
+      
       if(@async)
         w = Tracker.worker
         begin
@@ -132,9 +168,5 @@ module Mixpanel
         open(url).read
       end
     end
-
-    def build_event(event, properties)
-      {:event => event, :properties => properties}
-    end
   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 = "2.1.0"
+  s.version = "2.2.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_spec.rb

@@ -29,7 +29,7 @@ describe Mixpanel::Tracker do
       it "should call request method with token, time value and ip address" do
         params = {:event => "Sign up", :properties => {:token => MIX_PANEL_TOKEN, :time => Time.now.utc.to_i, :ip => "127.0.0.1"}}
 
-        @mixpanel.should_receive(:request).with(params).and_return("1")
+        @mixpanel.should_receive(:request).with(:track, params).and_return("1")
         @mixpanel.track_event("Sign up").should == true
       end
 
@@ -38,10 +38,47 @@ describe Mixpanel::Tracker do
 
         params = {:event => "Sign up", :properties => {:token => MIX_PANEL_TOKEN, :time => Time.now.utc.to_i, :ip => "10.1.0.2"}}
 
-        @mixpanel.should_receive(:request).with(params).and_return("1")
+        @mixpanel.should_receive(:request).with(:track, params).and_return("1")
         @mixpanel.track_event("Sign up")
       end
     end
+    
+    context "Managing People" do
+      it "should set person data" do
+        @mixpanel.engage_set(DISTINCT_ID, :$email => 'test@example.com').should == true
+      end
+      
+      it "should add person data" do
+        @mixpanel.engage_add(DISTINCT_ID, :custom => 99).should == true
+      end
+      
+      it "should be able to call engage method directly" do
+        @mixpanel.engage(:set, DISTINCT_ID, :$email => 'test@example.com').should == true
+      end
+      
+      it "should call request method for setting" do
+        params = {
+          :$token       => MIX_PANEL_TOKEN,
+          :$distinct_id => DISTINCT_ID,
+          :$set         => {
+            :$email => 'test@example.com',
+            :custom => 'test'
+        }}
+        @mixpanel.should_receive(:request).with(:engage, params).and_return("1")
+        @mixpanel.engage(:set, DISTINCT_ID, :email => 'test@example.com', :custom => 'test')
+      end
+      
+      it "should call request method for adding" do
+        params = {
+          :$token       => MIX_PANEL_TOKEN,
+          :$distinct_id => DISTINCT_ID,
+          :$add         => {
+            :custom => 99
+        }}
+        @mixpanel.should_receive(:request).with(:engage, params).and_return("1")
+        @mixpanel.engage(:add, DISTINCT_ID, :custom => 99)
+      end
+    end
   end
 
   context "Accessing Mixpanel through javascript API" do
@@ -120,10 +157,23 @@ describe Mixpanel::Tracker do
     end
   end
 
-  context "Import mode" do
+  context "Request modes" do
+    it "should use the track URL" do
+      @mixpanel.track_event("Sign up")
+      FakeWeb.last_request.path.to_s.include?(Mixpanel::Tracker::TRACK_ENDPOINT).should == true
+    end
+    
+    it "should use the engage URL" do
+      @mixpanel.engage(:set, DISTINCT_ID, :email => 'test@example.com')
+      FakeWeb.last_request.path.to_s.include?(Mixpanel::Tracker::ENGAGE_ENDPOINT).should == true
+    end
+    
     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
+      @mixpanel.track_event("Sign up")
+      path = FakeWeb.last_request.path.to_s
+      path.include?(Mixpanel::Tracker::IMPORT_ENDPOINT).should == true
+      path.include?("&api_key=ABCDEFG").should == true
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ require 'nokogiri'
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 
 MIX_PANEL_TOKEN = "e2d8b0bea559147844ffab3d607d26a6"
-
+DISTINCT_ID     = "abcd1234"
 
 def mixpanel_queue_should_include(mixpanel, type, *arguments)
   mixpanel.queue.each do |event_type, event_arguments|

metadata

@@ -1,158 +1,123 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mixpanel
-version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
-  segments: 
-  - 2
-  - 1
-  - 0
-  version: 2.1.0
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Alvaro Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-17 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2160572700 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2160572700
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2160572260 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2160572260
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: &2153622720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2153622720
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2153622300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2153622300
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2153621880 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2153621880
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: &2153621460 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2153621460
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2153621040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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 
+  version_requirements: *2153621040
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2153620620 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: *2153620620
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &2153620160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    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: *2153620160
+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: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - README.md
 - LICENSE
 - Rakefile
@@ -166,39 +131,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 
-      hash: 3
-      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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: mixpanel
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Supports direct request api and javascript requests through a middleware.
 test_files: []
-