version 3.11 added get definition and updated to toml

Author: kleinjoshuaa

CHANGES.txt

@@ -31,4 +31,5 @@
 - Fixed `to_dict()` method for Segments, Segment Definitions and Split Definitions
 3.1.10 (Oct 30, 2023)
 - Added scope options for admin api
-
+3.1.11 (Dec 13, 2023)
+- Added ability to get individual flag definitions with the `get_definition` method of splitDefinition

pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools>=61.2", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "splitapiclient"
+version = "3.1.11"
+description = "This Python Library provide full support for Split REST Admin API, allow creating, deleting and editing Environments, Splits, Split Definitions, Segments, Segment Keys, Users, Groups, API Keys, Change Requests, Attributes and Identities"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries",
+]
+authors = [
+  {name = "Patricio Echague", email = "[email protected]"},
+  {name = "Sebastian Arrubia", email = "[email protected]"},
+  {name = "Martin Redolatti", email = "[email protected]"},
+  {name = "Bilal Al-Shawany", email = "[email protected]"},
+]
+maintainers = [
+  {name = "Josh Klein", email = "[email protected]"}
+]
+
+
+[project.license]
+text = "Apache License 2.0"
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[project.urls]
+Homepage = "https://github.com/splitio/python-api"
+"Bug Tracker" = "https://github.com/splitio/python-api/issues"
+Documentation = "https://help.split.io/hc/en-us/articles/4412331052685-Python-PyPi-library-for-Split-REST-Admin-API"
+
+[tool.aliases]
+test = "pytest"
+
+[tool.pytest.ini_options]
+addopts = "--verbose"
+
+[tool.setuptools]
+include-package-data = false
+
+[aliases]
+test = "pytest"
+
+[tool.pytest]
+addopts = "--verbose"
+
+[options]
+packages = "find:"
+setup_requires = "pytest-runner"
+
+[options.install_requires]
+"argparse>" = "1.1"
+"requests>" = "2.14.2"
+"six>" = "1.10.0"
+
+[options.tests_require]
+mock = "=2.0.0"
+pytest-mock = "=1.6.0"
+pytest = "=6.2.4"

pyvenv.cfg

@@ -1,5 +1,5 @@
 from splitapiclient.resources import SplitDefinition
-from splitapiclient.util.exceptions import HTTPResponseError, \
+from splitapiclient.util.exceptions import HTTPNotFoundError, HTTPResponseError, \
     UnknownApiClientError
 from splitapiclient.util.logger import LOGGER
 from splitapiclient.util.helpers import as_dict
@@ -19,6 +19,17 @@ class SplitDefinitionMicroClient:
             'query_string': [],
             'response': True,
         },
+        'get_definition': {
+            'method': 'GET',
+            'url_template': ('splits/ws/{workspaceId}/{splitName}/environments/{environmentId}'),
+            'headers': [{
+                'name': 'Authorization',
+                'template': 'Bearer {value}',
+                'required': True,
+            }],
+            'query_string': [],
+            'response': True,
+        },
         'update_definition': {
             'method': 'PUT',
             'url_template': ('splits/ws/{workspaceId}/{splitName}/environments/{environmentId}'),
@@ -101,6 +112,26 @@ def find(self, split_name, environment_id, workspace_id):
         LOGGER.error("Split Name does not exist")
         return None
 
+    def get_definition(self, split_name, environment_id, workspace_id):
+        '''
+        Get a Split definition in a single API request.
+
+        :returns: SplitDefinition object
+        :rtype: SplitDefinition
+        '''
+        try:
+            response = self._http_client.make_request(
+                    self._endpoint['get_definition'],
+                    workspaceId = workspace_id,
+                    environmentId = environment_id,
+                    splitName = split_name
+            )
+            item = as_dict(response)
+            return SplitDefinition(item, environment_id, workspace_id, self._http_client)
+        except HTTPNotFoundError as e:
+            LOGGER.error("Split Name '%s' does not exist", split_name)
+            return None
+        
     def update_definition(self, split_name, environment_id, workspace_id, new_definition):
         '''
         update a split definition
@@ -155,4 +186,3 @@ def restore(self, split_name, environment_id, workspace_id):
             splitName = split_name
         )
         return response
-

setup.cfg

@@ -9,7 +9,7 @@ class TestSyncApiClient:
     '''
     '''
 
-    def test_constructor(self, mock):
+    def test_constructor(self):
         '''
         '''
         # Should have PROD url by default

setup.py

@@ -105,3 +105,50 @@ def test_list(self, mocker):
             }]
         assert object_to_stringified_dict(result[0]) == data[0]
         assert object_to_stringified_dict(result[1]) == data[1]
+        
+    def test_get_definition(self, mocker):
+        '''
+        '''
+        mocker.patch('splitapiclient.http_clients.sync_client.SyncHttpClient.make_request')
+        sc = SyncHttpClient('abc', 'abc')
+        emc = SplitDefinitionMicroClient(sc)
+        data = {
+                'name': 'split1',
+                'environment': Environment(data={'changePermissions': None, 'creationTime': None, 'dataExportPermissions': None, 'environmentType': None, 'workspaceIds': ['ws_id'], 'name':None, 'type': None, 'orgId': None, 'id':None, 'status':None}).to_dict(),
+                'trafficType': {'displayAttributeId': None, 'id': None, 'name': None},
+                'killed': False,
+                'treatments': [],
+                'defaultTreatment': 'off',
+                'baselineTreatment': 'off',
+                'trafficAllocation': 100,
+                'rules': [],
+                'defaultRule': [],
+                'creationTime': None,
+                'lastUpdateTime': None,
+                'lastTrafficReceivedAt': None
+            }
+
+        SyncHttpClient.make_request.return_value = data
+        result = emc.get_definition('split1', 'env_id', 'ws_id')
+        SyncHttpClient.make_request.assert_called_once_with(
+            SplitDefinitionMicroClient._endpoint['get_definition'],
+            workspaceId = 'ws_id',
+            environmentId = 'env_id',
+            splitName = 'split1'
+        )
+        data = {
+                'name': 'split1',
+                'environment': Environment(data={'changePermissions': None, 'creationTime': None, 'dataExportPermissions': None, 'environmentType': None, 'workspaceIds': ['ws_id'], 'name':None, 'type': None, 'orgId': None, 'id':None, 'status':None}).to_dict(),
+                'trafficType': {'displayAttributeId': None, 'id': None, 'name': None},
+                'killed': False,
+                'treatments': None,
+                'defaultTreatment': 'off',
+                'baselineTreatment': 'off',
+                'trafficAllocation': 100,
+                'rules': None,
+                'defaultRule': None,
+                'creationTime': None,
+                'lastUpdateTime': None,
+                'lastTrafficReceivedAt': None
+            }
+        assert object_to_stringified_dict(result) == data

splitapiclient/microclients/split_definition_microclient.py

@@ -1 +1 @@
-__version__ = '3.1.10'
+__version__ = '3.1.11'