Feat/enable-register-2 (#4)

* remove bulma, add more comments.

* fix urls. error edit.

* ref: refactor, move transform out.

* add normal logger settings.

* replace print with logger.

* ref, remove useless code.

* ref, migrate tests to root path.

* add vscode settings.

* remove ignore vscode.

* fix register html template.

* add mmigrate command for test..

* add management package.

* feat, add register forms.

* add migration.

* add verify email and register details save view.

* avoid inside method call by outside. Improve readability.

* refactor using login.py.

* add register/verify and details to testapp.

* add command register record.

* fix: register record create.

* feat, add admin

* fix login error.

* remove edit details.

* remove details validate.

* remove register-details url.

* fix: model verbose name.

* pass the old test.

* add system-name test.

* add test email info.

* merge login and register request email.

* update verify mixin and add new test for user exists.

* add more test for token verify.

* fix error of update.

* enable verify.

* update version 0.5.0

Author: Svtter

.gitignore

@@ -1,9 +1,10 @@
 .venv
-.vscode
 *.pyc
 __pycache__
 
 
 db.sqlite3
 .env
-dist
+dist
+
+*.log

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "python.testing.pytestArgs": [
+    "."
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

README.md

@@ -22,8 +22,10 @@ List of the urls for exmaple project:
 - [x] Time-limited of login link.
 - [x] limited of sending email. Using TimeLimt to set minutes.
 - [x] The link could be used for Login once.
+- [x] Register new user.
+- [x] Support multiple user.
 - [ ] Ban the IP to send mail frequently without login.
-- [ ] Multiple user.
+- [ ] Enable 2FA.
 - [ ] More easier and customizable login link.
 
 ## Usage
@@ -42,25 +44,30 @@ INSTALLED_APP = [
 
 ```python
 from django.shortcuts import render
-from django_login_email import views as v
+from django.urls import reverse
+
 from django_login_email import email as e
+from django_login_email import views as v
 
 # Create your views here.
 
-
-class MyInfo(e.EmailLoginInfo):
-    def set_variables(self):
-        self.subject = "Login request from meterhub"
-        self.welcome_text = "Welcome to meterhub! Please click the link below to login.<br>"
-        self.from_email = "sandbox.smtp.mailtrap.io"
+loginInfo, registerInfo = e.get_info_class("meterhub")
 
 
 class LoginView(v.EmailLoginView):
-    email_info_class = MyInfo
+  login_info_class = loginInfo
+  register_info_class = registerInfo
 
 
 class VerifyView(v.EmailVerifyView):
-    pass
+  def get_success_url(self):
+    return reverse("home")
+
+
+class LogoutView(v.EmailLogoutView):
+  pass
+
+
 
 ```
 

django_login_email/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.5.0"

django_login_email/admin.py

@@ -1,3 +1,10 @@
 from django.contrib import admin
 
+from django_login_email import models
+
 # Register your models here.
+
+
+@admin.register(models.EmailRecord)
+class EmailRecordAdmin(admin.ModelAdmin):
+  list_display = ("email", "expired_time", "validated", "mail_type")

django_login_email/email.py

@@ -1,126 +1,201 @@
-from dataclasses import dataclass
-import typing as t
 import abc
-import string
 import datetime
+import string
+import typing as t
+from dataclasses import dataclass
 from datetime import timezone
 
+from django.contrib.auth import get_user_model, login, logout
 from django.core.mail import EmailMessage
-from django.contrib.auth import get_user_model
-
-from django.contrib.auth import login, logout
-from . import token
-
-
-class EmailLoginInfo(object):
-    subject: str
-    message: str
-    welcome_text = "Welcome to meterhub! Please click the link below to login.<br>"
-    url: str = "http://127.0.0.1:8000/account/verify?token="
-    login_message: string.Template = string.Template('Click <a href="$url$token">Link</a>')
-    from_email: str
-
-    def __init__(self) -> None:
-        self.init_variables()
-
-    def init_variables(self):
-        raise NotImplementedError("You must set the subject and from_email.")
-
-    def set_token(self, value):
-        self.message = self.welcome_text + self.login_message.substitute(url=self.url, token=value)
 
-
-class TimeLimit(object):
-    minutes: int = 10
-
-
-@dataclass
-class MailRecord(object):
-    expired_time: t.Optional[datetime.datetime]
-    email: str
-    validated: bool
-    sault: str
+from . import errors, token
 
 
-class MailRecordMixin(abc.ABC):
+class EmailInfo(object):
+  """Email info."""
 
-    @abc.abstractmethod
-    def get_mail_record(self, mail: str) -> MailRecord:
-        # for easy to change. use a function.
-        raise NotImplementedError("You must implement get_mail_record")
+  subject: str
+  message: str
+  from_email: str
+  welcome_text: str
+  system_name: str
 
-    @abc.abstractmethod
-    def save_token(self, token: token.TokenDict):
-        """to save token in the database or somewhere."""
-        raise NotImplementedError("You must implement save_token")
+  url: str = "http://127.0.0.1:8000/account/verify?token="
+  login_message: string.Template = string.Template('Click <a href="$url$token">Link</a>')
 
-    @abc.abstractmethod
-    def disable_token(self, token: token.TokenDict):
-        """Every token should only login once"""
-        raise NotImplementedError("")
+  def set_token(self, value):
+    self.message = self.welcome_text + self.login_message.substitute(
+      url=self.url, token=value
+    )
 
 
-class EmailInfoMixin(MailRecordMixin):
-    email_info_class: t.Type[EmailLoginInfo]
+class EmailLoginInfo(EmailInfo):
+  """Email info for login."""
 
-    tl: TimeLimit
+  def __init__(self):
+    self.subject = f"Welcome to {self.system_name}! Please click the link below to login."
+    self.from_email = "noreply@example.com"
+    self.welcome_text: str = (
+      f"Welcome to {self.system_name}! Please click the link below to login.<br>"
+    )
 
-    def check_user(self, email):
-        User = get_user_model()
-        u = User.objects.get(email=email)
-        return u
 
-    def check_could_send(self, email):
-        re = self.get_mail_record(email)
-        # TODO: if other user send email, the current user could not sign in.
-        if (re.expired_time is None) or (re.expired_time <= datetime.datetime.now(tz=timezone.utc)):
-            return True
-        return False
+class EmailRegisterInfo(EmailInfo):
+  """Email info for register."""
 
-    def send_valid(self, email: str):
-        e = self.email_info_class()
-        m = token.TokenManager(self.tl.minutes)
+  def __init__(self):
+    self.subject = (
+      f"Welcome to {self.system_name}! Please click the link below to register."
+    )
+    self.from_email = "noreply@example.com"
+    self.welcome_text: str = (
+      f"Welcome to {self.system_name}! Please click the link below to register.<br>"
+    )
 
-        encrypt_token = m.encrypt_mail(email, self.save_token)
-        e.set_token(encrypt_token)
 
-        msg = EmailMessage(e.subject, e.message, e.from_email, [email])
-        msg.content_subtype = "html"
-        msg.send()
+def get_info_class(sys_name: str) -> t.Tuple[EmailLoginInfo, EmailRegisterInfo]:
+  class MyLoginInfo(EmailLoginInfo):
+    system_name = sys_name
 
-    def send_login_mail(self, email: str):
-        self.check_user(email)
-        if not self.check_could_send(email=email):
-            raise Exception(f"Cannot send. Wait {self.tl.minutes} minutes.")
+  class MyRegisterInfo(EmailRegisterInfo):
+    system_name = sys_name
 
-        self.send_valid(email)
+  return MyLoginInfo, MyRegisterInfo
 
 
-class EmailValidateMixin(MailRecordMixin):
-    tl: TimeLimit
-
-    def verify_login_mail(self, request, token_v: str):
-        m = token.TokenManager(self.tl.minutes)
-        token_str = m.decrypt_token(token=token_v)
-        token_d = m.transform_token(token_str)
-
-        mr = self.get_mail_record(m.get_mail(token_d))
-        if mr.validated:
-            raise Exception("Already validated.")
+@dataclass
+class TimeLimit(object):
+  minutes: int = 10
 
-        token_d = m.check_token(token_d, lambda: mr.sault)
-        if token_d is None:
-            raise Exception("Invalid token.")
 
-        User = get_user_model()
-        u = User.objects.get(email=m.get_mail(token_d))
-        if not u.is_active:
-            raise Exception("Inactive user, disallow login.")
+@dataclass
+class MailRecord(object):
+  expired_time: t.Optional[datetime.datetime]
+  email: str
+  validated: bool
+  sault: str
+
+
+class MailRecordAPI(abc.ABC):
+  """Mixin to get mail record."""
+
+  @abc.abstractmethod
+  def get_mail_record(self, mail: str) -> MailRecord:
+    """Get the mail record from the database."""
+    raise NotImplementedError("You must implement get_mail_record")
+
+  @abc.abstractmethod
+  def save_token(self, token: token.TokenDict):
+    """to save token in the database or somewhere."""
+    raise NotImplementedError("You must implement save_token")
+
+  @abc.abstractmethod
+  def disable_token(self, token: token.TokenDict):
+    """Every token should only login once"""
+    raise NotImplementedError("")
+
+
+class EmailFunc(MailRecordAPI):
+  """Mixin to send email."""
+
+  login_info_class: t.Type[EmailLoginInfo]
+  register_info_class: t.Type[EmailRegisterInfo]
+
+  tl: TimeLimit
+
+  def check_user(self, email) -> bool:
+    """check if the user exists."""
+    User = get_user_model()
+    u = User.objects.filter(email=email)
+    return u.exists()
+
+  def check_could_send(self, email) -> bool:
+    """check if the email could send."""
+    re = self.get_mail_record(email)
+    # TODO: if other user send email, the current user could not sign in.
+    if (re.expired_time is None) or (
+      re.expired_time <= datetime.datetime.now(tz=timezone.utc)
+    ):
+      return True
+    return False
+
+  def get_token_manager(self) -> token.TokenManager:
+    return token.TokenManager(self.tl.minutes)
+
+  def send_valid(self, email: str, mail_type: str):
+    """send login/register mail."""
+    if mail_type == "login":
+      e = self.login_info_class()
+    elif mail_type == "register":
+      e = self.register_info_class()
+    else:
+      raise ValueError(f"Invalid mail type: {mail_type}")
+
+    m = self.get_token_manager()
+    encrypt_token = m.encrypt_mail(email, mail_type, self.save_token)
+    e.set_token(encrypt_token)
+
+    msg = EmailMessage(e.subject, e.message, e.from_email, [email])
+    msg.content_subtype = "html"
+    msg.send()
+
+  def send_login_mail(self, email: str):
+    """
+    send login mail.
+    """
+    # if user not exist, send register mail.
+    if not self.check_user(email):
+      mail_type = "register"
+    else:
+      mail_type = "login"
+
+    # if the email could not send, raise exception.
+    if not self.check_could_send(email=email):
+      raise Exception(f"Cannot send. Wait {self.tl.minutes} minutes.")
+
+    self.send_valid(email, mail_type)
+
+
+class EmailVerifyMixin(MailRecordAPI):
+  """verify the token in url"""
+
+  tl: TimeLimit
+
+  def verify_token(self, token_v: str):
+    m = token.TokenManager(self.tl.minutes)
+    token_str = m.decrypt_token(token=token_v)
+    token_d = m.transform_token(token_str)
+
+    mr = self.get_mail_record(m.get_mail(token_d))
+    if mr.validated:
+      raise errors.ValidatedError("Token already validated.")
+
+    token_d = m.check_token(token_d, lambda: mr.sault)
+    if token_d is None:
+      raise errors.TokenError("Invalid token.")
 
-        self.disable_token(token=token_d)
-        login(request, u)
+    User = get_user_model()
+    u = User.objects.filter(email=m.get_mail(token_d)).first()
+    if not u:
+      # if user not exist, create a new user.
+      # support register by email.
+      u = User.objects.create(username=m.get_mail(token_d), email=m.get_mail(token_d))
+
+    if not u.is_active:
+      raise Exception("Inactive user, disallow login.")
+
+    self.disable_token(token=token_d)
+    return u
+
+  def verify_login_mail(self, request, token_v: str):
+    """
+    verify the login mail.
+    if user not exist, create a new user.
+    """
+    u = self.verify_token(token_v=token_v)
+    login(request, u)
 
 
 class EmailLogoutMixin(object):
-    def logout(self, request):
-        logout(request)
+  def logout(self, request):
+    logout(request)