Fixed related field validation and serialization

Author: Dmitry Berezovsky

README.rst README.MD

@@ -1,23 +1,25 @@
-==================
 Django API commons
 ==================
 
 Common library for building django based web api applications
 
-``````````````````````
-Development procedures
-``````````````````````
+
+## Development procedures
 
 Ensure that all python sources contain license notice:
-::
+
+```
     ./development/copyright-update
+```
 
 Building distribution package:
 
-::
+```
     ./build.sh clean build
+```
 
 Uploading package to PyPi:
 
-::
-    ./build.sh publish
+```
+    ./build.sh publish
+```

api_commons/dto.py

@@ -23,6 +23,7 @@
 
 from collections import Iterable
 from django.conf import settings
+from rest_framework.exceptions import ValidationError
 from rest_framework.fields import empty, Field
 from rest_framework.serializers import Serializer
 
@@ -112,13 +113,22 @@ def __init__(self, dto_class, required: bool = None, default=empty, initial=empt
         self.dto_class = dto_class
 
     def to_representation(self, instance: BaseDto):
-        return instance.to_dict()
+        if isinstance(instance, BaseDto):
+            return instance.to_dict()
+        elif isinstance(instance, dict):
+            return instance
+        else:
+            raise ValueError("Unexpected value passed to to_representation method. " + str(instance))
 
     def to_internal_value(self, data: dict):
         dto = self.dto_class.from_dict(data)
         dto.is_valid()
         return dto
 
+    def run_validators(self, value):
+        if not value.is_valid():
+            raise ValidationError(value.errors)
+
 
 class PaginationOptions(object):
     """ Pagination options class, has offset and limit parameters."""

example_service/api/hierarchy/__init__.py

@@ -0,0 +1,20 @@
+from django.http import HttpRequest
+
+from api_commons.decorator import inject_dto
+from example_service.api import errors
+from api_commons.common import ApiResponse
+from example_service.api.calculator.dto import CalculationRequestDto, CalculationResultDto
+from example_service.api.common import ExampleController
+from example_service.api.hierarchy.dto import ParentDto
+from example_service.core.services import CalculationService
+
+
+class HierarchyController(ExampleController):
+    def get(self, request: HttpRequest):
+        return ApiResponse.not_found(errors.NOT_SUPPORTED)
+
+    @inject_dto(ParentDto)
+    def post(self, request: HttpRequest, dto: ParentDto):
+        if not dto.is_valid():
+            return ApiResponse.bad_request(dto)
+        return ApiResponse.success(dto)

example_service/api/hierarchy/controllers.py

@@ -0,0 +1,19 @@
+from rest_framework import serializers
+
+from api_commons.dto import BaseDto, RelatedDtoField
+
+
+def child_validator(value):
+    try:
+        int(value)
+    except ValueError:
+        raise serializers.ValidationError("Should be integer")
+
+
+class ChildDto(BaseDto):
+    child_param_1 = serializers.CharField(required=True, validators=[child_validator])
+
+
+class ParentDto(BaseDto):
+    param_1 = serializers.CharField(required=True, validators=[child_validator])
+    child = RelatedDtoField(ChildDto, required=False)

example_service/api/hierarchy/dto.py

@@ -0,0 +1,7 @@
+from django.conf.urls import url
+
+from .controllers import *
+
+urlpatterns = [
+    url(r'^$', HierarchyController.as_view()),
+]

example_service/api/hierarchy/urls.py

@@ -5,6 +5,7 @@
 urlpatterns = [
     url(r'^ping/?', include('api.ping.urls')),
     url(r'^calc/?', include('api.calculator.urls')),
+    url(r'^hierarchy/?', include('api.hierarchy.urls')),
 ]
 
 handler404 = api_commons.common.error_404_handler

example_service/api/urls.py

@@ -7,12 +7,13 @@
 from codecs import open
 from os import path
 
-version = "1.0.4"
+version = "1.0.5"
 root_dir = path.abspath(path.dirname(__file__))
 src_dir = root_dir
 # Get the long description from the README file
-with open(path.join(root_dir, 'README.rst'), encoding='utf-8') as f:
-    long_description = f.read()
+with open(path.join(root_dir, 'README.MD'), encoding='utf-8') as f:
+    # long_description = f.read()
+    long_description = '''Common library for building django based web api applications'''
 
 setup(
     name='django_api_commons',
@@ -21,6 +22,7 @@
     version=version,
     description='Common library for building django based web api applications',
     long_description=long_description,
+    long_description_content_type="text/markdown",
     url='https://github.com/Logicify/python-api',
     keywords='django webservices api rest djangorestframework json jsonapi',