Fix some more tests and other improvements

Author: sumit4613

docs/conf.py

@@ -11,14 +11,13 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
-
-# sys.path.insert(0, os.path.abspath('.'))
+from datetime import datetime
 
 
 # -- Project information -----------------------------------------------------
 
 project = "drf-user"
-copyright = "2020, 101 Loop"
+copyright = f"{datetime.now().year}, 101 Loop"
 author = "101 Loop"
 
 parent_dir = os.path.dirname(os.path.dirname(__file__))

drf_user/admin.py

@@ -1,26 +1,18 @@
 """
 All Admin configuration related to drf_user
-
-Author: Himanshu Shankar (https://himanshus.com)
 """
 from django.contrib import admin
-from django.contrib.auth.admin import Group
-from django.contrib.auth.admin import GroupAdmin
-from django.contrib.auth.admin import UserAdmin
+from django.contrib.auth.admin import Group, GroupAdmin, UserAdmin
 from django.utils.text import gettext_lazy as _
 
-from .models import AuthTransaction
-from .models import OTPValidation
-from .models import Role
-from .models import User
+from drf_user.models import AuthTransaction, OTPValidation, Role, User
 
 
+@admin.register(User)
 class DRFUserAdmin(UserAdmin):
     """
     Overrides UserAdmin to show fields name & mobile and remove fields:
     first_name, last_name
-
-    Author: Himanshu Shankar (https://himanshus.com)
     """
 
     fieldsets = (
@@ -57,12 +49,14 @@ class DRFUserAdmin(UserAdmin):
     readonly_fields = ("date_joined", "last_login", "update_date")
 
 
+@admin.register(OTPValidation)
 class OTPValidationAdmin(admin.ModelAdmin):
     """OTP Validation Admin"""
 
     list_display = ("destination", "otp", "prop")
 
 
+@admin.register(AuthTransaction)
 class AuthTransactionAdmin(admin.ModelAdmin):
     """AuthTransaction Admin"""
 
@@ -89,7 +83,3 @@ def has_delete_permission(self, request, obj=None):
 # Source: https://stackoverflow.com/a/32445368
 admin.site.unregister(Group)
 admin.site.register(Role, GroupAdmin)
-
-admin.site.register(User, DRFUserAdmin)
-admin.site.register(OTPValidation, OTPValidationAdmin)
-admin.site.register(AuthTransaction, AuthTransactionAdmin)

drf_user/serializers.py

@@ -9,7 +9,7 @@
 
 from drf_user import user_settings
 from drf_user.models import User
-from drf_user.utils import check_validation
+from drf_user.utils import check_validation, is_mobile_valid
 from drf_user.constants import EMAIL, MOBILE
 
 
@@ -234,6 +234,11 @@ class OTPLoginRegisterSerializer(serializers.Serializer):
     verify_otp = serializers.CharField(default=None, required=False)
     mobile = serializers.CharField(required=True)
 
+    def validate_mobile(self, value: str) -> str:
+        """Validate whether the mobile is unique."""
+        is_mobile_valid(value)
+        return value
+
     @staticmethod
     def get_user(email: str, mobile: str):
         """Fetches user object"""
@@ -242,27 +247,27 @@ def get_user(email: str, mobile: str):
         except User.DoesNotExist:
             try:
                 user = User.objects.get(mobile=mobile)
-            except User.DoesNotExist as e:
-                raise NotFound(
-                    _(f"No user exists either for email={email} or mobile={mobile}")
-                ) from e
-
-        if user.email != email:
-            raise serializers.ValidationError(
-                _(
-                    "Your account is registered with {mobile} does not has "
-                    "{email} as registered email. Please login directly via "
-                    "OTP with your mobile.".format(mobile=mobile, email=email)
+            except User.DoesNotExist:
+                # new user is trying to register
+                user = None
+
+        if user:
+            if user.email != email:
+                raise serializers.ValidationError(
+                    _(
+                        f"Your account is registered with {mobile} does not has "
+                        f"{email} as registered email. Please login directly via "
+                        "OTP with your mobile."
+                    )
                 )
-            )
-        if user.mobile != mobile:
-            raise serializers.ValidationError(
-                _(
-                    "Your account is registered with {email} does not has "
-                    "{mobile} as registered mobile. Please login directly via "
-                    "OTP with your email.".format(mobile=mobile, email=email)
+            if user.mobile != mobile:
+                raise serializers.ValidationError(
+                    _(
+                        f"Your account is registered with {email} does not has "
+                        f"{mobile} as registered mobile. Please login directly via "
+                        "OTP with your email."
+                    )
                 )
-            )
         return user
 
     def validate(self, attrs: dict) -> dict:

drf_user/utils.py

@@ -233,7 +233,7 @@ def check_validation(value: str) -> bool:
         return False
 
 
-def validate_mobile(mobile: str) -> bool:
+def is_mobile_valid(mobile: str) -> bool:
     """
     This function checks if the mobile number is valid or not.
     Parameters
@@ -248,12 +248,12 @@ def validate_mobile(mobile: str) -> bool:
     Examples
     --------
     To check if '9999999999' is a valid mobile number
-    >>> print(validate_mobile('9999999999'))
+    >>> print(is_mobile_valid('9999999999'))
     True
     """
     match = re.match(r"^[6-9]\d{9}$", str(mobile))
     if match is None:
-        raise ValidationError("Invalid Mobile Number")
+        raise ValidationError("Enter a valid mobile number.")
     return True
 
 
@@ -281,8 +281,8 @@ def validate_otp(*, destination: str, otp_val: int) -> bool:
     except OTPValidation.DoesNotExist as e:
         raise NotFound(
             detail=_(
-                "No pending OTP validation request found for provided destination."
-                " Kindly send an OTP first"
+                f"No pending OTP validation request found for provided {destination}."
+                " Kindly send an OTP first."
             )
         ) from e
 
@@ -350,7 +350,7 @@ def send_message(
 
     if recip_mobile:
         # check for valid mobile numbers
-        validate_mobile(recip_mobile)
+        is_mobile_valid(recip_mobile)
 
     try:
         send_mail(
@@ -361,7 +361,8 @@ def send_message(
             recipient_list=[recip_email],
         )
     except Exception as e:  # noqa
-        sent["message"] = f"Email Message sending failed! {str(e.args)}"
+        logger.error("Email sending failed", exc_info=e)
+        sent["message"] = str(e)
         sent["success"] = False
     else:
         sent["message"] = "Email Message sent successfully!"
@@ -371,8 +372,8 @@ def send_message(
         try:
             api.send_sms(body=message, to=recip_mobile, from_phone=None)
         except Exception as e:  # noqa
-            logger.debug("Message sending failed", exc_info=e)
-            sent["mobile_message"] = f"Mobile Message sending failed! {str(e.args)}"
+            logger.error("Message sending failed", exc_info=e)
+            sent["mobile_message"] = str(e)
         else:
             sent["mobile_message"] = "Mobile Message sent successfully!"
 

drf_user/views.py

@@ -309,8 +309,13 @@ def post(self, request, *args, **kwargs):
         sent_otp_resp: dict = send_otp(otp_obj=otp_obj, recip_email=email, recip_mobile=mobile)
 
         if not sent_otp_resp["success"]:
+            # delete otp object if OTP could not be sent
+            otp_obj.delete()
             raise serializers.ValidationError(
-                detail=_(f"OTP could not be sent! {sent_otp_resp['message']}")
+                {
+                    "message": "OTP could not be sent! Please try again after some time.",
+                    "exc": sent_otp_resp["message"],
+                }
             )
 
         otp_obj.send_counter = F("send_counter") + 1

tests/fixtures/send_otp_responses.py

@@ -0,0 +1,7 @@
+"""Store mock responses here"""
+
+email_mobile_message_sent = {
+    "success": True,
+    "message": "Email Message sent successfully!",
+    "mobile_message": "Mobile Message sent successfully!",
+}