[Feature] Add clinical officers api

Author: RyanSept

healthtools_ke_api/__init__.py

@@ -3,6 +3,8 @@
 
 from healthtools_ke_api.views.doctors import doctors_api
 from healthtools_ke_api.views.nurses import nurses_api
+from healthtools_ke_api.views.clinical_officers import clinical_officers_api
+
 from healthtools_ke_api.views.sms_handler import sms_handler
 
 import os
@@ -18,6 +20,7 @@
 
 app.register_blueprint(doctors_api, url_prefix='/doctors')
 app.register_blueprint(nurses_api, url_prefix='/nurses')
+app.register_blueprint(clinical_officers_api, url_prefix='/clinical-officers')
 app.register_blueprint(sms_handler)
 
 

healthtools_ke_api/tests/test_clinical_officers_api.py

@@ -0,0 +1,20 @@
+from unittest import TestCase
+from healthtools_ke_api import app
+from healthtools_ke_api.views.clinical_officers import get_clinical_officers_from_cloudsearch
+
+
+class TestClinicalOfficersAPI(TestCase):
+    def setUp(self):
+        self.client = app.test_client()
+
+    def test_gets_cos_from_cloudsearch(self):
+        clinical_officers = get_clinical_officers_from_cloudsearch("Marie")
+        self.assertTrue(len(clinical_officers) > 0)
+
+    def test_cos_endpoint_with_bad_query(self):
+        response = self.client.get("/clinical-officers/search.json?q=")
+        self.assertIn("A query is required.", response.data)
+
+    def test_cos_endpoint_gets_doctors(self):
+        response = self.client.get("/clinical-officers/search.json?q=Marie")
+        self.assertIn("success", response.data)

healthtools_ke_api/tests/test_doctors_api.py

@@ -3,7 +3,7 @@
 from healthtools_ke_api.views.doctors import get_doctors_from_cloudsearch
 
 
-class TestNursesAPI(TestCase):
+class TestDoctorsAPI(TestCase):
     def setUp(self):
         self.client = app.test_client()
 

healthtools_ke_api/views/clinical_officers.py

@@ -0,0 +1,75 @@
+import boto3
+from flask import Blueprint, request, jsonify, current_app
+
+from healthtools_ke_api.analytics import track_event
+from healthtools_ke_api.settings import AWS_CONFIGS
+
+
+clinical_officers_api = Blueprint('clinical_officers_api', __name__)
+COS_CLOUDSEARCH_ENDPOINT = "http://doc-cfa-healthtools-ke-cos-nhxtw3w5goufkzram4er7sciz4.eu-west-1.cloudsearch.amazonaws.com/"
+cloudsearch_client = boto3.client("cloudsearchdomain",
+                                  endpoint_url=COS_CLOUDSEARCH_ENDPOINT,
+                                  **AWS_CONFIGS)
+
+
+@clinical_officers_api.route('/', methods=['GET'])
+def index():
+    '''
+    Landing endpoint
+    '''
+    msg = {
+        "name": "API to Kenyan Clinical Officers registry",
+        "authentication": [],
+        "endpoints": {
+            "/": {"methods": ["GET"]},
+            "/clinical-officers/search.json": {
+                "methods": ["GET"],
+                "args": {
+                    "q": {"required": True}
+                }
+            },
+        }
+    }
+    return jsonify(msg)
+
+
+@clinical_officers_api.route('/search.json', methods=['GET'])
+def search():
+    try:
+        query = request.args.get('q')
+        if not query or len(query) < 1:
+            return jsonify({
+                "error": "A query is required.",
+                "results": "",
+                "data": {"clinical_officers": []}
+            })
+
+        # get clinical_officers by that name from aws
+        response = {}
+        clinical_officers = get_clinical_officers_from_cloudsearch(query)
+
+        if not clinical_officers:
+            response["message"] = "No clinical officer by that name found."
+
+        track_event(current_app.config.get('GA_TRACKING_ID'),
+                    'Clinical-Officers', 'search', request.remote_addr,
+                    label=query, value=len(clinical_officers))
+        response["data"] = {"clinical_officers": clinical_officers}
+        response["status"] = "success"
+
+        results = jsonify(response)
+        return results
+    except Exception as err:
+        return jsonify({
+            "status": "error",
+            "message": str(err),
+            "data": {"clinical_officers": []}
+        })
+
+
+def get_clinical_officers_from_cloudsearch(query):
+    '''
+    Get clinical officers from AWS cloudsearch
+    '''
+    results = cloudsearch_client.search(query=query, size=10000)
+    return results["hits"]["hit"]

healthtools_ke_api/views/doctors.py

@@ -18,7 +18,7 @@ def index():
     Landing endpoint
     '''
     msg = {
-        "name": "API to doctors registry on AWS Cloudsearch",
+        "name": "API to the Kenyan doctors registry",
         "authentication": [],
         "endpoints": {
             "/": {"methods": ["GET"]},
@@ -51,6 +51,8 @@ def search():
         if not doctors:
             response["message"] = "No doctor by that name found."
 
+        track_event(current_app.config.get('GA_TRACKING_ID'), 'Doctor', 'search',
+                        request.remote_addr, label=query, value=len(doctors))
         response["data"] = {"doctors": doctors}
         response["status"] = "success"
 
@@ -68,5 +70,5 @@ def get_doctors_from_cloudsearch(query):
     '''
     Get doctors from AWS cloudsearch
     '''
-    results = cloudsearch_client.search(query=query)
+    results = cloudsearch_client.search(query=query, size=10000)
     return results["hits"]["hit"]