Added boostable bosses section

Galarzaa90 · Galarzaa90 · commit 8bd84ab6629d · 2022-07-22T13:57:31.000-07:00
diff --git a/serve.py b/serve.py
@@ -108,6 +108,24 @@ async def get_boosted_creature(request: web.Request):
     return json_response(response)
 
 
+@routes.get('/bosses/boosted')
+async def get_boosted_bosses(request: web.Request):
+    response = await app["tibiapy"].fetch_boosted_boss()
+    return json_response(response)
+
+
+@routes.get('/boosted')
+async def get_boosted_creatures(request: web.Request):
+    response = await app["tibiapy"].fetch_boosted_creature_and_boss()
+    return json_response(response)
+
+
+@routes.get('/bosses')
+async def get_library_bosses(request: web.Request):
+    response = await app["tibiapy"].fetch_library_bosses()
+    return json_response(response)
+
+
 @routes.get('/creatures/{name}')
 async def get_library_creature(request: web.Request):
     name = request.match_info.get('name')
diff --git a/tibiapy/client.py b/tibiapy/client.py
@@ -12,7 +12,7 @@
 import tibiapy
 from tibiapy import Auction, AuctionFilters, CharacterBazaar, Leaderboard, Spell, SpellsSection, abc
 from tibiapy.character import Character
-from tibiapy.creature import Creature, CreatureEntry, CreaturesSection
+from tibiapy.creature import BoostableBosses, BoostedCreatures, Creature, CreatureEntry, CreaturesSection
 from tibiapy.enums import BattlEyeHighscoresFilter, Category, HouseType, NewsCategory, \
     NewsType, VocationFilter
 from tibiapy.errors import Forbidden, NetworkError, SiteMaintenanceError
@@ -754,6 +754,96 @@ async def fetch_forum_announcement(self, announcement_id, *, test=False):
 
     # endregion
 
