hydroserverpy 1.0.0__py3-none-any.whl → 1.1.0b1__py3-none-any.whl

hydroserverpy/api/main.py

@@ -62,7 +62,7 @@ class HydroServer:
         auth = auth or self.auth
 
         if auth and auth[0] == "__key__":
-            self._session.headers.update({"key": auth[1]})
+            self._session.headers.update({"X-API-Key": auth[1]})
         elif auth:
             self._session.headers.update(
                 {"Authorization": f"Bearer {self._authenticate(auth[0], auth[1])}"}

hydroserverpy/api/models/__init__.py

@@ -2,6 +2,7 @@ from .iam.account import Account
 from .iam.workspace import Workspace
 from .iam.role import Role
 from .iam.collaborator import Collaborator
+from .iam.apikey import APIKey
 from .iam.account import Account
 from .sta.datastream import Datastream
 from .sta.observed_property import ObservedProperty
@@ -17,5 +18,6 @@ from .etl.data_archive import DataArchive
 Workspace.model_rebuild()
 Role.model_rebuild()
 Collaborator.model_rebuild()
+APIKey.model_rebuild()
 
 Unit.model_rebuild()

hydroserverpy/api/models/iam/apikey.py

@@ -0,0 +1,77 @@
+from typing import Optional, Union, TYPE_CHECKING
+from uuid import UUID
+from datetime import datetime
+from pydantic import BaseModel
+from ..base import HydroServerModel
+
+if TYPE_CHECKING:
+    from hydroserverpy import HydroServer
+    from hydroserverpy.api.models import Workspace, Role
+
+
+class APIKeyFields(BaseModel):
+    name: str
+    description: Optional[str] = None
+    is_active: bool
+    expires_at: Optional[datetime] = None
+    role: "Role"
+
+
+class APIKey(HydroServerModel, APIKeyFields):
+    def __init__(self, _connection: "HydroServer", _uid: Union[UUID, str], **data):
+        super().__init__(
+            _connection=_connection, _model_ref="apikeys", _uid=_uid, **data
+        )
+
+        self._workspace_id = str(data.get("workspace_id") or data["workspaceId"])
+        self._workspace = None
+
+    @property
+    def workspace(self) -> "Workspace":
+        """The workspace this data source belongs to."""
+
+        if self._workspace is None and self._workspace_id:
+            self._workspace = self._connection.workspaces.get(uid=self._workspace_id)
+
+        return self._workspace
+
+    def refresh(self):
+        """Refresh this data source from HydroServer."""
+
+        self._original_data = (
+            self._connection.workspaces.get_api_key(
+                uid=self._workspace_id, api_key_id=self.uid
+            ).model_dump(exclude=["uid"])
+        )
+        self.__dict__.update(self._original_data)
+        self._workspace = None
+
+    def save(self):
+        """Save changes to this data source to HydroServer."""
+
+        if self._patch_data:
+            api_key = self._connection.workspaces.update_api_key(
+                uid=self._workspace_id, api_key_id=self.uid, **self._patch_data
+            )
+            self._original_data = api_key.dict(by_alias=False, exclude=["uid"])
+            self.__dict__.update(self._original_data)
+
+    def delete(self):
+        """Delete this data source from HydroServer."""
+
+        if not self._uid:
+            raise AttributeError("This resource cannot be deleted: UID is not set.")
+
+        self._connection.workspaces.delete_api_key(
+            uid=self._workspace_id, api_key_id=self.uid
+        )
+        self._uid = None
+
+    def regenerate(self):
+        """Regenerates this API key. WARNING: Previous key will be invalidated."""
+
+        _, key = self._connection.workspaces.regenerate_api_key(
+            uid=self._workspace_id, api_key_id=self.uid
+        )
+
+        return key

hydroserverpy/api/models/iam/workspace.py

@@ -1,5 +1,6 @@
 from typing import List, Union, Optional, TYPE_CHECKING
 from uuid import UUID
+from datetime import datetime
 from pydantic import BaseModel, Field, EmailStr
 from ..base import HydroServerModel
 
@@ -8,6 +9,7 @@ if TYPE_CHECKING:
     from hydroserverpy.api.models import (
         Role,
         Collaborator,
+        APIKey,
         Account,
         Thing,
         ObservedProperty,
@@ -189,6 +191,79 @@ class Workspace(HydroServerModel, WorkspaceFields):
 
         super()._delete()
 
+    def list_api_keys(self) -> List["APIKey"]:
+        """Get all API keys associated with this workspace."""
+
+        return self._connection.workspaces.list_api_keys(uid=self.uid)
+
+    def get_api_key(self, api_key: Union["APIKey", UUID, str]) -> "APIKey":
+        """Get an API key associated with this workspace."""
+
+        return self._connection.workspaces.get_api_key(
+            uid=self.uid,
+            api_key_id=str(getattr(api_key, "uid", api_key))
+        )
+
+    def create_api_key(
+        self,
+        role: Union["Role", UUID, str],
+        name: str,
+        description: Optional[str] = None,
+        is_active: bool = True,
+        expires_at: Optional[datetime] = None
+    ):
+        """Create an API key associated with this workspace."""
+
+        api_key, key = self._connection.workspaces.create_api_key(
+            uid=self.uid,
+            role=role,
+            name=name,
+            description=description,
+            is_active=is_active,
+            expires_at=expires_at
+        )
+
+        return api_key, key
+
+    def update_api_key(
+            self,
+            api_key_id: Union[UUID, str],
+            role: Union["Role", UUID, str] = ...,
+            name: str = ...,
+            description: Optional[str] = ...,
+            is_active: bool = ...,
+            expires_at: Optional[datetime] = ...
+    ):
+        """Create an API key associated with this workspace."""
+
+        return self._connection.workspaces.update_api_key(
+            uid=self.uid,
+            api_key_id=api_key_id,
+            role=role,
+            name=name,
+            description=description,
+            is_active=is_active,
+            expires_at=expires_at
+        )
+
+    def delete_api_key(self, api_key_id: Union[UUID, str]):
+        """Delete an API key associated with this workspace."""
+
+        return self._connection.workspaces.delete_api_key(
+            uid=self.uid,
+            api_key_id=api_key_id
+        )
+
+    def regenerate_api_key(self, api_key_id: Union[UUID, str]):
+        """Regenerate an API key associated with this workspace."""
+
+        api_key, key = self._connection.workspaces.regenerate_api_key(
+            uid=self.uid,
+            api_key_id=api_key_id
+        )
+
+        return api_key, key
+
     def add_collaborator(
         self, email: EmailStr, role: Union["Role", UUID, str]
     ) -> "Collaborator":

hydroserverpy/api/services/iam/workspace.py

@@ -1,7 +1,8 @@
-from typing import TYPE_CHECKING, Union, List
+from typing import TYPE_CHECKING, Union, List, Tuple, Optional
 from pydantic import EmailStr
 from uuid import UUID
-from hydroserverpy.api.models import Workspace, Role, Collaborator
+from datetime import datetime
+from hydroserverpy.api.models import Workspace, Role, Collaborator, APIKey
 from ..base import EndpointService
 
 
@@ -107,6 +108,114 @@ class WorkspaceService(EndpointService):
         path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/collaborators"
         self._connection.request("delete", path, json={"email": email})
 
+    def list_api_keys(self, uid: Union[UUID, str]) -> List["APIKey"]:
+        """Get all API keys associated with a workspace."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys"
+        response = self._connection.request("get", path)
+
+        return [APIKey(_connection=self._connection, _uid=UUID(str(obj.pop("id"))), **obj) for obj in response.json()]
+
+    def get_api_key(self, uid: Union[UUID, str], api_key_id: Union[UUID, str]) -> "APIKey":
+        """Get an API key associated with a workspace."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys/{api_key_id}"
+        response = self._connection.request("get", path).json()
+
+        return APIKey(_connection=self._connection, _uid=UUID(str(response.pop("id"))), **response)
+
+    def create_api_key(
+        self,
+        uid: Union[UUID, str],
+        role: Union["Role", UUID, str],
+        name: str,
+        description: Optional[str] = None,
+        is_active: bool = True,
+        expires_at: Optional[datetime] = None
+    ) -> Tuple["APIKey", str]:
+        """Create an API key for a workspace."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys"
+        kwargs = {
+            "roleId": str(getattr(role, "uid", role)),
+            "name": name,
+            "description": description,
+            "isActive": is_active,
+            "expiresAt": expires_at
+        }
+        headers = {"Content-type": "application/json"}
+
+        response = self._connection.request(
+            "post", path, headers=headers, json=self._to_iso_time(kwargs)
+        ).json()
+
+        return APIKey(
+            _connection=self._connection, _uid=UUID(str(response.pop("id"))), **response
+        ), response["key"]
+
+    def update_api_key(
+        self,
+        uid: Union[UUID, str],
+        api_key_id: Union[UUID, str],
+        role: Union["Role", UUID, str] = ...,
+        name: str = ...,
+        description: Optional[str] = ...,
+        is_active: bool = ...,
+        expires_at: Optional[datetime] = ...
+    ) -> "APIKey":
+        """Update an existing API key."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys/{str(api_key_id)}"
+        kwargs = {
+            "roleId": ... if role is ... else str(getattr(role, "uid", role)),
+            "name": name,
+            "description": description,
+            "isActive": is_active,
+            "expiresAt": (
+                expires_at.isoformat()
+                if expires_at
+                not in (
+                    None,
+                    ...,
+                )
+                else None
+            )
+        }
+        headers = {"Content-type": "application/json"}
+
+        response = self._connection.request(
+            "patch", path, headers=headers,
+            json={k: v for k, v in kwargs.items() if v is not ...}
+        ).json()
+
+        return APIKey(
+            _connection=self._connection, _uid=UUID(str(response.pop("id"))), **response
+        )
+
+    def delete_api_key(
+        self,
+        uid: Union[UUID, str],
+        api_key_id: Union[UUID, str]
+    ):
+        """Delete an existing API key."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys/{str(api_key_id)}"
+        self._connection.request("delete", path)
+
+    def regenerate_api_key(
+        self,
+        uid: Union[UUID, str],
+        api_key_id: Union[UUID, str]
+    ):
+        """Regenerate an existing API key."""
+
+        path = f"/{self._api_route}/{self._endpoint_route}/{str(uid)}/api-keys/{str(api_key_id)}/regenerate"
+        response = self._connection.request("put", path).json()
+
+        return APIKey(
+            _connection=self._connection, _uid=UUID(str(response.pop("id"))), **response
+        ), response["key"]
+
     def transfer_ownership(self, uid: Union[UUID, str], email: str) -> None:
         """Transfer ownership of a workspace to another HydroServer user."""
 

{hydroserverpy-1.0.0.dist-info → hydroserverpy-1.1.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hydroserverpy
-Version: 1.0.0
+Version: 1.1.0b1
 Requires-Python: <4,>=3.9
 License-File: LICENSE
 Requires-Dist: requests>=2

{hydroserverpy-1.0.0.dist-info → hydroserverpy-1.1.0b1.dist-info}/RECORD

@@ -1,8 +1,8 @@
 hydroserverpy/__init__.py,sha256=FgaGFyhCjwmpJYEKNzOZxvfRx2neWMaOybj1z02_VSE,218
 hydroserverpy/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hydroserverpy/api/http.py,sha256=C5DgvEeiu54RaL-9oouFPSKosC8Uy5Qdwm5hYh2Ps-s,620
-hydroserverpy/api/main.py,sha256=OWJpCIuheBgWQA7R33BiG89-upMS-a3K_AScbVeVjxQ,4760
-hydroserverpy/api/models/__init__.py,sha256=ELrf3b7Aix7YcVF__Q_8e_G_FF8GYlX0J5l7fkGcHnY,690
+hydroserverpy/api/main.py,sha256=r-KD1Xyufzyt4YvRRhZbAngrj5h9yWLXiznx1Yda_8E,4766
+hydroserverpy/api/models/__init__.py,sha256=buOhJ2Bf9yI0GftSyulpR74A5IhyyKJrXY1xANicohw,744
 hydroserverpy/api/models/base.py,sha256=dc2tfMSgizymxAAOVURfy7Jzeh6xIiiq7hfWZI7l1_Q,2280
 hydroserverpy/api/models/etl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hydroserverpy/api/models/etl/data_archive.py,sha256=u-gpvUsaWaw0kyF3bPMm2e55Jx2yhvSV9ufXXaNtrTc,3429
@@ -11,9 +11,10 @@ hydroserverpy/api/models/etl/orchestration_configuration.py,sha256=ElSrgi7ioFZJF
 hydroserverpy/api/models/etl/orchestration_system.py,sha256=25En2G0z1gQzN-RW3UlrEGgkC952QDW21oYnawCX8hY,2357
 hydroserverpy/api/models/iam/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hydroserverpy/api/models/iam/account.py,sha256=7COk_CPYFlthg1uFWTBlJESfnuqMW90TSjZoIcBb-_8,439
+hydroserverpy/api/models/iam/apikey.py,sha256=FLppIWqoBlFYqumecF1cKVm4R2-ZacyKrpObMW1g50s,2465
 hydroserverpy/api/models/iam/collaborator.py,sha256=jp661DKDCwk8c8HFPAV-YVhEc80F5eGDKaSHmH62Q8Q,1007
 hydroserverpy/api/models/iam/role.py,sha256=8FVTj_1QwtPF9tk7baliMVg000kjc5N8oP6eYo8vTDY,275
-hydroserverpy/api/models/iam/workspace.py,sha256=s9u1oZyOdxM7txjJARFcIBrWMHQSDxODdreiatFsXJs,7331
+hydroserverpy/api/models/iam/workspace.py,sha256=rlRL52fAQrCZqmqMnCUNvBIWrlUGoYtQd16zCg-esWU,9630
 hydroserverpy/api/models/sta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hydroserverpy/api/models/sta/datastream.py,sha256=vRjgwAKaoBJEtgUXrZjIS-VuIZsCilm7FRwbvLS8Y8o,11186
 hydroserverpy/api/models/sta/observed_property.py,sha256=ThTg8aPMHPxbk9Hzpxw3AwM16gE1xvYpRK8UkiOdGeA,2180
@@ -29,7 +30,7 @@ hydroserverpy/api/services/etl/data_archive.py,sha256=hlNJOHJSZ1kV2n2xivWIBtT1Eo
 hydroserverpy/api/services/etl/data_source.py,sha256=DCgTyh8lF2iwh4uszePFg9UupXxJCN7Ww9Ut1MQKHis,6491
 hydroserverpy/api/services/etl/orchestration_system.py,sha256=JFuSJJUq4JJUt8KlZ-Ga0ktyQIe2U0Sa7ogd4oLjex4,2166
 hydroserverpy/api/services/iam/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hydroserverpy/api/services/iam/workspace.py,sha256=jJiqkMxFEp9REjR4LXyVp2o45CGBrrEadGelPPCuRJs,4547
+hydroserverpy/api/services/iam/workspace.py,sha256=KQ1zH7EnEcBrpeF-2APAo3aMiiSGCaUgOy_GwRQtyRI,8395
 hydroserverpy/api/services/sta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hydroserverpy/api/services/sta/datastream.py,sha256=_m-xFom3z8wo5-1_q8NjWUpcw36wYv1brIG7xeGGadk,12402
 hydroserverpy/api/services/sta/observed_property.py,sha256=nRlqBldJpXlj8VOZ4EwNOs4ZgmBw5w-EqAChfM3Z0Z0,2908
@@ -58,9 +59,9 @@ hydroserverpy/etl_csv/exceptions.py,sha256=0UY8YUlNepG0y6FfH36hJyR1bOhwYHSZIdUSS
 hydroserverpy/etl_csv/hydroserver_etl_csv.py,sha256=0ueBphEaAAlsb0cn71Ihgd5zOD8Zdu4Ts_yGwvXW53M,14544
 hydroserverpy/quality/__init__.py,sha256=GGBMkFSXciJLYrbV-NraFrj_mXWCy_GTcy9KKrKXU4c,84
 hydroserverpy/quality/service.py,sha256=U02UfLKVmFvr5ySiH0n0JYzUIabq5uprrHIiwcqBlqY,13879
-hydroserverpy-1.0.0.dist-info/licenses/LICENSE,sha256=xVqFxDw3QOEJukakL7gQCqIMTQ1dlSCTo6Oc1otNW80,1508
-hydroserverpy-1.0.0.dist-info/METADATA,sha256=Da0zrvryIMT9-eYhmsNES05Ebu7SwqYQIAs0qIe_19c,530
-hydroserverpy-1.0.0.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-hydroserverpy-1.0.0.dist-info/top_level.txt,sha256=Zf37hrncXLOYvXhgCrf5mZdeq81G9fShdE2LfYbtb7w,14
-hydroserverpy-1.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-hydroserverpy-1.0.0.dist-info/RECORD,,
+hydroserverpy-1.1.0b1.dist-info/licenses/LICENSE,sha256=xVqFxDw3QOEJukakL7gQCqIMTQ1dlSCTo6Oc1otNW80,1508
+hydroserverpy-1.1.0b1.dist-info/METADATA,sha256=SF2m2AtxqgHEz0XO7ozpwAimryavdn5Hap9rdYEdSIA,532
+hydroserverpy-1.1.0b1.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+hydroserverpy-1.1.0b1.dist-info/top_level.txt,sha256=Zf37hrncXLOYvXhgCrf5mZdeq81G9fShdE2LfYbtb7w,14
+hydroserverpy-1.1.0b1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+hydroserverpy-1.1.0b1.dist-info/RECORD,,