neris-api-client 0.0.1__tar.gz → 0.1.0__tar.gz

{neris_api_client-0.0.1 → neris_api_client-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neris_api_client
-Version: 0.0.1
+Version: 0.1.0
 Summary: NERIS API Client
 Author-email: Ben Coleman <ben.coleman@ul.org>
 Project-URL: Homepage, https://github.com/ulfsri/neris
@@ -30,6 +30,9 @@ from neris_api_client import NerisApiClient
 
 client = NerisApiClient(username="neris.user", password="*******", env="dev")
 
-# Get an organization
-org = client.get_org("FD24027240")
+# Get an entity
+entity = client.get_entity("FD24027240")
 ```
+
+API auth tokens are cached locally in `./.token_cache`. If there are auth issues first try instantiating the client with `use_cache=False`
+keyword argument or deleting the token cache.

{neris_api_client-0.0.1 → neris_api_client-0.1.0}/README.md

@@ -11,6 +11,9 @@ from neris_api_client import NerisApiClient
 
 client = NerisApiClient(username="neris.user", password="*******", env="dev")
 
-# Get an organization
-org = client.get_org("FD24027240")
+# Get an entity
+entity = client.get_entity("FD24027240")
 ```
+
+API auth tokens are cached locally in `./.token_cache`. If there are auth issues first try instantiating the client with `use_cache=False`
+keyword argument or deleting the token cache.

{neris_api_client-0.0.1 → neris_api_client-0.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "neris_api_client"
-version = "0.0.1"
+version = "0.1.0"
 authors = [
   { name="Ben Coleman", email="ben.coleman@ul.org" },
 ]

{neris_api_client-0.0.1 → neris_api_client-0.1.0}/src/neris_api_client/client.py

@@ -2,7 +2,7 @@ import jwt
 import json
 from enum import Enum
 from uuid import UUID
-from typing import Optional, Dict, Any, Callable
+from typing import List, Optional, Dict, Any, Callable
 from pathlib import Path
 from datetime import datetime, timedelta
 
@@ -11,6 +11,7 @@ import requests
 from pydantic import BaseModel
 
 from .models import (
+    IncidentPayload,
     CreateDepartmentPayload,
     DepartmentPayload,
     CreateUserPayload,
@@ -24,15 +25,17 @@ class Environment(str, Enum):
     DEV = "dev"
     PROD = "prod"
     LOCAL = "local"
+    TEST = "test"
 
 
 BASE_URLS = {
     Environment.LOCAL: "http://localhost:8000",
     Environment.DEV: "https://api-dev.neris.fsri.org/v1",
     Environment.PROD: "https://api.neris.fsri.org/v1",
+    Environment.TEST: "https://api-test.neris.fsri.org/v1",
 }
 
-COGNTIO_CLIENT_CONFIG_URL = (
+COGNITO_CLIENT_CONFIG_URL = (
     "https://neris-{env}-public.s3.us-east-2.amazonaws.com/cognito_config.json"
 )
 
@@ -40,14 +43,16 @@ COGNTIO_CLIENT_CONFIG_URL = (
 class _NerisApiClient:
     def __init__(
         self,
-        env: Environment = Environment.LOCAL,
         username: str = "",
         password: str = "",
+        env: Environment = Environment.LOCAL,
+        use_cache: bool = True,
     ):
         self._username = username
         self._password = password
         self._base_url = BASE_URLS[env]
         self._env = env
+        self._use_cache = use_cache
 
         self._access_token: str = None
         self._access_token_exp: datetime = None
@@ -60,6 +65,7 @@ class _NerisApiClient:
         # Don't mess with auth on localhost
         if env == Environment.LOCAL:
             # Non-existent auth token never expires
+            self._use_cache = False
             self._access_token_exp = datetime.now() + timedelta(weeks=52)
             return
 
@@ -71,7 +77,8 @@ class _NerisApiClient:
         self._id_token_cache_path = self._token_cache_path / "id_token"
         self._cognito_config_cache_path = self._token_cache_path / "cognito_config.json"
 
-        self._read_token_cache()
+        if self._use_cache:
+            self._read_token_cache()
 
         if self._access_token:
             self._set_token_exp()
@@ -83,7 +90,7 @@ class _NerisApiClient:
         def fetch_cognito_config(self):
             if self._cognito_config is None:
                 self._cognito_config = requests.get(
-                    COGNTIO_CLIENT_CONFIG_URL.format(env=self._env)
+                    COGNITO_CLIENT_CONFIG_URL.format(env=self._env)
                 ).json()
             return f(self)
 
@@ -103,14 +110,15 @@ class _NerisApiClient:
 
         self._set_token_exp()
 
-        self._write_token_cache()
+        if self._use_cache:
+            self._write_token_cache()
 
     @_fetch_cognito_config
     def _refresh_auth(self) -> None:
         res = self._cognito.initiate_auth(
             AuthFlow="REFRESH_TOKEN_AUTH",
             AuthParameters={"REFRESH_TOKEN": self._refresh_token},
-            ClientId=self._cogntio_config["client_id"],
+            ClientId=self._cognito_config["client_id"],
         )
 
         self._access_token = res["AuthenticationResult"]["AccessToken"]
@@ -156,6 +164,7 @@ class _NerisApiClient:
         method: str,
         path: str,
         data: Optional[str | Dict[str, Any]] = None,
+        params: Optional[Dict[str, Any]] = None,
         model: Optional[BaseModel] = None,
     ):
         if self._access_token_exp - datetime.now() <= timedelta(seconds=0):
@@ -171,11 +180,15 @@ class _NerisApiClient:
 
         if model:
             if isinstance(data, str):
-                data = model.model_validate_json(data).model_dump(mode="json")
+                data = model.model_validate_json(data).model_dump(
+                    mode="json", by_alias=True
+                )
             if isinstance(data, dict):
-                data = model.model_validate(data).model_dump(mode="json")
+                data = model.model_validate(data).model_dump(mode="json", by_alias=True)
 
-        res = getattr(self._session, method)(f"{self._base_url}{path}", json=data)
+        res = getattr(self._session, method)(
+            f"{self._base_url}{path}", json=data, params=params
+        )
 
         try:
             res.raise_for_status()
@@ -194,14 +207,16 @@ class NerisApiClient(_NerisApiClient):
     def health(self):
         return self._call("get", "/health")
 
-    def get_org(self, neris_id: str) -> Dict[str, Any]:
-        return self._call("get", f"/org/{neris_id}")
+    def get_entity(self, neris_id: str) -> Dict[str, Any]:
+        return self._call("get", f"/entity/{neris_id}")
 
-    def create_org(self, body: str | Dict[str, Any]) -> Dict[str, Any]:
-        return self._call("post", "/org/", body, model=CreateDepartmentPayload)
+    def create_entity(self, body: str | Dict[str, Any]) -> Dict[str, Any]:
+        return self._call("post", "/entity/", body, model=CreateDepartmentPayload)
 
-    def update_org(self, neris_id: str, body: str | Dict[str, Any]) -> Dict[str, Any]:
-        return self._call("put", f"/org/{neris_id}", body, model=DepartmentPayload)
+    def update_entity(
+        self, neris_id: str, body: str | Dict[str, Any]
+    ) -> Dict[str, Any]:
+        return self._call("put", f"/entity/{neris_id}", body, model=DepartmentPayload)
 
     def get_user(self, sub: str | UUID) -> Dict[str, Any]:
         return self._call("get", f"/user/{sub}")
@@ -213,3 +228,31 @@ class NerisApiClient(_NerisApiClient):
         self, sub: str | UUID, body: str | Dict[str, Any]
     ) -> Dict[str, Any]:
         return self._call("put", f"/user/{sub}", body, model=UpdateUserPayload)
+
+    def delete_user(self, sub: str | UUID) -> None:
+        self._call("delete", f"/user/{sub}")
+
+    def create_user_entity_membership(self, sub: str | UUID, neris_id: str) -> None:
+        self._call("post", f"/user/{sub}/user_entity_membership/{neris_id}")
+
+    def delete_user_entity_membership(self, sub: str | UUID, neris_id: str) -> None:
+        self._call("delete", f"/user/{sub}/user_entity_membership/{neris_id}")
+
+    def update_user_entity_activation(
+        self, sub: str | UUID, neris_id: str, active: bool
+    ) -> None:
+        self._call(
+            "put",
+            f"/user/{sub}/user_entity_activation/{neris_id}",
+            data={"active": active},
+        )
+
+    def list_user_entity_memberships(self, sub: str | UUID) -> List[Dict[str, Any]]:
+        return self._call("get", f"/user/{sub}/user_entity_membership")
+
+    def create_incident(
+        self, neris_id: str, body: str | Dict[str, Any]
+    ) -> Dict[str, Any]:
+        return self._call(
+            "post", f"/incident/{neris_id}", data=body, model=IncidentPayload
+        )