feat: automatic news post

Author: imperosol

bot.toml.example

@@ -1,10 +1,12 @@
-[bot]
-token = "<your discord bot token here>"
-log_level = "INFO"
-
-[guild]
-id = <the id of the server here>
-
-[sith_api]
-api_key = "<your sith api token here>"
-url = "https://ae.utbm.fr/"
+[bot]
+token = "<your discord bot token here>"
+log_level = "INFO"
+
+[guild]
+id = <the id of the server here>
+news_channel_id = <the id of the news channel here>
+news_role_id = <the id of the news channel here>
+
+[sith_api]
+api_key = "<your sith api token here>"
+url = "https://ae.utbm.fr/"

pyproject.toml

@@ -9,6 +9,7 @@ dependencies = [
     "discord-py[speed]>=2.6.4",
     "pydantic-settings>=2.11.0",
     "pydantic>=2.12.0",
+    "pytz>=2025.2",
 ]
 
 [dependency-groups]

src/client.py

@@ -1,7 +1,7 @@
 import asyncio
 import logging
 import types
-from datetime import date
+from datetime import date, datetime
 
 from aiohttp import (
     ClientSession,
@@ -44,11 +44,37 @@ class SimpleClubSchema(BaseModel):
     name: str
 
 
+class ClubProfileSchema(SimpleClubSchema):
+    logo: str | None = None
+    url: str
+
+
 class ClubSearchResultSchema(BaseModel):
     count: int
     results: list[SimpleClubSchema]
 
 
+class NewsSchema(BaseModel):
+    id: int
+    title: str
+    summary: str
+    is_published: bool
+    club: ClubProfileSchema
+    url: str
+
+
+class NewsDateSchema(BaseModel):
+    id: int
+    start_date: datetime
+    end_date: datetime
+    news: NewsSchema
+
+
+class NewsDateResultSchema(BaseModel):
+    count: int
+    results: list[NewsDateSchema]
+
+
 class SithClient(ClientSession):
     def __init__(self):
         self.logger = logging.getLogger("sith")
@@ -83,6 +109,21 @@ async def search_clubs(self, search: str) -> list[SimpleClubSchema] | None:
         except ValidationError as e:
             self.logger.error(str(e))
 
+    async def search_news(
+        self, after: datetime | None = None, before: datetime | None = None
+    ) -> list[NewsDateSchema] | None:
+        params = {"is_published": "true"}
+        if after:
+            params["after"] = after.isoformat()
+        if before:
+            params["before"] = before.isoformat()
+        async with self.get("/api/news/date", params=params) as res:
+            content = await res.read()
+        try:
+            return NewsDateResultSchema.model_validate_json(content).results
+        except ValidationError as e:
+            self.logger.error(str(e))
+
 
 async def request_logging_start(
     _session: SithClient,

src/commands/club.py

@@ -12,7 +12,6 @@
 from src.settings import Settings
 
 if TYPE_CHECKING:
-    from src.client import SithClient
     from src.main import AeBot
 
 
@@ -27,8 +26,8 @@ async def transform(
 
 
 class ClubCog(commands.GroupCog, group_name="club"):
-    def __init__(self, client: SithClient, bot: AeBot):
-        self.club_service = ClubService(client, bot)
+    def __init__(self, bot: AeBot):
+        self.club_service = ClubService(bot)
         self.settings = Settings()
 
     async def autocomplete_club(

src/commands/news.py

@@ -0,0 +1,49 @@
+from __future__ import annotations
+
+import datetime
+from typing import TYPE_CHECKING
+
+import pytz
+from discord.ext import commands, tasks
+
+from src.services.news import NewsService
+
+if TYPE_CHECKING:
+    from discord import Role, TextChannel
+
+    from src.main import AeBot
+
+
+class NewsCog(commands.Cog):
+    news_channel: TextChannel
+    news_role: Role
+
+    def __init__(self, bot: AeBot):
+        self.bot = bot
+        self.news_service = NewsService(bot)
+
+    @commands.Cog.listener(name="on_ready")
+    async def on_ready(self):
+        news_channel_id = self.bot.settings.guild.news_channel_id
+        news_role_id = self.bot.settings.guild.news_role_id
+        if not news_channel_id:
+            # If no news channel id is given in the config,
+            # the feature of automatic news post is disabled.
+            return
+        self.news_channel = self.bot.get_channel(news_channel_id)
+        self.news_role = self.bot.watched_guild.get_role(news_role_id)
+        await self.bot.wait_until_ready()
+        self.post_news.start()
+
+    @tasks.loop(
+        time=datetime.time(hour=9, minute=30, tzinfo=pytz.timezone("Europe/Paris"))
+    )
+    async def post_news(self):
+        news_dates = await self.news_service.get_upcoming_news()
+        if not news_dates:
+            return
+        embeds = [self.news_service.embed(n.news) for n in news_dates]
+        content = "## Événements dans les prochains jours"
+        if self.news_role:
+            content += f"\n{self.news_role.mention}"
+        await self.news_channel.send(content, embeds=embeds)

src/main.py

@@ -14,6 +14,7 @@
 from src.commands.admin import AdminCog
 from src.commands.club import ClubCog
 from src.commands.misc import MiscCog
+from src.commands.news import NewsCog
 from src.settings import BASE_DIR, Settings
 
 if TYPE_CHECKING:
@@ -33,7 +34,8 @@ def __init__(self, client: SithClient):
         )
 
     async def setup_hook(self):
-        await self.add_cog(ClubCog(self.client, self))
+        await self.add_cog(ClubCog(self))
+        await self.add_cog(NewsCog(self))
         await self.add_cog(AdminCog(self))
         await self.add_cog(MiscCog())
 

src/services/club.py

@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
     from discord import Guild, Member
 
-    from src.client import ClubSchema, SimpleClubSchema, SithClient
+    from src.client import ClubSchema, SimpleClubSchema
     from src.main import AeBot
 
 
@@ -51,9 +51,9 @@ def save(self):
 class ClubService:
     """Manage features directly related to clubs."""
 
-    def __init__(self, client: SithClient, bot: AeBot):
+    def __init__(self, bot: AeBot):
         self._config = Settings()
-        self._client = client
+        self._client = bot.client
         self._club_cache = {}
         self._bot = bot
 

src/services/news.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from datetime import UTC, datetime, timedelta
+from typing import TYPE_CHECKING
+from urllib.parse import urljoin
+
+from discord import Colour, Embed
+
+if TYPE_CHECKING:
+    from src.client import NewsDateSchema, NewsSchema
+    from src.main import AeBot
+
+
+class NewsService:
+    def __init__(self, bot: AeBot):
+        self._client = bot.client
+        self._bot = bot
+
+    async def get_upcoming_news(self, *, nb_days: int = 3) -> list[NewsDateSchema]:
+        """Fetch news of the next following days from the sith."""
+        today = datetime.now(tz=UTC)
+        three_days_later = (today + timedelta(days=nb_days)).replace(hour=23, minute=59)
+        news = await self._client.search_news(after=today, before=three_days_later)
+        return news or []
+
+    def embed(self, news: NewsSchema) -> Embed:
+        """Return a discord embed with infos about this news date."""
+        embed = Embed(
+            title=news.title,
+            description=news.summary,
+            url=urljoin(str(self._client._base_url), news.club.logo),
+            colour=Colour.blue(),
+        )
+        embed.set_author(
+            name=news.club.name, url=urljoin(str(self._client._base_url), news.club.url)
+        )
+        if news.club.logo:
+            embed = embed.set_thumbnail(
+                url=urljoin(str(self._client._base_url), news.club.logo)
+            )
+        return embed

src/settings.py

@@ -19,6 +19,8 @@ class ApiConfig(BaseModel):
 
 class GuildConfig(BaseModel):
     id: int
+    news_channel_id: int | None = None
+    news_role_id: int | None = None
 
 
 class BotConfig(BaseModel):