- Added change request support for segment class

chillaq · chillaq · commit 9c3c59bb5f77 · 2021-11-14T13:20:21.000-08:00
- Added missing properties for all schemas of resource classes
- Updated relevant tests
diff --git a/README.md b/README.md
@@ -8,9 +8,9 @@ Full documentation on this Python wrapper is available in [this link](https://he
 
 ### Quick setup
 
-Install the split-admin-api:
+Install the splitapiclient:
 ```
-pip install split-admin-api
+pip install splitapiclient
 ```
 
 Import the client object and initialize connection using an Admin API Key:
diff --git a/splitapiclient/microclients/change_request_microclient.py b/splitapiclient/microclients/change_request_microclient.py
@@ -125,7 +125,7 @@ def update_status(self, change_request_id, new_status, comment):
         )
         return ChangeRequest(response, self._http_client)
 
-    def submit_change_request(self, split_name, environment_id, workspace_id, data):
+    def submit_change_request(self, environment_id, workspace_id, data):
         '''
         Submit a split definition change request
 
@@ -134,7 +134,6 @@ def submit_change_request(self, split_name, environment_id, workspace_id, data):
         '''
         response = self._http_client.make_request(
             self._endpoint['submit_change_request'],
-            splitName = split_name,
             environmentId = environment_id,
             workspaceId = workspace_id,
             body = data
diff --git a/splitapiclient/microclients/segment_definition_microclient.py b/splitapiclient/microclients/segment_definition_microclient.py
@@ -86,7 +86,11 @@ def list(self, environment_id, workspace_id):
                 continue
             else:
                 break
-        return [SegmentDefinition(item, self._http_client) for item in final_list]
+        segment_definition_list = []
+        for item in final_list:
+            item['environment'] = {'id':environment_id, 'name':''}
+            segment_definition_list.append(SegmentDefinition(item, self._http_client))
+        return segment_definition_list
 
     def find(self, segment_name, environment_id, workspace_id):
         '''
diff --git a/splitapiclient/resources/apikey.py b/splitapiclient/resources/apikey.py
@@ -43,7 +43,7 @@ def __init__(self, data=None, client=None):
         self._name = data.get('name')
         self._apiKeyType = data.get('apiKeyType')
         self._createdBy = data.get('createdBy')
-        self._createdAt = data.get('createdAt')
+        self._created_at = data.get('createdAt')
         self._environments = data.get('environments') if 'environments' in data else []
         self._workspace = data.get('workspace') if 'workspace' in data else {}
         self._type = data.get('type')
diff --git a/splitapiclient/resources/attribute.py b/splitapiclient/resources/attribute.py
@@ -23,6 +23,7 @@ def __init__(self, data=None, client=None):
         if not data:
             data = {}
         BaseResource.__init__(self, data.get('id'), client)
+        self._id = data.get('id')
         self._traffic_type_id = data.get('trafficTypeId')
         self._display_name = data.get('displayName')
         self._description = data.get('description')
diff --git a/splitapiclient/resources/change_request.py b/splitapiclient/resources/change_request.py
@@ -90,6 +90,7 @@ def __init__(self, data=None, client=None):
         self._comment = data.get('comment') if 'comment' in data else ''
         self._split = data.get('split') if 'split' in data else {}
         self._segment = data.get('segment') if 'segment' in data else {}
+        self._operationType = data.get('operationType') if 'operationType' in data else ''
         self._environment = data.get('environment')
         self._approvers = []
         if 'approvers' in data:
diff --git a/splitapiclient/resources/matcher.py b/splitapiclient/resources/matcher.py
@@ -32,7 +32,7 @@ def __init__(self, data=None):
         self._type = data.get('type') if 'type' in data else ""
         self._attribute = data.get('attribute') if 'attribute' in data else ""
         self._string = data.get('string') if 'string' in data else ""
-        self._boolean = data.get('bool') if 'bool' in data else ""
+        self._bool = data.get('bool') if 'bool' in data else ""
         self._strings = []
         if 'strings' in data:
             for item in data.get('strings'):
@@ -52,8 +52,8 @@ def export_dict(self):
             result['attribute'] = self._attribute
         if self._string != "":
             result['string'] = self._string
-        if self._boolean != "":
-            result['bool'] = self._boolean
+        if self._bool != "":
+            result['bool'] = self._bool
         if len(self._strings)>0:
             result['strings'] = self._strings
         if self._number != "":
diff --git a/splitapiclient/resources/segment_definition.py b/splitapiclient/resources/segment_definition.py
@@ -31,7 +31,7 @@ def __init__(self, data=None, client=None):
         self._name = data.get('name')
         self._environment = data.get('environment')
         self._trafficType = TrafficType(data.get('trafficType')) if 'trafficType' in data else {}
-        self._creationTime = data.get('creationTime')
+        self._creationTime = data.get('creationTime') if 'creationTime' in data else 0
             
     @property
     def name(self):
@@ -103,3 +103,29 @@ def remove_keys(self, json_data, apiclient=None):
         imc = require_client('SegmentDefinition', self._client, apiclient)
         return imc.remove_keys(self._name, self._environment['id'], json_data)
 
+    def submit_change_request(self, keys, operation_type, title, comment, approvers, rollout_status_id, workspace_id, apiclient=None):
+        '''
+        submit a change request for segment definition
+
+        :param data: ChangeRequest
+        :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: ChangeRequest object
+        :rtype: ChangeRequest
+        '''
+        data = {
+            'segment': {
+                'name':self._name,
+                'keys': keys,
+            },
+            'operationType': operation_type,
+            'title': title,
+            'comment': comment,
+            'approvers': approvers,
+        }
+        if rollout_status_id is not None:
+            data['rolloutStatus'] = {'id': rollout_status_id}
+        imc = require_client('ChangeRequest', self._client, apiclient)
+        return imc.submit_change_request(self._environment['id'], workspace_id, data)
diff --git a/splitapiclient/resources/split.py b/splitapiclient/resources/split.py
@@ -34,7 +34,12 @@ def __init__(self, data=None, workspace_id=None, client=None):
         self._description = data.get('description')
         self._trafficType = TrafficType(data.get('trafficType')) if 'trafficType' in data else {}
         self._workspace_id = workspace_id
-            
+        self._creationTime = data.get('creationTime') if 'creationTime' in data else 0
+        self._tags = data.get('tags') if 'tags' in data else []
+        self._id = data.get('id') if 'id' in data else None
+        self._rolloutStatus = data.get('rolloutStatus') if 'rolloutStatus' in data else {}
+        self._rolloutStatusTimestamp = data.get('rolloutStatusTimestamp') if 'rolloutStatusTimestamp' in data else 0
+
     @property
     def name(self):
         return self._name
diff --git a/splitapiclient/resources/split_definition.py b/splitapiclient/resources/split_definition.py
@@ -68,12 +68,15 @@ def __init__(self, data=None, environment_id=None, workspace_id=None, client=Non
             data = {}
         BaseResource.__init__(self, data.get('name'), client)
         self._name = data.get('name')
-        self._trafficType = TrafficType(data.get('trafficType')) if 'trafficType' in data else {}
         self._environment = Environment(data.get('environment')) if 'environment' in data else {}
+        self._trafficType = TrafficType(data.get('trafficType')) if 'trafficType' in data else {}
         self._treatments = []
+        self._killed = data.get('killed') if 'killed' in data else False
         if 'treatments' in data:
             for item in data.get('treatments'):
                 self._treatments.append(Treatment(item))
+        self._default_treatment = data.get('defaultTreatment') if 'defaultTreatment' in data else ''
+        self._traffic_allocation = data.get('trafficAllocation') if 'trafficAllocation' in data else 0
         self._rules = []
         for item in data.get('rules'):
             self._rules.append(Rule(item))
@@ -164,5 +167,5 @@ def submit_change_request(self, definition, operation_type, title, comment, appr
         if rollout_status_id is not None:
             data['rolloutStatus'] = {'id': rollout_status_id}
         imc = require_client('ChangeRequest', self._client, apiclient)
-        return imc.submit_change_request(self._name, self._environment_id, self._workspace_id, data)
+        return imc.submit_change_request(self._environment_id, self._workspace_id, data)
 
diff --git a/splitapiclient/resources/traffic_type.py b/splitapiclient/resources/traffic_type.py
@@ -20,6 +20,7 @@ def __init__(self, data=None, workspaceId=None, client=None):
         if not data:
             data = {}
         BaseResource.__init__(self, data.get('id'), client)
+        self._id = data.get('id')
         self._name = data.get('name')
         self._display_attribute_id = data.get('displayAttributeId')
         self._workspace_id = workspaceId
diff --git a/splitapiclient/tests/resources/test_segment_definition.py b/splitapiclient/tests/resources/test_segment_definition.py
@@ -6,7 +6,7 @@
 from splitapiclient.http_clients.base_client import BaseHttpClient
 from splitapiclient.main import get_client
 from splitapiclient.microclients import SegmentDefinitionMicroClient
-
+from splitapiclient.microclients import ChangeRequestMicroClient
 class TestSegmentDefinition:
     '''
     Tests for the SegmentDefinition class' methods
@@ -135,3 +135,53 @@ def test_remove_keys(self, mocker):
         )
         assert attr == True
 
