Merge pull request #439 from mfoos/mfoos_agencies_filter

Added agency filters and tests

Author: mfoos

.github/actions/setup-frontend/action.yml

@@ -9,7 +9,7 @@ runs:
   using: "composite"
   steps:
     - name: Use Node.js ${{ inputs.node-version }}
-      uses: actions/setup-node@v2
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ inputs.node-version }}
         cache: "npm"

backend/routes/agencies.py

@@ -7,7 +7,7 @@
     NodeConflictException)
 from backend.mixpanel.mix import track_to_mp
 from backend.database.models.user import UserRole
-from backend.database.models.agency import Agency
+from backend.database.models.agency import Agency, State
 from .tmp.pydantic.agencies import CreateAgency, UpdateAgency
 from flask import Blueprint, abort, request
 from flask_jwt_extended.view_decorators import jwt_required
@@ -144,13 +144,40 @@ def get_all_agencies():
     Accepts Query Parameters for pagination:
     per_page: number of results per page
     page: page number
+    name: filter on agency name
+    hq_city: filter on agency city
+    hq_state: filter on agency state
+    hq_zip: filter on agency zipcode
+    jurisdiction: filter on agency jurisdiction
     """
     args = request.args
     q_page = args.get("page", 1, type=int)
     q_per_page = args.get("per_page", 20, type=int)
 
-    all_agencies = Agency.nodes.all()
-    results = paginate_results(all_agencies, q_page, q_per_page)
+    params = ["name", "hq_city", "hq_state", "hq_zip", "jurisdiction"]
+    params_used = set(params).intersection(args.keys())
+    params.extend(["page", "per_page"])
+
+    # includes unrecognized parameters
+    if bool(set(args).difference(params)):
+        abort(400)
+
+    # any valid filter parameters supplied
+    if bool(params_used):
+        filter_on = {}
+
+        for p in params_used:
+            input_value = args.get(key=p, default=None, type=str)
+            if p == "hq_state":
+                if input_value not in State.choices():
+                    abort(400)
+            filter_on[p] = input_value
+
+        agencies_filtered = Agency.nodes.filter(**filter_on)
+        results = paginate_results(agencies_filtered, q_page, q_per_page)
+    else:
+        all_agencies = Agency.nodes.all()
+        results = paginate_results(all_agencies, q_page, q_per_page)
 
     return ordered_jsonify(results), 200
 

backend/tests/test_agencies.py

@@ -37,6 +37,7 @@
         "hq_address": "3510 S Michigan Ave",
         "hq_city": "Chicago",
         "hq_zip": "60653",
+        "hq_state": "IL",
         "jurisdiction": "MUNICIPAL"
     },
     "nypd": {
@@ -45,6 +46,16 @@
         "hq_address": "1 Police Plaza",
         "hq_city": "New York",
         "hq_zip": "10038",
+        "hq_state": "NY",
+        "jurisdiction": "MUNICIPAL"
+    },
+    "npd": {
+        "name": "Newton Police Dept.",
+        "website_url": "https://www.newtonma.gov/government/police-department",
+        "hq_address": "1321 Washington St.",
+        "hq_city": "Newton",
+        "hq_zip": "02465",
+        "hq_state": "MA",
         "jurisdiction": "MUNICIPAL"
     }
 }
@@ -125,6 +136,72 @@ def test_get_all_agencies(client, access_token, example_agencies):
     assert res.json["results"].__len__() == total_agencies
 
 
+def test_filter_agencies(client, access_token, example_agencies):
+    # Test filtering
+    expect_name_ct = Agency.nodes.filter(
+        name="New York Police Department"
+    ).__len__()
+    res = client.get(
+        "/api/v1/agencies/?name=New York Police Department",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+    assert res.json['results'].__len__() == expect_name_ct
+
+    expect_city_ct = Agency.nodes.filter(hq_city="Chicago").__len__()
+    res = client.get(
+        "/api/v1/agencies/?hq_city=Chicago",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+    assert res.json['results'].__len__() == expect_city_ct
+
+    expect_state_ct = Agency.nodes.filter(hq_state="NY").__len__()
+    res = client.get(
+        "/api/v1/agencies/?hq_state=NY",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+    assert res.json['results'].__len__() == expect_state_ct
+
+    # State name not abbreviated correctly
+    res = client.get(
+        "/api/v1/agencies/?hq_state=New York",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 400
+
+    # No parameter "state"
+    res = client.get(
+        "/api/v1/agencies/?state=NY",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 400
+
+    expect_zip_ct = Agency.nodes.filter(hq_zip="60653").__len__()
+    res = client.get(
+        "/api/v1/agencies/?hq_zip=60653",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+    assert res.json['results'].__len__() == expect_zip_ct
+
+    # If leading zeroes get coerced anywhere, zip codes will break
+    res = client.get(
+        "/api/v1/agencies/?hq_zip=02465",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+
+    expect_juri_ct = Agency.nodes.filter(jurisdiction="MUNICIPAL").__len__()
+    res = client.get(
+        "/api/v1/agencies/?jurisdiction=MUNICIPAL",
+        headers={"Authorization": "Bearer {0}".format(access_token)}
+    )
+    assert res.status_code == 200
+    assert res.json['results'].__len__() == expect_juri_ct
+
+
 def test_agency_pagination(client, example_agencies, access_token):
     per_page = 1
     total_agencies = Agency.nodes.all().__len__()

oas/2.0/agencies.yaml

@@ -32,9 +32,9 @@ paths:
         - $ref: '../common/pagination.yaml#/components/parameters/per_page'
         - $ref: '#/components/parameters/jurisdiction'
         - $ref: '#/components/parameters/name'
-        - $ref: '#/components/parameters/zip_code'
-        - $ref: '#/components/parameters/city'
-        - $ref: '#/components/parameters/state'
+        - $ref: '#/components/parameters/hq_zip'
+        - $ref: '#/components/parameters/hq_city'
+        - $ref: '#/components/parameters/hq_state'
       tags: 
         -  Agencies
       responses:
@@ -327,23 +327,23 @@ components:
       schema:
         type: "string"
     zip_code:
-      name: "zip_code"
+      name: "hq_zip"
       in: "query"
       description: "Filter by zip code"
       required: false
       schema:
         type: "string"
     city:
-      name: "city"
+      name: "hq_city"
       in: "query"
       description: "Filter by city"
       required: false
       schema:
         type: "string"
     state:
-      name: "state"
+      name: "hq_state"
       in: "query"
-      description: "Filter by state"
+      description: "Filter by state (two-letter abbreviation)"
       required: false
       schema:
         type: "string"