Merge pull request #5879 from readthedocs/humitos/api-v3-redirect-crud

APIv3 CRUD for Redirect objects

Author: humitos

readthedocs/api/v3/mixins.py

@@ -1,5 +1,4 @@
 from django.shortcuts import get_object_or_404
-from rest_framework.exceptions import NotFound
 
 from readthedocs.builds.models import Version
 from readthedocs.projects.models import Project
@@ -62,7 +61,10 @@ def listing_objects(self, queryset, user):
         return queryset.none()
 
     def has_admin_permission(self, user, project):
-        if project in self.admin_projects(user):
+        # Use .only for small optimization
+        admin_projects = self.admin_projects(user).only('id')
+
+        if project in admin_projects:
             return True
 
         return False

readthedocs/api/v3/permissions.py

@@ -1,4 +1,4 @@
-from rest_framework.permissions import IsAuthenticated
+from rest_framework.permissions import IsAuthenticated, BasePermission
 
 
 class PublicDetailPrivateListing(IsAuthenticated):
@@ -29,3 +29,13 @@ def has_permission(self, request, view):
                 return True
 
         return False
+
+
+class IsProjectAdmin(BasePermission):
+
+    """Grant permission if user has admin rights on the Project."""
+
+    def has_permission(self, request, view):
+        project = view._get_parent_project()
+        if view.has_admin_permission(request.user, project):
+            return True

readthedocs/api/v3/serializers.py

@@ -11,6 +11,7 @@
 from readthedocs.builds.models import Build, Version
 from readthedocs.projects.constants import LANGUAGES, PROGRAMMING_LANGUAGES
 from readthedocs.projects.models import Project
+from readthedocs.redirects.models import Redirect, TYPE_CHOICES as REDIRECT_TYPE_CHOICES
 
 
 class UserSerializer(FlexFieldsModelSerializer):
@@ -321,6 +322,7 @@ class ProjectLinksSerializer(BaseLinksSerializer):
 
     versions = serializers.SerializerMethodField()
     builds = serializers.SerializerMethodField()
+    redirects = serializers.SerializerMethodField()
     subprojects = serializers.SerializerMethodField()
     superproject = serializers.SerializerMethodField()
     translations = serializers.SerializerMethodField()
@@ -338,6 +340,15 @@ def get_versions(self, obj):
         )
         return self._absolute_url(path)
 
+    def get_redirects(self, obj):
+        path = reverse(
+            'projects-redirects-list',
+            kwargs={
+                'parent_lookup_project__slug': obj.slug,
+            },
+        )
+        return self._absolute_url(path)
+
     def get_builds(self, obj):
         path = reverse(
             'projects-builds-list',
@@ -451,3 +462,70 @@ def get_subproject_of(self, obj):
             return self.__class__(obj.superprojects.first().parent).data
         except Exception:
             return None
+
+
+class RedirectLinksSerializer(BaseLinksSerializer):
+    _self = serializers.SerializerMethodField()
+    project = serializers.SerializerMethodField()
+
+    def get__self(self, obj):
+        path = reverse(
+            'projects-redirects-detail',
+            kwargs={
+                'parent_lookup_project__slug': obj.project.slug,
+                'redirect_pk': obj.pk,
+            },
+        )
+        return self._absolute_url(path)
+
+    def get_project(self, obj):
+        path = reverse(
+            'projects-detail',
+            kwargs={
+                'project_slug': obj.project.slug,
+            },
+        )
+        return self._absolute_url(path)
+
+
+class RedirectSerializerBase(serializers.ModelSerializer):
+
+    project = serializers.SlugRelatedField(slug_field='slug', read_only=True)
+    created = serializers.DateTimeField(source='create_dt', read_only=True)
+    modified = serializers.DateTimeField(source='update_dt', read_only=True)
+    _links = RedirectLinksSerializer(source='*', read_only=True)
+
+    type = serializers.ChoiceField(source='redirect_type', choices=REDIRECT_TYPE_CHOICES)
+
+    class Meta:
+        model = Redirect
+        fields = [
+            'pk',
+            'created',
+            'modified',
+            'project',
+            'type',
+            'from_url',
+            'to_url',
+            '_links',
+        ]
+
+
+class RedirectCreateSerializer(RedirectSerializerBase):
+    pass
+
+
+class RedirectDetailSerializer(RedirectSerializerBase):
+
+    """Override RedirectSerializerBase to sanitize the empty fields."""
+
+    from_url = serializers.SerializerMethodField()
+    to_url = serializers.SerializerMethodField()
+
+    def get_from_url(self, obj):
+        # Overridden only to return ``None`` when the description is ``''``
+        return obj.from_url or None
+
+    def get_to_url(self, obj):
+        # Overridden only to return ``None`` when the description is ``''``
+        return obj.to_url or None

readthedocs/api/v3/tests/responses/projects-detail.json

@@ -60,6 +60,7 @@
     "_links": {
         "_self": "https://readthedocs.org/api/v3/projects/project/",
         "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+        "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
         "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
         "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
         "translations": "https://readthedocs.org/api/v3/projects/project/translations/",

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

@@ -49,6 +49,7 @@
                 "_self": "https://readthedocs.org/api/v3/projects/project/",
                 "versions": "https://readthedocs.org/api/v3/projects/project/versions/",
                 "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+                "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
                 "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
                 "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
                 "translations": "https://readthedocs.org/api/v3/projects/project/translations/"

readthedocs/api/v3/tests/responses/projects-redirects-detail.json

@@ -0,0 +1,13 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/project/redirects/1/",
+        "project": "https://readthedocs.org/api/v3/projects/project/"
+    },
+    "created": "2019-04-29T10:00:00Z",
+    "modified": "2019-04-29T12:00:00Z",
+    "from_url": "/docs/",
+    "pk": 1,
+    "project": "project",
+    "type": "page",
+    "to_url": "/documentation/"
+}

