Merge pull request #15 from splitio/3.1.9

kleinjoshuaa · web-flow · commit 454955c2800b · 2023-09-07T16:51:13.000-04:00
3.1.9 - Updated to fix issues with the HTTP error messages as well as fixing issues with the to_dict() methods of the Segment, Segment Definition and Split Definition objects
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -26,4 +26,6 @@
 - Added `comment` and `title` as optional parameters for the `remove_from_environment` method of a Split
 - Updated default logging to be more useful
 3.1.8 (Jun 29nd, 2023)
-- Added suggestedValues for attributes
+- Added suggestedValues for attributes
+3.1.9 (Sept 7th, 2023)
+- Fixed `to_dict()` method for Segments, Segment Definitions and Split Definitions
diff --git a/bin/activate b/bin/activate
@@ -38,7 +38,7 @@ deactivate () {
 # unset irrelevant variables
 deactivate nondestructive
 
-VIRTUAL_ENV="/Users/joshuaklein/code/py_add_suggest_values/python-api"
+VIRTUAL_ENV="/Users/joshuaklein/code/py_fix_splitDef_dict/python-api"
 export VIRTUAL_ENV
 
 _OLD_VIRTUAL_PATH="$PATH"
diff --git a/bin/activate.csh b/bin/activate.csh
@@ -8,7 +8,7 @@ alias deactivate 'test $?_OLD_VIRTUAL_PATH != 0 && setenv PATH "$_OLD_VIRTUAL_PA
 # Unset irrelevant variables.
 deactivate nondestructive
 
-setenv VIRTUAL_ENV "/Users/joshuaklein/code/py_add_suggest_values/python-api"
+setenv VIRTUAL_ENV "/Users/joshuaklein/code/py_fix_splitDef_dict/python-api"
 
 set _OLD_VIRTUAL_PATH="$PATH"
 setenv PATH "$VIRTUAL_ENV/bin:$PATH"
diff --git a/bin/activate.fish b/bin/activate.fish
@@ -33,7 +33,7 @@ end
 # Unset irrelevant variables.
 deactivate nondestructive
 
-set -gx VIRTUAL_ENV "/Users/joshuaklein/code/py_add_suggest_values/python-api"
+set -gx VIRTUAL_ENV "/Users/joshuaklein/code/py_fix_splitDef_dict/python-api"
 
 set -gx _OLD_VIRTUAL_PATH $PATH
 set -gx PATH "$VIRTUAL_ENV/bin" $PATH
diff --git a/bin/pip b/bin/pip
@@ -1,4 +1,4 @@
-#!/Users/joshuaklein/code/py_add_suggest_values/python-api/bin/python3.11
+#!/Users/joshuaklein/code/py_fix_splitDef_dict/python-api/bin/python3.11
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/pip3 b/bin/pip3
@@ -1,4 +1,4 @@
-#!/Users/joshuaklein/code/py_add_suggest_values/python-api/bin/python3.11
+#!/Users/joshuaklein/code/py_fix_splitDef_dict/python-api/bin/python3.11
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/bin/pip3.11 b/bin/pip3.11
@@ -1,4 +1,4 @@
-#!/Users/joshuaklein/code/py_add_suggest_values/python-api/bin/python3.11
+#!/Users/joshuaklein/code/py_fix_splitDef_dict/python-api/bin/python3.11
 # -*- coding: utf-8 -*-
 import re
 import sys
diff --git a/pyvenv.cfg b/pyvenv.cfg
@@ -1,5 +1,5 @@
 home = /usr/local/opt/python@3.11/bin
 include-system-site-packages = false
 version = 3.11.4
-executable = /usr/local/Cellar/python@3.11/3.11.4/Frameworks/Python.framework/Versions/3.11/bin/python3.11
-command = /usr/local/opt/python@3.11/bin/python3.11 -m venv /Users/joshuaklein/code/py_add_suggest_values/python-api
+executable = /usr/local/Cellar/python@3.11/3.11.4_1/Frameworks/Python.framework/Versions/3.11/bin/python3.11
+command = /usr/local/opt/python@3.11/bin/python3.11 -m venv /Users/joshuaklein/code/py_fix_splitDef_dict/python-api
diff --git a/setup.cfg b/setup.cfg
@@ -6,7 +6,7 @@ addopts = --verbose
 
 [metadata]
 name = splitapiclient
-version = 3.1.8
+version = 3.1.9
 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
 long_description = file: README.md
 long_description_content_type = text/markdown
diff --git a/setup.py b/setup.py
@@ -112,8 +112,8 @@ def run(self):
     description='This Python Library provide full support for Split REST Admin API',
     long_description=(this_directory / "README.md").read_text(),
     long_description_content_type='text/markdown',
-    author='Patricio Echague, Sebastian Arrubia, Martin Redolatti',
-    author_email='pato@split.io, sebastian@split.io, martin@split.io',
+    author='Patricio Echague, Sebastian Arrubia, Martin Redolatti, Josh Klein, Bilal Al-Shawany',
+    author_email='pato@split.io, sebastian@split.io, martin@split.io, joshua.klein@split.io, bilal@split.io',
     url='https://github.com/splitio/python-api',
     download_url=(
         'https://github.com/splitio/python-api/tarball/' + __version__
diff --git a/splitapiclient/http_clients/sync_client.py b/splitapiclient/http_clients/sync_client.py
@@ -53,7 +53,7 @@ def _handle_invalid_response(self, response):
 
         exc = status_codes_exceptions.get(response.status_code)
         if exc:
-            raise exc()
+            raise exc(response.text)
         else:
             raise HTTPResponseError(response.text)
 
diff --git a/splitapiclient/resources/segment.py b/splitapiclient/resources/segment.py
@@ -40,7 +40,23 @@ def name(self):
     @property
     def description(self):
         return self._description
+
+    @property
+    def traffic_type(self):
+        return None if self._trafficType == {} else self._trafficType
         
+    @property
+    def workspace_id(self):
+        return self._workspace_id
+
+    @property
+    def tags(self):
+        return self._tags
+
+    @property
+    def creation_time(self):
+        return self._creationTime
+
     def add_to_environment(self, environment_id, apiclient=None):
         '''
         Add segment to environment
diff --git a/splitapiclient/resources/segment_definition.py b/splitapiclient/resources/segment_definition.py
@@ -36,7 +36,24 @@ def __init__(self, data=None, client=None):
     @property
     def name(self):
         return self._name
-            
+
+    @property
+    def traffic_type(self):
+        return None if self._trafficType == {} else self._trafficType
+        
+    @property
+    def environment(self):
+        return self._environment
+
+    @property
+    def tags(self):
+        return self._tags
+
+    @property
+    def creation_time(self):
+        return None if  self._creationTime==0 else self._creationTime
+
+
     def get_keys(self, apiclient=None):
         '''
         Get list of keys in segment in environment
diff --git a/splitapiclient/resources/split_definition.py b/splitapiclient/resources/split_definition.py
@@ -94,7 +94,57 @@ def __init__(self, data=None, environment_id=None, workspace_id=None, client=Non
     @property
     def name(self):
         return self._name
-        
+
+
+    @property
+    def environment(self):
+        return None if self._environment.id == "" else self._environment
+    
+    @property
+    def traffic_type(self):
+        return self._trafficType
+    
+    @property
+    def killed(self):
+        return self._killed
+   
+    @property
+    def treatments(self):
+        return None if len(self._treatments) == 0 else self._treatments 
+
+    @property
+    def default_treatment(self):
+        return self._default_treatment
+    
+    @property
+    def baseline_treatment(self):
+        return self._baseline_treatment
+
+
+    @property
+    def traffic_allocation(self):
+        return self._traffic_allocation
+    
+    @property
+    def rules(self):
+        return None if len(self._rules) == 0 else self._rules 
+    
+    @property
+    def default_rule(self):
+        return None if len(self._default_rule) == 0 else self._default_rule 
+    
+    @property
+    def creation_time(self):
+        return None if self._creationTime == 0 else self._creationTime
+
+    @property
+    def last_update_time(self):
+        return None if self._lastUpdateTime == 0 else self._lastUpdateTime
+    
+    @property
+    def last_traffic_received_at(self):
+        return None if self._lastTrafficReceivedAt == 0 else self._lastTrafficReceivedAt
+
     def update_definition(self, data, apiclient=None):
         '''
         Update split definition in environment
diff --git a/splitapiclient/tests/microclients/segment_definition_microclient_test.py b/splitapiclient/tests/microclients/segment_definition_microclient_test.py
@@ -3,6 +3,27 @@
 
 from splitapiclient.microclients import SegmentDefinitionMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
+from splitapiclient.resources import TrafficType
+
+def object_to_stringified_dict(obj):
+    """
+    Recursively converts an object and its nested objects to a stringified dictionary.
+    Assumes that the object has a 'to_dict()' method for serialization.
+    
+    Args:
+        obj: The object to be converted to a stringified dictionary.
+        
+    Returns:
+        A stringified dictionary representation of the object.
+    """
+    if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')):
+        return object_to_stringified_dict(obj.to_dict())  # Recursively call to_dict()
+    elif isinstance(obj, dict):
+        return {key: object_to_stringified_dict(value) for key, value in obj.items()}
+    elif isinstance(obj, list):
+        return [object_to_stringified_dict(item) for item in obj]
+    else:
+        return obj  # For non-dict, non-list, and non-object types, return as is
 
 
 class TestSegmentDefinitionMicroClient:
@@ -17,12 +38,20 @@ def test_list(self, mocker):
                 'name': 'name',
                 'environment': {
                     'id': 'env_id',
-                    'name': 'env'
+                    'name': ''
+                },
+                'trafficType': {
+                    'id': 'tt_id',
+                    'name': 'tt'
                 }},             {
-                'name': 'name',
+                'name': 'name2',
                 'environment': {
-                    'id': '1',
-                    'name': 'env'
+                    'id': 'env_id',
+                    'name': ''
+                },
+                'trafficType': {
+                    'id': 'tt_id',
+                    'name': 'tt'
                 }}
             ],
             'offset': 1,
@@ -40,16 +69,18 @@ def test_list(self, mocker):
         )
         data = [{
                 'name': 'name',
-                'environment': None,
+                'environment': {'id': 'env_id', 'name': ''},
                 'creationTime': None,
-                'trafficType': None
+                'trafficType': TrafficType(data={"id":"tt_id", "name":"tt"}).to_dict()
                 }, {
-                'name': 'name',
-                'environment': None,
+                'name': 'name2',
+                'environment': {'id': 'env_id', 'name': ''},
                 'creationTime': None,
-                'trafficType': None
+                'trafficType': TrafficType(data={"id":"tt_id", "name":"tt"}).to_dict()
                 }
             ]
 
-        assert result[0].to_dict() == data[0]
-        assert result[1].to_dict() == data[1]
+
+        assert object_to_stringified_dict(result[0]) == data[0]
+
+        assert object_to_stringified_dict(result[1]) == data[1]
diff --git a/splitapiclient/tests/microclients/split_definition_microclient_test.py b/splitapiclient/tests/microclients/split_definition_microclient_test.py
@@ -3,7 +3,26 @@
 
 from splitapiclient.microclients import SplitDefinitionMicroClient
 from splitapiclient.http_clients.sync_client import SyncHttpClient
-
+from splitapiclient.resources import Environment
+def object_to_stringified_dict(obj):
+    """
+    Recursively converts an object and its nested objects to a stringified dictionary.
+    Assumes that the object has a 'to_dict()' method for serialization.
+    
+    Args:
+        obj: The object to be converted to a stringified dictionary.
+        
+    Returns:
+        A stringified dictionary representation of the object.
+    """
+    if hasattr(obj, 'to_dict') and callable(getattr(obj, 'to_dict')):
+        return object_to_stringified_dict(obj.to_dict())  # Recursively call to_dict()
+    elif isinstance(obj, dict):
+        return {key: object_to_stringified_dict(value) for key, value in obj.items()}
+    elif isinstance(obj, list):
+        return [object_to_stringified_dict(item) for item in obj]
+    else:
+        return obj  # For non-dict, non-list, and non-object types, return as is
 
 class TestSplitDefinitionMicroClient:
 
@@ -57,32 +76,32 @@ def test_list(self, mocker):
         )
         data = [{
                 'name': 'split1',
-                'environment': None,
-                'trafficType': None,
-                'killed': None,
+                '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': None,
-                'baselineTreatment': None,
-                'trafficAllocation': None,
+                'defaultTreatment': 'off',
+                'baselineTreatment': 'off',
+                'trafficAllocation': 100,
                 'rules': None,
                 'defaultRule': None,
                 'creationTime': None,
                 'lastUpdateTime': None,
                 'lastTrafficReceivedAt': None
             }, {
                 'name': 'split2',
-                'environment': None,
-                'trafficType': None,
-                'killed': None,
+                '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': None,
-                'baselineTreatment': None,
-                'trafficAllocation': None,
+                'defaultTreatment': 'off',
+                'baselineTreatment': 'off',
+                'trafficAllocation': 100,
                 'rules': None,
                 'defaultRule': None,
                 'creationTime': None,
                 'lastUpdateTime': None,
                 'lastTrafficReceivedAt': None
             }]
-        assert result[0].to_dict() == data[0]
-        assert result[1].to_dict() == data[1]
+        assert object_to_stringified_dict(result[0]) == data[0]
+        assert object_to_stringified_dict(result[1]) == data[1]
diff --git a/splitapiclient/tests/resources/test_split.py b/splitapiclient/tests/resources/test_split.py
diff --git a/splitapiclient/tests/resources/test_split_definition.py b/splitapiclient/tests/resources/test_split_definition.py
diff --git a/splitapiclient/tests/resources/test_workspace.py b/splitapiclient/tests/resources/test_workspace.py
diff --git a/splitapiclient/version.py b/splitapiclient/version.py

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/Users/joshuaklein/code/py_add_suggest_values/python-api/bin/python3.11`
	`1`	`+#!/Users/joshuaklein/code/py_fix_splitDef_dict/python-api/bin/python3.11`
`2`	`2`	`# -- coding: utf-8 --`
`3`	`3`	`import re`
`4`	`4`	`import sys`
-Original file line number
+Diff line change
@@ @@ -1,5 +1,5 @@ @@
 home = /usr/local/opt/[email protected]/bin
 include-system-site-packages = false
 version = 3.11.4
 -executable = /usr/local/Cellar/[email protected]/3.11.4/Frameworks/Python.framework/Versions/3.11/bin/python3.11
 -command = /usr/local/opt/[email protected]/bin/python3.11 -m venv /Users/joshuaklein/code/py_add_suggest_values/python-api
 +executable = /usr/local/Cellar/[email protected]/3.11.4_1/Frameworks/Python.framework/Versions/3.11/bin/python3.11
 +command = /usr/local/opt/[email protected]/bin/python3.11 -m venv /Users/joshuaklein/code/py_fix_splitDef_dict/python-api