more code polishing, use helper to get microclient inside resources

Author: mredolatti

splitapiclient/resources/attribute.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 from splitapiclient.resources.base_resource import BaseResource
+from splitapiclient.util.helpers import require_client
 
 
 class Attribute(BaseResource):
@@ -73,14 +74,7 @@ def save(self, apiclient=None):
             the IdentifyClient instance should be passed in order to perform the
             http call
         '''
-        if apiclient is not None:
-            amc = apiclient.attributes
-        elif self._client is not None:
-            from splitapiclient.microclients import AttributeMicroClient
-            amc = AttributeMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
+        amc = require_client('Attribute', self._client, apiclient)
         return amc.save(self)
 
     def delete(self, apiclient=None):
@@ -91,12 +85,5 @@ def delete(self, apiclient=None):
             the IdentifyClient instance should be passed in order to perform the
             http call
         '''
-        if apiclient is not None:
-            amc = apiclient.attributes
-        elif self._client is not None:
-            from splitapiclient.microclients import AttributeMicroClient
-            amc = AttributeMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
+        amc = require_client('Attribute', self._client, apiclient)
         return amc.delete_by_instance(self)

splitapiclient/resources/environment.py

@@ -1,7 +1,7 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 from splitapiclient.resources.base_resource import BaseResource
-from splitapiclient.resources.identity import Identity
+from splitapiclient.util.helpers import require_client, as_dict
 
 
 class Environment(BaseResource):
@@ -35,17 +35,9 @@ def add_identity(self, data, apiclient=None):
             the IdentifyClient instance should be passed in order to perform the
             http call
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentifyClient is required')
-
-        identity = data.to_dict() if isinstance(data, Identity) else data
-        if not identity.get('environmentId'):
-            identity['environmentId'] = self.id
+        imc = require_client('Identity', self._client, apiclient)
+        identity = as_dict(data)
+        identity['environmentId'] = self.id
         return imc.save(identity)
 
     def add_identities(self, data, apiclient=None):
@@ -63,21 +55,8 @@ def add_identities(self, data, apiclient=None):
             for the failed item togegther with a status code and a message
         :rtype: tuple
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
-        # Convert identity objects to dicts if necessary before updating the
-        # environmentId
-        identities = [
-            i.to_dict() if isinstance(i, Identity) else i
-            for i in data
-        ]
+        imc = require_client('Identity', self._client, apiclient)
+        identities = [as_dict(i) for i in data]
         for item in identities:
-            if not item.get('environmentId'):
-                item['environmentId'] = self.id
+            item['environmentId'] = self.id
         return imc.save_all(identities)

splitapiclient/resources/identity.py

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 from splitapiclient.resources.base_resource import BaseResource
+from splitapiclient.util.helpers import as_dict, require_client
 
 
 class Identity(BaseResource):
@@ -75,14 +76,7 @@ def save(self, apiclient=None):
         :returns: newly saved Identity object
         :rtype: Identity
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
+        imc = require_client('Identity', self._client, apiclient)
         return imc.save(self.to_dict())
 
     def update(self, apiclient=None):
@@ -96,14 +90,7 @@ def update(self, apiclient=None):
         :returns: newly saved Identity object
         :rtype: Identity
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
+        imc = require_client('Identity', self._client, apiclient)
         return imc.update(self.to_dict())
 
     def delete(self, apiclient=None):
@@ -114,12 +101,5 @@ def delete(self, apiclient=None):
             the IdentifyClient instance should be passed in order to perform the
             http call
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
+        imc = require_client('Identity', self._client, apiclient)
         return imc.delete_by_instance(self)

splitapiclient/resources/traffic_type.py

@@ -1,10 +1,7 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 from splitapiclient.resources.base_resource import BaseResource
-from splitapiclient.resources.attribute import Attribute
-from splitapiclient.resources.identity import Identity
-from splitapiclient.util.exceptions import ClientRequiredError
-
+from splitapiclient.util.helpers import as_dict, require_client
 
 class TrafficType(BaseResource):
     '''
@@ -50,13 +47,7 @@ def fetch_attributes(self, apiclient=None):
         :returns: List of attributes associated with this traffic type
         :rtype: list(Attribute)
         '''
-        if apiclient is not None:
-            amc = apiclient.attributes
-        elif self._client is not None:
-            from splitapiclient.microclients import AttributeMicroClient
-            amc = AttributeMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An AttributeMicroClient is required')
+        amc = require_client('Attribute', self._client, apiclient)
         return amc.list(self.id)
 
     def add_attribute(self, data, apiclient=None):
