Merge pull request #2038 from PolicyEngine/fix/1988-migrate-household

Migrate `household` endpoints to new API structure

Author: anth-volk

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: minor
+  changes:
+    changed:
+    - Refactored household endpoints to match new API structure

policyengine_api/api.py

@@ -13,7 +13,9 @@
 # from werkzeug.middleware.profiler import ProfilerMiddleware
 
 # Endpoints
+from policyengine_api.routes.error_routes import error_bp
 from policyengine_api.routes.economy_routes import economy_bp
+from policyengine_api.routes.household_routes import household_bp
 from policyengine_api.routes.simulation_analysis_routes import (
     simulation_analysis_bp,
 )
@@ -22,9 +24,6 @@
 
 from .endpoints import (
     get_home,
-    get_household,
-    post_household,
-    update_household,
     get_policy,
     set_policy,
     get_policy_search,
@@ -56,19 +55,13 @@
 
 CORS(app)
 
+app.register_blueprint(error_bp)
+
 app.route("/", methods=["GET"])(get_home)
 
 app.register_blueprint(metadata_bp)
 
-app.route("/<country_id>/household/<household_id>", methods=["GET"])(
-    get_household
-)
-
-app.route("/<country_id>/household", methods=["POST"])(post_household)
-
-app.route("/<country_id>/household/<household_id>", methods=["PUT"])(
-    update_household
-)
+app.register_blueprint(household_bp)
 
 app.route("/<country_id>/policy/<policy_id>", methods=["GET"])(get_policy)
 
@@ -94,12 +87,10 @@
 )
 
 # Routes for economy microsimulation
-app.register_blueprint(economy_bp, url_prefix="/<country_id>/economy")
+app.register_blueprint(economy_bp)
 
 # Routes for AI analysis of economy microsim runs
-app.register_blueprint(
-    simulation_analysis_bp, url_prefix="/<country_id>/simulation-analysis"
-)
+app.register_blueprint(simulation_analysis_bp)
 
 app.route("/<country_id>/user-policy", methods=["POST"])(set_user_policy)
 
@@ -117,9 +108,7 @@
 
 app.route("/simulations", methods=["GET"])(get_simulations)
 
-app.register_blueprint(
-    tracer_analysis_bp, url_prefix="/<country_id>/tracer-analysis"
-)
+app.register_blueprint(tracer_analysis_bp)
 
 
 @app.route("/liveness-check", methods=["GET"])

policyengine_api/endpoints/__init__.py

