Convert the API URL system from an App based one

to a resource based one.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>

mayan/apps/checkouts/api_views.py

@@ -1,20 +1,13 @@
 from __future__ import absolute_import, unicode_literals
 
-import pytz
-
-from django.shortcuts import get_object_or_404
-
-from rest_framework import generics, status
-from rest_framework.response import Response
+from rest_framework import generics
 
 from acls.models import AccessControlList
-from documents.models import Document
 from documents.permissions import permission_document_view
 
 from .models import DocumentCheckout
 from .permissions import (
-    permission_document_checkout, permission_document_checkin,
-    permission_document_checkin_override
+    permission_document_checkin, permission_document_checkin_override
 )
 from .serializers import (
     DocumentCheckoutSerializer, NewDocumentCheckoutSerializer
@@ -47,12 +40,23 @@ class APICheckedoutDocumentListView(generics.ListCreateAPIView):
             APICheckedoutDocumentListView, self
         ).get(request, *args, **kwargs)
 
+    def get_serializer_context(self):
+        """
+        Extra context provided to the serializer class.
+        """
+        return {
+            'format': self.format_kwarg,
+            'request': self.request,
+            'view': self
+        }
+
+    '''
     def post(self, request, *args, **kwargs):
         """
         Checkout a document.
         """
 
-        serializer = self.get_serializer(data=request.DATA, files=request.FILES)
+        serializer = self.get_serializer(data=request.data, files=request.file)
 
         if serializer.is_valid():
             document = get_object_or_404(
@@ -83,6 +87,7 @@ class APICheckedoutDocumentListView(generics.ListCreateAPIView):
             return Response(status=status.HTTP_201_CREATED)
 
         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
+    '''
 
 
 class APICheckedoutDocumentView(generics.RetrieveDestroyAPIView):

mayan/apps/checkouts/apps.py

