Refactor JSON Validation

apps/establishment/serializers/back.py

@@ -8,7 +8,6 @@ from establishment.serializers import (
 from utils.decorators import with_base_attributes
 
 from main.models import Currency
-from utils.serializers import TJSONSerializer
 
 
 class EstablishmentListCreateSerializer(EstablishmentBaseSerializer):
@@ -89,13 +88,15 @@ class SocialNetworkSerializers(serializers.ModelSerializer):
 
 class PlatesSerializers(PlateSerializer):
     """Social network serializers."""
-    name = TJSONSerializer
+
     currency_id = serializers.PrimaryKeyRelatedField(
         source='currency',
         queryset=Currency.objects.all(), write_only=True
     )
 
     class Meta:
+        """Meta class."""
+
         model = models.Plate
         fields = PlateSerializer.Meta.fields + [
             'name',

apps/establishment/serializers/common.py

@@ -1,6 +1,6 @@
 """Establishment serializers."""
-from rest_framework import serializers
 from django.utils.translation import ugettext_lazy as _
+from rest_framework import serializers
 from comment import models as comment_models
 from comment.serializers import common as comment_serializers
 from establishment import models
@@ -11,8 +11,7 @@ from main.serializers import MetaDataContentSerializer, AwardSerializer, Currenc
 from review import models as review_models
 from timetable.serialziers import ScheduleRUDSerializer
 from utils import exceptions as utils_exceptions
-from utils.serializers import TranslatedField
-from utils.serializers import TJSONSerializer
+from utils.serializers import TranslatedField, ProjectModelSerializer
 
 
 class ContactPhonesSerializer(serializers.ModelSerializer):
@@ -44,9 +43,9 @@ class SocialNetworkRelatedSerializers(serializers.ModelSerializer):
         ]
 
 
-class PlateSerializer(serializers.ModelSerializer):
+class PlateSerializer(ProjectModelSerializer):
 
-    name_translated = serializers.CharField(allow_null=True, read_only=True)
+    name_translated = TranslatedField()
     currency = CurrencySerializer(read_only=True)
 
     class Meta:
@@ -59,9 +58,8 @@ class PlateSerializer(serializers.ModelSerializer):
         ]
 
 
-class MenuSerializers(serializers.ModelSerializer):
+class MenuSerializers(ProjectModelSerializer):
     plates = PlateSerializer(read_only=True, many=True, source='plate_set')
-    category = TJSONSerializer()
     category_translated = serializers.CharField(read_only=True)
 
     class Meta:
@@ -75,9 +73,8 @@ class MenuSerializers(serializers.ModelSerializer):
         ]
 
 
-class MenuRUDSerializers(serializers.ModelSerializer, ):
+class MenuRUDSerializers(ProjectModelSerializer):
     plates = PlateSerializer(read_only=True, many=True, source='plate_set')
-    category = TJSONSerializer()
 
     class Meta:
         model = models.Menu
@@ -141,7 +138,7 @@ class EstablishmentEmployeeSerializer(serializers.ModelSerializer):
         fields = ('id', 'name', 'position_translated', 'awards', 'priority')
 
 
-class EstablishmentBaseSerializer(serializers.ModelSerializer):
+class EstablishmentBaseSerializer(ProjectModelSerializer):
     """Base serializer for Establishment model."""
 
     preview_image = serializers.URLField(source='preview_image_url')
@@ -233,16 +230,6 @@ class EstablishmentDetailSerializer(EstablishmentListSerializer):
             'vintage_year',
         ]
 
-    # def get_in_favorites(self, obj):
-    #     """Get in_favorites status flag"""
-    #     user = self.context.get('request').user
-    #     if user.is_authenticated:
-    #         return obj.id in user.favorites.by_content_type(app_label='establishment',
-    #                                                         model='establishment')\
-    #                                        .values_list('object_id', flat=True)
-    #     else:
-    #         return False
-
 
 class EstablishmentCommentCreateSerializer(comment_serializers.CommentSerializer):
     """Create comment serializer"""

