Fixed calendar grid test with game releases, added cached API call and changed requests to httpx

Author: Liad Noam

app/config.py.example

@@ -40,6 +40,7 @@ WEBSITE_LANGUAGE = "en"
 # Get a free API KEY for Astronomy feature @ www.weatherapi.com/signup.aspx
 ASTRONOMY_API_KEY = os.getenv('ASTRONOMY_API_KEY')
 WEATHER_API_KEY = os.getenv('WEATHER_API_KEY')
+RAWG_API_KEY = os.getenv("RAWG_API_KEY")
 
 # https://developers.google.com/calendar/quickstart/python -
 # follow instracions and make an env variable with the path to the file.

app/internal/game_releases_utils.py

@@ -2,11 +2,14 @@
 
 from collections import defaultdict
 from datetime import datetime
-from typing import TYPE_CHECKING, DefaultDict, Dict, List
+from functools import lru_cache
+from typing import TYPE_CHECKING, Any, DefaultDict, Dict, List
 
-import requests
+import httpx
+from loguru import logger
 from sqlalchemy.orm import Session
 
+from app import config
 from app.database.models import UserSettings
 
 if TYPE_CHECKING:
@@ -17,16 +20,14 @@ def is_user_signed_up_for_game_releases(
     session: Session,
     current_user_id: int,
 ) -> bool:
