minor changes

Author: yakkomajuri

.github/workflows/tests.yml

@@ -24,4 +24,4 @@ jobs:
 
             - name: Run posthog tests
               run: |
-                  python setup.py test
+                  python setup.py test

posthog/client.py

@@ -35,6 +35,8 @@ def __init__(self, api_key=None, host=None, debug=False,
         require('api_key', api_key, string_types)
 
         self.queue = queue.Queue(max_queue_size)
+        
+        # api_key: This should be the Team API Key (token), public
         self.api_key = api_key
         self.on_error = on_error
         self.debug = debug
@@ -45,6 +47,8 @@ def __init__(self, api_key=None, host=None, debug=False,
         self.timeout = timeout
         self.feature_flags = None
         self.poll_interval = poll_interval
+        
+        # personal_api_key: This should be a generated Personal API Key, private
         self.personal_api_key = personal_api_key
 
         if debug:
@@ -230,7 +234,12 @@ def _load_feature_flags(self):
             self.feature_flags = get(self.personal_api_key, '/api/feature_flag/', self.host)['results']
         except APIError as e:
             if e.status == 401:
-                raise APIError(status=401, message='You are using a write-only key with feature flags. To use feature flags, use a personal API key as api_key instead.')
+                raise APIError(
+                    status=401, 
+                    message='You are using a write-only key with feature flags. ' \
+                    'To use feature flags, please set a personal_api_key ' \
+                    'More information: https://posthog.com/docs/api/overview'
+                )
 
         self._last_feature_flag_poll = datetime.utcnow().replace(tzinfo=tzutc())
 

posthog/request.py

@@ -54,22 +54,21 @@ def post(api_key, host=None, gzip=False, timeout=15, **kwargs):
 def get(api_key, url, host=None):
     log = logging.getLogger('posthog')
     url = remove_trailing_slash(host or DEFAULT_HOST) + url
-    request = requests.get(
+    response = requests.get(
         url,
         headers={
             'Authorization': 'Bearer %s' % api_key,
             'User-Agent': USER_AGENT
         },
     )
-    if request.status_code == 200:
-        return request.json()
+    if response.status_code == 200:
+        return response.json()
     try:
-        payload = request.json()
+        payload = response.json()
         log.debug('received response: %s', payload)
-        print(payload['detail'])
-        raise APIError(request.status_code, payload['detail'])
+        raise APIError(response.status_code, payload['detail'])
     except ValueError:
-        raise APIError(request.status_code, res.text)
+        raise APIError(response.status_code, response.text)
 
 
 class APIError(Exception):

posthog/test/client.py

@@ -9,11 +9,13 @@
 from posthog.client import Client
 from posthog.test.utils import TEST_API_KEY
 
+from posthog.request import APIError
+
 class TestClient(unittest.TestCase):
 
     def set_fail(self, e, batch):
         """Mark the failure handler"""
-        print('FAILL', e, batch)
+        print('FAIL', e, batch)
         self.failed = True
 
     def setUp(self):
@@ -77,7 +79,7 @@ def test_basic_identify(self):
         self.assertTrue(success)
         self.assertFalse(self.failed)
 
-        self.assertEqual(msg['$set'], {'trait': 'value'})
+        self.assertEqual(msg['$set']['trait'], 'value')
         self.assertTrue(isinstance(msg['timestamp'], str))
         self.assertTrue(isinstance(msg['messageId'], str))
         self.assertEqual(msg['distinct_id'], 'distinct_id')
@@ -92,7 +94,7 @@ def test_advanced_identify(self):
 
         self.assertEqual(msg['timestamp'], '2014-09-03T00:00:00+00:00')
         self.assertEqual(msg['context']['ip'], '192.168.0.1')
-        self.assertEqual(msg['$set'], {'trait': 'value'})
+        self.assertEqual(msg['$set']['trait'], 'value')
         self.assertEqual(msg['properties']['$lib'], 'posthog-python')
         self.assertEqual(msg['properties']['$lib_version'], VERSION)
         self.assertTrue(isinstance(msg['timestamp'], str))
@@ -239,6 +241,11 @@ def test_load_feature_flags(self, patch_get, patch_poll):
         self.assertEqual(client.feature_flags[0]['key'], 'beta-feature')
         self.assertEqual(client._last_feature_flag_poll.isoformat(), "2020-01-01T12:01:00+00:00")
         self.assertEqual(patch_poll.call_count, 1)
+        
+    def test_load_feature_flags_wrong_key(self):
+        client = Client(TEST_API_KEY, personal_api_key=TEST_API_KEY)
+        with freeze_time('2020-01-01T12:01:00.0000Z'):
+            self.assertRaises(APIError, client.load_feature_flags)
 
     @mock.patch('posthog.client.get')
     def test_feature_enabled_simple(self, patch_get):

simulator.py

@@ -45,8 +45,8 @@ def failed(status, msg):
     raise Exception(msg)
 
 
-def track():
-    posthog.track(options.distinct_id, options.event, anonymous_id=options.anonymousId,
+def capture():
+    posthog.capture(options.distinct_id, options.event, anonymous_id=options.anonymousId,
                     properties=json_hash(options.properties), context=json_hash(options.context))
 
 
@@ -55,21 +55,11 @@ def page():
                    properties=json_hash(options.properties), context=json_hash(options.context))
 
 
-def screen():
-    posthog.screen(options.distinct_id, name=options.name, anonymous_id=options.anonymousId,
-                     properties=json_hash(options.properties), context=json_hash(options.context))
-
-
 def identify():
     posthog.identify(options.distinct_id, anonymous_id=options.anonymousId,
                        traits=json_hash(options.traits), context=json_hash(options.context))
 
 
-def group():
-    posthog.group(options.distinct_id, options.groupId, json_hash(options.traits),
-                    json_hash(options.context), anonymous_id=options.anonymousId)
-
-
 def unknown():
     print()
 
@@ -84,11 +74,9 @@ def unknown():
 log.addHandler(ch)
 
 switcher = {
-    "track": track,
+    "capture": capture,
     "page": page,
-    "screen": screen,
-    "identify": identify,
-    "group": group
+    "identify": identify
 }
 
 func = switcher.get(options.type)