Metadata-Version: 1.1
Name: djangorestframework-role-filters
Version: 0.2.2
Summary: django-rest-framework-role-filters
Home-page: https://github.com/allisson/django-rest-framework-role-filters
Author: Allisson Azevedo
Author-email: allisson@gmail.com
License: UNKNOWN
Description: django-rest-framework-role-filters
        ==================================
        
        .. image:: https://travis-ci.org/allisson/django-rest-framework-role-filters.svg?branch=master
            :target: https://travis-ci.org/allisson/django-rest-framework-role-filters
        
        .. image:: https://codecov.io/gh/allisson/django-rest-framework-role-filters/branch/master/graph/badge.svg
            :target: https://codecov.io/gh/allisson/django-rest-framework-role-filters
        
        .. image:: https://img.shields.io/pypi/v/djangorestframework-role-filters.svg
                :target: https://pypi.python.org/pypi/djangorestframework-role-filters
        
        .. image:: https://img.shields.io/github/license/allisson/django-rest-framework-role-filters.svg
                :target: https://pypi.python.org/pypi/djangorestframework-role-filters
        
        .. image:: https://img.shields.io/pypi/pyversions/djangorestframework-role-filters.svg
                :target: https://pypi.python.org/pypi/djangorestframework-role-filters
        
        How to install
        --------------
        
        .. code:: shell
        
            pip install djangorestframework-role-filters
        
        Why i wrote this project?
        -------------------------
        
        I want work easily with roles without multiple ifs in code
        
        How to use
        ----------
        
        Create role_filters.py with your roles definitions
        
        .. code:: python
            
            from rest_framework_role_filters.role_filters import RoleFilter
        
            from .serializers import PostSerializerForUser
        
        
            class AdminRoleFilter(RoleFilter):
                role_id = 'admin'
        
        
            class UserRoleFilter(RoleFilter):
                role_id = 'user'
        
                def get_allowed_actions(self, request, view):
                    return ['create', 'list', 'retrieve', 'update', 'partial_update']
        
                def get_queryset(self, request, view, queryset):
                    queryset = queryset.filter(user=request.user)
                    return queryset
        
                def get_serializer_class(self, request, view):
                    return PostSerializerForUser
        
                def get_serializer(self, request, view, serializer_class, *args, **kwargs):
                    fields = (
                        'body',
                        'created_at',
                        'id',
                        'serializer_name',
                        'title',
                        'updated_at',
                        'user',
                    )
                    return serializer_class(*args, fields=fields, **kwargs)
        
        Create viewset and override get_role_id method
        
        .. code:: python
            
            from rest_framework_role_filters.role_filters import RoleFilterGroup
            from rest_framework_role_filters.viewsets import RoleFilterModelViewSet
        
            from .models import Post
            from .role_filters import AdminRoleFilter, UserRoleFilter
            from .serializers import PostSerializer
        
        
            class PostViewSet(RoleFilterModelViewSet):
                role_filter_group = RoleFilterGroup(role_filters=[AdminRoleFilter(), UserRoleFilter()])
                queryset = Post.objects.all()
                serializer_class = PostSerializer
        
                def get_role_id(self, request):
                    return request.user.role.role_id
        
                def perform_create(self, serializer):
                    serializer.save(user=self.request.user)
        
        If role_id is 'admin':
        
        * All actions is allowed
        * The default queryset is returned - Post.objects.all()
        * The default serializer_class is used - PostSerializer
        * The default viewset get_serializer method is used
        
        If role_id is 'user':
        
        * Only actions 'create', 'list', 'retrieve', 'update', 'partial_update' is allowed
        * The queryset is filtered by user
        * The serializer_class PostSerializerForUser is used
        * The serializer initializing with fields kwargs
        
        Check `testapp example <https://github.com/allisson/django-rest-framework-role-filters/tree/master/testproject/testapp>`_ code implementation.
        
Keywords: djangorestframework rest role permission
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
