add client method for fansites and route to server

Author: Galarzaa90

docs/api.rst

@@ -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

server.py

@@ -1,5 +1,5 @@
 from tests.tests_tibiapy import TestCommons
-from tibiapy.models.fansites import FansitesSection
+from tibiapy.models.fansite import FansitesSection
 from tibiapy.parsers.fansite import FansitesSectionParser
 
 FILE_FANSITES_SECTION = "fansites/fansites.txt"

tests/tests_fansites.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

tibiapy/client.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 *

tibiapy/models/__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 *

tibiapy/models/fansites.py tibiapy/models/fansite.pytibiapy/models/fansites.py renamed to tibiapy/models/fansite.py

@@ -3,7 +3,7 @@
 import bs4
 
 from tibiapy import InvalidContentError
-from tibiapy.models.fansites import Fansite, FansiteContent, FansiteSocialMedia, FansitesSection
+from tibiapy.models.fansite import Fansite, FansiteContent, FansiteSocialMedia, FansitesSection
 from tibiapy.utils import get_rows, parse_popup, parse_tibiacom_content
 
 

tibiapy/parsers/__init__.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.