Refactor game_service.py and add is_valid_slug utility function

Author: fvergaracl

app/api/v1/endpoints/games.py

@@ -16,56 +16,55 @@
 )
 
 
-# summary_get_games_list = "Get Games List"
-# description_get_games_list = """
-# ## Find Game
-# ### Find all games and params
-# """
+summary_get_games_list = "Get Games List"
+description_get_games_list = """
+## Find Game
+### Find all games and params
+"""
 
 
-# @router.get(
-#     "",
-#     response_model=FindGameResult,
-#     description=description_get_games_list,
-#     summary=summary_get_games_list,
-# )
-# @inject
-# def get_games_list(
-#     schema: PostFindGame = Depends(),
-#     service: GameService = Depends(Provide[Container.game_service]),
-# ):
-#     return service.get_all_games(schema)
+@router.get(
+    "",
+    response_model=FindGameResult,
+    description=description_get_games_list,
+    summary=summary_get_games_list,
+)
+@inject
+def get_games_list(
+    schema: PostFindGame = Depends(),
+    service: GameService = Depends(Provide[Container.game_service]),
+):
+    return service.get_all_games(schema)
 
 
-# summary_get_game_by_id = "Get Game by Id"
-# description_get_game_by_id = """
-# ## Get Game by Id
-# ### Get game by id
-# """
+summary_get_game_by_id = "Get Game by externalId"
+description_get_game_by_id = """
+Get Game by externalId
 
+"""
 
-# @router.get(
-#     "/{id}",
-#     response_model=FindGameById,
-#     description=description_get_game_by_id,
-#     summary=summary_get_game_by_id,
-# )
-# @inject
-# def get_game_by_id(
-#     id: UUID,
-#     service: GameService = Depends(Provide[Container.game_service]),
-# ):
 
-#     response = service.get_by_id(id)
-#     return response
+@router.get(
+    "/{id}",
+    response_model=FindGameById,
+    description=description_get_game_by_id,
+    summary=summary_get_game_by_id,
+)
+@inject
+def get_game_by_id(
+    id: UUID,
+    service: GameService = Depends(Provide[Container.game_service]),
+):
+
+    response = service.get_by_id(id)
+    return response
 
 
 summary_create_game = "Create Game"
 description_create_game = """
 Create Game
 """
 
