Merge pull request #18 from PostHog/better-errors

Add project_api_key, improve errors

Author: Twixes

posthog/client.py

@@ -32,13 +32,15 @@ class Client(object):
     def __init__(self, api_key=None, host=None, debug=False,
                  max_queue_size=10000, send=True, on_error=None, flush_at=100,
                  flush_interval=0.5, gzip=False, max_retries=3,
-                 sync_mode=False, timeout=15, thread=1, poll_interval=30, personal_api_key=None):
-        require('api_key', api_key, string_types)
+                 sync_mode=False, timeout=15, thread=1, poll_interval=30, personal_api_key=None, project_api_key=None):
 
         self.queue = queue.Queue(max_queue_size)
 
         # api_key: This should be the Team API Key (token), public
-        self.api_key = api_key
+        self.api_key = api_key or project_api_key
+
+        require('api_key', self.api_key, string_types)
+
         self.on_error = on_error
         self.debug = debug
         self.send = send
@@ -238,6 +240,11 @@ def _load_feature_flags(self):
                     'To use feature flags, please set a personal_api_key ' \
                     'More information: https://posthog.com/docs/api/overview'
                 )
+            else:
+                raise APIError(
+                    status=e.status, 
+                    message=e.message
+                )
         except Exception as e:
             self.log.warning('[FEATURE FLAGS] Fetching feature flags failed with following error. We will retry in %s seconds.' % self.poll_interval)
             self.log.warning(e)

posthog/request.py

@@ -46,57 +46,43 @@ def post(api_key, host=None, path=None, gzip=False, timeout=15, **kwargs):
         return res
 
 
-def decide(api_key, host=None, gzip=False, timeout=15, **kwargs):
-    """Post the `kwargs to the decide API endpoint"""
+def _process_response(res, success_message, return_json=True):
     log = logging.getLogger('posthog')
-    res = post(api_key, host, '/decide/', gzip, timeout, **kwargs)
+    if not res:
+        raise APIError('N/A', 'Error when fetching PostHog API, please make sure you are using your public project token/key and not a private API key.')
     if res.status_code == 200:
-        log.debug('Feature flags decided successfully')
-        return res.json()
+        log.debug(success_message)
+        return res.json() if return_json else res
     try:
         payload = res.json()
         log.debug('received response: %s', payload)
         raise APIError(res.status_code, payload['detail'])
     except ValueError:
         raise APIError(res.status_code, res.text)
 
+def decide(api_key, host=None, gzip=False, timeout=15, **kwargs):
+    """Post the `kwargs to the decide API endpoint"""
+    res = post(api_key, host, '/decide/', gzip, timeout, **kwargs)
+    return _process_response(res, success_message='Feature flags decided successfully')
+
 
 def batch_post(api_key, host=None, gzip=False, timeout=15, **kwargs):
     """Post the `kwargs` to the batch API endpoint for events"""
-    log = logging.getLogger('posthog')
     res = post(api_key, host, '/batch/', gzip, timeout, **kwargs)
-
-    if res.status_code == 200:
-        log.debug('data uploaded successfully')
-        return res
-    try:
-        payload = res.json()
-        log.debug('received response: %s', payload)
-        raise APIError(res.status_code, payload['detail'])
-    except ValueError:
-        raise APIError(res.status_code, res.text)
+    return _process_response(res, success_message='data uploaded successfully', return_json=False)
 
 
 def get(api_key, url, host=None, timeout=None):
-    log = logging.getLogger('posthog')
     url = remove_trailing_slash(host or DEFAULT_HOST) + url
-    response = requests.get(
+    res = requests.get(
         url,
         headers={
             'Authorization': 'Bearer %s' % api_key,
             'User-Agent': USER_AGENT
         },
         timeout=timeout
     )
-    if response.status_code == 200:
-        return response.json()
-    try:
-        payload = response.json()
-        log.debug('received response: %s', payload)
-        raise APIError(response.status_code, payload['detail'])
-    except ValueError:
-        raise APIError(response.status_code, response.text)
-
+    return _process_response(res, success_message=f'GET {url} completed successfully')
 
 class APIError(Exception):