Merge pull request #903 from srow90/codex/issue-888-api-score-sort

Support API sorting by user score

Author: dannyvfilms

src/api/helpers.py

@@ -124,6 +124,7 @@
 
 
 MEDIA_EXISTING_SORTS = [
+    "score",
     "start_date",
     "end_date",
 ] + [f.name for f in Item._meta.fields]
@@ -725,6 +726,9 @@ def apply_manual_sort_for_type(results, sort):
     "itemid": itemid_key_compare,
     "mediaid": _sort_mediaid,
     "progress": lambda media: int(getattr(media, "progress", 0) or 0),
+    "score": lambda media: _sort_nullable(
+        getattr(media, "aggregated_score", getattr(media, "score", None)),
+    ),
     "release_datetime": lambda media: _sort_nullable(
         getattr(_item_from_result(media), "release_datetime", None),
     ),

src/api/tests/test_media_core.py

@@ -153,6 +153,38 @@ def test_media_list_get_with_sort_filter_returns_sorted_results(self):
         titles = [item["item"]["title"] for item in payload["results"]]
         self.assertEqual(titles, sorted(titles, reverse=True))
 
+    def test_media_list_get_sorts_by_user_score(self):
+        """Media list accepts score as a tracked-media sort field."""
+        for media, score in zip(self.movie_medias, (7, 9, 8), strict=True):
+            media.score = score
+            media.save(update_fields=["score"])
+
+        response = self.call_api(
+            "get",
+            "api_media_list",
+            params={"media_type": MediaTypes.MOVIE.value, "sort": "score_desc"},
+            headers=self.auth_headers,
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            [item["score"] for item in response.json()["results"]],
+            [9, 8, 7],
+        )
+
+        response = self.call_api(
+            "get",
+            "api_media_list",
+            params={"sort": "score_desc"},
+            headers=self.auth_headers,
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(
+            [item["score"] for item in response.json()["results"][:3]],
+            [9, 8, 7],
+        )
+
     def test_media_list_get_with_exclude_filter_excludes_type(self):
         """Media list endpoint should exclude requested media types."""
         response = self.call_api(