api_secret support (#89)

* api_secret support.

* Clarify key/secret a little more.

* Don't use root logger.

Author: David Grant

mixpanel/__init__.py

@@ -17,16 +17,19 @@
 from __future__ import absolute_import, unicode_literals
 import datetime
 import json
+import logging
 import time
 import uuid
 
 import six
 from six.moves import range
 import urllib3
 
-__version__ = '4.7.0'
+__version__ = '4.8.0'
 VERSION = __version__  # TODO: remove when bumping major version.
 
+logger = logging.getLogger(__name__)
+
 
 class DatetimeSerializer(json.JSONEncoder):
     def default(self, obj):
@@ -100,23 +103,37 @@ def track(self, distinct_id, event_name, properties=None, meta=None):
         self._consumer.send('events', json_dumps(event, cls=self._serializer))
 
     def import_data(self, api_key, distinct_id, event_name, timestamp,
-                    properties=None, meta=None):
+                    properties=None, meta=None, api_secret=None):
         """Record an event that occurred more than 5 days in the past.
 
-        :param str api_key: your Mixpanel project's API key
+        :param str api_key: (DEPRECATED) your Mixpanel project's API key
         :param str distinct_id: identifies the user triggering the event
         :param str event_name: a name describing the event
         :param int timestamp: UTC seconds since epoch
         :param dict properties: additional data to record; keys should be
             strings, and values should be strings, numbers, or booleans
         :param dict meta: overrides Mixpanel special properties
+        :param str api_secret: Your Mixpanel project's API secret.
+
+        Important: Mixpanel's ``import`` HTTP endpoint requires the project API
+            secret found in your Mixpanel project's settings. The older API key is
+            no longer accessible in the Mixpanel UI, but will continue to work.
+            The api_key parameter will be removed in an upcoming release of
+            mixpanel-python.
+
+        .. versionadded:: 4.8.0
+            The *api_secret* parameter.
 
         To avoid accidentally recording invalid events, the Mixpanel API's
         ``track`` endpoint disallows events that occurred too long ago. This
         method can be used to import such events. See our online documentation
         for `more details
         <https://developer.mixpanel.com/docs/importing-old-events>`__.
         """
