django-pfx 1.4.dev96__tar.gz → 1.4.dev100__tar.gz

{django_pfx-1.4.dev96 → django_pfx-1.4.dev100}/PKG-INFO

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: django-pfx
-Version: 1.4.dev96
+Version: 1.4.dev100
 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.dev96 → django_pfx-1.4.dev100}/django_pfx.egg-info/SOURCES.txt

@@ -114,6 +114,7 @@ pfx/pfxcore/views/parameters/subset_page_subset.py
 pfx/settings/__init__.py
 pfx/settings/dev.py
 tests/__init__.py
+tests/apps.py
 tests/models.py
 tests/urls.py
 tests/views.py

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

@@ -0,0 +1,96 @@
+import inspect
+import logging
+from pathlib import Path
+
+from django import apps
+from django.apps import AppConfig
+from django.db.models.signals import post_migrate
+
+import yaml
+
+from pfx.pfxcore.shortcuts import permissions, settings
+
+logger = logging.getLogger(__name__)
+
+
+def update_groups_permissions(
+        groups, base_path, group_cache, is_last, module, out=True):
+    from django.contrib.auth.models import Group
+
+    out and print(f"Import file {base_path}/groups.yaml", end=" ")
+    todo = False
+
+    def log(txt):
+        if not out:
+            return
+        nonlocal todo
+        if not todo:
+            print()
+            todo = True
+        print("  * ", txt)
+
+    db_groups = {g.name: g for g in Group.objects.all()}
+
+    for name, perms in groups.items():
+        group_cache.add(name)
+        created = name not in db_groups
+        group = Group.objects.create(name=name) if created else db_groups[name]
+        if created:
+            log(f"Create group {name}")
+        current_perms = {
+            f'{p.content_type.app_label}.{p.codename}'
+            for p in group.permissions.filter(content_type__app_label=module)}
+        if created or not settings.PFX_AUTH_GROUPS_CREATE_ONLY:
+            to_add = set(perms) - current_perms
+            to_remove = current_perms - set(perms)
+            if to_add:
+                log(f"Add permissions for group {name}: {', '.join(to_add)}")
+                group.permissions.add(*permissions(*to_add))
+            if to_remove:
+                log(f"Remove permissions for group {name}: "
+                    f"{', '.join(to_remove)}")
+                group.permissions.remove(*permissions(*to_remove))
+
+    if is_last and not settings.PFX_AUTH_GROUPS_CREATE_ONLY:
+        names = db_groups.keys() - group_cache
+        if names:
+            log(f"Delete groups: {', '.join(names)}")
+            Group.objects.filter(name__in=names).delete()
+
+    if not todo:
+        out and print("[nothing to do]")
+
+
+def update_groups_permissions_action(sender, **kwargs):
+    if not isinstance(sender, PfxAppConfig):
+        return
+
+    base_path = '/'.join(sender.__class__.__module__.split('.')[:-1])
+    is_last = [
+        a for a in apps.apps.get_app_configs()
+        if isinstance(a, PfxAppConfig)][-1].name == sender.name
+    module = Path(inspect.getfile(sender.__class__)).parent.name
+
+    groups_file = Path(
+        Path(inspect.getfile(sender.__class__)).parent, 'groups.yaml')
+    if not groups_file.exists():
+        return
+
+    with groups_file.open() as file:
+        groups = yaml.safe_load(file)
+
+    update_groups_permissions(
+        groups, base_path, sender._processed_groups, is_last, module)
+
+
+class PfxAppConfig(AppConfig):
+    _processed_groups = set()
+
+    def ready(self):
+        post_migrate.connect(update_groups_permissions_action, sender=self)
+        return super().ready()
+
+
+class PfxCoreConfig(AppConfig):
+    name = 'pfx.pfxcore'
+    default = True

{django_pfx-1.4.dev96 → django_pfx-1.4.dev100}/pfx/pfxcore/default_settings.py

@@ -31,5 +31,4 @@ 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.dev96 → django_pfx-1.4.dev100}/pfx/pfxcore/models/pfx_models.py

@@ -23,8 +23,12 @@ class UniqueConstraint(models.UniqueConstraint):
 class JSONReprMixin():
     """A model mixin to manage JSON representation."""
     api = None
+    url = None
     apidoc = {}
 
+    def get_url(self):
+        return self.url
+
     def json_repr(self, **values):
         """Return the JSON representation of a mode instance.
 
@@ -39,6 +43,11 @@ class JSONReprMixin():
             res['resource_slug'] = self.slug
         if hasattr(self, 'reference'):
             res['resource_reference'] = self.reference
+        if self.api:
+            res['resource_api'] = f"{self.api}/{self.pk}"
+        url = self.get_url()
+        if url:
+            res['resource_url'] = f"{url}/{self.pk}"
         res.update(**values)
         return res
 

django_pfx-1.4.dev100/tests/apps.py

@@ -0,0 +1,7 @@
+from pfx.pfxcore import PfxAppConfig
+
+
+class AccountConfig(PfxAppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'tests'
+    default = True

{django_pfx-1.4.dev96 → django_pfx-1.4.dev100}/tests/tests/test_post_migrate_groups_update.py

@@ -8,16 +8,13 @@ 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)
+        update_groups_permissions(dict(
+            reader=[
+                'tests.view_author'],
+            editor=[
+                'tests.view_author',
+                'tests.add_author']), 'tests', set(), True, 'tests', False)
 
         groups = {g.name: g for g in Group.objects.all()}
         self.assertEqual(groups.keys(), {'reader', 'editor'})
@@ -26,14 +23,11 @@ class TestPostMigrateGroupsUpdate(TestAssertMixin, TestCase):
         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)
+        update_groups_permissions(dict(
+            editor=[
+                'tests.view_author',
+                'tests.change_author'],
+            new=[]), 'tests', set(), True, 'tests', False)
 
         groups = {g.name: g for g in Group.objects.all()}
         self.assertEqual(groups.keys(), {'editor', 'new'})
@@ -42,16 +36,14 @@ class TestPostMigrateGroupsUpdate(TestAssertMixin, TestCase):
         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)
+    @override_settings(PFX_AUTH_GROUPS_CREATE_ONLY=True)
     def test_groups_create_only(self):
-        update_groups_permissions(self)
+        update_groups_permissions(dict(
+            reader=[
+                'tests.view_author'],
+            editor=[
+                'tests.view_author',
+                'tests.add_author']), 'tests', set(), True, 'tests', False)
 
         groups = {g.name: g for g in Group.objects.all()}
         self.assertEqual(groups.keys(), {'reader', 'editor'})
@@ -60,14 +52,11 @@ class TestPostMigrateGroupsUpdate(TestAssertMixin, TestCase):
         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)
+        update_groups_permissions(dict(
+            editor=[
+                'tests.view_author',
+                'tests.change_author'],
+            new=[]), 'tests', set(), True, 'tests', False)
 
         groups = {g.name: g for g in Group.objects.all()}
         self.assertEqual(groups.keys(), {'reader', 'editor', 'new'})

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

@@ -1,36 +0,0 @@
-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 PfxAppConfig(AppConfig):
-    def ready(self):
-        if settings.PFX_AUTH_GROUPS is not None:
-            post_migrate.connect(update_groups_permissions, sender=self)
-        return super().ready()
-
-
-class PfxCoreConfig(AppConfig):
-    name = 'pfx.pfxcore'
-    default = True