UncountablePythonSDK 0.0.24__py3-none-any.whl → 0.0.25__py3-none-any.whl

{UncountablePythonSDK-0.0.24.dist-info → UncountablePythonSDK-0.0.25.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: UncountablePythonSDK
-Version: 0.0.24
+Version: 0.0.25
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{UncountablePythonSDK-0.0.24.dist-info → UncountablePythonSDK-0.0.25.dist-info}/RECORD

@@ -15,7 +15,7 @@ docs/static/favicons/manifest.json,sha256=6q_3nZkcg_x0xut4eE-xpdeMY1TydwiZIcbXlL
 docs/static/favicons/mstile-150x150.png,sha256=eAK4QdEofhdLtfmjuPTpnX3MJqYnvGXsHYUjlcQekyY,1035
 docs/static/favicons/safari-pinned-tab.svg,sha256=S84fRnz0ZxLnQrKtmmFZytiRyu1xLtMR_RVy5jmwU7k,1926
 examples/async_batch.py,sha256=wpf_3P547375vTIO4pKv5vw6WCkUnzqvw_S3idfhjvM,1122
-examples/create_entity.py,sha256=54AmZt83EpypxGcYZSIMmWlGz2oAgHFOsKuLSZOcHsI,625
+examples/create_entity.py,sha256=2ciY0Cy4McGmfyElFF19OyUrbAa7jOEG8PQfR7Hq6NI,636
 examples/upload_files.py,sha256=ZsMChgOioraVHv207YREpivAOf4dq3IxGIBoROoDX_4,482
 examples/recipe-import/importer.py,sha256=baD71xuNibxDTe3bGHsMEIZEf9Xtb-IumBNpCEV0RZU,1134
 pkgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -105,11 +105,11 @@ type_spec/external/api/recipes/set_recipe_tags.yaml,sha256=IrdkbryxZjNy8n4aMNLRT
 type_spec/external/api/triggers/run_trigger.yaml,sha256=c8xDV3bQRjcRRDG4Y7kdQmMMu1fj3ae5eUi-Sdbsi54,405
 uncountable/__init__.py,sha256=281cC2hs8pbrD0jVKMol-tbWSh7Zcsc8oRT42dKteyE,102
 uncountable/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-uncountable/core/__init__.py,sha256=7xUnbSWJzS31sWg0jCe5nIksn5s0PVdwUrUmDttHfCY,258
+uncountable/core/__init__.py,sha256=J0CeeztqyJe7klvHM-8fwSivN1sud6xZThOdaThnQrU,314
 uncountable/core/async_batch.py,sha256=0cRmCr6Z9sNxZyfY9Dl8wlCA4anISVZuHGgBegHhUbc,749
-uncountable/core/client.py,sha256=7bLuACxMJZsckSfL2j-p-XThYdvDAUAwm5nND9s-v1o,6946
+uncountable/core/client.py,sha256=cP6yEHv5KGE2NJn0BAQh470mirBfITMLsfEs-zj-6Ys,9024
 uncountable/core/file_upload.py,sha256=zTpAFSd7_-TmEVWxOn1rDznyWE6_AdZyuDQC3LP34iI,2667
-uncountable/core/types.py,sha256=gQtCw1-WSRak_ypFlGI1Ea9iZBP9zDeFq6XQtiXBlZA,459
+uncountable/core/types.py,sha256=RaNVuUPpcMBCfk-stS4Jh-9WBFzKK6_cVgRfPv7Dz6g,280
 uncountable/integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uncountable/integration/construct_client.py,sha256=r6M5pnIO0fKcjf5d_AREPtWZ6AkWgcjkdu_jHQEYlT8,1084
 uncountable/integration/cron.py,sha256=TIPqMPMSMtMJTu4aXwLf6QY-OLrpmyITLDp48UIr4Ok,919
@@ -210,7 +210,7 @@ uncountable/types/api/recipes/set_recipe_outputs.py,sha256=QYq39TNchQ80ET1C77OE9
 uncountable/types/api/recipes/set_recipe_tags.py,sha256=U710hgq9-t6QZGRB-ZGHskpt4iXwYEjIRb67eh3P518,2453
 uncountable/types/api/triggers/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/triggers/run_trigger.py,sha256=9m9M8-nlGB_sAU2Qm2lWugp4h4Osqj6QpjNfU8osd1U,901
-UncountablePythonSDK-0.0.24.dist-info/METADATA,sha256=3xzubcqtwZH0Z5jnBD1q_8eU5UyYnNiXiS_RnBAm4Xo,1613
-UncountablePythonSDK-0.0.24.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-UncountablePythonSDK-0.0.24.dist-info/top_level.txt,sha256=HaMiBnH1wA7SG9-RVHIJPBH3l8X5gee2jUf-77Nz-Dk,41
-UncountablePythonSDK-0.0.24.dist-info/RECORD,,
+UncountablePythonSDK-0.0.25.dist-info/METADATA,sha256=LU2djI-Urro-UFLucKkSiaI6kq9ueCClAJhRDI2snAM,1613
+UncountablePythonSDK-0.0.25.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+UncountablePythonSDK-0.0.25.dist-info/top_level.txt,sha256=HaMiBnH1wA7SG9-RVHIJPBH3l8X5gee2jUf-77Nz-Dk,41
+UncountablePythonSDK-0.0.25.dist-info/RECORD,,

examples/create_entity.py

@@ -1,4 +1,5 @@
-from uncountable.core import AuthDetailsApiKey, Client
+from uncountable.core import Client
+from uncountable.core.client import AuthDetailsOAuth
 from uncountable.types import (
     entity_t,
     field_values_t,
@@ -7,9 +8,8 @@ from uncountable.types import (
 
 client = Client(
     base_url="https://app.uncountable.com",
-    auth_details=AuthDetailsApiKey(
-        api_id="X",
-        api_secret_key="X",
+    auth_details=AuthDetailsOAuth(
+        refresh_token="x"
     ),
 )
 entities = client.create_entity(

uncountable/core/__init__.py

@@ -1,5 +1,6 @@
-from .client import AuthDetailsApiKey, Client
+from .client import Client
+from .types import AuthDetailsApiKey, AuthDetailsOAuth
 from .file_upload import MediaFileUpload, UploadedFile
 from .async_batch import AsyncBatchProcessor
 
-__all__: list[str] = ["AuthDetailsApiKey", "AsyncBatchProcessor", "Client", "MediaFileUpload", "UploadedFile"]
+__all__: list[str] = ["AuthDetailsApiKey", "AuthDetailsOAuth", "AsyncBatchProcessor", "Client", "MediaFileUpload", "UploadedFile"]

uncountable/core/client.py

@@ -1,4 +1,5 @@
 import base64
+from datetime import datetime, timedelta
 import json
 import typing
 from dataclasses import dataclass
@@ -14,7 +15,7 @@ from pkgs.serialization_util.serialization_helpers import JsonValue
 from uncountable.types.client_base import APIRequest, ClientMethods
 
 from .file_upload import FileUpload, FileUploader, UploadedFile
-from .types import AuthDetails, AuthDetailsApiKey
+from .types import AuthDetails, AuthDetailsApiKey, AuthDetailsOAuth
 
 DT = typing.TypeVar("DT")
 
@@ -48,11 +49,13 @@ class HTTPPostRequest(HTTPRequestBase):
 HTTPRequest = HTTPPostRequest | HTTPGetRequest
 
 
-
 @dataclass(kw_only=True)
-class ClientConfig():
+class ClientConfig:
     allow_insecure_tls: bool = False
-      
+
+
+OAUTH_REFRESH_WINDOW_SECONDS = 60 * 5
+
 
 class APIResponseError(BaseException):
     status_code: int
@@ -107,19 +110,60 @@ class SDKError(BaseException):
         return f"internal SDK error, please contact Uncountable support: {self.message}"
 
 
+@dataclass(kw_only=True)
+class OAuthBearerTokenCache:
+    token: str
+    expires_at: datetime
+
+
+@dataclass(kw_only=True)
+class GetOauthBearerTokenData:
+    access_token: str
+    expires_in: int
+    token_type: str
+    scope: str
+
+
+oauth_bearer_token_data_parser = CachedParser(GetOauthBearerTokenData)
+
+
 class Client(ClientMethods):
     _parser_map: dict[type, CachedParser] = {}
     _auth_details: AuthDetails
     _base_url: str
     _file_uploader: FileUploader
     _cfg: ClientConfig
+    _oauth_bearer_token_cache: OAuthBearerTokenCache | None = None
 
-    def __init__(self, *, base_url: str, auth_details: AuthDetails, config: ClientConfig | None = None):
+    def __init__(
+        self,
+        *,
+        base_url: str,
+        auth_details: AuthDetails,
+        config: ClientConfig | None = None,
+    ):
         self._auth_details = auth_details
         self._base_url = base_url
         self._file_uploader = FileUploader(self._base_url, self._auth_details)
         self._cfg = config or ClientConfig()
 
+    def _get_response_json(self, response: requests.Response) -> dict[str, JsonValue]:
+        if response.status_code < 200 or response.status_code > 299:
+            extra_details: dict[str, JsonValue] | None = None
+            try:
+                data = response.json()
+                if "error" in data:
+                    extra_details = data["error"]
+            except JSONDecodeError:
+                pass
+            raise APIResponseError.construct_error(
+                status_code=response.status_code, extra_details=extra_details
+            )
+        try:
+            return response.json()
+        except JSONDecodeError:
+            raise SDKError("unable to process response")
+
     def do_request(self, *, api_request: APIRequest, return_type: type[DT]) -> DT:
         http_request = self._build_http_request(api_request=api_request)
         match http_request:
@@ -128,7 +172,7 @@ class Client(ClientMethods):
                     http_request.url,
                     headers=http_request.headers,
                     params=http_request.query_params,
-                    verify=not self._cfg.allow_insecure_tls
+                    verify=not self._cfg.allow_insecure_tls,
                 )
             case HTTPPostRequest():
                 response = requests.post(
@@ -136,26 +180,16 @@ class Client(ClientMethods):
                     headers=http_request.headers,
                     data=http_request.body,
                     params=http_request.query_params,
-                    verify=not self._cfg.allow_insecure_tls
+                    verify=not self._cfg.allow_insecure_tls,
                 )
             case _:
                 typing.assert_never(http_request)
-        if response.status_code < 200 or response.status_code > 299:
-            extra_details: dict[str, JsonValue] | None = None
-            try:
-                data = response.json()
-                if "error" in data:
-                    extra_details = data["error"]
-            except JSONDecodeError:
-                pass
-            raise APIResponseError.construct_error(
-                status_code=response.status_code, extra_details=extra_details
-            )
+        response_data = self._get_response_json(response)
         cached_parser = self._get_cached_parser(return_type)
         try:
-            data = response.json()["data"]
+            data = response_data["data"]
             return cached_parser.parse_api(data)
-        except ValueError | JSONDecodeError:
+        except ValueError | JSONDecodeError | KeyError:
             raise SDKError("unable to process response")
 
     def _get_cached_parser(self, data_type: type[DT]) -> CachedParser[DT]:
@@ -163,6 +197,32 @@ class Client(ClientMethods):
             self._parser_map[data_type] = CachedParser(data_type)
         return self._parser_map[data_type]
 
+    def _get_oauth_bearer_token(self, *, oauth_details: AuthDetailsOAuth) -> str:
+        if (
+            self._oauth_bearer_token_cache is None
+            or (
+                self._oauth_bearer_token_cache.expires_at - datetime.now()
+            ).total_seconds()
+            < OAUTH_REFRESH_WINDOW_SECONDS
+        ):
+            refresh_url = urljoin(self._base_url, "/token/get_bearer_token")
+            response = requests.post(
+                refresh_url,
+                data={
+                    "client_secret": oauth_details.refresh_token,
+                    "scope": oauth_details.scope,
+                    "grant_type": "client_credentials",
+                },
+            )
+            data = self._get_response_json(response)
+            token_data = oauth_bearer_token_data_parser.parse_storage(data)
+            self._oauth_bearer_token_cache = OAuthBearerTokenCache(
+                token=token_data.access_token,
+                expires_at=datetime.now() + timedelta(seconds=token_data.expires_in),
+            )
+
+        return self._oauth_bearer_token_cache.token
+
     def _build_auth_headers(self) -> dict[str, str]:
         match self._auth_details:
             case AuthDetailsApiKey():
@@ -170,6 +230,9 @@ class Client(ClientMethods):
                     f"{self._auth_details.api_id}:{self._auth_details.api_secret_key}".encode()
                 ).decode("utf-8")
                 return {"Authorization": f"Basic {encoded}"}
+            case AuthDetailsOAuth():
+                token = self._get_oauth_bearer_token(oauth_details=self._auth_details)
+                return {"Authorization": f"Bearer {token}"}
         typing.assert_never(self._auth_details)
 
     def _build_http_request(self, *, api_request: APIRequest) -> HTTPRequest:

uncountable/core/types.py

@@ -1,16 +1,4 @@
-import base64
-import json
-import typing
 from dataclasses import dataclass
-from enum import StrEnum
-from urllib.parse import urljoin
-
-import aiohttp
-import requests
-
-from pkgs.argument_parser import CachedParser
-from pkgs.serialization_util import serialize_for_api
-from uncountable.types.client_base import APIRequest, ClientMethods
 
 
 @dataclass(kw_only=True)
@@ -19,4 +7,10 @@ class AuthDetailsApiKey:
     api_secret_key: str
 
 
-AuthDetails = AuthDetailsApiKey
+@dataclass(kw_only=True)
+class AuthDetailsOAuth:
+    refresh_token: str
+    scope: str = "unc.rnd"
+
+
+AuthDetails = AuthDetailsApiKey | AuthDetailsOAuth