cecil 0.0.13__tar.gz → 0.0.15__tar.gz

{cecil-0.0.13 → cecil-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cecil
-Version: 0.0.13
+Version: 0.0.15
 Summary: Python SDK for Cecil Earth
 License-Expression: MIT
 License-File: LICENSE.txt

cecil-0.0.15/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.0.15"

{cecil-0.0.13 → cecil-0.0.15}/src/cecil/__init__.py

@@ -1 +1,2 @@
 from .client import Client
+from .errors import Error

{cecil-0.0.13 → cecil-0.0.15}/src/cecil/client.py

@@ -6,6 +6,13 @@ import snowflake.connector
 from pydantic import BaseModel
 from requests import auth
 
+from .errors import (
+    Error,
+    _handle_bad_request,
+    _handle_not_found,
+    _handle_unprocessable_entity,
+)
+
 from .models import (
     AOI,
     AOICreate,
@@ -21,7 +28,7 @@ from .models import (
 )
 
 # TODO: find a way to get this version from __about__.py
-SDK_VERSION = "0.0.13"
+SDK_VERSION = "0.0.15"
 
 # TODO: Documentation (Google style)
 # TODO: Add HTTP retries
@@ -106,6 +113,7 @@ class Client:
         res = self._post(
             url=f"/v0/recover-api-key",
             model=RecoverAPIKeyRequest(email=email),
+            skip_auth=True,
         )
 
         return RecoverAPIKey(**res)
@@ -115,9 +123,10 @@ class Client:
 
         return RotateAPIKey(**res)
 
-    def _request(self, method: str, url: str, **kwargs) -> Dict:
+    def _request(self, method: str, url: str, skip_auth=False, **kwargs) -> Dict:
 
-        self._set_auth()
+        if skip_auth is False:
+            self._set_auth()
 
         headers = {"cecil-python-sdk-version": SDK_VERSION}
 
@@ -133,21 +142,36 @@ class Client:
             r.raise_for_status()
             return r.json()
 
-        except requests.exceptions.ConnectionError as err:
-            raise ValueError("Connection error") from err
+        except requests.exceptions.ConnectionError:
+            raise Error("failed to connect to the Cecil Platform")
         except requests.exceptions.HTTPError as err:
-            message = f"Request failed with status code {err.response.status_code}"
-            if err.response.text != "":
-                message += f": {err.response.text}"
-
-            raise ValueError(message) from err
+            match err.response.status_code:
+                case 400:
+                    _handle_bad_request(err.response)
+                case 401:
+                    raise Error("unauthorised")
+                case 404:
+                    _handle_not_found(err.response)
+                case 422:
+                    _handle_unprocessable_entity(err.response)
+                case 500:
+                    raise Error("internal server error")
+                case _:
+                    raise Error(
+                        f"request failed with code {err.response.status_code}",
+                        err.response.text,
+                    )
 
     def _get(self, url: str, **kwargs) -> Dict:
         return self._request(method="get", url=url, **kwargs)
 
-    def _post(self, url: str, model: BaseModel, **kwargs) -> Dict:
+    def _post(self, url: str, model: BaseModel, skip_auth=False, **kwargs) -> Dict:
         return self._request(
-            method="post", url=url, json=model.model_dump(by_alias=True), **kwargs
+            method="post",
+            url=url,
+            json=model.model_dump(by_alias=True),
+            skip_auth=skip_auth,
+            **kwargs,
         )
 
     def _set_auth(self) -> None:

cecil-0.0.15/src/cecil/errors.py

@@ -0,0 +1,62 @@
+import json
+
+
+class Error(Exception):
+    def __init__(self, message: str, details=None):
+        self.message = message
+        self.details = details
+
+        if self.details is not None:
+            super().__init__(f"{self.message} \n{json.dumps(self.details, indent=2)}")
+            return
+
+        super().__init__(self.message)
+
+
+def _format_json_key(value: str):
+    return "".join(["_" + i.lower() if i.isupper() else i for i in value]).lstrip("_")
+
+
+def _is_json(value: str):
+    try:
+        json.loads(value)
+        return True
+    except ValueError:
+        return False
+
+
+def _handle_bad_request(response):
+    if not _is_json(response.text):
+        raise Error("bad request")
+
+    details = {}
+    for key, value in response.json().items():
+        details[_format_json_key(key)] = value
+
+    raise Error("bad request", details)
+
+
+def _handle_not_found(response):
+    if not _is_json(response.text):
+        raise Error("resource not found")
+
+    details = {}
+    for key, value in response.json().items():
+        details[_format_json_key(key)] = value
+
+    raise Error("resource not found", details)
+
+
+def _handle_unprocessable_entity(response):
+    if not _is_json(response.text):
+        raise Error(f"failed to process request")
+
+    res_body = response.json()
+    if "params" not in res_body:
+        raise Error(f"failed to process request")
+
+    details = {}
+    for key, value in res_body["params"].items():
+        details[_format_json_key(key)] = value
+
+    raise Error(f"failed to process request", details)

cecil-0.0.13/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.0.13"