UncountablePythonSDK 0.0.24__tar.gz → 0.0.25__tar.gz

{uncountablepythonsdk-0.0.24/UncountablePythonSDK.egg-info → uncountablepythonsdk-0.0.25}/PKG-INFO

@@ -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 → uncountablepythonsdk-0.0.25/UncountablePythonSDK.egg-info}/PKG-INFO

@@ -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 → uncountablepythonsdk-0.0.25}/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(

uncountablepythonsdk-0.0.25/uncountable/core/__init__.py

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

{uncountablepythonsdk-0.0.24 → uncountablepythonsdk-0.0.25}/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:

uncountablepythonsdk-0.0.25/uncountable/core/types.py

@@ -0,0 +1,16 @@
+from dataclasses import dataclass
+
+
+@dataclass(kw_only=True)
+class AuthDetailsApiKey:
+    api_id: str
+    api_secret_key: str
+
+
+@dataclass(kw_only=True)
+class AuthDetailsOAuth:
+    refresh_token: str
+    scope: str = "unc.rnd"
+
+
+AuthDetails = AuthDetailsApiKey | AuthDetailsOAuth

uncountablepythonsdk-0.0.24/uncountable/core/__init__.py

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

uncountablepythonsdk-0.0.24/uncountable/core/types.py

@@ -1,22 +0,0 @@
-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)
-class AuthDetailsApiKey:
-    api_id: str
-    api_secret_key: str
-
-
-AuthDetails = AuthDetailsApiKey