Merge pull request #141 from girder/get-quota-endpoint

Add REST endpoint for retrieving a folder quota

dkc/core/rest/folder.py

@@ -12,7 +12,7 @@
 from rest_framework.response import Response
 from rest_framework.viewsets import ModelViewSet
 
-from dkc.core.models import File, Folder, Terms, TermsAgreement, Tree
+from dkc.core.models import File, Folder, Quota, Terms, TermsAgreement, Tree
 from dkc.core.permissions import (
     HasAccess,
     IsAdmin,
@@ -94,6 +94,12 @@ class Meta(FolderSerializer.Meta):
         read_only_fields = FolderSerializer.Meta.read_only_fields + ['parent']
 
 
+class QuotaSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Quota
+        fields = ['allowed', 'used']
+
+
 class TermsSerializer(serializers.ModelSerializer):
     class Meta:
         model = Terms
@@ -199,6 +205,14 @@ def path(self, request, pk=None):
         serializer = self.get_serializer(ancestors, many=True)
         return Response(serializer.data)
 
+    @swagger_auto_schema(responses={200: QuotaSerializer})
+    @action(detail=True, queryset=Folder.objects.select_related('tree__quota'))
+    def quota(self, request, pk=None):
+        """Retrieve size quota information for a folder."""
+        folder = self.get_object()
+        serializer = QuotaSerializer(folder.tree.quota)
+        return Response(serializer.data)
+
     @swagger_auto_schema(
         operation_description='Retrieve the terms of use for a folder.',
         responses={

dkc/core/tests/test_folder_rest.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 import pytest
 
 from dkc.core.models import File, Folder, Tree
@@ -192,3 +193,13 @@ def test_folder_default_ordering(admin_api_client, folder_factory):
     resp = admin_api_client.get('/api/v2/folders', data={'parent': 'null'})
     assert resp.status_code == 200
     assert [f['name'] for f in resp.data['results']] == ['A', 'B', 'C']
+
+
+@pytest.mark.django_db
+def test_folder_rest_get_quota(admin_api_client, folder):
+    resp = admin_api_client.get(f'/api/v2/folders/{folder.id}/quota')
+    assert resp.status_code == 200
+    assert resp.data == {
+        'used': 0,
+        'allowed': settings.DKC_DEFAULT_QUOTA,
+    }