Merge pull request #74 from PolicyEngine/feat/add_demo_endpoint

Added calculate_demo endpoint for use on API documentation page

changelog_entry.yaml

@@ -0,0 +1,4 @@
+- bump: patch
+  changes:
+    changed:
+    - Added calculate_demo endpoint for use on API documentation page

policyengine_household_api/api.py

@@ -12,6 +12,7 @@
 from sqlalchemy.orm import DeclarativeBase
 from dotenv import load_dotenv
 from authlib.integrations.flask_oauth2 import ResourceProtector
+from ratelimiter import RateLimiter
 
 # Internal imports
 from .auth.validation import Auth0JWTBearerTokenValidator
@@ -92,4 +93,10 @@ def readiness_check():
     )
 
 
+@app.route("/<country_id>/calculate_demo", methods=["POST"])
+@RateLimiter(max_calls=1, period=1)
+def calculate_demo(country_id):
+    return get_calculate(country_id)
+
+
 print("API initialised.")

setup.py

@@ -27,6 +27,7 @@
         "python-dotenv",
         "pymysql",
         "black==22.12.0",  # This is because policyengine_canada uses black<23
+        "ratelimiter",
     ],
     extras_require={
         "dev": [

tests/python/test_calculate_demo.py

@@ -0,0 +1,26 @@
+import pytest
+import os
+from tests.python.utils import client
+from policyengine_household_api.api import app
+
+
+def test_calc_demo(client):
+    """
+    Ensure that calculate_demo properly calculates;
+    the rate limiter does not return a 4xx, but instead
+    waits until the rate limit has ended, preventing the
+    need for a further test
+    """
+
+    response = client.post(
+        "/us/calculate_demo",
+        headers={
+            "Content-Type": "application/json",
+        },
+        data=open(
+            "./tests/python/data/calculate_us_1_data.json",
+            "r",
+            encoding="utf-8",
+        ),
+    )
+    assert response.status_code == 200, response.text