django-solomon 0.4.3__py3-none-any.whl → 0.5.0__py3-none-any.whl

django_solomon/admin.py

@@ -1,7 +1,9 @@
 from django.contrib import admin
+from django.contrib.auth.admin import UserAdmin
 from django.utils.translation import gettext_lazy as _
 
-from django_solomon.models import BlacklistedEmail, MagicLink
+from django_solomon.forms import CustomUserCreationForm, CustomUserChangeForm
+from django_solomon.models import BlacklistedEmail, MagicLink, CustomUser
 
 
 @admin.register(BlacklistedEmail)
@@ -43,3 +45,36 @@ class MagicLinkAdmin(admin.ModelAdmin):
     def is_valid(self, obj: MagicLink) -> bool:
         """Display if the magic link is valid."""
         return obj.is_valid
+
+
+@admin.register(CustomUser)
+class CustomUserAdmin(UserAdmin):
+    add_form = CustomUserCreationForm
+    form = CustomUserChangeForm
+    model = CustomUser
+    list_display = (
+        "email",
+        "is_superuser",
+        "is_staff",
+        "is_active",
+    )
+    list_filter = (
+        "is_superuser",
+        "is_staff",
+        "is_active",
+    )
+    fieldsets = (
+        (None, {"fields": ("email", "password")}),
+        ("Permissions", {"fields": ("is_staff", "is_active", "groups", "user_permissions")}),
+    )
+    add_fieldsets = (
+        (
+            None,
+            {
+                "classes": ("wide",),
+                "fields": ("email", "password1", "password2", "is_staff", "is_active", "groups", "user_permissions"),
+            },
+        ),
+    )
+    search_fields = ("email",)
+    ordering = ("email",)

django_solomon/apps.py

@@ -6,25 +6,5 @@ class DjangoSolomonConfig(AppConfig):
     name = "django_solomon"
 
     def ready(self):
-        # Copyright (c) 2023 Carlton Gibson
-        # This migration is taken from the fantastic project `django-unique-user-email` created by Carlton Gibson.
-        # https://github.com/carltongibson/django-unique-user-email/
-
-        from django.contrib.auth.models import User
-        from django.db import models
-
-        # Updating the field itself triggers the auto-detector
-        # field = User._meta.get_field("email")
-        # field._unique = True
-        #
-        # But setting a constraint does not...
-        User.Meta.constraints = [
-            models.UniqueConstraint(
-                fields=["email"],
-                name="unique_user_email",
-                # deferrable=models.Deferrable.DEFERRED,
-            ),
-        ]
-        User._meta.constraints = User.Meta.constraints
-        # ... as long as original_attrs is not updated.
-        # User._meta.original_attrs["constraints"] = User.Meta.constraints
+        # Import checks when app is ready
+        import django_solomon.checks  # noqa

django_solomon/backends.py

@@ -2,10 +2,11 @@ from typing import Any
 
 from django.conf import settings
 from django.contrib.auth.backends import ModelBackend
+from django.contrib.auth.base_user import AbstractBaseUser
 from django.http import HttpRequest
 from django.utils.translation import gettext_lazy as _
 
-from django_solomon.models import MagicLink, UserType
+from django_solomon.models import MagicLink
 from django_solomon.utilities import get_client_ip
 
 
@@ -15,7 +16,7 @@ class MagicLinkBackend(ModelBackend):
         request: HttpRequest | None = None,
         token: str | None = None,
         **kwargs: Any,  # noqa: ARG002
