Refactor update creation api

This merge request does the following:

• Raise DRF errors rather than returning response to take advantage of the DRF exception handling mechanism
• Create serialisers for PUT request to simplify the code
• Improve validation checks in several places
• Fixes several issues in DRF infrastructure uses
• Fixes JSON fields handling
• Remove routes that do no fully qualify objects
• Implement a custom DRF exception handler that will allow to log errors
• Improve testing
• Improve permission management

beat/web/team/api.py

@@ -32,8 +32,8 @@ from django.db.models import Q
 from rest_framework import generics
 from rest_framework import permissions
 from rest_framework.response import Response
-from rest_framework import status
 from rest_framework.reverse import reverse
+from rest_framework import exceptions as drf_exceptions
 
 from .serializers import FullTeamSerializer
 from .serializers import SimpleTeamSerializer
@@ -42,26 +42,26 @@ from .serializers import TeamUpdateSerializer
 from .models import Team
 from .permissions import IsOwner, HasPrivacyLevel
 
-from ..common.responses import BadRequestResponse, ForbiddenResponse
 from ..common.mixins import CommonContextMixin
 
 
-#----------------------------------------------------------
+# ----------------------------------------------------------
 
 
 class UserTeamListView(CommonContextMixin, generics.ListCreateAPIView):
     """
     Lists the team from a user and create new teams
     """
+
     model = Team
     serializer_class = SimpleTeamSerializer
     writing_serializer_class = TeamCreationSerializer
     permission_classes = [permissions.IsAuthenticated]
 
     def get_serializer(self, *args, **kwargs):
-        if self.request.method == 'POST':
+        if self.request.method == "POST":
             self.serializer_class = self.writing_serializer_class
-        return super(UserTeamListView, self).get_serializer(*args, **kwargs)
+        return super().get_serializer(*args, **kwargs)
 
     def list(self, request, owner_name):
         owner = get_object_or_404(User, username=owner_name)
@@ -69,13 +69,19 @@ class UserTeamListView(CommonContextMixin, generics.ListCreateAPIView):
         if request.user == owner:
             queryset = Team.objects.filter(owner=owner)
         else:
-            queryset = Team.objects.filter(Q(owner=owner), Q(privacy_level=Team.PUBLIC)|Q(privacy_level=Team.MEMBERS, members=request.user)).distinct()
-
-        serializer = self.get_serializer(queryset, many=True, context={'user': request.user})
+            queryset = Team.objects.filter(
+                Q(owner=owner),
+                Q(privacy_level=Team.PUBLIC)
+                | Q(privacy_level=Team.MEMBERS, members=request.user),
+            ).distinct()
+
+        serializer = self.get_serializer(
+            queryset, many=True, context={"user": request.user}
+        )
         return Response(serializer.data)
 
 
-#----------------------------------------------------------
+# ----------------------------------------------------------
 
 
 class TeamDetailView(CommonContextMixin, generics.RetrieveUpdateDestroyAPIView):
@@ -89,15 +95,15 @@ class TeamDetailView(CommonContextMixin, generics.RetrieveUpdateDestroyAPIView):
 
     def get_permissions(self):
         self.permission_classes = [permissions.IsAuthenticatedOrReadOnly]
-        if self.request.method == 'GET':
+        if self.request.method == "GET":
             self.permission_classes.append(HasPrivacyLevel)
         else:
             self.permission_classes.append(IsOwner)
-        return super(TeamDetailView, self).get_permissions()
+        return super().get_permissions()
 
-    def get_queryset(self):
-        owner_name = self.kwargs.get('owner_name')
-        team_name  = self.kwargs.get('team_name')
+    def get_object(self):
+        owner_name = self.kwargs.get("owner_name")
+        team_name = self.kwargs.get("team_name")
 
         team = get_object_or_404(Team, owner__username=owner_name, name=team_name)
 
@@ -106,52 +112,54 @@ class TeamDetailView(CommonContextMixin, generics.RetrieveUpdateDestroyAPIView):
         return team
 
     def get_serializer(self, *args, **kwargs):
-        if self.request.method in ['PUT', 'PATCH']:
+        if self.request.method in ["PUT", "PATCH"]:
             self.serializer_class = self.writing_serializer_class
-        return super(TeamDetailView, self).get_serializer(*args, **kwargs)
+        return super().get_serializer(*args, **kwargs)
 
-    def get(self, request, owner_name, team_name):
-        team = self.get_queryset()
-        serializer = self.serializer_class(team, context={'user': request.user})
-        return Response(serializer.data)
+    def get_serializer_context(self):
+        context = super().get_serializer_context()
+        context["user"] = self.request.user
+        return context
 
-    def delete(self, request, owner_name, team_name):
-        team = self.get_queryset()
-
-        # Check that the team can still be deleted
-        if not(team.deletable()):
-            return ForbiddenResponse("The team isn't deletable (it has been used to share %d objects with its members)" % team.total_shares())
-
-        team.delete()
-        return Response(status=status.HTTP_204_NO_CONTENT)
+    def perform_destroy(self, instance):
+        if not instance.deletable():
+            raise drf_exceptions.PermissionDenied(
+                "The team isn't deletable (it has been used to share %d objects with its members)"
+                % instance.total_shares()
+            )
+        return super().perform_destroy(instance)
 
     def update(self, request, owner_name, team_name):
-        team = self.get_queryset()
+        team = self.get_object()
         self.check_object_permissions(request, team)
 
-        serializer = self.writing_serializer_class(team, data=request.data, partial=True)
-        if not(serializer.is_valid()):
-            return BadRequestResponse(serializer.errors)
+        serializer = self.writing_serializer_class(
+            team, data=request.data, partial=True
+        )
+        serializer.is_valid(raise_exception=True)
 
         db_object = serializer.save()
 
         result = {
-            'name': db_object.name,
-            'url':  reverse('api_teams:team_info', args=[db_object.owner.username, db_object.name])
+            "name": db_object.name,
+            "url": reverse(
+                "api_teams:team_info", args=[db_object.owner.username, db_object.name]
+            ),
         }
 
         response = Response(result, status=200)
-        response['Location'] = result['url']
+        response["Location"] = result["url"]
         return response
 
 
-#----------------------------------------------------------
+# ----------------------------------------------------------
 
 
 class TeamListView(CommonContextMixin, generics.ListAPIView):
     """
     List all teams of the caller
     """
+
     model = Team
     serializer_class = SimpleTeamSerializer
     permission_classes = [permissions.IsAuthenticated]