mixpanel-ruby-with-pixel-tracking 1.4.0

data/lib/mixpanel-ruby/version.rb

@@ -0,0 +1,3 @@
+module Mixpanel
+  VERSION = '1.4.0'
+end

data/mixpanel-ruby.gemspec

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__), 'lib/mixpanel-ruby/version.rb')
+
+spec = Gem::Specification.new do |spec|
+  spec.name = 'mixpanel-ruby-with-pixel-tracking'
+  spec.version = Mixpanel::VERSION
+  spec.files = Dir.glob(`git ls-files`.split("\n"))
+  spec.require_paths = ['lib']
+  spec.summary = 'Temporary fork of the Official Mixpanel tracking library'
+  spec.description = 'Enables pixel-based event tracking'
+  spec.authors = [ 'Mixpanel', 'Pius Uzamere' ]
+  spec.email = 'support@mixpanel.com'
+  spec.homepage = 'https://mixpanel.com/help/reference/ruby'
+
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('webmock')
+end

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'webmock'
+require 'base64'
+require 'mixpanel-ruby/consumer'
+
+describe Mixpanel::Consumer do
+  before { WebMock.reset! }
+
+  shared_examples_for 'consumer' do
+    it 'should send a request to api.mixpanel.com/track on events' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json)
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
+    end
+
+    it 'should send a request to api.mixpanel.com/people on profile updates' do
+      stub_request(:any, 'https://api.mixpanel.com/engage').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:profile_update, {'data' => 'TEST EVENT MESSAGE'}.to_json)
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/engage').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
+    end
+
+    it 'should send a request to api.mixpanel.com/import on event imports' do
+      stub_request(:any, 'https://api.mixpanel.com/import').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:import, {'data' => 'TEST EVENT MESSAGE', 'api_key' => 'API_KEY','verbose' => '1' }.to_json)
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'api_key' => 'API_KEY', 'verbose' => '1' })
+    end
+
+    it 'should encode long messages without newlines' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:event, {'data' => 'BASE64-ENCODED VERSION OF BIN. THIS METHOD COMPLIES WITH RFC 2045. LINE FEEDS ARE ADDED TO EVERY 60 ENCODED CHARACTORS. IN RUBY 1.8 WE NEED TO JUST CALL ENCODE64 AND REMOVE THE LINE FEEDS, IN RUBY 1.9 WE CALL STRIC_ENCODED64 METHOD INSTEAD'}.to_json)
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'IkJBU0U2NC1FTkNPREVEIFZFUlNJT04gT0YgQklOLiBUSElTIE1FVEhPRCBDT01QTElFUyBXSVRIIFJGQyAyMDQ1LiBMSU5FIEZFRURTIEFSRSBBRERFRCBUTyBFVkVSWSA2MCBFTkNPREVEIENIQVJBQ1RPUlMuIElOIFJVQlkgMS44IFdFIE5FRUQgVE8gSlVTVCBDQUxMIEVOQ09ERTY0IEFORCBSRU1PVkUgVEhFIExJTkUgRkVFRFMsIElOIFJVQlkgMS45IFdFIENBTEwgU1RSSUNfRU5DT0RFRDY0IE1FVEhPRCBJTlNURUFEIg==', 'verbose' => '1'})
+    end
+
+    it 'should provide thorough information in case mixpanel fails' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:status => 401, :body => "nutcakes"})
+      expect { subject.send(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json) }.to raise_exception('Could not write to Mixpanel, server responded with 401 returning: \'nutcakes\'')
+    end
+  end
+
+  context 'raw consumer' do
+    it_behaves_like 'consumer'
+  end
+
+  context 'custom request consumer' do
+    subject do
+      ret = Mixpanel::Consumer.new
+      class << ret
+        attr_reader :called
+        def request(*args)
+          @called = true
+          super(*args)
+        end
+      end
+
+      ret
+    end
+
+    after(:each) do
+      subject.called.should be_true
+    end
+
+    it_behaves_like 'consumer'
+  end
+
+end
+
+describe Mixpanel::BufferedConsumer do
+  let(:max_length) { 10 }
+  before { WebMock.reset! }
+
+  context 'Default BufferedConsumer' do
+    subject { Mixpanel::BufferedConsumer.new(nil, nil, nil, max_length) }
+
+    it 'should not send a request for a single message until flush is called' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:event, {'data' => 'TEST EVENT 1'}.to_json)
+      WebMock.should have_not_requested(:post, 'https://api.mixpanel.com/track')
+
+      subject.flush()
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'WyJURVNUIEVWRU5UIDEiXQ==', 'verbose' => '1' })
+    end
+
+    it 'should send one message when max_length events are tracked' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+
+      max_length.times do |i|
+        subject.send(:event, {'data' => "x #{i}"}.to_json)
+      end
+
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'WyJ4IDAiLCJ4IDEiLCJ4IDIiLCJ4IDMiLCJ4IDQiLCJ4IDUiLCJ4IDYiLCJ4IDciLCJ4IDgiLCJ4IDkiXQ==', 'verbose' => '1' })
+    end
+
+    it 'should send one message per api key on import' do
+      stub_request(:any, 'https://api.mixpanel.com/import').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send(:import, {'data' => 'TEST EVENT 1', 'api_key' => 'KEY 1'}.to_json)
+      subject.send(:import, {'data' => 'TEST EVENT 1', 'api_key' => 'KEY 2'}.to_json)
+      subject.send(:import, {'data' => 'TEST EVENT 2', 'api_key' => 'KEY 1'}.to_json)
+      subject.send(:import, {'data' => 'TEST EVENT 2', 'api_key' => 'KEY 2'}.to_json)
+      subject.flush
+
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 1', 'verbose' => '1' })
+
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 2', 'verbose' => '1' })
+    end
+  end
+
+  context 'BufferedConsumer with block' do
+    let(:messages_seen) { [] }
+    subject do
+      Mixpanel::BufferedConsumer.new(nil, nil, nil, 3) do |type, message|
+        messages_seen << [type, message]
+      end
+    end
+
+    it 'should call block instead of making default requests on flush' do
+      3.times do |i|
+        subject.send(:event, {'data' => "x #{i}"}.to_json)
+      end
+
+      expect(messages_seen).to match_array(
+        [[:event, "{\"data\":[\"x 0\",\"x 1\",\"x 2\"]}"]]
+      )
+    end
+
+  end
+
+end

