Put requested board game in variable for expandability/testing

README.md

@@ -1,4 +1,2 @@
 # bgg_api
 
-An API implementation that will be used by my own board game website.
-The plan is for this API to be used by a single person who wants their board game collection to be cached so that retrieval is much faster.

bgg_connection.py

@@ -0,0 +1,59 @@
+import requests
+import xml.etree.ElementTree as ET
+from pydantic import HttpUrl
+
+from classes.boardgame import BoardGame, BoardGameExpansion
+
+def url_to_xml_object(url: HttpUrl) -> ET.Element:
+    r = requests.get(url)
+    root = ET.fromstring(r.content)
+    return root
+
+#Requires single boardgame XML 'item' from bgg api
+def convert_xml_to_boardgame(boardgame_xml: ET.Element) -> BoardGame:
+
+    boardgame_type = boardgame_xml.get('type')
+
+    match boardgame_type:
+        case "boardgame":
+            boardgame = BoardGame(
+                id = boardgame_xml.get('id'),
+                name = boardgame_xml.find('name').get('value'),
+                description = boardgame_xml.find('description').text,
+                image_url = boardgame_xml.find('image').text,
+                thumbnail_url = boardgame_xml.find('thumbnail').text,
+                year_published = int(boardgame_xml.find('yearpublished').get('value')),
+                min_players = int(boardgame_xml.find('minplayers').get('value')),
+                max_players = int(boardgame_xml.find('maxplayers').get('value')),
+                min_playing_time = int(boardgame_xml.find('minplaytime').get('value')),
+                max_playing_time = int(boardgame_xml.find('maxplaytime').get('value')),
+                min_age = int(boardgame_xml.find('minage').get('value')),
+                all_expansion_ids = [0,1,2,3]
+            )
+        case "boardgameexpansion":
+            boardgame = BoardGameExpansion(
+                id = boardgame_xml.get('id'),
+                name = boardgame_xml.find('name').get('value'),
+                description = boardgame_xml.find('description').text,
+                image_url = boardgame_xml.find('image').text,
+                thumbnail_url = boardgame_xml.find('thumbnail').text,
+                year_published = int(boardgame_xml.find('yearpublished').get('value')),
+                min_players = int(boardgame_xml.find('minplayers').get('value')),
+                max_players = int(boardgame_xml.find('maxplayers').get('value')),
+                min_playing_time = int(boardgame_xml.find('minplaytime').get('value')),
+                max_playing_time = int(boardgame_xml.find('maxplaytime').get('value')),
+                min_age = int(boardgame_xml.find('minage').get('value')),
+                all_expansion_ids = [0,1,2,3]
+            )
+
+    
+
+    return boardgame
+
+def get_boardgame(boardgame_id: int) -> BoardGame:
+    url : str = "https://boardgamegeek.com/xmlapi2/thing?id={}&stats=true".format(boardgame_id)
+    boardgame_xml_object : ET.Element = url_to_xml_object(url)
+
+    requested_boardgame = convert_xml_to_boardgame(boardgame_xml_object.find('item'))
+
+    return requested_boardgame

classes/boardgame.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, HttpUrl
+
+class BoardGame(BaseModel):
+    id: int
+    name: str
+    description: str
+    image_url : HttpUrl
+    thumbnail_url : HttpUrl
+    year_published: int
+    min_players: int
+    max_players: int
+    min_playing_time: int
+    max_playing_time: int
+    min_age: int
+    all_expansion_ids: list[int]
+
+
+class BoardGameExpansion(BoardGame):
+    pass

main.py

@@ -0,0 +1,22 @@
+from typing import Union
+from fastapi import FastAPI
+
+from classes.boardgame import BoardGame, BoardGameExpansion
+from bgg_connection import get_boardgame
+
+app = FastAPI()
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+
+@app.get("/items/{item_id}")
+def read_item(item_id: int, q: Union[str, None] = None):
+    return {"item_id": item_id, "q": q}
+
+@app.get("/boardgame/{boardgame_id}", response_model=BoardGame)
+def get_boardgame_by_id(boardgame_id: int):
+    requested_boardgame: BoardGame = get_boardgame(boardgame_id)
+    return requested_boardgame