feat: enhance guild schema detail

Author: JacobCoffee

src/server/domain/__init__.py

@@ -26,7 +26,7 @@
 routes: list[ControllerRouterHandler] = [
     system.controllers.system.SystemController,
     web.controllers.web.WebController,
-    guilds.controllers.GuildController,
+    guilds.controllers.GuildsController,
 ]
 """Routes for the application."""
 

src/server/domain/db/models.py

@@ -8,7 +8,7 @@
 from sqlalchemy.ext.associationproxy import AssociationProxy, association_proxy
 from sqlalchemy.orm import Mapped, mapped_column, relationship
 
-__all__ = ("GitHubConfig", "Guild", "SOTagsConfig", "User")
+__all__ = ("GitHubConfig", "Guild", "SOTagsConfig", "User", "AllowedUsersConfig")
 
 
 class Guild(UUIDAuditBase):

src/server/domain/guilds/controllers.py

@@ -7,7 +7,6 @@
 from litestar.di import Provide
 from litestar.params import Dependency, Parameter
 
-from server.domain.db.models import Guild
 from server.domain.guilds import urls
 from server.domain.guilds.dependencies import provides_guilds_service
 from server.domain.guilds.schemas import GuildSchema, UpdateableGuildSetting
@@ -17,10 +16,10 @@
     from advanced_alchemy import FilterTypes
     from litestar.pagination import OffsetPagination
 
-__all__ = ("GuildController",)
+__all__ = ("GuildsController",)
 
 
-class GuildController(Controller):
+class GuildsController(Controller):
     """Controller for guild-based routes."""
 
     tags = ["Guilds"]
@@ -33,9 +32,9 @@ class GuildController(Controller):
         path=urls.GUILD_LIST,
     )
     async def list_guilds(
-            self,
-            guilds_service: GuildsService,
-            filters: list[FilterTypes] = Dependency(skip_validation=True),
+        self,
+        guilds_service: GuildsService,
+        filters: list[FilterTypes] = Dependency(skip_validation=True),
     ) -> OffsetPagination[GuildSchema]:
         """List guilds.
 
@@ -56,16 +55,16 @@ async def list_guilds(
         path=urls.GUILD_CREATE,
     )
     async def create_guild(
-            self,
-            guilds_service: GuildsService,
-            guild_id: int = Parameter(
-                title="Guild ID",
-                description="The guild ID.",
-            ),
-            guild_name: str = Parameter(
-                title="Guild Name",
-                description="The guild name.",
-            ),
+        self,
+        guilds_service: GuildsService,
+        guild_id: int = Parameter(
+            title="Guild ID",
+            description="The guild ID.",
+        ),
+        guild_name: str = Parameter(
+            title="Guild Name",
+            description="The guild name.",
+        ),
     ) -> str:
         """Create a guild.
 
@@ -88,20 +87,20 @@ async def create_guild(
         path=urls.GUILD_UPDATE,
     )
     async def update_guild(
-            self,
-            guilds_service: GuildsService,
-            guild_id: Guild.guild_id = Parameter(
-                title="Guild ID",
-                description="The guild ID.",
-            ),
-            setting: UpdateableGuildSetting = Parameter(
-                title="Setting",
-                description="The setting to update.",
-            ),
-            value: str | int = Parameter(
-                title="Value",
-                description="The new value for the setting.",
-            ),
+        self,
+        guilds_service: GuildsService,
+        guild_id: int = Parameter(
+            title="Guild ID",
+            description="The guild ID.",
+        ),
+        setting: UpdateableGuildSetting = Parameter(
+            title="Setting",
+            description="The setting to update.",
+        ),
+        value: str | int = Parameter(
+            title="Value",
+            description="The new value for the setting.",
+        ),
     ) -> str:
         """Update a guild by ID.
 
@@ -114,5 +113,32 @@ async def update_guild(
         Returns:
             Guild: Updated guild object
         """
+        # todo: this is a placeholder, update
         await guilds_service.update(guild_id, setting, {"some-config-thing": value})
         return f"Guild {guild_id} updated."
+
+    @get(
+        operation_id="GuildDetail",
+        name="guilds:detail",
+        summary="Get guild details.",
+        path=urls.GUILD_DETAIL,
+    )
+    async def get_guild(
+        self,
+        guilds_service: GuildsService,
+        guild_id: int = Parameter(
+            title="Guild ID",
+            description="The guild ID.",
+        ),
+    ) -> GuildSchema:
+        """Get a guild by ID.
+
+        Args:
+            guilds_service (GuildsService): Guilds service
+            guild_id (int): Guild ID
+
+        Returns:
+            Guild: Guild object
+        """
+        result = await guilds_service.get(guild_id, id_attribute="guild_id")
+        return guilds_service.to_schema(GuildSchema, result)

src/server/domain/guilds/dependencies.py

@@ -4,8 +4,9 @@
 from typing import TYPE_CHECKING
 
 from sqlalchemy import select
+from sqlalchemy.orm import joinedload, noload, selectinload
 
-from server.domain.db.models import Guild
+from server.domain.db.models import AllowedUsersConfig, GitHubConfig, Guild, SOTagsConfig
 from server.domain.guilds.services import GuildsService
 from server.lib import log
 
@@ -20,15 +21,30 @@
 
 
 async def provides_guilds_service(db_session: AsyncSession) -> AsyncGenerator[GuildsService, None]:
