Naming fix

Author: kompotkot

brood/actions.py

@@ -864,9 +864,9 @@ def get_token(session: Session, token: uuid.UUID) -> Token:
     return token_object
 
 
-def get_current_user_extended(
+def get_current_user_with_groups(
     session: Session, token: uuid.UUID
-) -> Tuple[bool, data.UserExtendedResponse]:
+) -> Tuple[bool, data.UserWithGroupsResponse]:
     """
     Extend user data with groups for authentication middleware.
     """
@@ -903,7 +903,7 @@ def get_current_user_extended(
             )
         )
 
-    user_extended = data.UserExtendedResponse(
+    user_extended = data.UserWithGroupsResponse(
         user_id=user.id,
         username=user.username,
         first_name=user.first_name,

brood/api.py

@@ -30,7 +30,7 @@
     oauth2_scheme,
     autogenerated_user_token_check,
     get_current_user,
-    current_user_extended,
+    get_current_user_with_groups,
     is_token_restricted,
     is_token_restricted_or_installation,
     get_current_user_or_installation,
@@ -462,12 +462,12 @@ async def get_user_by_id_handler(
     return user
 
 
-@app.get("/auth", tags=["users"], response_model=data.UserExtendedResponse)
+@app.get("/auth", tags=["users"], response_model=data.UserWithGroupsResponse)
 async def get_auth_handler(
-    current_user: data.UserExtendedResponse = Depends(current_user_extended),
-) -> data.UserExtendedResponse:
+    current_user: data.UserWithGroupsResponse = Depends(get_current_user_with_groups),
+) -> data.UserWithGroupsResponse:
     """
-    Authorization middleware.
+    Endpoint returns user info extended with groups, mostly used as authorization middleware.
     """
     return current_user
 

brood/data.py

@@ -275,5 +275,5 @@ class ApplicationsListResponse(BaseModel):
     applications: List[ApplicationResponse] = Field(default_factory=list)
 
 
-class UserExtendedResponse(UserResponse):
+class UserWithGroupsResponse(UserResponse):
     groups: List[GroupUserResponse] = Field(default_factory=list)

brood/middleware.py

@@ -33,12 +33,12 @@ async def get_current_user(
     return token_object.user
 
 
-async def current_user_extended(
+async def get_current_user_with_groups(
     token: UUID = Depends(oauth2_scheme),
     db_session=Depends(yield_db_session_from_env),
-) -> data.UserExtendedResponse:
+) -> data.UserWithGroupsResponse:
     try:
-        token_active, user_extended = actions.get_current_user_extended(
+        token_active, user_extended = actions.get_current_user_with_groups(
             session=db_session, token=token
         )
     except actions.TokenNotFound: