Update client iterface to match henry\'s doc

Author: mredolatti

identify/main/identify_client.py

@@ -12,42 +12,18 @@ class BaseIdentifyClient:
     def __init__(self, config):
         pass
 
-    @abc.abstractmethod
-    def get_traffic_types(self):
-        pass
-
-    @abc.abstractmethod
-    def get_environments(self):
-        pass
-
-    @abc.abstractmethod
-    def get_attributes_for_traffic_type(self, traffic_type_id):
-        pass
-
-    @abc.abstractmethod
-    def create_attribute_for_traffic_type(self, traffic_type_id, attr_data):
-        pass
-
-    @abc.abstractmethod
-    def delete_attribute_from_schema(self, traffic_type_id, attribute_id):
+    @abc.abstractproperty
+    def traffic_type(self):
         pass
 
-    @abc.abstractmethod
-    def add_identities(self, traffic_type_id, environment_id, entities):
+    @abc.abstractproperty
+    def environment(self):
         pass
 
-    @abc.abstractmethod
-    def add_identity(self, traffic_type_id, environment_id, key, values):
+    @abc.abstractproperty
+    def attribute(self):
         pass
 
-    @abc.abstractmethod
-    def update_identity(self, traffic_type_id, environment_id, key, values):
-        pass
-
-    @abc.abstractmethod
-    def patch_identity(self, traffic_type_id, environment_id, key, values):
-        pass
-
-    @abc.abstractmethod
-    def delete_attributes_from_key(self, traffic_type_id, environment_id, key):
+    @abc.abstractproperty
+    def identity(self):
         pass

identify/main/identify_sync_client.py

@@ -9,57 +9,60 @@
 from identify.util.exceptions import InsufficientConfigArgumentsException
 
 
-class SyncIdentifyClient(BaseIdentifyClient):
+class TrafficTypeMicroClient:
     '''
-    Synchronous Identify API client
     '''
 
-    def __init__(self, config):
+    def __init__(self, http_client):
         '''
-        Class constructor.
+        '''
+        self._http_client = http_client
 
-        :param config: Dictionary containing optiones required to instantiate
-            the API client. Shoud have AT LEAST the following keys:
-                - 'base_url': Base url where the API is hosted
-                - 'apikey': APIKey used to authenticate the user.
+    def get_all(self):
         '''
-        if 'base_url' in config and 'apikey' in config:
-            self._base_url = config['base_url']
-            self._apikey = config['apikey']
-        else:
-            missing = [i not in config for i in ['base_url', 'apikey']]
-            raise InsufficientConfigArgumentsException(
-                'The following keys must be present in the config dict: %s'
-                % ','.join(missing)
-            )
+        Returns a list of TrafficType objects.
+        '''
+        return TrafficType.retrieve_all(self._http_client)
+
 
-        self._client = SyncHttpClient(self._base_url, self._apikey)
+class EnvironmentMicroClient:
+    '''
+    '''
 
-    def get_traffic_types(self):
+    def __init__(self, http_client):
         '''
-        Returns a list of TrafficType objects.
         '''
-        return TrafficType.retrieve_all(self._client)
+        self._http_client = http_client
 
-    def get_environments(self):
+    def get_all(self):
         '''
         Returns a list of environments.
         '''
-        return Environment.retrieve_all(self._client)
+        return Environment.retrieve_all(self._http_client)
+
 
-    def get_attributes_for_traffic_type(self, traffic_type_id):
+class AttributeMicroClient:
+    '''
+    '''
+
+    def __init__(self, http_client):
+        '''
+        '''
+        self._http_client = http_client
+
+    def get_all(self, traffic_type_id):
         '''
         Returns a list of attributes for a particular traffic type.
 
         :param traffic_type_id: Id of the traffic type whose attributes are to
             be retrieved.
         '''
         return Attribute.retrieve_all(
-            self._client,
+            self._http_client,
             trafficTypeId=traffic_type_id
         )
 
-    def create_attribute_for_traffic_type(self, traffic_type_id, attr_data):
+    def create(self, traffic_type_id, attr_data):
         '''
         Creates an attribute for a specific traffic type.
 
@@ -73,7 +76,7 @@ def create_attribute_for_traffic_type(self, traffic_type_id, attr_data):
                 - 'dataType': Data type of the new attribute
         '''
         return Attribute.create(
-            self._client,
+            self._http_client,
             attr_data.get('id'),
             traffic_type_id,
             attr_data.get('displayName'),
@@ -82,18 +85,28 @@ def create_attribute_for_traffic_type(self, traffic_type_id, attr_data):
             attr_data.get('isSearchable')
         )
 