data/spec/mixpanel-ruby/events_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'mixpanel-ruby/events.rb'
+require 'mixpanel-ruby/version.rb'
+require 'time'
+
+describe Mixpanel::Events do
+  before(:each) do
+    @time_now = Time.parse('Jun 6 1972, 16:23:04')
+    Time.stub(:now).and_return(@time_now)
+
+    @log = []
+    @events = Mixpanel::Events.new('TEST TOKEN') do |type, message|
+      @log << [type, JSON.load(message)]
+    end
+  end
+
+  it 'should send a well formed track/ message' do
+    @events.track('TEST ID', 'Test Event', {
+        'Circumstances' => 'During a test'
+    })
+    @log.should eq([[:event, 'data' => {
+        'event' => 'Test Event',
+        'properties' => {
+            'Circumstances' => 'During a test',
+            'distinct_id' => 'TEST ID',
+            'mp_lib' => 'ruby',
+            '$lib_version' => Mixpanel::VERSION,
+            'token' => 'TEST TOKEN',
+            'time' => @time_now.to_i
+        }
+    }]])
+  end
+
+
+  it 'should return a well formed pixel tracking uri if asked' do
+    @events.track('TEST ID', 'Test Event', {
+        'Circumstances' => 'During a test'
+    }, nil, true)
+    @log.should eq([[:event, 'data' => {
+        'event' => 'Test Event',
+        'properties' => {
+            'Circumstances' => 'During a test',
+            'distinct_id' => 'TEST ID',
+            'mp_lib' => 'ruby',
+            '$lib_version' => Mixpanel::VERSION,
+            'token' => 'TEST TOKEN',
+            'time' => @time_now.to_i
+        }
+    }]])
+  end
+
+
+  it 'should send a well formed import/ message' do
+    @events.import('API_KEY', 'TEST ID', 'Test Event', {
+        'Circumstances' => 'During a test'
+    })
+    @log.should eq([[:import, {
+        'api_key' => 'API_KEY',
+        'data' => {
+            'event' => 'Test Event',
+            'properties' => {
+                'Circumstances' => 'During a test',
+                'distinct_id' => 'TEST ID',
+                'mp_lib' => 'ruby',
+                '$lib_version' => Mixpanel::VERSION,
+                'token' => 'TEST TOKEN',
+                'time' => @time_now.to_i
+            }
+        }
+    } ]])
+  end
+end

