itk-dev-shared-components 2.1.0__tar.gz → 2.2.0__tar.gz

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: itk_dev_shared_components
-Version: 2.1.0
+Version: 2.2.0
 Summary: Shared components to use in RPA projects
 Author-email: ITK Development <itk-rpa@mkb.aarhus.dk>
 Project-URL: Homepage, https://github.com/itk-dev-rpa/itk-dev-shared-components

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/itk_dev_shared_components/kmd_nova/nova_documents.py

@@ -10,7 +10,7 @@ import urllib.parse
 import requests
 
 from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
-from itk_dev_shared_components.kmd_nova.nova_objects import Document
+from itk_dev_shared_components.kmd_nova.nova_objects import Document, Caseworker
 from itk_dev_shared_components.kmd_nova. util import datetime_from_iso_string
 
 
@@ -44,7 +44,8 @@ def get_documents(case_uuid: str, nova_access: NovaAccess) -> list[Document]:
             "approved": True,
             "documentDate": True,
             "fileExtension": True,
-            "documentCategory": True
+            "documentCategory": True,
+            "caseworker": True
         }
     }
 
@@ -55,6 +56,16 @@ def get_documents(case_uuid: str, nova_access: NovaAccess) -> list[Document]:
 
     documents = []
     for document_dict in response.json()['documents']:
+
+        if 'caseworker' in document_dict:
+            caseworker = Caseworker(
+                uuid = document_dict['caseworker']['kspIdentity']['novaUserId'],
+                name = document_dict['caseworker']['kspIdentity']['fullName'],
+                ident = document_dict['caseworker']['kspIdentity']['racfId']
+            )
+        else:
+            caseworker = None
+
         doc = Document(
             uuid = document_dict['documentUuid'],
             document_number = document_dict['documentNumber'],
@@ -66,7 +77,8 @@ def get_documents(case_uuid: str, nova_access: NovaAccess) -> list[Document]:
             document_date = datetime_from_iso_string(document_dict['documentDate']),
             file_extension = document_dict['fileExtension'],
             category_name = document_dict.get('documentCategoryName'),
-            category_uuid = document_dict.get('documentCategoryUuid')
+            category_uuid = document_dict.get('documentCategoryUuid'),
+            caseworker=caseworker
         )
         documents.append(doc)
 
@@ -184,6 +196,14 @@ def attach_document_to_case(case_uuid: str, document: Document, nova_access: Nov
         "accessToDocuments": True
     }
 
+    if document.caseworker:
+        payload['caseworker'] = {
+            "kspIdentity": {
+                "racfId": document.caseworker.ident,
+                "fullName": document.caseworker.name
+            }
+        }
+
     headers = {'Content-Type': 'application/json', 'Authorization': f"Bearer {nova_access.get_bearer_token()}"}
     response = requests.post(url, params=params, headers=headers, json=payload, timeout=60)
     response.raise_for_status()

itk_dev_shared_components-2.2.0/itk_dev_shared_components/kmd_nova/nova_notes.py

