mixpanel-ruby 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51973ff0dbb444c35e3c971e1c2bea676b511795f50afa1972319ba2f35acda5
-  data.tar.gz: 20b2c55a765a2bbfe0cdf03a94767d8ab1415abf4a7f1ac8d82b53f53c34dc38
+  metadata.gz: 528783e14b23218c322ec9513d2a7ba3112a41b54b53d9dd0cd2abeed7630b54
+  data.tar.gz: 5aded14afb1a1fca08fe5a02e386347edb665edc871677adf849a47af12658a2
 SHA512:
-  metadata.gz: b7c80d420403a94fc63f5df839110bdb05033f208748cebb86aea6d92dc94d9edd8456978820214725040b0abe1eb58276185c4d15d352850d9bf07df1cd0254
-  data.tar.gz: aad34a8e509085e21c89d274d0ac3a5caabaf89133891ed93c8a2b836f409e2797668a4f057d4f90a119ac792964b5fa62be0cb35bfa45db74bfe3fda46aaa47
+  metadata.gz: 58cdf71f0d7b8dfdcd85919fa6105694c24732a20b5f637b9e907d6fa5cb7d55c30e8f1ddd92d791708bf8425d0c886043bad13ccdf8dada91d8b2f6e328a235
+  data.tar.gz: 3aee5d979f1a9f27ef93a7acbf20acdf23341c653bf234b0a6fe55b619d73e57c5ef544b8e22e51b0ace0d958e48414c34c71274e18bf258b497416d48e69b0a

data/Readme.rdoc

@@ -49,6 +49,9 @@ In particular, for Rails apps, the following projects are currently actively mai
 
 == Changes
 
+== 2.2.2
+* Add Group Analytics support with Mixpanel::Groups
+
 == 2.2.1
 * Fix buffer clearing on partially successful writes in BufferedConsumer.
 

data/lib/mixpanel-ruby/consumer.rb

@@ -58,9 +58,13 @@ module Mixpanel
     # 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)
+    def initialize(events_endpoint=nil,
+                   update_endpoint=nil,
+                   groups_endpoint=nil,
+                   import_endpoint=nil)
       @events_endpoint = events_endpoint || 'https://api.mixpanel.com/track'
       @update_endpoint = update_endpoint || 'https://api.mixpanel.com/engage'
+      @groups_endpoint = groups_endpoint || 'https://api.mixpanel.com/groups'
       @import_endpoint = import_endpoint || 'https://api.mixpanel.com/import'
     end
 
@@ -75,6 +79,7 @@ module Mixpanel
       endpoint = {
         :event => @events_endpoint,
         :profile_update => @update_endpoint,
+        :group_update => @groups_endpoint,
         :import => @import_endpoint,
       }[type]
 

data/lib/mixpanel-ruby/groups.rb

@@ -0,0 +1,201 @@
+require 'date'
+require 'json'
+require 'time'
+
+require 'mixpanel-ruby/consumer'
+require 'mixpanel-ruby/error'
+
+module Mixpanel
+
+  # Handles formatting Mixpanel group updates and
+  # sending them to the consumer. You will rarely need
+  # to instantiate this class directly- to send
+  # group updates, use Mixpanel::Tracker#groups
+  #
+  #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+  #     tracker.groups.set(...) or .set_once(..), or .delete(...) etc.
+  class Groups
+
+    # You likely won't need to instantiate instances of Mixpanel::Groups
+    # directly. The best way to get an instance of Mixpanel::Groups is
+    #
+    #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #     tracker.groups # An instance of Mixpanel::Groups
+    #
+    def initialize(token, error_handler=nil, &block)
+      @token = token
+      @error_handler = error_handler || ErrorHandler.new
+
+      if block
+        @sink = block
+      else
+        consumer = Consumer.new
+        @sink = consumer.method(:send!)
+      end
+    end
+
+    # Sets properties on a group record. Takes a Hash with string
+    # keys, and values that are strings, numbers, booleans, or
+    # DateTimes
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #    # Sets properties on group with id "1234"
+    #    tracker.groups.set("GROUP KEY", "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(group_key, group_id, properties, ip=nil, optional_params={})
+      properties = fix_property_dates(properties)
+      message = {
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$set' => properties,
+      }.merge(optional_params)
+      message['$ip'] = ip if ip
+
+      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 group. That means you can call set_once many times
+    # without changing an original value.
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #    tracker.groups.set_once("GROUP KEY", "1234", {
+    #        'First Login Date': DateTime.now
+    #    });
+    #
+    def set_once(group_key, group_id, properties, ip=nil, optional_params={})
+      properties = fix_property_dates(properties)
+      message = {
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$set_once' => properties,
+      }.merge(optional_params)
+      message['$ip'] = ip if ip
+
+      update(message)
+    end
+
+    # Removes a specific value in a list property
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #
+    #    # removes "socks" from the "Items purchased" list property
+    #    # for the specified group
+    #    tracker.groups.remove("GROUP KEY", "1234", { 'Items purchased' => 'socks' })
+    #
+    def remove(group_key, group_id, properties, ip=nil, optional_params={})
+      properties = fix_property_dates(properties)
+      message = {
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$remove' => properties,
+      }.merge(optional_params)
+      message['$ip'] = ip if ip
+
+      update(message)
+    end
+
+    # Set union on list valued properties.
+    # Associates a list containing all elements of a given list,
+    # and all elements currently in a list associated with the given
+    # property. After a union, every element in the list associated
+    # with a property will be unique.
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #    tracker.groups.union("GROUP KEY", "1234", {
+    #        'Levels Completed' => ['Suffragette City']
+    #    });
+    #
+    def union(group_key, group_id, properties, ip=nil, optional_params={})
+      properties = fix_property_dates(properties)
+      message = {
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$union' => properties,
+      }.merge(optional_params)
+      message['$ip'] = ip if ip
+
+      update(message)
+    end
+
+    # Removes properties and their values from a group.
+    #
+    #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+    #
+    #    # removes a single property and its value from a group
+    #    tracker.groups.unset("GROUP KEY", "1234", "Overdue Since")
+    #
+    #    # removes multiple properties and their values from a group
+    #    tracker.groups.unset("GROUP KEY",
+    #                         "1234",
+    #                         ["Overdue Since", "Paid Date"])
+    #
+    def unset(group_key, group_id, properties, ip=nil, optional_params={})
+      properties = [properties] unless properties.is_a?(Array)
+      message = {
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$unset' => properties,
+      }.merge(optional_params)
+      message['$ip'] = ip if ip
+
+      update(message)
+    end
+
+    # Permanently delete a group from \Mixpanel groups analytics (all group
+    # properties on events stay)
+    def delete_group(group_key, group_id, optional_params={})
+      update({
+        '$group_key' => group_key,
+        '$group_id' => group_id,
+        '$delete' => '',
+      }.merge(optional_params))
+    end
+
+    # Send a generic update to \Mixpanel groups analytics.
+    # Caller is responsible for formatting the update message, as
+    # documented in the \Mixpanel HTTP specification, and passing
+    # the message as a dict to #update. This
+    # method might be useful if you want to use very new
+    # or experimental features of groups analytics from Ruby
+    # The \Mixpanel HTTP tracking API is documented at
+    # https://mixpanel.com/help/reference/http
+    def update(message)
+      data = {
+        '$token' => @token,
+        '$time' =>  ((Time.now.to_f) * 1000.0).to_i,
+      }.merge(message)
+
+      message = {'data' => data}
+
+      ret = true
+      begin
+        @sink.call(:group_update, message.to_json)
+      rescue MixpanelError => e
+        @error_handler.handle(e)
+        ret = false
+      end
+
+      ret
+    end
+
+    private
+
+    def fix_property_dates(properties)
+      properties.inject({}) do |ret, (key, value)|
+        value = value.respond_to?(:new_offset) ? value.new_offset('0') : value
+        value = value.respond_to?(:utc) ? value.utc : value  # Handle ActiveSupport::TimeWithZone
+
+        ret[key] = value.respond_to?(:strftime) ? value.strftime('%Y-%m-%dT%H:%M:%S') : value
+        ret
+      end
+    end
+  end
+end

data/lib/mixpanel-ruby/tracker.rb

@@ -1,5 +1,6 @@
 require 'mixpanel-ruby/events.rb'
 require 'mixpanel-ruby/people.rb'
+require 'mixpanel-ruby/groups.rb'
 
 module Mixpanel
   # Use Mixpanel::Tracker to track events and profile updates in your application.
@@ -13,16 +14,25 @@ module Mixpanel
   #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
   #     tracker.people.set(a_distinct_id, {properties})
   #
+  # To send groups updates, call
+  #
+  #     tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
+  #     tracker.groups.set(group_key, group_id, {properties})
+  #
   # You can find your project token in the settings dialog for your
   # project, inside of the Mixpanel web application.
   #
   # Mixpanel::Tracker is a subclass of Mixpanel::Events, and exposes
   # an instance of Mixpanel::People as Tracker#people
+  # and an instance of Mixpanel::Groups as Tracker#groups
   class Tracker < Events
     # An instance of Mixpanel::People. Use this to
     # send profile updates
     attr_reader :people
 
+    # An instance of Mixpanel::Groups. Use this to send groups updates
+    attr_reader :groups
+
     # Takes your Mixpanel project token, as a string.
     #
     #    tracker = Mixpanel::Tracker.new(YOUR_MIXPANEL_TOKEN)
@@ -46,6 +56,7 @@ module Mixpanel
       super(token, error_handler, &block)
       @token = token
       @people = People.new(token, error_handler, &block)
+      @groups = Groups.new(token, error_handler, &block)
     end
 
     # A call to #track is a report that an event has occurred.  #track

data/lib/mixpanel-ruby/version.rb

@@ -1,3 +1,3 @@
 module Mixpanel
-  VERSION = '2.2.1'
+  VERSION = '2.2.2'
 end

data/spec/mixpanel-ruby/consumer_spec.rb

@@ -22,6 +22,13 @@ describe Mixpanel::Consumer do
         with(:body => {'data' => 'IlRFU1QgRVZFTlQgTUVTU0FHRSI=', 'verbose' => '1' })
     end
 
