Add API endpoints for departments

OpenOversight/app/__init__.py

@@ -10,6 +10,7 @@
 from flask_migrate import Migrate
 from flask_wtf.csrf import CSRFProtect
 
+from OpenOversight.app.api.v1 import v1 as api_v1_blueprint
 from OpenOversight.app.auth.views import auth as auth_blueprint
 from OpenOversight.app.email_client import EmailClient
 from OpenOversight.app.filters import instantiate_filters
@@ -48,6 +49,7 @@ def create_app(config_name="default"):
     compress.init_app(app)
 
     # Register Blueprints for application routes
+    app.register_blueprint(api_v1_blueprint)
     app.register_blueprint(auth_blueprint)
     app.register_blueprint(main_blueprint)
 

OpenOversight/app/api/v1.py

@@ -0,0 +1,147 @@
+from http import HTTPMethod
+from typing import List
+
+from flask import Blueprint, Response, jsonify
+from sqlalchemy.orm import contains_eager, joinedload
+
+from OpenOversight.app.models.database import (
+    Assignment,
+    BaseModel,
+    Department,
+    Description,
+    Incident,
+    Link,
+    Officer,
+    Salary,
+    db,
+)
+from OpenOversight.app.models.database_cache import (
+    get_database_cache_entry,
+    put_database_cache_entry,
+)
+from OpenOversight.app.utils.constants import (
+    KEY_DEPT_ALL_ASSIGNMENTS,
+    KEY_DEPT_ALL_INCIDENTS,
+    KEY_DEPT_ALL_LINKS,
+    KEY_DEPT_ALL_NOTES,
+    KEY_DEPT_ALL_OFFICERS,
+    KEY_DEPT_ALL_SALARIES,
+)
+from OpenOversight.app.utils.flask import limiter
+
+
+v1 = Blueprint("v1", __name__, url_prefix="/api/v1")
+
+
+def objs_to_dicts_jsonify(obj_list: List[BaseModel]) -> Response:
+    return jsonify([o.to_dict() for o in obj_list])
+
+
+@v1.route("/departments/<int:department_id>/officers", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_officers(department_id: int) -> Response:
+    cache_params = (Department(id=department_id), KEY_DEPT_ALL_OFFICERS)
+    officers = get_database_cache_entry(*cache_params)
+
+    if officers is None:
+        officers = (
+            db.session.query(Officer)
+            .options(joinedload(Officer.assignments).joinedload(Assignment.job))
+            .options(joinedload(Officer.salaries))
+            .filter_by(department_id=department_id)
+            .all()
+        )
+        put_database_cache_entry(*cache_params, officers)
+
+    return objs_to_dicts_jsonify(officers)
+
+
+@v1.route("/departments/<int:department_id>/assignments", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_assignments(department_id: int) -> Response:
+    cache_params = Department(id=department_id), KEY_DEPT_ALL_ASSIGNMENTS
+    assignments = get_database_cache_entry(*cache_params)
+
+    if assignments is None:
+        assignments = (
+            db.session.query(Assignment)
+            .join(Assignment.base_officer)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Assignment.base_officer))
+            .options(joinedload(Assignment.unit))
+            .options(joinedload(Assignment.job))
+            .all()
+        )
+        put_database_cache_entry(*cache_params, assignments)
+
+    return objs_to_dicts_jsonify(assignments)
+
+
+@v1.route("/departments/<int:department_id>/incidents", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_incidents(department_id: int) -> Response:
+    cache_params = (Department(id=department_id), KEY_DEPT_ALL_INCIDENTS)
+    incidents = get_database_cache_entry(*cache_params)
+
+    if incidents is None:
+        incidents = Incident.query.filter_by(department_id=department_id).all()
+        put_database_cache_entry(*cache_params, incidents)
+
+    return objs_to_dicts_jsonify(incidents)
+
+
+@v1.route("/departments/<int:department_id>/salaries", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_salaries(department_id: int) -> Response:
+    cache_params = (Department(id=department_id), KEY_DEPT_ALL_SALARIES)
+    salaries = get_database_cache_entry(*cache_params)
+
+    if salaries is None:
+        salaries = (
+            db.session.query(Salary)
+            .join(Salary.officer)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Salary.officer))
+            .all()
+        )
+        put_database_cache_entry(*cache_params, salaries)
+
+    return objs_to_dicts_jsonify(salaries)
+
+
+@v1.route("/departments/<int:department_id>/links", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_links(department_id: int) -> Response:
+    cache_params = (Department(id=department_id), KEY_DEPT_ALL_LINKS)
+    links = get_database_cache_entry(*cache_params)
+
+    if links is None:
+        links = (
+            db.session.query(Link)
+            .join(Link.officers)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Link.officers))
+            .all()
+        )
+        put_database_cache_entry(*cache_params, links)
+
+    return objs_to_dicts_jsonify(links)
+
+
+@v1.route("/departments/<int:department_id>/descriptions", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_descriptions(department_id: int) -> Response:
+    cache_params = (Department(id=department_id), KEY_DEPT_ALL_NOTES)
+    notes = get_database_cache_entry(*cache_params)
+
+    if notes is None:
+        notes = (
+            db.session.query(Description)
+            .join(Description.officer)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Description.officer))
+            .all()
+        )
+        put_database_cache_entry(*cache_params, notes)
+
+    return objs_to_dicts_jsonify(notes)

