zboxapi 0.0.3__tar.gz → 0.0.4__tar.gz

{zboxapi-0.0.3 → zboxapi-0.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zboxapi
-Version: 0.0.3
+Version: 0.0.4
 Summary: 
 Author: Kelby Valenti
 Author-email: kelby.valenti@gmail.com

{zboxapi-0.0.3 → zboxapi-0.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zboxapi"
-version = "0.0.3"
+version = "0.0.4"
 description = ""
 authors = ["Kelby Valenti <kelby.valenti@gmail.com>", "Timo Sugliani <timo.sugliani@gmail.com>"]
 readme = "README.md"

zboxapi-0.0.4/src/zboxapi/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.4"

{zboxapi-0.0.3 → zboxapi-0.0.4}/src/zboxapi/main.py

@@ -1,5 +1,6 @@
 import contextlib
 import fcntl
+import os
 import re
 import socket
 
@@ -12,6 +13,7 @@ from typing import IO, Annotated
 
 import uvicorn
 from fastapi import APIRouter, Depends, FastAPI, HTTPException, Security, status
+from fastapi.routing import APIRoute
 from fastapi.security.api_key import APIKey, APIKeyHeader
 from pydantic import AfterValidator, BaseModel
 from pydantic_core import PydanticCustomError
@@ -107,6 +109,17 @@ def sort_hosts_lines(item: dict):
     )
 
 
+def simplify_operation_ids(api: FastAPI) -> None:
+    """
+    Update operation IDs so that generated API clients have simpler function
+    names.
+    """
+    for route in api.routes:
+        if isinstance(route, APIRoute) and not route.operation_id:
+            tag = route.tags[0] if route.tags else "default"
+            route.operation_id = f"{tag}_{route.name}"
+
+
 def make_list(obj):
     return obj if isinstance(obj, list) else [obj]
 
@@ -163,24 +176,24 @@ def validate_fqdn(value: str):
 FQDN = Annotated[str, AfterValidator(validate_fqdn)]
 
 
-class DnsCreate(BaseModel):
+class HostsCreate(BaseModel):
     ip: IPv4Address
     fqdn: FQDN
 
 
-class DnsDelete(BaseModel):
+class HostsDelete(BaseModel):
     ip: IPv4Address
     fqdn: FQDN
 
 
-class DnsUpdate(BaseModel):
+class HostsUpdate(BaseModel):
     ip: IPv4Address
     fqdn: FQDN
     new_ip: IPv4Address
     new_fqdn: FQDN
 
 
-class DnsView(BaseModel):
+class HostsView(BaseModel):
     ip: IPv4Address
     fqdn: str
 
@@ -192,7 +205,7 @@ hosts_router = APIRouter(prefix="/hosts", tags=["hosts"])
 def get_hosts(
     ip: IPv4Address | None = None,
     fqdn: str | None = None,
-) -> list[DnsView]:
+) -> list[HostsView]:
     with get_hosts_file_object() as hosts_fo:
         hosts_lines = get_hosts_lines(hosts_fo)
         hosts_lines = filter_hosts_file(hosts_lines, ip, fqdn)
@@ -200,7 +213,7 @@ def get_hosts(
 
 
 @hosts_router.post("")
-def add_hosts(lines_in: list[DnsCreate] | DnsCreate) -> list[DnsView]:
+def add_hosts(lines_in: list[HostsCreate] | HostsCreate) -> list[HostsView]:
     with get_hosts_file_object() as hosts_fo:
         hosts_lines = get_hosts_lines(hosts_fo)
         for line in make_list(lines_in):
@@ -213,7 +226,7 @@ def add_hosts(lines_in: list[DnsCreate] | DnsCreate) -> list[DnsView]:
 
 
 @hosts_router.put("")
-def update_hosts(lines_in: list[DnsUpdate] | DnsUpdate) -> list[DnsView]:
+def update_hosts(lines_in: list[HostsUpdate] | HostsUpdate) -> list[HostsView]:
     with get_hosts_file_object() as hosts_fo:
         hosts_lines = get_hosts_lines(hosts_fo)
         for line in make_list(lines_in):
@@ -228,7 +241,7 @@ def update_hosts(lines_in: list[DnsUpdate] | DnsUpdate) -> list[DnsView]:
 
 
 @hosts_router.delete("")
-def delete_hosts(lines_in: list[DnsDelete] | DnsDelete) -> list[DnsView]:
+def delete_hosts(lines_in: list[HostsDelete] | HostsDelete) -> list[HostsView]:
     with get_hosts_file_object() as hosts_fo:
         hosts_lines = get_hosts_lines(hosts_fo)
         for line in make_list(lines_in):
@@ -241,15 +254,23 @@ def delete_hosts(lines_in: list[DnsDelete] | DnsDelete) -> list[DnsView]:
     return hosts_lines
 
 
-app = FastAPI(title="zPod zBox API", dependencies=[Depends(validate_api_key)])
+zboxapi_root_path = os.getenv("ZBOXAPI_ROOT_PATH", None)
+
+app = FastAPI(
+    title="zBox API",
+    root_path=zboxapi_root_path,
+    dependencies=[Depends(validate_api_key)],
+)
 app.include_router(hosts_router)
+simplify_operation_ids(app)
+
 ZPOD_PASSWORD = get_zpod_password()
 
 
 def launch():
     uvicorn.run(
         app,
-        host="zbox",
+        host="127.0.0.1",
         port=8000,
     )
 

zboxapi-0.0.3/src/zboxapi/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.3"