Added full support for Admin API: (Users, Groups, Splits, Split Definitions, Segments, Segments Definitions, Rollout dashboard, Change requests and API Keys)

Author: chillaq

.DS_Store

@@ -1,2 +1,6 @@
 1.0 (July 10th, 2017)
  - Initial release
+2.0 (June 23rd, 2019)
+- Added Workspace and update base URL to use v2
+3.0 (June 23rd, 2019)
+- Added support for Users, Groups, Splits, Split Definitions, Segments, Segments Definitions, Rollout dashboard, Change requests and API Keys

CHANGES.txt

@@ -6,6 +6,166 @@ This API wrapper is designed to work with [Split](https://www.split.io), the pla
 
 For specific instructions on how to use this API refer to our [official API documentation](https://docs.split.io/reference).
 
+Install the split-admin-api:
+`pip install split-admin-api`
+
+Import the client object and initialize connection using an Admin API Key:
+`from splitapiclient.main import get_client
+client = get_client({'apikey': 'ADMIN API KEY'})
+`
+Enable optional logging:
+`import logging
+logging.basicConfig(level=logging.DEBUG)
+`
+**Workspaces**
+Fetch all workspaces:
+`for ws in client.workspaces.list():
+    print ("\nWorkspace:"+ws.name+", Id: "+ws.id)
+`
+Find a specific workspaces:
+`ws = client.workspaces.find("Defaults")
+print ("\nWorkspace:"+ws.name+", Id: "+ws.id)
+`
+**Environments**
+Fetch all Environments:
+`ws = client.workspaces.find("Defaults")
+for env in client.environments.list(ws.id):
+    print ("\nEnvironment: "+env.name+", Id: "+env.id)
+Add new environment:
+`ws = client.workspaces.find("Defaults")
+env = ws.add_environment({'name':'new_environment', 'production':False})
+`
+
+**Splits**
+Fetch all Splits:
+`ws = client.workspaces.find("Defaults")
+for split in client.splits.list(ws.id):
+    print ("\nSplit: "+split.name+", "+split._workspace_id)
+`
+Add new Split:
+`
+split = ws.add_split({'name':'split_name', 'description':'new UI feature'}, "user")
+print(split.name)
+`
+Add tags:
+`
+split.associate_tags(['my_new_tag', 'another_new_tag'])
+`
+Add Split to environment:
+`
+ws = client.workspaces.find("Defaults")
+split = client.splits.find("new_feature", ws.id) 
+env = client.environments.find("Production", ws.id)
+tr1 = treatment.Treatment({"name":"on","configurations":""})
+tr2 = treatment.Treatment({"name":"off","configurations":""})
+bk1 = bucket.Bucket({"treatment":"on","size":50})
+bk2 = bucket.Bucket({"treatment":"off","size":50})
+match = matcher.Matcher({"attribute":"group","type":"IN_LIST_STRING","strings":["employees"]})
+cond = condition.Condition({'matchers':[match.export_dict()]})
+rl = rule.Rule({'condition':cond.export_dict(), 'buckets':[bk1.export_dict(), bk2.export_dict()]})
+defrl = default_rule.DefaultRule({"treatment":"off","size":100}) 
+data={"treatments":[tr1.export_dict() ,tr2.export_dict()],"defaultTreatment":"off", "baselineTreatment": "off","rules":[rl.export_dict()],"defaultRule":[defrl.export_dict()], "comment": "adding split to production"}
+splitdef = split.add_to_environment(env.id, data)
+`
+Kill Split:
+`
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+splitDef = client.split_definitions.find("new_feature", env.id, ws.id)
+splitDef.kill()
+`
+Restore Split:
+`
+splitDef.restore()
+`
+Fetch all Splits in an Environment:
+`
+ws = client.workspaces.find("Defaults")
+env = client.environments.find("Production", ws.id)
+for spDef in client.split_definitions.list(env.id, ws.id):
+    print(spDef.name+str(spDef._default_rule))
+`
+Submit a Change request to update a Split definition:
+`
+splitDef = client.split_definitions.find("new_feature", env.id, ws.id)
+definition= {"treatments":[ {"name":"on"},{"name":"off"}],
+    "defaultTreatment":"off", "baselineTreatment": "off",
+    "rules": [],
+    "defaultRule":[{"treatment":"off","size":100}],"comment": "updating default rule"
+}
+splitDef.submit_change_request(definition, 'UPDATE', 'updating default rule', 'comment', ['user@email.com'], '')
+`
+List all change requests:
+`
+for cr in client.change_requests.list():
+    if cr._split is not None:
+        print (cr._id+", "+cr._split['name']+", "+cr._title+", "+str(cr._split['environment']['id'])) 
+    if cr._segment is not None:
+        print (cr._id+", "+cr._segment['name']+", "+cr._title)
+`
+Approve specific change request:
+`
+for cr in client.change_requests.list():
+    if cr._split['name']=='new_feature':
+        cr.update_status("APPROVED", "done")
+`
+**Users and Groups**
+Fetch all Active users:
+`
+for user in client.users.list('ACTIVE'):
+    print(user.email+", "+user._id) 
+`
+Invite new user:
+`
+group = client.groups.find('Administrators')
+userData = {'email':'user@email.com', 'groups':[{'id':'', 'type':'group'}]}
+userData['groups'][0]['id'] = group._id
+client.users.invite_user(userData)
+`
+Delete a pending invite:
+`
+for user in client.users.list('PENDING'):
+    print(user.email+", "+user._id+", "+user._status)
+    if user.email == 'user@email.com': 
+        client.users.delete(user._id)
+`
+Update user info:
+`
+data = {'name':'new_name', 'email':'user@email.com', '2fa':False, 'status':'ACTIVE'}
+user = client.users.find('user@email.com')
+user.update_user(user._id, data)
+`
+Fetch all Groups:
+`
+for group in client.groups.list():
+    print (group._id+", "+group._name)
+`
+Create Group:
+`
+client.groups.create_group({'name':'new_group', 'description':''})
+`
+Delete Group:
+`
+group = client.groups.find('new_group')
+client.groups.delete_group(group._id)
+`
+Replace existing user group:
+`
+user = client.users.find('user@email.com')
+group = client.groups.find('Administrators')
+data = [{'op': 'replace', 'path': '/groups/0', 'value': {'id': '<groupId>', 'type':'group'}}]
+data[0]['value']['id'] = group._id
+user.update_user_group(data)
+`
+Add user to new group
+`
+user = client.users.find('user@email.com')
+group = client.groups.find('Administrators')
+data = [{'op': 'add', 'path': '/groups/-', 'value': {'id': '<groupId>', 'type':'group'}}]
+data[0]['value']['id'] = group._id
+user.update_user_group(data)
+`
+
 ### Commitment to Quality:
 
 Split’s APIs are in active development and are constantly tested for quality. Unit tests are developed for each wrapper based on the unique needs of that language, and integration tests, load and performance tests, and behavior consistency tests are running 24/7 via automated bots. In addition, monitoring instrumentation ensures that these wrappers behave under the expected parameters of memory, CPU, and I/O.
@@ -14,17 +174,6 @@ Split’s APIs are in active development and are constantly tested for quality.
 
 Split is the leading platform for intelligent software delivery, helping businesses of all sizes deliver exceptional user experiences, and mitigate risk, by providing an easy, secure way to target features to customers. Companies like WePay, LendingTree and thredUP rely on Split to safely launch and test new features and derive insights on their use. Founded in 2015, Split's team comes from some of the most innovative enterprises in Silicon Valley, including Google, LinkedIn, Salesforce and Splunk. Split is based in Redwood City, California and backed by Accel Partners and Lightspeed Venture Partners. To learn more about Split, contact hello@split.io, or start a 14-day free trial at www.split.io/trial.
 
-Split has built and maintains a API wrappers for:
-
-* Java [Github](https://github.com/splitio/java-api)
-* Node [Github](https://github.com/splitio/javascript-api)
-* .NET [Github](https://github.com/splitio/.net-api)
-* Ruby [Github](https://github.com/splitio/ruby-api)
-* PHP [Github](https://github.com/splitio/php-api)
-* Python [Github](https://github.com/splitio/python-api)
-
-For a comprehensive list of opensource projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
-
 **Try Split for Free:**
 
 Split is available as a 14-day free trial. To create an account, visit [split.io/trial](https://www.split.io/trial).

README.md

@@ -90,7 +90,7 @@ def run(self):
 tests_requires = [
     'mock==2.0.0',
     'pytest-mock==1.6.0',
-    'pytest==3.1.3',
+    'pytest==6.2.4',
 ]
 
 

setup.py

@@ -45,7 +45,7 @@ def make_request(self, method, body=None, **kwargs):
     @staticmethod
     def get_params_from_url_template(url):
         '''
-        Retuns a list of tempated variables that must be replaced when
+        Retuns a list of templated variables that must be replaced when
         instantiating the url template.
 
         :param url: url template

splitapiclient/.DS_Store

@@ -1,6 +1,7 @@
 from __future__ import absolute_import, division, print_function, \
     unicode_literals
 import json
+import time
 from functools import partial
 import requests
 from splitapiclient.http_clients import base_client
@@ -95,15 +96,23 @@ def make_request(self, endpoint, body=None, **kwargs):
             LOGGER.debug('BODY: ' + json.dumps(body))
 
         # Make the actual HTTP call!
-        try:
-            response = method(url, headers=headers)
-            LOGGER.debug('RESPONSE: ' + response.text)
-        except Exception as e:
-            return self._handle_connection_error(e)
-
-        if not response.status_code == 200:
+        while True:
+            try:
+                response = method(url, headers=headers)
+                LOGGER.debug('RESPONSE: ' + response.text)
+            except Exception as e:
+                return self._handle_connection_error(e)
+            if response.status_code==429:
+                LOGGER.warning('RESPONSE CODE: %s, retrying in 5 seconds' % response.status_code)
+                time.sleep(5)
+                continue
+            else:
+                break
+            
+        if not (response.status_code == 200 or response.status_code == 204):
             LOGGER.warning('RESPONSE CODE: %s' % response.status_code)
             self._handle_invalid_response(response)
 
         if endpoint.get('response', False):
-            return json.loads(response.text)
+            if response.status_code != 204:
+                return json.loads(response.text)

splitapiclient/http_clients/base_client.py

@@ -17,11 +17,27 @@ def traffic_types(self):
         pass
 
     @abc.abstractproperty
-    def environments(sself):
+    def environments(self):
         pass
 
     @abc.abstractproperty
-    def workspaces(sself):
+    def splits(self):
+        pass
+
+    @abc.abstractproperty
+    def split_definitions(self):
+        pass
+
+    @abc.abstractproperty
+    def segments(self):
+        pass
+
+    @abc.abstractproperty
+    def segment_definitions(self):
+        pass
+
+    @abc.abstractproperty
+    def workspaces(self):
         pass
 
 
@@ -32,3 +48,19 @@ def attributes(self):
     @abc.abstractproperty
     def identities(self):
         pass
+
+    @abc.abstractproperty
+    def change_requests(self):
+        pass
+
+    @abc.abstractproperty
+    def users(self):
+        pass
+
+    @abc.abstractproperty
+    def groups(self):
+        pass
+
+    @abc.abstractproperty
+    def apikeys(self):
+        pass

splitapiclient/http_clients/sync_client.py

@@ -5,9 +5,17 @@
 from splitapiclient.util.exceptions import InsufficientConfigArgumentsException
 from splitapiclient.microclients import TrafficTypeMicroClient
 from splitapiclient.microclients import EnvironmentMicroClient
+from splitapiclient.microclients import SplitMicroClient
+from splitapiclient.microclients import SplitDefinitionMicroClient
+from splitapiclient.microclients import SegmentMicroClient
+from splitapiclient.microclients import SegmentDefinitionMicroClient
 from splitapiclient.microclients import WorkspaceMicroClient
 from splitapiclient.microclients import IdentityMicroClient
 from splitapiclient.microclients import AttributeMicroClient
+from splitapiclient.microclients import ChangeRequestMicroClient
+from splitapiclient.microclients import UserMicroClient
+from splitapiclient.microclients import GroupMicroClient
+from splitapiclient.microclients import APIKeyMicroClient
 
 
 class SyncApiClient(BaseApiClient):
@@ -42,14 +50,20 @@ def __init__(self, config):
 
         self._apikey = config['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._split_client = SplitMicroClient(http_client)
+        self._split_definition_client = SplitDefinitionMicroClient(http_client)
+        self._segment_client = SegmentMicroClient(http_client)
+        self._segment_definition_client = SegmentDefinitionMicroClient(http_client)
         self._workspace_client = WorkspaceMicroClient(http_client)
+        self._traffic_type_client = TrafficTypeMicroClient(http_client)
         self._attribute_client = AttributeMicroClient(http_client)
         self._identity_client = IdentityMicroClient(http_client)
+        self._change_request_client = ChangeRequestMicroClient(http_client)
+        self._user_client = UserMicroClient(http_client)
+        self._group_client = GroupMicroClient(http_client)
+        self._apikey_client = APIKeyMicroClient(http_client)
 
     @property
     def traffic_types(self):
@@ -59,6 +73,22 @@ def traffic_types(self):
     def environments(self):
         return self._environment_client
 
+    @property
+    def splits(self):
+        return self._split_client
+
+    @property
+    def split_definitions(self):
+        return self._split_definition_client
+
+    @property
+    def segments(self):
+        return self._segment_client
+
+    @property
+    def segment_definitions(self):
+        return self._segment_definition_client
+
     @property
     def workspaces(self):
         return self._workspace_client
@@ -70,3 +100,19 @@ def attributes(self):
     @property
     def identities(self):
         return self._identity_client
+
+    @property
+    def change_requests(self):
+        return self._change_request_client
+
+    @property
+    def users(self):
+        return self._user_client
+
+    @property
+    def groups(self):
+        return self._group_client
+
+    @property
+    def apikeys(self):
+        return self._apikey_client