+    async def fetch_boosted_creature_and_boss(self, *, test=False):
+        """Fetch today's boosted creature and boss.
+
+        .. versionadded:: 5.3.0
+
+        Parameters
+        ----------
+        test: :class:`bool`
+            Whether to request the test website instead.
+
+        Returns
+        -------
+        :class:`TibiaResponse` of :class:`BoostedCreatures`
+            The boosted creature and boss of the day.
+
+        Raises
+        ------
+        Forbidden
+            If a 403 Forbidden error was returned.
+            This usually means that Tibia.com is rate-limiting the client because of too many requests.
+        NetworkError
+            If there's any connection errors during the request.
+        """
+        response = await self._request("GET", NewsArchive.get_url(), test=test)
+        start_time = time.perf_counter()
+        boosted_creatures = BoostedCreatures.from_header(response.content)
+        parsing_time = time.perf_counter() - start_time
+        return TibiaResponse(response, boosted_creatures, parsing_time)
+
+    # Region Bosses
+    async def fetch_boosted_boss(self, *, test=False):
+        """Fetch today's boosted boss.
+
+        .. versionadded:: 5.3.0
+
+        Parameters
+        ----------
+        test: :class:`bool`
+            Whether to request the test website instead.
+
+        Returns
+        -------
+        :class:`TibiaResponse` of :class:`BossEntry`
+            The boosted boss of the day.
+
+        Raises
+        ------
+        Forbidden
+            If a 403 Forbidden error was returned.
+            This usually means that Tibia.com is rate-limiting the client because of too many requests.
+        NetworkError
+            If there's any connection errors during the request.
+        """
+        response = await self._request("GET", NewsArchive.get_url(), test=test)
+        start_time = time.perf_counter()
+        boosted_creature = BoostableBosses.boosted_boss_from_header(response.content)
+        parsing_time = time.perf_counter() - start_time
+        return TibiaResponse(response, boosted_creature, parsing_time)
+
+    async def fetch_library_bosses(self, *, test=False):
+        """Fetch the bosses from the library section.
+
+        .. versionadded:: 4.0.0
+
+        Parameters
+        ----------
+        test: :class:`bool`
+            Whether to request the test website instead.
+
+        Returns
+        -------
+        :class:`TibiaResponse` of :class:`BoostableBosses`
+            The creature's section in Tibia.com
+
+        Raises
+        ------
+        Forbidden
+            If a 403 Forbidden error was returned.
+            This usually means that Tibia.com is rate-limiting the client because of too many requests.
+        NetworkError
+            If there's any connection errors during the request.
+        """
+        response = await self._request("GET", BoostableBosses.get_url(), test=test)
+        start_time = time.perf_counter()
+        boosted_creature = BoostableBosses.from_content(response.content)
+        parsing_time = time.perf_counter() - start_time
+        return TibiaResponse(response, boosted_creature, parsing_time)
+
+    # endregion
+
     # region Creatures
     async def fetch_boosted_creature(self, *, test=False):
         """Fetch today's boosted creature.
@@ -1133,9 +1223,9 @@ async def fetch_world_houses(self, world, town, house_type=HouseType.HOUSE, stat
         house_type: :class:`HouseType`
             The type of building. House by default.
         status: :class:`HouseStatus`, optional
-            The house status to filter results. By default no filters will be applied.
+            The house status to filter results. By default, no filters will be applied.
         order: :class:`HouseOrder`, optional
-            The ordering to use for the results. By default they are sorted by name.
+            The ordering to use for the results. By default, they are sorted by name.
         test: :class:`bool`
             Whether to request the test website instead.
 
diff --git a/tibiapy/creature.py b/tibiapy/creature.py
@@ -1,4 +1,5 @@
 """Models related to the creatures section in the library."""
+import os
 import re
 import urllib.parse
 from typing import List, Optional
@@ -9,14 +10,18 @@
 from tibiapy.errors import InvalidContent
 
 __all__ = (
+    "BoostedCreatures",
+    "BoostableBosses",
+    "BossEntry",
     "CreatureEntry",
     "CreaturesSection",
     "Creature",
 )
 
 from tibiapy.utils import parse_tibiacom_content, get_tibia_url
 
-BOOSTED_ALT = "Today's boosted creature: "
+BOOSTED_ALT = re.compile("Today's boosted \w+: ")
+
 
 HP_PATTERN = re.compile(r"have (\d+) hitpoints")
 EXP_PATTERN = re.compile(r"yield (\d+) experience")
@@ -27,6 +32,193 @@
 MANA_COST = re.compile(r"takes (\d+) mana")
 
 
+class BoostedCreatures(abc.Serializable):
+    """Contains both boosted creature and boosted boss.
+
+    Attributes
+    ----------
+    creature: :class:`CreatureEntry`
+        The boosted creature of the day.
+    boss: :class:`BossEntry`
+        The boosted boss of the day.
+    """
+
+    __slots__ = (
+        "creature",
+        "boss",
+    )
+
+    def __init__(self, creature, boss):
+        self.creature: CreatureEntry = creature
+        self.boss: BossEntry = boss
+
+    @classmethod
+    def _parse_boosted_platform(cls, parsed_content: bs4.BeautifulSoup, tag_id: str):
+        img = parsed_content.find("img", attrs={"id": tag_id})
+        name = BOOSTED_ALT.sub("", img["title"]).strip()
+        image_url = img["src"]
+        identifier = image_url.split("/")[-1].replace(".gif", "")
+        return name, identifier
+
+    @classmethod
+    def from_header(cls, content: str):
+        """Parses both boosted creature and boss from the content of any section in Tibia.com
+
+        Parameters
+        ----------
+        content: :class:`str`
+            The HTML content of the page.
+
+        Returns
+        -------
+        :class:`BoostedCreatures`
+            The boosted creature an boss.
+
+        Raises
+        ------
+        InvalidContent
+            If content is not the HTML of a Tibia.com page.
+        """
+        try:
+            parsed_content = bs4.BeautifulSoup(content.replace('ISO-8859-1', 'utf-8'), "lxml",
+                                               parse_only=bs4.SoupStrainer("div", attrs={"id": "RightArtwork"}))
+            creature_name, creature_identifier = cls._parse_boosted_platform(parsed_content, "Monster")
+            boss_name, boss_identifier = cls._parse_boosted_platform(parsed_content, "Boss")
+            return cls(CreatureEntry(creature_name, creature_identifier), BossEntry(boss_name, boss_identifier))
+        except (TypeError, NameError, KeyError) as e:
+            raise InvalidContent("content is not from Tibia.com", e)
+
+
+class BoostableBosses(abc.Serializable):
+    """Represents the boostable bosses section in the Tibia.com library
+
+    Attributes
+    ----------
+    boosted_boss: :class:`BossEntry`
+        The current boosted boss.
+    bosses: list of :class:`BossEntry`
+        The list of boostable bosses.
+    """
+
+    __slots__ = (
+        "boosted_boss",
+        "bosses",
+    )
+
+    def __init__(self, boosted_boss, bosses):
+        self.boosted_boss: BossEntry = boosted_boss
+        self.bosses: List[BossEntry] = bosses
+
+    @classmethod
+    def get_url(cls):
+        """Get the URL to the Tibia.com boostable bosses.
+
+        Returns
+        -------
+        :class:`str`:
+            The URL to the Tibia.com library section.
+        """
+        return get_tibia_url("library", "boostablebosses")
+
+    @classmethod
+    def from_content(cls, content):
+        """Create an instance of the class from the html content of the boostable bosses library's page.
+
+        Parameters
+        ----------
+        content: :class:`str`
+            The HTML content of the page.
+
+        Returns
+        -------
+        :class:`BoostableBosses`
+            The Boostable Bosses section.
+
+        Raises
+        ------
+        InvalidContent
+            If content is not the HTML of a creature library's page.
+        """
+        try:
+            parsed_content = parse_tibiacom_content(content)
+            boosted_creature_table = parsed_content.find("div", {"class": "TableContainer"})
+            boosted_creature_text = boosted_creature_table.find("div", {"class": "Text"})
+            if not boosted_creature_text or "Boosted" not in boosted_creature_text.text:
+                return None
+            boosted_boss_tag = boosted_creature_table.find("b")
+            boosted_boss_image = boosted_creature_table.find("img")
+            image_url = urllib.parse.urlparse(boosted_boss_image["src"])
+            boosted_boss = BossEntry(boosted_boss_tag.text, os.path.basename(image_url.path).replace(".gif", ""))
+
+            list_table = parsed_content.find("div", style=lambda v: v and 'display: table' in v)
+            entries_container = list_table.find_all("div", style=lambda v: v and 'float: left' in v)
+            entries = []
+            for entry_container in entries_container:
+                name = entry_container.text.strip()
+                image = entry_container.find("img")
+                image_url = urllib.parse.urlparse(image["src"])
+                identifier = os.path.basename(image_url.path).replace(".gif", "")
+                entries.append(BossEntry(name, identifier))
+            return cls(boosted_boss, entries)
+        except (AttributeError, ValueError) as e:
+            raise InvalidContent("content is not the boosted boss's library", e)
+
+
+    @classmethod
+    def boosted_boss_from_header(cls, content):
+        """Get the boosted boss from any Tibia.com page.
+
+        Parameters
+        ----------
+        content: :class:`str`
+            The HTML content of a Tibia.com page.
+
+        Returns
+        -------
+        :class:`BossEntry`
+            The boosted boss of the day.
+
+        Raises
+        ------
+        InvalidContent
+            If content is not the HTML of a Tibia.com's page.
+        """
+        return BoostedCreatures.from_header(content).boss
+
+
+class BossEntry(abc.Serializable):
+    """Represents a boss in the boostable bosses section in the Tibia.com library.
+
+    Attributes
+    ----------
+    name: :class:`str`
+        The name of the boss..
+    identifier: :class:`str`
+        The internal name of the boss. Used for images.
+    """
+
+    __slots__ = (
+        "name",
+        "identifier",
+    )
+
+    _serializable_properties = (
+        "image_url",
+    )
+
+    def __init__(self, name, identifier=None):
+        self.name: str = name
+        self.identifier: str = identifier
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} name={self.name!r} identifier={self.identifier!r}>"
+
+    @property
+    def image_url(self):
+        """:class:`str`: The URL to this boss's image."""
+        return f"https://static.tibia.com/images/library/{self.identifier}.gif"
+
+
 class CreaturesSection(abc.Serializable):
     """Represents the creature's section in the Tibia.com library.
 
@@ -77,16 +269,7 @@ def boosted_creature_from_header(cls, content):
         InvalidContent
             If content is not the HTML of a Tibia.com's page.
         """
-        try:
-            parsed_content = bs4.BeautifulSoup(content.replace('ISO-8859-1', 'utf-8'), "lxml",
-                                               parse_only=bs4.SoupStrainer("div", attrs={"id": "RightArtwork"}))
-            img = parsed_content.find("img", attrs={"id": "Monster"})
-            name = img["title"].replace(BOOSTED_ALT, "").strip()
-            image_url = img["src"]
-            identifier = image_url.split("/")[-1].replace(".gif", "")
-            return CreatureEntry(name, identifier)
-        except TypeError as e:
-            raise InvalidContent("content is not from Tibia.com", e)
+        return BoostedCreatures.from_header(content).creature
 
     @classmethod
     def from_content(cls, content):
@@ -99,8 +282,8 @@ def from_content(cls, content):
 
         Returns
         -------
-        :class:`Character`
-            The character contained in the page.
+        :class:`CreaturesSection`
+            The creatures section from Tibia.com.
 
         Raises
         ------
