massive refactor

Author: knownbug06

verify_email/custom_types.py

@@ -1,5 +1,3 @@
 from typing import TypeVar
 
-from django.contrib.auth import get_user_model
-
-User = TypeVar("User", bound=get_user_model())
+User = TypeVar("User")

verify_email/tests.py

@@ -1,3 +1,76 @@
-from django.test import TestCase
+# verify_email_tests/test_verify_email.py
+import time
 
-# Create your tests here.
+from django.test import TestCase, override_settings
+from django.urls import reverse
+from django.contrib.auth import get_user_model
+from verify_email.email_handler import ActivationMailManager
+from verify_email.token_manager import TokenManager, SafeURL, ActivationLinkManager
+from django.core import mail
+from django.conf import settings
+from verify_email.app_configurations import GetFieldFromSettings
+
+
+User = get_user_model()
+
+
+class VerifyEmailTests(TestCase):
+    def setUp(self):
+        self.user = User.objects.create_user(
+            username='testuser',
+            email='[email protected]',
+            password='testpass'
+        )
+        self.user.is_active = False
+        self.user.save()
+
+    def test_send_verification_email(self):
+        """Test that verification email is sent."""
+        response = ActivationMailManager.send_verification_link(self.user)
+        self.assertIsNotNone(response)
+        self.assertEquals(len(mail.outbox), 1)
+
+    def test_verification_view_by_token_and_email(self):
+        """Test the email verification view."""
+        user_token = TokenManager().generate_token_for_user(self.user)
+        user_email = SafeURL.perform_encoding(self.user.email)
+        response = self.client.get(reverse('verify-email', args=[user_email, user_token]))
+        self.assertEqual(response.status_code, 200)
+
+    def test_verification_link(self):
+        user_token = TokenManager().generate_token_for_user(self.user)
+        user_email = self.user.email
+        link = ActivationLinkManager.generate_link(user_token, user_email)
+
+        full_url = f"http://testserver{link}"
+
+        resp = self.client.get(full_url)
+
+        self.assertEquals(resp.status_code, 200)
+
+    def test_process(self):
+        user_token = TokenManager().generate_token_for_user(self.user)
+        time.sleep(2)
+
+        link = ActivationLinkManager.generate_link(user_token, self.user.email)
+        full_url = f"http://testserver{link}"
+        resp = self.client.get(full_url)
+        self.assertEquals(resp.status_code, 200)
+
+    def test_timestamp_invalid_link(self):
+        user_token = TokenManager(max_age='2s').generate_token_for_user(self.user)
+        time.sleep(3)
+
+        link = ActivationLinkManager(max_age='2s').generate_link(user_token, self.user.email)
+        full_url = f"http://testserver{link}"
+        resp = self.client.get(full_url)
+        self.assertEquals(resp.status_code, 401)
+
+    def test_timestamp_valid_link(self):
+        user_token = TokenManager().generate_token_for_user(self.user)
+        time.sleep(3)
+
+        link = ActivationLinkManager.generate_link(user_token, self.user.email)
+        full_url = f"http://testserver{link}"
+        resp = self.client.get(full_url)
+        self.assertEquals(resp.status_code, 200)

verify_email/token_manager.py

@@ -25,10 +25,10 @@
 logger = logging.getLogger(__name__)
 
 
-@dataclass(frozen=True)
+@dataclass
 class GeneralConfig:
     settings: GetFieldFromSettings = GetFieldFromSettings()
-    max_age: int = settings.get("max_age", raise_exception=False)
+    max_age: str = settings.get("max_age", raise_exception=False)
     max_retries: int = settings.get("max_retries") + 1
     time_units: List = field(default_factory=lambda: ["s", "m", "h", "d"])
 
@@ -47,7 +47,7 @@ def perform_decoding(encoded_entity):
             return False
 
 
-@dataclass(frozen=True)
+@dataclass
 class ActivationLinkManager(GeneralConfig):
 
     @staticmethod
@@ -131,8 +131,8 @@ def request_new_link(self, request, inactive_user, token, user_email):
             )
 
 
