feat(groups): implemented memberfields (#139)

Author: bensteUEM

README.md

@@ -89,4 +89,5 @@ Anybody using this code is more than welcome to contribute with change requests
 
 * benste - implemented for use at Evangelische Kirchengemeinde Baiersbronn (https://www.evang-kirche-baiersbronn.de/)
 * kolibri52 - Jonathan supporting Liebenzeller Gemeinschaft Oettingen (https://lgv-oe.de/)
-* fschrempf - Frieder supporting CVJM Esslingen e. V. (https://cvjm-esslingen.de)
+* fschrempf - Frieder supporting CVJM Esslingen e. V. (https://cvjm-esslingen.de)
+* wengc3 - https://github.com/wengc3

churchtools_api/groups.py

@@ -219,6 +219,42 @@ def update_group(self, group_id: int, data: dict) -> dict:
         )
         return None
 
+    def update_group_member(self, group_id: int, person_id: int, data: dict) -> dict:
+        """Update a field of the given member in group.
+
+        to loookup available names use get_group_member(group_id=xxx).
+
+        Arguments:
+            group_id: number of the group to update
+            person_id: number of the member to update
+            data: all group member fields
+
+        Returns:
+            dict with updated group member
+        """
+        url = self.domain + f"/api/groups/{group_id}/members/{person_id}"
+        headers = {
+            "accept": "application/json",
+            "Content-Type": "application/json",
+        }
+        response = self.session.patch(url=url, headers=headers, data=json.dumps(data))
+
+        if response.status_code == requests.codes.ok:
+            response_content = json.loads(response.content)
+            response_data = response_content["data"].copy()
+            logger.debug(
+                "First response of Update Group Member successful len=%s",
+                len(response_content),
+            )
+
+            return response_data
+        logger.warning(
+            "%s Something went wrong updating group: %s",
+            response.status_code,
+            response.content,
+        )
+        return None
+
     def delete_group(self, group_id: int) -> bool:
         """Delete the given group.
 
@@ -311,10 +347,11 @@ def get_group_members(self, group_id: int, **kwargs: dict) -> list[dict]:
 
         Arguments:
             group_id: group id
-            kwargs: see below
+            kwargs: see API documentation - only tested cases below
 
         Kwargs:
             role_ids: list[int]: optional filter list of role ids
+            person_ids: list[int]: optional filter by person_id
 
         Returns:
             list of group member dicts
@@ -325,6 +362,8 @@ def get_group_members(self, group_id: int, **kwargs: dict) -> list[dict]:
 
         if "role_ids" in kwargs:
             params["role_ids[]"] = kwargs["role_ids"]
+        if "person_ids" in kwargs:
+            params["person_id[]"] = kwargs["person_ids"]
 
         response = self.session.get(url=url, headers=headers, params=params)
 
@@ -345,6 +384,38 @@ def get_group_members(self, group_id: int, **kwargs: dict) -> list[dict]:
         )
         return None
 
+    def get_group_memberfields(self, group_id: int) -> list[dict]:
+        """Get list of member fields for the given group.
+
+        Arguments:
+            group_id: group id
+
+        Returns:
+            list of group member fields dicts
+        """
+        url = self.domain + f"/api/groups/{group_id}/memberfields"
+        headers = {"accept": "application/json"}
+        params = {}
+
+        response = self.session.get(url=url, headers=headers, params=params)
+
+        if response.status_code == requests.codes.ok:
+            response_content = json.loads(response.content)
+
+            response_data = self.combine_paginated_response_data(
+                response_content,
+                url=url,
+                headers=headers,
+            )
+            return [response_data] if isinstance(response_data, dict) else response_data
+
+        logger.warning(
+            "%s Something went wrong fetching group member fields: %s",
+            response.status_code,
+            response.content,
+        )
+        return None
+
     def get_groups_members(
         self,
         group_ids: list[int] | None = None,

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "churchtools-api"
-version = "1.7.2"
+version = "1.7.3"
 description = "A python wrapper for use with ChurchToolsAPI"
 authors = [
     "bensteUEM",

tests/test_churchtools_api_groups.py

@@ -223,6 +223,42 @@ def test_update_group(self) -> None:
         groups = self.api.get_groups(group_id=SAMPLE_GROUP_ID)
         assert groups[0]["information"]["note"] == ""
 
+    def test_update_group_member(self) -> None:
+        """Checks that a field of a group member can be set.
+
+        to some value and the returned group member has this field value set.
+        Also cleans the field after executing the test
+
+        IMPORTANT - This test method and the parameters used depend on target system!
+        the hard coded sample exists on ELKW1610.KRZ.TOOLS
+        """
+        SAMPLE_GROUP_ID = 103
+        SAMPLE_MEMBER_ID = 513
+
+        # check comment is empty as prerequisite
+        pre_test_user_state = self.api.get_group_members(
+            group_id=SAMPLE_GROUP_ID, person_ids=[SAMPLE_MEMBER_ID]
+        )[0]
+        assert pre_test_user_state.get("comment") is None
+
+        # set a new sample comment
+        data = {"comment": "Updated Over API"}
+        group_member_update_result = self.api.update_group_member(
+            group_id=SAMPLE_GROUP_ID, person_id=SAMPLE_MEMBER_ID, data=data
+        )
+        assert group_member_update_result["comment"] == data["comment"]
+
+        # cleanup / delete comment after test
+        group_member_update_result = self.api.update_group_member(
+            group_id=SAMPLE_GROUP_ID,
+            person_id=SAMPLE_MEMBER_ID,
+            data={"comment": None},
+        )
+        members = self.api.get_group_members(
+            group_id=SAMPLE_GROUP_ID, person_ids=[SAMPLE_MEMBER_ID]
+        )
+        assert members[0]["comment"] is None
+
     def test_get_group_members(self) -> None:
         """Checks if group members can be retrieved.
 
@@ -233,13 +269,16 @@ def test_get_group_members(self) -> None:
         """
         SAMPLE_GROUP_ID = 103
         SAMPLE_GROUPTYPE_ROLE_ID = 16
-        members = self.api.get_group_members(group_id=SAMPLE_GROUP_ID)
+        SAMPLE_USER_ID = 513
 
+        # 1. retrieve all group member by group_id
+        members = self.api.get_group_members(group_id=SAMPLE_GROUP_ID)
         assert members is not None
         assert members != []
         for member in members:
             assert "personId" in member
 
+        # 2. retrieve group members by role
         members = self.api.get_group_members(
             group_id=SAMPLE_GROUP_ID,
             role_ids=[SAMPLE_GROUPTYPE_ROLE_ID],
@@ -250,10 +289,35 @@ def test_get_group_members(self) -> None:
             assert "personId" in member
             assert member["groupTypeRoleId"] == SAMPLE_GROUPTYPE_ROLE_ID
 
+        # 3. retrieve group members by person_id
+        members = self.api.get_group_members(
+            group_id=SAMPLE_GROUP_ID,
+            person_ids=[SAMPLE_USER_ID],
+        )
+        assert members is not None
+        assert members != []
+        assert len(members) == 1
+        assert members[0]["personId"] == SAMPLE_USER_ID
+
+    def test_get_group_memberfields(self) -> None:
+        """Checks if group member fields can be retrieved from a group.
+
+        IMPORTANT - This test method and the parameters used depend on target system!
+        the hard coded sample exists on ELKW1610.KRZ.TOOLS
+        """
+        SAMPLE_GROUP_ID = 103
+        memberfields = self.api.get_group_memberfields(group_id=SAMPLE_GROUP_ID)
+
+        assert memberfields is not None
+        assert memberfields != []
+        for memberfield in memberfields:
+            assert "type" in memberfield
+            assert "id" in memberfield["field"]
+
     def test_get_groups_members(self) -> None:
         """Check that a list of groups is received.
 
-        when asking by person and optional role id.
+        when requesting by person and optional role id.
 
         IMPORTANT - This test method and the parameters used depend on target system!
         the hard coded sample exists on ELKW1610.KRZ.TOOLS

version.py

@@ -2,7 +2,7 @@
 
 import os
 
-VERSION = "1.7.2"
+VERSION = "1.7.3"
 __version__ = VERSION
 
 if __name__ == "__main__":