+    def test_submit_change_request(self, mocker):
+        '''
+        '''
+        data = {
+            'segment': {
+                'name': 'segment1',
+                'keys': [],
+            },
+            'title': 'title',
+            'operationType': 'op',
+            'comment': 'com',
+            'approvers': ['approver'],
+        }
+        http_client_mock = mocker.Mock(spec=BaseHttpClient)
+        http_client_mock.make_request.return_value = data
+        seg = SegmentDefinition(
+            {
+                'name': 'segment1',
+                'environment': {
+                    'id': 'env_id',
+                    'name': 'env'
+                },
+                'trafficType': {},
+            },
+            http_client_mock
+        )
+        definition = []
+
+        attr = seg.submit_change_request(definition, 'op', 'title', 'com', ['approver'], None, 'ws_id')
+
+        http_client_mock.make_request.assert_called_once_with(
+            ChangeRequestMicroClient._endpoint['submit_change_request'],
+            workspaceId = 'ws_id',
+            environmentId = 'env_id',
+            body = data
+        )
+        data1 = {
+            'split': None,
+            'segment': None,
+            'id': None,
+            'status': None,
+            'title': None,
+            'comment': None,
+            'approvers': None,
+            'operationType': None,
+            'comments': None,
+            'rolloutStatus': None
+        }
+
+        assert attr.to_dict() == data1
diff --git a/splitapiclient/tests/resources/test_split.py b/splitapiclient/tests/resources/test_split.py
@@ -92,6 +92,8 @@ def test_add_to_environment(self, mocker):
         data['defaultRule'] = None
         data['creationTime'] = None
         data['lastUpdateTime'] = None
