Merge pull request #3 from RyanSept/ft-add-doctors-to-api

DavidLemayian · web-flow · commit 6ed325f20bc6 · 2017-05-08T13:12:17.000+03:00
Add doctors and clinical officers to API
diff --git a/Dockerfile b/Dockerfile
@@ -2,4 +2,4 @@ FROM python:2.7.13
 COPY . /healthtools-ke-api
 WORKDIR /healthtools-ke-api
 RUN pip install -r requirements.txt
-CMD ["gunicorn", "manage:app"]
+CMD ["gunicorn", "manage:app"]
diff --git a/README.md b/README.md
@@ -1,2 +1,46 @@
 # HealthTools.KE-api
-HealthTools Kenya API to retrieve, structure and return data being used by the health tools.
+HealthTools Kenya API to retrieve, structure and return data being used by the health tools. It provides
+data on the following medical officer registries: 
+
+- Doctors: http://medicalboard.co.ke/online-services/retention/
+- Foreign doctors: http://medicalboard.co.ke/online-services/foreign-doctors-license-register
+- Clinical officers: http://clinicalofficerscouncil.org/online-services/retention/
+
+### Specifications
+Specification for the API is shown below. It is an open api and requires no authentication to access.
+
+
+| EndPoint                            | Allowed Methods  | Functionality                                            | Parameters |
+|-------------------------------------|------------------|----------------------------------------------------------|------------|
+| `/doctors/search.json`              | GET              | Search a doctor by the name                              | q=<name>   |
+| `/nurses/search.json`               | GET              | Search a nurse by the name                               | q=<name>   |
+| `/clinical-officers/search.json`    | GET              | Search a clinical officer by the name                    | q=<name>   |
+
+
+### Installation
+Clone the repo from github `$ git clone git@github.com:RyanSept/HealthTools.KE-api.git`
+
+Change directory into package `$ cd HealthTools.KE-api`
+
+Install the dependencies by running `$ pip install requirements.txt`
+
+You can set the required environment variables like so
+```<>
+$ export GA_TRACKING_ID=<google-analytics-tracking-id>
+$ export SMS_USER=<sms-provider-user-id>
+$ export SMS_PASS=<sms-provider-passcode>
+$ export SMS_SHORTCODE=<sms-provider-shortcode>
+$ export SMS_SEND_URL=<url-for-sms-provider>
+$ export CONFIG=<config-mode>  # eg. "healthtools_ke_api.settings.DevConfig"
+$ export AWS_ACCESS_KEY_ID=<aws-access-key-id>
+$ export AWS_SECRET_KEY=<aws-secret-key>
+$ export AWS_REGION="<aws-region>
+```
+
+You can now run the server `$ python manage.py` or `gunicorn manage:app` for production.
+
+
+## Running the tests
+
+Use nosetests to run tests (with stdout) like this:
+```$ nosetests --nocapture```
diff --git a/healthtools_ke_api/__init__.py b/healthtools_ke_api/__init__.py
@@ -1,8 +1,11 @@
 from flask import Flask, jsonify
 from werkzeug.exceptions import HTTPException, default_exceptions
 
-from healthtools_ke_api.nurses import nurses_api
-from healthtools_ke_api.sms_handler import sms_handler
+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
 import sys
@@ -15,7 +18,9 @@
     print "No config has been specified for use in the environment variables."
     sys.exit()
 
+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)
 
 
diff --git a/healthtools_ke_api/config.py b/healthtools_ke_api/config.py
diff --git a/healthtools_ke_api/settings.py b/healthtools_ke_api/settings.py
@@ -3,6 +3,13 @@
 # Url of memcached server
 MEMCACHED_URL = os.getenv("MEMCACHED_URL")
 
+# Amazon Web Services configs
+AWS_CONFIGS = {
+    "aws_access_key_id": os.getenv("AWS_ACCESS_KEY_ID"),
+    "aws_secret_access_key": os.getenv("AWS_SECRET_KEY"),
+    "region_name": os.getenv("AWS_REGION"),
+}
+
 
 class Config(object):
     # Google Analytics tracking id
