splitio · mredolatti · Apr 24, 2019 · Apr 12, 2019 · Apr 12, 2019 · Apr 12, 2019
@@ -8,7 +8,8 @@
 * Bullet 2
 
 ## How to test new changes?
-*
+* python setup.py test to test everythin
+* pytest <SPECIFIC_FILE> to test a file in particular (requires pytest, pytest-cov & pytest-mock to be installed)
 
 ## Extra Notes
 * Bullet 1

@@ -2,31 +2,5 @@
     unicode_literals
 
 from splitio.client.factory import get_factory
-#from .factories import get_factory # noqa
-#from .key import Key # noqa
-#from .version import __version__  # noqa
-#
-#__all__ = ('api', 'brokers', 'cache', 'clients', 'matchers', 'segments',
-#           'settings', 'splits', 'splitters', 'transformers', 'treatments',
-#           'version', 'factories', 'manager')
-#
-#
-## Functions defined to maintain compatibility with previous sdk versions.
-## ======================================================================
-##
-## This functions are not supposed to be used directly, factory method should be
-## called instead, but since they were previously exposed, they're re-added here
-## as helper function so that if someone was using we don't break their code.
-#
-#def get_client(apikey, **kwargs):
-#    from .clients import Client
-#    from .brokers import get_self_refreshing_broker
-#    broker = get_self_refreshing_broker(apikey, **kwargs)
-#    return Client(broker)
-#
-#
-#def get_redis_client(apikey, **kwargs):
-#    from .clients import Client
-#    from .brokers import get_redis_broker
-#    broker = get_redis_broker(apikey, **kwargs)
-#    return Client(broker)
+from splitio.client.key import Key
+from splitio.version import __version__
@@ -3,19 +3,12 @@
 class APIException(Exception):
     """Exception to raise when an API call fails."""
 
-    def __init__(self, custom_message, status_code=None, original_exception=None):
+    def __init__(self, custom_message, status_code=None):
         """Constructor."""
         Exception.__init__(self, custom_message)
         self._status_code = status_code if status_code else -1
-        self._custom_message = custom_message
-        self._original_exception = original_exception
 
     @property
     def status_code(self):
         """Return HTTP status code."""
         return self._status_code
-
-    @property
-    def custom_message(self):
-        """Return custom message."""
-        return self._custom_message
@@ -2,6 +2,8 @@
 from __future__ import division
 
 from collections import namedtuple
+
+from six import raise_from
 import requests
 
 HttpResponse = namedtuple('HttpResponse', ['status_code', 'body'])
@@ -10,28 +12,14 @@
 class HttpClientException(Exception):
     """HTTP Client exception."""
 
-    def __init__(self, custom_message, original_exception=None):
+    def __init__(self, message):
         """
         Class constructor.
 
         :param message: Information on why this exception happened.
         :type message: str
-        :param original_exception: Original exception being caught if any.
-        :type original_exception: Exception.
         """
-        Exception.__init__(self, custom_message)
-        self._custom_message = custom_message
-        self._original_exception = original_exception
-
-    @property
-    def custom_message(self):
-        """Return custom message."""
-        return self._custom_message
-
-    @property
-    def original_exception(self):
-        """Return original exception."""
-        return self._original_exception
+        Exception.__init__(self, message)
 
 
 class HttpClient(object):
@@ -44,12 +32,12 @@ def __init__(self, timeout=None, sdk_url=None, events_url=None):
         """
         Class constructor.
 
+        :param timeout: How many milliseconds to wait until the server responds.
+        :type timeout: int
         :param sdk_url: Optional alternative sdk URL.
         :type sdk_url: str
         :param events_url: Optional alternative events URL.
         :type events_url: str
-        :param timeout: How many milliseconds to wait until the server responds.
-        :type timeout: int
         """
         self._timeout = timeout / 1000  if timeout else None  # Convert ms to seconds.
         self._urls = {
@@ -71,24 +59,38 @@ def _build_url(self, server, path):
         """
         return self._urls[server] + path
 
+    @staticmethod
+    def _build_basic_headers(apikey):
+        """
+        Build basic headers with auth.
+
+        :param apikey: API token used to identify backend calls.
+        :type apikey: str
+        """
+        return {
+            'Content-Type': 'application/json',
+            'Authorization': "Bearer %s" % apikey
+        }
+
     def get(self, server, path, apikey, query=None, extra_headers=None):  #pylint: disable=too-many-arguments
         """
         Issue a get request.
 
+        :param server: Whether the request is for SDK server or Events server.
+        :typee server: str
         :param path: path to append to the host url.
         :type path: str
         :param apikey: api token.
         :type apikey: str
+        :param query: Query string passed as dictionary.
+        :type query: dict
         :param extra_headers: key/value pairs of possible extra headers.
         :type extra_headers: dict
 
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = {
-            'Content-Type': 'application/json',
-            'Authorization': "Bearer %s" % apikey
-        }
+        headers = self._build_basic_headers(apikey)
 
         if extra_headers is not None:
             headers.update(extra_headers)
@@ -101,29 +103,30 @@ def get(self, server, path, apikey, query=None, extra_headers=None):  #pylint: d
                 timeout=self._timeout
             )
             return HttpResponse(response.status_code, response.text)
