comments and titles when removing a split & updated logging upon error

Author: kleinjoshuaa

CHANGES.txt

@@ -21,4 +21,7 @@
 3.1.5 (Sept 8th, 2022)
 - Added `import_attributes_from_json` for trafficType object
 3.1.6 (Nov 2nd, 2022)
-- Added `baselineTreatment` for splitDefinition object
+- Added `baselineTreatment` for splitDefinition object
+3.1.7 (Mar 2nd, 2023)
+- Added `comment` and `title` as optional parameters for the `remove_from_environment` method of a Split
+- Updated default logging to be more useful

splitapiclient/http_clients/sync_client.py

@@ -55,7 +55,7 @@ def _handle_invalid_response(self, response):
         if exc:
             raise exc()
         else:
-            raise HTTPResponseError()
+            raise HTTPResponseError(response.text)
 
     def _handle_connection_error(self, e):
         '''

splitapiclient/microclients/split_microclient.py

@@ -78,7 +78,7 @@ class SplitMicroClient:
         },
         'remove_from_environment': {
             'method': 'DELETE',
-            'url_template': ('splits/ws/{workspaceId}/{splitName}/environments/{environmentId}'),
+            'url_template': ('splits/ws/{workspaceId}/{splitName}/environments/{environmentId}?title={title}&comment={comment}'),
             'headers': [{
                 'name': 'Authorization',
                 'template': 'Bearer {value}',
@@ -240,11 +240,11 @@ def add_to_environment(self, split_name, environment_id, workspace_id, data):
         )
         return SplitDefinition(response, environment_id, workspace_id, self._http_client)
 
-    def remove_from_environment(self, split_name, environment_id, workspace_id):
+    def remove_from_environment(self, split_name, environment_id,comment, title, workspace_id ):
         '''
         Remove split from environment
 
-        :param split: split name, environment id, workspace id
+        :param split: split name, environment id, workspace id, comment, title
         
         :returns: True if successful
         :rtype: boolean
@@ -254,7 +254,9 @@ def remove_from_environment(self, split_name, environment_id, workspace_id):
             self._endpoint['remove_from_environment'],
             workspaceId = workspace_id,
             environmentId = environment_id,
-            splitName = split_name
+            splitName = split_name,
+            comment = comment, 
+            title = title
         )
         return response
 

splitapiclient/resources/split.py

@@ -73,11 +73,13 @@ def add_to_environment(self, environment_id, data, apiclient=None):
         imc = require_client('Split', self._client, apiclient)
         return imc.add_to_environment(self._name, environment_id, self._workspace_id, data)
 
-    def remove_from_environment(self, environment_id, apiclient=None):
+    def remove_from_environment(self, environment_id, comment="", title="", apiclient=None):
         '''
         Remove split from environment
 
         :param data: environment id
+        :param data: title
+        :param data: comment
         :param apiclient: If this instance wasn't returned by the client,
             the IdentifyClient instance should be passed in order to perform the
             http call
@@ -86,7 +88,7 @@ def remove_from_environment(self, environment_id, apiclient=None):
         :rtype: SplitDefinition
         '''
         imc = require_client('Split', self._client, apiclient)
-        return imc.remove_from_environment(self._name, environment_id, self._workspace_id)
+        return imc.remove_from_environment(self._name, environment_id, comment, title, self._workspace_id)
 
     def associate_tags(self, tags, apiclient=None):
         '''

splitapiclient/tests/resources/test_split.py

@@ -112,13 +112,17 @@ def test_remove_from_environment(self, mocker):
             'ws_id',
             http_client_mock
         )
-        attr = sp.remove_from_environment(environment_id)
+        title="title"
+        comment="comment"
+        attr = sp.remove_from_environment(environment_id, comment, title)
 
         http_client_mock.make_request.assert_called_once_with(
             SplitMicroClient._endpoint['remove_from_environment'],
             workspaceId = 'ws_id',
             splitName = 'name',
-            environmentId = environment_id
+            environmentId = environment_id,
+            title=title,
+            comment=comment
         )
         assert attr == True
 

splitapiclient/version.py

@@ -1 +1 @@
-__version__ = '3.1.6'
+__version__ = '3.1.7'