bazis-users 2.2.0__py3-none-any.whl

bazis/contrib/users/__init__.py

@@ -0,0 +1,31 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+try:
+    from importlib.metadata import PackageNotFoundError, version
+    __version__ = version('bazis-users')
+except PackageNotFoundError:
+    __version__ = 'dev'
+
+from django.conf import settings
+from django.contrib.auth import get_user_model
+
+from bazis.core.utils.imp import import_class
+
+
+def get_anonymous_user_model():
+    """
+    Retrieve the anonymous user model class specified in the Django settings.
+    """
+    return import_class(settings.AUTH_ANONYMOUS_USER_MODEL)

bazis/contrib/users/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '2.2.0'
+__version_tuple__ = version_tuple = (2, 2, 0)
+
+__commit_id__ = commit_id = None

bazis/contrib/users/admin_abstract.py

@@ -0,0 +1,40 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.utils.translation import gettext_lazy as _
+
+
+class UserAdminAbstract:
+
+    def get_fields_common(self, request, obj=None):
+        return ('username', 'password')
+
+    def get_fields_personal(self, request, obj=None):
+        return ('first_name', 'last_name', 'email')
+
+    def get_fields_permissions(self, request, obj=None):
+        return ('is_active', 'is_staff', 'is_superuser')
+
+    def get_fields_dates(self, request, obj=None):
+        return ('last_login', 'date_joined', 'dt_first_login')
+
+    def get_fieldsets(self, request, obj=None):
+        if not obj:
+            return self.add_fieldsets
+        return (
+            (None, {'fields': self.get_fields_common(request, obj)}),
+            (_('Personal info'), {'fields': self.get_fields_personal(request, obj)}),
+            (_('Permissions'), {'fields': self.get_fields_permissions(request, obj)}),
+            (_('Important dates'), {'fields': self.get_fields_dates(request, obj)}),
+        )

bazis/contrib/users/apps.py

@@ -0,0 +1,28 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.utils.translation import gettext_lazy as _
+
+from bazis.core.utils.apps import BaseConfig
+
+
+class UsersConfig(BaseConfig):
+    """
+    Configuration class for the 'users' application within the Bazis project. It
+    sets the application name and provides a human-readable name for the application
+    using Django's translation utilities.
+    """
+
+    name = 'bazis.contrib.users'
+    verbose_name = _('Users')

bazis/contrib/users/conf.py

@@ -0,0 +1,41 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from django.utils.translation import gettext_lazy as _
+
+from pydantic import Field
+
+from jose.constants import Algorithms
+
+from bazis.core.utils.schemas import BazisSettings
+
+
+class Settings(BazisSettings):
+    """
+    Settings class inherits from BazisSettings and defines various configuration
+    parameters for the application, including user models, OpenAPI token endpoint,
+    JWT algorithm, and JWT session lifetime.
+    """
+
+    AUTH_USER_MODEL: str = Field('users.User', title=_('Default user model'))
+    AUTH_ANONYMOUS_USER_MODEL: str = Field(
+        'bazis.contrib.users.models.AnonymousUser', title=_('Default anonymous user model')
+    )
+    BAZIS_OPENAPI_TOKEN_URL: str = Field('/api/openapi-token/', title=_('OpenAPI token`s endpoint'))
+    BAZIS_AUTH_COOKIE_NAME: str = Field('bazis_auth', title=_('Name of the user cookie'))
+    BAZIS_JWT_SESSION_ALG: str = Field(Algorithms.HS256, title=_('JWT algorithm'))
+    BAZIS_JWT_SESSION_LIFETIME: int = Field(86400, title=_('JWT lifetime'), dynamic=True)
+
+
+settings = Settings()

bazis/contrib/users/locale/en/LC_MESSAGES/django.po

@@ -0,0 +1,63 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-07-04 13:45+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: apps.py:13 router.py:7
+msgid "Users"
+msgstr ""
+
+#: conf.py:14
+msgid "Default user model"
+msgstr ""
+
+#: conf.py:16
+msgid "Default anonymous user model"
+msgstr ""
+
+#: conf.py:18
+msgid "OpenAPI token`s endpoint"
+msgstr ""
+
+#: conf.py:19
+msgid "JWT algorithm"
+msgstr ""
+
+#: conf.py:20
+msgid "JWT lifetime"
+msgstr ""
+
+#: models_abstract.py:30
+msgid "user"
+msgstr ""
+
+#: models_abstract.py:31
+msgid "users"
+msgstr ""
+
+#: routes.py:30
+msgid "Credentials are invalid"
+msgstr ""
+
+#: service.py:31
+msgid "Token expired"
+msgstr ""
+
+#: service.py:54
+msgid "Token is invalid"
+msgstr ""

