Add actions to pods

casepro/pods/base.py

@@ -32,12 +32,59 @@ def config_json(self):
         return json.dumps(self.config._config_data)
 
     def read_data(self, params):
-        """Should return the data that should be used to create the display for the pod."""
+        """
+        Should return the data that should be used to create the display for the pod.
+
+        For the base implementation, the data should be an object with 'items' and 'actions' keys.
+
+        The items key should be a list of objects, that have 'name' and 'value' keys, with the value of the keys being
+        what will be displayed.
+
+        The 'actions' key should be a list of objects, that have 'type', 'name' and 'payload' keys, where type and
+        payload is what is sent to the 'perform_action' function to determine which button has been pressed, and 'name'
+        is the text that is displayed on the button.
+
+        Each action may include the following optional fields:
+            - ``busy_text``: used as the action's corresponding
+            button's text while waiting on a response from the pod's api side
+            when the action is triggered. Defaults to the value of the ``name``
+            field.
+            - ``confirm``: whether a confirmation modal should be shown to
+            confirm whether the user would like to perform the action. Defaults
+            to ``false``.
+
+        Example:
+        {
+            'items': [
+                {
+                    'name': 'EDD',
+                    'value': '2015-07-18',
+                },
+            ],
+            'actions': [
+                {
+                    'type': 'remove_edd',
+                    'name': 'Remove EDD',
+                    'payload': {},
+                    'busy_text': 'Removing EDD',
+                    'confirm': True
+                },
+            ],
+        }
+        """
         return {}
 
-    def perform_action(self, params):
-        """Should perform the action specified by params."""
-        return {}
+    def perform_action(self, type_, params):
+        """
+        Should perform the action specified by the type and params (which are specified in the read function).
+
+        Returns a tuple (success, payload), where 'success' is a boolean value indicating whether the action was
+        successful or not. If true, a case action note will be created.
+
+        For the base implementation, payload is an object with a 'message' key, which is the error message if success
+        is false, or the message to place in the case action note if success is true.
+        """
+        return (False, {'message': ''})
 
 
 class PodPlugin(AppConfig):

casepro/pods/tests/test_views.py

@@ -3,6 +3,7 @@
 from django.core.urlresolvers import reverse
 from django.test import modify_settings
 
+from casepro.cases.models import CaseAction
 from casepro.test import BaseCasesTest
 
 
@@ -100,14 +101,81 @@ def test_invalid_json(self):
             'details': 'No JSON object could be decoded'
         })
 
+    def test_case_id_required(self):
+        '''
+        If the case id is not present in the request, an error response should be returned.
+        '''
+        with self.settings(PODS=[{'label': 'base_pod'}]):
+            from casepro.pods import registry
+            reload(registry)
+
+        response = self.url_post_json(
+            'unicef', reverse('perform_pod_action', args=('0',)), {})
+        self.assertEqual(response.status_code, 400)
+        self.assertEqual(response.json, {
+            'reason': 'Request object needs to have a "case_id" field'
+        })
+
     def test_pod_valid_request(self):
         """
         If it is a valid post request, the action should be performed.
         """
         with self.settings(PODS=[{'label': 'base_pod'}]):
             from casepro.pods import registry
             reload(registry)
+
+        contact = self.create_contact(self.unicef, 'contact-uuid', 'contact_name')
+        msg = self.create_message(self.unicef, 0, contact, 'Test message')
+        case = self.create_case(self.unicef, contact, self.moh, msg)
+
         response = self.url_post_json(
-            'unicef', reverse('perform_pod_action', args=('0',)), {})
+            'unicef', reverse('perform_pod_action', args=('0',)), {'case_id': case.id})
         self.assertEqual(response.status_code, 200)
-        self.assertEqual(response.json, {})
+        self.assertEqual(response.json, {
+            'success': False,
+            'payload': {
+                'message': '',
+                }
+            })
+
+    @modify_settings(INSTALLED_APPS={
+        'append': 'casepro.pods.tests.utils.SuccessActionPlugin',
+    })
+    def test_case_action_note_created_on_successful_action(self):
+        '''
+        If the action is successful, a case action note should be created.
+        '''
+        CaseAction.objects.all().delete()
+        self.login(self.admin)
+
+        with self.settings(PODS=[{'label': 'success_pod'}]):
+            from casepro.pods import registry
+            reload(registry)
+
+        contact = self.create_contact(self.unicef, 'contact-uuid', 'contact_name')
+        msg = self.create_message(self.unicef, 0, contact, 'Test message')
+        case = self.create_case(self.unicef, contact, self.moh, msg)
+
+        response = self.url_post_json(
+            'unicef', reverse('perform_pod_action', args=('0',)), {
+                'case_id': case.id,
+                'action': {
+                    'type': 'foo',
+                    'payload': {'foo': 'bar'},
+                },
+            })
+
+        self.assertEqual(response.status_code, 200)
+
+        message = "Type foo Params {u'foo': u'bar'}"
+        self.assertEqual(response.json, {
+            'success': True,
+            'payload': {
+                'message': message
+            }
+        })
+
+        [caseaction] = CaseAction.objects.all()
+        self.assertEqual(
+            caseaction.note,
+            "%s %s" % (self.admin.username, message))

casepro/pods/tests/utils.py

@@ -16,3 +16,16 @@ class DummyPodPlugin(PodPlugin):
     directive = 'dummy-pod'
     scripts = ('dummy-script.js',)
     styles = ('dummy-style.css',)
+
+
+class SuccessActionPod(Pod):
+    def perform_action(self, type_, params):
+        '''
+        Returns a successful action result with a message containing the type and params.
+        '''
+        return (True, {'message': 'Type %s Params %r' % (type_, params)})
+
+
+class SuccessActionPlugin(DummyPodPlugin):
+    pod_class = SuccessActionPod
+    label = 'success_pod'

casepro/pods/views.py

@@ -3,9 +3,13 @@
 import json
 from django.http import JsonResponse
 
+from casepro.cases.models import Case, CaseAction
 from casepro.pods import registry
 
 
+ACTION_NOTE_CONTENT = "%(username)s %(message)s"
+
+
 def read_pod_data(request, index):
     """Delegates to the `read_data` function of the correct pod."""
     if request.method != 'GET':
@@ -20,7 +24,10 @@ def read_pod_data(request, index):
 
 
 def perform_pod_action(request, index):
-    """Deletegates to the `perform_action` function of the correct pod."""
+    """
+    Delegates to the `perform_action` function of the correct pod. If the action completes successfully, a new case
+    action note is created with the success message.
+    """
     if request.method != 'POST':
         return JsonResponse({'reason': 'Method not allowed'}, status=405)
 
@@ -34,4 +41,19 @@ def perform_pod_action(request, index):
     except ValueError as e:
         return JsonResponse({'reason': 'JSON decode error', 'details': e.message}, status=400)
 
-    return JsonResponse(pod.perform_action(data))
+    case_id = data.get('case_id')
+    if case_id is None:
+        return JsonResponse(
+            {'reason': 'Request object needs to have a "case_id" field'}, status=400)
+
+    action_data = data.get('action', {})
+    success, payload = pod.perform_action(action_data.get('type'), action_data.get('payload', {}))
+    if success is True:
+        case = Case.objects.get(id=case_id)
+        note = ACTION_NOTE_CONTENT % {
+            'username': request.user.username,
+            'message': payload.get('message'),
+        }
+        CaseAction.create(case, request.user, CaseAction.ADD_NOTE, note=note)
+
+    return JsonResponse({'success': success, 'payload': payload})