Merge pull request #17 from thomasWajs/readme-bulkrouter

Example of BulkRouter implementation

README.rst

@@ -83,6 +83,25 @@ The above will allow to create the following queries
     # delete queryset (see notes)
     DELETE
 
+Router
+------
+
+The bulk router can map automatically the bulk actions ::
+
+	from rest_framework_bulk.routes import BulkRouter
+		
+	class UserViewSet(BulkCreateModelMixin
+	                  BulkUpdateModelMixin,
+	                  BulkDestroyModelMixin,
+	                  viewsets.ModelViewSet):
+	    model = User
+	    
+	    def allow_bulk_destroy(self, qs, filtered):
+	        """Don't forget to fine-grain this method"""
+	
+	router = BulkRouter()
+	router.register(r'users', UserViewSet)
+
 Notes
 -----
 
@@ -140,4 +159,5 @@ Maintainers/contributors:
 * Kevin Brown - https://github.com/kevin-brown
 * Martin Cavoj - https://github.com/macav
 * Mjumbe Poe - https://github.com/mjumbewu
+* Thomas Wajs - https://github.com/thomasWajs
 

rest_framework_bulk/routes.py

@@ -0,0 +1,18 @@
+from __future__ import unicode_literals, print_function
+import copy
+from rest_framework.routers import DefaultRouter, SimpleRouter
+
+
+__all__ = ["BulkRouter"]
+
+
+class BulkRouter(DefaultRouter):
+    """
+    Map http methods to actions defined on the bulk mixins.
+    """
+    routes = copy.deepcopy(SimpleRouter.routes)
+    routes[0].mapping.update({
+        'put': 'bulk_update',
+        'patch': 'partial_bulk_update',
+        'delete': 'bulk_destroy',
+    })