-    is_signed_up = (
+    is_signed_up = bool(
         session.query(UserSettings)
         .filter(UserSettings.user_id == current_user_id)
         .filter(UserSettings.video_game_releases.is_(True))
-        .first()
+        .first(),
     )
 
-    if is_signed_up:
-        return True
-    return False
+    return is_signed_up
 
 
 def add_game_events_to_weeks(
@@ -41,11 +42,20 @@ def add_game_events_to_weeks(
     last_day: Day = last_week.days[-1]
     first_day_str = datetime.strptime(first_day.set_id(), "%d-%B-%Y")
     last_day_str = datetime.strptime(last_day.set_id(), "%d-%B-%Y")
-    games_by_dates = get_games_data_separated_by_days(
+
+    output = get_games_data_by_dates_from_api(
         start_date=first_day_str.strftime("%Y-%m-%d"),
         end_date=last_day_str.strftime("%Y-%m-%d"),
     )
-    formatted_games = get_formatted_games_in_days(games_by_dates)
+    if not output["success"]:
+        logger.exception("Unsuccessful RAWG API call")
+        return weeks
+    games_by_dates = output["results"]
+
+    unformatted_games_by_dates = get_games_data_separated_by_dates(
+        games_by_dates,
+    )
+    formatted_games = get_formatted_games_in_days(unformatted_games_by_dates)
 
     return insert_formatted_games_to_weeks(weeks, formatted_games)
 
@@ -67,18 +77,47 @@ def insert_formatted_games_to_weeks(
     return weeks
 
 
-def get_games_data_separated_by_days(
-    start_date: datetime,
-    end_date: datetime,
-) -> DefaultDict[List[Dict]]:
+@lru_cache(maxsize=128)
+def get_games_data_by_dates_from_api(
+    start_date: str,
+    end_date: str,
+) -> Dict[str, Any]:
     API = "https://api.rawg.io/api/games"
-
-    current_day_games = requests.get(
-        f"{API}?dates={start_date},{end_date}",
-    )
-    current_day_games = current_day_games.json()["results"]
+    NO_API_RESPONSE = "The RAWG server did not response"
+    input_query_string = {
+        "dates": f"{start_date},{end_date}",
+        "key": config.RAWG_API_KEY,
+    }
+
+    output: Dict[str, Any] = {}
+    try:
+        response = httpx.get(
+            API,
+            params=input_query_string,
+        )
+    except httpx.HTTPError:
+        output["success"] = False
+        output["error"] = NO_API_RESPONSE
+        return output
+
+    if response.status_code != httpx.codes.OK:
+        output["success"] = False
+        output["error"] = NO_API_RESPONSE
+        return output
+
+    output["success"] = True
+    try:
+        output.update(response.json())
+        return output
+    except KeyError:
+        output["success"] = False
+        output["error"] = response.json()["error"]["message"]
+        return output
+
+
+def get_games_data_separated_by_dates(api_data):
     games_data = defaultdict(list)
-    for result in current_day_games:
+    for result in api_data:
         current = {
             "name": result["name"],
             "platforms": [],
@@ -98,8 +137,9 @@ def get_formatted_games_in_days(
     formatted_games = defaultdict(list)
 
     for date, game_data in separated_games_dict.items():
-        formatted_game_str = format_single_game(game_data, with_platforms)
-        formatted_games[date].append(formatted_game_str)
+        for game in game_data:
+            formatted_game_str = format_single_game(game, with_platforms)
+            formatted_games[date].append(formatted_game_str)
     return formatted_games
 
 
@@ -110,6 +150,7 @@ def format_single_game(raw_game, with_platforms=False):
         formatted_game_str += "-Platforms-<br>"
         for platform in raw_game["platforms"]:
             formatted_game_str += f"{platform},"
+    return formatted_game_str
 
 
 def translate_ymd_date_to_dby(ymd_str: str) -> str:

app/routers/calendar_grid.py

@@ -194,7 +194,7 @@ def create_weeks(
     num_days: int = len(ndays)
     _weeks = [Week(ndays[i : i + length]) for i in range(0, num_days, length)]
 
-    return add_game_events_to_weeks(_weeks, is_active=False)
+    return add_game_events_to_weeks(_weeks, is_active=True)
 
 
 def get_month_block(day: Day, n: int = MONTH_BLOCK) -> List[Week]:

tests/test_calendar_grid.py

@@ -80,15 +80,19 @@ def test_create_weeks():
 
     @staticmethod
     def test_get_month_block(Calendar):
+        dates_iterator = Calendar.itermonthdates(1988, 5)
         month_weeks = cg.create_weeks(
-            Calendar.itermonthdates(1988, 5),
+            (cg.Day(date) for date in dates_iterator),
             WEEK_DAYS,
         )
         get_block = cg.get_month_block(cg.Day(DATE), n=len(month_weeks))
 
         for i in range(len(month_weeks)):
             for j in range(cg.Week.WEEK_DAYS):
-                assert get_block[i].days[j].date == month_weeks[i].days[j]
+                assert (
+                    get_block[i].days[j].set_id()
+                    == month_weeks[i].days[j].set_id()
+                )
 
     @staticmethod
     def test_get_user_local_time():

tests/test_game_releases.py

@@ -1,5 +1,9 @@
+from collections import defaultdict
+
 from app.internal.game_releases_utils import (
-    get_games_data_separated_by_days,
+    get_formatted_games_in_days,
+    get_games_data_by_dates_from_api,
+    get_games_data_separated_by_dates,
     translate_dby_date_to_ymd,
     translate_ymd_date_to_dby,
 )
@@ -68,7 +72,7 @@ def test_get_game_releases_month(client):
             game_release_router.url_path_for("get_game_releases_month"),
         )
         assert response.ok
-        assert b"Prince" in response.content
+        assert b"name" in response.content
 
     @staticmethod
     def test_get_game_releases(client):
@@ -86,9 +90,24 @@ def test_get_game_releases(client):
     def test_get_games_data_separated_by_days():
         day_1 = "2020-12-10"
         day_2 = "2020-12-20"
-        formatted = get_games_data_separated_by_days(day_1, day_2)
-        assert isinstance(formatted, dict)
-        assert "platforms" in formatted["10-December-2020"][0].keys()
+        output = get_games_data_by_dates_from_api(
+            start_date=day_1,
+            end_date=day_2,
+        )
+        games_by_dates = output["results"]
+        unformatted_games_by_dates = get_games_data_separated_by_dates(
+            games_by_dates,
+        )
+        formatted_games = get_formatted_games_in_days(
+            unformatted_games_by_dates,
+        )
+
+        assert isinstance(unformatted_games_by_dates, defaultdict)
+        assert isinstance(formatted_games, defaultdict)
+        assert (
+            "platforms"
+            in unformatted_games_by_dates["10-December-2020"][0].keys()
+        )
 
     @staticmethod
     def test_ymd_to_dby():
@@ -99,3 +118,15 @@ def test_ymd_to_dby():
     def test_dby_to_ymd():
         dby_date = "12-December-2020"
         assert translate_dby_date_to_ymd(dby_date) == "2020-12-12"
+
+    @staticmethod
+    def test_get_game_releases_async(client):
+        day_1 = "2020-12-10"
+        day_2 = "2020-12-20"
+        dates = {"from-date": day_1, "to-date": day_2}
+        response = client.post(
+            game_release_router.url_path_for("fetch_released_games"),
+            data=dates,
+        )
+        assert response.ok
+        assert b"Xbox" in response.content