Merge branch 'master' of https://github.com/sbnoemi/mixpanel-python into 2.0.2rc

Joe Bowers · Joe Bowers · commit a646d1dcd96f · 2013-09-26T21:39:53.000Z
diff --git a/mixpanel/__init__.py b/mixpanel/__init__.py
@@ -39,7 +39,7 @@ def __init__(self, token, consumer=None):
     def _now(self):
         return time.time()
 
-    def track(self, distinct_id, event_name, properties={}):
+    def track(self, distinct_id, event_name, properties={}, meta={}):
         """
         Notes that an event has occurred, along with a distinct_id
         representing the source of that event (for example, a user id),
@@ -69,9 +69,10 @@ def track(self, distinct_id, event_name, properties={}):
             'event': event_name,
             'properties': all_properties,
         }
+        event.update(meta)
         self._consumer.send('events', json.dumps(event))
 
-    def alias(self, alias_id, original):
+    def alias(self, alias_id, original, meta={}):
         """
         Gives custom alias to a people record.
 
@@ -85,9 +86,9 @@ def alias(self, alias_id, original):
             'distinct_id': original,
             'alias': alias_id,
             'token': self._token,
-        })
+        }, meta=meta)
 
-    def people_set(self, distinct_id, properties):
+    def people_set(self, distinct_id, properties, meta={}):
         """
         Set properties of a people record.
 
@@ -100,9 +101,9 @@ def people_set(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$set': properties,
-        })
+        }, meta=meta)
 
-    def people_set_once(self, distinct_id, properties):
+    def people_set_once(self, distinct_id, properties, meta={}):
         """
         Set immutable properties of a people record.
 
@@ -115,9 +116,9 @@ def people_set_once(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$set_once': properties,
-        })
+        }, meta=meta)
 
-    def people_increment(self, distinct_id, properties):
+    def people_increment(self, distinct_id, properties, meta={}):
         """
         Increments/decrements numerical properties of people record.
 
@@ -130,9 +131,9 @@ def people_increment(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$add': properties,
-        })
+        }, meta=meta)
 
-    def people_append(self, distinct_id, properties):
+    def people_append(self, distinct_id, properties, meta={}):
         """
         Appends to the list associated with a property.
 
@@ -146,9 +147,9 @@ def people_append(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$append': properties,
-        })
+        }, meta=meta)
 
-    def people_union(self, distinct_id, properties):
+    def people_union(self, distinct_id, properties, meta={}):
         """
         Merges the values for a list associated with a property.
 
@@ -161,9 +162,9 @@ def people_union(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$union': properties,
-        })
+        }, meta=meta)
 
-    def people_unset(self, distinct_id, properties):
+    def people_unset(self, distinct_id, properties, meta={}):
         """
         Removes properties from a profile.
 
@@ -175,9 +176,9 @@ def people_unset(self, distinct_id, properties):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$unset': properties,
-        })
+        }, meta=meta)
 
-    def people_delete(self, distinct_id):
+    def people_delete(self, distinct_id, meta={}):
         """
         Permanently deletes a profile.
 
@@ -189,9 +190,9 @@ def people_delete(self, distinct_id):
         return self.people_update({
             '$distinct_id': distinct_id,
             '$delete': "",
-        })
+        }, meta=meta)
 
-    def people_track_charge(self, distinct_id, amount, properties={}):
+    def people_track_charge(self, distinct_id, amount, properties={}, meta={}):
         """
         Tracks a charge to a user.
 
@@ -206,9 +207,9 @@ def people_track_charge(self, distinct_id, amount, properties={}):
             mp.track_charge('1234', 50, {'$time': "2013-04-01T09:02:00"})
         """
         properties.update({'$amount': amount})
-        return self.people_append(distinct_id, {'$transactions': properties})
+        return self.people_append(distinct_id, {'$transactions': properties}, meta=meta)
 
-    def people_update(self, message):
+    def people_update(self, message, meta={}):
         """
         Send a generic update to Mixpanel people analytics.
         Caller is responsible for formatting the update message, as
@@ -224,6 +225,7 @@ def people_update(self, message):
             '$time': int(self._now() * 1000),
         }
         record.update(message)
+        record.update(meta)
         self._consumer.send('people', json.dumps(record))
 
 class MixpanelException(Exception):
diff --git a/tests.py b/tests.py
@@ -42,6 +42,26 @@ def test_track(self):
                 }
             }
         )])
+        
+    def test_track_meta(self):
+        self.mp.track('ID', 'button press', {'size': 'big', 'color': 'blue'}, 
+            meta={'$ip': 0, '$ignore_time': True,})
+        self.assertEqual(self.consumer.log, [(
+            'events', {
+                'event': 'button press',
+                'properties': {
+                    'token': self.TOKEN,
+                    'size': 'big',
+                    'color': 'blue',
+                    'distinct_id': 'ID',
+                    'time': int(self.mp._now()),
+                    'mp_lib': 'python',
+                    '$lib_version': mixpanel.VERSION,
+                },
+                '$ip': 0,
+                '$ignore_time': True,
+            }
+        )])
 
     def test_people_set(self):
         self.mp.people_set('amq', {'birth month': 'october', 'favorite color': 'purple'})
@@ -154,6 +174,23 @@ def test_alias(self):
             }
 
         )])
+        
+    def test_people_meta(self):
+        self.mp.people_set('amq', {'birth month': 'october', 'favorite color': 'purple'}, 
+            meta={'$ip': 0, '$ignore_time': True})
+        self.assertEqual(self.consumer.log, [(
+            'people', {
+                '$time': int(self.mp._now() * 1000),
+                '$token': self.TOKEN,
+                '$distinct_id': 'amq',
+                '$set': {
+                    'birth month': 'october',
+                    'favorite color': 'purple',
+                },
+                '$ip': 0,
+                '$ignore_time': True,
+            }
+        )])
 
 class ConsumerTestCase(unittest.TestCase):
     def setUp(self):
