django-pfx 1.4.dev72__tar.gz → 1.4.dev76__tar.gz

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev72
+Version: 1.4.dev76
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev72
+Version: 1.4.dev76
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/django_pfx.egg-info/SOURCES.txt

@@ -64,6 +64,8 @@ pfx/pfxcore/migrations/0001_initial.py
 pfx/pfxcore/migrations/0002_pfxpermissionsuser.py
 pfx/pfxcore/migrations/0003_delete_pfxpermissionsuser.py
 pfx/pfxcore/migrations/__init__.py
+pfx/pfxcore/migrations/operations/__init__.py
+pfx/pfxcore/migrations/operations/permissions.py
 pfx/pfxcore/models/__init__.py
 pfx/pfxcore/models/abstract_pfx_base_user.py
 pfx/pfxcore/models/cache_mixins.py
@@ -115,7 +117,6 @@ tests/urls.py
 tests/views.py
 tests/locale/fr/LC_MESSAGES/django.po
 tests/migrations/0001_initial.py
-tests/migrations/0002_alter_author_options.py
 tests/migrations/__init__.py
 tests/settings/__init__.py
 tests/settings/ci.py
@@ -138,6 +139,7 @@ tests/tests/test_locale_api.py
 tests/tests/test_perm_tests.py
 tests/tests/test_permissions.py
 tests/tests/test_perms_api.py
+tests/tests/test_post_migrate_groups_update.py
 tests/tests/test_profiling_middleware.py
 tests/tests/test_settings.py
 tests/tests/test_shortcuts.py

django_pfx-1.4.dev76/pfx/pfxcore/apps.py

@@ -0,0 +1,31 @@
+import logging
+
+from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+
+from pfx.pfxcore.shortcuts import permissions, settings
+
+logger = logging.getLogger(__name__)
+
+
+def update_groups_permissions(sender, **kwargs):
+    from django.contrib.auth.models import Group
+    groups = {g.name: g for g in Group.objects.all()}
+
+    for name, perms in settings.PFX_AUTH_GROUPS.items():
+        created = name not in groups
+        group = Group.objects.create(name=name) if created else groups[name]
+        if created or not settings.PFX_AUTH_GROUPS_CREATE_ONLY:
+            group.permissions.set(permissions(*perms))
+
+    if not settings.PFX_AUTH_GROUPS_CREATE_ONLY:
+        names = groups.keys() - settings.PFX_AUTH_GROUPS.keys()
+        Group.objects.filter(name__in=names).delete()
+
+
+class PfxCoreConfig(AppConfig):
+    name = 'pfx.pfxcore'
+
+    def ready(self):
+        if settings.PFX_AUTH_GROUPS is not None:
+            post_migrate.connect(update_groups_permissions, sender=self)

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/default_settings.py

@@ -30,3 +30,6 @@ STORAGE_S3_AWS_PUT_URL_EXPIRE = None
 STORAGE_S3_AWS_GET_URL_EXPIRE = None
 
 PFX_TEST_MODE = False
+
+PFX_AUTH_GROUPS = None
+PFX_AUTH_GROUPS_CREATE_ONLY = False

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2025-01-21 18:35+0100\n"
+"POT-Creation-Date: 2025-01-29 12:33+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -103,7 +103,7 @@ msgstr "Compte HOTP"
 msgid "HOTP expiry"
 msgstr "Expiration HOTP"
 
-#: models/otp_user_mixin.py:29 views/authentication_views.py:491
+#: models/otp_user_mixin.py:29 views/authentication_views.py:492
 msgid "OTP enabled"
 msgstr "OTP activé"
 
@@ -204,7 +204,7 @@ msgstr "Bienvenue sur %(site_name)s."
 msgid "Welcome on %(site_name)s"
 msgstr "Bienvenue sur %(site_name)s"
 
-#: views/authentication_views.py:81
+#: views/authentication_views.py:82
 #, python-brace-format
 msgid ""
 "Your connection is temporarily disabled after several unsuccessful attempts, "
@@ -213,43 +213,43 @@ msgstr ""
 "Votre connexion est temporairement désactivée après plusieurs tentatives "
 "infructueuses, veuillez réessayer dans {seconds} secondes."
 
-#: views/authentication_views.py:173
+#: views/authentication_views.py:174
 msgid "Successful login"
 msgstr "Connexion réussie"
 
-#: views/authentication_views.py:243 views/authentication_views.py:408
+#: views/authentication_views.py:244 views/authentication_views.py:409
 msgid "password updated successfully"
 msgstr "le mot de passe a été mis à jour avec succès"
 
-#: views/authentication_views.py:248
+#: views/authentication_views.py:249
 msgid "Incorrect password"
 msgstr "Mot de passe incorrect"
 
