Add more data fields to game details: old price, release date, and reviews (#196)

Author: TheLovinator1

discord_free_game_notifier/steam.py

@@ -37,8 +37,17 @@ class MoreData:
     # ["Tibba Games"]
     publishers: list[str] = field(default_factory=list)
 
+    # "4,99€"
+    old_price: str = ""
 
-def get_more_data(game_id: str) -> MoreData:
+    # "11 Feb, 2022"
+    release_date: str = ""
+
+    # "Mixed"
+    reviews: str = ""
+
+
+def get_more_data(game_id: str) -> MoreData:  # noqa: C901, PLR0912, PLR0915
     """Get more data about the game.
 
     Args:
@@ -52,49 +61,76 @@ def get_more_data(game_id: str) -> MoreData:
         return MoreData()
 
     logger.debug(f"Getting more data for {game_id=}")
-    response: requests.Response = requests.get(
+    appdetails_response: requests.Response = requests.get(
         url=f"https://store.steampowered.com/api/appdetails?appids={game_id}",
         headers={"User-Agent": DEFAULT_USER_AGENT},
         timeout=30,
     )
 
-    if not response.ok:
-        logger.error(f"Error when checking game for Steam:\n{response.status_code} - {response.reason}: {response.text}")
-        return MoreData()
-
-    response_data: dict = response.json()
-    if not response_data:
-        logger.error(f"JSON data is empty for {game_id=}")
-        return MoreData()
-
-    logger.debug(f"{response_data=}")
-
-    game_data: dict = response_data.get(game_id, {}).get("data", {})
-    if game_data:
-        more_data = MoreData()
-        header_image: str | None = game_data.get("header_image")
-        if header_image:
-            logger.debug(f"{header_image=} for {game_id=}")
-            more_data.header_image = header_image
+    more_data = MoreData()
+    if appdetails_response.ok:
+        game_data_from_api: dict = appdetails_response.json()
+        if game_data_from_api and game_data_from_api.get(game_id, {}).get("success", False):
+            logger.debug(f"{game_data_from_api=}")
+
+            game_data: dict = game_data_from_api.get(game_id, {}).get("data", {})
+            if game_data:
+                header_image: str | None = game_data.get("header_image")
+                if header_image:
+                    logger.debug(f"{header_image=} for {game_id=}")
+                    more_data.header_image = header_image
+
+                short_description: str | None = game_data.get("short_description")
+                if short_description:
+                    logger.debug(f"{short_description=} for {game_id=}")
+                    more_data.short_description = short_description
+
+                developers: list[str] | None = game_data.get("developers")
+                if developers:
+                    logger.debug(f"{developers=} for {game_id=}")
+                    more_data.developers = developers
+
+                publishers: list[str] | None = game_data.get("publishers")
+                if publishers:
+                    logger.debug(f"{publishers=} for {game_id=}")
+                    more_data.publishers = publishers
+
+                price_overview: dict | None = game_data.get("price_overview")
+                if price_overview:
+                    more_data.old_price = price_overview.get("initial_formatted", "")
+
+                release_date: dict | None = game_data.get("release_date")
+                if release_date:
+                    more_data.release_date = release_date.get("date", "")
 
-        short_description: str | None = game_data.get("short_description")
-        if short_description:
-            logger.debug(f"{short_description=} for {game_id=}")
-            more_data.short_description = short_description
+        else:
+            logger.error(f"Failed to get more data for {game_id=}: {game_data_from_api=}")
+    else:
+        logger.error(f"Failed to get more data for {game_id=}: {appdetails_response.status_code} - {appdetails_response.reason}")
 
-        developers: list[str] | None = game_data.get("developers")
-        if developers:
-            logger.debug(f"{developers=} for {game_id=}")
-            more_data.developers = developers
+    logger.debug(f"Getting reviews for {game_id=}")
 
-        publishers: list[str] | None = game_data.get("publishers")
-        if publishers:
-            logger.debug(f"{publishers=} for {game_id=}")
-            more_data.publishers = publishers
+    # {"success":1,"query_summary":{"num_reviews":0,"review_score":5,"review_score_desc":"Mixed","total_positive":125,"total_negative":74,"total_reviews":199},"reviews":[],"cursor":"*"} # noqa: E501
+    reviews_response: requests.Response = requests.get(
+        url=f"https://store.steampowered.com/appreviews/{game_id}?json=1&language=all&num_per_page=0&purchase_type=all",
+        headers={"User-Agent": DEFAULT_USER_AGENT},
+        timeout=30,
+    )
 
-        return more_data
+    if reviews_response.ok:
+        game_data: dict = reviews_response.json()
+        if game_data and game_data.get("success", False):
+            logger.debug(f"{game_data=}")
+            reviews: str | None = game_data.get("query_summary", {}).get("review_score_desc")
+            if reviews:
+                logger.debug(f"{reviews=} for {game_id=}")
+                more_data.reviews = reviews
+        else:
+            logger.error(f"Failed to get reviews for {game_id=}: {game_data=}")
+    else:
+        logger.error(f"Failed to get reviews for {game_id=}: {reviews_response.status_code} - {reviews_response.reason}")
 
-    return MoreData()
+    return more_data
 
 
 def get_free_steam_games() -> Generator[DiscordEmbed, Any, None]:
@@ -108,7 +144,12 @@ def get_free_steam_games() -> Generator[DiscordEmbed, Any, None]:
     games: list[Node] = parser.css("a.search_result_row")
 
     for game in games:
-        game_name: str = game.css_first("span.title").text(strip=True)
+        title_element = game.css_first("span.title")
+        if title_element is None:
+            logger.warning("Could not find title for game, skipping")
+            continue
+
+        game_name: str = title_element.text(strip=True)
 
         logger.info(f"Checking game: {game_name}")
         previous_games_file: Path = Path(settings.app_dir) / "steam.txt"
@@ -130,6 +171,15 @@ def get_free_steam_games() -> Generator[DiscordEmbed, Any, None]:
         if more_data.short_description:
             embed.description = html.unescape(more_data.short_description)
 
+        if more_data.old_price:
+            embed.add_embed_field(name="Old Price", value=more_data.old_price)
+
+        if more_data.release_date:
+            embed.add_embed_field(name="Release Date", value=more_data.release_date)
+
+        if more_data.reviews:
+            embed.add_embed_field(name="Reviews", value=more_data.reviews)
+
         set_game_footer(more_data, embed)
 
         logger.debug(f"More data for {game_name}: {more_data}")

tests/test_steam.py

@@ -42,6 +42,7 @@ def __init__(self, text: str, status_code: int) -> None:
         self.text: str = text
         self.status_code: int = status_code
         self.json_data: dict[str, dict[str, Any]] = {}
+        self.reason: str = {200: "OK", 404: "Not Found"}.get(status_code, "Unknown")
 
     @property
     def ok(self) -> bool:
@@ -64,14 +65,14 @@ def fake_get(
     """A fake requests.get function that returns local HTML for the Steam search page and fake JSON data for API calls.
 
     Args:
-        url (str): The URL to fetch.
+        url (str): The URL to check.
         headers (dict[str, str] | None): The headers to use for the request.
         timeout (int | None): The timeout for the request.
-        empty_mode (bool): Flag to determine which HTML file to return.
-        **kwargs (dict[str, Any]): Additional keyword arguments.
+        empty_mode (bool): Whether to return an empty response or not.
+        kwargs (dict[str, Any]): Additional keyword arguments.
 
     Returns:
-        FakeResponse: A fake Response object with the appropriate data for the given URL.
+        FakeResponse: A fake response object with the appropriate data.
     """
     if url.startswith(STEAM_URL.split("?")[0]):
         # steam.html has 2 games, steam_empty.html has 0 games
@@ -86,8 +87,9 @@ def fake_get(
         appids: list[str] = query.get("appids", ["753"])
         appid: str = appids[0]
 
-        data: dict[str, dict[str, dict[str, str | list[str]]]] = {
+        data: dict[str, dict[str, Any]] = {
             appid: {
+                "success": True,
                 "data": {
                     "header_image": "http://example.com/header.jpg",
                     "short_description": "A free game description",
@@ -115,7 +117,7 @@ def patch_requests_get_with_mode(monkeypatch: pytest.MonkeyPatch) -> Callable[..
     """
 
     def _patch(*, empty_mode: bool = False) -> None:
-        monkeypatch.setattr(requests, "get", lambda url, **kwargs: fake_get(url, empty_mode=empty_mode, **kwargs))  # pyright: ignore[ reportCallIssue ]
+        monkeypatch.setattr(requests, "get", lambda url, **kwargs: fake_get(url, empty_mode=empty_mode, **kwargs))  # pyright: ignore[reportCallIssue]
 
     return _patch
 
@@ -166,7 +168,7 @@ def test_get_free_steam_games(tmp_path: Path, patch_requests_get_with_mode: Call
         image: dict[str, str | int | None] | None = first_embed.image
         assert image, "Embed image is missing"
         assert "url" in image, "Embed image URL is missing"
-        assert str(image.get("url", "")).startswith("http://example.com/header.jpg"), "Embed image URL not as expected"
+        assert str(image.get("url", "")).startswith("http://example.com/header.jpg"), f"Embed image URL is incorrect: {image.get('url')}"
 
         # If a description was set (via the short_description), verify it contains the expected text.
         if first_embed.description: