blizzard.py

import datetime
import requests


class BlizzardTools():
    """ Class of tools to facilitate authenticating and fetching basic information
        from Blizzard Entertainment WoW Profile API"""

    def __init__(self, auth_data):
        self.description = 'Consumes Blizzard WoW Profile API'
        self.domain = "api.blizzard.com"
        self.auth_domain = "battle.net"
        self.region = auth_data.get('region', "eu")
        self.base_url = f"https://{self.region}.{self.domain}"
        self.auth_url = f"https://{self.region}.{self.auth_domain}"
        self.client_id = auth_data['client_id']
        self.client_secret = auth_data['client_secret']
        self.headers = {
            'Content-Type': 'application/json',
        }
        self.jar = requests.cookies.RequestsCookieJar()
        self.session = requests.Session()
        self.auth = requests.auth.HTTPBasicAuth(self.client_id, self.client_secret)
        self.client_token = None
        self.ranks = {0: "Guild Master",
                      1: "Officer",
                      2: "Officer Alt",
                      3: "Raider",
                      4: "Veteran",
                      5: "Member",
                      6: "Alt",
                      7: "Initiate"}
        self.max_level = 60

    def _get(self, url=None, parameters=None, auth=None, response="json"):
        r = self.session.get(url=url, params=parameters, auth=auth, headers=self.headers,
                             cookies=self.jar)
        r.raise_for_status()
        if response == "text":
            return r.text
        elif response == "json":
            return r.json()

    def _post(self, url=None, parameters=None, payload=None, response="json"):
        if parameters is None:
            r = self.session.post(url=url, headers=self.headers, cookies=self.jar,
                                  data=payload)
        else:
            r = self.session.post(url=url, headers=self.headers,
                                  cookies=self.jar, params=parameters,
                                  data=payload)
        r.raise_for_status()
        if response == "text":
            return r.text
        elif response == "json":
            return r.json()

    def get_auth_token(self):
        url = f"{self.auth_url}/oauth/token"
        parameters = {"grant_type": "client_credentials"}
        self.client_token = self._get(url, auth=self.auth, parameters=parameters)
        # set internal expiration time conservatively, 5 seconds before upstream
        expiration_time = datetime.datetime.now() + datetime.timedelta(seconds=(self.client_token["expires_in"] - 86300))
        self.client_token["expiration_time"] = expiration_time
        self.headers['Authorization'] = f'Bearer {self.client_token["access_token"]}'
        return self.client_token

    def refresh_auth_token(self):
        now = datetime.datetime.now()
        if (self.client_token is None) or (self.client_token["expiration_time"] < now):
            self.get_auth_token()

    def get_character_profile(self, realm, char_name):
        url = f"{self.base_url}/profile/wow/character/{realm}/{char_name}"
        self.refresh_auth_token()
        parameters = {"namespace": f"profile-{self.region}",
                      "locale": "en_US",
                      "access_token": self.client_token["access_token"]}
        profile = self._get(url, parameters=parameters)
        return profile

    def get_guild_roster(self, realm, guild_name):
        url = f"{self.base_url}/data/wow/guild/{realm}/{guild_name}/roster"
        self.refresh_auth_token()
        parameters = {"namespace": f"profile-{self.region}",
                      "locale": "en_US",
                      "access_token": self.client_token["access_token"]}
        roster = self._get(url, parameters=parameters)
        return roster

    def get_raiders(self, realm, guild_name):
        roster = self.get_guild_roster(realm, guild_name)
        members = roster["members"]
        raiders = list()
        for member in members:
            rank = member["rank"]
            char_slug = member["character"]["name"].lower()
            realm_slug = member["character"]["realm"]["slug"]
            char_level = member["character"]["level"]
            if (char_level == self.max_level and rank in [0, 1, 3]):
                profile = self.get_character_profile(realm_slug, char_slug)
                char_name = profile["name"]
                realm_name = profile["realm"]["name"]
                player_class = profile["character_class"]["name"]
                player_spec = profile["active_spec"]["name"]
                ilvl = profile["average_item_level"]
                memberdetails = {"ilvl": ilvl,
                                 "name": char_name,
                                 "realm": realm_name,
                                 "class": player_class,
                                 "spec": player_spec,
                                 "role": self.ranks[rank]}
                raiders.append(memberdetails)
        return raiders