mixpanel-ruby 1.2.0 → 1.3.0

data/Readme.rdoc

@@ -1,8 +1,7 @@
 = mixpanel-ruby: The official Mixpanel Ruby library
 
 mixpanel-ruby is a library for tracking events and sending \Mixpanel profile
-updates to \Mixpanel from your ruby applications. It's straightforward to
-get started sending your first events and updates:
+updates to \Mixpanel from your ruby applications.
 
 == Installation
 
@@ -38,6 +37,9 @@ For more information please visit:
 
 == Changes
 
+== 1.3.0
+* Added Consumer#request method, demo with Faraday integration
+
 == 1.2.0
 * All objects with a "strftime" method will be formatted as dates in
   people updates.

data/demo/faraday_consumer.rb

@@ -0,0 +1,40 @@
+require 'mixpanel-ruby'
+require 'faraday'
+
+# The Mixpanel library's default consumer will use the standard
+# Net::HTTP library to communicate with servers, but you can extend
+# your consumers to use other libraries. This example sends data using
+# the Faraday library (so you'll need that library available to run it)
+
+class FaradayConsumer < Mixpanel::Consumer
+  def request(endpoint, form_data)
+    conn = ::Faraday.new(endpoint)
+    response = conn.post(nil, form_data)
+    [response.status, response.body]
+  end
+end
+
+if __FILE__ == $0
+  # Replace this with the token from your project settings
+  DEMO_TOKEN = '072f77c15bd04a5d0044d3d76ced7fea'
+  faraday_consumer = FaradayConsumer.new
+
+  faraday_tracker = Mixpanel::Tracker.new(DEMO_TOKEN) do |type, message|
+    faraday_consumer.send(type, message)
+  end
+  faraday_tracker.track('ID', 'Event tracked through Faraday')
+
+  # It's also easy to delegate from a BufferedConsumer to your custom
+  # consumer.
+
+  buffered_faraday_consumer = Mixpanel::BufferedConsumer.new do |type, message|
+    faraday_consumer.send(type, message)
+  end
+
+  buffered_faraday_tracker = Mixpanel::Tracker.new(DEMO_TOKEN) do |type, message|
+    buffered_faraday_consumer.send(type, message)
+  end
+
+  buffered_faraday_tracker.track('ID', 'Event tracked (buffered) through faraday')
+  buffered_faraday_consumer.flush
+end

data/demo/out_of_process_consumer.rb

@@ -39,7 +39,7 @@ class OutOfProcessExample
 
           100.times do |i|
             event = 'Tick'
-            mixpanel_tracker.track(distinct_id, event, { 'Tick Number' => i })
+            mixpanel_tracker.track(distinct_id, event, {'Tick Number' => i})
             puts "tick #{i}"
           end
 

data/lib/mixpanel-ruby/consumer.rb

@@ -8,12 +8,19 @@ module Mixpanel
 
   @@init_http = nil
 
+  # This method exists for backwards compatibility. The preferred
+  # way to customize or configure the HTTP library of a consumer
+  # is to override Consumer#request.
+  #
   # Ruby's default SSL does not verify the server certificate.
   # To verify a certificate, or install a proxy, pass a block
-  # to Mixpanel::use_ssl that configures the Net::HTTP object.
+  # to Mixpanel.config_http that configures the Net::HTTP object.
+  # Note: when using the Faraday adapter, the block will receive
+  # the Faraday::Connection object. Please refer to the Faraday
+  # documentation for configuration examples.
   # For example, if running in Ubuntu Linux, you can run
   #
-  #    Mixpanel::use_ssl do |http|
+  #    Mixpanel.config_http do |http|
   #        http.ca_path = '/etc/ssl/certs'
   #        http.ca_file = '/etc/ssl/certs/ca-certificates.crt'
   #        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
@@ -36,7 +43,7 @@ module Mixpanel
   #
   #    tracker = Mixpanel::Tracker.new(MY_TOKEN) do |type, message|
   #        # type will be one of :event, :profile_update or :import
-  #        @kestrel.set(ANALYTICS_QUEUE, [ type, message ].to_json)
+  #        @kestrel.set(ANALYTICS_QUEUE, [type, message].to_json)
   #    end
   #
   # You can also instantiate the library consumers yourself, and use
@@ -75,35 +82,46 @@ module Mixpanel
         :event => @events_endpoint,
         :profile_update => @update_endpoint,
         :import => @import_endpoint
-      }[ type ]
+      }[type]
 
       decoded_message = JSON.load(message)
       api_key = decoded_message["api_key"]
       data = Base64.encode64(decoded_message["data"].to_json).gsub("\n", '')
 
