feat(persons): adding add delete person (#279)

Author: bensteUEM

churchtools_api/persons.py

@@ -128,3 +128,107 @@ def get_persons_masterdata(
             response.content,
         )
         return None
+
+    def create_person(self, person_data: dict) -> dict | None:
+        """Function to create a person to ChurchTools.
+
+        Arguments:
+            person_data: dict with person data according to CT API
+                firstName
+                lastName
+                email
+
+                and additional optional fields using the following deafults:
+                * departmentIds defaults to 0
+                * statusId defaults to 0 (unknown)
+                * campusId defaults to 0 (first campus)
+                * privacyPolicyAgreementTypeId defaults to 1 (Gruppenanmeldeforumular)
+                * privacyPolicyAgreementWhoId defaults to 1 (Person selbst)
+                * privacyPolicyAgreementDate defaults to "1900-01-01"
+
+        Permissions:
+            create person
+
+        Returns:
+            dict with created person data including new ID
+        """
+        # add default keys if not provided
+        required_keys = ["firstName", "lastName", "email"]
+        if not all(key in person_data for key in required_keys):
+            logger.error(
+                "Person creation failed: missing required keys in person_data: %s",
+                required_keys,
+            )
+            return None
+
+        default_keys = {
+            "departmentIds": [1],
+            "statusId": 0,  # Unkonwn
+            "campusId": 0,  # First Campus
+            "email": "no-mail@nomail.xx",
+            "privacyPolicyAgreementTypeId": 1,  # Gruppenanmeldeforumular
+            "privacyPolicyAgreementWhoId": 1,  # Person selbst
+            "privacyPolicyAgreementDate": "1900-01-01",
+        }
+
+        for key in default_keys:
+            if key not in person_data:
+                person_data[key] = default_keys[key]
+
+        # prepare request
+
+        url = self.domain + "/api/persons"
+
+        headers = {
+            "accept": "application/json",
+            "Content-Type": "application/json",
+        }
+
+        response = self.session.post(
+            url=url, headers=headers, data=json.dumps(person_data)
+        )
+
+        # use reposonse
+
+        if response.status_code == requests.codes.created:
+            response_content = json.loads(response.content)
+            response_data = response_content["data"].copy()
+
+            logger.debug("Person creation successful id=%s", response_data.get("id"))
+            return response_data
+        logger.warning(
+            "Person creation failed: %s %s",
+            response.status_code,
+            response.content,
+        )
+        return None
+
+    def delete_person(self, personId: int) -> bool:
+        """Function to delete a person from ChurchTools.
+
+        Arguments:
+            personId: ID of the person to delete
+
+        Permissions:
+            delete person
+
+        Returns:
+            bool indicating success
+        """
+        url = self.domain + f"/api/persons/{personId}"
+
+        headers = {
+            "accept": "application/json",
+        }
+        response = self.session.delete(url=url, headers=headers)
+
+        if response.status_code == requests.codes.no_content:
+            logger.debug("Person deletion successful id=%s", personId)
+            return True
+        logger.warning(
+            "Person deletion failed id=%s: %s %s",
+            personId,
+            response.status_code,
+            response.content,
+        )
+        return False

tests/test_churchtools_api_persons.py

@@ -133,3 +133,33 @@ def test_get_persons_sex_id_none(self) -> None:
         result = gender_map[None]
 
         assert result == EXPECTED_RESULT
+
+    def test_create_delete_person(self) -> None:
+        """Tests creating and deleting a person.
+
+        IMPORTANT - This test method and the parameters used depend on target system!
+        the hard coded sample exists on ELKW1610.KRZ.TOOLS
+        """
+        SAMPLE_FIRST_NAME = "TestFirstName"
+        SAMPLE_LAST_NAME = "TestLastName"
+        SAMPLE_MAIL = "TestMail@Example.com"
+
+        sample_person_data = {
+            "firstName": SAMPLE_FIRST_NAME,
+            "lastName": SAMPLE_LAST_NAME,
+            "email": SAMPLE_MAIL,
+        }
+
+        # create person
+        new_person = self.api.create_person(sample_person_data)
+        assert isinstance(new_person["id"], int)
+
+        # retrieve person and check data
+        check_person = self.api.get_persons(ids=[new_person["id"]])[0]
+        assert check_person["firstName"] == SAMPLE_FIRST_NAME
+        assert check_person["lastName"] == SAMPLE_LAST_NAME
+        assert check_person["email"] == SAMPLE_MAIL
+
+        # delete person
+        delete_result = self.api.delete_person(personId=new_person["id"])
+        assert delete_result is True