Merge pull request #10 from wook3024/develop

v0.1.0

Author: wook3024

.pre-commit-config.yaml

@@ -35,4 +35,4 @@ repos:
     rev: 5.10.1
     hooks:
       - id: isort
-        name: isort (python)
+        args: ["--profile", "black"]

README.md

@@ -1,15 +1,36 @@
-# FastAPI template
-
-## Quickstart
-
-### Build and start containers
-
+# WeatherBot API 
+---
+## Quickstart 
+가상환경 또는 컨테이너를 사용해 실행합니다.
+### container (build and start containers)
 ```sh
 docker-compose up -d --build
 ```
-
-### API server health check
-
+### venv (setup environments and run server)
+```sh
+1. pip install pip-tools
+2. pip-sync requirements/dev.txt
+3. sh run_server.sh
+```
+---
+## Health check
+서버 상태를 체크합니다.
 ```sh
 curl -X GET http://localhost:8000/livez
 ```
+---
+## Unittest
+가상환경 또는 컨테이너를 사용해 테스트합니다.
+### container
+```sh
+docker exec -it web bash -c "pytest -vv tests"
+```
+### venv
+```sh
+pytest -vv tests
+```
+---
+## Coinfig
+앱의 config를 관리합니다.
+- app.conf.log: 로그 설정 config를 관리합니다.
+- app.conf.config.service: 전체적인 서비스와 관련된 config를 관리합니다.

app/conf/config.yaml

@@ -1,3 +1,3 @@
 defaults:
     - log: default
-    - service: dev
+    - service: default

app/conf/service/default.yaml

@@ -0,0 +1,49 @@
+app:
+  title: FastAPI
+  version: 0.1.0
+  host: 127.0.0.1
+  port: 8000
+  reload: True
+  timeout: 1.5
+
+weather:
+  base_url: https://thirdparty-weather-api-v2.droom.workers.dev
+  historical_endpoint: /historical/hourly
+  current_endpoint: /current
+  api_key: CMRJW4WT7V3QA5AOIGPBC
+  weather_map:
+    - "sun"
+    - "foggy"
+    - "rain"
+    - "snow"
+    - "others"
+  base_hot_temp: 15
+  base_cold_temp: -2
+  base_rainfall: 100
+  base_warm_temp: 30
+  historical_time_unit: -6
+
+message:
+  greeting:
+    snow: "눈이 포슬포슬 내립니다."
+    heavy_snow: "폭설이 내리고 있어요."
+    rain: "비가 오고 있습니다."
+    heavy_rain: "폭우가 내리고 있어요."
+    foggy: "날씨가 약간은 칙칙해요."
+    sunny: "따사로운 햇살을 맞으세요."
+    cold: "날이 참 춥네요."
+    clear: "날씨가 참 맑습니다."
+  temperature:
+    min_max: "최고기온은 {}도, 최저기온은 {}도 입니다."
+    hotter: "어제보다 {}도 더 덥습니다."
+    less_hot: "어제보다 {}도 덜 덥습니다."
+    similarly_hot: "어제와 비슷하게 덥습니다."
+    colder: "어제보다 {}도 더 춥습니다."
+    less_cold: "어제보다 {}도 덜 춥습니다."
+    similarly_cold: "어제와 비슷하게 춥습니다."
+  headsup:
+    heavy_snow: "내일 폭설이 내릴 수도 있으니 외출 시 주의하세요."
+    snow: "눈이 내릴 예정이니 외출 시 주의하세요."
+    heavy_rain: "폭우가 내릴 예정이에요. 우산을 미리 챙겨두세요."
+    rain: "며칠동안 비 소식이 있어요."
+    clear: "날씨는 대체로 평온할 예정이에요."

app/conf/service/dev.yaml

@@ -1,11 +1,15 @@
+import asyncio
 import time
-import uvicorn
 
+import uvicorn
 from fastapi import FastAPI, Request
+from fastapi.encoders import jsonable_encoder
+from fastapi.exceptions import RequestValidationError
 from fastapi.responses import ORJSONResponse
+from starlette.status import HTTP_400_BAD_REQUEST, HTTP_408_REQUEST_TIMEOUT
 
-from .routes import index
-from . import logger, cfg
+from . import cfg, logger
+from .routes import index, weather
 
 
 def create_app() -> FastAPI:
@@ -15,21 +19,42 @@ def create_app() -> FastAPI:
         default_response_class=ORJSONResponse,
     )
 
-    @app.middleware("http")
-    async def add_process_time_header(request: Request, call_next):
+    app.include_router(router=index.router, tags=["Index"])
+    app.include_router(router=weather.router, tags=["Weather"])
+
+    return app
+
+
+app = create_app()
+
+
+@app.middleware("http")
+async def timeout_middleware(request: Request, call_next):
+    try:
         start_time = time.time()
-        response = await call_next(request)
+        return await asyncio.wait_for(
+            call_next(request), timeout=cfg.service.app.timeout
+        )
+    except asyncio.TimeoutError:
+        return ORJSONResponse(
+            status_code=HTTP_408_REQUEST_TIMEOUT,
+            content=jsonable_encoder(
+                {"detail": "Request processing time excedeed limit"}
+            ),
+        )
+    finally:
         process_time = time.time() - start_time
         logger.info(
             "{0} process time: {1:.8f}s".format(call_next.__name__, process_time)
         )