+      form_data = {"data" => data, "verbose" => 1}
+      form_data.merge!("api_key" => api_key) if api_key
+
+      response_code, response_body = request(endpoint, form_data)
+
+      succeeded = nil
+      if response_code.to_i == 200
+        result = JSON.load(response_body) rescue {}
+        succeeded = result['status'] == 1
+      end
+
+      if ! succeeded
+        raise ConnectionError.new("Could not write to Mixpanel, server responded with #{response_code} returning: '#{response_body}'")
+      end
+    end
+
+    # Request takes an endpoint HTTP or HTTPS url, and a Hash of data
+    # to post to that url. It should return a pair of
+    #
+    # [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.
+    def request(endpoint, form_data)
       uri = URI(endpoint)
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data(form_data)
 
       client = Net::HTTP.new(uri.host, uri.port)
       client.use_ssl = true
       Mixpanel.with_http(client)
 
-      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)
-
-      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, server responded with #{response.code} returning: '#{response.body}'")
-      end
+      [response.code, response.body]
     end
   end
 
@@ -139,9 +157,22 @@ module Mixpanel
     # consumer automatically sends its buffered events. The Mixpanel
     # endpoints have a limit of 50 events per HTTP request, but
     # you can lower the limit if your individual events are very large.
-    def initialize(events_endpoint=nil, update_endpoint=nil, import_endpoint=nil, max_buffer_length=MAX_LENGTH)
-      @max_length = [ max_buffer_length, MAX_LENGTH ].min
-      @consumer = Consumer.new(events_endpoint, update_endpoint, import_endpoint)
+    #
+    # By default, BufferedConsumer will use a standard Mixpanel
+    # consumer to send the events once the buffer is full (or on calls
+    # to #flush), but you can override this behavior by passing a
+    # block to the constructor, in the same way you might pass a block
+    # to the Mixpanel::Tracker constructor. If a block is passed to
+    # the constructor, the *_endpoint constructor arguments are
+    # ignored.
+    def initialize(events_endpoint=nil, update_endpoint=nil, import_endpoint=nil, max_buffer_length=MAX_LENGTH, &block)
+      @max_length = [max_buffer_length, MAX_LENGTH].min
+      if block
+        @sink = block
+      else
+        consumer = Consumer.new(events_endpoint, update_endpoint, import_endpoint)
+        @sink = consumer.method(:send)
+      end
       @buffers = {
         :event => [],
         :profile_update => [],
@@ -162,7 +193,7 @@ module Mixpanel
           flush_type(type)
         end
       else
-        @consumer.send(type, message)
+        @sink.call(type, message)
       end
     end
 
@@ -178,7 +209,7 @@ module Mixpanel
     def flush_type(type)
       @buffers[type].each_slice(@max_length) do |chunk|
         data = chunk.map {|message| JSON.load(message)['data'] }
-        @consumer.send(type, {'data' => data}.to_json)
+        @sink.call(type, {'data' => data}.to_json)
       end
       @buffers[type] = []
     end

data/lib/mixpanel-ruby/people.rb

@@ -111,13 +111,13 @@ module Mixpanel
 
     # Convenience method- increases the value of a numeric property
     # by one. Calling #plus_one(distinct_id, property_name) is the same as calling
-    # #increment(distinct_id, { property_name => 1 })
+    # #increment(distinct_id, {property_name => 1})
     #
     #    tracker = Mixpanel::Tracker.new
     #    tracker.people.plus_one("12345", "Albums Released")
     #
     def plus_one(distinct_id, property_name, ip=nil, optional_params={})
-      increment(distinct_id, { property_name => 1 }, ip, optional_params)
+      increment(distinct_id, {property_name => 1}, ip, optional_params)
     end
 
     # Appends a values to the end of list-valued properties.
@@ -177,7 +177,7 @@ module Mixpanel
     def unset(distinct_id, property, ip=nil, optional_params={})
       message = {
           '$distinct_id' => distinct_id,
-          '$unset' => [ property ]
+          '$unset' => [property]
       }.merge(optional_params)
 
       if ip
@@ -202,8 +202,8 @@ module Mixpanel
     #
     def track_charge(distinct_id, amount, properties={}, ip=nil, optional_params={})
       properties = fix_property_dates(properties)
-      charge_properties = properties.merge({ '$amount' => amount })
-      append(distinct_id, { '$transactions' => charge_properties }, ip, optional_params)
+      charge_properties = properties.merge({'$amount' => amount})
+      append(distinct_id, {'$transactions' => charge_properties}, ip, optional_params)
     end
 
     # Clear all charges from a \Mixpanel people profile

data/lib/mixpanel-ruby/tracker.rb

@@ -6,12 +6,12 @@ module Mixpanel
   # To track an event, call
   #
   #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
-  #     Mixpanel::Tracker.track(a_distinct_id, an_event_name, { properties })
+  #     Mixpanel::Tracker.track(a_distinct_id, an_event_name, {properties})
   #
   # To send people updates, call
   #
   #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
-  #     tracker.people.set(a_distinct_id, { properties })
+  #     tracker.people.set(a_distinct_id, {properties})
   #
   # You can find your project token in the settings dialog for your
   # project, inside of the Mixpanel web application.

data/lib/mixpanel-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mixpanel
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -4,85 +4,132 @@ require 'base64'
 require 'mixpanel-ruby/consumer'
 
 describe Mixpanel::Consumer do
-  before(:each) do
-    WebMock.reset!
-    @consumer = Mixpanel::Consumer.new
-  end
+  before { WebMock.reset! }
 
-  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}' })
-    @consumer.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
+  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}' })
-    @consumer.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/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 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}' })
-    @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', 'verbose' => '1' })
+    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
 
