fix(songs): workaround for support case with song arrangements - (#144)

fix(songs): corrected dtypes (#144)

Author: bensteUEM

churchtools_api/songs.py

@@ -304,7 +304,7 @@ def delete_song(self, song_id: int) -> bool:
 
         return True
 
-    def contains_song_tag(self, song_id: int, song_tag_name: int) -> bool:
+    def contains_song_tag(self, song_id: int, song_tag_name: str) -> bool:
         """Helper which checks if a specific song_tag_id is present on a song.
 
         Arguments:
@@ -317,13 +317,12 @@ def contains_song_tag(self, song_id: int, song_tag_name: int) -> bool:
         tags = self.get_tag(domain_type="song", domain_id=song_id, rtype="name_dict")
         return song_tag_name in tags
 
-    def get_songs_by_tag(self, song_tag_name: int) -> list[dict]:
+    def get_songs_by_tag(self, song_tag_name: str) -> list[dict]:
         """Helper which returns all songs that contain have a specific tag.
 
         Arguments:
-            song_tag_name: ChurchTools site specific song_tag_id which should be used
-            OR
-            song_tag_id
+            song_tag_name: name of a song tag that is used
+                in respective ChurchTools instace
 
         Returns:
             list of songs
@@ -367,7 +366,7 @@ def get_song_arrangement(
         return next(
             arrangement
             for arrangement in song["arrangements"]
-            if song["arrangements"][0]["isDefault"]
+            if arrangement["isDefault"]
         )
 
     def create_song_arrangement(self, song_id: int, arrangement_name: str) -> int:
@@ -426,6 +425,14 @@ def edit_song_arrangement(
             duration: (int) lenght in full seconds.
             note: (str) more detailed explanation text.
 
+        Not useable Keywords due to bug
+            #TODO@bensteUEM: only some parameters can be applied
+            # CT support case 147728
+            # https://github.com/bensteUEM/ChurchToolsAPI/issues/144
+            source_name: (int|str) id of the source as defined in masterdata.
+                Alternatively also accepts shortname.
+            source_reference: (str) source reference number.
+
         Returns:
             if changes were applied successful
         """
@@ -434,16 +441,35 @@ def edit_song_arrangement(
         existing_arrangement = self.get_song_arrangement(
             song_id=song_id, arrangement_id=arrangement_id
         )
-
-        if isinstance(kwargs.get("source_id"), int):
-            source_id = kwargs.get("source_id")
-        elif isinstance(kwargs.get("source_id"), str):
-            source_id = self.lookup_song_source_as_id(shortname=kwargs.get("source_id"))
+        # TODO@bensteUEM: only some parameters can be applied
+        # CT support case 147728
+        # https://github.com/bensteUEM/ChurchToolsAPI/issues/144
+        """
+        if isinstance(kwargs.get("source_name"), int):
+            source_name = kwargs.get("source_name")
+        elif isinstance(kwargs.get("source_name"), str):
+            source_name = self.lookup_song_source_as_id(
+                shortname=kwargs.get("source_name")
+            )
         else:
-            source_id = self.lookup_song_source_as_id(
+            source_name = self.lookup_song_source_as_id(
                 shortname=existing_arrangement["sourceName"]
             )
-
+        """
+        if kwargs.get("source_name") or kwargs.get("source_reference"):
+            logger.warning(
+                "CT support cas 147728 source_name and reference are "
+                "not updateabel via REST API"
+            )
+        # TODO@bensteUEM: only some parameters can be applied
+        # CT support case 147728
+        # https://github.com/bensteUEM/ChurchToolsAPI/issues/144
+        """
+        "sourceName": source_name,
+        "sourceReference": kwargs.get(
+            "source_reference", existing_arrangement["sourceReference"]
+        ),
+        """
         data = {
             "name": kwargs.get("name", existing_arrangement["name"]),
             "key": kwargs.get("key", existing_arrangement["key"]),

churchtools_api/tags.py

@@ -115,8 +115,8 @@ def remove_tag(self, domain_type: str, domain_id: str, tag_name: str) -> bool:
         return True
 
     def get_tag(
-        self, domain_type: str, domain_id: str, rtype: str = "original"
-    ) -> list[dict]:
+        self, domain_type: str, domain_id: int, rtype: str = "original"
+    ) -> list[dict] | None:
         """Retrieves the readable tags of one single object.
 
         Args:

tests/test_churchtools_api_songs.py

@@ -326,12 +326,19 @@ def test_create_edit_delete_song_arrangement(self) -> None:
         )
         assert created_arrangement["name"] == SAMPLE_ARRANGEMENT_NAME
 
-        SAMPLE_SOURCE = {"12": "T"}
+        # SAMPLE_SOURCE = {"12": "T"} #noqa: ERA001
 
         # edit source as text and changed params
         SAMPLE_ARRANGEMENT_NAME2 = "TEST_BEZEICHNUNG"
         SAMPLE_PARAMS = {
             "name": SAMPLE_ARRANGEMENT_NAME2,
+            # TODO@bensteUEM: only some parameters can be applied
+            # CT support case 147728
+            # https://github.com/bensteUEM/ChurchToolsAPI/issues/144
+            # "sourceName": next(
+            #     iter(SAMPLE_SOURCE.values())  # noqa: ERA001
+            # ),  # using shortname on purpse
+            # "sourceReference": "source_ref",  # noqa: ERA001
             "key": "F",
             "tempo": 50,
             "beat": "beat",
@@ -350,8 +357,13 @@ def test_create_edit_delete_song_arrangement(self) -> None:
             created_arrangement[expected_key] == expected_value
             for expected_key, expected_value in SAMPLE_PARAMS.items()
         )
+        # TODO@bensteUEM: only some parameters can be applied
+        # CT support case 147728
+        # https://github.com/bensteUEM/ChurchToolsAPI/issues/144
+        # assert created_arrangement["sourceName"] == next(iter(SAMPLE_SOURCE.values()))  # noqa: ERA001 E501
 
         # edit2 - source as key id
+        """
         SAMPLE_PARAMS_SHORT = {
             "source_id": int(next(iter(SAMPLE_SOURCE.keys()))),
         }
@@ -363,8 +375,7 @@ def test_create_edit_delete_song_arrangement(self) -> None:
             song_id=SAMPLE_SONG_ID, arrangement_id=arrangement_id
         )
         assert created_arrangement["sourceName"] == next(iter(SAMPLE_SOURCE.values()))
-        assert created_arrangement["duration"] == SAMPLE_PARAMS["duration"]
-
+        """
         # delete
         was_deleted = self.api.delete_song_arrangement(
             song_id=SAMPLE_SONG_ID, arrangement_id=arrangement_id