Merge pull request #43 from Galarzaa90/feat-fansites

Galarzaa90 · web-flow · commit 1aee357e4932 · 2024-03-31T13:26:22.000-07:00
Add support for fansitese section
diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/intro.rst b/docs/intro.rst
@@ -107,6 +107,8 @@ Supported Sections
 +----------------------------------+--------------------------------------------------------------+---------------------------------------------+
 | Guilds_ (Wars)                   | :meth:`tibiapy.parsers.GuildWarsParser.from_content`         | :meth:`Client.fetch_guild_wars`             |
 +----------------------------------+--------------------------------------------------------------+---------------------------------------------+
+| Fansites_                        | :meth:`tibiapy.parsers.FansitesSectionParser.from_content`   | :meth:`Client.fetch_fansites_section`       |
++----------------------------------+--------------------------------------------------------------+---------------------------------------------+
 | Forums_ (Section)                | :meth:`tibiapy.parsers.ForumSectionParser.from_content`      | :meth:`Client.fetch_forum_world_boards`     |
 |                                  |                                                              | :meth:`Client.fetch_forum_trade_boards`     |
 |                                  |                                                              | :meth:`Client.fetch_forum_community_boards` |
@@ -150,6 +152,7 @@ Supported Sections
 .. _Creature Library: https://www.tibia.com/library/?subtopic=creatures
 .. _Event Schedule: https://www.tibia.com/news/?subtopic=eventcalendar
 .. _Guilds: https://www.tibia.com/community/?subtopic=guilds
+.. _Fansites: https://www.tibia.com/community/?subtopic=fansites
 .. _Forums: https://www.tibia.com/community/?subtopic=forum
 .. _Highscores: https://www.tibia.com/community/?subtopic=highscores
 .. _Houses: https://www.tibia.com/community/?subtopic=houses
