refactor address

apps/collection/views/common.py

@@ -4,7 +4,7 @@ from rest_framework import permissions
 from collection import models
 from utils.pagination import ProjectPageNumberPagination
 from django.shortcuts import get_object_or_404
-from establishment.serializers import EstablishmentListSerializer
+from establishment.serializers import EstablishmentBaseSerializer
 from collection.serializers import common as serializers
 
 
@@ -56,7 +56,7 @@ class CollectionEstablishmentListView(CollectionListView):
     """Retrieve list of establishment for collection."""
     permission_classes = (permissions.AllowAny,)
     pagination_class = ProjectPageNumberPagination
-    serializer_class = EstablishmentListSerializer
+    serializer_class = EstablishmentBaseSerializer
     lookup_field = 'slug'
 
     def get_queryset(self):

apps/establishment/serializers/common.py

@@ -5,7 +5,7 @@ from comment import models as comment_models
 from comment.serializers import common as comment_serializers
 from establishment import models
 from favorites.models import Favorites
-from location.serializers import AddressSimpleSerializer, AddressSerializer
+from location.serializers import AddressBaseSerializer
 from main.models import MetaDataContent
 from main.serializers import MetaDataContentSerializer, AwardSerializer, CurrencySerializer
 from review import models as review_models
@@ -143,7 +143,7 @@ class EstablishmentBaseSerializer(ProjectModelSerializer):
 
     preview_image = serializers.URLField(source='preview_image_url')
     slug = serializers.SlugField(allow_blank=False, required=True, max_length=50)
-    address = AddressSerializer()
+    address = AddressBaseSerializer()
     tags = MetaDataContentSerializer(many=True)
     in_favorites = serializers.BooleanField(allow_null=True)
 
@@ -166,19 +166,7 @@ class EstablishmentBaseSerializer(ProjectModelSerializer):
         ]
 
 
-class EstablishmentListSerializer(EstablishmentBaseSerializer):
+class EstablishmentDetailSerializer(EstablishmentBaseSerializer):
-    """Serializer for Establishment model."""
-
-
-class EstablishmentAllListSerializer(EstablishmentListSerializer):
-    """ Serailizer for api/*/establishments """
-    address = AddressSimpleSerializer()
-
-    class Meta(EstablishmentListSerializer.Meta):
-        pass
-
-
-class EstablishmentDetailSerializer(EstablishmentListSerializer):
     """Serializer for Establishment model."""
 
     description_translated = TranslatedField()
@@ -197,10 +185,10 @@ class EstablishmentDetailSerializer(EstablishmentListSerializer):
     best_price_carte = serializers.DecimalField(max_digits=14, decimal_places=2, read_only=True)
     vintage_year = serializers.ReadOnlyField()
 
-    class Meta(EstablishmentListSerializer.Meta):
+    class Meta(EstablishmentBaseSerializer.Meta):
         """Meta class."""
 
