mirror of
https://github.com/home-assistant/supervisor.git
synced 2025-06-23 18:36:29 +00:00
e5451973bd
* Update homeassistant.py * Update validate.py * Update exceptions.py * Update services.py * Update discovery.py * fix gitignore * Fix handling for discovery * use object in ref * lock down discovery API * fix api * Design * Fix API * fix lint * fix * Fix security layer * add provide layer * fix access * change rating * fix rights * Fix API error handling * raise error * fix rights * api * fix handling * fix * debug * debug json * Fix validator * fix error * new url * fix schema
96 lines
2.7 KiB
Python
96 lines
2.7 KiB
Python
"""Init file for Hass.io util for RESTful API."""
|
|
import json
|
|
import logging
|
|
|
|
from aiohttp import web
|
|
import voluptuous as vol
|
|
from voluptuous.humanize import humanize_error
|
|
|
|
from ..const import (
|
|
JSON_RESULT, JSON_DATA, JSON_MESSAGE, RESULT_OK, RESULT_ERROR,
|
|
CONTENT_TYPE_BINARY)
|
|
from ..exceptions import HassioError, APIError, APIForbidden
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def json_loads(data):
|
|
"""Extract json from string with support for '' and None."""
|
|
if not data:
|
|
return {}
|
|
try:
|
|
return json.loads(data)
|
|
except json.JSONDecodeError:
|
|
raise APIError("Invalid json")
|
|
|
|
|
|
def api_process(method):
|
|
"""Wrap function with true/false calls to rest api."""
|
|
async def wrap_api(api, *args, **kwargs):
|
|
"""Return API information."""
|
|
try:
|
|
answer = await method(api, *args, **kwargs)
|
|
except (APIError, APIForbidden) as err:
|
|
return api_return_error(message=str(err))
|
|
except HassioError:
|
|
return api_return_error(message="Unknown Error, see logs")
|
|
|
|
if isinstance(answer, dict):
|
|
return api_return_ok(data=answer)
|
|
if isinstance(answer, web.Response):
|
|
return answer
|
|
elif isinstance(answer, bool) and not answer:
|
|
return api_return_error()
|
|
return api_return_ok()
|
|
|
|
return wrap_api
|
|
|
|
|
|
def api_process_raw(content):
|
|
"""Wrap content_type into function."""
|
|
def wrap_method(method):
|
|
"""Wrap function with raw output to rest api."""
|
|
async def wrap_api(api, *args, **kwargs):
|
|
"""Return api information."""
|
|
try:
|
|
msg_data = await method(api, *args, **kwargs)
|
|
msg_type = content
|
|
except (APIError, APIForbidden) as err:
|
|
msg_data = str(err).encode()
|
|
msg_type = CONTENT_TYPE_BINARY
|
|
except HassioError:
|
|
msg_data = b''
|
|
msg_type = CONTENT_TYPE_BINARY
|
|
|
|
return web.Response(body=msg_data, content_type=msg_type)
|
|
|
|
return wrap_api
|
|
return wrap_method
|
|
|
|
|
|
def api_return_error(message=None):
|
|
"""Return an API error message."""
|
|
return web.json_response({
|
|
JSON_RESULT: RESULT_ERROR,
|
|
JSON_MESSAGE: message,
|
|
}, status=400)
|
|
|
|
|
|
def api_return_ok(data=None):
|
|
"""Return an API ok answer."""
|
|
return web.json_response({
|
|
JSON_RESULT: RESULT_OK,
|
|
JSON_DATA: data or {},
|
|
})
|
|
|
|
|
|
async def api_validate(schema, request):
|
|
"""Validate request data with schema."""
|
|
data = await request.json(loads=json_loads)
|
|
try:
|
|
data = schema(data)
|
|
except vol.Invalid as ex:
|
|
raise APIError(humanize_error(data, ex)) from None
|
|
|
|
return data
|