add /item/comment endpoint and prefetch related models

core/inventory/api_v2.py

@@ -1,12 +1,13 @@
 from django.urls import re_path
 from django.contrib.auth.decorators import permission_required
-from rest_framework import routers, viewsets
+from rest_framework import routers, viewsets, status
 from rest_framework.decorators import api_view, permission_classes
 from rest_framework.response import Response
 from rest_framework.permissions import IsAuthenticated
 
-from inventory.models import Event, Container, Item
-from inventory.serializers import EventSerializer, ContainerSerializer, ItemSerializer, SearchResultSerializer
+from inventory.models import Event, Container, Item, Comment
+from inventory.serializers import EventSerializer, ContainerSerializer, CommentSerializer, ItemSerializer, \
+    SearchResultSerializer
 
 from base64 import b64decode
 
@@ -22,6 +23,17 @@ class ContainerViewSet(viewsets.ModelViewSet):
     queryset = Container.objects.all()
 
 
+class ItemViewSet(viewsets.ModelViewSet):
+    serializer_class = ItemSerializer
+
+    def get_queryset(self):
+        queryset = Item.objects.all()
+        serializer = self.get_serializer_class()
+        if hasattr(serializer, 'Meta') and hasattr(serializer.Meta, 'prefetch_related_fields'):
+            queryset = queryset.prefetch_related(*serializer.Meta.prefetch_related_fields)
+        return queryset
+
+
 def filter_items(items, query):
     query_tokens = query.split(' ')
     for item in items:
@@ -49,6 +61,7 @@ def search_items(request, event_slug, query):
 @api_view(['GET', 'POST'])
 @permission_classes([IsAuthenticated])
 def item(request, event_slug):
+    vs = ItemViewSet()
     try:
         event = None
         if event_slug != 'none':
@@ -56,7 +69,7 @@ def item(request, event_slug):
         if request.method == 'GET':
             if not request.user.has_event_perm(event, 'view_item'):
                 return Response(status=403)
-            return Response(ItemSerializer(Item.objects.filter(event=event), many=True).data)
+            return Response(ItemSerializer(vs.get_queryset().filter(event=event), many=True).data)
         elif request.method == 'POST':
             if not request.user.has_event_perm(event, 'add_item'):
                 return Response(status=403)
@@ -71,12 +84,31 @@ def item(request, event_slug):
         return Response(status=400)
 
 
+@api_view(['POST'])
+@permission_classes([IsAuthenticated])
+@permission_required('tickets.add_comment', raise_exception=True)
+def add_comment(request, event_slug, id):
+    event = None
+    if event_slug != 'none':
+        event = Event.objects.get(slug=event_slug)
+    item = Item.objects.get(event=event, id=id)
+    if not request.user.has_event_perm(event, 'view_item'):
+        return Response(status=403)
+    if 'comment' not in request.data or request.data['comment'] == '':
+        return Response({'status': 'error', 'message': 'missing comment'}, status=status.HTTP_400_BAD_REQUEST)
+    comment = Comment.objects.create(
+        item=item,
+        comment=request.data['comment'],
+    )
+    return Response(CommentSerializer(comment).data, status=status.HTTP_201_CREATED)
+
+
 @api_view(['GET', 'PUT', 'DELETE', 'PATCH'])
 @permission_classes([IsAuthenticated])
 def item_by_id(request, event_slug, id):
     try:
         event = Event.objects.get(slug=event_slug)
-        item = Item.objects.get(event=event, id=id)
+        item = ItemViewSet().get_queryset().get(event=event, id=id)
         if request.method == 'GET':
             if not request.user.has_event_perm(event, 'view_item'):
                 return Response(status=403)
@@ -117,5 +149,6 @@ urlpatterns = router.urls + [
     re_path(r'^(?P<event_slug>[\w-]+)/items/$', item, name='item'),
     re_path(r'^(?P<event_slug>[\w-]+)/items/(?P<query>[-A-Za-z0-9+/]*={0,3})/$', search_items, name='search_items'),
     re_path(r'^(?P<event_slug>[\w-]+)/item/$', item, name='item'),
+    re_path(r'^(?P<event_slug>[\w-]+)/item/(?P<id>\d+)/comment/$', add_comment, name='add_comment'),
     re_path(r'^(?P<event_slug>[\w-]+)/item/(?P<id>\d+)/$', item_by_id, name='item_by_id'),
 ]

core/inventory/serializers.py

@@ -3,7 +3,7 @@ from rest_framework import serializers
 from rest_framework.relations import SlugRelatedField
 
 from files.models import File
-from inventory.models import Event, Container, Item
+from inventory.models import Event, Container, Item, Comment
 from inventory.shared_serializers import BasicItemSerializer
 from mail.models import EventAddress
 from tickets.shared_serializers import BasicIssueSerializer
@@ -38,6 +38,18 @@ class ContainerSerializer(serializers.ModelSerializer):
         return len(instance.items)
 
 
+class CommentSerializer(serializers.ModelSerializer):
+
+    def validate(self, attrs):
+        if 'comment' not in attrs or attrs['comment'] == '':
+            raise serializers.ValidationError('comment cannot be empty')
+        return attrs
+
+    class Meta:
+        model = Comment
+        fields = ('id', 'comment', 'timestamp', 'item')
+
+
 class ItemSerializer(BasicItemSerializer):
     timeline = serializers.SerializerMethodField()
     dataImage = serializers.CharField(write_only=True, required=False)
@@ -48,6 +60,7 @@ class ItemSerializer(BasicItemSerializer):
         fields = ['cid', 'box', 'id', 'description', 'file', 'dataImage', 'returned', 'event', 'related_issues',
                   'timeline']
         read_only_fields = ['id']
+        prefetch_related_fields = ['comments', 'issue_relation_changes', 'container_history']
 
     def to_internal_value(self, data):
         container = None