+        data['lastTrafficReceivedAt'] = None
+        
         assert attr.to_dict() == data
 
     def test_remove_from_environment(self, mocker):
diff --git a/splitapiclient/tests/resources/test_split_definition.py b/splitapiclient/tests/resources/test_split_definition.py
@@ -101,7 +101,8 @@ def test_update_definition(self, mocker):
             'rules': None,
             'defaultRule': None,
             'creationTime' : None,
-            'lastUpdateTime' : None
+            'lastUpdateTime' : None,
+            'lastTrafficReceivedAt': None
         }
         assert attr.to_dict() == data
 
@@ -209,7 +210,6 @@ def test_submit_change_request(self, mocker):
 
         http_client_mock.make_request.assert_called_once_with(
             ChangeRequestMicroClient._endpoint['submit_change_request'],
-            splitName = 'split1',
             workspaceId = 'ws_id',
             environmentId = 'env_id',
             body = data
diff --git a/splitapiclient/tests/resources/test_workspace.py b/splitapiclient/tests/resources/test_workspace.py
@@ -179,10 +179,11 @@ def test_add_split(self, mocker):
         }
         data['trafficType'] = None
         data['creationTime'] = None
-        data['id'] = '1'
+        data['id'] = None
         data['rolloutStatus'] = None
         data['rolloutStatusTimestamp'] = None
         data['tags'] = None
+        
         assert attr.to_dict() == data
 
     def test_delete_split(self, mocker):
diff --git a/version.py b/version.py
@@ -0,0 +1 @@
+__version__ = '3.0.3'
