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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: itk_dev_shared_components
-Version: 2.2.0
+Version: 2.3.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.3.0/itk_dev_shared_components/graph/common.py

@@ -0,0 +1,54 @@
+"""This module contains common functions like HTTP request wrappers which are used across other modules."""
+
+from typing import Any
+
+import requests
+
+from itk_dev_shared_components.graph.authentication import GraphAccess
+
+
+def get_request(endpoint: str, graph_access: GraphAccess) -> requests.models.Response:
+    """Sends a get request to the given Graph endpoint using the GraphAccess
+    and returns the json object of the response.
+
+    Args:
+        endpoint: The URL of the Graph endpoint.
+        graph_access: The GraphAccess object used to authenticate.
+
+    Returns:
+        Response: The response object of the GET request.
+
+    Raises:
+        HTTPError: Any errors raised while performing GET request.
+    """
+    token = graph_access.get_access_token()
+    headers = {"Authorization": f"Bearer {token}"}
+
+    response = requests.get(endpoint, headers=headers, timeout=30)
+    response.raise_for_status()
+
+    return response
+
+
+def put_request(endpoint: str, graph_access: GraphAccess, data: Any) -> requests.models.Response:
+    """Sends a put request to the given Graph endpoint using the GraphAccess
+    and returns the json object of the response.
+
+    Args:
+        endpoint: The URL of the Graph endpoint.
+        data: The data to send in the request.
+        graph_access: The GraphAccess object used to authenticate.
+
+    Returns:
+        Response: The response object of the PUT request.
+
+    Raises:
+        HTTPError: Any errors raised while performing PUT request.
+    """
+    token = graph_access.get_access_token()
+    headers = {"Authorization": f"Bearer {token}"}
+
+    response = requests.put(endpoint, headers=headers, data=data, timeout=30)
+    response.raise_for_status()
+
+    return response

itk_dev_shared_components-2.3.0/itk_dev_shared_components/graph/file.py

@@ -0,0 +1,54 @@
+"""This module is responsible for accessing files using the Microsoft Graph API."""
+
+from dataclasses import dataclass, field
+
+from itk_dev_shared_components.graph.authentication import GraphAccess
+from itk_dev_shared_components.graph.common import get_request
+
+
+@dataclass
+class DriveItem:
+    """A class representing a DriveItem."""
+
+    id: str = field(repr=False)
+    name: str
+    web_url: str
+    last_modified: str
+
+
+def get_drive_item(graph_access: GraphAccess, site_id: str, drive_item_path: str) -> str:
+    """Given a site id and a drive_item_path, gets the corresponding DriveItem
+
+    You need to authorize against Graph to get the GraphAccess before using this function
+    see the graph.authentication module.
+
+    See https://learn.microsoft.com/en-us/graph/api/driveitem-get for further documentation
+
+    Args:
+        graph_access: The GraphAccess object used to authenticate.
+        site_id: The id of the site in SharePoint.
+        drive_item_path: The path to the DriveItem in SharePoint.
+    """
+    endpoint = f"https://graph.microsoft.com/v1.0/sites/{site_id}/drive/root:/{drive_item_path}"
+    response = get_request(endpoint, graph_access)
+    raw_response = response.json()
+
+    return _unpack_drive_item_response(raw_response)
+
+
+def _unpack_drive_item_response(drive_item_raw: dict[str, str]) -> DriveItem:
+    """Unpack a json HTTP response and create a DriveItem object.
+
+    Args:
+        drive_item_raw: The json dictionary created by response.json().
+
+    Returns:
+        DriveItem: A DriveItem object.
+    """
+
+    return DriveItem(
+        id=drive_item_raw["id"],
+        name=drive_item_raw["name"],
+        web_url=drive_item_raw["webUrl"],
+        last_modified=drive_item_raw["lastModifiedDateTime"],
+    )

