devcycle-python-server-sdk 2.0.1__py3-none-any.whl → 3.0.0__py3-none-any.whl

devcycle_python_sdk/protobuf/variableForUserParams_pb2.py

@@ -0,0 +1,46 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: variableForUserParams.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x1bvariableForUserParams.proto\"/\n\x0eNullableString\x12\r\n\x05value\x18\x01 \x01(\t\x12\x0e\n\x06isNull\x18\x02 \x01(\x08\"/\n\x0eNullableDouble\x12\r\n\x05value\x18\x01 \x01(\x01\x12\x0e\n\x06isNull\x18\x02 \x01(\x08\"m\n\x0f\x43ustomDataValue\x12\x1d\n\x04type\x18\x01 \x01(\x0e\x32\x0f.CustomDataType\x12\x11\n\tboolValue\x18\x02 \x01(\x08\x12\x13\n\x0b\x64oubleValue\x18\x03 \x01(\x01\x12\x13\n\x0bstringValue\x18\x04 \x01(\t\"\x93\x01\n\x12NullableCustomData\x12-\n\x05value\x18\x01 \x03(\x0b\x32\x1e.NullableCustomData.ValueEntry\x12\x0e\n\x06isNull\x18\x02 \x01(\x08\x1a>\n\nValueEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x1f\n\x05value\x18\x02 \x01(\x0b\x32\x10.CustomDataValue:\x02\x38\x01\"\x9c\x01\n\x18VariableForUserParams_PB\x12\x0e\n\x06sdkKey\x18\x01 \x01(\t\x12\x13\n\x0bvariableKey\x18\x02 \x01(\t\x12&\n\x0cvariableType\x18\x03 \x01(\x0e\x32\x10.VariableType_PB\x12\x19\n\x04user\x18\x04 \x01(\x0b\x32\x0b.DVCUser_PB\x12\x18\n\x10shouldTrackEvent\x18\x05 \x01(\x08\"\xe8\x02\n\nDVCUser_PB\x12\x0f\n\x07user_id\x18\x01 \x01(\t\x12\x1e\n\x05\x65mail\x18\x02 \x01(\x0b\x32\x0f.NullableString\x12\x1d\n\x04name\x18\x03 \x01(\x0b\x32\x0f.NullableString\x12!\n\x08language\x18\x04 \x01(\x0b\x32\x0f.NullableString\x12 \n\x07\x63ountry\x18\x05 \x01(\x0b\x32\x0f.NullableString\x12!\n\x08\x61ppBuild\x18\x06 \x01(\x0b\x32\x0f.NullableDouble\x12#\n\nappVersion\x18\x07 \x01(\x0b\x32\x0f.NullableString\x12$\n\x0b\x64\x65viceModel\x18\x08 \x01(\x0b\x32\x0f.NullableString\x12\'\n\ncustomData\x18\t \x01(\x0b\x32\x13.NullableCustomData\x12.\n\x11privateCustomData\x18\n \x01(\x0b\x32\x13.NullableCustomData\"\xac\x01\n\x0eSDKVariable_PB\x12\x0b\n\x03_id\x18\x01 \x01(\t\x12\x1e\n\x04type\x18\x02 \x01(\x0e\x32\x10.VariableType_PB\x12\x0b\n\x03key\x18\x03 \x01(\t\x12\x11\n\tboolValue\x18\x04 \x01(\x08\x12\x13\n\x0b\x64oubleValue\x18\x05 \x01(\x01\x12\x13\n\x0bstringValue\x18\x06 \x01(\t\x12#\n\nevalReason\x18\x07 \x01(\x0b\x32\x0f.NullableString*@\n\x0fVariableType_PB\x12\x0b\n\x07\x42oolean\x10\x00\x12\n\n\x06Number\x10\x01\x12\n\n\x06String\x10\x02\x12\x08\n\x04JSON\x10\x03*6\n\x0e\x43ustomDataType\x12\x08\n\x04\x42ool\x10\x00\x12\x07\n\x03Num\x10\x01\x12\x07\n\x03Str\x10\x02\x12\x08\n\x04Null\x10\x03\x42X\n&com.devcycle.sdk.server.local.protobufP\x01Z\x07./proto\xaa\x02\"DevCycle.SDK.Server.Local.Protobufb\x06proto3')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'variableForUserParams_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  DESCRIPTOR._serialized_options = b'\n&com.devcycle.sdk.server.local.protobufP\001Z\007./proto\252\002\"DevCycle.SDK.Server.Local.Protobuf'
+  _NULLABLECUSTOMDATA_VALUEENTRY._options = None
+  _NULLABLECUSTOMDATA_VALUEENTRY._serialized_options = b'8\001'
+  _VARIABLETYPE_PB._serialized_start=1087
+  _VARIABLETYPE_PB._serialized_end=1151
+  _CUSTOMDATATYPE._serialized_start=1153
+  _CUSTOMDATATYPE._serialized_end=1207
+  _NULLABLESTRING._serialized_start=31
+  _NULLABLESTRING._serialized_end=78
+  _NULLABLEDOUBLE._serialized_start=80
+  _NULLABLEDOUBLE._serialized_end=127
+  _CUSTOMDATAVALUE._serialized_start=129
+  _CUSTOMDATAVALUE._serialized_end=238
+  _NULLABLECUSTOMDATA._serialized_start=241
+  _NULLABLECUSTOMDATA._serialized_end=388
+  _NULLABLECUSTOMDATA_VALUEENTRY._serialized_start=326
+  _NULLABLECUSTOMDATA_VALUEENTRY._serialized_end=388
+  _VARIABLEFORUSERPARAMS_PB._serialized_start=391
+  _VARIABLEFORUSERPARAMS_PB._serialized_end=547
+  _DVCUSER_PB._serialized_start=550
+  _DVCUSER_PB._serialized_end=910
+  _SDKVARIABLE_PB._serialized_start=913
+  _SDKVARIABLE_PB._serialized_end=1085
+# @@protoc_insertion_point(module_scope)

