WIP: Add v1 data API

OpenOversight/app/__init__.py

@@ -6,19 +6,20 @@
 from flask import Flask, jsonify, render_template, request
 from flask_bootstrap import Bootstrap5
 from flask_compress import Compress
-from flask_limiter import Limiter
-from flask_limiter.util import get_remote_address
 from flask_login import LoginManager
 from flask_migrate import Migrate
-from flask_sitemap import Sitemap
 from flask_wtf.csrf import CSRFProtect
 
+from OpenOversight.app.api.api import api as api_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
+from OpenOversight.app.main.views import main as main_blueprint
 from OpenOversight.app.models.config import config
 from OpenOversight.app.models.database import db
 from OpenOversight.app.models.users import AnonymousUser
 from OpenOversight.app.utils.constants import MEGABYTE
+from OpenOversight.app.utils.flask import limiter, sitemap
 
 
 bootstrap = Bootstrap5()
@@ -29,11 +30,6 @@
 login_manager.anonymous_user = AnonymousUser
 login_manager.login_view = "auth.login"
 
-limiter = Limiter(
-    key_func=get_remote_address, default_limits=["100 per minute", "5 per second"]
-)
-
-sitemap = Sitemap()
 csrf = CSRFProtect()
 
 
@@ -52,14 +48,11 @@ def create_app(config_name="default"):
     sitemap.init_app(app)
     compress.init_app(app)
 
-    from OpenOversight.app.main import main as main_blueprint
-
+    # Add Blueprints
+    app.register_blueprint(api_blueprint)
+    app.register_blueprint(auth_blueprint)
     app.register_blueprint(main_blueprint)
 
-    from OpenOversight.app.auth import auth as auth_blueprint
-
-    app.register_blueprint(auth_blueprint, url_prefix="/auth")
-
     max_log_size = 10 * MEGABYTE  # start new log file after 10 MB
     num_logs_to_keep = 5
     file_handler = RotatingFileHandler(

OpenOversight/app/api/api.py

@@ -0,0 +1,8 @@
+from flask import Blueprint
+
+from OpenOversight.app.api.v1.api import v1 as v1_blueprint
+
+
+api = Blueprint("api", __name__, url_prefix="/api")
+
+api.register_blueprint(v1_blueprint)

OpenOversight/app/api/v1/api.py

@@ -0,0 +1,38 @@
+import json
+from http import HTTPMethod, HTTPStatus
+
+from flask import Blueprint, current_app
+from sqlalchemy.orm import joinedload
+
+from OpenOversight.app.models.database import Assignment, Department, Officer, 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_OFFICERS
+from OpenOversight.app.utils.flask import limiter
+
+
+v1 = Blueprint("v1", __name__, url_prefix="/v1")
+
+
+@v1.route("/departments/<int:department_id>/officers", methods=[HTTPMethod.GET])
+@limiter.limit("5/minute")
+def download_dept_officers(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)
+
+    return current_app.response_class(
+        mimetype="application/json",
+        response=json.dumps(officers),
+        status=HTTPStatus.OK,
+    )

OpenOversight/app/auth/__init__.py

@@ -1,6 +0,0 @@
-from flask import Blueprint
-
-
-auth = Blueprint("auth", __name__)
-
-from . import views  # noqa: E402,F401

OpenOversight/app/auth/views.py

@@ -2,6 +2,7 @@
 from http import HTTPMethod, HTTPStatus
 
 from flask import (
+    Blueprint,
     current_app,
     flash,
     redirect,
@@ -12,8 +13,6 @@
 )
 from flask_login import current_user, login_required, login_user, logout_user
 
-from OpenOversight.app import sitemap
-from OpenOversight.app.auth import auth
 from OpenOversight.app.auth.forms import (
     ChangeDefaultDepartmentForm,
     ChangeEmailForm,
@@ -36,10 +35,12 @@
 )
 from OpenOversight.app.utils.auth import admin_required
 from OpenOversight.app.utils.constants import KEY_APPROVE_REGISTRATIONS
+from OpenOversight.app.utils.flask import sitemap
 from OpenOversight.app.utils.forms import set_dynamic_default
 from OpenOversight.app.utils.general import validate_redirect_url
 
 
+auth = Blueprint("auth", __name__, url_prefix="/auth")
 js_loads = ["js/zxcvbn.js", "js/password.js"]
 sitemap_endpoints = []
 

OpenOversight/app/main/__init__.py

@@ -1,6 +0,0 @@
-from flask import Blueprint
-
-
-main = Blueprint("main", __name__)
-
-from OpenOversight.app.main import views  # noqa: E402,F401

OpenOversight/app/main/views.py

@@ -1,4 +1,3 @@
-import os
 import re
 import sys
 from datetime import datetime
@@ -7,6 +6,7 @@
 from typing import Optional
 
 from flask import (
+    Blueprint,
     Response,
     abort,
     current_app,
@@ -24,9 +24,7 @@
 from sqlalchemy.orm import contains_eager, joinedload, selectinload
 from sqlalchemy.orm.exc import NoResultFound
 
-from OpenOversight.app import limiter, sitemap
 from OpenOversight.app.auth.forms import LoginForm
-from OpenOversight.app.main import main
 from OpenOversight.app.main.downloads import (
     assignment_record_maker,
     descriptions_record_maker,
@@ -101,6 +99,7 @@
     dept_choices,
     unit_choices,
 )
+from OpenOversight.app.utils.flask import limiter, sitemap
 from OpenOversight.app.utils.forms import (
     add_new_assignment,
     add_officer_profile,
@@ -124,9 +123,7 @@
 )
 
 
-# Ensure the file is read/write by the creator only
-SAVED_UMASK = os.umask(0o077)
-
+main = Blueprint("main", __name__)
 sitemap_endpoints = []
 
 
@@ -220,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,
     )
 
 
@@ -425,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,
     )
@@ -635,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,
     )
@@ -819,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:
@@ -2305,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/utils/constants.py

@@ -1,6 +1,3 @@
-import os
-
-
 # Cache Key Constants
 KEY_DEPT_ALL_ASSIGNMENTS = "all_department_assignments"
 KEY_DEPT_ALL_INCIDENTS = "all_department_incidents"
@@ -44,7 +41,6 @@
 ENCODING_UTF_8 = "utf-8"
 FILE_TYPE_HTML = "html"
 FILE_TYPE_PLAIN = "plain"
-SAVED_UMASK = os.umask(0o077)  # Ensure the file is read/write by the creator only
 
 # File Name Constants
 SERVICE_ACCOUNT_FILE = "service_account_key.json"

OpenOversight/app/utils/flask.py

@@ -0,0 +1,10 @@
+from flask_limiter import Limiter
+from flask_limiter.util import get_remote_address
+from flask_sitemap import Sitemap
+
+
+limiter: Limiter = Limiter(
+    key_func=get_remote_address, default_limits=["100 per minute", "5 per second"]
+)
+
+sitemap = Sitemap()