bazis/contrib/users/locale/ru/LC_MESSAGES/django.po

@@ -0,0 +1,81 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2025-03-29 00:27+0300\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=4; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && "
+"n%10<=4 && (n%100<12 || n%100>14) ? 1 : n%10==0 || (n%10>=5 && n%10<=9) || "
+"(n%100>=11 && n%100<=14)? 2 : 3);\n"
+
+#: admin_abstract.py:23
+msgid "Personal info"
+msgstr ""
+
+#: admin_abstract.py:24
+msgid "Permissions"
+msgstr ""
+
+#: admin_abstract.py:25
+msgid "Important dates"
+msgstr ""
+
+#: apps.py:14 router.py:7
+msgid "Users"
+msgstr "Пользователи"
+
+#: conf.py:15
+msgid "Default user model"
+msgstr "Модель пользователя по умолчанию"
+
+#: conf.py:17
+msgid "Default anonymous user model"
+msgstr "Модель анонимного пользователя по умолчанию"
+
+#: conf.py:19
+msgid "OpenAPI token`s endpoint"
+msgstr "Эндпоинт для токена OpenAPI"
+
+#: conf.py:20
+msgid "Name of the user cookie"
+msgstr ""
+
+#: conf.py:21
+msgid "JWT algorithm"
+msgstr "Алгоритм JWT"
+
+#: conf.py:22
+msgid "JWT lifetime"
+msgstr "Срок жизни JWT"
+
+#: models_abstract.py:34
+msgid "user"
+msgstr "пользователь"
+
+#: models_abstract.py:35
+msgid "users"
+msgstr "Пользователи"
+
+#: routes.py:29
+msgid "Credentials are invalid"
+msgstr "Учетные данные недействительны"
+
+#: service.py:36
+msgid "Token expired"
+msgstr "Срок действия токена истек"
+
+#: service.py:61
+msgid "Token is invalid"
+msgstr "Токен недействителен"

bazis/contrib/users/middleware.py

@@ -0,0 +1,37 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from .models_abstract import UserMixin
+
+
+class UserRequestMiddleware:
+    """
+    Middleware that attaches the current authenticated user to the context for the
+    duration of the request.
+    """
+
+    def __init__(self, get_response):
+        """
+        Initializes the middleware with the given response handler.
+        """
+        self.get_response = get_response
+
+    def __call__(self, request):
+        """
+        Processes the incoming request, setting the user in the context if the user is
+        authenticated, and then passes the request to the next middleware or view.
+        """
+        if request.user and getattr(request.user, 'is_anonymous', None) is False:
+            UserMixin.CTX_USER_REQUEST.set(request.user)
+        return self.get_response(request)

bazis/contrib/users/migrations/0001_initial.py

@@ -0,0 +1,63 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generated by Django 5.0.1 on 2024-02-14 15:51
+
+import uuid
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.utils.timezone
+from django.db import migrations, models
+
+import model_clone.mixin
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='User',
+            fields=[
+                ('id', models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ('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')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('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')),
+                ('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,
+            },
+            bases=(model_clone.mixin.CloneMixin, models.Model),
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

bazis/contrib/users/migrations/0002_user_dt_first_login.py

@@ -0,0 +1,34 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generated by Django 6.0.1 on 2026-01-16 17:38
+
+from django.db import migrations, models
+from django.utils.translation import gettext_lazy as _
+
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='user',
+            name='dt_first_login',
+            field=models.DateTimeField(blank=True, null=True, verbose_name='Date/time of first login'),
+        ),
+    ]

bazis/contrib/users/migrations/__init__.py

@@ -0,0 +1,14 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+

bazis/contrib/users/models.py

@@ -0,0 +1,34 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from bazis.contrib.users.models_abstract import AnonymousUserAbstract, UserAbstract
+from bazis.core.models_abstract import JsonApiMixin, UuidMixin
+
+
+class User(JsonApiMixin, UuidMixin, UserAbstract):
+    """
+    Represents a user in the system, combining JSON API support, UUID functionality,
+    and user-specific attributes and methods.
+    """
+
+    pass
+
+
+class AnonymousUser(AnonymousUserAbstract):
+    """
+    Represents an anonymous user with attributes and methods specific to users who
+    are not logged in.
+    """
+
+    pass

