Merge pull request #212 from praekeltfoundation/add-clinic-lookup

Add clinic lookup

Author: erikh360

config/settings/base.py

@@ -48,6 +48,7 @@
     "randomisation",
     "msisdn_utils",
     "turn_alerts",
+    "momconnect",
 ]
 
 MIDDLEWARE = [

config/urls.py

@@ -11,4 +11,5 @@
     path("yal/", include("rp_yal.urls"), name="rp_yal"),
     path("msisdn_utils/", include("msisdn_utils.urls")),
     path("turnalerts/", include("turn_alerts.urls"), name="turn_alerts"),
+    path("momconnect/", include("momconnect.urls"), name="momconnect"),
 ]

docs/apps/momconnect.md

@@ -0,0 +1,37 @@
+# MomConnect App
+
+The `momconnect` app is responsible for all momconnect specific functionality, including:
+- **Clinic-related operations and integrations within the project**: It provides APIs and utilities to validate clinic codes and retrieve clinic details.
+
+## Key Features
+
+- **Clinic Management**: Handles the storage and retrieval of clinic information.
+- **Validation**: Includes utilities to validate clinic codes.
+- **API Endpoints**: Exposes endpoints for interacting with clinic data.
+
+## Key Components
+
+### Models
+- **Clinic**: Represents a clinic with attributes such as `value` (clinic code) and `name`.
+
+### Views
+- **ClinicDetailsView**: API view to retrieve clinic details based on a provided clinic code.
+
+### Utilities
+- **validate_clinic_code**: Utility function to validate the format of a clinic code.
+
+## API Endpoints
+
+### Clinic Details
+- **Endpoint**: `/momconnect/clinic-check/`
+- **Method**: `GET`
+- **Parameters**:
+  - `clinic_code` (required): The code of the clinic to retrieve.
+- **Responses**:
+  - `200 OK`: Returns the clinic details.
+  - `400 Bad Request`: Missing or invalid clinic code.
+  - `404 Not Found`: Clinic not found.
+
+## Testing
+
+The `momconnect` app includes comprehensive test coverage for its views and utilities. Tests are located in `momconnect/tests/`.

momconnect/__init__.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class MomconnectConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "momconnect"

momconnect/apps.py

@@ -0,0 +1,32 @@
+# Generated by Django 4.2.20 on 2025-03-25 08:31
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Clinic',
+            fields=[
+                ('code', models.CharField(max_length=255)),
+                ('value', models.CharField(max_length=255)),
+                ('uid', models.CharField(max_length=255, primary_key=True, serialize=False)),
+                ('name', models.CharField(max_length=255)),
+                ('province', models.CharField(blank=True, default=None, max_length=6, null=True)),
+                ('location', models.CharField(blank=True, default=None, max_length=255, null=True)),
+                ('area_type', models.CharField(blank=True, default=None, max_length=50, null=True)),
+                ('unit_type', models.CharField(blank=True, default=None, max_length=50, null=True)),
+                ('district', models.CharField(blank=True, default=None, max_length=50, null=True)),
+                ('municipality', models.CharField(blank=True, default=None, max_length=50, null=True)),
+            ],
+            options={
+                'indexes': [models.Index(fields=['value'], name='momconnect__value_9a1252_idx')],
+            },
+        ),
+    ]

momconnect/management/commands/import_clinics.py

@@ -0,0 +1,17 @@
+from django.db import models
+
+
+class Clinic(models.Model):
+    code = models.CharField(max_length=255)
+    value = models.CharField(max_length=255)
+    uid = models.CharField(max_length=255, primary_key=True)
+    name = models.CharField(max_length=255)
+    province = models.CharField(max_length=6, blank=True, null=True, default=None)
+    location = models.CharField(max_length=255, blank=True, null=True, default=None)
+    area_type = models.CharField(max_length=50, blank=True, null=True, default=None)
+    unit_type = models.CharField(max_length=50, blank=True, null=True, default=None)
+    district = models.CharField(max_length=50, blank=True, null=True, default=None)
+    municipality = models.CharField(max_length=50, blank=True, null=True, default=None)
+
+    class Meta:
+        indexes = [models.Index(fields=["value"])]

momconnect/migrations/0001_initial.py

