Full Serializer Mutation with DRF permissions

README.md

@@ -14,6 +14,7 @@ This package adds some extra functionalities to graphene-django to facilitate th
   1. Allow pagination and filtering on Queries.
   2. Allow defining DjangoRestFramework serializers based on Mutations.
   3. Allow using Directives on Queries and Fragments.
+  4. Allow defining Permissions for mutations and Queries
 
 **NOTE:** Subscription support was moved to [graphene-django-subscriptions](https://github.com/eamigo86/graphene-django-subscriptions).
 
@@ -22,26 +23,40 @@ This package adds some extra functionalities to graphene-django to facilitate th
 For installing graphene-django-extras, just run this command in your shell:
 
 ```
-pip install graphene-django-extras
+pip install git+https://github.com/eadwinCode/graphene-django-extras.git
 ```
 
 ## Documentation:
 
 ### Extra functionalities:
- **Fields:**
+ **Fields: (*Now has permissions*)**
   1.  DjangoObjectField
   2.  DjangoFilterListField
   3.  DjangoFilterPaginateListField
   4.  DjangoListObjectField (*Recommended for Queries definition*)
 
  **Mutations:**
   1.  DjangoSerializerMutation (*Recommended for Mutations definition*)
+  2.  *DRFSerializerMutation (*Recommended for Mutations definition Strictly for Serializers*)
+  3.  *DjangoModelMutation (*Recommended for Mutations definition Strictly for Django Models*)
+  4.  *UpdateSerializerMutation (*Update Mutation definition with Serializer class*)
+  5.  *DeleteSerializerMutation (*Delete Mutation definition with Serializer class*)
+  6.  *CreateSerializerMutation (*Create Mutation definition with Serializer class*)
+  7.  *CreateModelMutation (*Create Mutation definition with Django Model*)
+  8.  *UpdateModelMutation (*Update Mutation definition with Django Model*)
+  9.  *DeleteModelMutation (*Delete Mutation definition with Django Model*)
 
  **Types:**
   1.  DjangoListObjectType  (*Recommended for Types definition*)
   2.  DjangoInputObjectType
   3.  DjangoSerializerType  (*Recommended for quick queries and mutations definitions*)
 
+ **Decorators: For resolver functions**
+  1.  login_required (*Checks for authentication in request context*)
+  2.  permission_required (*Checks for 'access permissions' not object permissions*)
+  3.  is_super_user_required(*Checks if authenticated user is a superuser*) 
+  4.  is_staff_required(*Checks if authenticated user is a staff*) 
+
  **Paginations:**
   1.  LimitOffsetGraphqlPagination
   2.  PageGraphqlPagination
@@ -126,20 +141,53 @@ class UserInput(DjangoInputObjectType):
 
 ```python
 import graphene
-from graphene_django_extras import DjangoSerializerMutation
+from graphene_django_extras.rest_framework import DjangoModelMutation, DRFSerializerMutation
 
-from .serializers import UserSerializer
+from .serializers import UserSerializer, UpdateUserSerializer
 from .types import UserType
 from .input_types import UserInputType
+from .models import User
 
 
-class UserSerializerMutation(DjangoSerializerMutation):
+class UserSerializerMutation(DRFSerializerMutation):
     """
         DjangoSerializerMutation auto implement Create, Delete and Update functions
+        for more customisation use CreateSerializerMutation, UpdateSerializerMutation, 
+        DeleteSerializerMutation
     """
+
+    permission_classes = []
+
+    mutation_serializers = {  # optional if you want to be specific
+        'create': UserSerializer,
+        'update': UpdateUserSerializer
+    }
+
     class Meta:
         description = " DRF serializer based Mutation for Users "
-        serializer_class = UserSerializer
+        serializer_class = UserSerializer # compulsory global serializer_class
+
+
+class UserModelMutation(DjangoModelMutation):
+    """
+        DjangoModelMutation auto implement Create, Delete and Update functions
+        for more customisation use CreateModelMutation, UpdateModelMutation, 
+        DeleteModelMutation
+    """
+    permission_classes = []
+
+    create_fields = dict(
+        only_fields=('username','password', 'email'),
+    )
+
+    update_fields = dict(
+        exclude_fields=('username', 'password', 'email')
+    )
+
+    class Meta:
+        description = "Model based Mutation for Users "
+        model = User
+        only_fields = ('username', 'password', 'email' )
 
 
 class UserMutation(graphene.Mutation):
@@ -151,7 +199,7 @@ class UserMutation(graphene.Mutation):
     user = graphene.Field(UserType, required=False)
 
     class Arguments:
-        new_user = graphene.Argument(UserInput)
+        new_user = graphene.Argument(UserInputType)
 
     class Meta:
         description = " Graphene traditional mutation for Users "
@@ -168,14 +216,18 @@ import graphene
 from graphene_django_extras import DjangoObjectField, DjangoListObjectField, DjangoFilterPaginateListField,
 DjangoFilterListField, LimitOffsetGraphqlPagination
 from .types import UserType, UserListType, UserModelType
-from .mutations import UserMutation, UserSerializerMutation
+from .mutations import UserMutation, UserSerializerMutation, UserModelMutation
 
 
 class Queries(graphene.ObjectType):
     # Possible User list queries definitions
-    users = DjangoListObjectField(UserListType, description='All Users query')
-    users1 = DjangoFilterPaginateListField(UserType, pagination=LimitOffsetGraphqlPagination())
-    users2 = DjangoFilterListField(UserType)
+    users = DjangoListObjectField(
+        UserListType, description='All Users query', permission_classes=[IsAuthenticated,]
+    )
+    users1 = DjangoFilterPaginateListField(
+        UserType, pagination=LimitOffsetGraphqlPagination(), permission_classes=[IsAuthenticated,]
+    )
+    users2 = DjangoFilterListField(UserType, permission_classes=[IsAuthenticated,])
     users3 = DjangoListObjectField(UserListType, filterset_class=UserFilter, description='All Users query')
 
     # Defining a query for a single user
@@ -203,6 +255,10 @@ class Mutations(graphene.ObjectType):
     user_create = UserSerializerMutation.CreateField(deprecation_reason='Some one deprecation message')
     user_delete = UserSerializerMutation.DeleteField()
     user_update = UserSerializerMutation.UpdateField()
+
+    user_model_create = UserModelMutation.CreateField(deprecation_reason='Some one deprecation message')
+    user_model_delete = UserModelMutation.DeleteField()
+    user_model_update = UserModelMutation.UpdateField()
 
     # Exist two ways to define mutations with DjangoSerializerType
     user_create1, user_delete1, user_update1 = UserModelType.MutationFields(
@@ -493,6 +549,20 @@ You can use this shortcuts too:
 
 
 ## Change Log:
+#### v0.5:
+    1. List and Paginated fields can be resolved manually
+    2. Fixed fields compatibility issues graphene_django DjangoObjectType
+    3. Use graphene_django DjangoObjectType or graphene_django_extra DjangoObjectType
+    4. Base class for ListFields
+    5. Improved query builder for ListFields
+    6. DRF Permission implementation on ListFields
+
+#### v0.4.8-beta.1:
+    1. Added DRFSerializerMutation, another Mutation to properly manager mutation from serializer class
+    2. Added Permission to DRFSerializerMutations and DjangoModelMutations
+    3. Improved on ListField classes for easy customisation and 
+    4. Added permission to all ListField components 
+
 #### v0.4.8:
     1. Upgrade graphene-django dependency to version == 2.6.0.
 

README.rst

@@ -7,6 +7,7 @@ This package add some extra functionalities to **graphene-django** to facilitate
   1. Allows pagination and filtering on Queries.
   2. Allows to define DjangoRestFramework serializers based Mutations.
   3. Allows use Directives on Queries and Fragments.
+  4. Allow defining Permissions for mutations and Queries
 
 **NOTE:** Subscription support was moved to `graphene-django-subscriptions <https://github.com/eamigo86/graphene-django-subscriptions>`_
 
@@ -17,29 +18,43 @@ For installing graphene-django-extras, just run this command in your shell:
 
 .. code:: python
 
-    pip install "graphene-django-extras"
+    pip install "git+https://github.com/eadwinCode/graphene-django-extras.git"
 
 Documentation:
 --------------
 
 **********************
 Extra functionalities:
 **********************
-  **Fields:**
+  **Fields(Now has permissions):**
     1. DjangoObjectField
     2. DjangoFilterListField
     3. DjangoFilterPaginateListField
     4. DjangoListObjectField  (*Recommended for Queries definition*)
 
   **Mutations:**
     1.	DjangoSerializerMutation  (*Recommended for Mutations definition*)
+    2.  *DRFSerializerMutation (*Recommended for Mutations definition Strictly for Serializers*)
+    3.  *DjangoModelMutation (*Recommended for Mutations definition Strictly for Django Models*)
+    4.  *UpdateSerializerMutation (*Update Mutation definition with Serializer class*)
+    5.  *DeleteSerializerMutation (*Delete Mutation definition with Serializer class*)
+    6.  *CreateSerializerMutation (*Create Mutation definition with Serializer class*)
+    7.  *CreateModelMutation (*Create Mutation definition with Django Model*)
+    8.  *UpdateModelMutation (*Update Mutation definition with Django Model*)
+    9.  *DeleteModelMutation (*Delete Mutation definition with Django Model*)
 
   **Types:**
     1.	DjangoListObjectType  (*Recommended for Types definition*)
     2.	DjangoInputObjectType
     3.  DjangoSerializerType  (*Recommended for quick queries and mutations definitions*)
 
-  **Paginations:**
+  **Decorators: For resolver functions**
+    1.  login_required (*Checks for authentication in request context*)
+    2.  permission_required (*Checks for 'access permissions' not object permissions*)
+    3.  is_super_user_required(*Checks if authenticated user is a superuser*)
+    4.  is_staff_required(*Checks if authenticated user is a staff*)
+
+    **Paginations:**
     1.	LimitOffsetGraphqlPagination
     2.	PageGraphqlPagination
 
@@ -136,19 +151,49 @@ You can define traditional mutations that use InputTypes or Mutations based on D
 .. code:: python
 
     import graphene
-    from .serializers import UserSerializer
-    from graphene_django_extras import DjangoSerializerMutation
+    from .serializers import UserSerializer, UpdateUserSerializer
+    from graphene_django_extras.rest_framework import DjangoModelMutation, DRFSerializerMutation
     from .types import UserType
     from .input_types import UserInputType
 
 
-    class UserSerializerMutation(DjangoSerializerMutation):
+    class UserSerializerMutation(DRFSerializerMutation):
         """
             DjangoSerializerMutation auto implement Create, Delete and Update functions
+            for more customisation use CreateSerializerMutation, UpdateSerializerMutation, DeleteSerializerMutation
         """
+
+        permission_classes = []
+
+        mutation_serializers = {  # optional if you want to be specific
+            'create': UserSerializer,
+            'update': UpdateUserSerializer
+        }
+
         class Meta:
             description = " DRF serializer based Mutation for Users "
-            serializer_class = UserSerializer
+            serializer_class = UserSerializer # compulsory global serializer_class
+
+
+    class UserModelMutation(DjangoModelMutation):
+        """
+            DjangoModelMutation auto implement Create, Delete and Update functions
+            for more customisation use CreateModelMutation, UpdateModelMutation, DeleteModelMutation
+        """
+        permission_classes = []
+
+        create_fields = dict(
+            only_fields=('username','password', 'email'),
+        )
+
+        update_fields = dict(
+            exclude_fields=('username', 'password', 'email')
+        )
+
+        class Meta:
+            description = "Model based Mutation for Users "
+            model = User
+            only_fields = ('username', 'password', 'email' )
 
 
     class UserMutation(graphene.Mutation):
@@ -178,14 +223,18 @@ You can define traditional mutations that use InputTypes or Mutations based on D
     import graphene
     from graphene_django_extras import DjangoObjectField, DjangoListObjectField, DjangoFilterPaginateListField, DjangoFilterListField, LimitOffsetGraphqlPagination
     from .types import UserType, UserListType, UserModelType
-    from .mutations import UserMutation, UserSerializerMutation
+    from .mutations import UserMutation, UserSerializerMutation, UserModelMutation
 
 
     class Queries(graphene.ObjectType):
         # Possible User list queries definitions
-        users = DjangoListObjectField(UserListType, description='All Users query')
-        users1 = DjangoFilterPaginateListField(UserType, pagination=LimitOffsetGraphqlPagination())
-        users2 = DjangoFilterListField(UserType)
+        users = DjangoListObjectField(
+        UserListType, description='All Users query', permission_classes=[IsAuthenticated,]
+        )
+        users1 = DjangoFilterPaginateListField(
+            UserType, pagination=LimitOffsetGraphqlPagination(), permission_classes=[IsAuthenticated,]
+        )
+        users2 = DjangoFilterListField(UserType, permission_classes=[IsAuthenticated,])
         users3 = DjangoListObjectField(UserListType, filterset_class=UserFilter, description='All Users query')
 
         # Defining a query for a single user
@@ -209,6 +258,10 @@ You can define traditional mutations that use InputTypes or Mutations based on D
         user_delete = UserSerializerMutation.DeleteField()
         user_update = UserSerializerMutation.UpdateField()
 
+        user_model_create = UserModelMutation.CreateField(deprecation_reason='Some one deprecation message')
+        user_model_delete = UserModelMutation.DeleteField()
+        user_model_update = UserModelMutation.UpdateField()
+
         # Exist two ways to define mutations with DjangoSerializerType
         user_create1, user_delete1, user_update1 = UserModelType.MutationFields(
             description='Some description message for create, delete and update mutations',
@@ -511,6 +564,24 @@ You can use this shortcuts too:
 
 Change Log:
 -----------
+*******
+v0.5
+*******
+1. List and Paginated fields can be resolved manually
+2. Fixed fields compatibility issues graphene_django DjangoObjectType
+3. Use graphene_django DjangoObjectType or graphene_django_extra DjangoObjectType
+4. Base class for ListFields
+5. Improved query builder for ListFields
+6. DRF Permission implementation on ListFields
+
+*******
+v0.4.8-beta.1
+*******
+1. Added DRFSerializerMutation, another Mutation to properly manager mutation from serializer class
+2. Added Permission to DRFSerializerMutations and DjangoModelMutations
+3. Improved on ListField classes for easy customisation and
+4. Added permission to all ListField components
+
 *******
 v0.4.8:
 *******

graphene_django_extras/__init__.py

@@ -31,6 +31,7 @@
     "DjangoListObjectField",
     # MUTATIONS
     "DjangoSerializerMutation",
+
     # PAGINATIONS
     "LimitOffsetGraphqlPagination",
     "PageGraphqlPagination",
@@ -43,4 +44,5 @@
     # DIRECTIVES
     "all_directives",
     "ExtraGraphQLDirectiveMiddleware",
+
 )