bgg_api/bgg_connection.py

117 lines
4.2 KiB
Python
Raw Normal View History

2024-07-25 19:58:28 +02:00
import requests
import xml.etree.ElementTree as ET
from pydantic import HttpUrl
import requests
2024-07-25 19:58:28 +02:00
from classes.boardgame import BoardGame, BoardGameExpansion
import auth_manager
authenticated_session: requests.Session = requests.Session()
2024-07-25 19:58:28 +02:00
def url_to_xml_object(url: HttpUrl) -> ET.Element:
r = authenticated_session.get(url)
2024-07-25 19:58:28 +02:00
root = ET.fromstring(r.content)
return root
#Requires single boardgame XML 'item' from bgg api on /thing
def convert_xml_to_boardgame(boardgame_xml: ET.Element) -> BoardGame:
boardgame_type = boardgame_xml.get('type')
boardgame_dict = {
"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]
}
match boardgame_type:
case "boardgame":
boardgame = BoardGame(**boardgame_dict)
case "boardgameexpansion":
boardgame = BoardGameExpansion(**boardgame_dict)
return boardgame
def convert_collection_xml_to_boardgame(boardgame_xml: ET.Element) -> BoardGame:
boardgame_type = boardgame_xml.get('subtype')
boardgame_dict = {
"id" : boardgame_xml.get('objectid'),
"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]
}
match boardgame_type:
case "boardgame":
boardgame = BoardGame(**boardgame_dict)
case "boardgameexpansion":
boardgame = BoardGameExpansion(**boardgame_dict)
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
def get_user_owned_collection() -> list[BoardGame]:
url = 'https://boardgamegeek.com/xmlapi2/collection?username={}&own=1&stats=1&excludesubtype=boardgameexpansion&showprivate=1&version=1'.format(auth_manager.username)
collection_xml = url_to_xml_object(url)
print(collection_xml.tag)
owned_collection_list: list[BoardGame] = []
for boardgame_item in collection_xml:
boardgame = convert_xml_to_boardgame(boardgame_item)
owned_collection_list.append(boardgame)
return owned_collection_list
def load_authenticated_bgg_session(username: str, password: str) -> requests.Session:
global authenticated_session
login_url = "https://boardgamegeek.com/login/api/v1"
post_data = {
"credentials":{
"username": username,
"password": password
}
}
assert len(authenticated_session.cookies) == 0, 'Session already exists'
login_response = authenticated_session.post(login_url, json=post_data)
assert login_response.status_code == 204, "Login failed!"
load_authenticated_bgg_session(auth_manager.username, auth_manager.password)