data/spec/mixpanel-ruby/people_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+require 'mixpanel-ruby/people'
+
+describe Mixpanel::People do
+  before(:each) do
+    @time_now = Time.parse('Jun 6 1972, 16:23:04')
+    Time.stub(:now).and_return(@time_now)
+
+    @log = []
+    @people = Mixpanel::People.new('TEST TOKEN') do |type, message|
+      @log << [type, JSON.load(message)]
+    end
+  end
+
+  it 'should send a well formed engage/set message' do
+    @people.set("TEST ID", {
+        '$firstname' => 'David',
+        '$lastname' => 'Bowie',
+    })
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            '$firstname' => 'David',
+            '$lastname' => 'Bowie'
+        }
+    }]])
+  end
+
+  it 'should properly cast dates' do
+    @people.set("TEST ID", {
+        'created_at' => DateTime.new(2013, 1, 2, 3, 4, 5)
+    })
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            'created_at' => '2013-01-02T03:04:05'
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/set_once message' do
+    @people.set_once("TEST ID", {
+        '$firstname' => 'David',
+        '$lastname' => 'Bowie',
+    })
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set_once' => {
+            '$firstname' => 'David',
+            '$lastname' => 'Bowie'
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/add message' do
+    @people.increment("TEST ID", {'Albums Released' => 10})
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$add' => {
+            'Albums Released' => 10
+        }
+    }]])
+  end
+
+  it 'should send an engage/add message with a value of 1' do
+    @people.plus_one("TEST ID", 'Albums Released')
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$add' => {
+            'Albums Released' => 1
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/append message' do
+    @people.append("TEST ID", {'Albums' => 'Diamond Dogs'})
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$append' => {
+            'Albums' => 'Diamond Dogs'
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/union message' do
+    @people.union("TEST ID", {'Albums' => ['Diamond Dogs']})
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$union' => {
+            'Albums' => ['Diamond Dogs']
+        }
+    }]])
+  end
+
+  it 'should send a well formed unset message' do
+    @people.unset('TEST ID', 'Albums')
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$unset' => ['Albums']
+    }]])
+  end
+
+  it 'should send a well formed unset message with multiple properties' do
+    @people.unset('TEST ID', ['Albums', 'Vinyls'])
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$unset' => ['Albums', 'Vinyls']
+    }]])
+  end
+
+  it 'should send an engage/append with the right $transaction stuff' do
+    @people.track_charge("TEST ID", 25.42, {
+        '$time' => DateTime.new(1999,12,24,14, 02, 53),
+        'SKU' => '1234567'
+    })
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$append' => {
+            '$transactions' => {
+                '$time' => '1999-12-24T14:02:53',
+                'SKU' => '1234567',
+                '$amount' => 25.42
+            }
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/unset message for $transaction' do
+    @people.clear_charges("TEST ID")
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$unset' => ['$transactions']
+    }]])
+  end
+
+  it 'should send a well formed engage/delete message' do
+    @people.delete_user("TEST ID")
+    @log.should eq([[:profile_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => @time_now.to_i * 1000,
+        '$delete' => ''
+    }]])
+  end
+end

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -0,0 +1,135 @@
+require 'mixpanel-ruby'
+require 'base64'
+require 'json'
+require 'uri'
+
+describe Mixpanel::Tracker do
+  before(:each) do
+    @time_now = Time.parse('Jun 6 1972, 16:23:04')
+    Time.stub(:now).and_return(@time_now)
+  end
+
+  it 'should send an alias message to mixpanel no matter what the consumer is' do
+    WebMock.reset!
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN') {|*args| }
+    mixpanel.alias('TEST ALIAS', 'TEST ID')
+
+    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+      with(:body => {:data => 'eyJldmVudCI6IiRjcmVhdGVfYWxpYXMiLCJwcm9wZXJ0aWVzIjp7ImRpc3RpbmN0X2lkIjoiVEVTVCBJRCIsImFsaWFzIjoiVEVTVCBBTElBUyIsInRva2VuIjoiVEVTVCBUT0tFTiJ9fQ==', 'verbose' => '1'})
+  end
+
+  it 'should send a request to the track api with the default consumer' do
+    WebMock.reset!
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+    stub_request(:any, 'https://api.mixpanel.com/engage').to_return({:body => '{"status": 1, "error": null}'})
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN')
+
+    mixpanel.track('TEST ID', 'TEST EVENT', {'Circumstances' => 'During test'})
+
+    body = nil
+    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+      with { |req| body = req.body }
+
+    message_urlencoded = body[/^data=(.*?)(?:&|$)/, 1]
+    message_json = Base64.strict_decode64(URI.unescape(message_urlencoded))
+    message = JSON.load(message_json)
+    message.should eq({
+        'event' => 'TEST EVENT',
+        'properties' => {
+            'Circumstances' => 'During test',
+            'distinct_id' => 'TEST ID',
+            'mp_lib' => 'ruby',
+            '$lib_version' => Mixpanel::VERSION,
+            'token' => 'TEST TOKEN',
+            'time' => @time_now.to_i
+        }
+    })
+  end
+
+  it 'should return a tracking uri if asked and not execute any requests' do
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN')
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '{"status": 1, "error": null}'})
+
+
+    a = mixpanel.track('TEST ID', 'TEST EVENT', {'Circumstances' => 'During test'}, nil, true)
+    a.should eq "https://api.mixpanel.com/track?data=eyJldmVudCI6IlRFU1QgRVZFTlQiLCJwcm9wZXJ0aWVzIjp7ImRpc3RpbmN0X2lkIjoiVEVTVCBJRCIsInRva2VuIjoiVEVTVCBUT0tFTiIsInRpbWUiOjc2NzIwOTg0LCJtcF9saWIiOiJydWJ5IiwiJGxpYl92ZXJzaW9uIjoiMS40LjAiLCJDaXJjdW1zdGFuY2VzIjoiRHVyaW5nIHRlc3QifX0%3D&verbose=1&img=1"
+
+    WebMock.should_not have_requested(:post, 'https://api.mixpanel.com/track')
+    WebMock.should_not have_requested(:get, 'https://api.mixpanel.com/track')
+  end
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  it 'should call a consumer block if one is given' do
+    messages = []
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN') do |type, message|
+      messages << [type, JSON.load(message)]
+    end
+    mixpanel.track('ID', 'Event')
+    mixpanel.import('API_KEY', 'ID', 'Import')
+    mixpanel.people.set('ID', {'k' => 'v'})
+    mixpanel.people.append('ID', {'k' => 'v'})
+
+    expect = [
+        [ :event, 'data' =>
+          { 'event' => 'Event',
+            'properties' => {
+              'distinct_id' => 'ID',
+              'mp_lib' => 'ruby',
+              '$lib_version' => Mixpanel::VERSION,
+              'token' => 'TEST TOKEN',
+              'time' => @time_now.to_i
+            }
+          }
+        ],
+        [ :import, {
+            'data' => {
+              'event' => 'Import',
+              'properties' => {
+                'distinct_id' => 'ID',
+                'mp_lib' => 'ruby',
+                '$lib_version' => Mixpanel::VERSION,
+                'token' => 'TEST TOKEN',
+                'time' => @time_now.to_i
+              }
+            },
+            'api_key' => 'API_KEY',
+          }
+        ],
+        [ :profile_update, 'data' =>
+          { '$token' => 'TEST TOKEN',
+            '$distinct_id' => 'ID',
+            '$time' => @time_now.to_i * 1000,
+            '$set' => {'k' => 'v'}
+          }
+        ],
+        [ :profile_update, 'data' =>
+          { '$token' => 'TEST TOKEN',
+            '$distinct_id' => 'ID',
+            '$time' => @time_now.to_i * 1000,
+            '$append' => {'k' => 'v'}
+          }
+        ]
+    ]
+    expect.zip(messages).each do |expect, found|
+      expect.should eq(found)
+    end
+  end
+end