Merge pull request #59 from Police-Data-Accessibility-Project/mc_issu…

…e_364_consolidate_body_response_formatting

Refactored resource_helpers to include create_outer_model function

resources/DataSources.py

@@ -10,7 +10,7 @@
     update_data_source_wrapper,
     needs_identification_data_sources_wrapper,
 )
-from resources.resource_helpers import add_api_key_header_arg
+from resources.resource_helpers import add_api_key_header_arg, create_outer_model
 from utilities.namespace import create_namespace
 from resources.PsycopgResource import PsycopgResource, handle_exceptions
 
@@ -28,24 +28,19 @@
         "attribute_3": fields.String(
             description="Continue for as many attributes as you intend to modify",
         ),
-    }
+    },
 )
 
 
-data_sources_outer_model = namespace_data_source.model(
-    "DataSourcesOuter",
-    {
-        "count": fields.Integer(required=True, description="The count of data objects"),
-        "data": fields.List(
-            fields.Nested(data_sources_inner_model),
-        )
-    },
+data_sources_outer_model = create_outer_model(
+    namespace_data_source, data_sources_inner_model, "DataSourcesOuter"
 )
 
 
 authorization_parser = namespace_data_source.parser()
 add_api_key_header_arg(authorization_parser)
 
+
 @namespace_data_source.route("/data-sources-by-id/<data_source_id>")
 @namespace_data_source.param(
     name="data_source_id",
@@ -160,7 +155,6 @@ def post(self) -> Response:
 @namespace_data_source.route("/data-sources-needs-identification")
 class DataSourcesNeedsIdentification(PsycopgResource):
 
-
     @namespace_data_source.response(200, "Success", data_sources_outer_model)
     @namespace_data_source.response(500, "Internal server error")
     @namespace_data_source.response(400, "Bad request; missing or bad API key")
@@ -176,7 +170,6 @@ def get(self):
             return needs_identification_data_sources_wrapper(db_client)
 
 
-
 @namespace_data_source.route("/data-sources-map")
 class DataSourcesMap(PsycopgResource):
     """

resources/TypeaheadSuggestions.py

@@ -3,6 +3,7 @@
 
 from middleware.typeahead_suggestion_logic import get_typeahead_suggestions_wrapper
 from resources.PsycopgResource import handle_exceptions, PsycopgResource
+from resources.resource_helpers import create_outer_model
 
 from utilities.namespace import create_namespace, AppNamespaces
 
@@ -49,14 +50,10 @@
     },
 )
 
-typeahead_suggestions_outer_model = namespace_typeahead_suggestions.model(
+typeahead_suggestions_outer_model = create_outer_model(
+    namespace_typeahead_suggestions,
+    typeahead_suggestions_inner_model,
     "TypeaheadSuggestionsOuter",
-    {
-        "suggestions": fields.List(
-            fields.Nested(typeahead_suggestions_inner_model),
-            description="A list of suggestions",
-        ),
-    },
 )
 
 

resources/resource_helpers.py

@@ -52,20 +52,27 @@ def create_search_model(namespace: Namespace) -> Model:
         },
     )
 
-    search_result_outer_model = namespace.model(
-        "SearchResultOuter",
+    search_result_outer_model = create_outer_model(
+        namespace, search_result_inner_model, "SearchResultOuter"
+    )
+
+    return search_result_outer_model
+
+
+def create_outer_model(namespace: Namespace, inner_model: Model, name: str) -> Model:
+    return namespace.model(
+        name,
         {
             "count": fields.Integer(
-                required=True, description="Count of data items", attribute="count"
+                required=True, description=f"Count of {inner_model.name} items", attribute="count"
             ),
             "data": fields.List(
                 fields.Nested(
-                    search_result_inner_model,
+                    inner_model,
                     required=True,
-                    description="List of data items",
+                    description=f"List of {inner_model.name} items",
                 ),
                 attribute="data",
             ),
         },
     )
-    return search_result_outer_model