-  it 'should encode long messages without newlines' do
-    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==', 'verbose' => '1' })
+  context 'raw consumer' do
+    it_behaves_like 'consumer'
   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\'')
+  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
-  before(:each) do
-    WebMock.reset!
-    @max_length = 10
-    @consumer = Mixpanel::BufferedConsumer.new(nil, nil, nil, @max_length)
-  end
+  let(:max_length) { 10 }
+  before { WebMock.reset! }
 
-  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}' })
-    @consumer.send(:event, {'data' => 'TEST EVENT 1'}.to_json)
-    WebMock.should have_not_requested(:post, 'https://api.mixpanel.com/track')
+  context 'Default BufferedConsumer' do
+    subject { Mixpanel::BufferedConsumer.new(nil, nil, nil, max_length) }
 
-    @consumer.flush()
-    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
-      with(:body => {'data' => 'WyJURVNUIEVWRU5UIDEiXQ==', 'verbose' => '1' })
-  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 => '{"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}'})
 
-  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
 
-    @max_length.times do |i|
-      @consumer.send(:event, {'data' => "x #{i}"}.to_json)
+      WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+        with(:body => {'data' => 'WyJ4IDAiLCJ4IDEiLCJ4IDIiLCJ4IDMiLCJ4IDQiLCJ4IDUiLCJ4IDYiLCJ4IDciLCJ4IDgiLCJ4IDkiXQ==', 'verbose' => '1' })
     end
 
-    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
-      with(:body => {'data' => 'WyJ4IDAiLCJ4IDEiLCJ4IDIiLCJ4IDMiLCJ4IDQiLCJ4IDUiLCJ4IDYiLCJ4IDciLCJ4IDgiLCJ4IDkiXQ==', 'verbose' => '1' })
+    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
 
-  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}' })
-    @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)
-    @consumer.send(:import, {'data' => 'TEST EVENT 2', 'api_key' => 'KEY 2'}.to_json)
-    @consumer.flush
+  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
 
-    WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
-      with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 1', 'verbose' => '1' })
+    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
 
-    WebMock.should have_requested(:post, 'https://api.mixpanel.com/import').
-      with(:body => {'data' => 'IlRFU1QgRVZFTlQgMSI=', 'api_key' => 'KEY 2', 'verbose' => '1' })
   end
+
 end

data/spec/mixpanel-ruby/events_spec.rb

@@ -10,7 +10,7 @@ describe Mixpanel::Events do
 
     @log = []
     @events = Mixpanel::Events.new('TEST TOKEN') do |type, message|
-      @log << [ type, JSON.load(message) ]
+      @log << [type, JSON.load(message)]
     end
   end
 
@@ -18,7 +18,7 @@ describe Mixpanel::Events do
     @events.track('TEST ID', 'Test Event', {
         'Circumstances' => 'During a test'
     })