diff --git a/healthtools_ke_api/tests/__init__.py b/healthtools_ke_api/tests/__init__.py
diff --git a/healthtools_ke_api/tests/test_clinical_officers_api.py b/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)
diff --git a/healthtools_ke_api/tests/test_doctors_api.py b/healthtools_ke_api/tests/test_doctors_api.py
@@ -0,0 +1,20 @@
+from unittest import TestCase
+from healthtools_ke_api import app
+from healthtools_ke_api.views.doctors import get_doctors_from_cloudsearch
+
+
+class TestDoctorsAPI(TestCase):
+    def setUp(self):
+        self.client = app.test_client()
+
+    def test_gets_doctors_from_cloudsearch(self):
+        doctors = get_doctors_from_cloudsearch("Marie")
+        self.assertTrue(len(doctors) > 0)
+
+    def test_doctors_endpoint_with_bad_query(self):
+        response = self.client.get("/doctors/search.json?q=")
+        self.assertIn("A query is required.", response.data)
+
+    def test_doctors_endpoint_gets_doctors(self):
+        response = self.client.get("/doctors/search.json?q=Marie")
+        self.assertIn("success", response.data)
diff --git a/healthtools_ke_api/tests/test_nurses_api.py b/healthtools_ke_api/tests/test_nurses_api.py
@@ -0,0 +1,31 @@
+from unittest import TestCase
+from healthtools_ke_api import app
+from healthtools_ke_api.views.nurses import get_nurses_from_nc_registry
+
+
+class TestNursesAPI(TestCase):
+    def setUp(self):
+        self.client = app.test_client()
+
+    def test_gets_nurses_from_nc_registry(self):
+        nurses = get_nurses_from_nc_registry("Marie")
+        self.assertTrue(len(nurses) > 0)
+
+    def test_gets_nurses_from_nc_registry_handle_inexistent_nurse(self):
+        nurses = get_nurses_from_nc_registry("ihoafiho39023u8")
+        self.assertEqual(len(nurses), 0)
+
+    def test_nurses_endpoint_handles_bad_query(self):
+        response = self.client.get("/nurses/search.json?q=")
+        self.assertIn("A query is required.", response.data)
+
+    def test_nurses_endpoint_gets_nurses(self):
+        response = self.client.get("/nurses/search.json?q=Marie")
+        self.assertIn("success", response.data)
+
+    def test_nurses_endpoint_can_retrieve_cached_result(self):
+        # call once
+        self.client.get("/nurses/search.json?q=Marie")
+        # second time should retrieve cached result
+        response = self.client.get("/nurses/search.json?q=Marie")
+        self.assertIn("X-Retrieved-From-Cache", response.headers.keys())
diff --git a/healthtools_ke_api/views/__init__.py b/healthtools_ke_api/views/__init__.py
diff --git a/healthtools_ke_api/views/clinical_officers.py b/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"]
diff --git a/healthtools_ke_api/views/doctors.py b/healthtools_ke_api/views/doctors.py
@@ -0,0 +1,74 @@
+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
+
+
+doctors_api = Blueprint('doctors_api', __name__)
+DOCTORS_CLOUDSEARCH_ENDPOINT = "http://doc-cfa-healthtools-ke-doctors-m34xee6byjmzcgzmovevkjpffy.eu-west-1.cloudsearch.amazonaws.com/"
+cloudsearch_client = boto3.client("cloudsearchdomain",
+                                  endpoint_url=DOCTORS_CLOUDSEARCH_ENDPOINT,
+                                  **AWS_CONFIGS)
+
+
+@doctors_api.route('/', methods=['GET'])
+def index():
+    '''
+    Landing endpoint
+    '''
+    msg = {
+        "name": "API to the Kenyan doctors registry",
+        "authentication": [],
+        "endpoints": {
+            "/": {"methods": ["GET"]},
+            "/doctors/search.json": {
+                "methods": ["GET"],
+                "args": {
+                    "q": {"required": True}
+                }
+            },
+        }
+    }
+    return jsonify(msg)
+
+
+@doctors_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": {"doctors": []}
+            })
+
+        # get doctors by that name from aws
+        response = {}
+        doctors = get_doctors_from_cloudsearch(query)
+
+        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"
+
+        results = jsonify(response)
+        return results
+    except Exception as err:
+        return jsonify({
+            "status": "error",
+            "message": str(err),
+            "data": {"doctors": []}
+        })
+
+
+def get_doctors_from_cloudsearch(query):
+    '''
+    Get doctors from AWS cloudsearch
+    '''
+    results = cloudsearch_client.search(query=query, size=10000)
+    return results["hits"]["hit"]
diff --git a/healthtools_ke_api/views/nurses.py b/healthtools_ke_api/views/nurses.py
diff --git a/healthtools_ke_api/views/sms_handler.py b/healthtools_ke_api/views/sms_handler.py
@@ -1,7 +1,7 @@
 from flask import Blueprint, request, current_app
 
 from healthtools_ke_api.analytics import track_event
-from healthtools_ke_api.nurses import get_nurses_from_nc_registry
+from healthtools_ke_api.views.nurses import get_nurses_from_nc_registry
 
 import requests
 import re
diff --git a/requirements.txt b/requirements.txt
@@ -1,15 +1,23 @@
 appdirs==1.4.3
 beautifulsoup4==4.5.3
+boto3==1.4.4
+botocore==1.5.42
 bs4==0.0.1
 click==6.7
+docutils==0.13.1
 Flask==0.12.1
+futures==3.1.1
 gunicorn==19.7.1
 itsdangerous==0.24
 Jinja2==2.9.6
+jmespath==0.9.2
 MarkupSafe==1.0
+nose==1.3.7
 packaging==16.8
 pyparsing==2.2.0
+python-dateutil==2.6.0
 python-memcached==1.58
 requests==2.13.0
+s3transfer==0.1.10
 six==1.10.0
 Werkzeug==0.12.1