-#: views/authentication_views.py:251 views/authentication_views.py:417
+#: views/authentication_views.py:252 views/authentication_views.py:418
 msgid "Empty password is not allowed"
 msgstr "Un mot de passe vide n’est pas autorisé"
 
-#: views/authentication_views.py:342
+#: views/authentication_views.py:343
 msgid "User and token are valid"
 msgstr "L'utilisateur et le token sont valides"
 
-#: views/authentication_views.py:344
+#: views/authentication_views.py:345
 msgid "User or token is invalid"
 msgstr "L'utilisateur ou le token est invalide"
 
-#: views/authentication_views.py:451
+#: views/authentication_views.py:452
 msgid "OTP is already enabled"
 msgstr "OTP est déjà activé"
 
-#: views/authentication_views.py:492 views/authentication_views.py:528
+#: views/authentication_views.py:493 views/authentication_views.py:529
 msgid "Invalid code"
 msgstr "Code invalide"
 
-#: views/authentication_views.py:527
+#: views/authentication_views.py:528
 msgid "OTP disabled"
 msgstr "OTP désactivé"
 
-#: views/authentication_views.py:787
+#: views/authentication_views.py:789
 msgid ""
 "If the email address you entered is correct, you will receive an email from "
 "us with instructions to reset your password."
@@ -258,7 +258,7 @@ msgstr ""
 "un courrier électronique de notre part contenant des instructions pour "
 "réinitialiser votre mot de passe."
 
-#: views/authentication_views.py:861
+#: views/authentication_views.py:863
 msgid "A new authentication code has been sent by email."
 msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
 
@@ -273,21 +273,21 @@ msgid "{obj} cannot be deleted because it is referenced by other objects."
 msgstr ""
 "{obj} ne peut pas être supprimé car il est référencé par d’autres objets."
 
-#: views/rest_views.py:342
+#: views/rest_views.py:327
 #, python-brace-format
 msgid "{model} {obj} created."
 msgstr "{model} {obj} créé."
 
-#: views/rest_views.py:343
+#: views/rest_views.py:328
 #, python-brace-format
 msgid "{model} {obj} updated."
 msgstr "{model} {obj} modifié."
 
-#: views/rest_views.py:1141
+#: views/rest_views.py:1153
 #, python-brace-format
 msgid "{model} {obj} deleted."
 msgstr "{model} {obj} supprimé."
 
-#: views/rest_views.py:1240 views/rest_views.py:1280
+#: views/rest_views.py:1252 views/rest_views.py:1292
 msgid "Unexpected storage error"
 msgstr "Erreur de stockage inattendue"

django_pfx-1.4.dev76/pfx/pfxcore/migrations/__init__.py

@@ -0,0 +1,3 @@
+from django.db.migrations import *
+
+from .operations import *

django_pfx-1.4.dev76/pfx/pfxcore/migrations/operations/__init__.py

@@ -0,0 +1 @@
+from .permissions import CreateGroup, DeleteGroup, RenameGroup

django_pfx-1.4.dev76/pfx/pfxcore/migrations/operations/permissions.py

@@ -0,0 +1,87 @@
+from django.db.migrations.operations.base import Operation
+
+
+class GroupPermsOperation(Operation):
+    def state_forwards(self, app_label, state):
+        pass
+
+
+class CreateGroup(GroupPermsOperation):
+    """Create a group."""
+
+    def __init__(self, name):
+        self.group_name = name
+
+    def deconstruct(self):
+        return (self.__class__.__qualname__, [self.group_name], {})
+
+    def database_forwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            Group.objects.create(name=self.group_name)
+
+    def database_backwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            Group.objects.get(name=self.group_name).delete()
+
+    def describe(self):
+        return (f"Create group {self.group_name}")
+
+
+class DeleteGroup(GroupPermsOperation):
+    """Delete a group."""
+
+    def __init__(self, name):
+        self.group_name = name
+
+    def deconstruct(self):
+        return (self.__class__.__qualname__, [self.group_name], {})
+
+    def database_forwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            Group.objects.get(name=self.group_name).delete()
+
+    def database_backwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            Group.objects.create(name=self.group_name)
+
+    def describe(self):
+        return (f"Create group {self.group_name}")
+
+
+class RenameGroup(GroupPermsOperation):
+    """Rename a group."""
+
+    def __init__(self, old_name, new_name):
+        self.group_old_name = old_name
+        self.group_new_name = new_name
+
+    def deconstruct(self):
+        return (self.__class__.__qualname__, [
+            self.group_old_name, self.group_new_name], {})
+
+    def database_forwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            group = Group.objects.get(name=self.group_old_name)
+            group.name = self.group_new_name
+            group.save()
+
+    def database_backwards(
+            self, app_label, schema_editor, from_state, to_state):
+        Group = to_state.apps.get_model('auth', 'Group')
+        if self.allow_migrate_model(schema_editor.connection.alias, Group):
+            group = Group.objects.get(name=self.group_new_name)
+            group.name = self.group_old_name
+            group.save()
+
+    def describe(self):
+        return (f"Rename group {self.group_old_name} to {self.group_new_name}")

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/shortcuts.py