devcycle_python_sdk/util/version.py

@@ -5,5 +5,5 @@ def sdk_version() -> str:
     """
     Returns the current version of this SDK as a semantic version string
     """
-    with open(os.path.dirname(__file__) + '/../VERSION.txt', 'r') as version_file:
+    with open(os.path.dirname(__file__) + "/../VERSION.txt", "r") as version_file:
         return version_file.read().strip()

{devcycle_python_server_sdk-2.0.1.dist-info → devcycle_python_server_sdk-3.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: devcycle-python-server-sdk
-Version: 2.0.1
+Version: 3.0.0
 Summary: DevCycle Python SDK
 Home-page: https://github.com/devcycleHQ/python-server-sdk
 Author-email: 
@@ -9,6 +9,8 @@ License-File: LICENSE
 Requires-Dist: setuptools (>=21.0.0)
 Requires-Dist: urllib3 (>=1.15.1)
 Requires-Dist: requests (~=2.31.0)
+Requires-Dist: wasmtime (==9.0.0)
+Requires-Dist: protobuf (>=4.23.3)
 
     The DevCycle Python SDK used for feature management.
     

devcycle_python_server_sdk-3.0.0.dist-info/RECORD

@@ -0,0 +1,55 @@
+devcycle_python_sdk/VERSION.txt,sha256=yRY_8h8fKwOQ3Ei92kcXlxj3cvUHp8687KWc4acSkCk,5
+devcycle_python_sdk/__init__.py,sha256=vOoglQ8L7RsHTp-GSa8g7k2AAPrR_obhiDSC09LpG8w,265
+devcycle_python_sdk/cloud_client.py,sha256=k9Vr24ej6oNZV3WkbO8KKCcp0ERTnsvmCySI7-A8QYw,6675
+devcycle_python_sdk/exceptions.py,sha256=Et7fS8pEFbHkFY86T2pJoEUstwjh4_rzhJxVH8fzAns,1053
+devcycle_python_sdk/local_client.py,sha256=fJDW4JVQY2ePKAN9OUeDhuHOhMqGGeKrv4Z7eMpfmZU,8605
+devcycle_python_sdk/options.py,sha256=HSny3e5sXydrCamoTSyNkmkdcuaGjY_9etNPngw9Avc,4525
+devcycle_python_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+devcycle_python_sdk/api/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+devcycle_python_sdk/api/backoff.py,sha256=F6WYCloaZD9CjNu6mKBMq7K20S8-i2WVU6X05ZRoawE,303
+devcycle_python_sdk/api/bucketing_client.py,sha256=cchUuSngJEgDnhR4HeOsCgjH2gJu-yDbz9HFLDT2Bzk,5074
+devcycle_python_sdk/api/config_client.py,sha256=jtnDmGQBaxOCxF346iDfqjIMKclqdOZiApXeXLDakbs,4226
+devcycle_python_sdk/api/event_client.py,sha256=y1u7HQLTM_FHxiwyZ_2hahnVjYaNv2HuSzlNcIHIiOk,3319
+devcycle_python_sdk/api/local_bucketing.py,sha256=96UNaq18Xnx69xIKBQZLOY8C1jkjsDc0vJvR9Jm2_Qw,16322
+devcycle_python_sdk/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+devcycle_python_sdk/managers/config_manager.py,sha256=qv71EMtV0qvHOjkclP2fE54eXe8v_MnehjyIkr-YPsM,3122
+devcycle_python_sdk/managers/event_queue_manager.py,sha256=JvOefMEnK3-zbco5TCGr9vysa0nYmI5Eg58Dg4SDUuU,7909
+devcycle_python_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+devcycle_python_sdk/models/bucketed_config.py,sha256=rSKpxMTF-IbUVQ9gAWrWnb9Q9YF94ATqEFWNWuoQntk,3814
+devcycle_python_sdk/models/error_response.py,sha256=r_dRUDAbral9UGaMYcnBsZOr9Hmkyi1SQbhGmZilgpA,442
+devcycle_python_sdk/models/event.py,sha256=-6bhKp72mAgaoSxvhS__G4vvfQ9Psj83fc0Igelzw3o,3713
+devcycle_python_sdk/models/feature.py,sha256=m3wxxIjC5jxhKpPLI4RcsBaNLuy-zsMqoAgc8ySPe0I,852
+devcycle_python_sdk/models/platform_data.py,sha256=kIFevH5trsxI32qp7BW6glUCpipgpaVBKGqJWzQd5Xo,783
+devcycle_python_sdk/models/user.py,sha256=BGMtVM6shDX7rUfGfBbI55IUEsQ_4qrnmtwTqOcB-8A,2616
+devcycle_python_sdk/models/variable.py,sha256=qp00SyCNyfYiMlTwnDSDJ4ZetRF35JHTbYZQOBxFIqY,1711
+devcycle_python_sdk/protobuf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+devcycle_python_sdk/protobuf/utils.py,sha256=zi-kVx6yvgS2c04cUobLd2IDc_ZqKkWduay9YcpjoGc,4684
+devcycle_python_sdk/protobuf/variableForUserParams_pb2.py,sha256=Zf4-8n67UnulC0Sz90aqLYsXCFEgywOqfiSHuXZomLk,4244
+devcycle_python_sdk/util/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+devcycle_python_sdk/util/version.py,sha256=Cz7Us_EuXP-T8GI47g2WHYdBJj_zKo-5y545IDHJAjI,253
+example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+example/cloud_client_example.py,sha256=YD8ZsTv3dPYfbFUKraRpRT0VsJGrPwjm8ZCuA5H54yI,2463
+example/local_bucketing_client_example.py,sha256=WRyJOUayO1siwnkfPhXvMg3Oz53akcA-Y4EMBI1e4q0,2676
+test/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/test_cloud_client.py,sha256=zjk302m7qKMCQryolkc1WKLFmbGWUxA0VtHlZk0rY-0,11442
+test/test_local_client.py,sha256=mEBhq0gnHzjE-i_w4hMrmfhoHDJvCXGt3G8lx0EA9OE,12671
+test/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/api/test_bucketing_client.py,sha256=Zomy0LQ-abI6nZvazSgBZQX6OjPwqBbsmfXR7KpdNOk,7565
+test/api/test_config_client.py,sha256=gV86fwGBFN5r81jrfGKyptldgR5YGEXdUdFlXwFaupg,4275
+test/api/test_event_client.py,sha256=jaWFWY0jrFI0amCfRsByi-JHPkoWKH_Z7V2nNcbvepM,3211
+test/api/test_local_bucketing.py,sha256=E7alurvIScT0nilcuY2xGLCXzwxHrNWPBGdWxG6bR5A,15156
+test/fixture/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/fixture/data.py,sha256=OFHR29FiiMWhh2bmyeEbCck4Jyy8Ah7MsoLg0JZN0vk,1372
+test/managers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/managers/test_config_manager.py,sha256=_MtvyxK06xpBzzEsN1zsLdYrk3DsPsbCmSj7XorINmI,5366
+test/managers/test_event_queue_manager.py,sha256=KquHBuYiDdoVStm5Ga9mIB-wvmJnChiFRBNC8sMKaxQ,11053
+test/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/models/test_bucketed_config.py,sha256=8wCEyxaHxY21nl7ZbiFzp-IzZQBZIPIVPPzeREjumQk,858
+test/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+test/util/test_utils.py,sha256=tVBJm_qnqg-4PssLpXIxqlk0JehuiAIPs4zpi2oNVnY,6671
+test/util/test_version.py,sha256=4Qhi1grX84lmyQRJ6aQMJgMerl3ce2_jKEl71vhqG5E,368
+devcycle_python_server_sdk-3.0.0.dist-info/LICENSE,sha256=tHQMqu-Jic2UpMGqb-vNFbGygysl8IG4l1clnnh0OFo,1071
+devcycle_python_server_sdk-3.0.0.dist-info/METADATA,sha256=unv6PBvFApXc0qamRTmXPzgRJTFO5qGNllrmCElhSgs,452
+devcycle_python_server_sdk-3.0.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+devcycle_python_server_sdk-3.0.0.dist-info/top_level.txt,sha256=34f8zDzihAHoH7siAFlmscyO_QLNWWq9HApFlwtYL4k,33
+devcycle_python_server_sdk-3.0.0.dist-info/RECORD,,

example/{example.py → cloud_client_example.py}

@@ -1,9 +1,11 @@
+import datetime
 import logging
 import os
 
 from devcycle_python_sdk import DevCycleCloudClient, DevCycleCloudOptions
-from devcycle_python_sdk.models.user import User
-from devcycle_python_sdk.models.event import Event
+
+from devcycle_python_sdk.models.user import DevCycleUser
+from devcycle_python_sdk.models.event import DevCycleEvent, EventType
 
 VARIABLE_KEY = "test-boolean-variable"
 
@@ -12,37 +14,34 @@ logger = logging.getLogger(__name__)
 
 def main():
     """
-    Sample generic usage of the Python SDK.
+    Sample usage of the Python Server SDK using Cloud Bucketing.
     For a Django specific sample app, please see https://github.com/DevCycleHQ/python-django-example-app/
-
     """
     logging.basicConfig(level="INFO", format="%(levelname)s: %(message)s")
 
+    # create an instance of the DevCycle Client object
+    server_sdk_key = os.environ["DEVCYCLE_SERVER_SDK_KEY"]
     options = DevCycleCloudOptions(enable_edge_db=True)
+    client = DevCycleCloudClient(server_sdk_key, options)
 
-    # create an instance of the API class
-    server_sdk_key = os.environ["DVC_SERVER_SDK_KEY"]
-    dvc = DevCycleCloudClient(server_sdk_key, options)
-
-    user = User(user_id="test", email="yo@yo.ca", country="CA")
-    event = Event(type="customEvent", target="somevariable.key")
+    user = DevCycleUser(user_id="test-1234", email="test-user@domain.com", country="US")
 
     # Use variable_value to access the value of a variable directly
-    if dvc.variable_value(user, VARIABLE_KEY, False):
+    if client.variable_value(user, VARIABLE_KEY, False):
         logger.info(f"Variable {VARIABLE_KEY} is enabled")
     else:
         logger.info(f"Variable {VARIABLE_KEY} is not enabled")
 
     # DevCycle handles missing or wrongly typed variables by returning the default value
     # You can check this explicitly by using the variable method
-    variable = dvc.variable(user, VARIABLE_KEY + "-does-not-exist", False)
+    variable = client.variable(user, VARIABLE_KEY + "-does-not-exist", False)
     if variable.isDefaulted:
         logger.info(f"Variable {variable.key} is defaulted to {variable.value}")
 
     try:
         # Get all variables by key for user data
-        all_variables_response = dvc.all_variables(user)
-        logger.info("All variables:\n%s", all_variables_response)
+        all_variables_response = client.all_variables(user)
+        logger.info(f"All variables:\n{all_variables_response}")
 
         if VARIABLE_KEY not in all_variables_response:
             logger.warning(
@@ -50,14 +49,19 @@ def main():
             )
 
         # Get all features by key for user data
-        all_features_response = dvc.all_features(user)
-        logger.info("All features:\n%s", all_features_response)
+        all_features_response = client.all_features(user)
+        logger.info(f"All features:\n{all_features_response}")
+
+        # Post a custom event to DevCycle for user
+        event = DevCycleEvent(
+            type=EventType.CustomEvent,
+            target="some.variable.key",
+            date=datetime.datetime.now(),
+        )
+        client.track(user, event)
 
-        # Post events to DevCycle for user
-        track_response = dvc.track(user, event)
-        logger.info(track_response)
     except Exception as e:
-        logger.exception("Exception when calling Devcycle API: %s\n" % e)
+        logger.exception(f"Exception when calling Devcycle API: {e}\n")
 
 
 if __name__ == "__main__":

example/local_bucketing_client_example.py

@@ -0,0 +1,74 @@
+import logging
+import datetime
+import os
+import time
+
+from devcycle_python_sdk import DevCycleLocalClient, DevCycleLocalOptions
+from devcycle_python_sdk.models.user import DevCycleUser
+from devcycle_python_sdk.models.event import DevCycleEvent, EventType
+
+VARIABLE_KEY = "test-boolean-variable"
+
+logger = logging.getLogger(__name__)
+
+
+def main():
+    """
+    Sample usage of the Python Server SDK using Local Bucketing.
+    For a Django specific sample app, please see https://github.com/DevCycleHQ/python-django-example-app/
+    """
+    logging.basicConfig(level="INFO", format="%(levelname)s: %(message)s")
+
+    # create an instance of the DevCycle Client object
+    server_sdk_key = os.environ["DEVCYCLE_SERVER_SDK_KEY"]
+    options = DevCycleLocalOptions()
+    client = DevCycleLocalClient(server_sdk_key, options)
+
+    # Wait for DevCycle to initialize and load the configuration
+    while not client.is_initialized():
+        logger.info("Waiting for DevCycle to initialize...")
+        time.sleep(1)
+
+    user = DevCycleUser(user_id="test-1234", email="test-user@domain.com", country="US")
+
+    # Use variable_value to access the value of a variable directly
+    if client.variable_value(user, VARIABLE_KEY, False):
+        logger.info(f"Variable {VARIABLE_KEY} is enabled")
+    else:
+        logger.info(f"Variable {VARIABLE_KEY} is not enabled")
+
+    # DevCycle handles missing or wrongly typed variables by returning the default value
+    # You can check this explicitly by using the variable method
+    variable = client.variable(user, VARIABLE_KEY + "-does-not-exist", False)
+    if variable.isDefaulted:
+        logger.info(f"Variable {variable.key} is defaulted to {variable.value}")
+
+    try:
+        # Get all variables by key for user data
+        all_variables_response = client.all_variables(user)
+        logger.info(f"All variables:\n{all_variables_response}")
+
+        if VARIABLE_KEY not in all_variables_response:
+            logger.warning(
+                f"Variable {VARIABLE_KEY} does not exist - create it in the dashboard for this example"
+            )
+
+        # Get all features by key for user data
+        all_features_response = client.all_features(user)
+        logger.info(f"All features:\n{all_features_response}")
+
+        # Post a custom event to DevCycle for user
+        event = DevCycleEvent(
+            type=EventType.CustomEvent,
+            target="some.variable.key",
+            date=datetime.datetime.now(),
+        )
+        client.track(user, event)
+    except Exception as e:
+        logger.exception(f"Exception when calling DevCycle API: {e}")
+    finally:
+        client.close()
+
+
+if __name__ == "__main__":
+    main()

test/api/test_bucketing_client.py

@@ -1,3 +1,4 @@
+import json
 import logging
 import requests
 import responses
@@ -11,10 +12,10 @@ from devcycle_python_sdk.exceptions import (
     CloudClientUnauthorizedError,
     NotFoundError,
 )
-from devcycle_python_sdk.dvc_options import DevCycleCloudOptions
-from devcycle_python_sdk.models.event import Event
+from devcycle_python_sdk.options import DevCycleCloudOptions
+from devcycle_python_sdk.models.event import DevCycleEvent
 from devcycle_python_sdk.models.feature import Feature
-from devcycle_python_sdk.models.user import User
+from devcycle_python_sdk.models.user import DevCycleUser
 from devcycle_python_sdk.models.variable import Variable
 
 logger = logging.getLogger(__name__)
@@ -25,7 +26,7 @@ class BucketingClientTest(unittest.TestCase):
         sdk_key = "dvc_server_" + str(uuid.uuid4())
         options = DevCycleCloudOptions(retry_delay=0)
         self.test_client = BucketingAPIClient(sdk_key, options)
-        self.test_user = User(user_id="test_user_id")
+        self.test_user = DevCycleUser(user_id="test_user_id")
 
     @responses.activate
     def test_variable(self):
@@ -216,12 +217,16 @@ class BucketingClientTest(unittest.TestCase):
         result = self.test_client.track(
             self.test_user,
             events=[
-                Event(
+                DevCycleEvent(
                     type="sample-event",
                 )
             ],
         )
         self.assertEqual(result, "success")
+        data = json.loads(responses.calls[0].request.body)
+        self.assertTrue(type(data["events"][0]["date"]) == int)
+        self.assertEqual(len(data["events"]), 1)
+        self.assertEqual(data["events"][0]["type"], "sample-event")
 
 
 if __name__ == "__main__":

test/api/test_config_client.py

@@ -0,0 +1,133 @@
+import logging
+import unittest
+import uuid
+from os.path import join
+from http import HTTPStatus
+
+import requests
+import responses
+from responses.registries import OrderedRegistry
+
+from devcycle_python_sdk.api.config_client import ConfigAPIClient
+from devcycle_python_sdk.options import DevCycleLocalOptions
+from devcycle_python_sdk.exceptions import (
+    APIClientError,
+    APIClientUnauthorizedError,
+    NotFoundError,
+)
+from test.fixture.data import small_config_json
+
+logger = logging.getLogger(__name__)
+
+
+class ConfigAPIClientTest(unittest.TestCase):
+    def setUp(self) -> None:
+        self.sdk_key = "dvc_server_" + str(uuid.uuid4())
+        self.config_url = (
+            join(
+                "https://config-cdn.devcycle.com/",
+                "config",
+                "v1",
+                "server",
+                self.sdk_key,
+            )
+            + ".json"
+        )
+
+        options = DevCycleLocalOptions(config_retry_delay_ms=0)
+        self.test_client = ConfigAPIClient(self.sdk_key, options)
+        self.test_etag = str(uuid.uuid4())
+        self.test_config_json: dict = small_config_json()
+
+    @responses.activate
+    def test_get_config(self):
+        new_etag = str(uuid.uuid4())
+        responses.add(
+            responses.GET,
+            self.config_url,
+            headers={"ETag": new_etag},
+            json=self.test_config_json,
+        )
+        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+        self.assertDictEqual(result, self.test_config_json)
+        self.assertEqual(etag, new_etag)
+
+    @responses.activate(registry=OrderedRegistry)
+    def test_get_config_retries(self):
+        responses.add(
+            responses.GET,
+            self.config_url,
+            status=500,
+        )
+        responses.add(
+            responses.GET,
+            self.config_url,
+            headers={"ETag": self.test_etag},
+            json=self.test_config_json,
+        )
+        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+
+        self.assertDictEqual(result, self.test_config_json)
+        self.assertEqual(etag, self.test_etag)
+
+    @responses.activate(registry=OrderedRegistry)
+    def test_get_config_retries_network_error(self):
+        responses.add(
+            responses.GET,
+            self.config_url,
+            body=requests.exceptions.ConnectionError("Network Error"),
+        )
+        responses.add(
+            responses.GET,
+            self.config_url,
+            headers={"ETag": self.test_etag},
+            json=self.test_config_json,
+        )
+        result, etag = self.test_client.get_config(config_etag=self.test_etag)
+        self.assertDictEqual(result, self.test_config_json)
+        self.assertEqual(etag, self.test_etag)
+
+    @responses.activate(registry=OrderedRegistry)
+    def test_get_config_retries_exceeded(self):
+        for i in range(2):
+            responses.add(
+                responses.GET,
+                self.config_url,
+                status=HTTPStatus.INTERNAL_SERVER_ERROR,
+            )
+        with self.assertRaises(APIClientError):
+            self.test_client.get_config(config_etag=self.test_etag)
+
+    @responses.activate
+    def test_get_config_not_found(self):
+        for i in range(2):
+            responses.add(
+                responses.GET,
+                self.config_url,
+                status=HTTPStatus.NOT_FOUND,
+            )
+        with self.assertRaises(NotFoundError):
+            self.test_client.get_config(config_etag=self.test_etag)
+
+    @responses.activate
+    def test_get_config_unauthorized(self):
+        for i in range(2):
+            responses.add(
+                responses.GET,
+                self.config_url,
+                status=HTTPStatus.UNAUTHORIZED,
+            )
+        with self.assertRaises(APIClientUnauthorizedError):
+            self.test_client.get_config(config_etag=self.test_etag)
+
+    @responses.activate
+    def test_get_config_not_modified(self):
+        responses.add(
+            responses.GET,
+            self.config_url,
+            status=HTTPStatus.NOT_MODIFIED,
+        )
+
+        new_config, new_etag = self.test_client.get_config(config_etag=self.test_etag)
+        self.assertIsNone(new_config)
+        self.assertEqual(new_etag, self.test_etag)

test/api/test_event_client.py

@@ -0,0 +1,97 @@
+import logging
+import unittest
+import uuid
+from http import HTTPStatus
+
+import responses
+from responses.registries import OrderedRegistry
+
+from devcycle_python_sdk.api.event_client import EventAPIClient
+from devcycle_python_sdk.options import DevCycleLocalOptions
+from devcycle_python_sdk.exceptions import (
+    APIClientError,
+    APIClientUnauthorizedError,
+    NotFoundError,
+)
+from devcycle_python_sdk.models.event import (
+    UserEventsBatchRecord,
+    RequestEvent,
+    EventType,
+)
+from devcycle_python_sdk.models.user import DevCycleUser
+
+logger = logging.getLogger(__name__)
+
+
+class EventAPIClientTest(unittest.TestCase):
+    def setUp(self) -> None:
+        self.sdk_key = "dvc_server_" + str(uuid.uuid4())
+        options = DevCycleLocalOptions(events_api_uri="http://localhost:8080")
+
+        self.test_client = EventAPIClient(self.sdk_key, options)
+        self.test_batch_url = "http://localhost:8080/v1/events/batch"
+
+        self.test_user = DevCycleUser(user_id="123")
+        events = [
+            RequestEvent(
+                type=EventType.VariableDefaulted,
+                user_id="123",
+                date="2023-06-27T12:50:19.871Z",
+                clientDate="2023-06-27T12:50:19.871Z",
+            )
+        ]
+        self.test_batch = [UserEventsBatchRecord(user=self.test_user, events=events)]
+
+    @responses.activate
+    def test_publish_events(self):
+        responses.add(
+            responses.POST,
+            self.test_batch_url,
+            json={"message": "Successfully received 1 event batches."},
+        )
+
+        message = self.test_client.publish_events(self.test_batch)
+        self.assertEqual(message, "Successfully received 1 event batches.")
+
+    @responses.activate
+    def test_publish_events_empty_batch(self):
+        responses.add(
+            responses.POST,
+            self.test_batch_url,
+            json={"message": "Successfully received 1 event batches."},
+        )
+        message = self.test_client.publish_events([])
+        self.assertEqual(message, "Successfully received 1 event batches.")
+
+    @responses.activate(registry=OrderedRegistry)
+    def test_publish_events_retries_exceeded(self):
+        for i in range(2):
+            responses.add(
+                responses.POST,
+                self.test_batch_url,
+                status=HTTPStatus.INTERNAL_SERVER_ERROR,
+            )
+        with self.assertRaises(APIClientError):
+            self.test_client.publish_events(self.test_batch)
+
+    @responses.activate
+    def test_publish_events_not_found(self):
+        for i in range(2):
+            responses.add(
+                responses.POST,
+                self.test_batch_url,
+                status=HTTPStatus.NOT_FOUND,
+            )
+        with self.assertRaises(NotFoundError):
+            self.test_client.publish_events(self.test_batch)
+
+    @responses.activate
+    def test_publish_events_unauthorized(self):
+        for i in range(2):
+            responses.add(
+                responses.POST,
+                self.test_batch_url,
+                status=HTTPStatus.UNAUTHORIZED,
+            )
+        with self.assertRaises(APIClientUnauthorizedError):
+            self.test_client.publish_events(self.test_batch)