@@ -57,7 +57,10 @@ class CheckoutsApp(MayanAppConfig):
 
         Document.add_to_class(
             'check_in',
-            lambda document, user=None: DocumentCheckout.objects.check_in_document(document, user)
+            lambda document,
+            user=None: DocumentCheckout.objects.check_in_document(
+                document, user
+            )
         )
         Document.add_to_class(
             'checkout_info',

mayan/apps/checkouts/managers.py

@@ -19,7 +19,7 @@ logger = logging.getLogger(__name__)
 
 class DocumentCheckoutManager(models.Manager):
     def checkout_document(self, document, expiration_datetime, user, block_new_version=True):
-        self.create(
+        return self.create(
             document=document, expiration_datetime=expiration_datetime,
             user=user, block_new_version=block_new_version
         )

mayan/apps/checkouts/serializers.py

@@ -1,15 +1,19 @@
 from __future__ import unicode_literals
 
+from django.utils.translation import ugettext_lazy as _
+
 from rest_framework import serializers
 
+from acls.models import AccessControlList
+from documents.models import Document
+from documents.serializers import DocumentSerializer
+
 from .models import DocumentCheckout
+from .permissions import permission_document_checkout
 
 
 class DocumentCheckoutSerializer(serializers.ModelSerializer):
     def __init__(self, *args, **kwargs):
-        # Hide this import otherwise strange circular import error occur
-        from documents.serializers import DocumentSerializer
-
         super(DocumentCheckoutSerializer, self).__init__(*args, **kwargs)
         self.fields['document'] = DocumentSerializer()
 
@@ -17,7 +21,33 @@ class DocumentCheckoutSerializer(serializers.ModelSerializer):
         model = DocumentCheckout
 
 
-class NewDocumentCheckoutSerializer(serializers.Serializer):
-    document = serializers.IntegerField()
-    expiration_datetime = serializers.DateTimeField()
+class NewDocumentCheckoutSerializer(serializers.ModelSerializer):
     block_new_version = serializers.BooleanField()
+    document_pk = serializers.IntegerField(
+        help_text=_('Primary key of the document to be checked out.'),
+        write_only=True
+    )
+    expiration_datetime = serializers.DateTimeField()
+
+    class Meta:
+        fields = (
+            'block_new_version', 'document', 'document_pk',
+            'expiration_datetime', 'id'
+        )
+        model = DocumentCheckout
+        read_only_fields = ('document',)
+        write_only_fields = ('document_pk',)
+
+    def create(self, validated_data):
+        document = Document.objects.get(pk=validated_data.pop('document_pk'))
+
+        AccessControlList.objects.check_access(
+            permissions=permission_document_checkout,
+            user=self.context['request'].user, obj=document
+        )
+
+        validated_data['document'] = document
+        validated_data['user'] = self.context['request'].user
+        return super(NewDocumentCheckoutSerializer, self).create(
+            validated_data
+        )

mayan/apps/checkouts/tests/test_api.py

@@ -0,0 +1,75 @@
+from __future__ import unicode_literals
+
+import datetime
+
+from django.contrib.auth import get_user_model
+from django.core.urlresolvers import reverse
+from django.test import override_settings
+from django.utils.encoding import force_text
+from django.utils.timezone import now
+
+from rest_framework.test import APITestCase
+
+from documents.models import DocumentType
+from documents.tests import TEST_DOCUMENT_TYPE, TEST_SMALL_DOCUMENT_PATH
+from user_management.tests.literals import (
+    TEST_ADMIN_EMAIL, TEST_ADMIN_PASSWORD, TEST_ADMIN_USERNAME
+)
+
+from ..models import DocumentCheckout
+
+
+@override_settings(OCR_AUTO_OCR=False)
+class CheckoutAPITestCase(APITestCase):
+    def setUp(self):
+        super(CheckoutAPITestCase, self).setUp()
+
+        self.admin_user = get_user_model().objects.create_superuser(
+            username=TEST_ADMIN_USERNAME, email=TEST_ADMIN_EMAIL,
+            password=TEST_ADMIN_PASSWORD
+        )
+
+        self.client.login(
+            username=TEST_ADMIN_USERNAME, password=TEST_ADMIN_PASSWORD
+        )
+
+        self.document_type = DocumentType.objects.create(
+            label=TEST_DOCUMENT_TYPE
+        )
+
+        with open(TEST_SMALL_DOCUMENT_PATH) as file_object:
+            self.document = self.document_type.new_document(
+                file_object=file_object,
+            )
+
+    def tearDown(self):
+        self.document_type.delete()
+        super(CheckoutAPITestCase, self).tearDown()
+
+    def test_document_checkout_get_view(self):
+        expiration_datetime = now() + datetime.timedelta(days=1)
+
+        DocumentCheckout.objects.checkout_document(
+            document=self.document, expiration_datetime=expiration_datetime,
+            user=self.admin_user, block_new_version=True
+        )
+
+        response = self.client.get(reverse('rest_api:checkout-document-list'))
+
+        self.assertEqual(
+            response.data['results'][0]['document']['uuid'],
+            force_text(self.document.uuid)
+        )
+
+    def test_document_checkout_post_view(self):
+        response = self.client.post(
+            reverse('rest_api:checkout-document-list'), data={
+                'document_pk': self.document.pk,
+                'expiration_datetime': '2099-01-01T12:00'
+            }
+        )
+
+        self.assertEqual(response.status_code, 201)
+        self.assertEqual(
+            DocumentCheckout.objects.first().document, self.document
+        )

mayan/apps/checkouts/urls.py

@@ -26,11 +26,11 @@ urlpatterns = [
 
 api_urls = [
     url(
-        r'^documents/$', APICheckedoutDocumentListView.as_view(),
+        r'^checkouts/$', APICheckedoutDocumentListView.as_view(),
         name='checkout-document-list'
     ),
     url(
-        r'^documents/(?P<pk>[0-9]+)/$', APICheckedoutDocumentView.as_view(),
+        r'^checkouts/(?P<pk>[0-9]+)/$', APICheckedoutDocumentView.as_view(),
         name='checkedout-document-view'
     ),
 ]