@@ -128,8 +128,11 @@ def permissions(*perms):
     pks = set()
     for perm in perms:
         app_label, codename = perm.split('.')
-        pks.add(Permission.objects.get(
-            codename=codename, content_type__app_label=app_label).pk)
+        try:
+            pks.add(Permission.objects.get(
+                codename=codename, content_type__app_label=app_label).pk)
+        except Permission.DoesNotExist:
+            raise Exception(f"Permission {perm} does not exists.")
     return Permission.objects.filter(pk__in=pks)
 
 

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/views/authentication_views.py

@@ -10,6 +10,7 @@ from django.contrib.auth.tokens import default_token_generator
 from django.core.exceptions import ValidationError
 from django.core.mail import EmailMultiAlternatives
 from django.core.validators import validate_email
+from django.db import transaction
 from django.template import loader
 from django.utils.decorators import method_decorator
 from django.utils.encoding import force_bytes
@@ -724,8 +725,9 @@ class SignupView(SendMessageTokenMixin, CreateRestViewMixin, BaseRestView):
         super().validate(obj, **kwargs)
 
     def is_valid(self, obj, created=True, **kwargs):
-        r = super().is_valid(obj, created, **kwargs)
-        self.send_token_message(obj)
+        with transaction.atomic():
+            r = super().is_valid(obj, created, **kwargs)
+            self.send_token_message(obj)
         return r
 
 

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/views/fields.py

@@ -117,7 +117,8 @@ class ViewField:
                 dict(label=_(v), value=k) for k, v in self.choices.items()]
         if self.related_model:
             res['model'] = self.related_model._meta.label
-            res['api'] = self.related_model_api or self.related_model.api
+            res['api'] = self.related_model_api or getattr(
+                self.related_model, 'api', None)
         res['readonly'] = dict(
             post=self.readonly_create,
             put=self.readonly_update)
@@ -362,14 +363,15 @@ class VF:
             self, name, verbose_name=None, field_type=None, alias=None,
             readonly=False, readonly_create=False, readonly_update=False,
             choices=None, select_related=None, prefetch_related=None,
-            json_repr=None):
+            json_repr=None, related_model=None, related_model_api=None):
         self.kwargs = dict(
             name=name, verbose_name=verbose_name, field_type=field_type,
             alias=alias,
             readonly=readonly, readonly_create=readonly_create,
             readonly_update=readonly_update, choices=choices,
             select_related=select_related, prefetch_related=prefetch_related,
-            json_repr=json_repr)
+            json_repr=json_repr, related_model=related_model,
+            related_model_api=related_model_api)
 
     def to_field(self, model):
         return ViewField.from_name(model, **self.kwargs)

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/pfx/pfxcore/views/rest_views.py

@@ -314,6 +314,23 @@ class ModelResponseMixin(ModelMixin):
         """
         obj.full_clean(**kwargs)
 
+    def is_valid_response_meta(self, obj, created=False):
+        """Prepare the defaut meta for is_valid responce.
+
+        :param obj: The object instance
+        :param created: If object instance is created
+        :returns: The JSON response
+        :rtype: :class:`JsonResponse`
+        """
+        message = (
+                created and
+                _("{model} {obj} created.") or
+                _("{model} {obj} updated."))
+        return dict(
+            created=created,
+            message=f(
+                message, model=self.model_name, obj=object))
+
     def is_valid(self, obj, created=False, rel_data=None):
         """Persist an object instance changes and build default response.
 
@@ -337,14 +354,9 @@ class ModelResponseMixin(ModelMixin):
                     getattr(obj, k).set(v)
         else:
             obj.save()
-        message = (
-                created and
-                _("{model} {obj} created.") or
-                _("{model} {obj} updated."))
-        object = self.get_object(pk=obj.pk)
+        obj = self.get_object(pk=obj.pk)
         return self.response(
-            object, message=f(
-                message, model=self.model_name, obj=object))
+            obj, **self.is_valid_response_meta(obj, created=created))
 
     def is_invalid(self, obj, errors):
         """Build a 422 response for invalid object instance.

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/tests/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.17 on 2025-01-21 08:32
+# Generated by Django 4.2.17 on 2025-01-22 07:34
 # flake8: noqa
 
 import django.contrib.auth.models
@@ -40,6 +40,7 @@ class Migration(migrations.Migration):
                 'verbose_name': 'Author',
                 'verbose_name_plural': 'Authors',
                 'ordering': ['last_name', 'first_name', 'pk'],
+                'permissions': [('can_customize_author', 'Can customize author')],
             },
             bases=(pfx.pfxcore.models.cache_mixins.CacheableMixin, pfx.pfxcore.models.pfx_models.JSONReprMixin, models.Model),
         ),

{django_pfx-1.4.dev72 → django_pfx-1.4.dev76}/tests/tests/__init__.py

@@ -12,6 +12,7 @@ from .test_locale_api import LocaleAPITest
 from .test_perm_tests import PermTestsTest
 from .test_permissions import TestPermissions
 from .test_perms_api import PermsAPITest
+from .test_post_migrate_groups_update import TestPostMigrateGroupsUpdate
 from .test_profiling_middleware import ProfilingMiddlewareTest
 from .test_settings import TestSettings
 from .test_shortcuts import ShortcutTest

django_pfx-1.4.dev76/tests/tests/test_post_migrate_groups_update.py

@@ -0,0 +1,79 @@
+from django.contrib.auth.models import Group
+from django.test import TestCase
+from django.test.utils import override_settings
+
+from pfx.pfxcore.apps import update_groups_permissions
+from pfx.pfxcore.test import TestAssertMixin
+
+
+class TestPostMigrateGroupsUpdate(TestAssertMixin, TestCase):
+
+    @override_settings(PFX_AUTH_GROUPS=dict(
+        reader=[
+            'tests.view_author',
+        ],
+        editor=[
+            'tests.view_author',
+            'tests.add_author',
+        ]))
+    def test_groups(self):
+        update_groups_permissions(self)
+
+        groups = {g.name: g for g in Group.objects.all()}
+        self.assertEqual(groups.keys(), {'reader', 'editor'})
+        perms = {p.codename for p in groups['reader'].permissions.all()}
+        self.assertEqual(perms, {'view_author'})
+        perms = {p.codename for p in groups['editor'].permissions.all()}
+        self.assertEqual(perms, {'view_author', 'add_author'})
+
+        with override_settings(
+            PFX_AUTH_GROUPS=dict(
+                editor=[
+                    'tests.view_author',
+                    'tests.change_author',
+                ],
+                new=[])):
+            update_groups_permissions(self)
+
+        groups = {g.name: g for g in Group.objects.all()}
+        self.assertEqual(groups.keys(), {'editor', 'new'})
+        perms = {p.codename for p in groups['editor'].permissions.all()}
+        self.assertEqual(perms, {'view_author', 'change_author'})
+        perms = {p.codename for p in groups['new'].permissions.all()}
+        self.assertEqual(perms, set())
+
+    @override_settings(PFX_AUTH_GROUPS=dict(
+        reader=[
+            'tests.view_author',
+        ],
+        editor=[
+            'tests.view_author',
+            'tests.add_author',
+        ]), PFX_AUTH_GROUPS_CREATE_ONLY=True)
+    def test_groups_create_only(self):
+        update_groups_permissions(self)
+
+        groups = {g.name: g for g in Group.objects.all()}
+        self.assertEqual(groups.keys(), {'reader', 'editor'})
+        perms = {p.codename for p in groups['reader'].permissions.all()}
+        self.assertEqual(perms, {'view_author'})
+        perms = {p.codename for p in groups['editor'].permissions.all()}
+        self.assertEqual(perms, {'view_author', 'add_author'})
+
+        with override_settings(
+            PFX_AUTH_GROUPS=dict(
+                editor=[
+                    'tests.view_author',
+                    'tests.change_author',
+                ],
+                new=[])):
+            update_groups_permissions(self)
+
+        groups = {g.name: g for g in Group.objects.all()}
+        self.assertEqual(groups.keys(), {'reader', 'editor', 'new'})
+        perms = {p.codename for p in groups['reader'].permissions.all()}
+        self.assertEqual(perms, {'view_author'})
+        perms = {p.codename for p in groups['editor'].permissions.all()}
+        self.assertEqual(perms, {'view_author', 'add_author'})
+        perms = {p.codename for p in groups['new'].permissions.all()}
+        self.assertEqual(perms, set())

django_pfx-1.4.dev72/pfx/pfxcore/apps.py

@@ -1,9 +0,0 @@
-import logging
-
-from django.apps import AppConfig
-
-logger = logging.getLogger(__name__)
-
-
-class PfxCoreConfig(AppConfig):
-    name = 'pfx.pfxcore'

django_pfx-1.4.dev72/tests/migrations/0002_alter_author_options.py

@@ -1,18 +0,0 @@
-# Generated by Django 4.2.17 on 2025-01-22 03:31
-# flake8: noqa
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('tests', '0001_initial'),
-    ]
-
-    operations = [
-        migrations.AlterModelOptions(
-            name='author',
-            options={'ordering': ['last_name', 'first_name', 'pk'], 'permissions': [('can_customize_author', 'Can customize author')], 'verbose_name': 'Author', 'verbose_name_plural': 'Authors'},
-        ),
-    ]