Issue #45: Customize e-mail registration

* Added `REGISTER_EMAIL_SERIALIZER_CLASS` setting key

Author: apragacz

rest_registration/api/serializers.py

@@ -33,6 +33,19 @@ def get_authenticated_user(self):
             data['login'], data['password'])
 
 
+class DefaultRegisterEmailSerializer(serializers.Serializer):
+    """
+    Default serializer used for e-mail registration (e-mail change).
+    """
+    email = serializers.EmailField(required=True)
+
+    def get_email(self):
+        """
+        Return user email.
+        """
+        return self.validated_data['email']
+
+
 class DefaultUserProfileSerializer(serializers.ModelSerializer):
     """
     Default serializer used for user profile. It will use these:

rest_registration/api/views/register_email.py

@@ -3,7 +3,10 @@
 from rest_framework.decorators import api_view, permission_classes
 from rest_framework.permissions import AllowAny, IsAuthenticated
 
-from rest_registration.decorators import api_view_serializer_class
+from rest_registration.decorators import (
+    api_view_serializer_class,
+    api_view_serializer_class_getter
+)
 from rest_registration.notifications import send_verification_notification
 from rest_registration.settings import registration_settings
 from rest_registration.utils.responses import get_ok_response
@@ -23,11 +26,8 @@ def get_valid_period(self):
         return registration_settings.REGISTER_EMAIL_VERIFICATION_PERIOD
 
 
-class RegisterEmailSerializer(serializers.Serializer):
-    email = serializers.EmailField(required=True)
-
-
-@api_view_serializer_class(RegisterEmailSerializer)
+@api_view_serializer_class_getter(
+    lambda: registration_settings.REGISTER_EMAIL_SERIALIZER_CLASS)
 @api_view(['POST'])
 @permission_classes([IsAuthenticated])
 def register_email(request):
@@ -36,10 +36,11 @@ def register_email(request):
     '''
     user = request.user
 
-    serializer = RegisterEmailSerializer(data=request.data)
+    serializer_class = registration_settings.REGISTER_EMAIL_SERIALIZER_CLASS
+    serializer = serializer_class(data=request.data)
     serializer.is_valid(raise_exception=True)
 
-    email = serializer.validated_data['email']
+    email = serializer.get_email()
 
     template_config = (
         registration_settings.REGISTER_EMAIL_VERIFICATION_EMAIL_TEMPLATES)

rest_registration/settings_fields.py

@@ -163,6 +163,18 @@ def __new__(cls, name, *, default=None, help=None, import_string=False):
     ),
 ]
 REGISTER_EMAIL_SETTINGS_FIELDS = [
+    Field(
+        'REGISTER_EMAIL_SERIALIZER_CLASS',
+        default='rest_registration.api.serializers.DefaultRegisterEmailSerializer',  # noqa: E501
+        import_string=True,
+        help=dedent("""\
+            The serializer used by :ref:`register-email-view` endpoint.
+            It is used to validate the input data and obtain new e-mail.
+            You can use your custom serializer
+            to customise validation logic. Please remember that it should
+            implement ``get_email`` method.
+            """),
+    ),
     Field('REGISTER_EMAIL_VERIFICATION_ENABLED', default=True),
     Field(
         'REGISTER_EMAIL_VERIFICATION_PERIOD',