Merge pull request #16 from python-discord/feat/team-by-name

Implement endpoint for getting team by name

Author: D0rs4n

alembic/versions/3bb5cc4b5d48_add_unique_team_name_and_jam_constraint.py

@@ -0,0 +1,24 @@
+"""add unique team name and jam constraint
+
+Revision ID: 3bb5cc4b5d48
+Revises: a2c25c740f2a
+Create Date: 2022-07-05 20:42:53.033311
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '3bb5cc4b5d48'
+down_revision = 'a2c25c740f2a'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+ op.create_index('team_name_jam_unique', 'teams', [sa.text('lower(name)'), 'jam_id'], unique=True)
+
+
+def downgrade():
+ op.drop_index('team_name_jam_unique', 'teams')

api/database.py

@@ -1,4 +1,4 @@
-from sqlalchemy import BigInteger, Boolean, Column, Enum, ForeignKey, Integer, PrimaryKeyConstraint, Text
+from sqlalchemy import BigInteger, Boolean, Column, Enum, ForeignKey, Index, Integer, PrimaryKeyConstraint, Text, text
 from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.orm import relationship, sessionmaker
@@ -65,6 +65,10 @@ class Team(Base):
  jam = relationship("Jam", back_populates="teams", lazy="joined")
  users = relationship("TeamUser", back_populates="team", lazy="joined")
 
+ __table_args__ = (
+ Index('team_name_jam_unique', text("lower(name)"), "jam_id", unique=True),
+ )
+
 
 class Winner(Base):
  """A user who has won a code jam."""

api/routers/teams.py

@@ -1,4 +1,7 @@
+from typing import Optional
+
 from fastapi import APIRouter, Depends, HTTPException, Response
+from sqlalchemy import func
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.future import select
 
@@ -43,6 +46,36 @@ async def get_teams(current_jam: bool = False, session: AsyncSession = Depends(g
  return teams.scalars().all()
 
 
+@router.get(
+ "/find",
+ response_model=TeamResponse,
+ responses={
+ 404: {
+ "description": "Team could not be found."
+ }
+ }
+)
+async def find_team_by_name(
+ name: str, jam_id: Optional[int] = None, session: AsyncSession = Depends(get_db_session)
+) -> Team:
+ """Get a specific code jam team by name."""
+ if jam_id is None:
+ teams = await session.execute(
+ select(Team).join(Team.jam).where(func.lower(Team.name) == func.lower(name) and Jam.ongoing == True)
+ )
+ else:
+ teams = await session.execute(
+ select(Team).where((func.lower(Team.name) == func.lower(name)) & (Team.jam_id == jam_id))
+ )
+
+ teams.unique()
+
+ if not (team := teams.scalars().one_or_none()):
+ raise HTTPException(status_code=404, detail="Team with specified name could not be found.")
+
+ return team
+
+
 @router.get(
  "/{team_id}",
  response_model=TeamResponse,

tests/routers/test_teams.py

@@ -147,3 +147,65 @@ async def test_remove_nonexisting_team_user(
  )
 
  assert response.status_code == 400
+
+
+async def test_find_nonexisting_team(
+ client: AsyncClient,
+ app: FastAPI
+) -> None:
+ """Getting a non-existing team by name should return 404."""
+ response = await client.get(
+ app.url_path_for("find_team_by_name"),
+ params={"name": "team that should never exist"}
+ )
+
+ assert response.status_code == 404
+
+
+async def test_find_existing_team_case_insensitive_current_jam(
+ client: AsyncClient,
+ app: FastAPI,
+ created_codejam: models.CodeJamResponse
+) -> None:
+ """Getting an existing team (current jam) should return 200 and be case-insensitive."""
+ team = created_codejam.teams[0]
+
+ response = await client.get(
+ app.url_path_for("find_team_by_name"),
+ params={"name": team.name.upper()}
+ )
+ assert response.status_code == 200
+
+ parsed = models.TeamResponse(**response.json())
+ assert parsed == team
+
+
+async def test_find_team_by_name_wrong_jam(
+ client: AsyncClient,
+ app: FastAPI,
+ created_codejam: models.CodeJamResponse
+) -> None:
+ """Getting an existing team from wrong code jam should return 404."""
+ response = await client.get(
+ app.url_path_for("find_team_by_name"),
+ params={"name": created_codejam.teams[0].name.upper(), "jam_id": 9999}
+ )
+ assert response.status_code == 404
+
+
+async def test_find_team_by_name_using_specific_jam(
+ client: AsyncClient,
+ app: FastAPI,
+ created_codejam: models.CodeJamResponse
+) -> None:
+ """Getting an existing team using right jam ID should return 200 and be case-insensitive."""
+ team = created_codejam.teams[0]
+
+ response = await client.get(
+ app.url_path_for("find_team_by_name"),
+ params={"name": team.name.upper(), "jam_id": created_codejam.id}
+ )
+ assert response.status_code == 200
+
+ parsed = models.TeamResponse(**response.json())
+ assert parsed == team