import logging
import json
import aiohttp
from .exceptions import HostError, ResourceError, ResourceTypeError
_LOGGER = logging.getLogger(__name__)
RES_CONF = "/config"
[docs]class Controller:
"""Controller class representing one nodejs-poolController
"""
def __init__(self, session: aiohttp.ClientSession, host: str, port: int) -> None:
"""Initialize with connection parameters
Parameters
----------
session : aiohttp.ClientSession
'aiohttp.ClientSession' to use for connection to controller
host : str
Hostname or IP address to controller
port : int
Port number to controller. Typically 4200
"""
self.session = session
self._rh = _RequestsHandler(session, host, port)
[docs] async def checkconnect(self) -> bool:
"""Check successful connection by inspecting returned controller version
Returns
-------
bool
True for successful connection
"""
try:
data = await self._rh.get(RES_CONF)
except HostError:
return False
return bool(not data['appVersion'] == "")
[docs]class _RequestsHandler:
"""Handler class to manage http requests to the controller
"""
def __init__(self, session: aiohttp.ClientSession, host: str, port):
self.headers = {"Accept": "application/json"}
self.scheme = "http"
self.session = session
self.host = host
self.port = port
[docs] async def get(self, resource: str) -> str:
"""Method to get resource from Pool Controller API
Parameters
----------
resource : str
Resource to get with leading '/'
Returns
-------
str
String representing resource body
Raises
------
ResourceTypeError
Error raised when ContentType is not application/json
HostError
Error raised when Host refuses connection
ResourceError
Error raised when Resource return status code >= 400
"""
data = []
url = f"{self.scheme}://{self.host}:{self.port}{resource}"
try:
async with self.session.get(
url,
headers=self.headers,
raise_for_status=True
) as resp:
try:
data = await resp.json()
except aiohttp.ContentTypeError as error:
_LOGGER.debug(repr(error))
raise ResourceTypeError(error.request_info.url) from error
else:
_LOGGER.debug(json.dumps(data))
return data
except aiohttp.ClientConnectorError as error:
_LOGGER.warning(
"Connection to PoolController failed: %s://%s:%s",
self.scheme,
self.host,
self.port)
_LOGGER.debug(repr(error))
raise HostError(error.host, error.port) from error
except aiohttp.ClientResponseError as error:
_LOGGER.warning("Received unexpected response for resource: %s", resource)
_LOGGER.debug(repr(error))
raise ResourceError(error.status, error.request_info.url) from error
else:
_LOGGER.debug(
"Connected to PoolController: %s://%s:%s",
self.scheme,
self.host,
self.port)