readthedocs/api/v3/tests/responses/projects-redirects-detail_PUT.json

@@ -0,0 +1,13 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/project/redirects/1/",
+        "project": "https://readthedocs.org/api/v3/projects/project/"
+    },
+    "created": "2019-04-29T10:00:00Z",
+    "modified": "2019-04-29T12:00:00Z",
+    "from_url": "/changed/",
+    "pk": 1,
+    "project": "project",
+    "type": "page",
+    "to_url": "/toanother/"
+}

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

@@ -0,0 +1,20 @@
+{
+    "count": 1,
+    "next": null,
+    "previous": null,
+    "results": [
+        {
+            "_links": {
+                "_self": "https://readthedocs.org/api/v3/projects/project/redirects/1/",
+                "project": "https://readthedocs.org/api/v3/projects/project/"
+            },
+            "created": "2019-04-29T10:00:00Z",
+            "modified": "2019-04-29T12:00:00Z",
+            "from_url": "/docs/",
+            "pk": 1,
+            "project": "project",
+            "type": "page",
+            "to_url": "/documentation/"
+        }
+    ]
+}

readthedocs/api/v3/tests/responses/projects-redirects-list_POST.json

@@ -0,0 +1,13 @@
+{
+    "_links": {
+        "_self": "https://readthedocs.org/api/v3/projects/project/redirects/2/",
+        "project": "https://readthedocs.org/api/v3/projects/project/"
+    },
+    "created": "2019-04-29T10:00:00Z",
+    "modified": "2019-04-29T12:00:00Z",
+    "from_url": "/page/",
+    "pk": 2,
+    "project": "project",
+    "type": "page",
+    "to_url": "/another/"
+}

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

@@ -68,6 +68,7 @@
                     "_self": "https://readthedocs.org/api/v3/projects/project/",
                     "versions": "https://readthedocs.org/api/v3/projects/project/versions/",
                     "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+                    "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
                     "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
                     "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
                     "translations": "https://readthedocs.org/api/v3/projects/project/translations/"
@@ -90,6 +91,7 @@
                 "_self": "https://readthedocs.org/api/v3/projects/subproject/",
                 "versions": "https://readthedocs.org/api/v3/projects/subproject/versions/",
                 "builds": "https://readthedocs.org/api/v3/projects/subproject/builds/",
+                "redirects": "https://readthedocs.org/api/v3/projects/subproject/redirects/",
                 "subprojects": "https://readthedocs.org/api/v3/projects/subproject/subprojects/",
                 "superproject": "https://readthedocs.org/api/v3/projects/subproject/superproject/",
                 "translations": "https://readthedocs.org/api/v3/projects/subproject/translations/"

readthedocs/api/v3/tests/responses/projects-superproject.json

@@ -11,6 +11,7 @@
     "_links": {
         "_self": "https://readthedocs.org/api/v3/projects/project/",
         "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+        "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
         "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
         "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
         "translations": "https://readthedocs.org/api/v3/projects/project/translations/",

readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json

@@ -32,6 +32,7 @@
         "_links": {
             "_self": "https://readthedocs.org/api/v3/projects/project/",
             "builds": "https://readthedocs.org/api/v3/projects/project/builds/",
+            "redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
             "subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
             "superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
             "translations": "https://readthedocs.org/api/v3/projects/project/translations/",