docs

Author: mredolatti

identify/http_clients/sync_client.py

@@ -38,7 +38,11 @@ def setup_method(self, method, body=None):
 
     def _handle_invalid_response(self, response):
         '''
-        TODO
+        Handle responses that are not okay and throw an appropriate exception.
+        If the code doesn't match the known ones, a generic HTTPResponseError
+        is thrown
+
+        :param response: requests' module response object
         '''
         status_codes_exceptions = {
             404: HTTPNotFoundError,
@@ -54,6 +58,10 @@ def _handle_invalid_response(self, response):
 
     def _handle_connection_error(self, e):
         '''
+        Handle error when attempting to connect to identify backend.
+        Logs exception thrown by requests module, and raises an
+        IdentifyBackendUnreachableError error, so that it can be caught
+        by using the top level IdentifyException
         '''
         LOGGER.debug(e)
         raise IdentifyBackendUnreachableError(

identify/microclients/attribute_microclient.py

@@ -51,6 +51,10 @@ def __init__(self, http_client):
     def list(self, traffic_type_id):
         '''
         Returns a list of TrafficType objects.
+
+        :param traffic_type_id: Id of the TrafficType whose attributes will be
+            returned
+        :rtype: list(TrafficType)
         '''
         try:
             response = self._http_client.make_request(
@@ -67,6 +71,13 @@ def list(self, traffic_type_id):
 
     def create(self, attribute):
         '''
+        Create a new attribute.
+
+        :param attribute: Attribute instance or dict with camelcase keys
+            containing Attribute properties
+
+        :returns: newly created attribute
+        :rtype: Attribute
         '''
         # TODO: Validate!
         try:
@@ -88,11 +99,18 @@ def create(self, attribute):
 
     def delete(self, attribute):
         '''
+        Delete an attribute
+
+        :param attribute: Attribute instance
         '''
         return self.delete_by_id(attribute.id, attribute.traffic_type_id)
 
     def delete_by_id(self, attribute_id, traffic_type_id):
         '''
+        Delete an attribute by specifying its id and it's traffic type id.
+
+        :param attribute_id: attribute's id
+        :param traffic_type_id: atribute's traffic type id
         '''
         try:
             return self._http_client.make_request(

identify/microclients/environment_microclient.py

@@ -23,12 +23,16 @@ class EnvironmentMicroClient:
 
     def __init__(self, http_client):
         '''
+        Constructor
         '''
         self._http_client = http_client
 
     def list(self):
         '''
         Returns a list of Environment objects.
+
+        :returns: list of Environment objects
+        :rtype: list(Environment)
         '''
         try:
             response = self._http_client.make_request(

identify/microclients/identity_microclient.py

@@ -72,11 +72,19 @@ class IdentityMicroClient:
 
     def __init__(self, http_client):
         '''
+        Constructor
         '''
         self._http_client = http_client
 
     def save(self, identity):
         '''
+        Save an identity
+
+        :param identity: Identity instance or dict containing keys with identity
+            properties
+
+        :returns: newly created Identity
+        :rtype: Identity
         '''
         try:
             data = identity.to_dict() if isinstance(identity, Identity) else identity
@@ -98,7 +106,15 @@ def save(self, identity):
 
     def save_all(self, identities):
         '''
-        entities: { key: { attr_id: value, ...} }
+        Save multiple identities at once
+
+        :param identities: array of Identity instances or dicts containing keys
+            with identity's properties
+
+        :returns: tuple with successful and failed items. Succesful items
+            are Identity objects. Failed ones will contain the Identity object
+            for the failed item togegther with a status code and a message
+        :rtype: tuple
         '''
         # TODO: Validate!
         try:
@@ -139,6 +155,13 @@ def save_all(self, identities):
 
     def update(self, identity):
         '''
+        Update an existing identity
+
+        :param identity: Identity instance or dict containing keys with identity
+            properties
+
+        :returns: updated Identity
+        :rtype: Identity
         '''
         try:
             data = identity.to_dict() if isinstance(identity, Identity) else identity
@@ -160,6 +183,13 @@ def update(self, identity):
 
     def patch(self, identity):
         '''
+        Patch an existing identity
+
+        :param identity: Identity instance or dict containing keys with identity
+            properties
+
+        :returns: patched Identity
+        :rtype: Identity
         '''
         try:
             data = identity.to_dict() if isinstance(identity, Identity) else identity
@@ -181,6 +211,9 @@ def patch(self, identity):
 
     def delete_all_attributes(self, identity):
         '''
+        Delete all attributes from the current identity
+
+        :param identity: Identity instance
         '''
         return self.delete_all_attributes_by_id(
             identity.traffic_type_id,
@@ -190,6 +223,12 @@ def delete_all_attributes(self, identity):
 
     def delete_all_attributes_by_id(self, traffic_type_id, environment_id, key):
         '''
+        Delete all attributes by specifying the traffic type id, the environment
+        id and the identity's key instead of passing an Identify object.
+
+        :param traffic_type_id: Identity's traffic type id
+        :param environment_id: Identity's environment id
+        :param key: Identity's key
         '''
         try:
             self._http_client.make_request(

identify/microclients/traffic_type_microclient.py

@@ -23,12 +23,16 @@ class TrafficTypeMicroClient:
 
     def __init__(self, http_client):
         '''
+        Constructor
         '''
         self._http_client = http_client
 
     def list(self):
         '''
         Returns a list of TrafficType objects.
+
+        :returns: List of TrafficType objects
+        :rtype: list(TrafficType)
         '''
         try:
             response = self._http_client.make_request(

identify/resources/attribute.py

@@ -67,6 +67,11 @@ def is_searchable(self, new):
 
     def delete(self, identify_client=None):
         '''
+        Delete this attribute
+
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
         '''
         if identify_client is not None:
             amc = identify_client.attribute

identify/resources/environment.py

@@ -28,6 +28,12 @@ def name(self, new):
 
     def add_identity(self, data, identify_client=None):
         '''
+        Add a new identity associated with this environment.
+
+        :param data: Identity object or dict containing identity properties
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
         '''
         if identify_client is not None:
             imc = identify_client.identity
@@ -44,6 +50,18 @@ def add_identity(self, data, identify_client=None):
 
     def add_identities(self, data, identify_client=None):
         '''
+        Add multiple new identities associated with this environment.
+
+        :param data: list ofIdentity objects or dicts containing identity
+            properties
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: tuple with successful and failed items. Succesful items
+            are Identity objects. Failed ones will contain the Identity object
+            for the failed item togegther with a status code and a message
+        :rtype: tuple
         '''
         if identify_client is not None:
             imc = identify_client.identity

identify/resources/identity.py

@@ -66,6 +66,14 @@ def organization_id(self, new):
 
     def save(self, identify_client=None):
         '''
+        Save this Identity
+
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: newly saved Identity object
+        :rtype: Identity
         '''
         if identify_client is not None:
             imc = identify_client.identity
@@ -79,6 +87,14 @@ def save(self, identify_client=None):
 
     def update(self, identify_client=None):
         '''
+        Update this Identity
+
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: newly saved Identity object
+        :rtype: Identity
         '''
         if identify_client is not None:
             imc = identify_client.identity
@@ -92,6 +108,11 @@ def update(self, identify_client=None):
 
     def delete_attributes(self, identify_client=None):
         '''
+        Delete all attributes from this Identity
+
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
         '''
         if identify_client is not None:
             imc = identify_client.identity

identify/resources/traffic_type.py

@@ -17,6 +17,7 @@ class TrafficType(BaseResource):
 
     def __init__(self, data, client=None):
         '''
+        Constructor
         '''
         BaseResource.__init__(self, data.get('id'), client)
         self._name = data.get('name')
@@ -40,6 +41,14 @@ def display_attribute_id(self, new):
 
     def fetch_attributes(self, identify_client=None):
         '''
+        Fetch all attributes for this traffic type
+
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: List of attributes associated with this traffic type
+        :rtype: list(Attribute)
         '''
         if identify_client is not None:
             amc = identify_client.attribute
@@ -52,6 +61,15 @@ def fetch_attributes(self, identify_client=None):
 
     def add_attribute(self, data, identify_client=None):
         '''
+        Add a new attribute associated with this traffic type
+
+        :param data: Attribute instance or dict containing Attribute properties
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: Newly created attribute
+        :rtype: Attribute
         '''
         if identify_client is not None:
             amc = identify_client.attribute
@@ -68,6 +86,15 @@ def add_attribute(self, data, identify_client=None):
 
     def add_identity(self, data, identify_client=None):
         '''
+        Add a new identity associated with this traffic type.
+
+        :param data: Identity object or dict containing identity properties
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: newly created Identity
+        :rtype: Identity
         '''
         if identify_client is not None:
             imc = identify_client.identity
@@ -84,6 +111,18 @@ def add_identity(self, data, identify_client=None):
 
     def add_identities(self, data, identify_client=None):
         '''
+        Add multiple new identities associated with this traffic type.
+
+        :param data: list ofIdentity objects or dicts containing identity
+            properties
+        :param identify_client: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+
+        :returns: tuple with successful and failed items. Succesful items
+            are Identity objects. Failed ones will contain the Identity object
+            for the failed item togegther with a status code and a message
+        :rtype: tuple
         '''
         if identify_client is not None:
             imc = identify_client.identity

identify/tests/resources/test_base_resource.py

@@ -26,11 +26,3 @@ def from_dict(self, c, r): pass
 
         b = SampleResource2('', '')
         assert isinstance(b, BaseResource)
-
-    def test_validate(self):
-        # TODO!
-        pass
-
-    def test_to_dict(self):
-        # TODO!
-        pass