mixpanel-ruby-with-pixel-tracking 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d4ba4e0efa7356ed86c7d5ea079836a1c22dfb5
+  data.tar.gz: 80a6454f9dc22b5602199458cae0b527d841a5ee
+SHA512:
+  metadata.gz: 3ec9803cccf0dc2ef3c022ed8c4fbd7b3e6245a348a64035aa40b6e88416cb39263499d55d1d33ce9ccd2daf4be9e50f42b4981c84e9b0e8464d91065c33b94e
+  data.tar.gz: 20cf182a055aa6f34675672df0c6cf320efd50d1f43e709d5d2269322c788378118d3afae35f20cbcb413d1bb987bcf2c32ab1dfbeebdedc890699742b7b4221

data/.gitignore

@@ -0,0 +1,4 @@
+*~
+Gemfile.lock
+html
+mixpanel-ruby*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,190 @@
+Copyright 2012 Mixpanel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License below, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+Rake::RDocTask.new do |rd|
+  rd.main = "Readme.rdoc"
+  rd.rdoc_files.include("Readme.rdoc", "lib/**/*.rb")
+end
+
+task :default => :spec

data/Readme.rdoc

@@ -0,0 +1,76 @@
+= 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.
+
+== Installation
+
+    gem install mixpanel-ruby
+
+== Getting Started
+
+    require 'mixpanel-ruby'
+
+    tracker = Mixpanel::Tracker.new(YOUR_TOKEN)
+
+    # Track an event on behalf of user "User1"
+    tracker.track('User1', 'A Mixpanel Event')
+
+    # Send an update to User1's profile
+    tracker.people.set('User1', {
+        '$first_name' => 'David',
+        '$last_name' => 'Bowie',
+        'Best Album' => 'The Rise and Fall of Ziggy Stardust and the Spiders from Mars'
+    })
+
+The primary class you will use to track events is Mixpanel::Tracker. An instance of
+Mixpanel::Tracker is enough to send events directly to \Mixpanel, and get you integrated
+right away.
+
+== Additional Information
+
+For more information please visit:
+
+* Our Ruby API Integration page[https://mixpanel.com/help/reference/ruby#introduction]
+* The usage demo[https://github.com/mixpanel/mixpanel-ruby/tree/master/demo]
+* The documentation[http://mixpanel.github.io/mixpanel-ruby/]
+
+The official Mixpanel gem is built with simplicity and broad applicability in
+mind, but there are also third party Ruby libraries that can work with the library
+to provide useful features in common situations. One in particular is
+MetaEvents[https://github.com/swiftype/meta_events], a third party gem 
+which provides support for client-side tracking in Rails applications,
+super-properties-like persistent properties, and a DSL for defining your events.
+
+== Changes
+
+== 1.4.0
+* Allow unset to unset multiple properties
+
+== 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.
+
+== 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)
+
+=== 1.0.1
+* Compatibility with earlier versions of ruby. Library development will continue
+  to target 1.9, so later versions may not be compatible with Ruby 1.8, but we
+  love patches!
+
+=== 1.0.0
+* tracker#import added
+* Change to internal tracking message format. Messages written
+  by earlier versions of the library will not work with 1.0.0 consumer classes.
+* alias bugfixed
+* Fixes to tests to allow for different timezones
+* Support for optional/experimental people api properties in people calls

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

@@ -0,0 +1,71 @@
+require 'mixpanel-ruby'
+require 'thread'
+require 'json'
+require 'securerandom'
+
+# As your application scales, it's likely you'll want to
+# to detect events in one place and send them somewhere
+# else. For example, you might write the events to a queue
+# to be consumed by another process.
+#
+# This demo shows how you might do things, using
+# the block constructor in Mixpanel to enqueue events,
+# and a MixpanelBufferedConsumer to send them to
+# Mixpanel
+
+# Mixpanel uses the Net::HTTP library, which by default
+# will not verify remote SSL certificates. In your app,
+# you'll need to call Mixpanel.config_http with the path
+# to your Certificate authority resources, or the library
+# won't verify the remote certificate identity.
+Mixpanel.config_http do |http|
+  http.ca_path = '/etc/ssl/certs'
+  http.ca_file = "/etc/ssl/certs/ca-certificates.crt"
+  http.use_ssl = true
+  http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+end
+
+class OutOfProcessExample
+  class << self
+    def run(token, distinct_id)
+      open('|-', 'w+') do |subprocess|
+        if subprocess
+          # This is the tracking process. Once we configure
+          # The tracker to write to our subprocess, we can quickly
+          # call #track without delaying our other work.
+          mixpanel_tracker = Mixpanel::Tracker.new(token) do |*message|
+            subprocess.write(message.to_json + "\n")
+          end
+
+          100.times do |i|
+            event = 'Tick'
+            mixpanel_tracker.track(distinct_id, event, {'Tick Number' => i})
+            puts "tick #{i}"
+          end
+
+        else
+          # This is the consumer process. In your applications, code
+          # like this may end up in queue consumers or in a separate
+          # thread.
+          mixpanel_consumer = Mixpanel::BufferedConsumer.new
+          begin
+            $stdin.each_line do |line|
+              message = JSON.load(line)
+              type, content = message
+              mixpanel_consumer.send(type, content)
+            end
+          ensure
+            mixpanel_consumer.flush
+          end
+        end
+      end
+    end # run
+  end
+end
+
+if __FILE__ == $0
+  # Replace this with the token from your project settings
+  DEMO_TOKEN = '072f77c15bd04a5d0044d3d76ced7fea'
+  run_id = SecureRandom.base64
+  OutOfProcessExample.run(DEMO_TOKEN, run_id)
+end

data/demo/simple_messages.rb

@@ -0,0 +1,8 @@
+require 'mixpanel-ruby'
+
+if __FILE__ == $0
+  # Replace this with the token from your project settings
+  DEMO_TOKEN = '072f77c15bd04a5d0044d3d76ced7fea'
+  mixpanel_tracker = Mixpanel::Tracker.new(DEMO_TOKEN)
+  mixpanel_tracker.track('ID', 'Script run')
+end

data/lib/mixpanel-ruby.rb

@@ -0,0 +1,3 @@
+require 'mixpanel-ruby/consumer.rb'
+require 'mixpanel-ruby/tracker.rb'
+require 'mixpanel-ruby/version.rb'

data/lib/mixpanel-ruby/consumer.rb

@@ -0,0 +1,240 @@
+require 'base64'
+require 'net/https'
+require 'json'
+
+module Mixpanel
+  class ConnectionError < IOError
+  end
+
+  @@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.config_http that configures the Net::HTTP object.
+  # For example, if running in Ubuntu Linux, you can run
+  #
+  #    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
+  #    end
+  #
+  # \Mixpanel Consumer and BufferedConsumer will call your block
+  # to configure their connections
+  def self.config_http(&block)
+    @@init_http = block
+  end
+
+  # A Consumer recieves 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.
+  #
+  # You can provide your own consumer to your Mixpanel::Trackers,
+  # either by passing in an argument with a #send method when you construct
+  # the tracker, or just passing a block to Mixpanel::Tracker.new
+  #
+  #    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)
+  #    end
+  #
+  # You can also instantiate the library consumers yourself, and use
+  # them wherever you would like. For example, the working that
+  # consumes the above queue might work like this:
+  #
+  #     mixpanel = Mixpanel::Consumer
+  #     while true
+  #         message_json = @kestrel.get(ANALYTICS_QUEUE)
+  #         mixpanel.send(*JSON.load(message_json))
+  #     end
+  #
+  # Mixpanel::Consumer is the default consumer. It sends each message,
+  # as the message is recieved, directly to Mixpanel.
+  class Consumer
+
+    # Create a Mixpanel::Consumer. If you provide endpoint arguments,
+    # they will be used instead of the default Mixpanel endpoints.
+    # This can be useful for proxying, debugging, or if you prefer
+    # not to use SSL for your events.
+    def initialize(events_endpoint=nil, update_endpoint=nil, import_endpoint=nil)
+      @events_endpoint = events_endpoint || 'https://api.mixpanel.com/track'
+      @update_endpoint = update_endpoint || 'https://api.mixpanel.com/engage'
+      @import_endpoint = import_endpoint || 'https://api.mixpanel.com/import'
+    end
+
+    # Send the given string message to Mixpanel. Type should be
+    # one of :event, :profile_update or :import, which will determine the endpoint.
+    #
+    # Mixpanel::Consumer#send sends messages to Mixpanel immediately on
+    # each call. To reduce the overall bandwidth you use when communicating
+    # with Mixpanel, you can also use Mixpanel::BufferedConsumer
+    def send(type, message, as_pixel = false)
+      type = type.to_sym
+      endpoint = {
+        :event => @events_endpoint,
+        :profile_update => @update_endpoint,
+        :import => @import_endpoint
+      }[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
+
+      if as_pixel
+        form_data.merge!("img" => 1)
+        return generate_tracking_url(endpoint, form_data)
+      end
+
+      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 receives 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)
+
+      response = client.request(request)
+      [response.code, response.body]
+    end
+
+
+
+    # Generate_tracking_url takes an endpoint HTTP or HTTPS url, and a Hash of data
+    # to post to that url. It should return a string for the tracking url:
+    #
+    # pixel_tracking_url
+
+    def generate_tracking_url(endpoint, form_data)
+      uri = URI(endpoint)
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.set_form_data(form_data)
+      "#{endpoint}?#{request.body}"
+    end
+  end
+
+  # BufferedConsumer buffers messages in memory, and sends messages as
+  # a batch.  This can improve performance, but calls to #send may
+  # still block if the buffer is full.  If you use this consumer, you
+  # should call #flush when your application exits or the messages
+  # remaining in the buffer will not be sent.
+  #
+  # To use a BufferedConsumer directly with a Mixpanel::Tracker,
+  # instantiate your Tracker like this
+  #
+  #    buffered_consumer = Mixpanel::BufferedConsumer.new
+  #    begin
+  #        buffered_tracker = Mixpanel::Tracker.new(YOUR_TOKEN) do |type, message|
+  #            buffered_consumer.send(type, message)
+  #        end
+  #        # Do some tracking here
+  #        ...
+  #    ensure
+  #        buffered_consumer.flush
+  #    end
+  #
+  class BufferedConsumer
+    MAX_LENGTH = 50
+
+    # Create a Mixpanel::BufferedConsumer. If you provide endpoint arguments,
+    # they will be used instead of the default Mixpanel endpoints.
+    # This can be useful for proxying, debugging, or if you prefer
+    # not to use SSL for your events.
+    #
+    # You can also change the preferred buffer size before the
+    # 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.
+    #
+    # 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 => [],
+      }
+    end
+
+    # Stores a message for Mixpanel in memory. When the buffer
+    # hits a maximum length, the consumer will flush automatically.
+    # Flushes are synchronous when they occur.
+    #
+    # Currently, only :event and :profile_update messages are buffered,
+    # :import messages will be send immediately on call.
+    def send(type, message)
+      type = type.to_sym
+      if @buffers.has_key? type
+        @buffers[type] << message
+        if @buffers[type].length >= @max_length
+          flush_type(type)
+        end
+      else
+        @sink.call(type, message)
+      end
+    end
+
+    # Pushes all remaining messages in the buffer to Mixpanel.
+    # You should call #flush before your application exits or
+    # messages may not be sent.
+    def flush
+      @buffers.keys.each { |k| flush_type(k) }
+    end
+
+    private
+
+    def flush_type(type)
+      @buffers[type].each_slice(@max_length) do |chunk|
+        data = chunk.map {|message| JSON.load(message)['data'] }
+        @sink.call(type, {'data' => data}.to_json)
+      end
+      @buffers[type] = []
+    end
+  end
+
+  private
+  def self.with_http(http)
+    if @@init_http
+      @@init_http.call(http)
+    end
+  end
+end