added spec query parameter

Author: Bilal Al

splitio/api/auth.py

@@ -5,6 +5,7 @@
 
 from splitio.api import APIException
 from splitio.api.commons import headers_from_metadata, record_telemetry
+from splitio.api.commons import _SPEC_VERSION
 from splitio.util.time import get_current_epoch_time_ms
 from splitio.api.client import HttpClientException
 from splitio.models.token import from_raw
@@ -43,7 +44,7 @@ def authenticate(self):
         try:
             response = self._client.get(
                 'auth',
-                '/v2/auth',
+                '/v2/auth?s=' + _SPEC_VERSION,
                 self._sdk_key,
                 extra_headers=self._metadata,
             )

splitio/api/commons.py

@@ -3,7 +3,7 @@
 
 _CACHE_CONTROL = 'Cache-Control'
 _CACHE_CONTROL_NO_CACHE = 'no-cache'
-
+_SPEC_VERSION = '1.1'
 
 def headers_from_metadata(sdk_metadata, client_key=None):
     """
@@ -57,7 +57,7 @@ def record_telemetry(status_code, elapsed, metric_name, telemetry_runtime_produc
 class FetchOptions(object):
     """Fetch Options object."""
 
-    def __init__(self, cache_control_headers=False, change_number=None, sets=None):
+    def __init__(self, cache_control_headers=False, change_number=None, sets=None, spec=_SPEC_VERSION):
         """
         Class constructor.
 
@@ -73,6 +73,7 @@ def __init__(self, cache_control_headers=False, change_number=None, sets=None):
         self._cache_control_headers = cache_control_headers
         self._change_number = change_number
         self._sets = sets
+        self._spec = spec
 
     @property
     def cache_control_headers(self):
@@ -89,6 +90,11 @@ def sets(self):
         """Return sets."""
         return self._sets
 
+    @property
+    def spec(self):
+        """Return sets."""
+        return self._spec
+
     def __eq__(self, other):
         """Match between other options."""
         if self._cache_control_headers != other._cache_control_headers:
@@ -97,6 +103,8 @@ def __eq__(self, other):
             return False
         if self._sets != other._sets:
             return False
+        if self._spec != other._spec:
+            return False
         return True
 
 
@@ -116,7 +124,8 @@ def build_fetch(change_number, fetch_options, metadata):
     :return: Objects for fetch
     :rtype: dict, dict
     """
-    query = {'since': change_number}
+    query = {'s': fetch_options.spec} if fetch_options.spec is not None else {}
+    query['since'] = change_number
     extra_headers = metadata
     if fetch_options is None:
         return query, extra_headers

splitio/sync/segment.py

@@ -144,13 +144,13 @@ def synchronize_segment(self, segment_name, till=None):
         :return: True if no error occurs. False otherwise.
         :rtype: bool
         """
-        fetch_options = FetchOptions(True)  # Set Cache-Control to no-cache
+        fetch_options = FetchOptions(True, None, None, None)  # Set Cache-Control to no-cache
         successful_sync, remaining_attempts, change_number = self._attempt_segment_sync(segment_name, fetch_options, till)
         attempts = _ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES - remaining_attempts
         if successful_sync:  # succedeed sync
             _LOGGER.debug('Refresh completed in %d attempts.', attempts)
             return True
-        with_cdn_bypass = FetchOptions(True, change_number)  # Set flag for bypassing CDN
+        with_cdn_bypass = FetchOptions(True, change_number, None, None)  # Set flag for bypassing CDN
         without_cdn_successful_sync, remaining_attempts, change_number = self._attempt_segment_sync(segment_name, with_cdn_bypass, till)
         without_cdn_attempts = _ON_DEMAND_FETCH_BACKOFF_MAX_RETRIES - remaining_attempts
         if without_cdn_successful_sync:

tests/api/test_auth.py

@@ -37,7 +37,7 @@ def test_auth(self, mocker):
         call_made = httpclient.get.mock_calls[0]
 
         # validate positional arguments
-        assert call_made[1] == ('auth', '/v2/auth', 'some_api_key')
+        assert call_made[1] == ('auth', '/v2/auth?s=1.1', 'some_api_key')
 
         # validate key-value args (headers)
         assert call_made[2]['extra_headers'] == {

tests/api/test_segments_api.py

@@ -18,7 +18,7 @@ def test_fetch_segment_changes(self, mocker):
         httpclient.get.return_value = client.HttpResponse(200, '{"prop1": "value1"}')
         segment_api = segments.SegmentsAPI(httpclient, 'some_api_key', SdkMetadata('1.0', 'some', '1.2.3.4'), mocker.Mock())
 
-        response = segment_api.fetch_segment('some_segment', 123, FetchOptions())
+        response = segment_api.fetch_segment('some_segment', 123, FetchOptions(None, None, None, None))
         assert response['prop1'] == 'value1'
         assert httpclient.get.mock_calls == [mocker.call('sdk', '/segmentChanges/some_segment', 'some_api_key',
                                                          extra_headers={
@@ -29,7 +29,7 @@ def test_fetch_segment_changes(self, mocker):
                                                          query={'since': 123})]
 
         httpclient.reset_mock()
-        response = segment_api.fetch_segment('some_segment', 123, FetchOptions(True))
+        response = segment_api.fetch_segment('some_segment', 123, FetchOptions(True, None, None, None))
         assert response['prop1'] == 'value1'
         assert httpclient.get.mock_calls == [mocker.call('sdk', '/segmentChanges/some_segment', 'some_api_key',
                                                          extra_headers={
@@ -41,7 +41,7 @@ def test_fetch_segment_changes(self, mocker):
                                                          query={'since': 123})]
 
         httpclient.reset_mock()
-        response = segment_api.fetch_segment('some_segment', 123, FetchOptions(True, 123))
+        response = segment_api.fetch_segment('some_segment', 123, FetchOptions(True, 123, None, None))
         assert response['prop1'] == 'value1'
         assert httpclient.get.mock_calls == [mocker.call('sdk', '/segmentChanges/some_segment', 'some_api_key',
                                                          extra_headers={

tests/api/test_splits_api.py

@@ -27,7 +27,7 @@ def test_fetch_split_changes(self, mocker):
                                                              'SplitSDKMachineIP': '1.2.3.4',
                                                              'SplitSDKMachineName': 'some'
                                                          },
-                                                         query={'since': 123, 'sets': 'set1,set2'})]
+                                                         query={'s': '1.1', 'since': 123, 'sets': 'set1,set2'})]
 
         httpclient.reset_mock()
         response = split_api.fetch_splits(123, FetchOptions(True))
@@ -39,7 +39,7 @@ def test_fetch_split_changes(self, mocker):
                                                              'SplitSDKMachineName': 'some',
                                                              'Cache-Control': 'no-cache'
                                                          },
-                                                         query={'since': 123})]
+                                                         query={'s': '1.1', 'since': 123})]
 
         httpclient.reset_mock()
         response = split_api.fetch_splits(123, FetchOptions(True, 123, 'set3'))
@@ -51,7 +51,7 @@ def test_fetch_split_changes(self, mocker):
                                                              'SplitSDKMachineName': 'some',
                                                              'Cache-Control': 'no-cache'
                                                          },
-                                                         query={'since': 123, 'till': 123, 'sets': 'set3'})]
+                                                         query={'s': '1.1', 'since': 123, 'till': 123, 'sets': 'set3'})]
 
         httpclient.reset_mock()
         def raise_exception(*args, **kwargs):