bazis/contrib/users/models_abstract.py

@@ -0,0 +1,156 @@
+# Copyright 2026 EcoFuture Technology Services LLC and contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+The module provides mixins for working with User
+"""
+
+from contextvars import ContextVar
+from datetime import timedelta
+
+from django.conf import settings
+from django.contrib.auth.models import AbstractUser
+from django.contrib.auth.models import AnonymousUser as BaseAnonymousUser
+from django.contrib.auth.signals import user_logged_in
+from django.contrib.gis.db import models
+from django.db import IntegrityError, transaction
+from django.dispatch import receiver
+from django.utils.timezone import now
+from django.utils.translation import gettext_lazy as _
+
+from jose import jwt
+
+from bazis.core.models_abstract import InitialBase, JsonApiMixin
+
+
+class UserAbstract(AbstractUser, InitialBase):
+    """
+    Abstract base class for user models, extending Django's AbstractUser and
+    InitialBase.
+    """
+    dt_first_login = models.DateTimeField('Date/time of first login', blank=True, null=True)
+
+    class Meta:
+        """
+        Meta class for UserAbstract, defining verbose names and setting the model as
+        abstract.
+        """
+
+        verbose_name = _('user')
+        verbose_name_plural = _('users')
+        abstract = True
+
+    def get_full_name(self):
+        """
+        Returns the full name of the user, combining first and last name if available,
+        otherwise returns the username.
+        """
+        full_name = ''
+        if self.first_name:
+            full_name = self.first_name
+        if self.last_name:
+            full_name += ' ' + self.last_name
+        return full_name.strip() or self.username
+
+    def jwt_build(self, auth_type=None) -> str:
+        """
+        Generates a JSON Web Token (JWT) for the user, optionally including an
+        authentication type.
+        """
+        data = {
+            'sub': self.username,
+            'exp': now() + timedelta(seconds=settings.BAZIS_JWT_SESSION_LIFETIME),
+        }
+        if auth_type:
+            data['auth_type'] = auth_type
+
+        return jwt.encode(data, settings.SECRET_KEY, algorithm=settings.BAZIS_JWT_SESSION_ALG)
+
+    @classmethod
+    def find_or_create(cls, filters, params):
+        """
+        Class method to find a user by filters or create a new one with the provided
+        parameters, ensuring atomic transactions.
+        """
+        with transaction.atomic():
+            if user := cls.objects.filter(filters).first():
+                return user
+
+            try:
+                with transaction.atomic(savepoint=False):
+                    return cls.objects.create(**params)
+            except IntegrityError:
+                if user := cls.objects.filter(filters).first():
+                    return user
+                raise
+
+    @property
+    def raw_password(self) -> str | None:
+        """
+        Property to get the user's password in a masked format or set a new password.
+        """
+        if self.password:
+            return '**********'
+
+    @raw_password.setter
+    def raw_password(self, value):
+        """
+        Property to get the user's password in a masked format or set a new password.
+        """
+        self.set_password(value)
+
+
+@receiver(user_logged_in)
+def set_dt_first_login(sender, user=None, **kwargs):
+    if user and not user.dt_first_login and user.pk:
+        type(user).objects.filter(pk=user.pk).update(dt_first_login=now())
+
+
+class AnonymousUserAbstract(BaseAnonymousUser):
+    """
+    Mixin for the AnonymousUser class, adding basic fields like first_name,
+    last_name, and email.
+    """
+
+    first_name = ''
+    last_name = ''
+    email = ''
+
+    def get_full_name(self):
+        """
+        Returns the full name of the anonymous user, combining first and last name if
+        available, otherwise returns the username.
+        """
+        full_name = ''
+        if self.first_name:
+            full_name = self.first_name
+        if self.last_name:
+            full_name += ' ' + self.last_name
+        return full_name.strip() or self.username
+
+
+class UserMixin(JsonApiMixin):
+    """
+    Mixin that allows saving the current user in the context using a ContextVar.
+    """
+
+    #: Context variable in which the current active user can be stored
+    CTX_USER_REQUEST: ContextVar['UserMixin'] = ContextVar('CTX_USER_REQUEST', default=None)
+
+    class Meta:
+        """
+        Meta class for UserMixin, setting the model as abstract.
+        """
+
+        abstract = True