updated to support large segments

Author: kleinjoshuaa

CHANGES.txt

@@ -37,5 +37,5 @@
 - Added ability to retrieve API keys when creating an environment
 3.1.13 (Jan 31, 2024)
 - Updated keyId of an API KEY to be the actual ID and not the key itself
-3.2.0 (Jan 31, 2025)
-- Updated to support flag sets and the impressionsDisabled boolean value
+3.2.0 (Feb 2, 2025)
+- Updated to support flag sets, large segments and the impressionsDisabled boolean value

splitapiclient/main/sync_apiclient.py

@@ -18,6 +18,9 @@
 from splitapiclient.microclients import APIKeyMicroClient
 from splitapiclient.microclients import RestrictionMicroClient
 from splitapiclient.microclients import FlagSetMicroClient
+from splitapiclient.microclients import LargeSegmentMicroClient
+from splitapiclient.microclients import LargeSegmentDefinitionMicroClient
+
 
 class SyncApiClient(BaseApiClient):
     '''
@@ -41,7 +44,11 @@ def __init__(self, config):
         else:
             self._base_url = self.BASE_PROD_URL
             self._base_url_old = self.BASE_PROD_URL_OLD
-        self._base_url_v3 = self.BASE_PROD_URL_V3
+            
+        if 'base_url_v3' in config:
+            self._base_url_v3 = config['base_url_v3']
+        else:
+            self._base_url_v3 = self.BASE_PROD_URL_V3
 
         missing = [i for i in ['apikey'] if i not in config]
         if missing:
@@ -60,6 +67,8 @@ def __init__(self, config):
         self._split_definition_client = SplitDefinitionMicroClient(http_client)
         self._segment_client = SegmentMicroClient(http_client)
         self._segment_definition_client = SegmentDefinitionMicroClient(http_client)
+        self._large_segment_client = LargeSegmentMicroClient(http_client)
+        self._large_segment_definition_client = LargeSegmentDefinitionMicroClient(http_client)
         self._workspace_client = WorkspaceMicroClient(http_client)
         self._traffic_type_client = TrafficTypeMicroClient(http_client)
         self._attribute_client = AttributeMicroClient(http_client)
@@ -94,6 +103,14 @@ def segments(self):
     @property
     def segment_definitions(self):
         return self._segment_definition_client
+    
+    @property
+    def large_segments(self):
+        return self._large_segment_client
+
+    @property
+    def large_segment_definitions(self):
+        return self._large_segment_definition_client
 
     @property
     def workspaces(self):

splitapiclient/microclients/__init__.py

@@ -12,4 +12,6 @@
 from splitapiclient.microclients.group_microclient import GroupMicroClient
 from splitapiclient.microclients.apikey_microclient import APIKeyMicroClient
 from splitapiclient.microclients.restriction_microclient import RestrictionMicroClient
-from splitapiclient.microclients.flag_set_microclient import FlagSetMicroClient
+from splitapiclient.microclients.flag_set_microclient import FlagSetMicroClient
+from splitapiclient.microclients.large_segment_microclient import LargeSegmentMicroClient
+from splitapiclient.microclients.large_segment_definition_microclient import LargeSegmentDefinitionMicroClient

splitapiclient/microclients/large_segment_definition_microclient.py

@@ -0,0 +1,157 @@
+from splitapiclient.resources import LargeSegmentDefinition
+from splitapiclient.util.exceptions import HTTPResponseError, \
+    UnknownApiClientError
+from splitapiclient.util.logger import LOGGER
+from splitapiclient.util.helpers import as_dict
+import urllib
+import requests
+
+class LargeSegmentDefinitionMicroClient:
+    '''
+    '''
+    _endpoint = {
+        'all_items': {
+            'method': 'GET',
+            'url_template': 'large-segments/ws/{workspaceId}/environments/{environmentId}',
+            'headers': [{
+                'name': 'Authorization',
+                'template': 'Bearer {value}',
+                'required': True,
+            }],
+            'query_string': [],
+            'response': True,
+        },
+        'make_cr': {
+            'method': 'POST',
+            'url_template': 'changeRequests/ws/{workspaceId}/environments/{environmentId}',
+            'headers': [{
+                'name': 'Authorization',
+                'template': 'Bearer {value}',
+                'required': True,
+            }],
+            'query_string': [],
+            'response': True,
+        },
+
+    }
+
+    def __init__(self, http_client):
+        '''
+        Constructor
+        '''
+        self._http_client = http_client
+
+    def list(self, environment_id, workspace_id):
+        '''
+        Returns a list of Segment in environemnt objects.
+
+        :returns: list of Segment in environemnt objects
+        :rtype: list(SegmentDefinition)
+        '''
+        final_list = []
+        response = self._http_client.make_request(
+            self._endpoint['all_items'],
+            workspaceId = workspace_id,
+            environmentId = environment_id,
+        )
+        for item in response:
+            final_list.append(as_dict(item))
+
+
+        segment_definition_list = []
+        for item in final_list:
+            item['environment'] = {'id':environment_id, 'name':''}
+            item['workspaceId'] = workspace_id
+            segment_definition_list.append(LargeSegmentDefinition(item, self._http_client))
+        return segment_definition_list
+
+    def find(self, segment_name, environment_id, workspace_id):
+        '''
+        Find Segment in environment list objects.
+
+        :returns: SegmentDefinition object
+        :rtype: SegmentDefinition
+        '''
+        for item in self.list(environment_id, workspace_id):
+            if item.name == segment_name:
+                return item
+        LOGGER.error("Large Segment Definition Name does not exist")
+        return None
+
+
+
+    def remove_all_members(self, workspace_id, environment_id, name, title, comment, approvers):
+        '''
+        remove all segment members
+
+        :param data: json data
+        :param workspace_id: workspace id
+        :param environment_id: environment id
+        
+        
+        :returns: True
+        :rtype: boolean
+        '''
+        
+        data = {
+            'largeSegment': {
+                'name': name
+            },
+            'operationType': 'ARCHIVE',
+            'title': title,
+            'comment': comment,
+            'approvers': approvers
+        }
+        response = self._http_client.make_request(
+            self._endpoint['make_cr'],
+            body=as_dict(data),
+            environmentId = environment_id,
+            workspaceId = workspace_id
+        )     
+        return True
+
+
+    def submit_upload(self, workspace_id, environment_id, name, title,comment,approvers):
+        '''
+        remove keys from csv file into segment
+
+        :param segment: segment name, environment id, json data
+        
+        :returns: True
+        :rtype: boolean
+        '''
+        data ={
+            'largeSegment': {
+                'name': name
+            },
+            'operationType': 'UPLOAD',
+            'title': title,
+            'comment': comment,
+            'approvers': approvers,
+        }
+        response = self._http_client.make_request(
+            self._endpoint['make_cr'],
+            body=as_dict(data),
+            environmentId = environment_id,
+            workspaceId = workspace_id
+        )
+        return response
+
+
+    def upload_file(self, result, file_path):
+        '''
+        Upload a file to the specified URL.
+
+        :param result: dictionary containing 'url', 'method', and 'transactionMetadata'
+        :param file_path: path to the file to be uploaded
+        
+        :returns: response from the server
+        :rtype: requests.Response
+        '''
+        url = result['transactionMetadata']['url']
+        headers = {
+            'Host': result['transactionMetadata']['headers']['Host'][0]
+        }
+        with open(file_path, 'rb') as file:
+            response = requests.put(url, headers=headers, data=file)
+        return response