-
 @router.post(
     "",
     response_model=GameCreated,
@@ -79,18 +78,6 @@ def create_game(
 ):
     return service.create(schema)
 
-# @router.post(
-# "",
-# response_model=GameCreated,
-# summary=summary_create_game,
-# description=description_create_game,
-# )
-# @inject
-# def create_game(
-# schema: PostCreateGame,
-# service: GameService = Depends(Provide[Container.game_service]),
-# ):
-# return service.create(schema)
 
 
 # summary_patch_game = "Update Game"

app/repository/game_repository.py

@@ -43,6 +43,8 @@ def get_all_games(self, schema):
 
             query = session.query(
                 Games.id.label("id"),
+                Games.updated_at.label("updated_at"),
+                Games.strategyId.label("strategyId"),
                 Games.created_at.label("created_at"),
                 Games.platform.label("platform"),
                 Games.endDateTime.label("endDateTime"),
@@ -73,14 +75,16 @@ def get_all_games(self, schema):
                 games = query.limit(page_size).offset(
                     (page - 1) * page_size).all()
 
-            total_count = filtered_query.count()
+           
 
             game_results = {}
             for game in games:
                 game_id = game.id
                 if game_id not in game_results:
                     game_results[game_id] = BaseGameResult(
                         id=game.id,
+                        updated_at=game.updated_at,
+                        strategyId=game.strategyId,
                         created_at=game.created_at,
                         externalGameId=game.externalGameId,
                         platform=game.platform,
@@ -90,11 +94,13 @@ def get_all_games(self, schema):
                 game_results[game_id].params.append(
                     {
                         "id": game.GamesParams.id,
-                        "key": game.GamesParams.paramKey,
+                        "key": game.GamesParams.key,
                         "value": game.GamesParams.value,
                     }
                 )
 
+            total_count = list(game_results.values()).__len__()
+
             return FindGameResult(
                 items=list(game_results.values()),
                 search_options={
@@ -122,7 +128,7 @@ def get_game_by_id(self, id: str):
                 game_params.append(
                     {
                         "id": param.id,
-                        "paramKey": param.paramKey,
+                        "key": param.key,
                         "value": param.value,
                     }
                 )

app/schema/games_schema.py

@@ -98,7 +98,7 @@ class UpsertGame(BaseGame, metaclass=AllOptional):
 
 
 class UpsertGameWithGameParams(BaseGame, metaclass=AllOptional):
-    paramKey: str
+    key: str
     value: str
 
 

app/services/game_service.py

@@ -9,7 +9,7 @@
                                      ResponsePatchGame)
 from app.services.base_service import BaseService
 from app.engine.all_engine_strategies import all_engine_strategies
-
+from app.util.is_valid_slug import is_valid_slug
 class GameService(BaseService):
     def __init__(
         self,
@@ -40,6 +40,16 @@ def create(self, schema: PostCreateGame):
         externalGameId_exist = self.game_repository.read_by_column(
             "externalGameId", externalGameId, not_found_raise_exception=False
         )
+
+        is_valid_externalGameId = is_valid_slug(externalGameId)
+        if not is_valid_externalGameId:
+            raise ConflictError(
+                detail=(
+                    f"Invalid externalGameId: {externalGameId}. externalGameId should be a valid slug (Should have only alphanumeric characters and Underscore . Length should be between 3 and 60)"  
+                )
+            )
+
+        # externalGameId
         if externalGameId_exist:
             raise ConflictError(
                 detail=(

app/util/validate_slug.py renamed to app/util/is_valid_slug.py

@@ -1,7 +1,7 @@
 import re
 
 
-def validate_slug(slug):
+def is_valid_slug(slug):
     """
     Validates a slug.
     :param slug: The slug to validate.
@@ -11,4 +11,4 @@ def validate_slug(slug):
 
 
     """
-    return re.match(r'^[a-z0-9_-]{3,60}$', slug) is not None
+    return re.match(r"^[a-zA-Z0-9_]{3,60}$", slug) is not None

tests/unit_tests/model/test_game_params.py

@@ -5,21 +5,21 @@
 
 def test_games_params_creation_and_representation():
     # Prepare data for creating a GamesParams instance
-    param_key = "difficulty"
+    key = "difficulty"
     value = "hard"
     game_id = str(uuid4())  # Assuming UUID is used for game IDs
 
     # Create a GamesParams instance
     game_params = GamesParams(
-        paramKey=param_key,
+        key=key,
         value=value,
         gameId=game_id
     )
 
     # Test the string representation
     expected_str = (
         f"GameParams: (id={game_params.id}, created_at={game_params.created_at}, updated_at={game_params.updated_at}, "
-        f"paramKey={param_key}, value={value}, gameId={game_id})"
+        f"key={key}, value={value}, gameId={game_id})"
     )
     assert str(game_params) == expected_str
     assert repr(game_params) == expected_str
@@ -28,17 +28,17 @@ def test_games_params_creation_and_representation():
 def test_games_params_equality():
     game_id = uuid4()
     game_params1 = GamesParams(
-        paramKey="difficulty",
+        key="difficulty",
         value="hard",
         gameId=game_id
     )
     game_params2 = GamesParams(
-        paramKey="difficulty",
+        key="difficulty",
         value="hard",
         gameId=game_id
     )
     game_params3 = GamesParams(
-        paramKey="level",
+        key="level",
         value="10",
         gameId=game_id
     )
@@ -51,17 +51,17 @@ def test_games_params_equality():
 def test_games_params_hash():
     game_id = uuid4()
     game_params1 = GamesParams(
-        paramKey="difficulty",
+        key="difficulty",
         value="hard",
         gameId=game_id
     )
     game_params2 = GamesParams(
-        paramKey="difficulty",
+        key="difficulty",
         value="hard",
         gameId=game_id
     )
     game_params3 = GamesParams(
-        paramKey="level",
+        key="level",
         value="10",
         gameId=game_id
     )