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/ocr/api_views.py

@@ -3,6 +3,8 @@ from __future__ import absolute_import, unicode_literals
 from rest_framework import generics, status
 from rest_framework.response import Response
 
+from django.shortcuts import get_object_or_404
+
 from documents.models import Document, DocumentPage, DocumentVersion
 from rest_api.permissions import MayanPermission
 
@@ -26,10 +28,6 @@ class APIDocumentOCRView(generics.GenericAPIView):
         Submit a document for OCR.
         ---
         omit_serializer: true
-        parameters:
-            - name: pk
-              paramType: path
-              type: number
         responseMessages:
             - code: 202
               message: Accepted
@@ -40,12 +38,19 @@ class APIDocumentOCRView(generics.GenericAPIView):
 
 
 class APIDocumentVersionOCRView(generics.GenericAPIView):
+    lookup_url_kwarg = 'version_pk'
     mayan_object_permissions = {
         'POST': (permission_ocr_document,)
     }
     permission_classes = (MayanPermission,)
     queryset = DocumentVersion.objects.all()
 
+    def get_document(self):
+        return get_object_or_404(Document, pk=self.kwargs['document_pk'])
+
+    def get_queryset(self):
+        return self.get_document().versions.all()
+
     def get_serializer_class(self):
         return None
 
@@ -54,10 +59,6 @@ class APIDocumentVersionOCRView(generics.GenericAPIView):
         Submit a document version for OCR.
         ---
         omit_serializer: true
-        parameters:
-            - name: pk
-              paramType: path
-              type: number
         responseMessages:
             - code: 202
               message: Accepted
@@ -70,20 +71,25 @@ class APIDocumentVersionOCRView(generics.GenericAPIView):
 class APIDocumentPageContentView(generics.RetrieveAPIView):
     """
     Returns the OCR content of the selected document page.
-    ---
-    GET:
-        parameters:
-            - name: pk
-              paramType: path
-              type: number
     """
 
+    lookup_url_kwarg = 'page_pk'
     mayan_object_permissions = {
         'GET': (permission_ocr_content_view,),
     }
     permission_classes = (MayanPermission,)
     serializer_class = DocumentPageContentSerializer
-    queryset = DocumentPage.objects.all()
+
+    def get_document(self):
+        return get_object_or_404(Document, pk=self.kwargs['document_pk'])
+
+    def get_document_version(self):
+        return get_object_or_404(
+            self.get_document().versions.all(), pk=self.kwargs['version_pk']
+        )
+
+    def get_queryset(self):
+        return self.get_document_version().pages.all()
 
     def retrieve(self, request, *args, **kwargs):
         instance = self.get_object()

mayan/apps/ocr/tests/test_api.py

@@ -63,7 +63,9 @@ class OCRAPITestCase(BaseAPITestCase):
         response = self.client.post(
             reverse(
                 'rest_api:document-version-ocr-submit-view',
-                args=(self.document.latest_version.pk,)
+                args=(
+                    self.document.pk, self.document.latest_version.pk,
+                )
             )
         )
 
@@ -77,7 +79,10 @@ class OCRAPITestCase(BaseAPITestCase):
         response = self.client.get(
             reverse(
                 'rest_api:document-page-content-view',
-                args=(self.document.latest_version.pages.first().pk,)
+                args=(
+                    self.document.pk, self.document.latest_version.pk,
+                    self.document.latest_version.pages.first().pk,
+                )
             ),
         )
 

mayan/apps/ocr/urls.py

@@ -43,16 +43,16 @@ urlpatterns = [
 
 api_urls = [
     url(
-        r'^document/(?P<pk>\d+)/submit/$', APIDocumentOCRView.as_view(),
+        r'^documents/(?P<pk>\d+)/ocr/$', APIDocumentOCRView.as_view(),
         name='document-ocr-submit-view'
     ),
     url(
-        r'^document_version/(?P<pk>\d+)/submit/$',
+        r'^documents/(?P<document_pk>\d+)/versions/(?P<version_pk>\d+)/ocr/$',
         APIDocumentVersionOCRView.as_view(),
         name='document-version-ocr-submit-view'
     ),
     url(
-        r'^page/(?P<pk>\d+)/content/$', APIDocumentPageContentView.as_view(),
+        r'^documents/(?P<document_pk>\d+)/versions/(?P<version_pk>\d+)/pages/(?P<page_pk>\d+)/ocr/$', APIDocumentPageContentView.as_view(),
         name='document-page-content-view'
     ),
 ]