Use organisation ID instead of members url (#413)

Author: MattyTheHacker

.env.example

@@ -24,7 +24,7 @@ GROUP_SHORT_NAME=[Replace with the short colloquial name of your community group
 
 # The URL of the page where guests can purchase a full membership to join your community group
 # Must be a valid URL
-PURCHASE_MEMBERSHIP_URL=[Replace with your group's purchase=membership URL]
+PURCHASE_MEMBERSHIP_URL=[Replace with your group\'s purchase=membership URL]
 
 
 # The minimum level that logs must meet in order to be logged to the console output stream
@@ -36,7 +36,7 @@ CONSOLE_LOG_LEVEL=INFO
 # The URL to retrieve the list of IDs of people that have purchased a membership to your community group
 # Ensure that all members are visible without pagination. For example, if your members-list is found on the UoB Guild of Students website, ensure the URL includes the "sort by groups" option
 # Must be a valid URL
-MEMBERS_LIST_URL=[Replace with your group's members-list URL]
+ORGANISATION_ID=[Replace with your group\'s MSL Organisation ID]
 
 # !!REQUIRED!!
 # The members-list URL session cookie
@@ -99,7 +99,7 @@ STATISTICS_ROLES=Committee,Committee-Elect,Student Rep,Member,Guest,Server Boost
 # !!REQUIRED!!
 # The URL of the your group's Discord guild moderation document
 # Must be a valid URL
-MODERATION_DOCUMENT_URL=[Replace with your group's moderation document URL]
+MODERATION_DOCUMENT_URL=[Replace with your group\'s moderation document URL]
 
 
 # The name of the channel, that warning messages will be sent to when a committee-member manually applies a moderation action (instead of using the `/strike` command)

README.md

@@ -190,9 +190,7 @@ You'll also need to set a number of [environment variables](https://wikipedia.or
 (This setting is optional.
 Error logs will **always** be sent to the [console](https://wikipedia.org/wiki/Terminal_emulator), this setting allows them to also be sent to a [Discord log channel](https://docs.pycord.dev/en/stable/api/models.html#discord.TextChannel).)
 
-* `MEMBERS_LIST_URL`: The [URL](https://wikipedia.org/wiki/URL) to retrieve the list of IDs of people that have purchased a membership to your community group.
-(The [CSS](https://cssbham.com)' members-list is currently found on [the Guild of Students website](https://guildofstudents.com).
-If your members-list is also found on [the Guild of Students website](https://guildofstudents.com), ensure the [URL](https://wikipedia.org/wiki/URL) includes the "sort by groups" option, so that all members are visible without [pagination](https://wikipedia.org/wiki/Pagination).)
+* `ORGANISATION_ID`: Your Guild society ID. This is used to dynamically create the members list among other needed URLs.
 
 * `MEMBERS_LIST_URL_SESSION_COOKIE`: The members-list [URL](https://wikipedia.org/wiki/URL) [session cookie](https://wikipedia.org/wiki/HTTP_cookie#Session_cookie).
 (If your group's members-list is stored at a [URL](https://wikipedia.org/wiki/URL) that requires [authentication](https://wikipedia.org/wiki/Authentication), this [session cookie](https://wikipedia.org/wiki/HTTP_cookie#Session_cookie) should [authenticate](https://wikipedia.org/wiki/Authentication) TeX-Bot to view your group's members-list, as if it were [logged in to the website](https://wikipedia.org/wiki/Login_session) as a Committee member.

cogs/make_member.py

@@ -67,7 +67,8 @@
     ".ASPXAUTH": settings["MEMBERS_LIST_AUTH_SESSION_COOKIE"],
 }
 
-REQUEST_URL: "Final[str]" = settings["MEMBERS_LIST_URL"]
+ORGANISATION_ID: "Final[str]" = settings["ORGANISATION_ID"]
+GROUPED_MEMBRS_URL: "Final[str]" = f"https://guildofstudents.com/organisation/memberlist/{ORGANISATION_ID}/?sort=groups"
 
 
 class MakeMemberCommandCog(TeXBotBaseCog):
@@ -171,7 +172,7 @@ async def make_member(self, ctx: "TeXBotApplicationContext", group_member_id: st
             headers=REQUEST_HEADERS,
             cookies=REQUEST_COOKIES,
         )
-        async with http_session, http_session.get(REQUEST_URL) as http_response:
+        async with http_session, http_session.get(GROUPED_MEMBRS_URL) as http_response:
             response_html: str = await http_response.text()
 
         MEMBER_HTML_TABLE_IDS: Final[frozenset[str]] = frozenset(

config.py

@@ -377,19 +377,20 @@ def _setup_roles_messages(cls) -> None:
         cls._settings["ROLES_MESSAGES"] = set(messages_dict["roles_messages"])  # type: ignore[call-overload]
 
     @classmethod
-    def _setup_members_list_url(cls) -> None:
-        raw_members_list_url: str | None = os.getenv("MEMBERS_LIST_URL")
+    def _setup_organisation_id(cls) -> None:
+        raw_organisation_id: str | None = os.getenv("ORGANISATION_ID")
 
-        MEMBERS_LIST_URL_IS_VALID: Final[bool] = bool(
-            raw_members_list_url and validators.url(raw_members_list_url),
+        ORGANISATION_ID_IS_VALID: Final[bool] = bool(
+            raw_organisation_id and re.fullmatch(r"\A\d{4,5}\Z", raw_organisation_id),
         )
-        if not MEMBERS_LIST_URL_IS_VALID:
-            INVALID_MEMBERS_LIST_URL_MESSAGE: Final[str] = (
-                "MEMBERS_LIST_URL must be a valid URL."
+
+        if not ORGANISATION_ID_IS_VALID:
+            INVALID_ORGANISATION_ID_MESSAGE: Final[str] = (
+                "ORGANISATION_ID must be an integer 4 to 5 digits long."
             )
-            raise ImproperlyConfiguredError(INVALID_MEMBERS_LIST_URL_MESSAGE)
+            raise ImproperlyConfiguredError(message=INVALID_ORGANISATION_ID_MESSAGE)
 
-        cls._settings["MEMBERS_LIST_URL"] = raw_members_list_url
+        cls._settings["ORGANISATION_ID"] = raw_organisation_id
 
     @classmethod
     def _setup_members_list_auth_session_cookie(cls) -> None:
@@ -701,7 +702,7 @@ def _setup_env_variables(cls) -> None:
         cls._setup_ping_command_easter_egg_probability()
         cls._setup_welcome_messages()
         cls._setup_roles_messages()
-        cls._setup_members_list_url()
+        cls._setup_organisation_id()
         cls._setup_members_list_auth_session_cookie()
         cls._setup_membership_perks_url()
         cls._setup_purchase_membership_url()