Merge branch 'versionning_and_model_update' into 'master'

Versionning and moderation update

See merge request chehabfl/outgoing_rex!20

backend/admin.py

@@ -18,7 +18,9 @@ from backend.models.location import CityTransport
 from backend.models.location import CityTourism
 from backend.models.location import CityOtherStuff
 
-from backend.models.university import University, Campus, UniversityScholarship
+from backend.models.university import University
+from backend.models.university import Campus
+from backend.models.university import UniversityScholarship
 
 from backend.models.university import UniversityInfo
 from backend.models.university import UniversitySemestersDates
@@ -53,6 +55,7 @@ CLASSIC_MODELS = [
     Country,
     City,
     Currency,
+    University,
     Department,
     Offer,
     Semester,
@@ -66,7 +69,6 @@ CLASSIC_MODELS = [
 ]
 
 VERSIONNED_MODELS = [
-    University,
     Campus,
     UniversityScholarship,
     UniversityInfo,
@@ -102,3 +104,6 @@ for model in CLASSIC_MODELS:
 
 for model in VERSIONNED_MODELS:
     admin.site.register(model, CompareVersionAdmin)
+    if (model.get_serializer().Meta.model != model):
+        raise Exception(
+            "Get_serializer configuration incorrect in", str(model))

backend/migrations/0021_auto_20180828_2128.py

+# Generated by Django 2.0.3 on 2018-08-28 19:28
+
+from django.conf import settings
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('backend', '0020_auto_20180827_1026'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='ForTestingVersionning',
+            new_name='ForTestingVersioning',
+        ),
+    ]

backend/models/location/cityBasicModules.py

@@ -11,6 +11,10 @@ class CityTransport(BasicModule):
     city = models.OneToOneField(
         City, on_delete=models.CASCADE, related_name='city_transport', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CityTransportSerializer
+
 
 class CityTransportSerializer(BasicModuleSerializer):
     class Meta:
@@ -36,6 +40,10 @@ class CityTourism(BasicModule):
     city = models.OneToOneField(
         City, on_delete=models.CASCADE, related_name='city_tourism', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CityTourismSerializer
+
 
 class CityTourismSerializer(BasicModuleSerializer):
     class Meta:
@@ -61,6 +69,10 @@ class CityOtherStuff(BasicModule):
     city = models.OneToOneField(
         City, on_delete=models.CASCADE, related_name='city_other_stuff', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CityOtherStuffSerializer
+
 
 class CityOtherStuffSerializer(BasicModuleSerializer):
     class Meta:

backend/models/location/cityPhoto.py

@@ -10,6 +10,10 @@ class CityPhoto(Photo):
         on_delete=models.CASCADE,
         related_name='city_photos')
 
+    @classmethod
+    def get_serializer(cls):
+        return CityPhotoSerializer
+
     class Meta:
         unique_together = ('city', 'photo')
 

backend/models/location/countryBasicModules.py

@@ -11,6 +11,10 @@ class CountryVisaAdministrative(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_visa_administrative', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryVisaAdministrativeSerializer
+
 
 class CountryVisaAdministrativeSerializer(BasicModuleSerializer):
     class Meta:
@@ -37,6 +41,10 @@ class CountryHealthInsurance(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_health_insurances', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryHealthInsuranceSerializer
+
 
 class CountryHealthInsuranceSerializer(BasicModuleSerializer):
     class Meta:
@@ -62,6 +70,10 @@ class CountryOtherInsurance(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_other_insurances', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryOtherInsuranceSerializer
+
 
 class CountryOtherInsuranceSerializer(BasicModuleSerializer):
     class Meta:
@@ -86,6 +98,10 @@ class CountryCulture(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_culture', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryCultureSerializer
+
 
 class CountryCultureSerializer(BasicModuleSerializer):
     class Meta:
@@ -110,6 +126,10 @@ class CountryTransport(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_transport', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryTransportSerializer
+
 
 class CountryTransportSerializer(BasicModuleSerializer):
     class Meta:
@@ -135,6 +155,10 @@ class CountryTourism(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_tourism', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryTourismSerializer
+
 
 class CountryTourismSerializer(BasicModuleSerializer):
     class Meta:
@@ -160,6 +184,10 @@ class CountryOtherStuff(BasicModule):
     country = models.OneToOneField(
         Country, on_delete=models.CASCADE, related_name='country_other_stuff', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryOtherStuffSerializer
+
 
 class CountryOtherStuffSerializer(BasicModuleSerializer):
     class Meta:

backend/models/location/countryDri.py

@@ -7,6 +7,10 @@ class CountryDri(DriRestrictedModule):
     country = models.ManyToManyField(
         Country, related_name="country_dri")
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryDriSerializer
+
 
 class CountryDriSerializer(DriRestrictedModuleSerializer):
 

backend/models/location/countryPhoto.py

@@ -10,6 +10,10 @@ class CountryPhoto(Photo):
         on_delete=models.CASCADE,
         related_name='country_photos')
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryPhotoSerializer
+
     class Meta:
         unique_together = ('country', 'photo')
 

backend/models/location/countryScholarship.py

@@ -7,6 +7,10 @@ class CountryScholarship(Scholarship):
     country = models.ManyToManyField(
         Country, related_name="country_scholarhip")
 
+    @classmethod
+    def get_serializer(cls):
+        return CountryScholarshipSerializer
+
 
 class CountryScholarshipSerializer(ScholarshipSerializer):
 

backend/models/my_model/__init__.py

@@ -3,5 +3,5 @@ from .myModelSerializer import MyModelSerializer  # noqa: F401
 from .myModelViewSet import MyModelViewSet  # noqa: F401
 from .pendingModeration import PendingModeration, PendingModerationSerializer, PendingModerationViewSet  # noqa: F401
 from .forTestingModeration import ForTestingModeration, ForTestingModerationSerializer, ForTestingModerationViewSet  # noqa: F401
-from .myModelVersionned import MyModelVersionned, MyModelVersionnedSerializer, MyModelVersionnedViewSet  # noqa: F401
-from .forTestingVersionning import ForTestingVersionning, ForTestingVersionningSerializer, ForTestingVersionningViewSet  # noqa: F401
+from .myModelVersionned import MyModelVersionned, MyModelVersionnedSerializer, MyModelVersionnedViewSet, VersionViewSet  # noqa: F401
+from .forTestingVersioning import ForTestingVersioning, ForTestingVersioningSerializer, ForTestingVersioningViewSet  # noqa: F401

backend/models/my_model/forTestingVersionning.py → backend/models/my_model/forTestingVersioning.py

@@ -4,25 +4,29 @@ import reversion
 
 
 @reversion.register()
-class ForTestingVersionning(MyModelVersionned):
+class ForTestingVersioning(MyModelVersionned):
     """
         Simple model for testing purposes
     """
     bbb = models.CharField(max_length=100)
 
+    @classmethod
+    def get_serializer(cls):
+        return ForTestingVersioningSerializer
 
-class ForTestingVersionningSerializer(MyModelVersionnedSerializer):
+
+class ForTestingVersioningSerializer(MyModelVersionnedSerializer):
     """
         Same as above
     """
     class Meta:
-        model = ForTestingVersionning
+        model = ForTestingVersioning
         fields = '__all__'
 
 
-class ForTestingVersionningViewSet(MyModelVersionnedViewSet):
+class ForTestingVersioningViewSet(MyModelVersionnedViewSet):
     """
         Same as above
     """
-    serializer_class = ForTestingVersionningSerializer
-    queryset = ForTestingVersionning.objects.all()
+    serializer_class = ForTestingVersioningSerializer
+    queryset = ForTestingVersioning.objects.all()

backend/models/my_model/myModel.py

 from django.db import models
 from django.contrib.auth.models import User
+from django.contrib.contenttypes.fields import GenericRelation
+from .pendingModeration import PendingModeration
 
 
 class MyModel(models.Model):
@@ -17,6 +19,7 @@ class MyModel(models.Model):
     updated_on = models.DateTimeField(null=True)
     updated_by = models.ForeignKey(
         User, null=True, on_delete=models.SET_NULL, related_name='+')
+    pending_moderation = GenericRelation(PendingModeration)
 
     class Meta:
         abstract = True

backend/models/my_model/myModelSerializer.py

@@ -5,6 +5,7 @@ from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from backend.utils import is_member
 from .myModel import MyModel
+from .pendingModeration import PendingModerationSerializer
 
 
 class MyModelSerializer(serializers.ModelSerializer):
@@ -14,6 +15,8 @@ class MyModelSerializer(serializers.ModelSerializer):
         format="%Y-%m-%d %H:%M:%S", read_only=True)
     moderated_by = serializers.CharField(read_only=True)
     updated_by = serializers.CharField(read_only=True)
+    pending_moderation = serializers.SerializerMethodField()
+    # pending_moderation = PendingModerationSerializer(many=True, read_only=True)
 
     # TODO : updated_by_username useless ? See in rest API
     updated_by_username = serializers.SerializerMethodField(read_only=True)
@@ -24,6 +27,12 @@ class MyModelSerializer(serializers.ModelSerializer):
         else:
             return None
 
+    def get_pending_moderation(self, obj):
+        if self.context['view'].action != 'list':
+            print(self.context['view'].action)
+            return PendingModerationSerializer(obj.pending_moderation, many=True, read_only=True, context=self.context).data
+        return None
+
     class Meta:
         model = MyModel
 
@@ -84,6 +93,9 @@ class MyModelSerializer(serializers.ModelSerializer):
         pass
 
     def save(self, **kwargs):
+        return self.my_save(**kwargs)
+
+    def my_save(self, **kwargs):
         user = self.get_user_in_request()
         self.clean_validated_data()
         self.my_pre_save()

backend/models/my_model/myModelVersionned.py

 from backend.models.my_model import MyModel, MyModelSerializer, MyModelViewSet
 from backend.signals import new_revision_saved
+from rest_framework import serializers, permissions, mixins, viewsets
 import reversion
+from reversion.models import Version
+from django.contrib.contenttypes.models import ContentType
+from django.core.serializers.base import DeserializationError
+from django.core import serializers as djangoSerializers
 
 
 class MyModelVersionned(MyModel):
 
+    @classmethod
+    def get_serializer(cls):
+        """
+            This function is required for handling
+            versioning easily.
+            You have to put the correct value in each subclass
+        """
+        raise Exception("Get_serializer must be redifined in subclass")
+
     class Meta:
         abstract = True
 
 
 class MyModelVersionnedSerializer(MyModelSerializer):
+    nb_versions = serializers.SerializerMethodField()
+    content_type_id = serializers.SerializerMethodField()
+
+    def get_nb_versions(self, obj):
+        if self.context['view'].action != 'list':
+            versions = Version.objects.get_for_object(obj)
+            return len(versions)
+        return None
+
+    def get_content_type_id(self, obj):
+        return ContentType.objects.get_for_model(self.Meta.model).id
 
     def save(self, **kwargs):
-        # Retrieve the user info from the request
         user = self.context['request'].user
-
+        res = None
         with reversion.create_revision():
-            super(MyModelSerializer, self).save(**kwargs)
+            res = self.my_save(**kwargs)
             reversion.set_user(user)
-
-        # Signal save to perform squash of revisions
         new_revision_saved.send(sender=self.__class__, obj=self.instance)
+        return res
 
 
 class MyModelVersionnedViewSet(MyModelViewSet):
     serializer_class = MyModelVersionnedSerializer
+
+
+class VersionSerializer(serializers.ModelSerializer):
+    # serialized_data = serializers.JSONField()
+    data = serializers.SerializerMethodField()
+
+    def get_data(self, obj):
+        data = obj.serialized_data
+
+        try:
+            tmp = list(djangoSerializers.deserialize(
+                obj.format, data, ignorenonexistent=True))[0]
+            print(tmp.object)
+            # Version is valid,
+            obj_serializer = tmp.object.get_serializer()
+            if obj_serializer is None:
+                return "THE PROGRAMMER FORGOT TO SET THE SERIALIZER IN THE MODEL"
+            else:
+                new_context = dict(self.context)
+                new_context['view'].action = 'list'
+                return obj_serializer(tmp.object, context=new_context).data
+        except (DeserializationError, djangoSerializers.SerializerDoesNotExist):
+            obj.delete()  # The version is not valid regarding the model, we should delete it !
+            # Might result in inconsistent nb of versions but that's fine.
+            return None
+
+    class Meta:
+        model = Version
+        fields = ('data', 'id')
+
+
+class VersionViewSet(mixins.ListModelMixin,
+                     viewsets.GenericViewSet):  # TODO better presentation
+    permission_classes = (permissions.IsAuthenticated,)
+    serializer_class = VersionSerializer
+
+    def get_queryset(self):
+        content_type_id = self.kwargs['content_type_id']
+        object_pk = self.kwargs['object_pk']
+        ct = ContentType.objects.get_for_id(content_type_id)
+        model = ct.model_class()
+        obj = model.objects.get(pk=object_pk)
+        return Version.objects.get_for_object(obj)
+
+    # queryset = get_queryset()

backend/models/my_model/myModelViewSet.py

@@ -17,7 +17,7 @@ class MyModelViewSet(DictModeViewSet):
         to prefetch some table and enhance performances
         """
         self.mymodel_queryset = self.queryset.prefetch_related(
-            'moderated_by', 'updated_by')
+            'moderated_by', 'updated_by', 'pending_moderation')
         return self.extend_queryset()
 
     def extend_queryset(self):

backend/models/my_model/pendingModeration.py

@@ -21,6 +21,15 @@ class PendingModeration(models.Model):
 
 
 class PendingModerationSerializer(serializers.ModelSerializer):
+    content_type = serializers.CharField(read_only=True)
+    object_id = serializers.CharField(read_only=True)
+
+    updated_by = serializers.CharField(read_only=True)
+    updated_on = serializers.DateTimeField(
+        format="%Y-%m-%d %H:%M:%S", read_only=True)
+
+    new_object = serializers.JSONField(read_only=True)
+
     class Meta:
         model = PendingModeration
         fields = '__all__'

backend/models/university/campus.py

@@ -31,6 +31,10 @@ class Campus(BasicModule):
     def location(self):
         return {'lat': self.lat, 'lon': self.lon}
 
+    @classmethod
+    def get_serializer(cls):
+        return CampusSerializer
+
     class Meta:
         unique_together = ('is_main_campus', 'university')
 

backend/models/university/campusBasicModules.py

@@ -11,6 +11,10 @@ class CampusCultureAndStudentLife(BasicModule):
     campus = models.OneToOneField(
         Campus, on_delete=models.CASCADE, related_name='campus_culture_and_sl', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CampusCultureAndStudentLifeSerializer
+
 
 class CampusCultureAndStudentLifeSerializer(BasicModuleSerializer):
     class Meta:
@@ -34,6 +38,10 @@ class CampusAccommodation(BasicModule):
     campus = models.OneToOneField(
         Campus, on_delete=models.CASCADE, related_name='campus_accomodation', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CampusAccommodationSerializer
+
 
 class CampusAccommodationSerializer(BasicModuleSerializer):
     class Meta:
@@ -57,6 +65,10 @@ class CampusTransport(BasicModule):
     campus = models.OneToOneField(
         Campus, on_delete=models.CASCADE, related_name='campus_transport', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CampusTransportSerializer
+
 
 class CampusTransportSerializer(BasicModuleSerializer):
     class Meta:
@@ -81,6 +93,10 @@ class CampusOtherStuff(BasicModule):
     campus = models.OneToOneField(
         Campus, on_delete=models.CASCADE, related_name='campus_other_stuff', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return CampusOtherStuffSerializer
+
 
 class CampusOtherStuffSerializer(BasicModuleSerializer):
     class Meta:

backend/models/university/universityBasicModules.py

@@ -12,6 +12,10 @@ class UniversityInsurance(BasicModule):
     university = models.OneToOneField(
         University, on_delete=models.CASCADE, related_name='university_insurances', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityInsuranceSerializer
+
 
 class UniversityInsuranceSerializer(BasicModuleSerializer):
     class Meta:
@@ -35,6 +39,10 @@ class UniversityCulture(BasicModule):
     university = models.OneToOneField(
         University, on_delete=models.CASCADE, related_name='university_culture', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityCultureSerializer
+
 
 class UniversityCultureSerializer(BasicModuleSerializer):
     class Meta:
@@ -58,6 +66,10 @@ class UniversityCourses(BasicModule):
     university = models.OneToOneField(
         University, on_delete=models.CASCADE, related_name='university_courses', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityCoursesSerializer
+
 
 class UniversityCoursesSerializer(BasicModuleSerializer):
     class Meta:
@@ -83,6 +95,10 @@ class UniversitySpecialOffer(BasicModule):
     university = models.OneToOneField(
         University, on_delete=models.CASCADE, related_name='university_special_offer', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversitySpecialOfferSerializer
+
 
 class UniversitySpecialOfferSerializer(BasicModuleSerializer):
     class Meta:
@@ -107,6 +123,10 @@ class UniversityOtherStuff(BasicModule):
     university = models.OneToOneField(
         University, on_delete=models.CASCADE, related_name='university_other_stuff', primary_key=True)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityOtherStuffSerializer
+
 
 class UniversityOtherStuffSerializer(BasicModuleSerializer):
     class Meta:

backend/models/university/universityDri.py

@@ -7,6 +7,10 @@ class UniversityDri(DriRestrictedModule):
     university = models.ManyToManyField(
         University, related_name="university_dri")
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityDriSerializer
+
 
 class UniversityDriSerializer(DriRestrictedModuleSerializer):
 

backend/models/university/universityInfo.py

@@ -26,6 +26,10 @@ class UniversityInfo(BasicModule):
 
     costs_currency = models.ForeignKey(Currency, on_delete=models.PROTECT)
 
+    @classmethod
+    def get_serializer(cls):
+        return UniversityInfoSerializer
+
 
 class UniversityInfoSerializer(BasicModuleSerializer):