-        except Exception as exc:
-            raise HttpClientException('requests library is throwing exceptions', exc)
+        except Exception as exc:  #pylint: disable=broad-except
+            raise_from(HttpClientException('requests library is throwing exceptions'), exc)
 
     def post(self, server, path, apikey, body, query=None, extra_headers=None):  #pylint: disable=too-many-arguments
         """
         Issue a POST request.
 
+        :param server: Whether the request is for SDK server or Events server.
+        :typee server: str
         :param path: path to append to the host url.
         :type path: str
         :param apikey: api token.
         :type apikey: str
         :param body: body sent in the request.
         :type body: str
+        :param query: Query string passed as dictionary.
+        :type query: dict
         :param extra_headers: key/value pairs of possible extra headers.
         :type extra_headers: dict
 
         :return: Tuple of status_code & response text
         :rtype: HttpResponse
         """
-        headers = {
-            'Content-Type': 'application/json',
-            'Authorization': "Bearer %s" % apikey
-        }
+        headers = self._build_basic_headers(apikey)
 
         if extra_headers is not None:
             headers.update(extra_headers)
@@ -137,5 +140,5 @@ def post(self, server, path, apikey, body, query=None, extra_headers=None):  #py
                 timeout=self._timeout
             )
             return HttpResponse(response.status_code, response.text)
-        except Exception as exc:
-            raise HttpClientException('requests library is throwing exceptions', exc)
+        except Exception as exc:  #pylint: disable=broad-except
+            raise_from(HttpClientException('requests library is throwing exceptions'), exc)
@@ -1,5 +1,8 @@
 """Events API module."""
 import logging
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -11,10 +14,12 @@ def __init__(self, http_client, apikey, sdk_metadata):
         """
         Class constructor.
 
-        :param client: HTTP Client responsble for issuing calls to the backend.
-        :type client: HttpClient
+        :param http_client: HTTP Client responsble for issuing calls to the backend.
+        :type http_client: HttpClient
         :param apikey: User apikey token.
         :type apikey: string
+        :param sdk_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio.client.util.SdkMetadata
         """
         self._logger = logging.getLogger(self.__class__.__name__)
         self._client = http_client
@@ -69,5 +74,6 @@ def flush_events(self, events):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Events not flushed properly.'), exc)
@@ -2,6 +2,9 @@
 
 import logging
 from itertools import groupby
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -78,5 +81,6 @@ def flush_impressions(self, impressions):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Impressions not flushed properly.'), exc)
@@ -2,6 +2,9 @@
 
 import json
 import logging
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -47,5 +50,6 @@ def fetch_segment(self, segment_name, change_number):
             else:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Segments not fetched properly.'), exc)
@@ -2,6 +2,9 @@
 
 import logging
 import json
+
+from six import raise_from
+
 from splitio.api import APIException
 from splitio.api.client import HttpClientException
 
@@ -44,5 +47,6 @@ def fetch_splits(self, change_number):
             else:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            raise_from(APIException('Splits not fetched correctly.'), exc)
@@ -60,7 +60,9 @@ def flush_latencies(self, latencies):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Latencies not flushed correctly.'), exc)
 
     @staticmethod
     def _build_gauges(gauges):
@@ -94,7 +96,9 @@ def flush_gauges(self, gauges):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Gauges not flushed correctly.'), exc)
 
     @staticmethod
     def _build_counters(counters):
@@ -128,5 +132,6 @@ def flush_counters(self, counters):
             if not 200 <= response.status_code < 300:
                 raise APIException(response.body, response.status_code)
         except HttpClientException as exc:
-            self._logger.debug('Error flushing events: ', exc_info=True)
-            raise APIException(exc.custom_message, original_exception=exc.original_exception)
+            self._logger.error('Http client is throwing exceptions')
+            self._logger.debug('Error: ', exc_info=True)
+            six.raise_from(APIException('Counters not flushed correctly.'), exc)
@@ -55,6 +55,11 @@ def destroy(self):
         """
         self._factory.destroy()
 
+    @property
+    def ready(self):
+        """Return whether the SDK initialization has finished."""
+        return self._factory.ready
+
     @property
     def destroyed(self):
         """Return whether the factory holding this client has been destroyed."""