Refactor MSL authentication checks

cogs/check_su_platform_authorisation.py

@@ -1,10 +1,8 @@
 """Contains cog classes for SU platform access cookie authorisation check interactions."""
 
 import logging
-from enum import Enum
 from typing import TYPE_CHECKING, override
 
-import bs4
 import discord
 from discord.ext import tasks
 
@@ -13,10 +11,13 @@
 from utils.error_capture_decorators import (
     capture_guild_does_not_exist_error,
 )
-from utils.msl import fetch_url_content_with_session
+from utils.msl import (
+    get_su_platform_access_cookie_status,
+    get_su_platform_organisations,
+)
 
 if TYPE_CHECKING:
-    from collections.abc import Iterable, Sequence
+    from collections.abc import Sequence
     from collections.abc import Set as AbstractSet
     from logging import Logger
     from typing import Final
@@ -32,136 +33,7 @@
 logger: "Final[Logger]" = logging.getLogger("TeX-Bot")
 
 
-SU_PLATFORM_PROFILE_URL: "Final[str]" = "https://guildofstudents.com/profile"
-SU_PLATFORM_ORGANISATION_URL: "Final[str]" = (
-    "https://www.guildofstudents.com/organisation/admin"
-)
-
-
-class SUPlatformAccessCookieStatus(Enum):
-    """Enum class defining the status of the SU Platform Access Cookie."""
-
-    INVALID = (
-        logging.WARNING,
-        (
-            "The SU platform access cookie is not associated with any MSL user, "
-            "meaning it is invalid or expired."
-        ),
-    )
-    VALID = (
-        logging.WARNING,
-        (
-            "The SU platform access cookie is associated with a valid MSL user, "
-            "but is not an admin to any MSL organisations."
-        ),
-    )
-    AUTHORISED = (
-        logging.INFO,
-        (
-            "The SU platform access cookie is associated with a valid MSL user and "
-            "has access to at least one MSL organisation."
-        ),
-    )
-
-
-class CheckSUPlatformAuthorisationBaseCog(TeXBotBaseCog):
-    """Cog class that defines the base functionality for cookie authorisation checks."""
-
-    async def get_su_platform_access_cookie_status(self) -> SUPlatformAccessCookieStatus:
-        """Retrieve the current validity status of the SU platform access cookie."""
-        response_object: bs4.BeautifulSoup = bs4.BeautifulSoup(
-            await fetch_url_content_with_session(SU_PLATFORM_PROFILE_URL), "html.parser"
-        )
-        page_title: bs4.Tag | bs4.NavigableString | None = response_object.find("title")
-        if not page_title or "Login" in str(page_title):
-            logger.warning("Token is invalid or expired.")
-            return SUPlatformAccessCookieStatus.INVALID
-
-        organisation_admin_url: str = (
-            f"{SU_PLATFORM_ORGANISATION_URL}/{settings['ORGANISATION_ID']}"
-        )
-        response_html: str = await fetch_url_content_with_session(organisation_admin_url)
-
-        if "admin tools" in response_html.lower():
-            return SUPlatformAccessCookieStatus.AUTHORISED
-
-        if "You do not have any permissions for this organisation" in response_html.lower():
-            return SUPlatformAccessCookieStatus.VALID
-
-        logger.warning(
-            "Unexpected response when checking SU platform access cookie authorisation."
-        )
-        return SUPlatformAccessCookieStatus.INVALID
-
-    async def get_su_platform_organisations(self) -> "Iterable[str]":
-        """Retrieve the MSL organisations the current SU platform cookie has access to."""
-        response_object: bs4.BeautifulSoup = bs4.BeautifulSoup(
-            await fetch_url_content_with_session(SU_PLATFORM_PROFILE_URL), "html.parser"
-        )
-
-        page_title: bs4.Tag | bs4.NavigableString | None = response_object.find("title")
-
-        if not page_title:
-            logger.warning(
-                "Profile page returned no content when checking "
-                "SU platform access cookie's authorisation."
-            )
-            return ()
-
-        if "Login" in str(page_title):
-            logger.warning(
-                "Authentication redirected to login page. "
-                "SU platform access cookie is invalid or expired."
-            )
-            return ()
-
-        profile_section_html: bs4.Tag | bs4.NavigableString | None = response_object.find(
-            "div", {"id": "profile_main"}
-        )
-
-        if profile_section_html is None:
-            logger.warning(
-                "Couldn't find the profile section of the user "
-                "when scraping the SU platform's website HTML."
-            )
-            logger.debug("Retrieved HTML: %s", response_object.text)
-            return ()
-
-        user_name: bs4.Tag | bs4.NavigableString | int | None = profile_section_html.find("h1")
-
-        if not isinstance(user_name, bs4.Tag):
-            logger.warning(
-                "Found user profile on the SU platform but couldn't find their name."
-            )
-            logger.debug("Retrieved HTML: %s", response_object.text)
-            return ()
-
-        parsed_html: bs4.Tag | bs4.NavigableString | None = response_object.find(
-            "ul", {"id": "ulOrgs"}
-        )
-
-        if parsed_html is None or isinstance(parsed_html, bs4.NavigableString):
-            NO_ADMIN_TABLE_MESSAGE: Final[str] = (
-                f"Failed to retrieve the admin table for user: {user_name.string}. "
-                "Please check you have used the correct SU platform access token!"
-            )
-            logger.warning(NO_ADMIN_TABLE_MESSAGE)
-            return ()
-
-        organisations: Iterable[str] = [
-            list_item.get_text(strip=True) for list_item in parsed_html.find_all("li")
-        ]
-
-        logger.debug(
-            "SU platform access cookie has admin authorisation to: %s as user %s",
-            organisations,
-            user_name.text,
-        )
-
-        return organisations
-
-
-class CheckSUPlatformAuthorisationCommandCog(CheckSUPlatformAuthorisationBaseCog):
+class CheckSUPlatformAuthorisationCommandCog(TeXBotBaseCog):
     """Cog class that defines the "/check-su-platform-authorisation" command."""
 
     @discord.slash_command(
@@ -182,7 +54,7 @@ async def check_su_platform_authorisation(self, ctx: "TeXBotApplicationContext")
 
         async with ctx.typing():
             su_platform_access_cookie_organisations: AbstractSet[str] = set(
-                await self.get_su_platform_organisations()
+                await get_su_platform_organisations()
             )
 
             await ctx.followup.send(
@@ -205,7 +77,7 @@ async def check_su_platform_authorisation(self, ctx: "TeXBotApplicationContext")
             )
 
 
-class CheckSUPlatformAuthorisationTaskCog(CheckSUPlatformAuthorisationBaseCog):
+class CheckSUPlatformAuthorisationTaskCog(TeXBotBaseCog):
     """Cog class defining a repeated task for checking SU platform access cookie."""
 
     @override
@@ -237,7 +109,7 @@ async def su_platform_access_cookie_check_task(self) -> None:
         logger.debug("Running SU platform access cookie check task...")
 
         su_platform_access_cookie_status: tuple[int, str] = (
-            await self.get_su_platform_access_cookie_status()
+            await get_su_platform_access_cookie_status()
         ).value
 
         logger.log(

utils/msl/__init__.py

@@ -2,19 +2,25 @@
 
 from typing import TYPE_CHECKING
 
+from .authorisation import (
+    SUPlatformAccessCookieStatus,
+    get_su_platform_access_cookie_status,
+    get_su_platform_organisations,
+)
 from .memberships import (
     fetch_community_group_members_count,
     fetch_community_group_members_list,
-    fetch_url_content_with_session,
     is_id_a_community_group_member,
 )
 
 if TYPE_CHECKING:
     from collections.abc import Sequence
 
 __all__: "Sequence[str]" = (
+    "SUPlatformAccessCookieStatus",
     "fetch_community_group_members_count",
     "fetch_community_group_members_list",
-    "fetch_url_content_with_session",
+    "get_su_platform_access_cookie_status",
+    "get_su_platform_organisations",
     "is_id_a_community_group_member",
 )

utils/msl/authorisation.py

@@ -0,0 +1,143 @@
+"""Module for authorisation checks."""
+
+import logging
+from enum import Enum
+from typing import TYPE_CHECKING
+
+import bs4
+
+from .core import ORGANISATION_ADMIN_URL, su_platform_client
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable, Sequence
+    from logging import Logger
+    from typing import Final
+
+
+__all__: "Sequence[str]" = (
+    "SUPlatformAccessCookieStatus",
+    "get_su_platform_access_cookie_status",
+    "get_su_platform_organisations",
+)
+
+
+logger: "Final[Logger]" = logging.getLogger("TeX-Bot")
+
+
+SU_PLATFORM_PROFILE_URL: "Final[str]" = "https://guildofstudents.com/profile"
+
+
+class SUPlatformAccessCookieStatus(Enum):
+    """Enum class defining the status of the SU Platform Access Cookie."""
+
+    INVALID = (
+        logging.WARNING,
+        (
+            "The SU platform access cookie is not associated with any MSL user, "
+            "meaning it is invalid or expired."
+        ),
+    )
+    VALID = (
+        logging.WARNING,
+        (
+            "The SU platform access cookie is associated with a valid MSL user, "
+            "but is not an admin to any MSL organisations."
+        ),
+    )
+    AUTHORISED = (
+        logging.INFO,
+        (
+            "The SU platform access cookie is associated with a valid MSL user and "
+            "has access to at least one MSL organisation."
+        ),
+    )
+
+
+async def get_su_platform_access_cookie_status() -> SUPlatformAccessCookieStatus:
+    """Retrieve the current validity status of the SU platform access cookie."""
+    response_object: bs4.BeautifulSoup = bs4.BeautifulSoup(
+        await su_platform_client.fetch_url_content(SU_PLATFORM_PROFILE_URL), "html.parser"
+    )
+    page_title: bs4.Tag | bs4.NavigableString | None = response_object.find("title")
+    if not page_title or "Login" in str(page_title):
+        logger.debug("Token is invalid or expired.")
+        return SUPlatformAccessCookieStatus.INVALID
+
+    response_html: str = await su_platform_client.fetch_url_content(ORGANISATION_ADMIN_URL)
+
+    if "admin tools" in response_html.lower():
+        return SUPlatformAccessCookieStatus.AUTHORISED
+
+    if "you do not have any permissions for this organisation" in response_html.lower():
+        return SUPlatformAccessCookieStatus.VALID
+
+    logger.warning(
+        "Unexpected response when checking SU platform access cookie authorisation."
+    )
+    return SUPlatformAccessCookieStatus.INVALID
+
+
+async def get_su_platform_organisations() -> "Iterable[str]":
+    """Retrieve the MSL organisations the current SU platform cookie has access to."""
+    response_object: bs4.BeautifulSoup = bs4.BeautifulSoup(
+        await su_platform_client.fetch_url_content(SU_PLATFORM_PROFILE_URL), "html.parser"
+    )
+
+    page_title: bs4.Tag | bs4.NavigableString | None = response_object.find("title")
+
+    if not page_title:
+        logger.warning(
+            "Profile page returned no content when checking "
+            "SU platform access cookie's authorisation."
+        )
+        return ()
+
+    if "Login" in str(page_title):
+        logger.warning(
+            "Authentication redirected to login page. "
+            "SU platform access cookie is invalid or expired."
+        )
+        return ()
+
+    profile_section_html: bs4.Tag | bs4.NavigableString | None = response_object.find(
+        "div", {"id": "profile_main"}
+    )
+
+    if profile_section_html is None:
+        logger.warning(
+            "Couldn't find the profile section of the user "
+            "when scraping the SU platform's website HTML."
+        )
+        logger.debug("Retrieved HTML: %s", response_object.text)
+        return ()
+
+    user_name: bs4.Tag | bs4.NavigableString | int | None = profile_section_html.find("h1")
+
+    if not isinstance(user_name, bs4.Tag):
+        logger.warning("Found user profile on the SU platform but couldn't find their name.")
+        logger.debug("Retrieved HTML: %s", response_object.text)
+        return ()
+
+    parsed_html: bs4.Tag | bs4.NavigableString | None = response_object.find(
+        "ul", {"id": "ulOrgs"}
+    )
+
+    if parsed_html is None or isinstance(parsed_html, bs4.NavigableString):
+        NO_ADMIN_TABLE_MESSAGE: Final[str] = (
+            f"Failed to retrieve the admin table for user: {user_name.string}. "
+            "Please check you have used the correct SU platform access token!"
+        )
+        logger.warning(NO_ADMIN_TABLE_MESSAGE)
+        return ()
+
+    organisations: Iterable[str] = [
+        list_item.get_text(strip=True) for list_item in parsed_html.find_all("li")
+    ]
+
+    logger.debug(
+        "SU platform access cookie has admin authorisation to: %s as user %s",
+        organisations,
+        user_name.text,
+    )
+
+    return organisations