@@ -71,17 +62,9 @@ def add_attribute(self, data, apiclient=None):
         :returns: Newly created attribute
         :rtype: Attribute
         '''
-        if apiclient is not None:
-            amc = apiclient.attributes
-        elif self._client is not None:
-            from splitapiclient.microclients import AttributeMicroClient
-            amc = AttributeMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An AttributeMicroClient is required')
-
-        attribute = data.to_dict() if isinstance(data, Attribute) else data
-        if not attribute.get('trafficTypeId'):
-            attribute['trafficTypeId'] = self.id
+        amc = require_client('Attribute', self._client, apiclient)
+        attribute = as_dict(data)
+        attribute['trafficTypeId'] = self.id
         return amc.save(attribute)
 
     def add_identity(self, data, apiclient=None):
@@ -96,17 +79,9 @@ def add_identity(self, data, apiclient=None):
         :returns: newly created Identity
         :rtype: Identity
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
-        identity = data.to_dict() if isinstance(data, Identity) else data
-        if not identity.get('trafficTypeId'):
-            identity['trafficTypeId'] = self.id
+        imc = require_client('Identity', self._client, apiclient)
+        identity = as_dict(data)
+        identity['trafficTypeId'] = self.id
         return imc.save(identity)
 
     def add_identities(self, data, apiclient=None):
@@ -124,20 +99,8 @@ def add_identities(self, data, apiclient=None):
             for the failed item togegther with a status code and a message
         :rtype: tuple
         '''
-        if apiclient is not None:
-            imc = apiclient.identities
-        elif self._client is not None:
-            from splitapiclient.microclients.identity_microclient import IdentityMicroClient
-            imc = IdentityMicroClient(self._client)
-        else:
-            raise ClientRequiredError('An IdentityMicroClient is required')
-
-        identities = [
-            i.to_dict() if isinstance(i, Identity) else i
-            for i in data
-        ]
+        imc = require_client('Identity', self._client, apiclient)
+        identities = [as_dict(i) for i in data]
         for item in identities:
-            if not item.get('trafficTypeId'):
-                item['trafficTypeId'] = self.id
+            item['trafficTypeId'] = self.id
         return imc.save_all(identities)
-

splitapiclient/tests/resources/test_attribute.py

@@ -4,6 +4,7 @@
 from splitapiclient.resources import Attribute
 from splitapiclient.microclients import AttributeMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.http_clients.base_client import BaseHttpClient
 from splitapiclient.main import get_client
 
 
@@ -65,7 +66,7 @@ def test_save(self, mocker):
             'dataType': 'string',
             'isSearchable': False,
         }
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = attr_data
         a1 = Attribute(attr_data, http_client_mock)
 
@@ -94,7 +95,7 @@ def test_save(self, mocker):
     def test_delete(self, mocker):
         '''
         '''
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = None
         a1 = Attribute(
             {

splitapiclient/tests/resources/test_environment.py

@@ -5,6 +5,7 @@
 from splitapiclient.resources import Identity
 from splitapiclient.microclients import IdentityMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.http_clients.base_client import BaseHttpClient
 from splitapiclient.main import get_client
 
 
@@ -51,7 +52,7 @@ def test_add_identity(self, mocker):
             'values': {'a1': 'v1'},
             'organizationId': 'o1',
         }
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = data
         env1 = Environment(
             {
@@ -122,7 +123,7 @@ def test_add_identities(self, mocker):
             'organizationId': 'o1',
         }]
 
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = {
             'objects': data,
             'failed': [],

splitapiclient/tests/resources/test_identity.py

@@ -2,6 +2,7 @@
     unicode_literals
 
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.http_clients.base_client import BaseHttpClient
 from splitapiclient.resources import Identity
 from splitapiclient.microclients import IdentityMicroClient
 from splitapiclient.main import get_client
@@ -52,7 +53,7 @@ def test_getters_and_setters(self):
     def test_save(self, mocker):
         '''
         '''
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         i1 = Identity(
             {
                 'key': 'key1',
@@ -94,7 +95,7 @@ def test_save(self, mocker):
     def test_update(self, mocker):
         '''
         '''
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         i1 = Identity(
             {
                 'key': 'key1',
@@ -136,7 +137,7 @@ def test_update(self, mocker):
     def test_delete(self, mocker):
         '''
         '''
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         i1 = Identity(
             {
                 'key': 'key1',

splitapiclient/tests/resources/test_traffic_type.py

@@ -7,6 +7,7 @@
 from splitapiclient.microclients import AttributeMicroClient
 from splitapiclient.microclients import IdentityMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.http_clients.base_client import BaseHttpClient
 from splitapiclient.main import get_client
 
 
@@ -64,7 +65,7 @@ def test_fetch_attributes(self, mocker):
             'dataType': 'string',
             'description': 'd2',
         }]
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = data
         tt1 = TrafficType(
             {
@@ -109,7 +110,7 @@ def test_add_attribute(self, mocker):
             'dataType': 'string',
             'description': 'd1',
         }
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = data
         tt1 = TrafficType(
             {
@@ -166,7 +167,7 @@ def test_add_identity(self, mocker):
             'values': {'a1': 'v1'},
             'organizationId': 'o1',
         }
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = data
         tt1 = TrafficType(
             {
@@ -240,7 +241,7 @@ def test_add_identities(self, mocker):
             'organizationId': 'o1',
         }]
 
-        http_client_mock = mocker.Mock()
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
         http_client_mock.make_request.return_value = {
             'objects': data,
             'failed': [],