django-pfx 1.4.dev70__tar.gz → 1.4.dev74__tar.gz

{django_pfx-1.4.dev70 → django_pfx-1.4.dev74}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev70
+Version: 1.4.dev74
 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.dev70 → django_pfx-1.4.dev74}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev70
+Version: 1.4.dev74
 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.dev70 → django_pfx-1.4.dev74}/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
@@ -137,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.dev74/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.dev70 → django_pfx-1.4.dev74}/pfx/pfxcore/decorator/rest.py

@@ -14,8 +14,8 @@ logger = logging.getLogger(__name__)
 
 
 def rest_api(
-        path, method='get', public=None, priority=0, priority_doc=0,
-        parameters=None,
+        path, method='get', public=None, perms=None,
+        priority=0, priority_doc=0, parameters=None,
         request_schema=None, response_schema=None, filters=False,
         search=False, groups=None):
     def decorator(func):
@@ -31,7 +31,7 @@ def rest_api(
                     'HTTP_X_PRINT_REQUEST' in request.META):
                 print(format_request(request))
             try:
-                self.check_perm(public, func.__name__, *args, **kwargs)
+                self.check_perm(public, func.__name__, perms, *args, **kwargs)
                 return func(self, *args, **kwargs)
             except APIError as e:
                 return e.response

{django_pfx-1.4.dev70 → django_pfx-1.4.dev74}/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.dev70 → django_pfx-1.4.dev74}/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-22 16:36+0100\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"

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

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

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

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

django_pfx-1.4.dev74/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.dev70 → django_pfx-1.4.dev74}/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.dev70 → django_pfx-1.4.dev74}/pfx/pfxcore/views/rest_views.py

@@ -1325,7 +1325,7 @@ class SecuredRestViewMixin(View):
             return getattr(self, param)
         return self.default_public if public is None else public
 
-    def check_perm(self, public, func_name, *args, **kwargs):
+    def check_perm(self, public, func_name, perms, *args, **kwargs):
         """Check permissions for a specific service.
 
         Do all checks for a specific service and raise
@@ -1338,6 +1338,12 @@ class SecuredRestViewMixin(View):
             return
         if not self.request.user.is_authenticated:
             raise UnauthorizedError()
+        if isinstance(perms, str):
+            if not self.request.user.has_perm(perms):
+                raise ForbiddenError()
+        elif perms:
+            if not self.request.user.has_perms(perms):
+                raise ForbiddenError()
         if not self.perm():
             raise ForbiddenError()
         fperm = f'{func_name}_perm'

{django_pfx-1.4.dev70 → django_pfx-1.4.dev74}/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.dev70 → django_pfx-1.4.dev74}/tests/models.py

@@ -89,6 +89,7 @@ class Author(CacheableMixin, JSONReprMixin, models.Model):
         verbose_name = "Author"
         verbose_name_plural = "Authors"
         ordering = ['last_name', 'first_name', 'pk']
+        permissions = [("can_customize_author", "Can customize author")]
 
     def __str__(self):
         return f"{self.first_name} {self.last_name}"

{django_pfx-1.4.dev70 → django_pfx-1.4.dev74}/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.dev70 → django_pfx-1.4.dev74}/tests/tests/test_permissions.py

@@ -237,3 +237,49 @@ class TestPermissions(TestAssertMixin, TestCase):
         response = self.client.get(
             f'/api/perms/books/{self.author1_book1.pk}/cover')
         self.assertRC(response, 200)
+
+    def test_custom_get_admin(self):
+        self.client.login(username='admin')
+
+        response = self.client.get('/api/perms/authors/custom')
+        self.assertRC(response, 200)
+
+    def test_custom_get_user(self):
+        self.client.login(username='user')
+
+        response = self.client.get('/api/perms/authors/custom')
+        self.assertRC(response, 403)
+
+        self.user.user_permissions.add(*permissions('tests.view_author'))
+
+        response = self.client.get('/api/perms/authors/custom')
+        self.assertRC(response, 200)
+
+    def test_custom_put_admin(self):
+        self.client.login(username='admin')
+
+        response = self.client.put('/api/perms/authors/custom')
+        self.assertRC(response, 200)
+
+    def test_custom_put_user(self):
+        self.client.login(username='user')
+
+        response = self.client.put('/api/perms/authors/custom')
+        self.assertRC(response, 403)
+
+        self.user.user_permissions.set(permissions('tests.change_author'))
+
+        response = self.client.put('/api/perms/authors/custom')
+        self.assertRC(response, 403)
+
+        self.user.user_permissions.set(permissions(
+            'tests.can_customize_author'))
+
+        response = self.client.put('/api/perms/authors/custom')
+        self.assertRC(response, 403)
+
+        self.user.user_permissions.set(permissions(
+            'tests.change_author', 'tests.can_customize_author'))
+
+        response = self.client.put('/api/perms/authors/custom')
+        self.assertRC(response, 200)

django_pfx-1.4.dev74/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.dev70 → django_pfx-1.4.dev74}/tests/views.py

@@ -191,7 +191,15 @@ class PrivateAuthorRestView(AuthorRestViewMixin, RestView):
 @rest_view("/perms/authors")
 class PermsAuthorRestView(
         AuthorRestViewMixin, SlugPermsDetailRestViewMixin, PermsRestView):
-    pass
+
+    @rest_api("/custom", method="get", perms='tests.view_author')
+    def get_custom(self):
+        return JsonResponse(dict(message='Custom get'))
+
+    @rest_api("/custom", method="put", perms=[
+        'tests.change_author', 'tests.can_customize_author'])
+    def get_custom_action(self):
+        return JsonResponse(dict(message='Custom put'))
 
 
 @rest_view("/admin-edit/authors")

django_pfx-1.4.dev70/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'