mixpanel-ruby 1.0.2 → 1.1.0

data/Readme.rdoc

@@ -38,6 +38,10 @@ For more information please visit:
 
 == Changes
 
+== 1.1.0
+* The default consumer now sends requests (and expects responses) in
+  verbose, JSON mode, which may improve error reporting.
+
 === 1.0.2
 * Allow ip and optional_params arguments to be accepted by all
   Mixpanel::People methods (except #destroy_user)

data/lib/mixpanel-ruby/consumer.rb

@@ -1,5 +1,6 @@
 require 'base64'
 require 'net/https'
+require 'json'
 
 module Mixpanel
   class ConnectionError < IOError
@@ -86,16 +87,22 @@ module Mixpanel
       client.use_ssl = true
       Mixpanel.with_http(client)
 
-      form_data = { "data" => data }
+      form_data = { "data" => data, "verbose" => 1 }
       form_data.merge!("api_key" => api_key) if api_key
       request = Net::HTTP::Post.new(uri.request_uri)
       request.set_form_data(form_data)
       response = client.request(request)
 
-      if response.code == '200' and response.body == '1'
+      succeeded = false
+      if response.code == '200'
+        result = JSON.load(response.body) rescue {}
+        succeeded = result['status'] == 1
+      end
+
+      if succeeded
         return true
       else
-        raise ConnectionError.new('Could not write to Mixpanel')
+        raise ConnectionError.new("Could not write to Mixpanel, server responded with #{response.code} returning: '#{response.body}'")
       end
     end
   end

data/lib/mixpanel-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mixpanel
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -10,31 +10,36 @@ describe Mixpanel::Consumer do
   end
 
   it 'should send a request to api.mixpanel.com/track on events' do
-    stub_request(:any, 'https://api.mixpanel.com/track').to_return({ :body => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({ :body => '{"status": 1, "error": null}' })
     @consumer.send(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json)
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
-      with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=' })
+      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 => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/engage').to_return({ :body => '{"status": 1, "error": null}' })
     @consumer.send(:profile_update, {'data' => 'TEST EVENT MESSAGE'}.to_json)
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/engage').
-      with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=' })
+      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 => "1" })
-    @consumer.send(:import, {'data' => 'TEST EVENT MESSAGE', 'api_key' => 'API_KEY'}.to_json)
+    stub_request(:any, 'https://api.mixpanel.com/import').to_return({ :body => '{"status": 1, "error": null}' })
+    @consumer.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' })
+      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 => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({ :body => '{"status": 1, "error": null}' })
     @consumer.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==' })
+      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 { @consumer.send(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json) }.to raise_exception('Could not write to Mixpanel, server responded with 401 returning: \'nutcakes\'')
   end
 end
 
@@ -46,28 +51,28 @@ describe Mixpanel::BufferedConsumer do
   end
 
   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 => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({ :body => '{"status": 1, "error": null}' })
     @consumer.send(:event, {'data' => 'TEST EVENT 1'}.to_json)
     WebMock.should have_not_requested(:post, 'https://api.mixpanel.com/track')
 
     @consumer.flush()
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
-      with(:body => {'data' => 'WyJURVNUIEVWRU5UIDEiXQ==' })
+      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 => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/track').to_return({ :body => '{"status": 1, "error": null}' })
 
     @max_length.times do |i|
       @consumer.send(:event, {'data' => "x #{i}"}.to_json)
     end
 
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
-      with(:body => {'data' => 'WyJ4IDAiLCJ4IDEiLCJ4IDIiLCJ4IDMiLCJ4IDQiLCJ4IDUiLCJ4IDYiLCJ4IDciLCJ4IDgiLCJ4IDkiXQ==' })
+      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 => "1" })
+    stub_request(:any, 'https://api.mixpanel.com/import').to_return({ :body => '{"status": 1, "error": null}' })
     @consumer.send(:import, {'data' => 'TEST EVENT 1', 'api_key' => 'KEY 1'}.to_json)
     @consumer.send(:import, {'data' => 'TEST EVENT 1', 'api_key' => 'KEY 2'}.to_json)
     @consumer.send(:import, {'data' => 'TEST EVENT 2', 'api_key' => 'KEY 1'}.to_json)
@@ -75,9 +80,9 @@ describe Mixpanel::BufferedConsumer do
     @consumer.flush
 
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
-      with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 1' })
+      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' })
+      with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 2', 'verbose' => '1' })
   end
 end

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -11,18 +11,18 @@ describe Mixpanel::Tracker do
 
   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 => "1" })
+    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==' })
+      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 => "1" })
-    stub_request(:any, 'https://api.mixpanel.com/engage').to_return({ :body => "1" })
+    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' })
@@ -31,7 +31,7 @@ describe Mixpanel::Tracker do
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
       with { |req| body = req.body }
 
-    message_urlencoded = body[/^data=(.*)$/, 1]
+    message_urlencoded = body[/^data=(.*?)(?:&|$)/, 1]
     message_json = Base64.strict_decode64(URI.unescape(message_urlencoded))
     message = JSON.load(message_json)
     message.should eq({

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-18 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake