mixpanel-ruby 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+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,33 @@
+= 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:
+
+== 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.
+
+
+
+

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,153 @@
+require 'base64'
+require 'net/https'
+
+module Mixpanel
+  class ConnectionError < IOError
+  end
+
+  @@init_http = nil
+
+  # 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.
+  # For example, if running in Ubuntu Linux, you can run
+  #
+  #    Mixpanel::use_ssl 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 or :profile_update
+  #        @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
+    def initialize(events_endpoint=nil, update_endpoint=nil)
+      @events_endpoint = events_endpoint || 'https://api.mixpanel.com/track'
+      @update_endpoint = update_endpoint || 'https://api.mixpanel.com/engage'
+    end
+
+    # Send the given string message to Mixpanel. Type should be
+    # one of :event or :profile_update, which will determine the endpoint.
+    def send(type, message)
+      type = type.to_sym
+      endpoint = {
+        :event => @events_endpoint,
+        :profile_update => @update_endpoint,
+      }[ type ]
+      data = Base64.strict_encode64(message)
+      uri = URI(endpoint)
+
+      client = Net::HTTP.new(uri.host, uri.port)
+      client.use_ssl = true
+      Mixpanel.with_http(client)
+
+      request = Net::HTTP::Post.new(uri.request_uri)
+      request.set_form_data({"data" => data })
+      response = client.request(request)
+
+      if response.code == '200' and response.body == '1'
+        return true
+      else
+        raise ConnectionError.new('Could not write to Mixpanel')
+      end
+    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
+
+    def initialize(events_endpoint=nil, update_endpoint=nil, max_buffer_length=MAX_LENGTH)
+      @max_length = [ max_buffer_length, MAX_LENGTH ].min
+      @consumer = Consumer.new(events_endpoint, update_endpoint)
+      @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.
+    def send(type, message)
+      type = type.to_sym
+      @buffers[type] << message
+      if @buffers[type].length >= @max_length
+        flush_type(type)
+      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|
+        message = "[ #{chunk.join(',')} ]"
+        @consumer.send(type, message)
+      end
+      @buffers[type] = []
+    end
+  end
+
+  private
+  def self.with_http(http)
+    if @@init_http
+      @@init_http.call(http)
+    end
+  end
+end

data/lib/mixpanel-ruby/events.rb

@@ -0,0 +1,68 @@
+require 'mixpanel-ruby/consumer'
+require 'time'
+
+module Mixpanel
+
+  # Handles formatting Mixpanel event tracking messages
+  # and sending them to the consumer. Mixpanel::Tracker
+  # is a subclass of this class, and the best way to
+  # track events is to instantiate a Mixpanel::Tracker
+  #
+  #     tracker = Mixpanel::Tracker.new # Has all of the methods of Mixpanel::Event
+  #     tracker.track(...)
+  #
+  class Events
+
+    # You likely won't need to instantiate an instance of
+    # Mixpanel::Events directly. The best way to get an instance
+    # is to use Mixpanel::Tracker
+    #
+    #     # tracker has all of the methods of Mixpanel::Events
+    #     tracker = Mixpanel::Tracker.new(...)
+    #
+    def initialize(token, &block)
+      @token = token
+      if block
+        @sink = block
+      else
+        consumer = Consumer.new
+        @sink = consumer.method(:send)
+      end
+    end
+
+    # Notes that an event has occurred, along with 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.
+    #
+    #     tracker = Mixpanel::Tracker.new
+    #
+    #     # Track that user "12345"'s credit card was declined
+    #     tracker.track("12345", "Credit Card Declined")
+    #
+    #     # Properties describe the circumstances of the event,
+    #     # or aspects of the source or user associated with the event
+    #     tracker.track("12345", "Welcome Email Sent", {
+    #         'Email Template' => 'Pretty Pink Welcome',
+    #         'User Sign-up Cohort' => 'July 2013'
+    #     })
+    def track(distinct_id, event, properties={}, ip=nil)
+      properties = {
+          'distinct_id' => distinct_id,
+          'token' => @token,
+          'time' => Time.now.to_i
+      }.merge(properties)
+      if ip
+        properties['ip'] = ip
+      end
+
+      message = {
+          'event' => event,
+          'properties' => properties
+      }
+
+      @sink.call(:event, message.to_json)
+    end
+  end
+end

data/lib/mixpanel-ruby/people.rb

@@ -0,0 +1,243 @@
+require 'mixpanel-ruby/consumer'
+require 'json'
+require 'date'
+require 'time'
+
+module Mixpanel
+
+  # Handles formatting Mixpanel profile updates and
+  # sending them to the consumer. You will rarely need
+  # to instantiate this class directly- to send
+  # profile updates, use Mixpanel::Tracker#people
+  #
+  #     tracker = Mixpanel::Tracker.new
+  #     tracker.people.set(...) # Or .append(..), or track_charge(...) etc.
+  class People
+
+    # You likely won't need to instantiate instances of Mixpanel::People
+    # directly. The best way to get an instance of Mixpanel::People is
+    #
+    #     tracker = Mixpanel::Tracker.new(...)
+    #     tracker.people # An instance of Mixpanel::People
+    #
+    def initialize(token, &block)
+      @token = token
+      if block
+        @sink = block
+      else
+        consumer = Consumer.new
+        @sink = consumer.method(:send)
+      end
+    end
+
+    # Sets properties on a user record. Takes a Hash with string
+    # keys, and values that are strings, numbers, booleans, or
+    # DateTimes
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    # Sets properties on profile with id "1234"
+    #    tracker.people.set("1234", {
+    #        'company' => 'Acme',
+    #        'plan' => 'Premium',
+    #        'Sign-Up Date' => DateTime.now
+    #    });
+    #
+    # If you provide an ip argument, Mixpanel will use that
+    # ip address for geolocation (rather than the ip of your server)
+    def set(distinct_id, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      message = {
+          '$distinct_id' => distinct_id,
+          '$set' => properties,
+      }
+
+      if ip
+        message['$ip'] = ip
+      end
+
+      update(message)
+    end
+
+    # set_once works just like #set, but will only change the
+    # value of properties if they are not already present
+    # in the profile. That means you can call set_once many times
+    # without changing an original value.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    tracker.people.set("12345", {
+    #        'First Login Date': DateTime.now
+    #    });
+    #
+    def set_once(distinct_id, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      message = {
+          '$distinct_id' => distinct_id,
+          '$set_once' => properties,
+      }
+
+      if ip
+        message['$ip'] = ip
+      end
+
+      update(message)
+    end
+
+    # Changes the value of properties by a numeric amount.  Takes a
+    # hash with string keys and numeric properties.  Mixpanel will add
+    # the given amount to whatever value is currently assigned to the
+    # property. If no property exists with a given name, the value
+    # will be added to zero.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    tracker.people.set("12345", {
+    #        'Coins Spent' => 7,
+    #        'Coins Earned' => -7, # Use a negative number to subtract
+    #    });
+    #
+    def increment(distinct_id, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      message = {
+          '$distinct_id' => distinct_id,
+          '$add' => properties,
+      }
+
+      if ip
+        message['$ip'] = ip
+      end
+
+      update(message)
+    end
+
+    # Appends a values to the end of list-valued properties.
+    # If the given properties don't exist, a new list-valued
+    # property will be created.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    tracker.people.append("12345", {
+    #        'Login Dates' => DateTime.now,
+    #        'Alter Ego Names' => 'Ziggy Stardust'
+    #    });
+    #
+    def append(distinct_id, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      message = {
+          '$distinct_id' => distinct_id,
+          '$append' => properties,
+      }
+
+      if ip
+        message['$ip'] = ip
+      end
+
+      update(message)
+    end
+
+    # Appends a value to the end of list-valued properties,
+    # only if the given value is not already present in the list.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    tracker.people.union("12345", {
+    #        'Levels Completed' => 'Suffragette City'
+    #    });
+    #
+    def union(distinct_id, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      message = {
+          '$distinct_id' => distinct_id,
+          '$union' => properties,
+      }
+
+      if ip
+        message['$ip'] = ip
+      end
+
+      update(message)
+    end
+
+    # Removes a property and it's value from a profile.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #    tracker.people.unset("12345", "Overdue Since")
+    #
+    def unset(distinct_id, property)
+      update({
+          '$distinct_id' => distinct_id,
+          '$unset' => [ property ]
+      })
+    end
+
+    # Records a payment to you to a profile. Charges recorded with
+    # #track_charge will appear in the Mixpanel revenue report.
+    #
+    #    tracker = Mixpanel::Tracker.new
+    #
+    #    # records a charge of $25.32 from user 12345
+    #    tracker.people.track_charge("12345", 25.32)
+    #
+    #    # records a charge of $30.50 on the 2nd of January,
+    #    mixpanel.people.track_charge("12345", 30.50, {
+    #        '$time' => DateTime.parse("Jan 2 2013")
+    #    })
+    #
+    def track_charge(distinct_id, amount, properties, ip=nil)
+      properties = fix_property_dates(properties)
+      charge_properties = properties.merge({ '$amount' => amount })
+      append(distinct_id, { '$transactions' => charge_properties }, ip)
+    end
+
+    # Clear all charges from a Mixpanel people profile
+    def clear_charges(distinct_id)
+      unset(distinct_id, '$transactions')
+    end
+
+    # Permanently delete a profile from Mixpanel people analytics
+    def delete_user(distinct_id)
+      update({
+          '$distinct_id' => distinct_id,
+          '$delete' => ''
+      })
+    end
+
+    # Send a generic update to Mixpanel people analytics.
+    # Caller is responsible for formatting the update, as
+    # documented in the Mixpanel HTTP specification. This
+    # method might be useful if you want to use very new
+    # or experimental features of people analytics from Ruby
+    # The Mixpanel HTTP tracking API is documented at
+    # http://joe.dev.mixpanel.org/help/reference/http
+    def update(message)
+      message = {
+          '$token' => @token,
+          '$time' =>  ((Time.now.to_f) * 1000.0).to_i
+      }.merge(message)
+      @sink.call(:profile_update, message.to_json)
+    end
+
+    private
+
+    def fix_property_dates(h)
+      h.inject({}) do |ret,(k,v)|
+        ret[k] = PeopleDate.asPeopleDate(v)
+        ret
+      end
+    end
+
+    class PeopleDate
+      def initialize(date)
+        @date = date
+      end
+
+      def to_json(*a)
+        @date.strftime('%Y-%m-%dT%H:%M:%S').to_json(*a)
+      end
+
+      def self.asPeopleDate(thing)
+        if thing.is_a?(Date)
+          PeopleDate.new(thing)
+        else
+          thing
+        end
+      end
+    end
+  end
+end

data/lib/mixpanel-ruby/tracker.rb

@@ -0,0 +1,61 @@
+require 'mixpanel-ruby/events.rb'
+require 'mixpanel-ruby/people.rb'
+
+module Mixpanel
+  # Use Mixpanel::Tracker to track events and profile updates in your application.
+  # To track an event, call
+  #
+  #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+  #     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 })
+  #
+  # Mixpanel::Tracker is a subclass of Mixpanel::Events, and exposes
+  # an instance of Mixpanel::People as Tracker#people
+  class Tracker < Events
+    # An instance of Mixpanel::People. Use this to
+    # send profile updates
+    attr_reader :people
+
+    # Takes your Mixpanel project token, as a string.
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #
+    # By default, the tracker will send an message to Mixpanel
+    # synchronously with each call, using an instance of Mixpanel::Consumer.
+    #
+    # You can also provide a block to the constructor
+    # to specify particular consumer behaviors (for
+    # example, if you wanted to write your messages to
+    # a queue instead of sending them directly to Mixpanel)
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN) do |type, message|
+    #        @kestrel.set(MY_MIXPANEL_QUEUE, [type,message].to_json)
+    #    end
+    #
+    # If a block is provided, it is passed a type (one of :event or :profile_update)
+    # and a string message. This same format is accepted by Mixpanel::Consumer#send
+    # and Mixpanel::BufferedConsumer#send
+    def initialize(token, &block)
+      super(token, &block)
+      @people = People.new(token, &block)
+    end
+
+
+    # Creates a distinct_id alias. \Events and updates with an alias
+    # will be considered by mixpanel to have the same source, and
+    # refer to the same profile.
+    #
+    # Multiple aliases can map to the same real_id, once a real_id is
+    # used to track events or send updates, it should never be used as
+    # an alias itself.
+    def alias(alias_id, real_id)
+      track(real_id, '$create_alias', {
+          'alias' => alias_id
+      })
+    end
+  end
+end

data/lib/mixpanel-ruby/version.rb

@@ -0,0 +1,3 @@
+module Mixpanel
+  VERSION = '0.1.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'
+  spec.version = Mixpanel::VERSION
+  spec.files = Dir.glob(`git ls-files`.split("\n"))
+  spec.require_paths = ['lib']
+  spec.summary = 'Official Mixpanel tracking library for ruby'
+  spec.description = 'The official Mixpanel tracking library for ruby'
+  spec.authors = [ 'Mixpanel' ]
+  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,54 @@
+require 'spec_helper'
+require 'webmock'
+require 'base64'
+require 'mixpanel-ruby/consumer'
+
+describe Mixpanel::Consumer do
+  before(:each) do
+    WebMock.reset!
+    @consumer = Mixpanel::Consumer.new
+  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" })
+    @consumer.send(:event, 'TEST EVENT MESSAGE')
+    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+      with(:body => {'data' => 'VEVTVCBFVkVOVCBNRVNTQUdF' })
+  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" })
+    @consumer.send(:profile_update, 'TEST EVENT MESSAGE')
+    WebMock.should have_requested(:post, 'https://api.mixpanel.com/engage').
+      with(:body => {'data' => 'VEVTVCBFVkVOVCBNRVNTQUdF' })
+  end
+end
+
+describe Mixpanel::BufferedConsumer do
+  before(:each) do
+    WebMock.reset!
+    @max_length = 10
+    @consumer = Mixpanel::BufferedConsumer.new(nil, nil, @max_length)
+  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" })
+    @consumer.send(:event, 'TEST EVENT 1')
+    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' => 'WyBURVNUIEVWRU5UIDEgXQ==' })
+  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" })
+
+    @max_length.times do |i|
+      @consumer.send(:event, "x #{i}")
+    end
+
+    WebMock.should have_requested(:post, 'https://api.mixpanel.com/track').
+      with(:body => {'data' => 'WyB4IDAseCAxLHggMix4IDMseCA0LHggNSx4IDYseCA3LHggOCx4IDkgXQ==' })
+  end
+end

data/spec/mixpanel-ruby/events_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'mixpanel-ruby/events.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, {
+        'event' => 'Test Event',
+        'properties' => {
+            'Circumstances' => 'During a test',
+            'distinct_id' => 'TEST ID',
+            'token' => 'TEST TOKEN',
+            'time' => 76695784
+        }
+    }]])
+  end
+end
+

data/spec/mixpanel-ruby/people_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+require 'date'
+require 'json'
+require 'mixpanel-ruby/people.rb'
+
+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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$set' => {
+            '$firstname' => 'David',
+            '$lastname' => 'Bowie'
+        }
+    }]])
+  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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$add' => {
+            'Albums Released' => 10
+        }
+    }]])
+  end
+
+  it 'should send a well formed engage/append message' do
+    @people.append("TEST ID", { 'Albums' => 'Diamond Dogs' })
+    @log.should eq([[ :profile_update, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$union' => {
+            'Albums' => 'Diamond Dogs'
+        }
+    }]])
+  end
+
+  it 'should send a well formed unset message' do
+    @people.unset('TEST ID', 'Albums')
+    @log.should eq([[ :profile_update, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$unset' => [ 'Albums' ]
+    }]])
+  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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$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, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$unset' => [ '$transactions' ]
+    }]])
+  end
+
+  it 'should send a well formed engage/delete message' do
+    @people.delete_user("TEST ID")
+    @log.should eq([[ :profile_update, {
+        '$token' => 'TEST TOKEN',
+        '$distinct_id' => 'TEST ID',
+        '$time' => 76695784000,
+        '$delete' => ''
+    }]])
+  end
+end

data/spec/mixpanel-ruby/tracker_spec.rb

@@ -0,0 +1,90 @@
+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 a well formed alias message' do
+    log = []
+    mixpanel = Mixpanel::Tracker.new('TEST TOKEN') do |type, message|
+      log << [ type, JSON.load(message) ]
+    end
+    mixpanel.alias('TEST ALIAS', 'TEST ID')
+    log.should eq([[ :event, {
+        'event' => '$create_alias',
+        'properties' => {
+            'alias' => 'TEST ALIAS',
+            'distinct_id' => 'TEST ID',
+            'token' => 'TEST TOKEN',
+            'time' => 76695784
+        }
+    }]])
+  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" })
+    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',
+            'token' => 'TEST TOKEN',
+            'time' => 76695784
+        }
+    })
+  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.people.set('ID', { 'k' => 'v' })
+    mixpanel.people.append('ID', { 'k' => 'v' })
+
+    messages.should eq([
+        [ :event,
+          { 'event' => 'Event',
+            'properties' => {
+              'distinct_id' => 'ID',
+              'token' => 'TEST TOKEN',
+              'time' => 76695784
+            }
+          }
+        ],
+        [ :profile_update,
+          { '$token' => 'TEST TOKEN',
+            '$distinct_id' => 'ID',
+            '$time' => 76695784000,
+            '$set' => { 'k' => 'v' }
+          }
+        ],
+        [ :profile_update,
+          { '$token' => 'TEST TOKEN',
+            '$distinct_id' => 'ID',
+            '$time' => 76695784000,
+            '$append' => { 'k' => 'v' }
+          }
+        ]
+    ])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'json'
+require 'webmock/rspec'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: mixpanel-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mixpanel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The official Mixpanel tracking library for ruby
+email: support@mixpanel.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.rdoc
+- demo/out_of_process_consumer.rb
+- demo/simple_messages.rb
+- lib/mixpanel-ruby.rb
+- lib/mixpanel-ruby/consumer.rb
+- lib/mixpanel-ruby/events.rb
+- lib/mixpanel-ruby/people.rb
+- lib/mixpanel-ruby/tracker.rb
+- lib/mixpanel-ruby/version.rb
+- mixpanel-ruby.gemspec
+- spec/mixpanel-ruby/consumer_spec.rb
+- spec/mixpanel-ruby/events_spec.rb
+- spec/mixpanel-ruby/people_spec.rb
+- spec/mixpanel-ruby/tracker_spec.rb
+- spec/spec_helper.rb
+homepage: https://mixpanel.com/help/reference/ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Official Mixpanel tracking library for ruby
+test_files: []