add version endpoint

Author: ciur

papermerge/core/serializers/__init__.py

@@ -35,6 +35,8 @@
     TokenSerializer,
     CreateTokenSerializer
 )
+from .version import VersionSerializer
+
 
 __all__ = [
     'AutomateSerializer',
@@ -66,5 +68,6 @@
     'PagesMoveToFolderSerializer',
     'PagesMoveToDocumentSerializer',
     'TokenSerializer',
-    'InboxCountSerializer'
+    'InboxCountSerializer',
+    'VersionSerializer'
 ]

papermerge/core/serializers/version.py

@@ -0,0 +1,5 @@
+from rest_framework import serializers as rest_serializers
+
+
+class VersionSerializer(rest_serializers.Serializer):
+    version = rest_serializers.CharField(max_length=32)

papermerge/core/urls.py

@@ -112,5 +112,10 @@
         views.OCRView.as_view(),
         name='tasks-ocr'
     ),
+    path(
+        'version/',
+        views.VersionView.as_view(),
+        name='version'
+    ),
     re_path(r"^", include(router.urls)),
 ]

papermerge/core/version.py

@@ -0,0 +1 @@
+__version__ = "2.1.0a39"

papermerge/core/views/__init__.py

@@ -36,6 +36,7 @@
 from .login import LoginView
 from .logout import LogoutView, LogoutAllView
 from .tokens import TokensViewSet
+from .version import VersionView
 
 __all__ = [
     'AutomatesViewSet',
@@ -69,4 +70,5 @@
     'LogoutView',
     'LogoutAllView',
     'TokensViewSet',
+    'VersionView'
 ]

papermerge/core/views/version.py

@@ -0,0 +1,23 @@
+from rest_framework.renderers import JSONRenderer as rest_framework_JSONRenderer
+from rest_framework.parsers import JSONParser as rest_framework_JSONParser
+from rest_framework.generics import GenericAPIView
+from rest_framework.response import Response
+
+from papermerge.core.serializers import (
+    VersionSerializer
+)
+from papermerge.core.version import __version__ as THE_VERSION
+
+from .mixins import RequireAuthMixin
+
+
+class VersionView(RequireAuthMixin, GenericAPIView):
+    serializer_class = VersionSerializer
+    parser_classes = (rest_framework_JSONParser,)
+    renderer_classes = (rest_framework_JSONRenderer,)
+
+    def get(self, request):
+        """
+        Retrieves papermerge core module version
+        """
+        return Response(data={'version': THE_VERSION})

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "papermerge-core"
-version = "2.1.0a36"
+version = "2.1.0a39"
 description = "Open source document management system designed for scanned documents"
 authors = ["Eugen Ciur <eugen@papermerge.com>"]
 license = "Apache 2.0 License"