@@ -0,0 +1,27 @@
+from django.test import TestCase
+
+from momconnect.utils import clean_clinic_code, validate_clinic_code
+
+
+class TestUtils(TestCase):
+    def test_clean_clinic_code(self):
+        """
+        Test that the clean_clinic_code function removes spaces from the input string.
+        """
+        self.assertEqual(clean_clinic_code("123 456"), "123456")
+        self.assertEqual(clean_clinic_code("  789 "), "789")
+        self.assertEqual(clean_clinic_code("abc def"), "abcdef")
+        self.assertEqual(clean_clinic_code(""), "")
+
+    def test_validate_clinic_code(self):
+        """
+        Test that the validate_clinic_code function checks if the clinic code is valid.
+        A valid clinic code must be exactly 6 digits long and contain only numbers.
+        """
+        self.assertTrue(validate_clinic_code("123456"))
+        self.assertTrue(validate_clinic_code(" 123 456 "))
+        self.assertFalse(validate_clinic_code("12345"))
+        self.assertFalse(validate_clinic_code("1234567"))
+        self.assertFalse(validate_clinic_code("12345a"))
+        self.assertFalse(validate_clinic_code(""))
+        self.assertFalse(validate_clinic_code(" "))

momconnect/migrations/__init__.py

@@ -0,0 +1,66 @@
+from django.contrib.auth.models import User
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.authtoken.models import Token
+from rest_framework.test import APIClient, APITestCase
+
+from momconnect.models import Clinic
+
+
+class ClinicDetailsViewTests(APITestCase):
+    def setUp(self):
+        self.api_client = APIClient()
+
+        self.user = User.objects.create_user(
+            "username", "[email protected]", "password"
+        )
+        token = Token.objects.get(user=self.user)
+        self.api_client.credentials(HTTP_AUTHORIZATION="Token " + token.key)
+
+        self.clinic = Clinic.objects.create(value="123456", name="Test Clinic")
+        self.url = reverse("clinic-check")
+
+    def test_unauthenticated_client(self):
+        """
+        Test that an unauthenticated client receives a 401 Unauthorized response
+        when attempting to access the clinic details endpoint.
+        """
+        response = self.client.get(self.url, {"clinic_code": self.clinic.value})
+        self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED)
+
+    def test_missing_clinic_code(self):
+        """
+        Test that the endpoint returns a 400 Bad Request response
+        when the clinic_code parameter is missing.
+        """
+        response = self.api_client.get(self.url)
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertEqual(response.data, {"error": "missing clinic code"})
+
+    def test_invalid_clinic_code(self):
+        """
+        Test that the endpoint returns a 400 Bad Request response
+        when the clinic_code parameter is invalid.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "invalid"})
+        self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
+        self.assertEqual(response.data, {"error": "invalid"})
+
+    def test_clinic_not_found(self):
+        """
+        Test that the endpoint returns a 404 Not Found response
+        when the clinic with the provided clinic_code does not exist.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": "999999"})
+        self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
+        self.assertEqual(response.data, {"error": "clinic not found"})
+
+    def test_successful_clinic_retrieval(self):
+        """
+        Test that the endpoint successfully retrieves clinic details
+        when a valid clinic_code is provided.
+        """
+        response = self.api_client.get(self.url, {"clinic_code": self.clinic.value})
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["code"], self.clinic.value)
+        self.assertEqual(response.data["name"], self.clinic.name)

momconnect/models.py

@@ -0,0 +1,7 @@
+from django.urls import path
+
+from .views import ClinicDetailsView
+
+urlpatterns = [
+    path("clinic-check", ClinicDetailsView.as_view(), name="clinic-check"),
+]

momconnect/tests/test_utils.py

@@ -0,0 +1,7 @@
+def clean_clinic_code(clinic_code):
+    return str(clinic_code).replace(" ", "")
+
+
+def validate_clinic_code(clinic_code):
+    clinic_code = clean_clinic_code(clinic_code)
+    return clinic_code.isdigit() and len(clinic_code) == 6

momconnect/tests/test_views.py

@@ -0,0 +1,25 @@
+from rest_framework import generics, status
+from rest_framework.response import Response
+
+from .models import Clinic
+from .utils import validate_clinic_code
+
+
+class ClinicDetailsView(generics.RetrieveAPIView):
+    def get(self, request):
+        try:
+            clinic_code = request.query_params["clinic_code"]
+        except KeyError:
+            return Response(
+                {"error": "missing clinic code"}, status.HTTP_400_BAD_REQUEST
+            )
+
+        if not validate_clinic_code(clinic_code):
+            return Response({"error": "invalid"}, status.HTTP_400_BAD_REQUEST)
+
+        try:
+            clinic = Clinic.objects.get(value=clinic_code)
+        except Clinic.DoesNotExist:
+            return Response({"error": "clinic not found"}, status.HTTP_404_NOT_FOUND)
+
+        return Response({"code": clinic.value, "name": clinic.name})