mixpanel-ruby 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 286b3bfe7565a25de53140a93d879b403331b87d
-  data.tar.gz: b6eed03923e1eee12b21075e5afe48ac4c81807a
+  metadata.gz: f9e1a1a4366eebfc28e385aafb1a74df684b02d4
+  data.tar.gz: 2569a46638a4c168e6766ca21c3ce54adf5d9ee4
 SHA512:
-  metadata.gz: 765115c755470429ef8a93609b2e42578a1cfb762df1474d1e98b0eb3188c869235b2d7e7a4e1569a1aa098fc1211478285434b9e689d3186caa512c5f7b83ad
-  data.tar.gz: 4844747e4c68ecaca350d4c720118716014306e803eb5f414bd4a3ed11e701ea474bd7e321bc539e9ea2134186e69fe968263322ac57ff9bb99e3c99cce0be08
+  metadata.gz: 2e759bb1cd88260c95e1d5edf2efd61bcf284984f3595c5e1b3126b3db428db85806942bf09d73e2974cd0da8b292d8c8edd9315ad2cb81a9456bfe555049ee6
+  data.tar.gz: 9d53eccb3b1cee24a2dbda7cf16719feb5933002bf394079050bd10882493ecd53f93263e489df28a049e649344f5cfc992cce10914aa24417a958e342606020

data/Readme.rdoc

@@ -49,6 +49,12 @@ In particular, for Rails apps, the following projects are currently actively mai
 
 == Changes
 
+== 2.1.0
+* Add Mixpanel::Tracker#generate_tracking_url, which generates {pixel tracking urls}[https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking].
+* Rescue JSONErrors in the consumer and raise Mixpanel::ServerError in Mixpanel::Consumer#send!.
+* Make it clear how to import events with custom timestamp.
+* Update dependancies in gemspec
+
 == 2.0.1
 * Add Deprecated version of Mixpanel::BufferedConsumer#send
 

data/lib/mixpanel-ruby/consumer.rb

@@ -35,7 +35,7 @@ module Mixpanel
     @@init_http = block
   end
 
-  # A Consumer recieves messages from a Mixpanel::Tracker, and
+  # A Consumer receives messages from a Mixpanel::Tracker, and
   # sends them elsewhere- probably to Mixpanel's analytics services,
   # but can also enqueue them for later processing, log them to a
   # file, or do whatever else you might find useful.
@@ -100,13 +100,16 @@ module Mixpanel
         raise ConnectionError.new("Could not connect to Mixpanel, with error \"#{e.message}\".")
       end
 
-      succeeded = nil
+      result = {}
       if response_code.to_i == 200
-        result = JSON.load(response_body) rescue {}
-        succeeded = result['status'] == 1
+        begin
+          result = JSON.parse(response_body.to_s)
+        rescue JSON::JSONError
+          raise ServerError.new("Could not interpret Mixpanel server response: '#{response_body}'")
+        end
       end
 
-      if !succeeded
+      if result['status'] != 1
         raise ServerError.new("Could not write to Mixpanel, server responded with #{response_code} returning: '#{response_body}'")
       end
     end
@@ -123,7 +126,7 @@ module Mixpanel
     # [response code, response body]
     #
     # as the result of the response. Response code should be nil if
-    # the request never recieves a response for some reason.
+    # the request never receives a response for some reason.
     def request(endpoint, form_data)
       uri = URI(endpoint)
       request = Net::HTTP::Post.new(uri.request_uri)
@@ -141,7 +144,6 @@ module Mixpanel
       response = client.request(request)
       [response.code, response.body]
     end
-
   end
 
   # BufferedConsumer buffers messages in memory, and sends messages as

data/lib/mixpanel-ruby/events.rb

@@ -79,7 +79,9 @@ module Mixpanel
     # representing the source of that event (for example, a user id),
     # an event name describing the event and a set of properties
     # describing that event. Properties are provided as a Hash with
-    # string keys and strings, numbers or booleans as values.
+    # string keys and strings, numbers or booleans as values.  By default,
+    # we pass the time of the method call as the time the event occured, if you
+    # wish to override this pass a timestamp in the properties hash.
     #
     #     tracker = Mixpanel::Tracker.new
     #
@@ -90,7 +92,8 @@ module Mixpanel
     #     # or aspects of the source or user associated with the event
     #     tracker.import("API_KEY", "12345", "Welcome Email Sent", {
     #         'Email Template' => 'Pretty Pink Welcome',