{itk_dev_shared_components-2.2.0 → itk_dev_shared_components-2.3.0}/itk_dev_shared_components/graph/mail.py

@@ -7,6 +7,7 @@ import requests
 from bs4 import BeautifulSoup
 
 from itk_dev_shared_components.graph.authentication import GraphAccess
+from itk_dev_shared_components.graph.common import get_request
 
 
 @dataclass
@@ -67,7 +68,7 @@ def get_emails_from_folder(user: str, folder_path: str, graph_access: GraphAcces
 
     endpoint = f"https://graph.microsoft.com/v1.0/users/{user}/mailFolders/{folder_id}/messages?$top=1000"
 
-    response = _get_request(endpoint, graph_access)
+    response = get_request(endpoint, graph_access)
     emails_raw = response.json()['value']
 
     return _unpack_email_response(user, emails_raw)
@@ -84,7 +85,7 @@ def get_email_as_mime(email: Email, graph_access: GraphAccess) -> io.BytesIO:
         io.BytesIO: A file-like object of the MIME file.
     """
     endpoint = f"https://graph.microsoft.com/v1.0/users/{email.user}/messages/{email.id}/$value"
-    response = _get_request(endpoint, graph_access)
+    response = get_request(endpoint, graph_access)
     data = response.content
     return io.BytesIO(data)
 
@@ -113,7 +114,7 @@ def get_folder_id_from_path(user: str, folder_path: str, graph_access: GraphAcce
 
     # Get main folder
     endpoint = f"https://graph.microsoft.com/v1.0/users/{user}/mailFolders"
-    response = _get_request(endpoint, graph_access).json()
+    response = get_request(endpoint, graph_access).json()
     folder_id = _find_folder(response, main_folder)
     if folder_id is None:
         raise ValueError(f"Top level folder '{main_folder}' was not found for user '{user}'.")
@@ -121,7 +122,7 @@ def get_folder_id_from_path(user: str, folder_path: str, graph_access: GraphAcce
     # Get child folders
     for child_folder in child_folders:
         endpoint = f"https://graph.microsoft.com/v1.0/users/{user}/mailFolders/{folder_id}/childFolders"
-        response = _get_request(endpoint, graph_access).json()
+        response = get_request(endpoint, graph_access).json()
         folder_id = _find_folder(response, child_folder)
         if folder_id is None:
             raise ValueError(f"Child folder '{child_folder}' not found under '{main_folder}' for user '{user}'.")
@@ -141,7 +142,7 @@ def list_email_attachments(email: Email, graph_access: GraphAccess) -> tuple[Att
         tuple[Attachment]: A tuple of Attachment objects describing the attachments.
     """
     endpoint = f"https://graph.microsoft.com/v1.0/users/{email.user}/messages/{email.id}/attachments?$select=name,size,id"
-    response = _get_request(endpoint, graph_access).json()
+    response = get_request(endpoint, graph_access).json()
 
     attachments = []
     for att in response['value']:
@@ -162,7 +163,7 @@ def get_attachment_data(attachment: Attachment, graph_access: GraphAccess) -> io
     """
     email = attachment.email
     endpoint = f"https://graph.microsoft.com/v1.0/users/{email.user}/messages/{email.id}/attachments/{attachment.id}/$value"
-    response = _get_request(endpoint, graph_access)
+    response = get_request(endpoint, graph_access)
     data_bytes = response.content
     return io.BytesIO(data_bytes)
 
@@ -287,31 +288,3 @@ def _unpack_email_response(user: str, emails_raw: list[dict[str, str]]) -> tuple
         )
 
     return tuple(emails)
-
-
-def _get_request(endpoint: str, graph_access: GraphAccess) -> requests.models.Response:
-    """Sends a get request to the given Graph endpoint using the GraphAccess
-    and returns the json object of the response.
-
-    Args:
-        endpoint: The URL of the Graph endpoint.
-        graph_access: The GraphAccess object used to authenticate.
-        timeout: Timeout in seconds of the HTTP request. Defaults to 10.
-
-    Returns:
-        Response: The response object of the GET request.
-
-    Raises:
-        HTTPError: Any errors raised while performing GET request.
-    """
-    token = graph_access.get_access_token()
-    headers = {'Authorization': f"Bearer {token}"}
-
-    response = requests.get(
-        endpoint,
-        headers=headers,
-        timeout=30
-    )
-    response.raise_for_status()
-
-    return response

itk_dev_shared_components-2.3.0/itk_dev_shared_components/graph/site.py

@@ -0,0 +1,104 @@
+"""This module is responsible for accessing sites using the Microsoft Graph API."""
+
+from dataclasses import dataclass, field
+
+from itk_dev_shared_components.graph.authentication import GraphAccess
+from itk_dev_shared_components.graph.common import get_request, put_request
+
+
+@dataclass
+class Site:
+    """A class representing a Site."""
+
+    id: str = field(repr=False)
+    name: str
+    display_name: str
+    description: str
+    web_url: str
+    created: str
+    last_modified: str
+
+
+def get_site(graph_access: GraphAccess, site_path: str) -> Site:
+    """Retrieve properties and relationships for a site resource.
+    A site resource represents a team site in SharePoint.
+
+    You need to authorize against Graph to get the GraphAccess before using this function
+    see the graph.authentication module.
+
+    See https://learn.microsoft.com/en-us/graph/api/site-get?view=graph-rest-1.0
+    for a list of possible site_paths to pass as argument.
+
+    Args:
+        graph_access: The GraphAccess object used to authenticate.
+        site_path: The path to the team site in SharePoint.
+
+    returns:
+        A Site object
+    """
+    endpoint = f"https://graph.microsoft.com/v1.0/sites/{site_path}"
+    response = get_request(endpoint, graph_access)
+
+    return _unpack_site_response(response.json())
+
+
+def download_file_contents(graph_access: GraphAccess, site_id: str, drive_item_id: str) -> bytes:
+    """Given a site_id, a drive_item_id, and a download destination, downloads a single file from a site resource
+
+    You need to authorize against Graph to get the GraphAccess before using this function
+    see the graph.authentication module.
+
+    See https://learn.microsoft.com/en-us/graph/api/driveitem-get-content for further documentation
+
+    Args:
+        graph_access: The GraphAccess object used to authenticate.
+        site_id: The id of the site in SharePoint.
+        drive_item_id: The id of the DriveItem in SharePoint.
+
+    returns:
+        bytes containing the contents of the file
+    """
+    endpoint = f"https://graph.microsoft.com/v1.0/sites/{site_id}/drive/items/{drive_item_id}/content"
+    response = get_request(endpoint, graph_access)
+    return response.content
+
+
+def upload_file_contents(graph_access: GraphAccess, site_id: str, drive_item_path: str, file_contents: bytes):
+    """Given a site_id, a drive_item_path, and file_contents as bytes, uploads a single file to a site
+
+    You need to authorize against Graph to get the GraphAccess before using this function
+    see the graph.authentication module.
+
+    See https://learn.microsoft.com/en-us/graph/api/driveitem-put-content for further documentation
+
+    Args:
+        graph_access: The GraphAccess object used to authenticate.
+        site_id: The id of the site in SharePoint.
+        drive_item_path: The path to upload the file contents to.
+        file_contents: A bytes object containing the file's contents.
+
+    """
+
+    endpoint = f"https://graph.microsoft.com/v1.0/sites/{site_id}/drive/root:/{drive_item_path}:/content"
+    put_request(endpoint, graph_access, file_contents)
+
+
+def _unpack_site_response(site_raw: dict[str, str]) -> Site:
+    """Unpack a json HTTP response and create a Site object.
+
+    Args:
+        site_raw: The json dictionary created by response.json().
+
+    Returns:
+        Site: A Site object.
+    """
+
+    return Site(
+        id=site_raw["id"],
+        name=site_raw["name"],
+        display_name=site_raw["displayName"],
+        description=site_raw["description"],
+        web_url=site_raw["webUrl"],
+        created=site_raw["createdDateTime"],
+        last_modified=site_raw["lastModifiedDateTime"],
+    )

{itk_dev_shared_components-2.2.0 → itk_dev_shared_components-2.3.0}/itk_dev_shared_components/kmd_nova/nova_cases.py

@@ -28,16 +28,93 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
 
     Raises:
         ValueError: If no search terms are given.
-        requests.exceptions.HTTPError: If the request failed.
     """
 
     if not any((cpr, case_number, case_title)):
         raise ValueError("No search terms given.")
 
+    payload = _create_payload(cpr, "CprNummer", case_number, case_title, limit)
+    return _get_nova_cases(nova_access, payload)
+
+
+def get_cvr_cases(nova_access: NovaAccess, cvr: str = None,  case_number: str = None, case_title: str = None, limit: int = 100) -> list[NovaCase]:
+    """Search for cases on different search terms.
+    Currently supports search on cvr number, case number and case title. At least one search term must be given.
+
+    Args:
+        nova_access: The NovaAccess object used to authenticate.
+        cvr: The cvr number to search on. E.g. "01234567"
+        case_number: The case number to search on. E.g. "S2022-12345"
+        case_title: The case title to search on.
+        limit: The maximum number of cases to find (1-500).
+
+    Returns:
+        A list of NovaCase objects.
+
+    Raises:
+        ValueError: If no search terms are given.
+    """
+
+    if not any((cvr, case_number, case_title)):
+        raise ValueError("No search terms given.")
+
+    payload = _create_payload(cvr, "CvrNummer", case_number, case_title, limit)
+    return _get_nova_cases(nova_access, payload)
+
+
+def _get_nova_cases(nova_access: NovaAccess, payload: dict) -> list[NovaCase]:
+    """Search for cases with a payload of search terms.
+
+    Args:
+        nova_access: The NovaAccess object used to authenticate.
+        payload: A dictionary containing case identifier, identifier type, case number case title and limit
+
+    Returns:
+        A list of NovaCase objects.
+
+    Raises:
+        requests.exceptions.HTTPError: If the request failed.
+    """
     url = urllib.parse.urljoin(nova_access.domain, "api/Case/GetList")
     params = {"api-version": "1.0-Case"}
 
-    payload = {
+    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()
+
+    if response.json()['pagingInformation']['numberOfRows'] == 0:
+        return []
+
+    # Convert json to NovaCase objects
+    cases = []
+    for case_dict in response.json()['cases']:
+        security_unit, responsible_department = _extract_departments(case_dict)
+        case = NovaCase(
+            uuid = case_dict['common']['uuid'],
+            title = case_dict['caseAttributes']['title'],
+            case_date = datetime_from_iso_string(case_dict['caseAttributes']['caseDate']),
+            case_number = case_dict['caseAttributes']['userFriendlyCaseNumber'],
+            active_code = case_dict['state']['activeCode'],
+            progress_state = case_dict['state']['progressState'],
+            case_parties = _extract_case_parties(case_dict),
+            document_count = case_dict['numberOfDocuments'],
+            note_count = case_dict['numberOfJournalNotes'],
+            kle_number = case_dict['caseClassification']['kleNumber']['code'],
+            proceeding_facet = case_dict['caseClassification']['proceedingFacet']['code'],
+            sensitivity = case_dict["sensitivity"]["sensitivity"],
+            caseworker = _extract_case_worker(case_dict),
+            security_unit=security_unit,
+            responsible_department=responsible_department
+        )
+
+        cases.append(case)
+
+    return cases
+
+
+def _create_payload(identification: str = None, identification_type: str = "CprNummer", case_number: str = None, case_title: str = None, limit: int = 100) -> dict:
+    return {
         "common": {
             "transactionId": str(uuid.uuid4())
         },
@@ -50,8 +127,8 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
             "title": case_title
         },
         "caseParty": {
-            "identificationType": "CprNummer",
-            "identification": cpr
+            "identificationType": identification_type,
+            "identification": identification
         },
         "caseGetOutput": {
             "numberOfSecondaryParties": True,
@@ -110,40 +187,6 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
         }
     }
 
-    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()
-
-    if response.json()['pagingInformation']['numberOfRows'] == 0:
-        return []
-
-    # Convert json to NovaCase objects
-    cases = []
-    for case_dict in response.json()['cases']:
-        security_unit, responsible_department = _extract_departments(case_dict)
-        case = NovaCase(
-            uuid = case_dict['common']['uuid'],
-            title = case_dict['caseAttributes']['title'],
-            case_date = datetime_from_iso_string(case_dict['caseAttributes']['caseDate']),
-            case_number = case_dict['caseAttributes']['userFriendlyCaseNumber'],
-            active_code = case_dict['state']['activeCode'],
-            progress_state = case_dict['state']['progressState'],
-            case_parties = _extract_case_parties(case_dict),
-            document_count = case_dict['numberOfDocuments'],
-            note_count = case_dict['numberOfJournalNotes'],
-            kle_number = case_dict['caseClassification']['kleNumber']['code'],
-            proceeding_facet = case_dict['caseClassification']['proceedingFacet']['code'],
-            sensitivity = case_dict["sensitivity"]["sensitivity"],
-            caseworker = _extract_case_worker(case_dict),
-            security_unit=security_unit,
-            responsible_department=responsible_department
-        )
-
-        cases.append(case)
-
-    return cases
-
 
 def _extract_departments(case_dict: dict) -> tuple[Department, Department]:
     """Extract the departments from a HTTP request response.
@@ -171,6 +214,7 @@ def _extract_departments(case_dict: dict) -> tuple[Department, Department]:
 
 def _extract_case_worker(case_dict: dict) -> Caseworker | None:
     """Extract the case worker from a HTTP request response.
+    If the case worker is in a unexpected format, None is returned.
 
     Args:
         case_dict: The dictionary describing the case.
@@ -179,11 +223,14 @@ def _extract_case_worker(case_dict: dict) -> Caseworker | None:
         A case worker object describing the case worker if any.
     """
     if 'caseworker' in case_dict:
-        return Caseworker(
-            uuid = case_dict['caseworker']['kspIdentity']['novaUserId'],
-            name = case_dict['caseworker']['kspIdentity']['fullName'],
-            ident = case_dict['caseworker']['kspIdentity']['racfId']
-        )
+        try:
+            return Caseworker(
+                uuid = case_dict['caseworker']['kspIdentity']['novaUserId'],
+                name = case_dict['caseworker']['kspIdentity']['fullName'],
+                ident = case_dict['caseworker']['kspIdentity']['racfId']
+            )
+        except KeyError:
+            return None
 
     return None
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: itk_dev_shared_components
-Version: 2.2.0
+Version: 2.3.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.2.0 → itk_dev_shared_components-2.3.0}/itk_dev_shared_components.egg-info/SOURCES.txt

@@ -9,7 +9,10 @@ itk_dev_shared_components.egg-info/requires.txt
 itk_dev_shared_components.egg-info/top_level.txt
 itk_dev_shared_components/graph/__init__.py
 itk_dev_shared_components/graph/authentication.py
+itk_dev_shared_components/graph/common.py
+itk_dev_shared_components/graph/file.py
 itk_dev_shared_components/graph/mail.py
+itk_dev_shared_components/graph/site.py
 itk_dev_shared_components/kmd_nova/__init__.py
 itk_dev_shared_components/kmd_nova/authentication.py
 itk_dev_shared_components/kmd_nova/cpr.py

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

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