Build flexible reporting endpoint

server/api/code/lacity_data_api/routers/reports.py

@@ -1,20 +1,73 @@
 import datetime
+import re
+from typing import List, Optional
 
-from fastapi import APIRouter
+from fastapi import APIRouter, Query
 
+from sqlalchemy import text
+from ..models import db
 from ..models.service_request import ServiceRequest
+from ..models.request_type import RequestType
+from ..models.council import Council
 
 router = APIRouter()
 
+# maps keywords to sqlalchemy columns or functions
+field_dict = {
+    "created_year": db.extract(
+        'year',
+        ServiceRequest.created_date
+    ).label('created_year'),
+    "created_month": db.extract(
+        'month',
+        ServiceRequest.created_date
+    ).label('created_month'),
+    "created_date": ServiceRequest.created_date,
+    "council_name": Council.council_name,
+    "type_name": RequestType.type_name
+}
 
-@router.get("/", description="*BETA: Rudimentary reporting endpoint")
+filter_regex = "^(\w+)([>=<]+)([\w-]+)$"  # noqa
+
+
+@router.get("")
 async def run_report(
-    start_date: datetime.date = datetime.date.today() - datetime.timedelta(days=7),
-    end_date: datetime.date = datetime.date.today()
+    field: Optional[List[str]] = Query(
+        ["type_name", "created_date"],
+        description="ex. created_date",
+        regex="(created_year|created_month|created_date|council_name|type_name)"
+    ),
+    filter: Optional[List[str]] = Query(
+        [f"created_date>={str(datetime.date.today() - datetime.timedelta(days=7))}"],
+        description="""
+            Field then operator then value
+            (ex. created_date>=2021-01-01 or council_name=Arleta
+            """,
+        regex=filter_regex
+    )
 ):
 
-    result = await ServiceRequest.get_request_reports(
-        start_date,
-        end_date
+    # set up the fields for select and group by
+    fields = [field_dict[i] for i in field]
+    group_by = fields.copy()
+    fields.append(db.func.count().label("counts"))
+
+    # set up filters for where clause
+    filters = []
+    for f in filter:
+        match = re.search(filter_regex, f)
+        filters.append(f"{match.group(1)} {match.group(2)} '{match.group(3)}'")
+
+    result = await (
+        db.select(
+            fields
+        ).select_from(
+            ServiceRequest.join(RequestType).join(Council)
+        ).where(
+            text(' AND '.join(filters))
+        ).group_by(
+            *group_by
+        ).gino.all()
     )
+
     return result

server/api/code/lacity_data_api/routers/shim.py

@@ -7,7 +7,7 @@
     request_type, service_request, council
 )
 from ..services import (
-    email, github, reports
+    email, github, visualizations
 )
 
 router = APIRouter()
@@ -92,7 +92,7 @@ async def get_pins(filter: Filter):
 
 @router.post("/visualizations")
 async def get_visualizations(filter: Filter):
-    result = await reports.get_visualization(
+    result = await visualizations.get_visualization(
         filter.startDate,
         filter.endDate,
         filter.requestTypes,
@@ -103,19 +103,19 @@ async def get_visualizations(filter: Filter):
 
 @router.post("/comparison/frequency")
 async def get_comparison_frequency(comp_filter: Comparison):
-    result = await reports.freq_comparison(**dict(comp_filter))
+    result = await visualizations.freq_comparison(**dict(comp_filter))
     return result
 
 
 @router.post("/comparison/timetoclose")
 async def get_comparison_time_to_close(comp_filter: Comparison):
-    result = await reports.ttc_comparison(**dict(comp_filter))
+    result = await visualizations.ttc_comparison(**dict(comp_filter))
     return result
 
 
 @router.post("/comparison/counts")
 async def get_comparison_counts(comp_filter: Comparison):
-    result = await reports.counts_comparison(**dict(comp_filter))
+    result = await visualizations.counts_comparison(**dict(comp_filter))
     return result
 
 

server/api/tests/integration/test_api_reports.py

@@ -0,0 +1,20 @@
+
+def test_api_report(client):
+    url = "/reports?filter=created_date>=2020-01-01"
+    response = client.get(url)
+    assert response.status_code == 200
+    assert len(response.json()) == 30
+
+
+def test_api_report_type_name(client):
+    url = "/reports?filter=created_date>=2020-01-01&field=type_name"
+    response = client.get(url)
+    assert response.status_code == 200
+    assert len(response.json()) == 10
+
+
+def test_api_report_council_name(client):
+    url = "/reports?filter=created_date>=2020-01-01&field=council_name"
+    response = client.get(url)
+    assert response.status_code == 200
+    assert len(response.json()) == 99