API: add project name/slug filters (#9843)

* API: add project name/slug filters

I am trying to use the project API for some search and dropdown filters,
and while I can filter the local results, it's much nicer to use the API
filter for this.

This adds an icontains filter field for project name and slug, and
hopefully some accurate tests.

* Lint

* Add missing fixture

* Remove print statement

Co-authored-by: Benjamin Balder Bach <[email protected]>

* Add comment on changing filter fields

Co-authored-by: Benjamin Balder Bach <[email protected]>

Author: agjohnson

docs/user/api/v3.rst

@@ -186,6 +186,8 @@ Projects list
             }]
         }
 
+    :query string name: return projects with matching name
+    :query string slug: return projects with matching slug
     :query string language: language code as ``en``, ``es``, ``ru``, etc.
     :query string programming_language: programming language code as ``py``, ``js``, etc.
 

readthedocs/api/v3/filters.py

@@ -8,11 +8,20 @@
 
 class ProjectFilter(filters.FilterSet):
 
+    # TODO this is copying the patterns from other filter sets, where the fields
+    # are all ``icontains`` lookups by default. We discussed reversing this
+    # pattern in the future though, see:
+    # https://github.com/readthedocs/readthedocs.org/issues/9862
+    name = filters.CharFilter(lookup_expr="icontains")
+    slug = filters.CharFilter(lookup_expr="icontains")
+
     class Meta:
         model = Project
         fields = [
-            'language',
-            'programming_language',
+            "name",
+            "slug",
+            "language",
+            "programming_language",
         ]
 
 

readthedocs/api/v3/tests/responses/projects-list-empty.json

@@ -0,0 +1,6 @@
+{
+    "count": 0,
+    "next": null,
+    "previous": null,
+    "results": []
+}

readthedocs/api/v3/tests/test_projects.py

@@ -23,6 +23,48 @@ def test_projects_list(self):
             self._get_response_dict('projects-list'),
         )
 
+    def test_projects_list_filter_full_hit(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
+        response = self.client.get(
+            reverse("projects-list"),
+            data={
+                "name": self.project.name,
+            },
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertDictEqual(
+            response.json(),
+            self._get_response_dict("projects-list"),
+        )
+
+    def test_projects_list_filter_partial_hit(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
+        response = self.client.get(
+            reverse("projects-list"),
+            data={
+                "name": self.project.name[0:3],
+            },
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertDictEqual(
+            response.json(),
+            self._get_response_dict("projects-list"),
+        )
+
+    def test_projects_list_filter_miss(self):
+        self.client.credentials(HTTP_AUTHORIZATION=f"Token {self.token.key}")
+        response = self.client.get(
+            reverse("projects-list"),
+            data={
+                "name": "63dadecd5323d789cafe09f01cda85fd",
+            },
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertDictEqual(
+            response.json(),
+            self._get_response_dict("projects-list-empty"),
+        )
+
     def test_own_projects_detail(self):
         self.client.credentials(HTTP_AUTHORIZATION=f'Token {self.token.key}')
         response = self.client.get(