Merge branch 'develop' into feature/search

Author: Neraste

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v5.0.0
+    rev: v6.0.0
     hooks:
     - id: trailing-whitespace
     - id: end-of-file-fixer

CHANGELOG.md

@@ -34,6 +34,10 @@ Any important notes regarding the update.
 
 ## Unreleased
 
+### Added
+
+- Allow to fetch full lyrics of a song at URL `api/library/songs/lyrics/<id>/`.
+
 ## 1.9.2 - 2025-03-22
 
 ## 1.9.1 - 2025-03-15

dakara_server/dakara_server/urls.py

@@ -102,6 +102,11 @@
         library_views.SongView.as_view(),
         name="library-song",
     ),
+    path(
+        "api/library/songs/lyrics/<int:pk>/",
+        library_views.SongLyricsView.as_view(),
+        name="library-song-lyrics",
+    ),
     path(
         "api/library/songs/retrieve/",
         library_views.SongRetrieveListView.as_view(),

dakara_server/internal/query_language.py

@@ -25,9 +25,7 @@ def __init__(self, keywords):
             |
             (?P<contains2>(?:\\\s|\S)+) # contains with no quotes
         )
-        """.format(
-            keywords_regex=r"|".join(self.keywords)
-        )
+        """.format(keywords_regex=r"|".join(self.keywords))
 
         self.language_matcher = re.compile(regex, re.I | re.X)
 

dakara_server/internal/tests/base_test.py

@@ -85,7 +85,7 @@ def check_query(self, query, expected, remaining=None):
         self.assertEqual(response.data["count"], len(expected))
         results = response.data["results"]
         self.assertEqual(len(results), len(expected))
-        for item, expected_item in zip(results, expected):
+        for item, expected_item in zip(results, expected, strict=False):
             self.assertEqual(item["id"], expected_item.id)
 
         if remaining is not None:

dakara_server/library/serializers.py

@@ -403,6 +403,14 @@ def update(self, song, validated_data):
         return song
 
 
