Added Support for Workspace feature

Author: Bilal Al-Shahwany

splitapiclient/main/apiclient.py

@@ -20,6 +20,11 @@ def traffic_types(self):
     def environments(sself):
         pass
 
+    @abc.abstractproperty
+    def workspaces(sself):
+        pass
+
+    
     @abc.abstractproperty
     def attributes(self):
         pass

splitapiclient/main/sync_apiclient.py

@@ -5,6 +5,7 @@
 from splitapiclient.util.exceptions import InsufficientConfigArgumentsException
 from splitapiclient.microclients import TrafficTypeMicroClient
 from splitapiclient.microclients import EnvironmentMicroClient
+from splitapiclient.microclients import WorkspaceMicroClient
 from splitapiclient.microclients import IdentityMicroClient
 from splitapiclient.microclients import AttributeMicroClient
 
@@ -14,7 +15,8 @@ class SyncApiClient(BaseApiClient):
     Synchronous Split API client
     '''
 
-    BASE_PROD_URL = 'https://api.split.io/internal/api/v1'
+    BASE_PROD_URL = 'https://api.split.io/internal/api/v2'
+    BASE_PROD_URL_OLD = 'https://api.split.io/internal/api/v1'
 
     def __init__(self, config):
         '''
@@ -29,6 +31,7 @@ def __init__(self, config):
             self._base_url = config['base_url']
         else:
             self._base_url = self.BASE_PROD_URL
+            self._base_url_old = self.BASE_PROD_URL_OLD
 
         missing = [i for i in ['apikey'] if i not in config]
         if missing:
@@ -38,10 +41,13 @@ def __init__(self, config):
             )
 
         self._apikey = config['apikey']
-        http_client = SyncHttpClient(self._base_url, self._apikey)
-
+        
+        http_client = SyncHttpClient(self._base_url_old, self._apikey)
         self._traffic_type_client = TrafficTypeMicroClient(http_client)
+
+        http_client = SyncHttpClient(self._base_url, self._apikey)
         self._environment_client = EnvironmentMicroClient(http_client)
+        self._workspace_client = WorkspaceMicroClient(http_client)
         self._attribute_client = AttributeMicroClient(http_client)
         self._identity_client = IdentityMicroClient(http_client)
 
@@ -53,6 +59,10 @@ def traffic_types(self):
     def environments(self):
         return self._environment_client
 
+    @property
+    def workspaces(self):
+        return self._workspace_client
+
     @property
     def attributes(self):
         return self._attribute_client

splitapiclient/microclients/__init__.py

@@ -1,4 +1,5 @@
 from splitapiclient.microclients.traffic_type_microclient import TrafficTypeMicroClient
 from splitapiclient.microclients.environment_microclient import EnvironmentMicroClient
+from splitapiclient.microclients.workspace_microclient import WorkspaceMicroClient
 from splitapiclient.microclients.attribute_microclient import AttributeMicroClient
 from splitapiclient.microclients.identity_microclient import IdentityMicroClient

splitapiclient/microclients/attribute_microclient.py