-        return response
-
-    app.include_router(router=index.router, tags=["Index"])
-    return app
 
 
-app = create_app()
+@app.exception_handler(RequestValidationError)
+async def validation_exception_handler(request: Request, exc: RequestValidationError):
+    return ORJSONResponse(
+        status_code=HTTP_400_BAD_REQUEST,
+        content=jsonable_encoder({"detail": exc.errors()}),
+    )
 
 
 if __name__ == "__main__":

app/main.py

@@ -1,6 +1,7 @@
-from fastapi import APIRouter
-from fastapi.responses import RedirectResponse, PlainTextResponse
+import asyncio
 
+from fastapi import APIRouter
+from fastapi.responses import PlainTextResponse, RedirectResponse
 
 router = APIRouter()
 
@@ -24,3 +25,8 @@ async def livez() -> PlainTextResponse:
         sPlainTextResponse: Health check response
     """
     return PlainTextResponse("\n", status_code=200)
+
+
+@router.get("/timeout", include_in_schema=False)
+async def route_for_test(sleep_time: float) -> None:
+    await asyncio.sleep(sleep_time)

app/routes/index.py

@@ -0,0 +1,78 @@
+import asyncio
+from typing import Dict, Optional
+from urllib.parse import urljoin
+
+from fastapi import APIRouter
+from fastapi.encoders import jsonable_encoder
+from fastapi.responses import ORJSONResponse
+from httpx import AsyncClient
+
+from .. import cfg, schemas
+from ..utils.weather import Greeting, HeadsUp, Temperature
+
+router = APIRouter()
+
+
+async def request_weather_data(
+    client: AsyncClient,
+    lon: float,
+    lat: float,
+    endpoint: str,
+    hour_offset: Optional[int] = None,
+) -> Dict:
+    response = await client.get(
+        url=urljoin(
+            base=cfg.service.weather.base_url,
+            url=endpoint,
+        ),
+        params={
+            "api_key": cfg.service.weather.api_key,
+            "lat": lat,
+            "lon": lon,
+            "hour_offset": hour_offset,
+        },
+    )
+    weather = response.json()
+    return weather
+
+
+@router.get("/summary", response_model=schemas.SummaryResponse)
+async def summary(lon: float, lat: float) -> ORJSONResponse:
+    async with AsyncClient() as client:
+        cur_weather, pre_weather = await asyncio.gather(
+            request_weather_data(
+                client=client,
+                lon=lon,
+                lat=lat,
+                endpoint=cfg.service.weather.current_endpoint,
+            ),
+            request_weather_data(
+                client=client,
+                lon=lon,
+                lat=lat,
+                endpoint=cfg.service.weather.historical_endpoint,
+                hour_offset=-24,
+            ),
+        )
+    greeting_message, temp_message, headsup_message = await asyncio.gather(
+        Greeting.get_greeting_message(schemas.CurrentWeatherResponse(**cur_weather)),
+        Temperature.get_temp_message(
+            lat=lat,
+            lon=lon,
+            cur_temp=cur_weather.get("temp", float("inf")),
+            pre_temp=pre_weather.get("temp", float("inf")),
+            hour_offset=-24,
+        ),
+        HeadsUp.get_headsup_message(lat, lon),
+    )
+    return ORJSONResponse(
+        content=jsonable_encoder(
+            {
+                "summary": {
+                    "greeting": greeting_message,
+                    "temperature": temp_message,
+                    "heads_up": headsup_message,
+                }
+            }
+        )
+    )

app/routes/weather.py

@@ -0,0 +1,19 @@
+from .weather import (
+    CurrentWeatherRequest,
+    CurrentWeatherResponse,
+    ForecastWeatherRequest,
+    ForecastWeatherResponse,
+    HistoricalWeatherRequest,
+    HistoricalWeatherResponse,
+    SummaryResponse,
+)
+
+__all__ = [
+    "SummaryResponse",
+    "CurrentWeatherRequest",
+    "CurrentWeatherResponse",
+    "ForecastWeatherRequest",
+    "ForecastWeatherResponse",
+    "HistoricalWeatherRequest",
+    "HistoricalWeatherResponse",
+]

app/schemas/__init__.py

@@ -0,0 +1,49 @@
+from pydantic import BaseModel
+
+
+class Summary(BaseModel):
+    greeting: str
+    temperature: str
+    heads_up: str
+
+
+class SummaryResponse(BaseModel):
+    summary: Summary
+
+
+class Coordinate(BaseModel):
+    lat: float
+    lon: float
+
+
+class CurrentWeatherRequest(Coordinate):
+    ...
+
+
+class CurrentWeatherResponse(BaseModel):
+    timestamp: float
+    code: int
+    temp: float
+    rain1h: int
+
+
+class ForecastWeatherRequest(Coordinate):
+    hour_offset: int
+
+
+class ForecastWeatherResponse(BaseModel):
+    timestamp: float
+    code: int
+    min_temp: float
+    max_temp: float
+    rain: int
+
+
+class HistoricalWeatherRequest(Coordinate):
+    hour_offset: int
+
+
+class HistoricalWeatherResponse(BaseModel):
+    timestamp: float
+    code: int
+    rain1h: int