Add StartWorkflowMixin

This allows to start new workflows from views that don't inherit from BaseCreateView. This is useful if you e.g. want to start a view from json input and don't need forms.

Author: fvollmer

joeflow/models.py

@@ -19,6 +19,7 @@
 from .conf import settings
 from .typing import HUMAN, MACHINE
 from .utils import NoDashDiGraph
+from .views import StartWorkflowMixin
 
 logger = logging.getLogger(__name__)
 
@@ -139,7 +140,7 @@ def urls(cls):
         urls = []
         for name, node in cls.get_nodes():
             if isinstance(node, View):
-                if isinstance(node, BaseCreateView):
+                if isinstance(node, (BaseCreateView, StartWorkflowMixin)):
                     route = f"{name}/"
                 else:
                     route = f"{name}/<int:pk>/"

joeflow/tasks/human.py

@@ -2,15 +2,15 @@
 
 from django.views import generic
 
-from joeflow.views import TaskViewMixin
+from joeflow.views import TaskViewMixin, StartWorkflowMixin
 
 __all__ = (
     "StartView",
     "UpdateView",
 )
 
 
-class StartView(TaskViewMixin, generic.CreateView):
+class StartView(TaskViewMixin, StartWorkflowMixin, generic.CreateView):
     """
     Start a new workflow by a human with a view.
 

joeflow/views.py

@@ -29,6 +29,22 @@ def get_template_names(self):
         return names
 
 
+class StartWorkflowMixin:
+    """
+    Use this mixin to create a start workflow with a view. Example:
+
+    class MyStartWorkflowView(StartWorkflowMixin, TaskViewMixin, View):
+        def post(self, request, *args, **kwargs):
+            try:
+                data = json.loads(request.body)
+                workflow_id = self.start_workflow(data)
+            except Exception as e:
+                return HttpResponseBadRequest("Failed to start workflow")
+
+            return JsonResponse({'message': 'Workflow started successfully.', 'id': workflow_id}, status=201)
+    """
+
+
 class TaskViewMixin(WorkflowTemplateNameViewMixin, RevisionMixin):
     name = None
     path = ""