splight-lib 5.6.5.dev0__tar.gz → 5.7.0__tar.gz

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: splight-lib
-Version: 5.6.5.dev0
+Version: 5.7.0
 Summary: Splight Library
 Author: Splight Dev
 Author-email: dev@splight-ae.com

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "splight-lib"
-version = "5.6.5dev0"
+version = "5.7.0"
 description = "Splight Library"
 authors = ["Splight Dev <dev@splight-ae.com>"]
 readme = "README.md"

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/client/database/classmap.py

@@ -3,7 +3,9 @@ from splight_lib.constants import ENGINE_PREFIX, HUB_PREFIX
 MODEL_NAME_MAP = {
     "advancedfilter": f"{ENGINE_PREFIX}/alert/advancedfilters/",
     "alert": f"{ENGINE_PREFIX}/alert/alerts/",
-    "asset": f"{ENGINE_PREFIX}/assets/",
+    "asset": f"{ENGINE_PREFIX}/asset/assets/",
+    "assetkind": f"{ENGINE_PREFIX}/asset/kinds/",
+    # TODO: update to new endpoint for attributes
     "attribute": f"{ENGINE_PREFIX}/attributes/",
     "metadata": f"{ENGINE_PREFIX}/metadata/",
     "chart": f"{ENGINE_PREFIX}/dashboard/charts/",

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/client/database/remote_client.py

@@ -20,6 +20,7 @@ from splight_lib.client.exceptions import (
     InstanceNotFound,
     InvalidModel,
     InvalidModelName,
+    RequestError,
 )
 from splight_lib.constants import ENGINE_PREFIX
 from splight_lib.logging._internal import LogTags, get_splight_logger
@@ -116,7 +117,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         api_path = self._get_api_path(resource_name)
         url = self._base_url / api_path / f"{id}/"
         response = self._restclient.delete(url)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
 
     @retry(SPLIGHT_REQUEST_EXCEPTIONS, tries=3, delay=1)
     def _get(
@@ -155,7 +157,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         api_path = api_path.format_map({"prefix": ENGINE_PREFIX, **instance})
         url = self._base_url / api_path
         response = self._restclient.post(url, json=instance)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         return response.json()
 
     def _retrieve_multiple(
@@ -180,8 +183,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         response = self._restclient.get(url)
         if response.status_code == codes.NOT_FOUND:
             raise InstanceNotFound(resource_name, id)
-        else:
-            response.raise_for_status()
+        elif response.is_error:
+            raise RequestError(response.status_code, response.text)
         return response.json()
 
     @retry(SPLIGHT_REQUEST_EXCEPTIONS, tries=3, delay=1)
@@ -214,7 +217,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         resource_id = instance.get("id")
         url = self._base_url / api_path / f"{resource_id}/download_url/"
         response = self._restclient.get(url)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         download_url = response.json().get("url")
 
         file = NamedTemporaryFile(mode="wb+", suffix=instance["name"])
@@ -253,7 +257,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
     def _list(self, url: furl, **kwargs) -> PaginatedResponse:
         params = self._parse_params(**kwargs)
         response = self._restclient.get(url, params=params)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         return response.json()
 
     def _create(
@@ -281,7 +286,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
                 req_args = {"json": instance}
 
             response = self._restclient.post(url, **req_args)
-            response.raise_for_status()
+            if response.is_error:
+                raise RequestError(response.status_code, response.text)
             instance = response.json()
         logger.debug(
             "Instance %s created", instance["id"], tags=LogTags.DATABASE
@@ -318,12 +324,14 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
 
             response = self._restclient.put(url, **req_args)
 
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         return response.json()
 
     def _create_file(self, instance: Dict, url: furl):
         response = self._restclient.post(url, data=instance)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         file_path = instance["file"]
         # Check is this is handled somewher
         created_instance = response.json()
@@ -335,7 +343,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
         resource_id = instance.get("id")
         url = self._base_url / api_path / f"{resource_id}/upload_url/"
         response = self._restclient.get(url)
-        response.raise_for_status()
+        if response.is_error:
+            raise RequestError(response.status_code, response.text)
         upload_url = response.json().get("url")
         file = open(file_path, "rb")
         file_name = instance["name"]
@@ -345,7 +354,8 @@ class RemoteDatabaseClient(AbstractDatabaseClient, AbstractRemoteClient):
                 upload_url,
                 files=file,
             )
-            response.raise_for_status()
+            if response.is_error:
+                raise RequestError(response.status_code, response.text)
         logger.debug(
             "File uploaded succesfully %s.", resource_id, tags=LogTags.DATABASE
         )

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/client/exceptions.py

@@ -16,6 +16,14 @@ SPLIGHT_REQUEST_EXCEPTIONS = (
 )
 
 
+class RequestError(Exception):
+    def __init__(self, status_code: int, text: str):
+        self._msg = f"Got an error status code: {status_code} - {text}"
+
+    def __str__(self) -> str:
+        return self._msg
+
+
 class InvalidModelName(Exception):
     def __init__(self, model_name: str):
         self._msg = f"Model {model_name} is not a valid database model"

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/client/tests/test_database.py

@@ -21,6 +21,10 @@ class MockResponse:
     def __init__(self, json_data):
         self.json_data = json_data
 
+    @property
+    def is_error(self) -> bool:
+        return False if self.status_code < 400 else True
+
     def raise_for_status(self):
         return None
 
@@ -115,6 +119,7 @@ def test_delete(mocker: MockerFixture):
     mock_delete = mocker.patch.object(
         SplightRestClient,
         "delete",
+        return_value=MockResponse({}),
     )
     client.delete("alert", "instance_id")
     mock_delete.assert_called_once()

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/client/tests/test_datalake.py

@@ -18,6 +18,10 @@ class MockResponse:
     def __init__(self, json_data):
         self.json_data = json_data
 
+    @property
+    def is_error(self) -> bool:
+        return False if self.status_code < 400 else True
+
     def raise_for_status(self):
         return None
 

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/__init__.py

@@ -1,5 +1,5 @@
 from splight_lib.models.alert import Alert, AlertItem
-from splight_lib.models.asset import Asset
+from splight_lib.models.asset import Asset, AssetKind
 from splight_lib.models.attribute import Attribute
 from splight_lib.models.component import (
     Component,
@@ -30,6 +30,7 @@ __all__ = [
     Alert,
     AlertItem,
     Asset,
+    AssetKind,
     Attribute,
     Boolean,
     Chart,

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/asset.py

@@ -2,16 +2,42 @@ import warnings
 from typing import Any, List, Optional, Tuple
 
 from geojson_pydantic import GeometryCollection
-from pydantic import Field
+from pydantic import BaseModel, Field
 
 from splight_lib.constants import DESCRIPTION_MAX_LENGTH
 from splight_lib.models.attribute import Attribute
 from splight_lib.models.base import SplightDatabaseBaseModel
+from splight_lib.models.exceptions import MethodNotAllowed
 from splight_lib.models.metadata import Metadata
 
 warnings.filterwarnings("ignore", category=UserWarning)
 
 
+class AssetRepr(BaseModel):
+    id: str
+    name: str
+
+
+class AssetRelationship(BaseModel):
+    id: str
+    name: str
+    description: Optional[str] = None
+    related_asset_kind: Optional[str] = None
+    asset: AssetRepr
+    related_asset: AssetRepr
+
+
+class AssetKind(SplightDatabaseBaseModel):
+    id: Optional[str] = None
+    name: str
+
+    def save(self):
+        raise MethodNotAllowed("AssetKind objects are read-only")
+
+    def delete(self):
+        raise MethodNotAllowed("AssetKind objects are read-only")
+
+
 class Asset(SplightDatabaseBaseModel):
     id: Optional[str] = None
     name: str
@@ -23,7 +49,9 @@ class Asset(SplightDatabaseBaseModel):
     metadata: List[Metadata] = []
     geometry: Optional[GeometryCollection] = None
     centroid_coordinates: Optional[Tuple[float, float]] = None
-    related_assets: Optional[List["Asset"]] = []
+    kind: Optional[AssetKind] = None
+    related_to: List[AssetRelationship] = []
+    related_from: List[AssetRelationship] = []
 
     def set_attribute(self, attribute: Attribute, value: Any, value_type: str):
         new_value = self._db_client.operate(

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/base.py

@@ -41,8 +41,8 @@ class SplightDatabaseBaseModel(BaseModel):
             self.model_dump(exclude_none=True, mode="json"),
             files=files_dict,
         )
-        if not self.id:
-            self.id = saved["id"]
+        for field in self.model_fields:
+            setattr(self, field, saved.get(field))
 
     def delete(self):
         self._db_client.delete(

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/exceptions.py

@@ -1,3 +1,7 @@
+class MethodNotAllowed(Exception):
+    pass
+
+
 class InvalidObjectInstance(Exception):
     pass
 

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/hub_solution.py

@@ -18,9 +18,17 @@ class HubSolution(SplightDatabaseBaseModel):
     main_file: Optional[FilePath] = Field(default=None, exclude=True)
     variables_file: Optional[FilePath] = Field(default=None, exclude=True)
     values_file: Optional[FilePath] = Field(default=None, exclude=True)
+    readme_file: Optional[FilePath] = Field(default=None, exclude=True)
 
     def save(self) -> None:
-        if not all([self.main_file, self.variables_file, self.values_file]):
+        if not all(
+            [
+                self.main_file,
+                self.variables_file,
+                self.values_file,
+                self.readme_file,
+            ]
+        ):
             raise ValueError("Missing one of the required files")
         return super().save()
 
@@ -29,4 +37,5 @@ class HubSolution(SplightDatabaseBaseModel):
             "main_file": self.main_file,
             "variables_file": self.variables_file,
             "values_file": self.values_file,
+            "readme_file": self.readme_file,
         }

{splight_lib-5.6.5.dev0 → splight_lib-5.7.0}/splight_lib/models/tests/test_database_model.py

@@ -9,8 +9,8 @@ from uuid import uuid4  # noqa: E402
 
 import pytest  # noqa: E402
 
-from splight_lib.client.database.local_client import (  # noqa: E402
-    LocalDatabaseClient,
+from splight_lib.client.database.remote_client import (  # noqa: E402
+    RemoteDatabaseClient,
 )
 from splight_lib.models.base import SplightDatabaseBaseModel  # noqa: E402
 from splight_lib.settings import settings  # noqa: E402
@@ -53,7 +53,7 @@ RESOURCE_LIST = [
 ]
 
 
-@patch.object(LocalDatabaseClient, "_get", return_value=RESOURCE_LIST)
+@patch.object(RemoteDatabaseClient, "_get", return_value=RESOURCE_LIST)
 def test_list(mock):
     instances = Resource.list()
     mock.assert_called_with(Resource.__name__)
@@ -64,7 +64,7 @@ def test_list(mock):
     )
 
 
-@patch.object(LocalDatabaseClient, "_get", return_value=RESOURCE_LIST)
+@patch.object(RemoteDatabaseClient, "_get", return_value=RESOURCE_LIST)
 def test_list_first(mock):
     instances = Resource.list(first=True)
     mock.assert_called_with(Resource.__name__, first=True)
@@ -81,11 +81,18 @@ def test_list_first(mock):
 )
 def test_retrieve(instance_dict):
     with patch.object(
-        LocalDatabaseClient, "_get", return_value=instance_dict
+        RemoteDatabaseClient, "_get", return_value=instance_dict
     ) as mock:
-        instance = Resource.retrieve(instance_dict["id"])
-        mock.assert_called_with(Resource.__name__, id=instance.id, first=True)
-        assert instance.model_dump() == instance_dict
+        with patch.object(
+            RemoteDatabaseClient,
+            "_get_api_path",
+            return_value="/api/resource/",
+        ):
+            instance = Resource.retrieve(instance_dict["id"])
+            mock.assert_called_with(
+                Resource.__name__, id=instance.id, first=True
+            )
+            assert instance.model_dump() == instance_dict
 
 
 @pytest.mark.parametrize(
@@ -94,12 +101,19 @@ def test_retrieve(instance_dict):
 )
 def test_save_with_id(instance_dict):
     with patch.object(
-        LocalDatabaseClient, "save", return_value=instance_dict
+        RemoteDatabaseClient, "save", return_value=instance_dict
     ) as mock:
-        resource = Resource.model_validate(instance_dict)
-        resource.save()
-        mock.assert_called_with(Resource.__name__, instance_dict, files=None)
-        assert resource.model_dump() == instance_dict
+        with patch.object(
+            RemoteDatabaseClient,
+            "_get_api_path",
+            return_value="/api/resource/",
+        ):
+            resource = Resource.model_validate(instance_dict)
+            resource.save()
+            mock.assert_called_with(
+                Resource.__name__, instance_dict, files=None
+            )
+            assert resource.model_dump() == instance_dict
 
 
 @pytest.mark.parametrize(
@@ -108,14 +122,21 @@ def test_save_with_id(instance_dict):
 )
 def test_save_without_id(instance_dict):
     with patch.object(
-        LocalDatabaseClient, "save", return_value=instance_dict
+        RemoteDatabaseClient, "save", return_value=instance_dict
     ) as mock:
-        resource = Resource.model_validate(instance_dict)
-        resource.id = None
-        resource_dict = resource.model_dump(exclude_none=True)
-        resource.save()
-        mock.assert_called_with(Resource.__name__, resource_dict, files=None)
-        assert resource.model_dump() == instance_dict
+        with patch.object(
+            RemoteDatabaseClient,
+            "_get_api_path",
+            return_value="/api/resource/",
+        ):
+            resource = Resource.model_validate(instance_dict)
+            resource.id = None
+            resource_dict = resource.model_dump(exclude_none=True)
+            resource.save()
+            mock.assert_called_with(
+                Resource.__name__, resource_dict, files=None
+            )
+            assert resource.model_dump() == instance_dict
 
 
 @pytest.mark.parametrize(
@@ -124,10 +145,15 @@ def test_save_without_id(instance_dict):
 )
 def test_delete(instance_dict):
     with patch.object(
-        LocalDatabaseClient, "delete", return_value=None
+        RemoteDatabaseClient, "delete", return_value=instance_dict
     ) as mock:
-        resource = Resource.model_validate(instance_dict)
-        resource.delete()
-        mock.assert_called_with(
-            resource_name=Resource.__name__, id=resource.id
-        )
+        with patch.object(
+            RemoteDatabaseClient,
+            "_get_api_path",
+            return_value="/api/resource/",
+        ):
+            resource = Resource.model_validate(instance_dict)
+            resource.delete()
+            mock.assert_called_with(
+                resource_name=Resource.__name__, id=resource.id
+            )