Add msl methods

cogs/__init__.py

@@ -37,6 +37,7 @@
 from .remind_me import ClearRemindersBacklogTaskCog, RemindMeCommandCog
 from .send_get_roles_reminders import SendGetRolesRemindersTaskCog
 from .send_introduction_reminders import SendIntroductionRemindersTaskCog
+from .society_events import SocietyEventsSlashCommandsCog
 from .source import SourceCommandCog
 from .startup import StartupCog
 from .stats import StatsCommandsCog
@@ -77,6 +78,7 @@
     "RemindMeCommandCog",
     "SendGetRolesRemindersTaskCog",
     "SendIntroductionRemindersTaskCog",
+    "SocietyEventsSlashCommandsCog",
     "SourceCommandCog",
     "StartupCog",
     "StatsCommandsCog",
@@ -119,6 +121,7 @@ def setup(bot: "TeXBot") -> None:
         SendGetRolesRemindersTaskCog,
         SendIntroductionRemindersTaskCog,
         SourceCommandCog,
+        SocietyEventsSlashCommandsCog,
         StartupCog,
         StatsCommandsCog,
         StrikeCommandCog,

cogs/make_member.py

@@ -4,10 +4,7 @@
 import re
 from typing import TYPE_CHECKING
 
-import aiohttp
-import bs4
 import discord
-from bs4 import BeautifulSoup
 from django.core.exceptions import ValidationError
 
 from config import settings
@@ -22,6 +19,8 @@
 
     from utils import TeXBotApplicationContext
 
+from utils.msl import get_membership_count, is_student_id_member
+
 __all__: "Sequence[str]" = ("MakeMemberCommandCog", "MemberCountCommandCog")
 
 logger: "Final[Logger]" = logging.getLogger("TeX-Bot")
@@ -157,92 +156,32 @@ async def make_member(self, ctx: "TeXBotApplicationContext", group_member_id: st
                 )
                 return
 
