DVC-7684 New Cloud SDK

.github/workflows/run-test-harness.yml.disabled

@@ -0,0 +1,17 @@
+name: Run Test Harness
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  harness-tests:
+    name: Harness Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: DevCycleHQ/test-harness@main
+        with:
+          sdks-to-test: python
+          sdk-github-sha: ${{github.event.pull_request.head.sha}}
+          github-token: ${{ secrets.TEST_HARNESS_GH_SECRET }}
+

.github/workflows/unit_test.yml

@@ -0,0 +1,24 @@
+name: Unit Tests
+
+on: [ push ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.10" ]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.test.txt
+      - name: Run unit tests
+        run: |
+          python -m unittest -v

.ruff.toml

@@ -2,10 +2,13 @@
 select = [
 	"F", # PyFlakes
 	"E", # pycodestyle error
-	#"W", # pycodestyle warning
-	#"N", # pep8-naming
+	"W", # pycodestyle warning
+	"N", # pep8-naming
 	"T20", # flake8-print
+	"RUF100", # ensure noqa comments actually match an error
 ]
 ignore = [
 	"E501", # line too long
 ]
+[per-file-ignores]
+"__init__.py" = ["F401"]

README.md

@@ -1,10 +1,12 @@
 # DevCycle Python Server SDK
 
-Welcome to the the DevCycle Python SDK, initially generated via the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/devcycle).
+The DevCycle Python SDK used for feature management.
+
+This SDK allows your application to interface with the [DevCycle Bucketing API](https://docs.devcycle.com/bucketing-api/#tag/devcycle).
 
 ## Requirements.
 
-Python 2.7 and 3.4+
+* Python 3.7+
 
 ## Installation
 
@@ -21,23 +23,21 @@ import devcycle_python_sdk
 ## Getting Started
 
 ```python
-    from __future__ import print_function
-    from devcycle_python_sdk import Configuration, DVCOptions, DVCClient, UserData, Event
-    from devcycle_python_sdk.rest import ApiException
-    configuration = Configuration()
-    configuration.api_key['Authorization'] = 'your_server_key_here'
-    options = DVCOptions(enableEdgeDB=True)
-
-     # create an instance of the API class
-     dvc = DVCClient(configuration, options)
-
-     user = UserData(
-        user_id='test',
-        email='[email protected]',
-        country='CA'
-    )
-
-    value = dvc.variable_value(user, 'feature-key', 'default-value')
+from devcycle_python_sdk import DevCycleCloudClient, DevCycleCloudOptions
+from devcycle_python_sdk.models.user import User
+
+options = DevCycleCloudOptions()
+
+# create an instance of the client class
+dvc = DevCycleCloudClient('YOUR_DVC_SERVER_SDK_KEY', options)
+
+user = User(
+    user_id='test',
+    email='[email protected]',
+    country='CA'
+)
+
+value = dvc.variable_value(user, 'feature-key', 'default-value')
 ```
 
 ## Usage
@@ -46,6 +46,10 @@ To find usage documentation, visit our [docs](https://docs.devcycle.com/docs/sdk
 
 ## Development
 
+When developing the SDK it is recommended that you have both a 3.7 and 3.11 python interpreter installed in order to verify changes across different versions of python.
+
+### Dependencies
+
 To set up dependencies for local development, run:
 ```
 pip install -r requirements.test.txt
@@ -58,6 +62,8 @@ pip install --editable .
 from the top level of the repo (same level as setup.py). Then run the example app as normal.
 
 
+### Linting
+
 Linting checks on PRs are run using [ruff](https://github.com/charliermarsh/ruff), and are configured using `.ruff.toml`. To run the linter locally, run this command from the top level of the repo:
 ```
 ruff check .
@@ -66,4 +72,11 @@ ruff check .
 Ruff can automatically fix simple linting errors (the ones marked with `[*]`). To do so, run:
 ```
 ruff check . --fix
+```
+
+### Unit Tests
+
+To run the unit tests, run:
+```bash
+python -m unittest -v
 ```

devcycle_python_sdk/__init__.py

@@ -1,30 +1,4 @@
-# coding: utf-8
+# Simplify imports for the SDK entry point objects
 
-# flake8: noqa
-
-"""
-    DevCycle Bucketing API
-
-    Documents the DevCycle Bucketing API which provides and API interface to User Bucketing and for generated SDKs.  # noqa: E501
-
-    OpenAPI spec version: 1.0.0
-
-    Generated by: https://github.com/swagger-api/swagger-codegen.git
-"""
-
-from __future__ import absolute_import
-
-# import apis into sdk package
-from devcycle_python_sdk.api.dvc_client import DVCClient
-from devcycle_python_sdk.dvc_options import DVCOptions
-# import ApiClient
-from devcycle_python_sdk.api_client import ApiClient
-from devcycle_python_sdk.configuration import Configuration
-# import models into sdk package
-from devcycle_python_sdk.models.error_response import ErrorResponse
-from devcycle_python_sdk.models.event import Event
-from devcycle_python_sdk.models.feature import Feature
-from devcycle_python_sdk.models.inline_response201 import InlineResponse201
-from devcycle_python_sdk.models.user_data import UserData
-from devcycle_python_sdk.models.user_data_and_events_body import UserDataAndEventsBody
-from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.dvc_options import DevCycleCloudOptions
+from devcycle_python_sdk.dvc_cloud_client import DevCycleCloudClient

devcycle_python_sdk/api/__init__.py

@@ -1,6 +1 @@
-from __future__ import absolute_import
 
-# flake8: noqa
-
-# import apis into api package
-from devcycle_python_sdk.api.dvc_client import DVCClient

devcycle_python_sdk/api/bucketing_client.py

@@ -0,0 +1,153 @@
+import logging
+import math
+from os.path import join
+import random
+import time
+from typing import Dict, List, Optional
+
+import requests
+
+from devcycle_python_sdk.exceptions import (
+    CloudClientError,
+    NotFoundError,
+    CloudClientUnauthorizedError,
+)
+from devcycle_python_sdk.dvc_options import DevCycleCloudOptions
+from devcycle_python_sdk.models.user import User
+from devcycle_python_sdk.models.event import Event
+from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.models.feature import Feature
+
+logger = logging.getLogger(__name__)
+
+
+class BucketingAPIClient:
+    def __init__(self, sdk_key: str, options: DevCycleCloudOptions):
+        self.sdk_key = sdk_key
+        self.options = options
+        self.session = requests.Session()
+        self.session.headers = {
+            "Authorization": sdk_key,
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+        }
+        self.session.max_redirects = 0
+
+    def _url(self, *path_args: str) -> str:
+        return join(self.options.bucketing_API_URI, "v1", *path_args)
+
+    def request(self, method: str, url: str, **kwargs) -> dict:
+        retries_remaining = self.options.request_retries + 1
+        timeout = self.options.request_timeout
+
+        query_params = {}
+        if self.options.enable_edge_db:
+            query_params["enableEdgeDB"] = "true"
+
+        attempts = 1
+        while retries_remaining > 0:
+            request_error: Optional[Exception] = None
+            try:
+                res: requests.Response = self.session.request(
+                    method, url, params=query_params, timeout=timeout, **kwargs
+                )
+
+                if res.status_code == 401:
+                    # Not a retryable error
+                    raise CloudClientUnauthorizedError("Invalid SDK Key")
+                elif res.status_code == 404:
+                    # Not a retryable error
+                    raise NotFoundError(url)
+                elif 400 <= res.status_code < 500:
+                    # Not a retryable error
+                    raise CloudClientError(f"Bad request: HTTP {res.status_code}")
+                elif res.status_code >= 500:
+                    # Retryable error
+                    request_error = CloudClientError(
+                        f"Server error: HTTP {res.status_code}"
+                    )
+            except requests.exceptions.RequestException as e:
+                request_error = e
+
+            if not request_error:
+                break
+
+            logger.error(
+                f"DevCycle cloud bucketing request failed (attempt {attempts}): {request_error}"
+            )
+            retries_remaining -= 1
+            if retries_remaining:
+                retry_delay = exponential_backoff(
+                    attempts, self.options.retry_delay / 1000.0
+                )
+                time.sleep(retry_delay)
+                attempts += 1
+                continue
+
+            raise CloudClientError(message="Retries exceeded", cause=request_error)
+
+        data: dict = res.json()
+        return data
+
+    def variable(self, key: str, user: User) -> Variable:
+        data = self.request("POST", self._url("variables", key), json=user.to_json())
+
+        return Variable(
+            _id=data.get("_id"),
+            key=data.get("key"),
+            type=data.get("type"),
+            value=data.get("value"),
+        )
+
+    def variables(self, user: User) -> Dict[str, Variable]:
+        data = self.request("POST", self._url("variables"), json=user.to_json())
+
+        result: Dict[str, Variable] = {}
+        for key, value in data.items():
+            result[key] = Variable(
+                _id=str(value.get("_id")),
+                key=str(value.get("key")),
+                type=str(value.get("type")),
+                value=value.get("value"),
+                isDefaulted=None,
+            )
+
+        return result
+
+    def features(self, user: User) -> Dict[str, Feature]:
+        data = self.request("POST", self._url("features"), json=user.to_json())
+
+        result: Dict[str, Feature] = {}
+        for key, value in data.items():
+            result[key] = Feature(
+                _id=value.get("_id"),
+                key=value.get("key"),
+                type=value.get("type"),
+                _variation=value.get("_variation"),
+                variationKey=value.get("variationKey"),
+                variationName=value.get("variationName"),
+                evalReason=value.get("evalReason"),
+            )
+
+        return result
+
+    def track(self, user: User, events: List[Event]) -> str:
+        data = self.request(
+            "POST",
+            self._url("track"),
+            json={
+                "user": user.to_json(),
+                "events": [event.to_json() for event in events],
+            },
+        )
+        message = data.get("message", "")
+        return message
+
+
+def exponential_backoff(attempt: int, base_delay: float) -> float:
+    """
+    Exponential backoff starting with 200ms +- 0...40ms jitter
+    """
+    delay = math.pow(2, attempt) * base_delay / 2.0
+    random_sum = delay * 0.1 * random.random()
+    return delay + random_sum