OpenOversight/app/main/views.py

@@ -217,7 +217,8 @@ def get_officer():
 def redirect_get_started_labeling():
     flash(FLASH_MSG_PERMANENT_REDIRECT)
     return redirect(
-        url_for("main.get_started_labeling"), code=HTTPStatus.PERMANENT_REDIRECT
+        url_for("main.get_started_labeling"),
+        code=HTTPStatus.PERMANENT_REDIRECT,
     )
 
 
@@ -422,7 +423,9 @@ def redirect_edit_assignment(officer_id: int, assignment_id: int):
     flash(FLASH_MSG_PERMANENT_REDIRECT)
     return redirect(
         url_for(
-            "main.edit_assignment", officer_id=officer_id, assignment_id=assignment_id
+            "main.edit_assignment",
+            officer_id=officer_id,
+            assignment_id=assignment_id,
         ),
         code=HTTPStatus.PERMANENT_REDIRECT,
     )
@@ -632,7 +635,9 @@ def display_tag(tag_id: int):
 def redirect_classify_submission(image_id: int, contains_cops: int):
     return redirect(
         url_for(
-            "main.classify_submission", image_id=image_id, contains_cops=contains_cops
+            "main.classify_submission",
+            image_id=image_id,
+            contains_cops=contains_cops,
         ),
         code=HTTPStatus.PERMANENT_REDIRECT,
     )
@@ -816,7 +821,10 @@ def edit_department(department_id: int):
                             f"You attempted to delete a rank, {rank}, that is still in use"
                         )
                     return redirect(
-                        url_for("main.edit_department", department_id=department_id)
+                        url_for(
+                            "main.edit_department",
+                            department_id=department_id,
+                        )
                     )
 
             for new_rank, order in new_ranks:
@@ -2302,7 +2310,11 @@ def redirect_edit_description(officer_id: int, obj_id=None):
 def redirect_delete_description(officer_id: int, obj_id=None):
     flash(FLASH_MSG_PERMANENT_REDIRECT)
     return redirect(
-        url_for("main.description_api_delete", officer_id=officer_id, obj_id=obj_id),
+        url_for(
+            "main.description_api_delete",
+            officer_id=officer_id,
+            obj_id=obj_id,
+        ),
         code=HTTPStatus.PERMANENT_REDIRECT,
     )
 

OpenOversight/app/models/database.py

@@ -199,11 +199,11 @@ class Department(BaseModel, TrackUpdates):
     __table_args__ = (UniqueConstraint("name", "state", name="departments_name_state"),)
 
     @property