-    ) -> UserType | None:
+    ) -> AbstractBaseUser | None:
         """
         Authenticates a user based on the provided magic link token. This method validates
         the token, ensures the token is not expired, and checks if the user associated

django_solomon/checks.py

@@ -0,0 +1,42 @@
+# django_solomon/checks.py
+from django.apps import apps
+from django.conf import settings
+from django.core.checks import Error, register
+
+
+@register()
+def check_user_model_email(app_configs, **kwargs):  # noqa: ARG001
+    """
+    Check that the user model has a unique email field.
+    """
+    errors = []
+
+    # Get the user model
+    user_model = apps.get_model(settings.AUTH_USER_MODEL)
+
+    # Check if email field exists
+    try:
+        email_field = user_model._meta.get_field("email")
+    except Exception:
+        errors.append(
+            Error(
+                "User model does not have an email field.",
+                hint="Make sure your user model has an email field.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E001",
+            )
+        )
+        return errors
+
+    # Check if email field is unique
+    if not email_field.unique:
+        errors.append(
+            Error(
+                "User model email field must be unique.",
+                hint="Set unique=True on the email field of your user model.",
+                obj=settings.AUTH_USER_MODEL,
+                id="django_solomon.E002",
+            )
+        )
+
+    return errors

django_solomon/forms.py

@@ -1,6 +1,9 @@
 from django import forms
+from django.contrib.auth.forms import UserCreationForm, UserChangeForm
 from django.utils.translation import gettext_lazy as _
 
+from django_solomon.models import CustomUser
+
 
 class MagicLinkForm(forms.Form):
     """Form for requesting a magic link."""
@@ -10,3 +13,15 @@ class MagicLinkForm(forms.Form):
         max_length=254,
         widget=forms.EmailInput(attrs={"autocomplete": "email"}),
     )
+
+
+class CustomUserCreationForm(UserCreationForm):
+    class Meta:
+        model = CustomUser
+        fields = ("email",)
+
+
+class CustomUserChangeForm(UserChangeForm):
+    class Meta:
+        model = CustomUser
+        fields = ("email",)

django_solomon/migrations/0001_initial.py

@@ -1,6 +1,8 @@
-# Generated by Django 5.2 on 2025-04-18 13:46
+# Generated by Django 5.2 on 2025-04-21 11:50
 
+import django.contrib.auth.validators
 import django.db.models.deletion
+import django.utils.timezone
 from django.conf import settings
 from django.db import migrations, models
 
@@ -10,7 +12,7 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('auth', '0012_alter_user_first_name_max_length'),
     ]
 
     operations = [
@@ -28,6 +30,29 @@ class Migration(migrations.Migration):
                 'ordering': ['-created_at'],
             },
         ),
+        migrations.CreateModel(
+            name='CustomUser',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('email', models.EmailField(max_length=254, unique=True, verbose_name='email address')),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+            },
+        ),
         migrations.CreateModel(
             name='MagicLink',
             fields=[
@@ -36,6 +61,7 @@ class Migration(migrations.Migration):
                 ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='Created at')),
                 ('expires_at', models.DateTimeField(verbose_name='Expires at')),
                 ('used', models.BooleanField(default=False, verbose_name='Used')),
+                ('ip_address', models.GenericIPAddressField(blank=True, null=True, verbose_name='IP Address')),
                 ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='magic_links', to=settings.AUTH_USER_MODEL, verbose_name='User')),
             ],
             options={

django_solomon/models.py

@@ -1,16 +1,63 @@
+import uuid
 from datetime import timedelta
-from typing import Any, TypeVar
+from typing import Any
 
 from django.conf import settings
-from django.contrib.auth import get_user_model
-from django.contrib.auth.base_user import AbstractBaseUser
+from django.contrib.auth.base_user import AbstractBaseUser, BaseUserManager
+from django.contrib.auth.models import AbstractUser
 from django.contrib.auth.tokens import default_token_generator
 from django.db import models
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
-User = get_user_model()
-UserType = TypeVar("UserType", bound=AbstractBaseUser)
+
+class CustomUserManager(BaseUserManager):
+    """
+    Custom user model manager where email is the unique identifiers
+    for authentication instead of usernames.
+    """
+
+    def create_user(self, email, password, **extra_fields):
+        """
+        Create and save a user with the given email and password.
+        """
+        if not email:
+            raise ValueError(_("The Email must be set"))
+        email = self.normalize_email(email)
+        user = self.model(email=email, **extra_fields)
+        user.set_password(password)
+        user.save()
+        return user
+
+    def create_superuser(self, email, password, **extra_fields):
+        """
+        Create and save a SuperUser with the given email and password.
+        """
+        extra_fields.setdefault("is_staff", True)
+        extra_fields.setdefault("is_superuser", True)
+        extra_fields.setdefault("is_active", True)
+
+        if extra_fields.get("is_staff") is not True:
+            raise ValueError(_("Superuser must have is_staff=True."))
+        if extra_fields.get("is_superuser") is not True:
+            raise ValueError(_("Superuser must have is_superuser=True."))
+        return self.create_user(email, password, **extra_fields)
+
+
+class CustomUser(AbstractUser):
+    email = models.EmailField(_("email address"), unique=True)
+
+    USERNAME_FIELD = "email"
+    REQUIRED_FIELDS = ["username"]
+
+    objects = CustomUserManager()
+
+    def __str__(self):
+        return self.email
+
+    def save(self, *args, **kwargs):
+        self.username = self.email
+        super().save(*args, **kwargs)
 
 
 class BlacklistedEmail(models.Model):
@@ -42,7 +89,7 @@ class MagicLinkManager(models.Manager["MagicLink"]):
     criteria like token, usage status, and expiration date.
     """
 
