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,56 @@
+from http import HTTPMethod
+
+from flask import Blueprint, Response, jsonify
+from sqlalchemy.orm import Query
+
+from OpenOversight.app.models.database import Department
+from OpenOversight.app.utils.flask import limiter
+
+
+v1 = Blueprint("v1", __name__, url_prefix="/api/v1")
+
+
+def objs_to_dicts_jsonify(obj_list: Query) -> Response:
+    return jsonify([o.to_dict() for o in obj_list])
+
+
+@v1.route("/departments/<int:department_id>/assignments", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_assignments(department_id: int) -> Response:
+    assignments = Department.get_assignments(department_id)
+    return objs_to_dicts_jsonify(assignments)
+
+
+@v1.route("/departments/<int:department_id>/descriptions", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_descriptions(department_id: int) -> Response:
+    descriptions = Department.get_descriptions(department_id)
+    return objs_to_dicts_jsonify(descriptions)
+
+
+@v1.route("/departments/<int:department_id>/incidents", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_incidents(department_id: int) -> Response:
+    incidents = Department.get_incidents(department_id)
+    return objs_to_dicts_jsonify(incidents)
+
+
+@v1.route("/departments/<int:department_id>/links", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_links(department_id: int) -> Response:
+    links = Department.get_links(department_id)
+    return objs_to_dicts_jsonify(links)
+
+
+@v1.route("/departments/<int:department_id>/officers", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_officers(department_id: int) -> Response:
+    officers = Department.get_officers(department_id)
+    return objs_to_dicts_jsonify(officers)
+
+
+@v1.route("/departments/<int:department_id>/salaries", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def get_dept_salaries(department_id: int) -> Response:
+    salaries = Department.get_salaries(department_id)
+    return objs_to_dicts_jsonify(salaries)

OpenOversight/app/main/views.py

@@ -21,7 +21,7 @@
 from flask_login import current_user, login_required, login_user
 from flask_wtf import FlaskForm
 from sqlalchemy.exc import IntegrityError
-from sqlalchemy.orm import contains_eager, joinedload, selectinload
+from sqlalchemy.orm import selectinload
 from sqlalchemy.orm.exc import NoResultFound
 
 from OpenOversight.app.auth.forms import LoginForm
@@ -71,20 +71,14 @@
     User,
     db,
 )
-from OpenOversight.app.models.database_cache import (
-    get_database_cache_entry,
-    put_database_cache_entry,
-)
 from OpenOversight.app.utils.auth import ac_or_admin_required, admin_required
 from OpenOversight.app.utils.choices import AGE_CHOICES, GENDER_CHOICES, RACE_CHOICES
 from OpenOversight.app.utils.cloud import crop_image, save_image_to_s3_and_db
 from OpenOversight.app.utils.constants import (
     ENCODING_UTF_8,
     FLASH_MSG_PERMANENT_REDIRECT,
     KEY_DEPT_ALL_ASSIGNMENTS,
-    KEY_DEPT_ALL_INCIDENTS,
     KEY_DEPT_ALL_LINKS,
-    KEY_DEPT_ALL_NOTES,
     KEY_DEPT_ALL_OFFICERS,
     KEY_DEPT_ALL_SALARIES,
     KEY_DEPT_TOTAL_ASSIGNMENTS,
@@ -217,7 +211,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 +417,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 +629,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 +815,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:
@@ -1572,18 +1574,7 @@ def redirect_download_dept_officers_csv(department_id: int):
 )
 @limiter.limit("5/minute")
 def download_dept_officers_csv(department_id: int):
-    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)
-
+    officers = Department.get_officers(department_id)
     field_names = [
         "id",
         "unique identifier",
@@ -1599,6 +1590,7 @@ def download_dept_officers_csv(department_id: int):
         "job title",
         "most recent salary",
     ]
+
     return make_downloadable_csv(
         officers, department_id, "Officers", field_names, officer_record_maker
     )
@@ -1620,20 +1612,7 @@ def redirect_download_dept_assignments_csv(department_id: int):
 )
 @limiter.limit("5/minute")
 def download_dept_assignments_csv(department_id: int):
-    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)
-
+    assignments = Department.get_assignments(department_id)
     field_names = [
         "id",
         "officer id",
@@ -1645,6 +1624,7 @@ def download_dept_assignments_csv(department_id: int):
         "unit id",
         "unit description",
     ]
+
     return make_downloadable_csv(
         assignments,
         department_id,
@@ -1670,12 +1650,7 @@ def redirect_download_incidents_csv(department_id: int):
 )
 @limiter.limit("5/minute")
 def download_incidents_csv(department_id: int):
-    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)
-
+    incidents = Department.get_incidents(department_id)
     field_names = [
         "id",
         "report_num",
@@ -1687,6 +1662,7 @@ def download_incidents_csv(department_id: int):
         "links",
         "officers",
     ]
+
     return make_downloadable_csv(
         incidents,
         department_id,
@@ -1712,18 +1688,7 @@ def redirect_download_dept_salaries_csv(department_id: int):
 )
 @limiter.limit("5/minute")
 def download_dept_salaries_csv(department_id: int):
-    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)
-
+    salaries = Department.get_salaries(department_id)
     field_names = [
         "id",
         "officer id",
@@ -1734,6 +1699,7 @@ def download_dept_salaries_csv(department_id: int):
         "year",
         "is_fiscal_year",
     ]
+
     return make_downloadable_csv(
         salaries, department_id, "Salaries", field_names, salary_record_maker
     )
@@ -1751,18 +1717,7 @@ def redirect_download_dept_links_csv(department_id: int):
 @main.route("/download/departments/<int:department_id>/links", methods=[HTTPMethod.GET])
 @limiter.limit("5/minute")
 def download_dept_links_csv(department_id: int):
-    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)
-
+    links = Department.get_links(department_id)
     field_names = [
         "id",
         "title",
@@ -1773,6 +1728,7 @@ def download_dept_links_csv(department_id: int):
         "officers",
         "incidents",
     ]
+
     return make_downloadable_csv(
         links, department_id, "Links", field_names, links_record_maker
     )
@@ -1794,18 +1750,7 @@ def redirect_download_dept_descriptions_csv(department_id: int):
 )
 @limiter.limit("5/minute")
 def download_dept_descriptions_csv(department_id: int):
-    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)
-
+    descriptions = Department.get_descriptions(department_id)
     field_names = [
         "id",
         "text_contents",
@@ -1814,8 +1759,9 @@ def download_dept_descriptions_csv(department_id: int):
         "created_at",
         "last_updated_at",
     ]
+
     return make_downloadable_csv(
-        notes, department_id, "Notes", field_names, descriptions_record_maker
+        descriptions, department_id, "Notes", field_names, descriptions_record_maker
     )
 
 
@@ -2302,7 +2248,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,
     )