-    def delete_attribute_from_schema(self, traffic_type_id, attribute_id):
+    def delete(self, traffic_type_id, attribute_id):
         '''
         Delete an attribute from a particular traffic type.
 
         :param traffic_type_id: Trafic id of the schema whose attribute
             will be removed.
         :param attribute_id: Id of the attribute to be removed.
         '''
-        return Attribute.delete(self._client, attribute_id, traffic_type_id)
+        return Attribute.delete(self._http_client, attribute_id, traffic_type_id)
+
+
+class IdentityMicroClient:
+    '''
+    '''
 
-    def add_identities(self, traffic_type_id, environment_id, identities,
-                       organization_id=None):
+    def __init__(self, http_client):
+        '''
+        '''
+        self._http_client = http_client
+
+    def add_many(self, traffic_type_id, environment_id, identities,
+                 organization_id=None):
         '''
         Create Identities for a specific traffic type and environment.
 
@@ -113,15 +126,15 @@ def add_identities(self, traffic_type_id, environment_id, identities,
                 }
         '''
         return Identity.create_many(
-            self._client,
+            self._http_client,
             traffic_type_id,
             environment_id,
             identities,
             organization_id
         )
 
-    def add_identity(self, traffic_type_id, environment_id, key, values,
-                     organization_id=None):
+    def add(self, traffic_type_id, environment_id, key, values,
+            organization_id=None):
         '''
         Create a new Identity.
 
@@ -136,16 +149,16 @@ def add_identity(self, traffic_type_id, environment_id, key, values,
                  }
         '''
         return Identity.create(
-            self._client,
+            self._http_client,
             key,
             traffic_type_id,
             environment_id,
             values,
             organization_id
         )
 
-    def update_identity(self, traffic_type_id, environment_id, key, values,
-                        organization_id=None):
+    def update(self, traffic_type_id, environment_id, key, values,
+               organization_id=None):
         '''
         Update an Identity.
 
@@ -160,16 +173,16 @@ def update_identity(self, traffic_type_id, environment_id, key, values,
                  }
         '''
         return Identity.update(
-            self._client,
+            self._http_client,
             key,
             traffic_type_id,
             environment_id,
             values,
             organization_id
         )
 
-    def patch_identity(self, traffic_type_id, environment_id, key, values,
-                       organization_id=None):
+    def patch(self, traffic_type_id, environment_id, key, values,
+              organization_id=None):
         '''
         Patch an Identity.
 
@@ -184,15 +197,15 @@ def patch_identity(self, traffic_type_id, environment_id, key, values,
                  }
         '''
         return Identity.patch(
-            self._client,
+            self._http_client,
             key,
             traffic_type_id,
             environment_id,
             values,
             organization_id
         )
 
-    def delete_attributes_from_key(self, traffic_type_id, environment_id, key):
+    def delete_attributes(self, traffic_type_id, environment_id, key):
         '''
         Delete all attributes for a specific key.
 
@@ -201,8 +214,56 @@ def delete_attributes_from_key(self, traffic_type_id, environment_id, key):
         :key: Key whose attributes will be deleted.
         '''
         return Identity.delete_all_attributes(
-            self._client,
+            self._http_client,
             traffic_type_id,
             environment_id,
             key
         )
+
+
+class SyncIdentifyClient(BaseIdentifyClient):
+    '''
+    Synchronous Identify API client
+    '''
+
+    def __init__(self, config):
+        '''
+        Class constructor.
+
+        :param config: Dictionary containing optiones required to instantiate
+            the API client. Shoud have AT LEAST the following keys:
+                - 'base_url': Base url where the API is hosted
+                - 'apikey': APIKey used to authenticate the user.
+        '''
+        if 'base_url' in config and 'apikey' in config:
+            self._base_url = config['base_url']
+            self._apikey = config['apikey']
+        else:
+            missing = [i not in config for i in ['base_url', 'apikey']]
+            raise InsufficientConfigArgumentsException(
+                'The following keys must be present in the config dict: %s'
+                % ','.join(missing)
+            )
+
+        http_client = SyncHttpClient(self._base_url, self._apikey)
+
+        self._traffic_type_client = TrafficTypeMicroClient(http_client)
+        self._environment_client = EnvironmentMicroClient(http_client)
+        self._attribute_client = AttributeMicroClient(http_client)
+        self._identity_client = IdentityMicroClient(http_client)
+
+    @property
+    def traffic_type(self):
+        return self._traffic_type_client
+
+    @property
+    def environment(self):
+        return self._environment_client
+
+    @property
+    def attribute(self):
+        return self._attribute_client
+
+    @property
+    def identity(self):
+        return self._identity_client