mlb_dataadapter.py

from typing import Dict
from .exceptions import TheMlbStatsApiException
import requests
import logging


class MlbResult:
    """
    A class that holds data, status_code, and message returned from statsapi.mlb.com

    Attributes
    ----------
    status_code : int
        HTTP Return Code
    message : str
        Message returned from REST Endpoint
    data : dict
        JSON Data received from request
    """

    def __init__(self, status_code: int, message: str, data: Dict = {}):
        self.status_code = int(status_code)
        self.message = str(message)

        self.data = data
        if 'copyright' in data:
            del data['copyright']


class MlbDataAdapter:
    """
    Adapter for calling the mlb statsapi endpoint

    Attributes
    ----------
    hostname : str
        rest endpoint for data
    ver : str
        api version
    logger : logging.Logger
        instance of logger class
    """

    def __init__(self, hostname: str = 'statsapi.mlb.com', ver: str = 'v1', logger: logging.Logger = None):
        self.url = f'https://{hostname}/api/{ver}/'
        self._logger = logger or logging.getLogger(__name__)
        self._logger.setLevel(logging.DEBUG)

    def get(self, endpoint: str, ep_params: Dict = None, data: Dict = None) -> MlbResult:
        """
        return a MlbResult from endpoint

        Parameters
        ----------
        endpoint : str
            rest api endpoint
        ep_params : dict
            params
        data : dict
            data to send with requests (we aren't using this)

        Returns
        -------
        MlbResult
        """

        full_url = self.url + endpoint
        logline_pre = f'url={full_url}'
        logline_post = " ,".join((logline_pre, 'success={}, status_code={}, message={}, url={}'))

        try:
            self._logger.debug(logline_post)
            response = requests.get(url=full_url, params=ep_params)

        except requests.exceptions.RequestException as e:
            self._logger.error(msg=(str(e)))
            raise TheMlbStatsApiException('Request failed') from e

        try:
            data = response.json()

        except (ValueError, requests.JSONDecodeError) as e: 
            self._logger.error(msg=(str(e)))
            raise TheMlbStatsApiException('Bad JSON in response') from e

        if response.status_code <= 200 and response.status_code <= 299:
            self._logger.debug(msg=logline_post.format('success',
            response.status_code, response.reason, response.url))

            return MlbResult(response.status_code, message=response.reason, data=data)

        elif response.status_code >= 400 and response.status_code <= 499:  
            self._logger.error(msg=logline_post.format('Invalid Request',
            response.status_code, response.reason, response.url))

            # return MlbResult with 404 and empty data
            return MlbResult(response.status_code, message=response.reason, data={})

        elif response.status_code >= 500 and response.status_code <= 599:

            self._logger.error(msg=logline_post.format('Internal error occurred', 
            response.status_code, response.reason, response.url))

            raise TheMlbStatsApiException(f"{response.status_code}: {response.reason}")

        else:
            raise TheMlbStatsApiException(f"{response.status_code}: {response.reason}")