Agregar funciones de prueba y herramientas para la interfaz de OBR

app.py

@@ -18,39 +18,23 @@ from tools.obr import (
     insert_map,
     clean_map
 )
+from tools.test import test_function
 from dotenv import load_dotenv
 import os
 
 load_dotenv()
 
-# === FUNCIÓN DE PRUEBA ===
-def test_function(text_input, number_input):
-    """Función de prueba que combina varias funcionalidades para testing"""
-    result = {
-        "text_analysis": letter_counter(text_input, "a"),
-        "dice_roll": roll_dice(6, number_input),
-        "coin_flip": coin_flip(number_input),
-        "input_received": {
-            "text": text_input,
-            "number": number_input
-        }
-    }
-    return result
-
 # === GRADIO INTERFACE ===
 demo = gr.TabbedInterface(
-    [
-        # Pestaña de pruebas (sin api_name)
+    [        # Pestaña de pruebas (sin api_name)
         gr.Interface(
             test_function,
             [
-                gr.Textbox(label="Texto de prueba", placeholder="Escribe algo aquí..."),
-                gr.Number(label="Número de prueba", value=3, minimum=1, maximum=10)
+                gr.Textbox(label="Tab ID"),
             ],
             gr.JSON(label="Resultados de la prueba"),
-            title="Ventana de Pruebas",
-            description="Esta ventana es solo para hacer pruebas y no sirve como endpoint.",
-            api_name=False
+            title="Ventana de Pruebas de OBR",
+            description="Esta ventana demuestra todas las funcionalidades de OwlBear Rodeo disponibles.",
         ),
         gr.Interface(letter_counter, [gr.Textbox(), gr.Textbox()], gr.Textbox(), api_name="letter_counter"),
         gr.Interface(prime_factors, gr.Number(), gr.JSON(), api_name="prime_factors"),

tools.py → tools/general.py

@@ -1,10 +1,3 @@
-import requests as request
-import os 
-import urllib3
-
-# Suprimir advertencias sobre conexiones SSL inseguras
-urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
-
 # === TOOLS ===
 def letter_counter(word, letter):
     """
@@ -78,54 +71,4 @@ def coin_flip(flips):
         List[str]: A list of results from each flip ("Heads" or "Tails").
     """
     import random
-    return ["Heads" if random.randint(0, 1) == 0 else "Tails" for _ in range(flips)]
-
-def execute_action(tab_id, action, params):
-    """
-    Execute an action on a specific tab.
-
-    Args:
-        tab_id (str): The ID of the tab where the action will be executed.
-        action (str): The action to perform (e.g., "createShape", "createText").
-        params (json): Parameters required for the action.
-
-    Returns:
-        dict: A dictionary containing the result of the action.
-    """
-    payload = {
-        "action": action,
-        "args": params
-    }
-    url = f"{os.getenv('FRONTEND_SERVER')}/execute/{tab_id}"
-
-    response = request.post(
-        url,
-        json=payload,
-        headers={'Content-Type': 'application/json'},
-        verify=False
-    )
-
-    return response
-
-def create_shape(width:int, height:int, shape_type:str, fill_color:str, tab_id:str):
-    """
-    Create a shape item with specified properties.
-
-    Args:
-        width (int): Width of the shape. Minimum value is 100.
-        height (int): Height of the shape.  Minimum value is 100.
-        shape_type (str): Type of the shape. It can be "RECTANGLE" | "CIRCLE" | "TRIANGLE" | "HEXAGON".
-        fill_color (str): Fill color in hex format (e.g., "#ff0000").
-        tab_id (str): The ID of the tab where the shape will be created. This is the most important parameter.
-
-    Returns:
-        dict: A dictionary representing the created shape item.
-    """
-    params = {
-        "width": width,
-        "height": height,
-        "shapeType": shape_type.upper(),
-        "fillColor": fill_color
-    }
-
-    return execute_action(tab_id=tab_id, action="createShape", params=params)
+    return ["Heads" if random.randint(0, 1) == 0 else "Tails" for _ in range(flips)]

tools/obr.py

@@ -0,0 +1,255 @@
+import requests as request
+import os 
+import urllib3
+
+# Suprimir advertencias sobre conexiones SSL inseguras
+urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
+
+ASSETS_NAMES = {
+    "BOOK": "book.png",
+    "CHEST": "chest.png",
+    "SWORD": "sword.png",
+    "TORCH": "torch.png",
+    "ARCHER": "halfElfBard.png",
+    "HUMAN": "human.png",
+    "ORC": "halfOrcFighter2.png",
+    "KNIGHT": "knight1.png",
+    "DRAGON": "redDragon.png",
+    "GOBLIN": "goblin.png",
+    "GOLEM": "rockGolem.png",
+    "FOREST": "battleMap.jpg",
+}
+
+def execute_action(tab_id, action, params={}):
+    """
+    Execute an action on a specific tab.
+
+    Args:
+        tab_id (str): The ID of the tab where the action will be executed.
+        action (str): The action to perform (e.g., "createShape", "createText").
+        params (json): Parameters required for the action.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    payload = {
+        "action": action,
+        "args": params
+    }
+    url = f"{os.getenv('FRONTEND_SERVER')}/execute/{tab_id}"
+
+    response = request.post(
+        url,
+        json=payload,
+        headers={'Content-Type': 'application/json'},
+        verify=False
+    )
+    
+    if action != "getGameState" and response.status_code == 200 and response.json()["success"]:
+        return execute_action(tab_id=tab_id, action="getGameState")
+    else:
+        return response.json()
+    
+def create_token(name:str, type:str, x:int, y:int, size:int, tab_id:str)->dict:
+    """
+    Create a token with specified properties, they can be items or characters.
+
+    Args:
+        name (str): Name of the token.
+        type (str): Type of the token. It can be "BOOK" | "CHEST" | "SWORD" | "TORCH" | "ARCHER" | "HUMAN" | "ORC" | "KNIGHT" | "DRAGON" | "GOBLIN" | "GOLEM".
+        x (int): X coordinate of the token in cells.
+        y (int): Y coordinate of the token in cells.
+        size (int): Width of the token in cells.
+        tab_id (str): The ID of the tab where the token will be created. This is the most important parameter.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+
+    asset_url = f"{os.getenv('ASSETS_URL')}/{ASSETS_NAMES[type.upper()]}"
+
+    params = {
+        "name": name,
+        "imageUrl": asset_url,
+        "x": x,
+        "y": y,
+        "size": size
+    }
+
+    return execute_action(tab_id=tab_id, action="createToken", params=params)
+
+def create_shape(width:int, height:int, x:int, y:int, shape_type:str, fill_color:str, stroke_color:str, tab_id:str) -> dict:
+    """
+    Create a shape item with specified properties.
+
+    Args:
+        width (int): Width of the shape in cells.
+        height (int): Height of the shape in cells.
+        x (int): X coordinate of the shape in cells.
+        y (int): Y coordinate of the shape in cells.
+        shape_type (str): Type of the shape. It can be "RECTANGLE" | "CIRCLE" | "TRIANGLE" | "HEXAGON".
+        fill_color (str): Fill color in hex format (e.g., "#ff0000").
+        stroke_color (str): Stroke color in hex format (e.g., "#ff0000").
+        tab_id (str): The ID of the tab where the shape will be created. This is the most important parameter.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    params = {
+        "width": width,
+        "height": height,
+        "x": x,
+        "y": y,
+        "shapeType": shape_type.upper(),
+        "strokeColor": stroke_color,
+        "fillColor": fill_color
+    }
+
+    return execute_action(tab_id=tab_id, action="createShape", params=params)
+
+def game_state(tab_id:str) -> dict:
+    """
+    Get the current game state.
+
+    Args:
+        tab_id (str): The ID of the tab to retrieve the game state for.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    return execute_action(tab_id=tab_id, action="getGameState")
+
+def move_item(tab_id:str, item_id:str, x:int, y:int) -> dict:
+    """
+    Move an item to a new position.
+
+    Args:
+        tab_id (str): The ID of the tab where the item is located.
+        item_id (str): The ID of the item to move.
+        x (int): New X coordinate in cells.
+        y (int): New Y coordinate in cells.
+
+    Returns:
+        dict: A dictionary confirming the moved item.
+    """
+    params = {
+        "id": item_id,
+        "x": x,
+        "y": y
+    }
+    
+    return execute_action(tab_id=tab_id, action="moveItem", params=params)
+
+def delete_item(tab_id:str, item_id:str) -> dict:
+    """
+    Delete an item from the game.
+
+    Args:
+        tab_id (str): The ID of the tab where the item is located.
+        item_id (str): The ID of the item to delete.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    params = {
+        "id": item_id
+    }
+    
+    return execute_action(tab_id=tab_id, action="deleteItem", params=params)
+
+def fill_fog(tab_id:str) -> dict:
+    """
+    Fill the entire map with fog of war.
+
+    Args:
+        tab_id (str): The ID of the tab where the fog will be applied.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    
+    return execute_action(tab_id=tab_id, action="fillFog")
+
+def clear_fog(tab_id:str) -> dict:
+    """
+    Clear the fog of war from the entire map.
+
+    Args:
+        tab_id (str): The ID of the tab where the fog will be cleared.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    
+    return execute_action(tab_id=tab_id, action="removeFog")
+
+def add_token_light(tab_id:str, item_id:str, light_radius:int) -> dict:
+    """
+    Add light to a token. This will allow to show it inside the fog of war.
+    It can be used to add light to items like torches or characters.
+    It will be attached so that the light moves with the token.
+
+    Args:
+        tab_id (str): The ID of the tab where the item is located.
+        item_id (str): The ID of the item to add light to.
+        light_radius (int): The radius of the light in cells.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    params = {
+        "targetId": item_id,
+        "radiusCells": light_radius
+    }
+    
+    return execute_action(tab_id=tab_id, action="addLightSource", params=params)
+
+def animate_token_viewport(tab_id:str, item_id:str) -> dict:
+    """
+    Animate the viewport to focus on a specific token.
+
+    Args:
+        tab_id (str): The ID of the tab where the item is located.
+        item_id (str): The ID of the item to focus on.
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    params = {
+        "itemsId": item_id
+    }
+    
+    return execute_action(tab_id=tab_id, action="animateViewport", params=params)
+
+def insert_map(tab_id:str, map_type:str="FOREST") -> dict:
+    """
+    Insert a map into the game.
+
+    Args:
+        tab_id (str): The ID of the tab where the map will be inserted.
+        map_type (str): The type of the map to insert. It can be only "FOREST".
+
+    Returns:
+        dict: A dictionary containing the game state.
+    """
+    map_type = map_type.upper()
+    map_type = "FOREST"
+    asset_url = f"{os.getenv('ASSETS_URL')}/{ASSETS_NAMES[map_type]}"
+    params = {
+        "mapUrl": asset_url,
+    }
+    
+    return execute_action(tab_id=tab_id, action="insertMap", params=params)
+
+def clean_map(tab_id:str) -> dict:
+    """
+    Clean the map by removing all items and shapes.
+
+    Args:
+        tab_id (str): The ID of the tab where the map will be cleaned.
+
+    Returns:
+        dict: A dictionary confirming the map cleaning.
+    """
+    
+    return execute_action(tab_id=tab_id, action="emptyAll")

tools/test.py

@@ -0,0 +1,129 @@
+from tools.obr import (
+    create_shape,
+    create_token,
+    game_state,
+    move_item,
+    delete_item,
+    fill_fog,
+    clear_fog,
+    add_token_light,
+    animate_token_viewport,
+    insert_map,
+    clean_map
+)
+import time
+
+# === FUNCIÓN DE PRUEBA ===
+def test_function(tab_id):
+    """Función de prueba que demuestra todas las funcionalidades de OBR"""
+    results = []
+    
+    try:
+        # 1. Limpiar el mapa
+        results.append({"step": "1. Limpiando mapa", "result": clean_map(tab_id)})
+        time.sleep(1)
+        
+        # 2. Limpiar niebla
+        results.append({"step": "2. Limpiando niebla", "result": clear_fog(tab_id)})
+        time.sleep(1)
+
+        # 3. Insertar mapa
+        results.append({"step": "3. Insertando mapa", "result": insert_map(tab_id, "FOREST")})
+        time.sleep(1)
+
+        # 4. Crear formas geométricas (círculos rojos en diagonal)
+        for i in range(0, 30, 6):
+            shape_result = create_shape(
+                width=2, 
+                height=2, 
+                x=i, 
+                y=i, 
+                shape_type="CIRCLE", 
+                fill_color="#FF0000", 
+                stroke_color="#FF0000", 
+                tab_id=tab_id
+            )
+            results.append({"step": f"4. Creando círculo en ({i},{i})", "result": shape_result})
+            time.sleep(0.5)
+
+        # 5. Crear token principal (Knight)
+        knight_result = create_token(
+            name="Knight",
+            type="KNIGHT",
+            x=0,
+            y=0,
+            size=1,
+            tab_id=tab_id
+        )
+        knight_id = [i for i in knight_result['result']["gameState"]['images'] if i["name"] == "Knight"][0]["id"]
+        
+        results.append({"step": "5. Creando Knight", "result": knight_result, "token_id": knight_id})
+        time.sleep(1)
+
+        # 6. Mover el knight a posición intermedia
+        if knight_id:
+            results.append({"step": "6. Moviendo Knight a (14,14)", "result": move_item(tab_id, knight_id, 14, 14)})
+            time.sleep(1)
+
+            # 7. Mover el knight a posición final
+            results.append({"step": "7. Moviendo Knight a (29,29)", "result": move_item(tab_id, knight_id, 29, 29)})
+            time.sleep(1)
+
+        # 8. Crear token dragón
+        dragon_result = create_token(
+            name="Red Dragon",
+            type="DRAGON",
+            x=14,
+            y=14,
+            size=3,
+            tab_id=tab_id
+        )
+        dragon_id = [i for i in dragon_result['result']["gameState"]['images'] if i["name"] == "Red Dragon"][0]["id"]   
+        results.append({"step": "8. Creando Red Dragon", "result": dragon_result, "token_id": dragon_id})
+        time.sleep(1)
+
+        # 9. Animar viewport al dragón
+        if dragon_id:
+            results.append({"step": "9. Animando viewport al dragón", "result": animate_token_viewport(tab_id, dragon_id)})
+            time.sleep(1)
+
+        # 10. Llenar con niebla
+        results.append({"step": "10. Llenando con niebla", "result": fill_fog(tab_id)})
+        time.sleep(1)
+
+        # 11. Añadir luz al knight
+        if knight_id:
+            results.append({"step": "11. Añadiendo luz al Knight", "result": add_token_light(tab_id, knight_id, 5)})
+            time.sleep(1)
+
+            # 12. Mover knight de vuelta al centro
+            results.append({"step": "12. Moviendo Knight de vuelta a (14,14)", "result": move_item(tab_id, knight_id, 14, 14)})
+            time.sleep(1)
+
+            # 13. Animar viewport al knight
+            results.append({"step": "13. Animando viewport al Knight", "result": animate_token_viewport(tab_id, knight_id)})
+            time.sleep(1)
+
+        # 14. Obtener estado final del juego
+        final_state = game_state(tab_id)
+        results.append({"step": "14. Estado final del juego", "result": final_state})
+        time.sleep(5)
+
+        #15. Limpiar mapa al final
+        results.append({"step": "15. Limpiando mapa", "result": clean_map(tab_id)})
+
+        
+        return {
+            "success": True,
+            "message": "Prueba completada exitosamente",
+            "total_steps": len(results),
+            "results": results
+        }
+        
+    except Exception as e:
+        return {
+            "success": False,
+            "error": str(e),
+            "completed_steps": len(results),
+            "results": results
+        }