-    def create_for_user(self, user: UserType, ip_address: str = None) -> "MagicLink":
+    def create_for_user(self, user: AbstractBaseUser, ip_address: str = None) -> "MagicLink":
         """
         Creates a new magic link for a given user. If the setting SOLOMON_ONLY_ONE_LINK_ALLOWED
         is enabled, marks existing links for the user as used before creating a new one.
@@ -110,7 +157,9 @@ class MagicLink(models.Model):
         based on a predefined duration from the settings.
         """
         if not self.pk or not self.token:
-            self.token = default_token_generator.make_token(self.user)
+            base_token = default_token_generator.make_token(self.user)
+            unique_component = uuid.uuid4().hex[:8]  # 8 characters from UUID
+            self.token = f"{base_token}-{unique_component}"
 
         if not self.expires_at:
             expiration_time = getattr(settings, "SOLOMON_LINK_EXPIRATION", 300)  # seconds

django_solomon/utilities.py

@@ -4,14 +4,13 @@ import socket
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
+from django.contrib.auth.base_user import AbstractBaseUser
 from django.contrib.auth.hashers import make_password
 
-from django_solomon.models import UserType
-
 logger = logging.getLogger(__name__)
 
 
-def get_user_by_email(email: str) -> UserType | None:
+def get_user_by_email(email: str) -> AbstractBaseUser | None:
     """
     Get a user by email.
 
@@ -53,7 +52,7 @@ def get_user_by_email(email: str) -> UserType | None:
         return None
 
 
-def create_user_from_email(email: str) -> UserType:
+def create_user_from_email(email: str) -> AbstractBaseUser:
     """
     Creates a new user with the given email.
 