@@ -0,0 +1,141 @@
+"""This module has functions to do with journal note related calls to the KMD Nova api."""
+
+import base64
+import uuid
+import urllib.parse
+from datetime import datetime
+
+import requests
+
+from itk_dev_shared_components.kmd_nova.authentication import NovaAccess
+from itk_dev_shared_components.kmd_nova.nova_objects import JournalNote
+
+
+def add_text_note(case_uuid: str, note_title: str, note_text: str, approved: bool, nova_access: NovaAccess) -> str:
+    """Add a text based journal note to a Nova case.
+
+    Args:
+        case_uuid: The uuid of the case to add the journal note to.
+        note_title: The title of the note.
+        note_text: The text content of the note.
+        approved: Whether the journal note should be marked as approved in Nova.
+        nova_access: The NovaAccess object used to authenticate.
+
+    Returns:
+        The uuid of the created journal note.
+    """
+    note_uuid = str(uuid.uuid4())
+
+    url = urllib.parse.urljoin(nova_access.domain, "api/Case/Update")
+    params = {"api-version": "1.0-Case"}
+
+    payload = {
+        "common": {
+            "transactionId": str(uuid.uuid4()),
+            "uuid": case_uuid
+        },
+        "journalNotes": [
+            {
+                "uuid": note_uuid,
+                "approved": approved,
+                "journalNoteAttributes": {
+                    "journalNoteDate": datetime.today().isoformat(),
+                    "title": note_title,
+                    "journalNoteType": "Bruger",
+                    "format": "Text",
+                    "note": _encode_text(note_text)
+                }
+            }
+        ]
+    }
+
+    headers = {'Content-Type': 'application/json', 'Authorization': f"Bearer {nova_access.get_bearer_token()}"}
+
+    response = requests.patch(url, params=params, headers=headers, json=payload, timeout=60)
+    response.raise_for_status()
+
+    return note_uuid
+
+
+def _encode_text(string: str) -> str:
+    """Encode a string to a base64 string.
+    Ensure the base64 string doesn't contain padding by inserting spaces at the end of the input string.
+    There is a bug in the Nova api that corrupts the string if it contains padding.
+    The extra spaces will not show up in the Nova user interface.
+
+    Args:
+        string: The string to encode.
+
+    Returns:
+        A base64 string containing no padding.
+    """
+    def b64(s: str) -> str:
+        """Helper function to convert a string to base64."""
+        return base64.b64encode(s.encode()).decode()
+
+    while (s := b64(string)).endswith("="):
+        string += ' '
+
+    return s
+
+
+def get_notes(case_uuid: str, nova_access: NovaAccess, offset: int = 0, limit: int = 100) -> tuple[JournalNote, ...]:
+    """Get all journal notes from the given case.
+
+    Args:
+        case_uuid: The uuid of the case to get notes from.
+        nova_access: The NovaAccess object used to authenticate.
+        offset: The number of journal notes to skip.
+        limit: The maximum number of journal notes to get (1-500).
+
+    Returns:
+        A tuple of JournalNote objects.
+    """
+    url = urllib.parse.urljoin(nova_access.domain, "api/Case/GetList")
+    params = {"api-version": "1.0-Case"}
+
+    payload = {
+        "common": {
+            "transactionId": str(uuid.uuid4()),
+            "uuid": case_uuid
+        },
+        "paging": {
+            "startRow": offset+1,
+            "numberOfRows": limit
+        },
+        "caseGetOutput": {
+            "journalNotes": {
+                "uuid": True,
+                "approved": True,
+                "journalNoteAttributes": {
+                    "title": True,
+                    "format": True,
+                    "note": True,
+                    "createdTime": True
+                }
+            }
+        }
+    }
+
+    headers = {'Content-Type': 'application/json', 'Authorization': f"Bearer {nova_access.get_bearer_token()}"}
+
+    response = requests.put(url, params=params, headers=headers, json=payload, timeout=60)
+    response.raise_for_status()
+
+    note_dicts = response.json()['cases'][0]['journalNotes']['journalNotes']
+
+    notes_list = []
+
+    for note_dict in note_dicts:
+        notes_list.append(
+            JournalNote(
+                uuid=note_dict['uuid'],
+                title=note_dict['journalNoteAttributes']['title'],
+                approved=note_dict['approved'],
+                journal_date=note_dict['journalNoteAttributes']['createdTime'],
+                note=note_dict['journalNoteAttributes']['note'],
+                note_format=note_dict['journalNoteAttributes']['format']
+            )
+        )
+
+    return tuple(notes_list)

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/itk_dev_shared_components/kmd_nova/nova_objects.py

@@ -48,6 +48,7 @@ class Document:
     file_extension: Optional[str] = None
     category_name: Optional[str] = None
     category_uuid: Optional[str] = None
+    caseworker: Optional[Caseworker] = None
 
 
 @dataclass(slots=True, kw_only=True)

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/itk_dev_shared_components.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: itk_dev_shared_components
-Version: 2.1.0
+Version: 2.2.0
 Summary: Shared components to use in RPA projects
 Author-email: ITK Development <itk-rpa@mkb.aarhus.dk>
 Project-URL: Homepage, https://github.com/itk-dev-rpa/itk-dev-shared-components

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/itk_dev_shared_components.egg-info/SOURCES.txt

@@ -15,6 +15,7 @@ itk_dev_shared_components/kmd_nova/authentication.py
 itk_dev_shared_components/kmd_nova/cpr.py
 itk_dev_shared_components/kmd_nova/nova_cases.py
 itk_dev_shared_components/kmd_nova/nova_documents.py
+itk_dev_shared_components/kmd_nova/nova_notes.py
 itk_dev_shared_components/kmd_nova/nova_objects.py
 itk_dev_shared_components/kmd_nova/nova_tasks.py
 itk_dev_shared_components/kmd_nova/util.py

{itk_dev_shared_components-2.1.0 → itk_dev_shared_components-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "itk_dev_shared_components"
-version = "2.1.0"
+version = "2.2.0"
 authors = [
   { name="ITK Development", email="itk-rpa@mkb.aarhus.dk" },
 ]