@@ -10,7 +10,7 @@ class AttributeMicroClient:
     _endpoint = {
         'all_items': {
             'method': 'GET',
-            'url_template': 'trafficTypes/{trafficTypeId}/schema',
+            'url_template': 'schema/ws/{workspaceId}/trafficTypes/{trafficTypeId}',
             'headers': [{
                 'name': 'Authorization',
                 'template': 'Bearer {value}',
@@ -20,8 +20,8 @@ class AttributeMicroClient:
             'response': True,
         },
         'create': {
-            'method': 'PUT',
-            'url_template': 'trafficTypes/{trafficTypeId}/schema',
+            'method': 'POST',
+            'url_template': 'schema/ws/{workspaceId}/trafficTypes/{trafficTypeId}',
             'headers': [{
                 'name': 'Authorization',
                 'template': 'Bearer {value}',
@@ -32,7 +32,7 @@ class AttributeMicroClient:
         },
         'delete': {
             'method': 'DELETE',
-            'url_template': 'trafficTypes/{trafficTypeId}/schema/{attributeId}',
+            'url_template': 'schema/ws/{workspaceId}/trafficTypes/{trafficTypeId}/schema/{attributeId}',
             'headers': [{
                 'name': 'Authorization',
                 'template': 'Bearer {value}',
@@ -48,7 +48,7 @@ def __init__(self, http_client):
         '''
         self._http_client = http_client
 
-    def list(self, traffic_type_id):
+    def list(self, workspace_id, traffic_type_id):
         '''
         Returns a list of TrafficType objects.
 
@@ -58,7 +58,8 @@ def list(self, traffic_type_id):
         '''
         response = self._http_client.make_request(
             self._endpoint['all_items'],
-            trafficTypeId=traffic_type_id
+            trafficTypeId=traffic_type_id,
+            workspaceId=workspace_id
         )
         return [Attribute(item, self._http_client) for item in response]
 
@@ -73,14 +74,18 @@ def save(self, attribute):
         :rtype: Attribute
         '''
         data = as_dict(attribute)
+        wsId=data.get('workspaceId')
+        del data['workspaceId']
+        del data['isSearchable']
         response = self._http_client.make_request(
             self._endpoint['create'],
             data,
-            trafficTypeId=data.get('trafficTypeId')
+            trafficTypeId=data.get('trafficTypeId'),
+            workspaceId=wsId
         )
         return Attribute(response, self._http_client)
 
-    def delete(self, attribute_id, traffic_type_id):
+    def delete(self, attribute_id, workspace_id, traffic_type_id):
         '''
         Delete an attribute by specifying its id and it's traffic type id.
 
@@ -90,7 +95,8 @@ def delete(self, attribute_id, traffic_type_id):
         return self._http_client.make_request(
             self._endpoint['delete'],
             trafficTypeId=traffic_type_id,
-            attributeId=attribute_id
+            attributeId=attribute_id,
+            workspaceId=workspace_id
         )
 
     def delete_by_instance(self, attribute):
@@ -102,5 +108,6 @@ def delete_by_instance(self, attribute):
         data = as_dict(attribute)
         return self.delete(
             data.get('id'),
-            data.get('trafficTypeId')
+            data.get('trafficTypeId'),
+            data.get('workspaceId')
         )

splitapiclient/microclients/environment_microclient.py

@@ -9,7 +9,7 @@ class EnvironmentMicroClient:
     _endpoint = {
         'all_items': {
             'method': 'GET',
-            'url_template': 'environments',
+            'url_template': 'environments/ws/{workspaceId}',
             'headers': [{
                 'name': 'Authorization',
                 'template': 'Bearer {value}',
@@ -26,14 +26,15 @@ def __init__(self, http_client):
         '''
         self._http_client = http_client
 
-    def list(self):
+    def list(self, workspace_id):
         '''
         Returns a list of Environment objects.
 
         :returns: list of Environment objects
         :rtype: list(Environment)
         '''
         response = self._http_client.make_request(
-            self._endpoint['all_items']
+            self._endpoint['all_items'],
+            workspaceId =workspace_id
         )
         return [Environment(item, self._http_client) for item in response]

splitapiclient/microclients/workspace_microclient.py

@@ -0,0 +1,39 @@
+from splitapiclient.resources import Workspace
+from splitapiclient.util.exceptions import HTTPResponseError, \
+    UnknownApiClientError
+from splitapiclient.util.logger import LOGGER
+
+class WorkspaceMicroClient:
+    '''
+    '''
+    _endpoint = {
+        'all_items': {
+            'method': 'GET',
+            'url_template': 'workspaces',
+            'headers': [{
+                'name': 'Authorization',
+                'template': 'Bearer {value}',
+                'required': True,
+            }],
+            'query_string': [],
+            'response': True,
+        },
+    }
+
+    def __init__(self, http_client):
+        '''
+        Constructor
+        '''
+        self._http_client = http_client
+
+    def list(self):
+        '''
+        Returns a list of Workspaces objects.
+
+        :returns: list of Workspaces objects
+        :rtype: list(Workspaces)
+        '''
+        response = self._http_client.make_request(
+            self._endpoint['all_items']
+        )
+        return [Workspace(item, self._http_client) for item in response['objects']]

splitapiclient/resources/__init__.py

@@ -1,4 +1,5 @@
 from splitapiclient.resources.traffic_type import TrafficType
 from splitapiclient.resources.environment import Environment
+from splitapiclient.resources.workspace import Workspace
 from splitapiclient.resources.identity import Identity
 from splitapiclient.resources.attribute import Attribute

splitapiclient/resources/attribute.py

@@ -14,6 +14,7 @@ class Attribute(BaseResource):
         'description': 'string',
         'dataType': 'string',
         'isSearchable': 'bool',
+        'workspaceId' : 'string',
     }
 
     def __init__(self, data=None, client=None):
@@ -27,6 +28,7 @@ def __init__(self, data=None, client=None):
         self._description = data.get('description')
         self._data_type = data.get('dataType')
         self._is_searchable = data.get('isSearchable')
+        self._workspace_id = data.get('workspaceId')
 
     @property
     def traffic_type_id(self):

splitapiclient/resources/environment.py

@@ -10,6 +10,7 @@ class Environment(BaseResource):
     _schema = {
         'id': 'string',
         'name': 'string',
+        'workspaceId' : 'string',
     }
 
     def __init__(self, data=None, client=None):
@@ -19,7 +20,12 @@ def __init__(self, data=None, client=None):
             data = {}
         BaseResource.__init__(self, data.get('id'), client)
         self._name = data.get('name')
+        self._workspace_id = data.get('workspaceId')
 
+    @property
+    def workspace_id(self):
+        return self._workspace_id
+            
     @property
     def name(self):
         return self._name

splitapiclient/resources/workspace.py

@@ -0,0 +1,64 @@
+from __future__ import absolute_import, division, print_function, \
+    unicode_literals
+from splitapiclient.resources.base_resource import BaseResource
+from splitapiclient.util.helpers import require_client, as_dict
+
+
+class Workspace(BaseResource):
+    '''
+    '''
+    _schema = {
+        'id': 'string',
+        'name': 'string',
+    }
+
+    def __init__(self, data=None, client=None):
+        '''
+        '''
+        if not data:
+            data = {}
+        BaseResource.__init__(self, data.get('id'), client)
+        self._name = data.get('name')
+
+    @property
+    def name(self):
+        return self._name
+
+    @name.setter
+    def name(self, new):
+        self._name = new
+
+    def add_identity(self, data, apiclient=None):
+        '''
+        Add a new identity associated with this environment.
+
+        :param data: Identity object or dict containing identity properties
+        :param apiclient: If this instance wasn't returned by the client,
+            the IdentifyClient instance should be passed in order to perform the
+            http call
+        '''
+        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):
+        '''
+        Add multiple new identities associated with this environment.
+
+        :param data: list ofIdentity objects or dicts containing identity
+            properties
+        :param apiclient: 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
+        '''
+        imc = require_client('Identity', self._client, apiclient)
+        identities = [as_dict(i) for i in data]
+        for item in identities:
+            item['environmentId'] = self.id
+        return imc.save_all(identities)