-@dataclass(frozen=True)
-class TokenManager(GeneralConfig, signing.TimestampSigner):
+@dataclass
+class TokenManager(signing.TimestampSigner, GeneralConfig):
     """
     This class is responsible for creating encrypted links / verifying them / applying several checks for token lifetime
     and generating new verification links on request.
@@ -157,11 +157,11 @@ class TokenManager(GeneralConfig, signing.TimestampSigner):
     link_manager: ActivationLinkManager = ActivationLinkManager()
 
     def __post_init__(self):
-        key = self.settings.get("key", raise_exception=False)
-        salt = self.settings.get("salt", raise_exception=False)
-        sep = self.settings.get("sep", raise_exception=False)
+        self.key = self.settings.get("key", raise_exception=False)
+        self.salt = self.settings.get("salt", raise_exception=False)
+        self.sep = self.settings.get("sep", raise_exception=False)
 
-        super().__init__(key, sep, salt)
+        super().__init__()
 
     @staticmethod
     def is_token_valid(plain_email, encrypted_user_token) -> bool:

verify_email/urls.py

@@ -1,14 +1,14 @@
 from django.urls import path
-from .views import verify_user_and_activate, request_new_link
+from .views import verify_and_activate_user, request_new_link
 
 urlpatterns = [
     path(
-        "user/verify-email/<useremail>/<usertoken>/",
-        verify_user_and_activate,
+        "user/verify-email/<user_email>/<user_token>/",
+        verify_and_activate_user,
         name="verify-email",
     ),
     path(
-        "user/verify-email/request-new-link/<useremail>/<usertoken>/",
+        "user/verify-email/request-new-link/<user_email>/<user_token>/",
         request_new_link,
         name="request-new-link-from-token",
     ),

verify_email/views.py

@@ -39,7 +39,7 @@
 
 
 @require_GET
-def verify_user_and_activate(request, user_email, user_token):
+def verify_and_activate_user(request, user_email, user_token):
     """
     A view function already implemented for you so you don't have to implement any function for verification
     as this function will be automatically be called when user clicks on verification link.
@@ -70,6 +70,7 @@ def verify_user_and_activate(request, user_email, user_token):
         )
         return render(
             request,
+            status=401,
             template_name=failed_template,
             context={
                 "msg": failed_msg,
@@ -80,6 +81,7 @@ def verify_user_and_activate(request, user_email, user_token):
     except SignatureExpired:
         return render(
             request,
+            status=401,
             template_name=link_expired_template,
             context={
                 "msg": "The link has lived its life :( Request a new one!",
@@ -91,6 +93,7 @@ def verify_user_and_activate(request, user_email, user_token):
     except BadSignature:
         return render(
             request,
+            status=401,
             template_name=failed_template,
             context={
                 "msg": "This link was modified before verification.",
@@ -101,6 +104,7 @@ def verify_user_and_activate(request, user_email, user_token):
     except MaxRetriesExceeded:
         return render(
             request,
+            status=401,
             template_name=failed_template,
             context={
                 "msg": "You have exceeded the maximum verification requests! Contact admin.",
@@ -110,6 +114,7 @@ def verify_user_and_activate(request, user_email, user_token):
     except InvalidToken:
         return render(
             request,
+            status=401,
             template_name=failed_template,
             context={
                 "msg": "This link is invalid or been used already, we cannot verify using this link.",
@@ -119,10 +124,29 @@ def verify_user_and_activate(request, user_email, user_token):
     except UserNotFound:
         raise Http404("404 User not found")
 
+    except Exception as err:
+        logger.exception(err)
+        flash_msg = "Something went wrong during this process!"
+        if debug:
+            flash_msg = f"""{flash_msg} Developer should look into this.
+            Error Details: {err}
+            (You are seeing error details because app is running in debug mode)
+            """
+        return render(
+            request,
+            status=403,
+            template_name=failed_template,
+            context={
+                "msg": flash_msg,
+                "status": "Failed!",
+            },
+        )
+
+
 
-def request_new_link(request, useremail=None, usertoken=None):
+def request_new_link(request, user_email=None, user_token=None):
     try:
-        if useremail is None or usertoken is None:
+        if user_email is None or user_token is None:
             # request came from re-request email page
             if request.method == "POST":
                 form = RequestNewVerificationEmail(request.POST)  # do not inflate data
@@ -157,7 +181,7 @@ def request_new_link(request, useremail=None, usertoken=None):
         else:
             # request came from  previously sent link
             status = ActivationMailManager.resend_verification_link(
-                request, useremail, token=usertoken
+                request, user_email, token=user_token
             )
             if status:
                 return render(
@@ -192,6 +216,7 @@ def request_new_link(request, useremail=None, usertoken=None):
         )
         return render(
             request,
+            status=403,
             template_name=failed_template,
             context={
                 "msg": "You have exceeded the maximum verification requests! Contact admin.",
@@ -210,6 +235,7 @@ def request_new_link(request, useremail=None, usertoken=None):
     except UserAlreadyActive:
         return render(
             request,
+            status=403,
             template_name=failed_template,
             context={
                 "msg": "This user's account is already active",
@@ -226,6 +252,7 @@ def request_new_link(request, useremail=None, usertoken=None):
             """
         return render(
             request,
+            status=403,
             template_name=failed_template,
             context={
                 "msg": flash_msg,