Merge pull request #27 from letsbuilda/sd/gh26

Move random number generation to generators module

Author: shenanigansd

docs/source/changelog.rst

@@ -4,8 +4,11 @@
 Changelog
 =========
 
+- :release:`1.8.0 <11th March 2023>`
+- :feature:`26` Move random number generation to generators module
+
 - :release:`1.7.0 <11th March 2023>`
-- :feature:`24` Add random number generation
+- :feature:`24` Add bulk uuid generation
 
 - :release:`1.6.0 <09th March 2023>`
 - :feature:`21` Add random number generation

pyproject.toml

@@ -58,6 +58,8 @@ addopts = "tests -r a -v --doctest-modules src"
 max-line-length = 120
 
 [tool.pylint.messages_control]
-disable = "R0903"
+disable = "C0103,R0903,E0213"
 # justifications:
+# C0103 (invalid-name) - pydantic
 # R0903 (too-few-public-methods) - models
+# E0213 (no-self-argument) - pydantic

src/api/__init__.py

@@ -1,3 +1,3 @@
 """Public API for our projects"""
 
-__version__ = "1.7.0"
+__version__ = "1.8.0"

src/api/modules/generators.py

@@ -1,29 +1,30 @@
 """Generation of things"""
 
 import uuid
+from random import randint
 from typing import Literal
 
 from fastapi import APIRouter
 
 # pylint: disable-next=no-name-in-module
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, Field, validator
 
 router_generators = APIRouter(prefix="/generators", tags=["generators"])
 
 
-class UUIDs(BaseModel):
-    """Model to hold a list of UUIDs"""
-
-    uuids: list[str]
-
-
 class UUIDConfig(BaseModel):
     """Model to hold configuration for UUID generation"""
 
     uuid_type: Literal[1, 4]
     quantity: int = Field(gt=0, default=1)
 
 
+class UUIDs(BaseModel):
+    """Model to hold a list of UUIDs"""
+
+    uuids: list[str]
+
+
 @router_generators.post("/uuids/")
 async def bulk_uuids(config: UUIDConfig) -> UUIDs:
     """Generate bulk UUIDs"""
@@ -35,3 +36,32 @@ async def bulk_uuids(config: UUIDConfig) -> UUIDs:
         raise ValueError(f"unsupported UUID type: {config.uuid_type}")
     uuids = [str(function()) for _ in range(config.quantity)]
     return UUIDs(uuids=uuids)
+
+
+class NumbersConfig(BaseModel):
+    """Model to hold configuration for number generation"""
+
+    lower_bound: int | None = Field(default=1)
+    upper_bound: int | None = Field(default=1)
+    quantity: int | None = Field(gt=0, default=1)
+
+    @validator("upper_bound")
+    def upper_bound_must_be_greater_than_lower_bound(cls, v, values):
+        """Confirm upper bound is greater than lower bound"""
+        if "lower_bound" in values and v < values["lower_bound"]:
+            raise ValueError("upper bound must be greater than lower bound")
+        return v
+
+
+class Numbers(BaseModel):
+    """Model to hold a list of numbers"""
+
+    numbers: list[int]
+    total: int
+
+
+@router_generators.post("/random-numbers/")
+async def random_numbers(config: NumbersConfig) -> Numbers:
+    """Generate bulk random numbers"""
+    numbers = [randint(config.lower_bound, config.upper_bound) for _ in range(config.quantity)]
+    return Numbers(numbers=numbers, total=sum(numbers))

src/api/server.py

@@ -1,7 +1,6 @@
 """API server definition"""
 
 from os import getenv
-from random import randint
 
 import sentry_sdk
 from fastapi import APIRouter, FastAPI
@@ -33,13 +32,6 @@ 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",
@@ -69,13 +61,5 @@ 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)
-
 app.include_router(router_generators)

tests/modules/__init__.py

@@ -0,0 +1 @@
+"""Test the modules"""

tests/test_generators.py tests/modules/test_generators.pytests/test_generators.py renamed to tests/modules/test_generators.py

@@ -9,8 +9,17 @@
 client = TestClient(app)
 
 
-def test_read_random_numbers():
+def test_bulk_uuids():
     response = client.post("/generators/uuids/", json={"uuid_type": 1, "quantity": 1})
     assert response.status_code == 200
     first = response.json()["uuids"][0]
     assert isinstance(uuid.UUID(first), uuid.UUID)
+
+
+def test_random_numbers():
+    response = client.post("/generators/random-numbers/", json={})
+    assert response.status_code == 200
+    assert response.json() == {
+        "numbers": [1],
+        "total": 1,
+    }

tests/test_server.py

@@ -15,12 +15,3 @@ 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,
-    }