{django_solomon-0.4.3.dist-info → django_solomon-0.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: django-solomon
-Version: 0.4.3
+Version: 0.5.0
 Summary: A Django app for passwordless authentication using magic links.
 Project-URL: Home, https://django-solomon.rtfd.io/
 Project-URL: Documentation, https://django-solomon.rtfd.io/
@@ -30,7 +30,7 @@ License: MIT License
         SOFTWARE.
 License-File: LICENSE
 Keywords: django
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django :: 4.2
 Classifier: Framework :: Django :: 5.0
@@ -65,6 +65,7 @@ A Django app for passwordless authentication using magic links.
 ## Features
 
 - Passwordless authentication using magic links sent via email
+- Email-based authentication with a built-in CustomUser model
 - Configurable link expiration time
 - Blacklist functionality to block specific email addresses
 - Support for auto-creating users when they request a magic link
@@ -72,8 +73,7 @@ A Django app for passwordless authentication using magic links.
 - Privacy-focused IP anonymization
 - Customizable templates for emails and pages
 - Compatible with Django's authentication system
-- Enforces unique email addresses for users (Code is taken
-  from [django-unique-user-email](https://github.com/carltongibson/django-unique-user-email). Thanks!)
+- System checks to ensure proper configuration
 
 ## Installation
 
@@ -93,7 +93,15 @@ INSTALLED_APPS = [
 ]
 ```
 
-2. Add the authentication backend to your settings:
+2. Configure the user model in your settings:
+
+```python
+AUTH_USER_MODEL = 'django_solomon.CustomUser'
+```
+
+This setting is required for django-solomon to work properly, as it needs a user model with a unique email field for email-based authentication. You can also use your own custom user model as long as it has a unique email field.
+
+3. Add the authentication backend to your settings:
 
 ```python
 AUTHENTICATION_BACKENDS = [
@@ -102,7 +110,7 @@ AUTHENTICATION_BACKENDS = [
 ]
 ```
 
-3. Include the django-solomon URLs in your project's `urls.py`:
+4. Include the django-solomon URLs in your project's `urls.py`:
 
 ```python
 from django.urls import include, path
@@ -114,7 +122,7 @@ urlpatterns = [
 ]
 ```
 
-4. Set the login URL in your settings to use django-solomon's login view:
+5. Set the login URL in your settings to use django-solomon's login view:
 
 ```python
 LOGIN_URL = 'django_solomon:login'
@@ -122,7 +130,7 @@ LOGIN_URL = 'django_solomon:login'
 
 This ensures that when users need to authenticate, they'll be redirected to the magic link login page.
 
-5. Configure your email settings to ensure emails can be sent:
+6. Configure your email settings to ensure emails can be sent:
 
 ```python
 EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'

{django_solomon-0.4.3.dist-info → django_solomon-0.5.0.dist-info}/RECORD

@@ -1,28 +1,27 @@
 django_solomon/__init__.py,sha256=4GdjeQVyChzdc7pZ1jrpknjcnu9Do_0nSh42UZNICKo,80
-django_solomon/admin.py,sha256=hwesCOQgUDDHPh5qq97AObfSyMgIOKsdzoa69naMPx4,1428
-django_solomon/apps.py,sha256=hfkXVS1kp1kAWtl5q2CPkxhP5rxnGq09JvQrYTNj2PA,1114
-django_solomon/backends.py,sha256=3RN4dsCehg5urp9sfASERFda1VR9nislNvHrxUc7rXM,3171
+django_solomon/admin.py,sha256=H1q4qXN0uccLY3OFt7v9FisnLwANStDIr5JWMP8gByw,2401
+django_solomon/apps.py,sha256=Ln0Nbv7ZQTb25l4p2CXyxtKFqy60Q9AEBCXIapYaDLk,268
+django_solomon/backends.py,sha256=ruv8Lop5js4MQmTQV0cl07Hc11sZ1Kty6QOS5J92ZbI,3228
+django_solomon/checks.py,sha256=yF2IFogiUreaAQcw2YzTUtq1mkd9hpzvdgbh3u0oopY,1198
 django_solomon/config.py,sha256=JEl3cY0BnfC9ja0ZVeLmfIwUStbUAO6vRhGZrrig5Yw,787
-django_solomon/forms.py,sha256=ymDsZ-KWyJfo12vGbZCxIhIvVket93xYR4MgDif4fh0,312
-django_solomon/models.py,sha256=G-74LDemMJMVOXN94tSz7E9XwspCNkzmHbhEP3Kl80U,4904
+django_solomon/forms.py,sha256=Y6PsFbeSNLaCB3gfWE4ekvg6sJmtyy9DGn35ZJ5Qejo,667
+django_solomon/models.py,sha256=9npDBTcCvlFbi4wSfV7IEU3WDgoincjMDmwPQqGU8lU,6567
 django_solomon/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_solomon/urls.py,sha256=tT-I-p6dA2rD1IvH3pAcJRkPXYW0oYmYWXZAoiLJzGY,471
-django_solomon/utilities.py,sha256=I6LiBwAwZaa8h-iH_6RLP9fkJkK9mEb_24LPzLLuwFA,4559
+django_solomon/utilities.py,sha256=FpWFqkPf4tzjItjuTrVfKRhjZw5449VZ7Y1gjPrcuhQ,4590
 django_solomon/views.py,sha256=gqsj1SVd2bbQvla3xpZYVHYCUxhu3fr_5I-LY-Tvm2g,5737
 django_solomon/locale/de/LC_MESSAGES/django.po,sha256=6lo72lsDV1bKBVowiRsQoaVKH5Mbkf34z78sG1LEYq4,747
 django_solomon/locale/en/LC_MESSAGES/django.po,sha256=6MjGCWQn-1AjOnP_gXtLa0Oad4qfNAn5tXdhnw_wEcg,732
 django_solomon/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_solomon/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_solomon/migrations/0001_initial.py,sha256=i-UhR1KQ4p7WmbDg9xUQfMmDo8yYdIigvHNsefLHJEc,1981
-django_solomon/migrations/0002_magiclink_ip_address.py,sha256=hs3MISYV7IHEqF-vELCmFtzhhvK8GEHkZu8RMc4X1YU,432
-django_solomon/migrations/0003_add_unique_constraint_auth_user_email.py,sha256=2eZm-oSTtf9zmEy4fJYE6fjMAsn_VUS_zKfW3WQNGoQ,1487
+django_solomon/migrations/0001_initial.py,sha256=RlyI1VV2kDXcGS3waQ1ujieq8gGx66YU75phWhwxTlU,4558
 django_solomon/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_solomon/templates/django_solomon/base/invalid_magic_link.html,sha256=3U4T2n4uvPvktiOOHYVyNmk0aXFfE4DPrURE1DinWKk,554
 django_solomon/templates/django_solomon/base/login_form.html,sha256=VYGnrno3c36W9f04XdRqJpjsDfOy0sq5D_cLayPz8Q0,546
 django_solomon/templates/django_solomon/base/magic_link_sent.html,sha256=GIMxnw3E98TXVkVQkMRTHmX5mz0xUsvgXVj25gO2HPQ,461
 django_solomon/templates/django_solomon/email/magic_link.mjml,sha256=OnfVGm2yFrOmoQ1syo6-Duq_Qraf3Tv0Vy5oidvt55g,1427
 django_solomon/templates/django_solomon/email/magic_link.txt,sha256=yl01eie3U2HkFEJvB1Qlm8Z6FPuop5yubDXFY5V507Q,502
-django_solomon-0.4.3.dist-info/METADATA,sha256=RFZs39oVqVqI_Hc8LlX25fQC7shz7qdvZsMiPAp6MCs,10508
-django_solomon-0.4.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-django_solomon-0.4.3.dist-info/licenses/LICENSE,sha256=tbfFOFdH5mHIfmNGo6KGOC3U8f-hTCLfetcr8A89WwI,1071
-django_solomon-0.4.3.dist-info/RECORD,,
+django_solomon-0.5.0.dist-info/METADATA,sha256=KmHBIVEGRYWuemsWRm4YLBEA2Wx-Wn2w1DCNoWzWnUQ,10792
+django_solomon-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+django_solomon-0.5.0.dist-info/licenses/LICENSE,sha256=tbfFOFdH5mHIfmNGo6KGOC3U8f-hTCLfetcr8A89WwI,1071
+django_solomon-0.5.0.dist-info/RECORD,,

django_solomon/migrations/0002_magiclink_ip_address.py

@@ -1,18 +0,0 @@
-# Generated by Django 5.2 on 2025-04-20 14:59
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('django_solomon', '0001_initial'),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name='magiclink',
-            name='ip_address',
-            field=models.GenericIPAddressField(blank=True, null=True, verbose_name='IP Address'),
-        ),
-    ]

django_solomon/migrations/0003_add_unique_constraint_auth_user_email.py

@@ -1,42 +0,0 @@
-from django.db import migrations, models
-
-
-# Copyright (c) 2023 Carlton Gibson
-# This migration is taken from the fantastic project `django-unique-user-email` created by Carlton Gibson.
-# https://github.com/carltongibson/django-unique-user-email/
-
-
-class CustomAddConstraint(migrations.AddConstraint):
-    """
-    Override app_label to target auth.User
-    """
-
-    def state_forwards(self, app_label, state):
-        state.add_constraint("auth", self.model_name_lower, self.constraint)
-
-    def database_forwards(self, app_label, schema_editor, from_state, to_state):
-        model = to_state.apps.get_model("auth", self.model_name)
-        if self.allow_migrate_model(schema_editor.connection.alias, model):
-            schema_editor.add_constraint(model, self.constraint)
-
-    def database_backwards(self, app_label, schema_editor, from_state, to_state):
-        model = to_state.apps.get_model("auth", self.model_name)
-        if self.allow_migrate_model(schema_editor.connection.alias, model):
-            schema_editor.remove_constraint(model, self.constraint)
-
-
-class Migration(migrations.Migration):
-    dependencies = [
-        ("django_solomon", "0002_magiclink_ip_address"),
-        ("auth", "0012_alter_user_first_name_max_length"),
-    ]
-
-    operations = [
-        CustomAddConstraint(
-            model_name="user",
-            constraint=models.UniqueConstraint(
-                fields=["email"],
-                name="unique_user_email",
-            ),
-        ),
-    ]