@@ -1,10 +1,7 @@
 from .home import get_home
 from .household import (
-    get_household,
-    post_household,
     get_household_under_policy,
     get_calculate,
-    update_household,
 )
 from .policy import (
     get_policy,

policyengine_api/endpoints/household.py

@@ -74,174 +74,6 @@ def get_household_year(household):
     return household_year
 
 
-@validate_country
-def get_household(country_id: str, household_id: str) -> dict:
-    """Get a household's input data with a given ID.
-
-    Args:
-        country_id (str): The country ID.
-        household_id (str): The household ID.
-    """
-
-    # Retrieve from the household table
-    row = database.query(
-        f"SELECT * FROM household WHERE id = ? AND country_id = ?",
-        (household_id, country_id),
-    ).fetchone()
-
-    if row is not None:
-        household = dict(row)
-        household["household_json"] = json.loads(household["household_json"])
-        return dict(
-            status="ok",
-            message=None,
-            result=household,
-        )
-    else:
-        response_body = dict(
-            status="error",
-            message=f"Household #{household_id} not found.",
-        )
-        return Response(
-            json.dumps(response_body),
-            status=404,
-            mimetype="application/json",
-        )
-
-
-@validate_country
-def post_household(country_id: str) -> dict:
-    """Set a household's input data.
-
-    Args:
-        country_id (str): The country ID.
-    """
-
-    payload = request.json
-    label = payload.get("label")
-    household_json = payload.get("data")
-    household_hash = hash_object(household_json)
-    api_version = COUNTRY_PACKAGE_VERSIONS.get(country_id)
-
-    try:
-        database.query(
-            f"INSERT INTO household (country_id, household_json, household_hash, label, api_version) VALUES (?, ?, ?, ?, ?)",
-            (
-                country_id,
-                json.dumps(household_json),
-                household_hash,
-                label,
-                api_version,
-            ),
-        )
-    except sqlalchemy.exc.IntegrityError:
-        pass
-
-    household_id = database.query(
-        f"SELECT id FROM household WHERE country_id = ? AND household_hash = ?",
-        (country_id, household_hash),
-    ).fetchone()["id"]
-
-    response_body = dict(
-        status="ok",
-        message=None,
-        result=dict(
-            household_id=household_id,
-        ),
-    )
-    return Response(
-        json.dumps(response_body),
-        status=201,
-        mimetype="application/json",
-    )
-
-
-@validate_country
-def update_household(country_id: str, household_id: str) -> Response:
-    """
-    Update a household via UPDATE request
-
-    Args: country_id (str): The country ID
-    """
-
-    # Fetch existing household first
-    try:
-        row = database.query(
-            f"SELECT * FROM household WHERE id = ? AND country_id = ?",
-            (household_id, country_id),
-        ).fetchone()
-
-        if row is not None:
-            household = dict(row)
-            household["household_json"] = json.loads(
-                household["household_json"]
-            )
-            household["label"]
-        else:
-            response_body = dict(
-                status="error",
-                message=f"Household #{household_id} not found.",
-            )
-            return Response(
-                json.dumps(response_body),
-                status=404,
-                mimetype="application/json",
-            )
-    except Exception as e:
-        logging.exception(e)
-        response_body = dict(
-            status="error",
-            message=f"Error fetching household #{household_id} while updating: {e}",
-        )
-        return Response(
-            json.dumps(response_body),
-            status=500,
-            mimetype="application/json",
-        )
-
-    payload = request.json
-    label = payload.get("label") or household["label"]
-    household_json = payload.get("data") or household["household_json"]
-    household_hash = hash_object(household_json)
-    api_version = COUNTRY_PACKAGE_VERSIONS.get(country_id)
-
-    try:
-        database.query(
-            f"UPDATE household SET household_json = ?, household_hash = ?, label = ?, api_version = ? WHERE id = ?",
-            (
-                json.dumps(household_json),
-                household_hash,
-                label,
-                api_version,
-                household_id,
-            ),
-        )
-    except Exception as e:
-        logging.exception(e)
-        response_body = dict(
-            status="error",
-            message=f"Error fetching household #{household_id} while updating: {e}",
-        )
-        return Response(
-            json.dumps(response_body),
-            status=500,
-            mimetype="application/json",
-        )
-
-    response_body = dict(
-        status="ok",
-        message=None,
-        result=dict(
-            household_id=household_id,
-        ),
-    )
-    return Response(
-        json.dumps(response_body),
-        status=200,
-        mimetype="application/json",
-    )
-
-
 @validate_country
 def get_household_under_policy(
     country_id: str, household_id: str, policy_id: str

policyengine_api/routes/economy_routes.py

@@ -3,15 +3,18 @@
 from policyengine_api.utils import get_current_law_policy_id
 from policyengine_api.utils.payload_validators import validate_country
 from policyengine_api.constants import COUNTRY_PACKAGE_VERSIONS
-from flask import request, Response
+from flask import request
 import json
 
 economy_bp = Blueprint("economy", __name__)
 economy_service = EconomyService()
 
 
 @validate_country
-@economy_bp.route("/<policy_id>/over/<baseline_policy_id>", methods=["GET"])
+@economy_bp.route(
+    "/<country_id>/economy/<int:policy_id>/over/<int:baseline_policy_id>",
+    methods=["GET"],
+)
 def get_economic_impact(country_id, policy_id, baseline_policy_id):
 
     policy_id = int(policy_id or get_current_law_policy_id(country_id))
@@ -30,25 +33,14 @@ def get_economic_impact(country_id, policy_id, baseline_policy_id):
         "version", COUNTRY_PACKAGE_VERSIONS.get(country_id)
     )
 
-    try:
-        result = economy_service.get_economic_impact(
-            country_id,
-            policy_id,
-            baseline_policy_id,
-            region,
-            dataset,
-            time_period,
-            options,
-            api_version,
-        )
-        return result
-    except Exception as e:
-        return Response(
-            {
-                "status": "error",
-                "message": "An error occurred while calculating the economic impact. Details: "
-                + str(e),
-                "result": None,
-            },
-            500,
-        )
+    result = economy_service.get_economic_impact(
+        country_id,
+        policy_id,
+        baseline_policy_id,
+        region,
+        dataset,
+        time_period,
+        options,
+        api_version,
+    )
+    return result

policyengine_api/routes/error_routes.py

@@ -0,0 +1,67 @@
+import json
+from flask import Response, Blueprint
+from werkzeug.exceptions import (
+    HTTPException,
+)
+
+error_bp = Blueprint("error", __name__)
+
+
+@error_bp.app_errorhandler(404)
+def response_404(error) -> Response:
+    """Specific handler for 404 Not Found errors"""
+    return make_error_response(error, 404)
+
+
+@error_bp.app_errorhandler(400)
+def response_400(error) -> Response:
+    """Specific handler for 400 Bad Request errors"""
+    return make_error_response(error, 400)
+
+
+@error_bp.app_errorhandler(401)
+def response_401(error) -> Response:
+    """Specific handler for 401 Unauthorized errors"""
+    return make_error_response(error, 401)
+
+
+@error_bp.app_errorhandler(403)
+def response_403(error) -> Response:
+    """Specific handler for 403 Forbidden errors"""
+    return make_error_response(error, 403)
+
+
+@error_bp.app_errorhandler(500)
+def response_500(error) -> Response:
+    """Specific handler for 500 Internal Server errors"""
+    return make_error_response(error, 500)
+
+
+@error_bp.app_errorhandler(HTTPException)
+def response_http_exception(error: HTTPException) -> Response:
+    """Generic handler for HTTPException; should be raised if no specific handler is found"""
+    return make_error_response(str(error), error.code)
+
+
+@error_bp.app_errorhandler(Exception)
+def response_generic_error(error: Exception) -> Response:
+    """Handler for any unhandled exceptions"""
+    return make_error_response(str(error), 500)
+
+
+def make_error_response(
+    error,
+    status_code: int,
+) -> Response:
+    """Create a generic error response"""
+    return Response(
+        json.dumps(
+            {
+                "status": "error",
+                "message": str(error),
+                "result": None,
+            }
+        ),
+        status_code,
+        mimetype="application/json",
+    )