-    def display_name(self):
+    def display_name(self) -> str:
         return self.name if not self.state else f"[{self.state}] {self.name}"
 
     @cached(cache=DB_CACHE, key=model_cache_key(KEY_DEPT_TOTAL_ASSIGNMENTS))
-    def total_documented_assignments(self):
+    def total_documented_assignments(self) -> int:
         return (
             db.session.query(Assignment.id)
             .join(Officer, Assignment.officer_id == Officer.id)
@@ -212,13 +212,13 @@ def total_documented_assignments(self):
         )
 
     @cached(cache=DB_CACHE, key=model_cache_key(KEY_DEPT_TOTAL_INCIDENTS))
-    def total_documented_incidents(self):
+    def total_documented_incidents(self) -> int:
         return (
             db.session.query(Incident).filter(Incident.department_id == self.id).count()
         )
 
     @cached(cache=DB_CACHE, key=model_cache_key(KEY_DEPT_TOTAL_OFFICERS))
-    def total_documented_officers(self):
+    def total_documented_officers(self) -> int:
         return (
             db.session.query(Officer).filter(Officer.department_id == self.id).count()
         )

OpenOversight/tests/routes/test_api_v1.py

@@ -0,0 +1,77 @@
+import json
+from http import HTTPStatus
+
+import pytest
+from flask import current_app, url_for
+from sqlalchemy.orm import contains_eager, joinedload
+
+from OpenOversight.app.models.database import Assignment, Incident, Officer, Salary
+from OpenOversight.app.utils.constants import ENCODING_UTF_8
+
+
+@pytest.mark.parametrize("department_id", [1, 3000])
+def test_get_dept_attributes(client, session, department_id: int):
+    with current_app.test_request_context():
+        # Get officers
+        expected_officers = Officer.query.filter_by(department_id=department_id).count()
+
+        resp_officers = client.get(
+            url_for("v1.get_dept_officers", department_id=department_id),
+            follow_redirects=True,
+        )
+        officers = json.loads(resp_officers.data.decode(ENCODING_UTF_8))
+
+        assert resp_officers.status_code == HTTPStatus.OK
+        assert len(officers) == expected_officers
+
+        # Get assignments
+        expected_assignments = (
+            session.query(Assignment)
+            .join(Assignment.base_officer)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Assignment.base_officer))
+            .options(joinedload(Assignment.unit))
+            .options(joinedload(Assignment.job))
+            .all()
+        )
+
+        resp_assignments = client.get(
+            url_for("v1.get_dept_assignments", department_id=department_id),
+            follow_redirects=True,
+        )
+        assignments = json.loads(resp_assignments.data.decode(ENCODING_UTF_8))
+
+        assert resp_assignments.status_code == HTTPStatus.OK
+        assert len(assignments) == len(expected_assignments)
+
+        # Get incidents
+        expected_incidents = Incident.query.filter_by(
+            department_id=department_id
+        ).count()
+
+        resp_incidents = client.get(
+            url_for("v1.get_dept_incidents", department_id=department_id),
+            follow_redirects=True,
+        )
+        incidents = json.loads(resp_incidents.data.decode(ENCODING_UTF_8))
+
+        assert resp_incidents.status_code == HTTPStatus.OK
+        assert len(incidents) == expected_incidents
+
+        # Get salaries
+        expected_salaries = (
+            session.query(Salary)
+            .join(Salary.officer)
+            .filter(Officer.department_id == department_id)
+            .options(contains_eager(Salary.officer))
+            .count()
+        )
+
+        resp_salaries = client.get(
+            url_for("v1.get_dept_salaries", department_id=department_id),
+            follow_redirects=True,
+        )
+        salaries = json.loads(resp_salaries.data.decode(ENCODING_UTF_8))
+
+        assert resp_salaries.status_code == HTTPStatus.OK
+        assert len(salaries) == expected_salaries