add random number route

Signed-off-by: Bradley Reynolds <[email protected]>

Author: shenanigansd

docs/source/changelog.rst

@@ -4,6 +4,9 @@
 Changelog
 =========
 
+- :release:`1.6.0 <09th March 2023>`
+- :feature:`21` Add random number generation
+
 - :release:`1.5.0 <28th February 2023>`
 - :feature:`17` Pin the Docker image to a specific SHA-256 digest to help with reproducible builds
 

src/api/__init__.py

@@ -1,3 +1,3 @@
 """Public API for our projects"""
 
-__version__ = "1.5.0"
+__version__ = "1.6.0"

src/api/server.py

@@ -1,6 +1,7 @@
 """API server definition"""
 
 from os import getenv
+from random import randint
 
 import sentry_sdk
 from fastapi import APIRouter, FastAPI
@@ -31,6 +32,13 @@ class TextModel(BaseModel):
     text: str
 
 
+class Numbers(BaseModel):
+    """Model to hold a list of numbers"""
+
+    numbers: list[int]
+    total: int
+
+
 app = FastAPI(
     title="Let's Build A API",
     description="An API to host Let's Build A's projects",
@@ -60,4 +68,11 @@ async def uwuify_route(text: TextModel):
     return {"text": uwuify(text.text)}
 
 
+@router_fun.get("/random-numbers/{quantity}/{range_high}")
+async def random_numbers(quantity: int, range_high: int) -> Numbers:
+    """Generate bulk random numbers"""
+    numbers = [randint(1, range_high) for _ in range(quantity)]
+    return Numbers(numbers=numbers, total=sum(numbers))
+
+
 app.include_router(router_fun)

tests/test_server.py

@@ -15,3 +15,12 @@ def test_read_main():
         "message": "Welcome to the API",
         "version": __version__,
     }
+
+
+def test_read_random_numbers():
+    response = client.get("/fun/random-numbers/1/1")
+    assert response.status_code == 200
+    assert response.json() == {
+        "numbers": [1],
+        "total": 1,
+    }