+class SongLyricsSerializer(serializers.ModelSerializer):
+    """Song lyrics field serializer."""
+
+    class Meta:
+        model = Song
+        fields = ("id", "lyrics")
+
+
 class SongForPlayerSerializer(serializers.ModelSerializer):
     """Song serializer.
 

dakara_server/library/tests/base_test.py

@@ -85,19 +85,21 @@ def check_song_json(self, json, expected_song):
         # tags
         expected_tags = expected_song.tags.all()
         self.assertEqual(len(json["tags"]), len(expected_tags))
-        for tag, expected_tag in zip(json["tags"], expected_tags):
+        for tag, expected_tag in zip(json["tags"], expected_tags, strict=False):
             self.check_tag_json(tag, expected_tag)
 
         # artists
         expected_artists = expected_song.artists.all()
         self.assertEqual(len(json["artists"]), len(expected_artists))
-        for artist, expected_artist in zip(json["artists"], expected_artists):
+        for artist, expected_artist in zip(
+            json["artists"], expected_artists, strict=False
+        ):
             self.check_artist_json(artist, expected_artist)
 
         # works
         expected_works = expected_song.songworklink_set.all()
         self.assertEqual(len(json["works"]), len(expected_works))
-        for work, expected_work in zip(json["works"], expected_works):
+        for work, expected_work in zip(json["works"], expected_works, strict=False):
             self.check_work_json(work["work"], expected_work.work)
             self.assertEqual(work["link_type"], expected_work.link_type)
             self.assertEqual(work["link_type_number"], expected_work.link_type_number)
@@ -125,7 +127,7 @@ def check_work_json(self, json, expected_work):
         expected_alt_titles = expected_work.alternative_titles.all()
         self.assertEqual(len(json["alternative_titles"]), len(expected_alt_titles))
         for alt_title, expected_alt_title in zip(
-            json["alternative_titles"], expected_alt_titles
+            json["alternative_titles"], expected_alt_titles, strict=False
         ):
             self.assertEqual(alt_title["title"], expected_alt_title.title)
 

dakara_server/library/tests/test_song.py

@@ -57,6 +57,9 @@ def test_get_song_long_lyrics(self):
         self.assertEqual(len(response.data["results"]), 2)
 
         # check lyrics
+        self.assertNotEqual(
+            response.data["results"][1]["lyrics_preview"]["text"], self.song2.lyrics
+        )
         self.assertDictEqual(
             response.data["results"][1]["lyrics_preview"],
             {
@@ -962,3 +965,34 @@ def test_put_song_embedded_work_subtitle(self):
         self.assertEqual(Work.objects.count(), 4)
         workNew = Work.objects.get(title="Work1", subtitle="", work_type=self.wt1)
         self.assertIsNotNone(workNew)
+
+
+class SongLyricsViewTestCase(LibraryAPITestCase):
+    def setUp(self):
+        # create a user without any rights
+        self.user = self.create_user("TestUser")
+
+        # create test data
+        self.create_test_data()
+
+        # add lyrics to one song
+        self.song2.lyrics = """Mary had a little lamb
+Little lamb, little lamb
+Mary had a little lamb
+Its fleece was white as snow
+And everywhere that Mary went
+Mary went, Mary."""
+        self.song2.save()
+
+        # Create urls to access these playlist entries
+        self.url_song2 = reverse("library-song-lyrics", kwargs={"pk": self.song2.id})
+
+    def test_get_lyrics(self):
+        """Get a song lyrics."""
+        self.authenticate(self.user)
+
+        response = self.client.get(self.url_song2)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["id"], self.song2.id)
+        self.assertEqual(response.data["lyrics"], self.song2.lyrics)

dakara_server/library/views.py

@@ -6,6 +6,7 @@
 from rest_framework.generics import (
     ListAPIView,
     ListCreateAPIView,
+    RetrieveAPIView,
     RetrieveUpdateDestroyAPIView,
 )
 from rest_framework.permissions import IsAuthenticated
@@ -54,6 +55,17 @@ class SongView(RetrieveUpdateDestroyAPIView):
     serializer_class = serializers.SongSerializer
 
 
+class SongLyricsView(RetrieveAPIView):
+    """List of songs."""
+
+    permission_classes = [
+        IsAuthenticated,
+        permissions.IsLibraryManager | internal_permissions.IsReadOnly,
+    ]
+    queryset = models.Song.objects.all()
+    serializer_class = serializers.SongLyricsSerializer
+
+
 class SongRetrieveListView(ListAPIView):
     """List of all songs.
 

requirements.txt

@@ -1,15 +1,14 @@
-asgiref>=3.9.1,<3.10.0  # to remove after updating channels
-APScheduler>=3.11.0,<3.12.0
-channels>=4.2.0,<4.3.0
-daphne>=4.1.2,<4.2.0
-dj-database-url>=2.3.0,<2.4.0
+APScheduler>=3.11.2,<3.12.0
+channels>=4.3.2,<4.4.0
+daphne>=4.2.1,<4.3.0
+dj-database-url>=3.1.2,<3.2.0
 django-cache-lock>=0.2.5,<0.3.0
-django-filter>=25.1,<25.2
+django-filter>=25.2,<25.3
 django-ordered-model>=3.7.4,<3.8.0
 django-rest-registration>=0.9.0,<0.10.0
-Django>=5.1.6,<5.2.0
-djangorestframework>=3.15.2,<3.16.0
-drf-spectacular==0.28.0
-packaging>=24.2,<24.3
+Django>=5.2.12,<5.3.0
+djangorestframework>=3.17.1,<3.18.0
+drf-spectacular>=0.29.0,<0.30.0
+packaging>=26.0,<27.0
 python-decouple>=3.8,<3.9
-setuptools>=75.8
+setuptools>=82.0.1