+
+        if api_secret is None:
+            logger.warning("api_key will soon be removed from mixpanel-python; please use api_secret instead.")
+
         all_properties = {
             'token': self._token,
             'distinct_id': distinct_id,
@@ -133,7 +150,8 @@ def import_data(self, api_key, distinct_id, event_name, timestamp,
         }
         if meta:
             event.update(meta)
-        self._consumer.send('imports', json_dumps(event, cls=self._serializer), api_key)
+
+        self._consumer.send('imports', json_dumps(event, cls=self._serializer), api_key, api_secret)
 
     def alias(self, alias_id, original, meta=None):
         """Creates an alias which Mixpanel will use to remap one id to another.
@@ -166,19 +184,32 @@ def alias(self, alias_id, original, meta=None):
             event.update(meta)
         sync_consumer.send('events', json_dumps(event, cls=self._serializer))
 
-    def merge(self, api_key, distinct_id1, distinct_id2, meta=None):
+    def merge(self, api_key, distinct_id1, distinct_id2, meta=None, api_secret=None):
         """
         Merges the two given distinct_ids.
 
-        :param str api_key: Your Mixpanel project's API key.
+        :param str api_key: (DEPRECATED) Your Mixpanel project's API key.
         :param str distinct_id1: The first distinct_id to merge.
         :param str distinct_id2: The second (other) distinct_id to merge.
         :param dict meta: overrides Mixpanel special properties
+        :param str api_secret: Your Mixpanel project's API secret.
+
+        Important: Mixpanel's ``merge`` HTTP endpoint requires the project API
+            secret found in your Mixpanel project's settings. The older API key is
+            no longer accessible in the Mixpanel UI, but will continue to work.
+            The api_key parameter will be removed in an upcoming release of
+            mixpanel-python.
+
+        .. versionadded:: 4.8.0
+            The *api_secret* parameter.
 
         See our online documentation for `more
         details
         <https://developer.mixpanel.com/docs/http#merge>`__.
         """
+        if api_secret is None:
+            logger.warning("api_key will soon be removed from mixpanel-python; please use api_secret instead.")
+
         event = {
             'event': '$merge',
             'properties': {
@@ -188,7 +219,7 @@ def merge(self, api_key, distinct_id1, distinct_id2, meta=None):
         }
         if meta:
             event.update(meta)
-        self._consumer.send('imports', json_dumps(event, cls=self._serializer), api_key)
+        self._consumer.send('imports', json_dumps(event, cls=self._serializer), api_key, api_secret)
 
     def people_set(self, distinct_id, properties, meta=None):
         """Set properties of a people record.
@@ -530,22 +561,27 @@ def __init__(self, events_url=None, people_url=None, import_url=None,
             cert_reqs=cert_reqs,
         )
 
-    def send(self, endpoint, json_message, api_key=None):
+    def send(self, endpoint, json_message, api_key=None, api_secret=None):
         """Immediately record an event or a profile update.
 
         :param endpoint: the Mixpanel API endpoint appropriate for the message
         :type endpoint: "events" | "people" | "groups" | "imports"
         :param str json_message: a JSON message formatted for the endpoint
         :param str api_key: your Mixpanel project's API key
+        :param str api_secret: your Mixpanel project's API secret
         :raises MixpanelException: if the endpoint doesn't exist, the server is
             unreachable, or the message cannot be processed
+
+
+        .. versionadded:: 4.8.0
+            The *api_secret* parameter.
         """
-        if endpoint in self._endpoints:
-            self._write_request(self._endpoints[endpoint], json_message, api_key)
-        else:
+        if endpoint not in self._endpoints:
             raise MixpanelException('No such endpoint "{0}". Valid endpoints are one of {1}'.format(endpoint, self._endpoints.keys()))
 
-    def _write_request(self, request_url, json_message, api_key=None):
+        self._write_request(self._endpoints[endpoint], json_message, api_key, api_secret)
+
+    def _write_request(self, request_url, json_message, api_key=None, api_secret=None):
         data = {
             'data': json_message,
             'verbose': 1,
@@ -554,11 +590,17 @@ def _write_request(self, request_url, json_message, api_key=None):
         if api_key:
             data.update({'api_key': api_key})
 
+        headers = None
+
+        if api_secret is not None:
+            headers = urllib3.util.make_headers(basic_auth="{}:".format(api_secret))
+
         try:
             response = self._http.request(
                 'POST',
                 request_url,
                 fields=data,
+                headers=headers,
                 encode_multipart=False, # URL-encode payload in POST body.
             )
         except Exception as e:
@@ -621,7 +663,7 @@ def __init__(self, max_size=50, events_url=None, people_url=None, import_url=Non
         self._max_size = min(50, max_size)
         self._api_key = None
 
-    def send(self, endpoint, json_message, api_key=None):
+    def send(self, endpoint, json_message, api_key=None, api_secret=None):
         """Record an event or profile update.
 
         Internally, adds the message to a buffer, and then flushes the buffer
@@ -633,6 +675,7 @@ def send(self, endpoint, json_message, api_key=None):
         :type endpoint: "events" | "people" | "groups" | "imports"
         :param str json_message: a JSON message formatted for the endpoint
         :param str api_key: your Mixpanel project's API key
+        :param str api_secret: your Mixpanel project's API secret
         :raises MixpanelException: if the endpoint doesn't exist, the server is
             unreachable, or any buffered message cannot be processed
 
@@ -644,8 +687,9 @@ def send(self, endpoint, json_message, api_key=None):
 
         buf = self._buffers[endpoint]
         buf.append(json_message)
-        if api_key is not None:
-            self._api_key = api_key
+        # Fixme: Don't stick these in the instance.
+        self._api_key = api_key
+        self._api_secret = api_secret
         if len(buf) >= self._max_size:
             self._flush_endpoint(endpoint)
 
@@ -664,7 +708,7 @@ def _flush_endpoint(self, endpoint):
             batch = buf[:self._max_size]
             batch_json = '[{0}]'.format(','.join(batch))
             try:
-                self._consumer.send(endpoint, batch_json, self._api_key)
+                self._consumer.send(endpoint, batch_json, self._api_key, self._api_secret)
             except MixpanelException as orig_e:
                 mp_e = MixpanelException(orig_e)
                 mp_e.message = batch_json

test_mixpanel.py

@@ -20,11 +20,13 @@ class LogConsumer(object):
     def __init__(self):
         self.log = []
 
-    def send(self, endpoint, event, api_key=None):
+    def send(self, endpoint, event, api_key=None, api_secret=None):
+        entry = [endpoint, json.loads(event)]
         if api_key:
-            self.log.append((endpoint, json.loads(event), api_key))
-        else:
-            self.log.append((endpoint, json.loads(event)))
+            entry.append(api_key)
+        if api_secret:
+            entry.append(api_secret)
+        self.log.append(tuple(entry))
 
 
 class TestMixpanel:
@@ -79,7 +81,9 @@ def test_track_empty(self):
 
     def test_import_data(self):
         timestamp = time.time()
-        self.mp.import_data('MY_API_KEY', 'ID', 'button press', timestamp, {'size': 'big', 'color': 'blue', '$insert_id': 'abc123'})
+        self.mp.import_data('MY_API_KEY', 'ID', 'button press', timestamp,
+            {'size': 'big', 'color': 'blue', '$insert_id': 'abc123'},
+            api_secret='MY_SECRET')
         assert self.consumer.log == [(
             'imports', {
                 'event': 'button press',
@@ -94,7 +98,8 @@ def test_import_data(self):
                     '$lib_version': mixpanel.__version__,
                 },
             },
-            'MY_API_KEY'
+            'MY_API_KEY',
+            'MY_SECRET',
         )]
 
     def test_track_meta(self):
@@ -517,6 +522,14 @@ def test_send_remembers_api_key(self):
         self.consumer.flush()
         assert self.log == [('imports', ['Event'], 'MY_API_KEY')]
 
+    def test_send_remembers_api_secret(self):
+        self.consumer.send('imports', '"Event"', api_secret='ZZZZZZ')
+        assert len(self.log) == 0
+        self.consumer.flush()
+        assert self.log == [('imports', ['Event'], 'ZZZZZZ')]
+
+
+
 
 class TestFunctional:
     @classmethod