+    it 'should send a request to api.mixpanel.com/groups on groups updates' do
+      stub_request(:any, 'https://api.mixpanel.com/groups').to_return({:body => '{"status": 1, "error": null}'})
+      subject.send!(:group_update, {'data' => 'TEST EVENT MESSAGE'}.to_json)
+      expect(WebMock).to have_requested(:post, 'https://api.mixpanel.com/groups').
+        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)

data/spec/mixpanel-ruby/groups_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+require 'active_support/time'
+
+require 'mixpanel-ruby/groups'
+
+describe Mixpanel::Groups do
+  before(:each) do
+    @time_now = Time.parse('Jun 6 1972, 16:23:04')
+    allow(Time).to receive(:now).and_return(@time_now)
+
+    @log = []
+    @groups = Mixpanel::Groups.new('TEST TOKEN') do |type, message|
+      @log << [type, JSON.load(message)]
+    end
+  end
+
+  it 'should send a well formed groups/set message' do
+    @groups.set("TEST GROUP KEY", "TEST GROUP ID", {
+        '$groupname' => 'Mixpanel',
+        '$grouprevenue' => 200
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            '$groupname' => 'Mixpanel',
+            '$grouprevenue' => 200
+        }
+    }]])
+  end
+
+  it 'should properly cast dates' do
+    @groups.set("TEST GROUP KEY", "TEST GROUP ID", {
+        'created_at' => DateTime.new(2013, 1, 2, 3, 4, 5)
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            'created_at' => '2013-01-02T03:04:05'
+        }
+    }]])
+  end
+
+  it 'should convert offset datetimes to UTC' do
+    @groups.set("TEST GROUP KEY", "TEST GROUP ID", {
+        'created_at' => DateTime.new(2013, 1, 1, 18, 4, 5, '-8')
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            'created_at' => '2013-01-02T02:04:05'
+        }
+    }]])
+  end
+
+  it 'should convert offset ActiveSupport::TimeWithZone objects to UTC' do
+    Time.zone = 'Pacific Time (US & Canada)'
+    @groups.set("TEST GROUP KEY", "TEST GROUP ID", {
+        'created_at' => Time.zone.local(2013, 1, 1, 18, 4, 5)
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set' => {
+            'created_at' => '2013-01-02T02:04:05'
+        }
+    }]])
+  end
+
+  it 'should send a well formed groups/set_once message' do
+    @groups.set_once("TEST GROUP KEY", "TEST GROUP ID", {
+        '$groupname' => 'Mixpanel',
+        '$grouprevenue' => 200
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$set_once' => {
+            '$groupname' => 'Mixpanel',
+            '$grouprevenue' => 200
+        }
+    }]])
+  end
+
+  it 'should send a well formed groups/remove message' do
+    @groups.remove("TEST GROUP KEY", "TEST GROUP ID", {
+        'Albums' => 'Diamond Dogs'
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$remove' => {
+            'Albums' => 'Diamond Dogs'
+        }
+    }]])
+  end
+
+  it 'should send a well formed groups/union message' do
+    @groups.union("TEST GROUP KEY", "TEST GROUP ID", {
+      'Albums' => ['Diamond Dogs']
+    })
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$union' => {
+            'Albums' => ['Diamond Dogs']
+        }
+    }]])
+  end
+
+  it 'should send a well formed unset message' do
+    @groups.unset("TEST GROUP KEY", "TEST GROUP ID", 'Albums')
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$unset' => ['Albums']
+    }]])
+  end
+
+  it 'should send a well formed unset message with multiple properties' do
+    @groups.unset("TEST GROUP KEY", "TEST GROUP ID", ['Albums', 'Vinyls'])
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$unset' => ['Albums', 'Vinyls']
+    }]])
+  end
+
+  it 'should send a well formed groups/delete message' do
+    @groups.delete_group("TEST GROUP KEY", "TEST GROUP ID")
+    expect(@log).to eq([[:group_update, 'data' => {
+        '$token' => 'TEST TOKEN',
+        '$group_key' => 'TEST GROUP KEY',
+        '$group_id' => 'TEST GROUP ID',
+        '$time' => @time_now.to_i * 1000,
+        '$delete' => ''
+    }]])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixpanel-ruby
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Mixpanel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2019-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,7 @@ files:
 - lib/mixpanel-ruby/consumer.rb
 - lib/mixpanel-ruby/error.rb
 - lib/mixpanel-ruby/events.rb
+- lib/mixpanel-ruby/groups.rb
 - lib/mixpanel-ruby/people.rb
 - lib/mixpanel-ruby/tracker.rb
 - lib/mixpanel-ruby/version.rb
@@ -93,6 +94,7 @@ files:
 - spec/mixpanel-ruby/consumer_spec.rb
 - spec/mixpanel-ruby/error_spec.rb
 - spec/mixpanel-ruby/events_spec.rb
+- spec/mixpanel-ruby/groups_spec.rb
 - spec/mixpanel-ruby/people_spec.rb
 - spec/mixpanel-ruby/tracker_spec.rb
 - spec/spec_helper.rb