-    #         'User Sign-up Cohort' => 'July 2013'
+    #         'User Sign-up Cohort' => 'July 2013',
+    #         'time' => 1369353600,
     #     })
     def import(api_key, distinct_id, event, properties={}, ip=nil)
       properties = {

data/lib/mixpanel-ruby/tracker.rb

@@ -131,5 +131,42 @@ module Mixpanel
 
       ret
     end
+
+    # A call to #generate_tracking_url will return a formatted url for
+    # pixel based tracking.  #generate_tracking_url takes a distinct_id
+    # representing the source of that event (for example, a user id),
+    # an event name describing the event, and a set of properties describing
+    # that event. Properties are provided as a Hash with string keys and
+    # strings, numbers or booleans as values. For more information, please see:
+    # https://mixpanel.com/docs/api-documentation/pixel-based-event-tracking
+    #
+    #     tracker = Mixpanel::Tracker.new
+    #
+    #     # generate pixel tracking url in order to track that user
+    #     # "12345"'s credit card was declined
+    #     url = tracker.generate_tracking_url("12345", "Credit Card Declined", {
+    #       'time' => 1310111365
+    #     })
+    #
+    #     url == 'https://api.mixpanel.com/track/?data=[BASE_64_JSON_EVENT]&ip=1&img=1'
+    def generate_tracking_url(distinct_id, event, properties={}, endpoint=nil)
+      properties = {
+        'distinct_id' => distinct_id,
+        'token' => @token,
+        'time' => Time.now.to_i,
+        'mp_lib' => 'ruby',
+        '$lib_version' => Mixpanel::VERSION,
+      }.merge(properties)
+
+      raw_data = {
+        'event' => event,
+        'properties' => properties,
+      }
+
+      endpoint = endpoint || 'https://api.mixpanel.com/track/'
+      data = Base64.urlsafe_encode64(raw_data.to_json)
+
+      "#{endpoint}?data=#{data}&ip=1&img=1"
+    end
   end
 end

data/lib/mixpanel-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mixpanel
-  VERSION = '2.0.1'
+  VERSION = '2.1.0'
 end

data/mixpanel-ruby.gemspec

@@ -14,7 +14,7 @@ spec = Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0.0'
-  spec.add_development_dependency 'webmock', '~> 1.18.0'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.18'
 end

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -46,6 +46,20 @@ describe Mixpanel::Consumer do
       expect(WebMock).to have_requested(:post, 'https://api.mixpanel.com/track').
         with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
     end
+
+    it 'should raise server error if response body is empty' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => ''})
+      expect { subject.send!(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json) }.to raise_exception(Mixpanel::ServerError, /Could not interpret Mixpanel server response: ''/)
+      expect(WebMock).to have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
+    end
+
+    it 'should raise server error when verbose is disabled' do
+      stub_request(:any, 'https://api.mixpanel.com/track').to_return({:body => '0'})
+      expect { subject.send!(:event, {'data' => 'TEST EVENT MESSAGE'}.to_json) }.to raise_exception(Mixpanel::ServerError, /Could not interpret Mixpanel server response: '0'/)
+      expect(WebMock).to have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
+    end
   end
 
   context 'raw consumer' do

data/spec/mixpanel-ruby/events_spec.rb

@@ -50,5 +50,26 @@ describe Mixpanel::Events do
         }
     } ]])
   end
-end
 
+  it 'should allow users to pass timestamp for import' do
+    older_time = Time.parse('Jun 6 1971, 16:23:04')
+    @events.import('API_KEY', 'TEST ID', 'Test Event', {
+        'Circumstances' => 'During a test',
+        'time' => older_time.to_i,
+    })
+    expect(@log).to 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' => older_time.to_i,
+            }
+        }
+    } ]])
+  end
+end

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -2,6 +2,7 @@ require 'mixpanel-ruby'
 require 'base64'
 require 'json'
 require 'uri'
+require 'cgi'
 
 describe Mixpanel::Tracker do
   before(:each) do
@@ -19,6 +20,34 @@ describe Mixpanel::Tracker do
       with(:body => {:data => 'eyJldmVudCI6IiRjcmVhdGVfYWxpYXMiLCJwcm9wZXJ0aWVzIjp7ImRpc3RpbmN0X2lkIjoiVEVTVCBJRCIsImFsaWFzIjoiVEVTVCBBTElBUyIsInRva2VuIjoiVEVTVCBUT0tFTiJ9fQ==', 'verbose' => '1'})
   end
 
+  it 'should generate pixel tracking urls correctly' do
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN')
+    event = 'TEST EVENT'
+    properties = {'Circumstances' => 'During test'}
+    default_properties = {
+      'distinct_id' => 'TEST_ID',
+      'mp_lib' => 'ruby',
+      '$lib_version' => Mixpanel::VERSION,
+      'token' => 'TEST TOKEN',
+      'time' => @time_now.to_i
+    }
+    expected_data = {'event' => event, 'properties' => properties.merge(default_properties)}
+
+    url_string = mixpanel.generate_tracking_url('TEST_ID', event, properties)
+
+    url = URI(url_string)
+    expect(url.scheme).to eq('https')
+    expect(url.host).to eq('api.mixpanel.com')
+    expect(url.path).to eq('/track/')
+
+    parsed_query = CGI.parse(url.query)
+    expect(parsed_query['ip'][0]).to eq('1')
+    expect(parsed_query['img'][0]).to eq('1')
+
+    data = JSON.parse(Base64.urlsafe_decode64(parsed_query['data'][0]))
+    expect(data).to eq(expected_data)
+  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}'})

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Mixpanel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.18'
 description: The official Mixpanel tracking library for ruby
 email: support@mixpanel.com
 executables: []