apps/news/serializers.py

@@ -1,11 +1,12 @@
 """News app common serializers."""
 from rest_framework import serializers
+from account.serializers.common import UserSerializer
 from location import models as location_models
 from location.serializers import CountrySimpleSerializer
 from main.serializers import MetaDataContentSerializer
 from news import models
-from utils.serializers import TranslatedField
-from account.serializers.common import UserSerializer
+from utils.serializers import TranslatedField, ProjectModelSerializer
+
 
 class NewsTypeSerializer(serializers.ModelSerializer):
     """News type serializer."""
@@ -17,7 +18,7 @@ class NewsTypeSerializer(serializers.ModelSerializer):
         fields = ('id', 'name')
 
 
-class NewsBaseSerializer(serializers.ModelSerializer):
+class NewsBaseSerializer(ProjectModelSerializer):
     """Base serializer for News model."""
 
     # read only fields
@@ -50,7 +51,8 @@ class NewsDetailSerializer(NewsBaseSerializer):
 
     description_translated = TranslatedField()
     country = CountrySimpleSerializer(read_only=True)
-    author = UserSerializer(source='created_by')
+    # todo: check the data redundancy
+    author = UserSerializer(source='created_by', read_only=True)
     state_display = serializers.CharField(source='get_state_display',
                                           read_only=True)
 

apps/news/views.py

@@ -20,11 +20,13 @@ class NewsMixinView:
 
 class NewsListView(NewsMixinView, generics.ListAPIView):
     """News list view."""
+
     filter_class = filters.NewsListFilterSet
 
 
 class NewsDetailView(NewsMixinView, generics.RetrieveAPIView):
     """News detail view."""
+
     lookup_field = 'slug'
     serializer_class = serializers.NewsDetailSerializer
 
@@ -54,6 +56,7 @@ class NewsBackOfficeLCView(NewsBackOfficeMixinView,
     create_serializers_class = serializers.NewsBackOfficeDetailSerializer
 
     def get_serializer_class(self):
+        """Override serializer class."""
         if self.request.method == 'POST':
             return self.create_serializers_class
         return super().get_serializer_class()

apps/utils/serializers.py

@@ -1,7 +1,7 @@
 """Utils app serializer."""
-from rest_framework import serializers
-from utils.models import PlatformMixin
 from django.core import exceptions
+from rest_framework import serializers
+from utils import models
 from translation.models import Language
 
 
@@ -11,8 +11,8 @@ class EmptySerializer(serializers.Serializer):
 
 class SourceSerializerMixin(serializers.Serializer):
     """Base authorization serializer mixin"""
-    source = serializers.ChoiceField(choices=PlatformMixin.SOURCES,
-                                     default=PlatformMixin.WEB,
+    source = serializers.ChoiceField(choices=models.PlatformMixin.SOURCES,
+                                     default=models.PlatformMixin.WEB,
                                      write_only=True)
 
 
@@ -25,18 +25,16 @@ class TranslatedField(serializers.CharField):
                          read_only=read_only, **kwargs)
 
 
+# todo: view validation in more detail
 def validate_tjson(value):
-
     if not isinstance(value, dict):
         raise exceptions.ValidationError(
             'invalid_json',
             code='invalid_json',
             params={'value': value},
         )
-
     lang_count = Language.objects.filter(locale__in=value.keys()).count()
-
-    if lang_count == 0:
+    if lang_count != len(value.keys()):
         raise exceptions.ValidationError(
             'invalid_translated_keys',
             code='invalid_translated_keys',
@@ -44,5 +42,13 @@ def validate_tjson(value):
         )
 
 
-class TJSONSerializer(serializers.JSONField):
+class TJSONField(serializers.JSONField):
+    """Custom serializer's JSONField for model's TJSONField."""
+
     validators = [validate_tjson]
+
+
+class ProjectModelSerializer(serializers.ModelSerializer):
+    """Overrided ModelSerializer."""
+
+    serializers.ModelSerializer.serializer_field_mapping[models.TJSONField] = TJSONField