-            guild_member_ids: set[str] = set()
-
-            http_session: aiohttp.ClientSession = aiohttp.ClientSession(
-                headers=REQUEST_HEADERS,
-                cookies=REQUEST_COOKIES,
-            )
-            async with http_session, http_session.get(GROUPED_MEMBERS_URL) as http_response:
-                response_html: str = await http_response.text()
-
-            MEMBER_HTML_TABLE_IDS: Final[frozenset[str]] = frozenset(
-                {
-                    "ctl00_Main_rptGroups_ctl05_gvMemberships",
-                    "ctl00_Main_rptGroups_ctl03_gvMemberships",
-                    "ctl00_ctl00_Main_AdminPageContent_rptGroups_ctl03_gvMemberships",
-                    "ctl00_ctl00_Main_AdminPageContent_rptGroups_ctl05_gvMemberships",
-                },
+        if not await is_student_id_member(student_id=group_member_id):
+            await self.command_send_error(
+                ctx=ctx,
+                message=(
+                    f"You must be a member of {self.bot.group_full_name} "
+                    "to use this command.\n"
+                    f"The provided {_GROUP_MEMBER_ID_ARGUMENT_NAME} must match "
+                    f"the {self.bot.group_member_id_type} ID "
+                    f"that you purchased your {self.bot.group_short_name} membership with."
+                ),
             )
-            table_id: str
-            for table_id in MEMBER_HTML_TABLE_IDS:
-                parsed_html: bs4.Tag | bs4.NavigableString | None = BeautifulSoup(
-                    response_html,
-                    "html.parser",
-                ).find(
-                    "table",
-                    {"id": table_id},
-                )
-
-                if parsed_html is None or isinstance(parsed_html, bs4.NavigableString):
-                    continue
 
-                guild_member_ids.update(
-                    row.contents[2].text
-                    for row in parsed_html.find_all(
-                        "tr",
-                        {"class": ["msl_row", "msl_altrow"]},
-                    )
+        try:
+            await GroupMadeMember.objects.acreate(group_member_id=group_member_id)  # type: ignore[misc]
+        except ValidationError as create_group_made_member_error:
+            error_is_already_exists: bool = (
+                "hashed_group_member_id" in create_group_made_member_error.message_dict
+                and any(
+                    "already exists" in error
+                    for error in create_group_made_member_error.message_dict[
+                        "hashed_group_member_id"
+                    ]
                 )
-
-            guild_member_ids.discard("")
-            guild_member_ids.discard("\n")
-            guild_member_ids.discard(" ")
-
-            if not guild_member_ids:
-                await self.command_send_error(
-                    ctx,
-                    error_code="E1041",
-                    logging_message=OSError(
-                        "The guild member IDs could not be retrieved from "
-                        "the MEMBERS_LIST_URL.",
-                    ),
-                )
-                return
-
-            if group_member_id not in guild_member_ids:
-                await self.command_send_error(
-                    ctx,
-                    message=(
-                        f"You must be a member of {self.bot.group_full_name} "
-                        "to use this command.\n"
-                        f"The provided {_GROUP_MEMBER_ID_ARGUMENT_NAME} must match "
-                        f"the {self.bot.group_member_id_type} ID "
-                        f"that you purchased your {self.bot.group_short_name} membership with."
-                    ),
-                )
-                return
-
-            # NOTE: The "Member" role must be added to the user **before** the "Guest" role to ensure that the welcome message does not include the suggestion to purchase membership
-            await interaction_member.add_roles(
-                member_role,
-                reason=f'{ctx.user} used TeX Bot slash-command: "/makemember"',
             )
-
-            try:
-                await GroupMadeMember.objects.acreate(group_member_id=group_member_id)  # type: ignore[misc]
-            except ValidationError as create_group_made_member_error:
-                error_is_already_exists: bool = (
-                    "hashed_group_member_id" in create_group_made_member_error.message_dict
-                    and any(
-                        "already exists" in error
-                        for error in create_group_made_member_error.message_dict[
-                            "hashed_group_member_id"
-                        ]
-                    )
-                )
-                if not error_is_already_exists:
-                    raise
+            if not error_is_already_exists:
+                raise create_group_made_member_error from create_group_made_member_error
 
             await ctx.followup.send(content="Successfully made you a member!", ephemeral=True)
 
@@ -285,58 +224,7 @@ async def member_count(self, ctx: "TeXBotApplicationContext") -> None:  # type:
         await ctx.defer(ephemeral=False)
 
         async with ctx.typing():
-            http_session: aiohttp.ClientSession = aiohttp.ClientSession(
-                headers=REQUEST_HEADERS,
-                cookies=REQUEST_COOKIES,
-            )
-            async with http_session, http_session.get(BASE_MEMBERS_URL) as http_response:
-                response_html: str = await http_response.text()
-
-            member_list_div: bs4.Tag | bs4.NavigableString | None = BeautifulSoup(
-                response_html,
-                "html.parser",
-            ).find(
-                "div",
-                {"class": "memberlistcol"},
-            )
-
-            if member_list_div is None or isinstance(member_list_div, bs4.NavigableString):
-                await self.command_send_error(
-                    ctx=ctx,
-                    error_code="E1041",
-                    logging_message=OSError(
-                        "The member count could not be retrieved from the MEMBERS_LIST_URL.",
-                    ),
-                )
-                return
-
-            if "showing 100 of" in member_list_div.text.lower():
-                member_count: str = member_list_div.text.split(" ")[3]
-                await ctx.followup.send(
-                    content=f"{self.bot.group_full_name} has {member_count} members! :tada:",
-                )
-                return
-
-            member_table: bs4.Tag | bs4.NavigableString | None = BeautifulSoup(
-                response_html,
-                "html.parser",
-            ).find(
-                "table",
-                {"id": "ctl00_ctl00_Main_AdminPageContent_gvMembers"},
-            )
-
-            if member_table is None or isinstance(member_table, bs4.NavigableString):
-                await self.command_send_error(
-                    ctx=ctx,
-                    error_code="E1041",
-                    logging_message=OSError(
-                        "The member count could not be retrieved from the MEMBERS_LIST_URL."
-                    ),
-                )
-                return
-
             await ctx.followup.send(
-                content=f"{self.bot.group_full_name} has {
-                    len(member_table.find_all('tr', {'class': ['msl_row', 'msl_altrow']}))
-                } members! :tada:"
+                content=f"{settings['GROUP_NAME']} has {await get_membership_count()} "
+                "members! :tada:",
             )

cogs/society_events.py

@@ -0,0 +1,49 @@
+"""Module for handling society events in a Discord bot."""
+
+import logging
+from datetime import datetime
+from typing import TYPE_CHECKING
+
+import discord
+
+from utils import TeXBotBaseCog
+from utils.msl import fetch_guild_activities
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+    from logging import Logger
+    from typing import Final
+
+    from utils import TeXBotApplicationContext
+
+
+__all__: "Sequence[str]" = ("SocietyEventsSlashCommandsCog",)
+
+
+logger: "Final[Logger]" = logging.getLogger("TeX-Bot")
+
+
+class SocietyEventsSlashCommandsCog(TeXBotBaseCog):
+    """Cog Class for handling society event commands."""
+
+    society_events: discord.SlashCommandGroup = discord.SlashCommandGroup(
+        name="society-events",
+        description="Commands for managing society events.",
+    )
+
+    @society_events.command(
+        name="list-all",
+        desciption="List all society events.",
+    )
+    async def list_all_events(self, ctx: "TeXBotApplicationContext") -> None:
+        """List all society events."""
+        await ctx.defer(ephemeral=True)
+        activities: dict[str, str] = await fetch_guild_activities(
+            from_date=datetime.strptime("2023-01-01", "%Y-%m-%d"),  # noqa: DTZ007
+            to_date=datetime.strptime("2026-01-01", "%Y-%m-%d"),  # noqa: DTZ007
+        )
+
+        await ctx.followup.send(
+            content=str(activities),
+            ephemeral=True,
+        )

pyproject.toml

@@ -25,8 +25,9 @@ test = ["pytest-cov>=6.1", "pytest>=8.3"]
 type-check = ["django-stubs[compatible-mypy]>=5.1", "mypy>=1.13", "types-beautifulsoup4>=4.12"]
 
 [project] # TODO: Remove [project] table once https://github.com/astral-sh/uv/issues/8582 is completed
+dependencies = ["aiohttp>=3.11.14", "anyio>=4.9.0"]
 name = "TeX-Bot-Py-V2"
-requires-python = ">=3.12,<3.13" # TODO: Allow Python 3.13 once py-cord makes a new release with support for it
+requires-python = ">=3.12,<3.13"                    # TODO: Allow Python 3.13 once py-cord makes a new release with support for it
 version = "0.1.0"
 
 

utils/msl/__init__.py

@@ -0,0 +1,35 @@
+"""MSL utility classes & functions provided for use across the whole of the project."""
+
+from typing import TYPE_CHECKING
+
+from .activities import fetch_guild_activities
+from .events import create_event, get_all_guild_events
+from .finances import (
+    fetch_financial_transactions,
+    fetch_transaction_from_id,
+    get_account_balance,
+)
+from .memberships import get_full_membership_list, get_membership_count, is_student_id_member
+from .reports import (
+    get_product_customisations,
+    get_product_sales,
+    update_current_year_sales_report,
+)
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+__all__: "Sequence[str]" = (
+    "create_event",
+    "fetch_financial_transactions",
+    "fetch_guild_activities",
+    "fetch_transaction_from_id",
+    "get_account_balance",
+    "get_all_guild_events",
+    "get_full_membership_list",
+    "get_membership_count",
+    "get_product_customisations",
+    "get_product_sales",
+    "is_student_id_member",
+    "update_current_year_sales_report",
+)