Merge pull request #90 from itk-dev-rpa/release/2.8.0

Release/2.8.0

Author: ghbm-itk

changelog.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.8.0] - 2024-10-02
+
+### Added
+
+- misc.cpr_util: Function to get birth date from cpr number.
+- kmd_nova.nova_cases: Function to get a case on its uuid.
+
 ## [2.7.1] - 2024-09-24
 
 ### Fixed
@@ -174,7 +181,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release
 
-[Unreleased]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/2.7.1...HEAD
+[Unreleased]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/compare/2.8.0...HEAD
+[2.8.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.8.0
 [2.7.1]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.7.1
 [2.7.0]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.7.0
 [2.6.1]: https://github.com/itk-dev-rpa/ITK-dev-shared-components/releases/tag/2.6.1

itk_dev_shared_components/kmd_nova/nova_cases.py

@@ -12,6 +12,28 @@
 from itk_dev_shared_components.kmd_nova.util import datetime_from_iso_string
 
 
+def get_case(case_uuid: str, nova_access: NovaAccess) -> NovaCase:
+    """Get a case from based on its uuid.
+
+    Args:
+        case_uuid: The uuid of the case to get.
+        nova_access: The NovaAccess object used to authenticate.
+
+    Raises:
+        ValueError: If no case was found.
+
+    Returns:
+        The case with the given uuid.
+    """
+    payload = _create_payload(case_uuid=case_uuid)
+    cases = _get_nova_cases(nova_access, payload)
+
+    if not cases:
+        raise ValueError(f"No case found with the given uuid: {case_uuid}")
+
+    return cases[0]
+
+
 def get_cases(nova_access: NovaAccess, cpr: 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 cpr number, case number and case title. At least one search term must be given.
@@ -33,7 +55,7 @@ def get_cases(nova_access: NovaAccess, cpr: str = None, case_number: str = None,
     if not any((cpr, case_number, case_title)):
         raise ValueError("No search terms given.")
 
-    payload = _create_payload(cpr, "CprNummer", case_number, case_title, limit)
+    payload = _create_payload(identification=cpr, identification_type="CprNummer", case_number=case_number, case_title=case_title, limit=limit)
     return _get_nova_cases(nova_access, payload)
 
 
@@ -58,7 +80,7 @@ def get_cvr_cases(nova_access: NovaAccess, cvr: str = None,  case_number: str =
     if not any((cvr, case_number, case_title)):
         raise ValueError("No search terms given.")
 
-    payload = _create_payload(cvr, "CvrNummer", case_number, case_title, limit)
+    payload = _create_payload(identification=cvr, identification_type="CvrNummer", case_number=case_number, case_title=case_title, limit=limit)
     return _get_nova_cases(nova_access, payload)
 
 
@@ -113,10 +135,11 @@ def _get_nova_cases(nova_access: NovaAccess, payload: dict) -> list[NovaCase]:
     return cases
 
 
-def _create_payload(identification: str = None, identification_type: str = "CprNummer", case_number: str = None, case_title: str = None, limit: int = 100) -> dict:
+def _create_payload(*, case_uuid: str = None, 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())
+            "transactionId": str(uuid.uuid4()),
+            "uuid": case_uuid
         },
         "paging": {
             "startRow": 1,

itk_dev_shared_components/misc/cpr_util.py

@@ -3,16 +3,15 @@
 from datetime import date
 
 
-def get_age(cpr: str, current_date: date = date.today()) -> int:
-    """Get the age of a person based on their cpr number
+def get_birth_date(cpr: str) -> date:
+    """Get the birth date of a person based on their cpr number
     using the 7th digit to infer the century.
 
     Args:
         cpr: The cpr number in the format 'ddmmyyxxxx'.
-        current_date: The date where the age is calculated from. Defaults to the current date.
 
     Returns:
-        The age in integer years based on the cpr number.
+        The birth date based on cpr number.
 
     Raises:
         ValueError: If the given cpr is not in 'ddmmyyxxxx' format.
@@ -51,7 +50,24 @@ def get_age(cpr: str, current_date: date = date.today()) -> int:
     else:
         year += t[2]
 
-    birthdate = date(year, month, day)
+    return date(year, month, day)
+
+
+def get_age(cpr: str, current_date: date = date.today()) -> int:
+    """Get the age of a person based on their cpr number
+    using the 7th digit to infer the century.
+
+    Args:
+        cpr: The cpr number in the format 'ddmmyyxxxx'.
+        current_date: The date where the age is calculated from. Defaults to the current date.
+
+    Returns:
+        The age in integer years based on the cpr number.
+
+    Raises:
+        ValueError: If the given cpr is not in 'ddmmyyxxxx' format.
+    """
+    birthdate = get_birth_date(cpr)
 
     age = current_date.year - birthdate.year - ((current_date.month, current_date.day) < (birthdate.month, birthdate.day))
 

pyproject.toml

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

tests/test_misc/test_cpr_util.py

@@ -43,6 +43,38 @@ def test_get_age_from_cpr(self):
         with self.assertRaises(ValueError):
             cpr_util.get_age("010190xxxx")
 
+    def test_get_birth_date_from_cpr(self):
+        """Test getting the age from a cpr number."""
+        # A table of fictional cpr-numbers and the expected birth dates.
+        test_data = (
+            ("0101920000", date(1992, 1, 1)),
+            ("0101921000", date(1992, 1, 1)),
+            ("0101922000", date(1992, 1, 1)),
+            ("0101923000", date(1992, 1, 1)),
+            ("0101154000", date(2015, 1, 1)),
+            ("0101924000", date(1992, 1, 1)),
+            ("0101155000", date(2015, 1, 1)),
+            ("0101925000", date(1892, 1, 1)),
+            ("0101156000", date(2015, 1, 1)),
+            ("0101926000", date(1892, 1, 1)),
+            ("0101157000", date(2015, 1, 1)),
+            ("0101927000", date(1892, 1, 1)),
+            ("0101158000", date(2015, 1, 1)),
+            ("0101928000", date(1892, 1, 1)),
+            ("0101159000", date(2015, 1, 1)),
+            ("0101929000", date(1992, 1, 1)),
+        )
+
+        for cpr, birth_date in test_data:
+            with self.subTest(cpr=cpr, birth_date=birth_date):
+                self.assertEqual(cpr_util.get_birth_date(cpr), birth_date)
+
+        with self.assertRaises(ValueError):
+            cpr_util.get_birth_date("010190-1234")
+
+        with self.assertRaises(ValueError):
+            cpr_util.get_birth_date("010190xxxx")
+
 
 if __name__ == '__main__':
     unittest.main()

tests/test_nova_api/test_cases.py

@@ -87,7 +87,9 @@ def test_get_cvr_cases(self):
             nova_cases.get_cvr_cases(nova_access=self.nova_access)
 
     def test_add_case(self):
-        """Test adding a case to Nova."""
+        """Test adding a case to Nova.
+        Also tests getting a case on uuid.
+        """
         nova_party = os.getenv('NOVA_PARTY').split(',')
         party = CaseParty(
             role="Primær",
@@ -126,17 +128,14 @@ def test_add_case(self):
         nova_case = None
         for _ in range(10):
             time.sleep(1)
-            cases = nova_cases.get_cases(self.nova_access, cpr=party.identification, case_title="Test")
-            for c in cases:
-                if c.title == case.title:
-                    nova_case = c
-                    break
-            if nova_case:
+            try:
+                nova_case = nova_cases.get_case(case.uuid, self.nova_access)
                 break
+            except ValueError:
+                pass
 
         self.assertIsNotNone(nova_case)
 
-        nova_case = cases[0]
         self.assertEqual(nova_case.uuid, case.uuid)
         self.assertEqual(nova_case.title, case.title)
         self.assertEqual(nova_case.progress_state, case.progress_state)