-    """Construct GuildConfig-based repository and service objects for the request.
+    """Construct Guilds-based repository and service objects for the request.
 
     Args:
         db_session (AsyncSession): SQLAlchemy AsyncSession
 
     Yields:
         GuildsService: GuildConfig-based service
     """
-    async with GuildsService.new(session=db_session, statement=select(Guild).order_by(Guild.guild_id)) as service:
+    async with GuildsService.new(
+        session=db_session,
+        statement=select(Guild)
+        .order_by(Guild.guild_name)
+        .options(
+            selectinload(Guild.github_config).options(
+                joinedload(GitHubConfig.guild, innerjoin=True).options(noload("*")),
+            ),
+            selectinload(Guild.sotags_configs).options(
+                joinedload(SOTagsConfig.guild, innerjoin=True).options(noload("*")),
+            ),
+            selectinload(Guild.allowed_users).options(
+                joinedload(AllowedUsersConfig.guild, innerjoin=True).options(noload("*")),
+            ),
+        ),
+    ) as service:
         try:
             yield service
         finally:

src/server/domain/guilds/schemas.py

@@ -10,6 +10,23 @@
 __all__ = ("GuildCreate", "GuildSchema", "GuildUpdate", "UpdateableGuildSetting")
 
 
+class GitHubConfigSchema(CamelizedBaseModel):
+    guild_id: UUID
+    discussion_sync: bool
+    github_organization: str | None
+    github_repository: str | None
+
+
+class SOTagsConfigSchema(CamelizedBaseModel):
+    guild_id: UUID
+    tag_name: str
+
+
+class AllowedUsersConfigSchema(CamelizedBaseModel):
+    guild_id: int
+    user_id: UUID
+
+
 class GuildSchema(CamelizedBaseModel):
     """Schema representing an existing guild."""
 
@@ -24,6 +41,15 @@ class GuildSchema(CamelizedBaseModel):
     issue_linking: bool | None = Field(title="Issue Linking", description="Is issue linking enabled.")
     comment_linking: bool | None = Field(title="Comment Linking", description="Is comment linking enabled.")
     pep_linking: bool | None = Field(title="PEP Linking", description="Is PEP linking enabled.")
+    github_config: GitHubConfigSchema | None = Field(
+        title="GitHub Config", description="The GitHub configuration for the guild."
+    )
+    sotags_configs: list[SOTagsConfigSchema] = Field(
+        title="StackOverflow Tags Configs", description="The StackOverflow tags configuration for the guild."
+    )
+    allowed_users: list[AllowedUsersConfigSchema] = Field(
+        title="Allowed Users", description="The allowed users configuration for the guild."
+    )
 
 
 class GuildCreate(CamelizedBaseModel):
@@ -56,9 +82,7 @@ class UpdateableGuildSetting(CamelizedBaseModel):
     """Guild Model Settings"""
     prefix: str = Field(title="Prefix", description="The prefix for the guild.")
     help_channel_id: int = Field(title="Help Channel ID", description="The channel ID for the help channel.")
-    sync_label: str = Field(
-        title="Sync Label", description="The forum label to use for GitHub discussion syncs."
-    )
+    sync_label: str = Field(title="Sync Label", description="The forum label to use for GitHub discussion syncs.")
     issue_linking: bool = Field(title="Issue Linking", description="Is issue linking enabled.")
     comment_linking: bool = Field(title="Comment Linking", description="Is comment linking enabled.")
     pep_linking: bool = Field(title="PEP Linking", description="Is PEP linking enabled.")

src/server/domain/guilds/services.py

@@ -3,14 +3,13 @@
 
 from typing import Any
 
-from server.domain.db.models import Guild
+from server.domain.db.models import AllowedUsersConfig, GitHubConfig, Guild, SOTagsConfig
 from server.lib import log
-from server.lib.repository import SQLAlchemyAsyncSlugRepository
+from server.lib.repository import SQLAlchemyAsyncRepository, SQLAlchemyAsyncSlugRepository
 from server.lib.service import SQLAlchemyAsyncRepositoryService
 
 __all__ = ("GuildsRepository", "GuildsService")
 
-
 logger = log.get_logger()
 
 
@@ -37,3 +36,39 @@ async def to_model(self, data: Guild | dict[str, Any], operation: str | None = N
             Project: Converted model
         """
         return await super().to_model(data, operation)
+
+
+class GitHubConfigRepository(SQLAlchemyAsyncRepository[GitHubConfig]):
+    """GitHubConfig SQLAlchemy Repository."""
+
+    model_type = GitHubConfig
+
+
+class GitHubConfigService(SQLAlchemyAsyncRepositoryService[GitHubConfig]):
+    """Handles basic operations for the guilds' GitHub config."""
+
+    repository_type = GitHubConfigRepository
+
+
+class SOTagsConfigRepository(SQLAlchemyAsyncRepository[SOTagsConfig]):
+    """SOTagsConfig SQLAlchemy Repository."""
+
+    model_type = SOTagsConfig
+
+
+class SOTagsConfigService(SQLAlchemyAsyncRepositoryService[SOTagsConfig]):
+    """Handles basic operations for the guilds' StackOverflow tags config."""
+
+    repository_type = SOTagsConfigRepository
+
+
+class AllowedUsersConfigRepository(SQLAlchemyAsyncRepository[AllowedUsersConfig]):
+    """AllowedUsersConfig SQLAlchemy Repository."""
+
+    model_type = AllowedUsersConfig
+
+
+class AllowedUsersConfigService(SQLAlchemyAsyncRepositoryService[AllowedUsersConfig]):
+    """Handles basic operations for the guilds' Allowed Users config."""
+
+    repository_type = AllowedUsersConfigRepository