django-pfx 1.3.dev20__tar.gz → 1.4.dev4__tar.gz

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.3.dev20
+Version: 1.4.dev4
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.3.dev20
+Version: 1.4.dev4
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/django_pfx.egg-info/SOURCES.txt

@@ -113,6 +113,7 @@ tests/tests/basic_api_errors.py
 tests/tests/basic_api_test.py
 tests/tests/test_api_doc.py
 tests/tests/test_auth_api.py
+tests/tests/test_body_mixin.py
 tests/tests/test_cache.py
 tests/tests/test_client.py
 tests/tests/test_fields.py

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/doc/source/pfx_views.md

@@ -300,3 +300,47 @@ the list of available fields to order the list.
 In a future version, these services should return a JSON OpenAPI structure. The list
 of orderable fields is resource-intensive to compute and should be removed and moved
 in the generated API doc.
+
+## Custom service with body validation
+
+You can define a custom service and load body data into a unmanaged model if you view
+inherits from `BodyMixin`.
+
+Then you can add custom validators on you model.
+
+Define an unmanaged model (you can use fields validators or extend the `clean` method
+to customize validation):
+```python
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+from pfx.pfxcore.models import PFXModelMixin
+
+
+class CustomModel(PFXModelMixin, models.Model):
+    pks = models.IntegerField(_("An integer"))
+
+    class Meta:
+        managed = False
+```
+
+Then you can load the body in a `CustomModel` instance in a service, method `body_to_model`
+will call `full_clean` on model instance and raise a `ModelValidationAPIError` if
+there is invalid values (`ModelValidationAPIError` will be automatically converted
+into a `422/JSONResponse` including fields and/or global errors):
+```python
+from pfx.pfxcore.decorator import rest_api, rest_view
+from pfx.pfxcore.views import BodyMixin
+
+from .models import CustomModel
+
+
+@rest_view("/my-service")
+class MyServiceView(BodyMixin):
+    @rest_api("", method="put")
+    def put(self, *args, **kwargs):
+        custom = self.body_to_model(CustomModel)
+        # …
+```
+
+See {func}`pfx.pfxcore.views.BodyMixin.body_to_model` for method documentation.

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/pfx/pfxcore/views/rest_views.py

@@ -11,7 +11,7 @@ from django.core.exceptions import (
     ValidationError,
 )
 from django.db import IntegrityError, transaction
-from django.db.models import ForeignKey, Q
+from django.db.models import ForeignKey, Model, Q
 from django.shortcuts import redirect
 from django.urls import path
 from django.utils.translation import gettext_lazy as _
@@ -26,6 +26,7 @@ from pfx.pfxcore.exceptions import (
     APIError,
     ForbiddenError,
     JsonErrorAPIError,
+    ModelValidationAPIError,
     NotFoundError,
     UnauthorizedError,
 )
@@ -421,6 +422,22 @@ class BodyMixin:
         except JSONDecodeError as e:
             raise JsonErrorAPIError(e)
 
+    def body_to_model(self, model: Model, validate=True, **kwargs):
+        """Return a new model instance built with request body.
+
+        :param model: The model to instantiate
+        :param validate: Activate validation
+        :param \\**kwargs: The optional arguments for `full_clean`
+        :rtype: :class:`django.db.models.Model`
+        """
+        obj = model(**self.deserialize_body())
+        if validate:
+            try:
+                obj.full_clean(**kwargs)
+            except ValidationError as e:
+                raise ModelValidationAPIError(e)
+        return obj
+
 
 class ModelBodyMixin(BodyMixin, ModelMixin):
     """Extension mixin to process object in body."""

{django-pfx-1.3.dev20 → django-pfx-1.4.dev4}/tests/tests/__init__.py

@@ -2,6 +2,7 @@ from .basic_api_errors import BasicAPIErrorTest
 from .basic_api_test import BasicAPITest
 from .test_api_doc import ApiDocTest
 from .test_auth_api import AuthAPITest
+from .test_body_mixin import TestBodyMixin
 from .test_cache import TestCache
 from .test_client import TestApiClient
 from .test_fields import FieldsTest

django-pfx-1.4.dev4/tests/tests/test_body_mixin.py

@@ -0,0 +1,48 @@
+import json
+from unittest.mock import MagicMock
+
+from django.db import models
+from django.test import TestCase
+
+from pfx.pfxcore.exceptions import ModelValidationAPIError
+from pfx.pfxcore.models import PFXModelMixin
+from pfx.pfxcore.test import TestAssertMixin
+from pfx.pfxcore.views import BodyMixin
+
+
+class CustomModel(PFXModelMixin, models.Model):
+    value = models.IntegerField("An integer")
+
+    class Meta:
+        managed = False
+
+
+class CustomView(BodyMixin):
+    def __init__(self, **body):
+        super().__init__()
+        self.request = MagicMock()
+        self.request.body = json.dumps(body)
+
+
+class TestBodyMixin(TestAssertMixin, TestCase):
+    def test_body_to_model(self):
+        view = CustomView(value=7)
+        custom = view.body_to_model(CustomModel)
+
+        self.assertIsInstance(custom, CustomModel)
+        self.assertEqual(custom.value, 7)
+
+    def test_body_to_model_validation(self):
+        view = CustomView()
+        with self.assertRaises(ModelValidationAPIError) as cm:
+            view.body_to_model(CustomModel)
+        self.assertJE(
+            cm.exception.data.message_dict, "value",
+            ["This field cannot be null."])
+
+    def test_body_to_model_disable_validation(self):
+        view = CustomView()
+        custom = view.body_to_model(CustomModel, validate=False)
+
+        self.assertIsInstance(custom, CustomModel)
+        self.assertEqual(custom.value, None)