diff --git a/server.py b/server.py
@@ -17,7 +17,8 @@
                            PvpTypeFilter,
                            SpellGroup, SpellSorting, SpellType, SpellVocationFilter)
 from tibiapy.models import (Auction, AuctionFilters, BoostableBosses, BossEntry, Character, CharacterBazaar, Creature,
-                            CreatureEntry, CreaturesSection, EventSchedule, ForumBoard, ForumSection, ForumThread,
+                            CreatureEntry, CreaturesSection, EventSchedule, FansitesSection, ForumBoard, ForumSection,
+                            ForumThread,
                             Guild, GuildWars,
                             GuildsSection, Highscores, House, HousesSection, KillStatistics, Leaderboard, News,
                             NewsArchive, Spell,
@@ -297,6 +298,17 @@ async def get_leaderboard(
     )
 
 
+@app.get("/fansites", tags=["Community"])
+async def get_fansites(
+        response: Response,
+) -> TibiaResponse[FansitesSection]:
+    """Show the fansites section."""
+    return handle_response(
+        response,
+        await app.state.client.fetch_fansites_section(),
+    )
+
+
 # endregion
 
 # region Forums
diff --git a/tests/resources/README.md b/tests/resources/README.md
@@ -193,6 +193,11 @@ trying to cover as many scenarios possible, to be used in unit tests.
 - [worldOverviewOnline.txt](worldOverview/worldOverviewOnline.txt) - The world list with all worlds online.
 - [worldOverviewOffline.txt](worldOverview/worldOverviewOffline.txt) - The world list with all worlds offline.
 
+## Fansites
+
+- [fansites.txt](fansites/fansites.txt) - The fansites section.
+
 ## Other
 
 - [tibiacom_about.txt](aboutSection.txt) - The 'About Tibia' section on Tibia.com, used to provide invalid content for tests.
+
diff --git a/tests/resources/fansites/fansites.txt b/tests/resources/fansites/fansites.txt
diff --git a/tests/tests_fansites.py b/tests/tests_fansites.py
@@ -0,0 +1,16 @@
+from tests.tests_tibiapy import TestCommons
+from tibiapy.models.fansite import FansitesSection
+from tibiapy.parsers.fansite import FansitesSectionParser
+
+FILE_FANSITES_SECTION = "fansites/fansites.txt"
+
+
+class TestFansitesSection(TestCommons):
+    def test_fansites_parser_from_content(self):
+        """Testing parsing the fansites section."""
+        content = self.load_resource(FILE_FANSITES_SECTION)
+        fansites_section = FansitesSectionParser.from_content(content)
+
+        self.assertIsInstance(fansites_section, FansitesSection)
+        self.assertIsNotEmpty(fansites_section.promoted_fansites)
+        self.assertIsNotEmpty(fansites_section.supported_fansites)
diff --git a/tibiapy/client.py b/tibiapy/client.py
@@ -19,15 +19,17 @@
 from tibiapy.models import TibiaResponse
 from tibiapy.parsers import (
     AuctionParser, BoostableBossesParser, BoostedCreaturesParser, CMPostArchiveParser, CharacterBazaarParser,
-    CharacterParser, CreatureParser, CreaturesSectionParser, EventScheduleParser, ForumAnnouncementParser,
+    CharacterParser, CreatureParser, CreaturesSectionParser, EventScheduleParser, FansitesSectionParser,
+    ForumAnnouncementParser,
     ForumBoardParser, ForumSectionParser, ForumThreadParser, GuildParser, GuildWarsParser, GuildsSectionParser,
     HighscoresParser, HouseParser, HousesSectionParser, KillStatisticsParser, LeaderboardParser, NewsArchiveParser,
     NewsParser, SpellParser, SpellsSectionParser, WorldOverviewParser, WorldParser,
 )
 from tibiapy.urls import (
     get_auction_url, get_bazaar_url, get_boostable_bosses_url, get_character_url, get_cm_post_archive_url,
     get_community_boards_url, get_creature_url, get_creatures_section_url, get_event_schedule_url,
-    get_forum_announcement_url, get_forum_board_url, get_forum_post_url, get_forum_section_url, get_forum_thread_url,
+    get_fansites_url, get_forum_announcement_url, get_forum_board_url, get_forum_post_url, get_forum_section_url,
+    get_forum_thread_url,
     get_guild_url, get_guild_wars_url, get_highscores_url, get_house_url, get_houses_section_url,
     get_kill_statistics_url, get_leaderboards_url, get_news_archive_url, get_news_url, get_spell_url,
     get_spells_section_url, get_support_boards_url, get_trade_boards_url, get_world_boards_url, get_world_guilds_url,
@@ -37,9 +39,9 @@
 if TYPE_CHECKING:
     from tibiapy.models import (
         AjaxPaginator, Auction, AuctionFilters, BoostableBosses, BoostedCreatures, BossEntry, CMPostArchive, Character,
-        CharacterBazaar, Creature, CreatureEntry, CreaturesSection, EventSchedule, ForumAnnouncement, ForumBoard,
-        ForumSection, ForumThread, Guild, GuildWars, GuildsSection, Highscores, House, HousesSection, KillStatistics,
-        Leaderboard, News, NewsArchive, Spell, SpellsSection, World, WorldOverview,
+        CharacterBazaar, Creature, CreatureEntry, CreaturesSection, EventSchedule, FansitesSection, ForumAnnouncement,
+        ForumBoard, ForumSection, ForumThread, Guild, GuildWars, GuildsSection, Highscores, House, HousesSection,
+        KillStatistics, Leaderboard, News, NewsArchive, Spell, SpellsSection, World, WorldOverview,
     )
 
 __all__ = (
@@ -1035,6 +1037,32 @@ async def fetch_guild_wars(self, name: str, *, test: bool = False) -> TibiaRespo
         response = await self._request("GET", get_guild_wars_url(name), test=test)
         return response.parse(GuildWarsParser.from_content)
 
+    async def fetch_fansites_section(self, *, test: bool = False) -> TibiaResponse[FansitesSection]:
+        """Fetch the fansites section from Tibia.com.
+
+        .. versionadded:: 6.2.0
+
+        Parameters
+        ----------
+        test:
+            Whether to request the test website instead.
+
+        Returns
+        -------
+        TibiaResponse[FansitesSection]
+            A response containing the fansites section.
+
+        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", get_fansites_url(), test=test)
+        return response.parse(FansitesSectionParser.from_content)
+
     # endregion
 
     # region Forums
diff --git a/tibiapy/models/__init__.py b/tibiapy/models/__init__.py
@@ -4,6 +4,7 @@
 from tibiapy.models.character import *
 from tibiapy.models.creature import *
 from tibiapy.models.event import *
+from tibiapy.models.fansite import *
 from tibiapy.models.forum import *
 from tibiapy.models.guild import *
 from tibiapy.models.highscores import *
diff --git a/tibiapy/models/fansite.py b/tibiapy/models/fansite.py
@@ -0,0 +1,60 @@
+from typing import List, Optional
+
+from tibiapy.models import BaseModel
+
+__all__ = (
+    "FansiteContent",
+    "FansiteSocialMedia",
+    "Fansite",
+    "FansitesSection",
+)
+
+
+class FansiteContent(BaseModel):
+    """An icon to represent a category of content."""
+
+    name: str
+    """The name of the content category."""
+    icon_url: str
+    """URL to the icon."""
+
+
+class FansiteSocialMedia(BaseModel):
+    """An icon to represent available social media for the fansite."""
+
+    name: str
+    """The name of the social media site."""
+    icon_url: str
+    """The URL to the icon."""
+
+
+class Fansite(BaseModel):
+    """Represents a fansite in the fansite programme."""
+
+    name: str
+    """The name of the fansite."""
+    url: str
+    """The URL to the fansite."""
+    logo_url: str
+    """URL to the fansite's logo."""
+    contact: str
+    """The name of the contact person."""
+    content: List[FansiteContent]
+    """A list of content categories for the site."""
+    social_media: List[FansiteSocialMedia]
+    """A list of the social media sites the fansite has."""
+    languages: List[str]
+    """A list of the languages the site is available in."""
+    specials: List[str]
+    """A description of features or highligts."""
+    fansite_item_image_url: Optional[str]
+    """The URL to the fansite item's icon, if available."""
+
+
+class FansitesSection(BaseModel):
+    """The fansites section of Tibia.com."""
+
+    promoted_fansites: List[Fansite]
+    """Promoted fansites."""
+    supported_fansites: List[Fansite]
+    """Supported fansites."""
diff --git a/tibiapy/parsers/__init__.py b/tibiapy/parsers/__init__.py
@@ -2,6 +2,7 @@
 from tibiapy.parsers.character import *
 from tibiapy.parsers.creature import *
 from tibiapy.parsers.event import *
+from tibiapy.parsers.fansite import *
 from tibiapy.parsers.forum import *
 from tibiapy.parsers.guild import *
 from tibiapy.parsers.highscores import *
diff --git a/tibiapy/parsers/fansite.py b/tibiapy/parsers/fansite.py
@@ -0,0 +1,90 @@
+from typing import List
+
+import bs4
+
+from tibiapy import InvalidContentError
+from tibiapy.models.fansite import Fansite, FansiteContent, FansiteSocialMedia, FansitesSection
+from tibiapy.utils import get_rows, parse_popup, parse_tibiacom_content
+
+
+class FansitesSectionParser:
+    """Parser for the fansites section."""
+
+    @classmethod
+    def from_content(cls, content: str) -> FansitesSection:
+        """Get the list of available fansites from the HTML of the Tibia.com fansites section.
+
+        Parameters
+        ----------
+        content:
+            The HTML content of the page.
+
+        Returns
+        -------
+            The fansites section.
+
+        Raises
+        ------
+        InvalidContent
+            If content is not the HTML of the fansites section's page.
+        """
+        try:
+            parsed_content = parse_tibiacom_content(content, builder="html5lib")
+            promoted_table = parsed_content.select_one("#promotedfansitesinnertable")
+            supported_table = parsed_content.select_one("#supportedfansitesinnertable")
+            return FansitesSection(
+                promoted_fansites=cls._parse_fansites_table(promoted_table),
+                supported_fansites=cls._parse_fansites_table(supported_table),
+            )
+        except (ValueError, IndexError) as e:
+            raise InvalidContentError("content does not belong to the bazaar at Tibia.com", original=e) from e
+
+    @classmethod
+    def _parse_fansites_table(cls, table: bs4.Tag) -> List[Fansite]:
+        fansites = []
+        for row in get_rows(table)[1:]:
+            cols = row.select("td")
+            site_image = cols[0].select_one("img")
+            site_link = cols[0].select_one("a")
+            name = site_image["alt"]
+            image_url = site_image["src"]
+            site_url = site_link["href"]
+
+            character = cols[1].select_one("a").text
+
+            content = []
+            content_poupups = cols[2].select("span")
+            for content_span in content_poupups:
+                _, popup = parse_popup(content_span["onmouseover"])
+                content.append(FansiteContent(name=popup.text, icon_url=content_span.select_one("img")["src"]))
+
+            social = []
+            social_poupups = cols[3].select("span")
+            for social_span in social_poupups:
+                _, popup = parse_popup(social_span["onmouseover"])
+                social.append(FansiteSocialMedia(name=popup.text, icon_url=social_span.select_one("img")["src"]))
+
+            languages = []
+            languages_poupups = cols[4].select("div.HelperDivIndicator")
+            for language_div in languages_poupups:
+                _, popup = parse_popup(language_div["onmouseover"])
+                languages.append(popup.text)
+
+            specials = [t.text for t in cols[5].select("li")]
+
+            fansite_item_img = cols[6].select_one("img")
+            item_url = fansite_item_img["src"] if fansite_item_img else None
+            fansites.append(
+                Fansite(
+                    name=name,
+                    url=site_url,
+                    logo_url=image_url,
+                    contact=character,
+                    content=content,
+                    social_media=social,
+                    languages=languages,
+                    specials=specials,
+                    fansite_item_image_url=item_url,
+                ),
+            )
+        return fansites
diff --git a/tibiapy/urls.py b/tibiapy/urls.py
@@ -176,6 +176,17 @@ def get_house_url(world: str, house_id: int) -> str:
     return get_tibia_url("community", "houses", page="view", houseid=house_id, world=world)
 
 
+def get_fansites_url() -> str:
+    """Get the Tibia.com URL for the fansites section.
+
+    Returns
+    -------
+    :class:`str`
+        The URL to the fansites section.
+    """
+    return get_tibia_url("community", "fansites")
+
+
 def get_world_overview_url() -> str:
     """Get the URL to world overview section in Tibia.com.
 
