drf-iam 0.0.2__py3-none-any.whl → 0.1.0__py3-none-any.whl

drf_iam/utils/load_viewset_permissions.py

@@ -0,0 +1,64 @@
+import inspect
+from django.urls.resolvers import URLPattern, URLResolver
+from rest_framework.viewsets import ViewSetMixin
+from rest_framework.decorators import action
+
+from django.urls import get_resolver
+from ..models import Policy
+
+
+def is_viewset(cls):
+    return isinstance(cls, type) and issubclass(cls, ViewSetMixin)
+
+
+def get_viewset_actions(viewset_cls):
+    actions = set()
+
+    # Default ViewSet methods
+    default_actions = {'list', 'retrieve', 'create', 'update', 'partial_update', 'destroy'}
+    for action_name in default_actions:
+        if hasattr(viewset_cls, action_name):
+            actions.add(action_name)
+
+    # Custom @action methods
+    for name, method in inspect.getmembers(viewset_cls, predicate=inspect.isfunction):
+        if hasattr(method, 'mapping'):
+            for http_method in method.mapping:
+                actions.add(f"{name}")
+
+    return actions
+
+
+def extract_viewsets_from_urlpatterns(urlpatterns, prefix=''):
+    for pattern in urlpatterns:
+        if isinstance(pattern, URLResolver):
+            # Recurse into included URLConfs
+            yield from extract_viewsets_from_urlpatterns(pattern.url_patterns, prefix + str(pattern.pattern))
+        elif isinstance(pattern, URLPattern):
+            callback = pattern.callback
+            cls = getattr(callback, 'cls', None)
+            if is_viewset(cls):
+                yield {
+                    'prefix': prefix,
+                    'pattern': pattern.pattern,
+                    'viewset': cls,
+                    'callback': callback
+                }
+
+
+def load_permissions_from_urls(**kwargs):
+    urlpatterns = get_resolver().url_patterns
+    for entry in extract_viewsets_from_urlpatterns(urlpatterns):
+        viewset_cls = entry['viewset']
+        basename = getattr(viewset_cls,"iam_policy_name") or viewset_cls.__name__.lower().replace('viewset', '')
+        actions = get_viewset_actions(viewset_cls)
+
+        for action in actions:
+            full_action = f"{basename}:{action}"
+            Policy.objects.get_or_create(
+                action=full_action,
+                resource_type=basename,
+                defaults={
+                    'description': f"Permission for {full_action} on {basename}"
+                }
+            )

drf_iam-0.1.0.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.2
+Name: drf-iam
+Version: 0.1.0
+Summary: IAM-style roles and permissions for Django Rest Framework
+Home-page: https://github.com/tushar1328/drf-iam.git
+Author: Tushar Patel
+Author-email: tushar.patel@gmail.com
+Project-URL: Documentation, https://drf-iam.readthedocs.io/en/latest/installation.html
+Project-URL: Source, https://github.com/tushar1328/drf-iam.git
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+Requires-Dist: Django>=3.2
+Requires-Dist: djangorestframework>=3.12
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# DRF-IAM (Django REST Framework - Identity and Access Management)
+
+[![PyPI version](https://badge.fury.io/py/drf-iam.svg)](https://badge.fury.io/py/drf-iam)
+[![Documentation Status](https://readthedocs.org/projects/drf-iam/badge/?version=latest)](https://drf-iam.readthedocs.io/en/latest/?badge=latest)
+
+A powerful Django application that provides Role-Based Access Control (RBAC) for Django REST Framework applications. Easily manage permissions and roles across your API endpoints.
+
+## Features
+
+- 🔒 Role-Based Access Control (RBAC)
+- 🎯 Custom policy names for viewsets
+- 🔄 Seamless integration with Django's User model
+- ⚡ Easy to set up and configure
+- 📚 Comprehensive documentation
+
+## Installation
+
+```bash
+pip install drf-iam
+```
+
+## Quick Start
+
+1. Add `drf_iam` to your `INSTALLED_APPS` in `settings.py`:
+
+```python
+INSTALLED_APPS = [
+    ...
+    'drf_iam',
+]
+```
+
+2. Add the Role relationship to your User model:
+
+```python
+from django.contrib.auth.models import AbstractUser
+from drf_iam.models import Role
+
+class User(AbstractUser):
+    role = models.ForeignKey(Role, on_delete=models.SET_NULL, null=True)
+```
+
+3. Run migrations:
+
+```bash
+python manage.py makemigrations
+python manage.py migrate
+```
+
+4. Use in your viewsets:
+
+```python
+from rest_framework import viewsets
+from drf_iam.permissions import IAMPermission
+
+class UserViewSet(viewsets.ModelViewSet):
+    permission_classes = [IAMPermission]
+    iam_policy_name = "users"  # Optional: Custom policy name for this viewset
+```
+
+## Documentation
+
+For detailed documentation, visit [https://drf-iam.readthedocs.io/](https://drf-iam.readthedocs.io/)
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

{drf_iam-0.0.2.dist-info → drf_iam-0.1.0.dist-info}/RECORD

@@ -6,7 +6,9 @@ drf_iam/permissions.py,sha256=kUhB7V48sb4v3uZI2lWv40hvI85nE61rL-amh6OY8mg,958
 drf_iam/tests.py,sha256=mrbGGRNg5jwbTJtWWa7zSKdDyeB4vmgZCRc2nk6VY-g,60
 drf_iam/migrations/0001_initial.py,sha256=y_4jXnr7gjU4UXxVrgVrStTSFu3h1ZrmjEZDL4FtZa4,3086
 drf_iam/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-drf_iam-0.0.2.dist-info/METADATA,sha256=WLu6QTApO6YfbOO9PYGgzNRyyd3W-JLMS5w_zkOXNJo,1112
-drf_iam-0.0.2.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-drf_iam-0.0.2.dist-info/top_level.txt,sha256=daz6AaQ9e_cfCjLk2aRoLb_PCOoFofYUX4DU85VwHSM,8
-drf_iam-0.0.2.dist-info/RECORD,,
+drf_iam/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+drf_iam/utils/load_viewset_permissions.py,sha256=EVNrldOOkBMjEIoTBlHwSotBOtvW0kHjNONQz_blnxA,2257
+drf_iam-0.1.0.dist-info/METADATA,sha256=SqDZ1fsPg5RyzvNVIjs_nCjpxUjT4Wi_0-aAX11Mmjc,2763
+drf_iam-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+drf_iam-0.1.0.dist-info/top_level.txt,sha256=daz6AaQ9e_cfCjLk2aRoLb_PCOoFofYUX4DU85VwHSM,8
+drf_iam-0.1.0.dist-info/RECORD,,

{drf_iam-0.0.2.dist-info → drf_iam-0.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

drf_iam-0.0.2.dist-info/METADATA

@@ -1,38 +0,0 @@
-Metadata-Version: 2.4
-Name: drf-iam
-Version: 0.0.2
-Summary: IAM-style roles and permissions for Django Rest Framework
-Home-page: https://github.com/tushar1328/drf-iam.git
-Author: Tushar Patel
-Author-email: tushar.patel@gmail.com
-Project-URL: Documentation, https://drf-iam.readthedocs.io/en/latest/installation.html
-Project-URL: Source, https://github.com/tushar1328/drf-iam.git
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 3.2
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-Requires-Dist: Django>=3.2
-Requires-Dist: djangorestframework>=3.12
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-## Rest Framework IAM
-
-A simple Django application for Role Based Access Control (RBAC) using Django Rest Framework
-
-## Installation
-
-```bash
-pip install drf-iam
-```