-    @log.should eq([[ :event, 'data' => {
+    @log.should eq([[:event, 'data' => {
         'event' => 'Test Event',
         'properties' => {
             'Circumstances' => 'During a test',
@@ -35,7 +35,7 @@ describe Mixpanel::Events do
     @events.import('API_KEY', 'TEST ID', 'Test Event', {
         'Circumstances' => 'During a test'
     })
-    @log.should eq([[ :import, {
+    @log.should eq([[:import, {
         'api_key' => 'API_KEY',
         'data' => {
             'event' => 'Test Event',

data/spec/mixpanel-ruby/people_spec.rb

@@ -8,7 +8,7 @@ describe Mixpanel::People do
 
     @log = []
     @people = Mixpanel::People.new('TEST TOKEN') do |type, message|
-      @log << [ type, JSON.load(message) ]
+      @log << [type, JSON.load(message)]
     end
   end
 
@@ -17,7 +17,7 @@ describe Mixpanel::People do
         '$firstname' => 'David',
         '$lastname' => 'Bowie',
     })
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
@@ -32,7 +32,7 @@ describe Mixpanel::People do
     @people.set("TEST ID", {
         'created_at' => DateTime.new(2013, 1, 2, 3, 4, 5)
     })
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
@@ -47,7 +47,7 @@ describe Mixpanel::People do
         '$firstname' => 'David',
         '$lastname' => 'Bowie',
     })
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
@@ -59,8 +59,8 @@ describe Mixpanel::People do
   end
 
   it 'should send a well formed engage/add message' do
-    @people.increment("TEST ID", { 'Albums Released' => 10 })
-    @log.should eq([[ :profile_update, 'data' => {
+    @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,
@@ -72,7 +72,7 @@ describe Mixpanel::People do
 
   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' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
@@ -83,8 +83,8 @@ describe Mixpanel::People do
   end
 
   it 'should send a well formed engage/append message' do
-    @people.append("TEST ID", { 'Albums' => 'Diamond Dogs' })
-    @log.should eq([[ :profile_update, 'data' => {
+    @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,
@@ -95,8 +95,8 @@ describe Mixpanel::People do
   end
 
   it 'should send a well formed engage/union message' do
-    @people.union("TEST ID", { 'Albums' => ['Diamond Dogs'] })
-    @log.should eq([[ :profile_update, 'data' => {
+    @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,
@@ -108,11 +108,11 @@ describe Mixpanel::People do
 
   it 'should send a well formed unset message' do
     @people.unset('TEST ID', 'Albums')
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
-        '$unset' => [ 'Albums' ]
+        '$unset' => ['Albums']
     }]])
   end
 
@@ -121,7 +121,7 @@ describe Mixpanel::People do
         '$time' => DateTime.new(1999,12,24,14, 02, 53),
         'SKU' => '1234567'
     })
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
@@ -137,17 +137,17 @@ describe Mixpanel::People do
 
   it 'should send a well formed engage/unset message for $transaction' do
     @people.clear_charges("TEST ID")
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,
-        '$unset' => [ '$transactions' ]
+        '$unset' => ['$transactions']
     }]])
   end
 
   it 'should send a well formed engage/delete message' do
     @people.delete_user("TEST ID")
-    @log.should eq([[ :profile_update, 'data' => {
+    @log.should eq([[:profile_update, 'data' => {
         '$token' => 'TEST TOKEN',
         '$distinct_id' => 'TEST ID',
         '$time' => @time_now.to_i * 1000,

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -11,21 +11,21 @@ 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 => '{"status": 1, "error": null}' })
+    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' })
+      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}' })
+    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' })
+    mixpanel.track('TEST ID', 'TEST EVENT', {'Circumstances' => 'During test'})
 
     body = nil
     WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
@@ -50,12 +50,12 @@ describe Mixpanel::Tracker do
   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) ]
+      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' })
+    mixpanel.people.set('ID', {'k' => 'v'})
+    mixpanel.people.append('ID', {'k' => 'v'})
 
     expect = [
         [ :event, 'data' =>
@@ -87,14 +87,14 @@ describe Mixpanel::Tracker do
           { '$token' => 'TEST TOKEN',
             '$distinct_id' => 'ID',
             '$time' => @time_now.to_i * 1000,
-            '$set' => { 'k' => 'v' }
+            '$set' => {'k' => 'v'}
           }
         ],
         [ :profile_update, 'data' =>
           { '$token' => 'TEST TOKEN',
             '$distinct_id' => 'ID',
             '$time' => @time_now.to_i * 1000,
-            '$append' => { 'k' => 'v' }
+            '$append' => {'k' => 'v'}
           }
         ]
     ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2014-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -71,6 +71,7 @@ files:
 - LICENSE
 - Rakefile
 - Readme.rdoc
+- demo/faraday_consumer.rb
 - demo/out_of_process_consumer.rb
 - demo/simple_messages.rb
 - lib/mixpanel-ruby.rb