Add functions to fetch forecast from OWM API

Author: nifadyev

src/owm_api.py

@@ -0,0 +1,48 @@
+from os import getenv
+
+from httpx import AsyncClient, ConnectTimeout
+from dotenv import load_dotenv
+
+from constants.owm_api import DEFAULT_TIMEOUT, OPENWEATHERMAP_REQUEST_TEMPLATE
+from schemas import OWMWeather
+
+load_dotenv()
+
+
+async def retrieve_weather_info() -> OWMWeather:
+    raw_response = await fetch_weather()
+
+    return validate_response(raw_response)
+
+
+async def fetch_weather() -> dict:
+    api_request = render_api_request()
+
+    async with AsyncClient(timeout=DEFAULT_TIMEOUT) as client:
+        try:
+            response = await client.get(api_request)
+        except ConnectTimeout:
+            raise ConnectTimeout(
+                message=f"Request to OpenWeatherMap API took more than {DEFAULT_TIMEOUT} seconds",
+            )
+
+        response.raise_for_status()
+
+        return response.json()
+
+
+def render_api_request() -> str:
+    if not (api_key := getenv("OPENWEATHERMAP_API_KEY")):
+        raise ValueError("Env variable `OPENWEATHERMAP_API_KEY` is missing or empty")
+    if not (latitude := getenv("LATITUDE")):
+        raise ValueError("Env variable `LATITUDE` is missing or empty")
+    if not (longitude := getenv("LONGITUDE")):
+        raise ValueError("Env variable `LONGITUDE` is missing or empty")
+
+    return OPENWEATHERMAP_REQUEST_TEMPLATE.format(
+        api_key=api_key, latitude=latitude, longitude=longitude
+    )
+
+
+def validate_response(raw_response: dict) -> OWMWeather:
+    return OWMWeather.from_dict(raw_response)

tests/conftest.py

@@ -23,9 +23,9 @@ class Meta:
 
     message = factory.SubFactory(MessageFactory)
 
-
-@pytest.fixture(scope="module")
+@pytest.fixture
 def set_owm_api_env_variables():
+    """Do not add scope to this fixture, it will break unit tests at test_owm_api.py."""
     os.environ["OPENWEATHERMAP_API_KEY"] = "fake_app_id"
     os.environ["LATITUDE"] = "12.3456789"
     os.environ["LONGITUDE"] = "98.7654321"

tests/constants.py

@@ -1,5 +1,10 @@
 from typing import Final
 
+OPENWEATHERMAP_REQUEST: Final[str] = (
+    "https://api.openweathermap.org/data/3.0/onecall?"
+    "lat=12.3456789&lon=98.7654321&units=metric&exclude=minutely,hourly&appid=fake_app_id"
+)
+
 
 OWM_RESPONSE_FRAGMENT: Final[str] = """
 {

tests/integration/test_owm_api.py

@@ -0,0 +1,53 @@
+import pytest
+from httpx import ConnectTimeout, HTTPStatusError
+from pytest_httpx import HTTPXMock
+
+from src.owm_api import fetch_weather, retrieve_weather_info
+from tests.constants import OPENWEATHERMAP_REQUEST, OWM_RESPONSE_FRAGMENT
+
+
+@pytest.mark.asyncio
+async def test_retrieve_weather_info(
+    httpx_mock: HTTPXMock, fake_owmweather, set_owm_api_env_variables
+):
+    httpx_mock.add_response(
+        method="GET", url=OPENWEATHERMAP_REQUEST, text=OWM_RESPONSE_FRAGMENT
+    )
+
+    owmweather_instance = await retrieve_weather_info()
+
+    assert owmweather_instance == fake_owmweather
+
+
+@pytest.mark.asyncio
+async def test_fetch_weather(httpx_mock: HTTPXMock, set_owm_api_env_variables):
+    httpx_mock.add_response(method="GET", url=OPENWEATHERMAP_REQUEST, json={})
+
+    json_response = await fetch_weather()
+
+    assert json_response == {}
+
+
+@pytest.mark.asyncio
+async def test_fetch_weather__connection_timeout(
+    httpx_mock: HTTPXMock, set_owm_api_env_variables
+):
+    httpx_mock.add_exception(ConnectTimeout(""), url=OPENWEATHERMAP_REQUEST)
+
+    with pytest.raises(
+        ConnectTimeout,
+        match="Request to OpenWeatherMap API took more than 15.0 seconds",
+    ):
+        await fetch_weather()
+
+
+@pytest.mark.asyncio
+async def test_fetch_weather__unauthorized(
+    httpx_mock: HTTPXMock, set_owm_api_env_variables
+):
+    httpx_mock.add_response(
+        method="GET", url=OPENWEATHERMAP_REQUEST, json={}, status_code=401
+    )
+
+    with pytest.raises(HTTPStatusError):
+        await fetch_weather()

tests/unit/test_owm_api.py

@@ -0,0 +1,28 @@
+import pytest
+from os import environ
+from constants.owm_api import OPENWEATHERMAP_REQUEST_TEMPLATE
+
+from owm_api import render_api_request
+
+
+def test_render_api_request(set_owm_api_env_variables):
+    expected_request = OPENWEATHERMAP_REQUEST_TEMPLATE.format(
+        api_key="fake_app_id", latitude="12.3456789", longitude="98.7654321"
+    )
+
+    assert render_api_request() == expected_request
+
+
+@pytest.mark.parametrize(
+    argnames=("env_variable_name"),
+    argvalues=("OPENWEATHERMAP_API_KEY", "LATITUDE", "LONGITUDE"),
+)
+def test_render_api_request_raises_value_error(
+    env_variable_name, set_owm_api_env_variables
+):
+    del environ[env_variable_name]
+
+    with pytest.raises(
+        ValueError, match=f"Env variable `{env_variable_name}` is missing or empty"
+    ):
+        render_api_request()