-        fields = EstablishmentListSerializer.Meta.fields + [
+        fields = EstablishmentBaseSerializer.Meta.fields + [
             'description_translated',
             'image',
             'subtypes',

apps/establishment/views/web.py

@@ -28,7 +28,7 @@ class EstablishmentListView(EstablishmentMixinView, generics.ListAPIView):
     """Resource for getting a list of establishments."""
 
     filter_class = filters.EstablishmentFilter
-    serializer_class = serializers.EstablishmentAllListSerializer
+    serializer_class = serializers.EstablishmentBaseSerializer
 
     def get_queryset(self):
         """Overridden method 'get_queryset'."""
@@ -70,7 +70,8 @@ class EstablishmentRecentReviewListView(EstablishmentListView):
 
 class EstablishmentSimilarListView(EstablishmentListView):
     """Resource for getting a list of establishments."""
-    serializer_class = serializers.EstablishmentListSerializer
+
+    serializer_class = serializers.EstablishmentBaseSerializer
     pagination_class = EstablishmentPortionPagination
 
     def get_queryset(self):
@@ -96,6 +97,7 @@ class EstablishmentCommentCreateView(generics.CreateAPIView):
 
 class EstablishmentCommentListView(generics.ListAPIView):
     """View for return list of establishment comments."""
+
     permission_classes = (permissions.AllowAny,)
     serializer_class = serializers.EstablishmentCommentCreateSerializer
 
@@ -153,11 +155,13 @@ class EstablishmentFavoritesCreateDestroyView(generics.CreateAPIView, generics.D
 
 class EstablishmentNearestRetrieveView(EstablishmentListView, generics.ListAPIView):
     """Resource for getting list of nearest establishments."""
-    serializer_class = serializers.EstablishmentListSerializer
+
+    serializer_class = serializers.EstablishmentBaseSerializer
     filter_class = filters.EstablishmentFilter
 
     def get_queryset(self):
         """Overridden method 'get_queryset'."""
+        # todo: latitude and longitude
         lat = self.request.query_params.get('lat')
         lon = self.request.query_params.get('lon')
         radius = self.request.query_params.get('radius')

apps/favorites/views.py

@@ -1,13 +1,13 @@
 """Views for app favorites."""
 from rest_framework import generics
-
 from establishment.models import Establishment
-from establishment.serializers import EstablishmentListSerializer
+from establishment.serializers import EstablishmentBaseSerializer
 from .models import Favorites
 
 
 class FavoritesBaseView(generics.GenericAPIView):
     """Base view for Favorites."""
+
     def get_queryset(self):
         """Override get_queryset method."""
         return Favorites.objects.by_user(self.request.user)
@@ -15,7 +15,8 @@ class FavoritesBaseView(generics.GenericAPIView):
 
 class FavoritesEstablishmentListView(generics.ListAPIView):
     """List views for favorites"""
-    serializer_class = EstablishmentListSerializer
+
+    serializer_class = EstablishmentBaseSerializer
 
     def get_queryset(self):
         """Override get_queryset method"""

apps/location/models.py

@@ -71,6 +71,7 @@ class City(models.Model):
 
 
 class Address(models.Model):
+
     """Address model."""
     city = models.ForeignKey(City, verbose_name=_('city'), on_delete=models.CASCADE)
     street_name_1 = models.CharField(
@@ -98,11 +99,11 @@ class Address(models.Model):
 
     @property
     def latitude(self):
-        return self.coordinates.y
+        return self.coordinates.y if self.coordinates else float(0)
 
     @property
     def longitude(self):
-        return self.coordinates.x
+        return self.coordinates.x if self.coordinates else float(0)
 
     @property
     def location_field_indexing(self):

apps/location/serializers/back.py

@@ -1,11 +1,8 @@
-from django.contrib.gis.geos import Point
-from rest_framework import serializers
-
 from location import models
 from location.serializers import common
 
 
-class AddressCreateSerializer(common.AddressSerializer):
+class AddressCreateSerializer(common.AddressDetailSerializer):
     """Address create serializer."""
 
 

apps/location/serializers/common.py

@@ -1,5 +1,6 @@
 """Location app common serializers."""
 from django.contrib.gis.geos import Point
+from django.utils.translation import ugettext_lazy as _
 from rest_framework import serializers
 from location import models
 from utils.serializers import TranslatedField
@@ -83,55 +84,18 @@ class CitySerializer(serializers.ModelSerializer):
         ]
 
 
-class AddressSerializer(serializers.ModelSerializer):
+class AddressBaseSerializer(serializers.ModelSerializer):
-    """Address serializer."""
-
-    city_id = serializers.PrimaryKeyRelatedField(
-        source='city',
-        queryset=models.City.objects.all())
-    city = CitySerializer(read_only=True)
-    geo_lon = serializers.FloatField(allow_null=True)
-    geo_lat = serializers.FloatField(allow_null=True)
-
-    class Meta:
-        model = models.Address
-        fields = [
-            'id',
-            'city_id',
-            'city',
-            'street_name_1',
-            'street_name_2',
-            'number',
-            'postal_code',
-            'geo_lon',
-            'geo_lat',
-        ]
-
-    def validate(self, attrs):
-        # if geo_lat and geo_lon was sent
-        geo_lat = attrs.pop('geo_lat') if 'geo_lat' in attrs else None
-        geo_lon = attrs.pop('geo_lon') if 'geo_lon' in attrs else None
-
-        if geo_lat and geo_lon:
-            # Point(longitude, latitude)
-            attrs['coordinates'] = Point(geo_lat, geo_lon)
-        return attrs
-
-    def to_representation(self, instance):
-        """Override to_representation method"""
-        if instance.coordinates and isinstance(instance.coordinates, Point):
-            # Point(longitude, latitude)
-            setattr(instance, 'geo_lat', instance.coordinates.x)
-            setattr(instance, 'geo_lon', instance.coordinates.y)
-        else:
-            setattr(instance, 'geo_lat', float(0))
-            setattr(instance, 'geo_lon', float(0))
-        return super().to_representation(instance)
-
-
-class AddressSimpleSerializer(serializers.ModelSerializer):
     """Serializer for address obj in related objects."""
 
+    latitude = serializers.FloatField(allow_null=True)
+    longitude = serializers.FloatField(allow_null=True)
+
+    # todo: remove this fields (backward compatibility)
+    geo_lon = serializers.FloatField(source='longitude', allow_null=True,
+                                     read_only=True)
+    geo_lat = serializers.FloatField(source='latitude', allow_null=True,
+                                     read_only=True)
+
     class Meta:
         """Meta class."""
 
@@ -142,4 +106,45 @@ class AddressSimpleSerializer(serializers.ModelSerializer):
             'street_name_2',
             'number',
             'postal_code',
+            'latitude',
+            'longitude',
+
+            # todo: remove this fields (backward compatibility)
+            'geo_lon',
+            'geo_lat',
+        )
+
+    def validate_latitude(self, value):
+        if -90 <= value <= 90:
+            return value
+        raise serializers.ValidationError(_('Invalid value'))
+
+    def validate_longitude(self, value):
+        if -180 <= value <= 180:
+            return value
+        raise serializers.ValidationError(_('Invalid value'))
+
+    def validate(self, attrs):
+        # validate coordinates
+        latitude = attrs.pop('latitude', None)
+        longitude = attrs.pop('longitude', None)
+        if latitude is not None and longitude is not None:
+            attrs['coordinates'] = Point(longitude, latitude)
+        return attrs
+
+
+class AddressDetailSerializer(AddressBaseSerializer):
+    """Address serializer."""
+
+    city_id = serializers.PrimaryKeyRelatedField(
+        source='city', write_only=True,
+        queryset=models.City.objects.all())
+    city = CitySerializer(read_only=True)
+
+    class Meta(AddressBaseSerializer.Meta):
+        """Meta class."""
+
+        fields = AddressBaseSerializer.Meta.fields + (
+            'city_id',
+            'city',
         )

apps/location/views/back.py

@@ -1,6 +1,5 @@
 """Location app views."""
 from rest_framework import generics
-from rest_framework import permissions
 
 from location import models, serializers
 from location.views import common
@@ -9,13 +8,13 @@ from location.views import common
 # Address
 class AddressListCreateView(common.AddressViewMixin, generics.ListCreateAPIView):
     """Create view for model Address."""
-    serializer_class = serializers.AddressSerializer
+    serializer_class = serializers.AddressDetailSerializer
     queryset = models.Address.objects.all()
 
 
 class AddressRUDView(common.AddressViewMixin, generics.RetrieveUpdateDestroyAPIView):
     """RUD view for model Address."""
-    serializer_class = serializers.AddressSerializer
+    serializer_class = serializers.AddressDetailSerializer
     queryset = models.Address.objects.all()
 
 

apps/location/views/common.py

@@ -100,17 +100,17 @@ class CityUpdateView(CityViewMixin, generics.UpdateAPIView):
 # Address
 class AddressCreateView(AddressViewMixin, generics.CreateAPIView):
     """Create view for model Address"""
-    serializer_class = serializers.AddressSerializer
+    serializer_class = serializers.AddressDetailSerializer
 
 
 class AddressRetrieveView(AddressViewMixin, generics.RetrieveAPIView):
     """Retrieve view for model Address"""
-    serializer_class = serializers.AddressSerializer
+    serializer_class = serializers.AddressDetailSerializer
 
 
 class AddressListView(AddressViewMixin, generics.ListAPIView):
     """List view for model Address"""
     permission_classes = (permissions.AllowAny, )
-    serializer_class = serializers.AddressSerializer
+    serializer_class = serializers.AddressDetailSerializer