Switch locative to use the webhook component (#20043)
* Switch locative to use the webhook component * Lint * Remove dead test code * Use voluptuous to validate the webhook schema * Validate test mode schema as well * Lint * Remove allow_extra * Return web.Response correctly * #20043: Remove superfluous dict in WEBHOOK_SCHEMA validation
This commit is contained in:
5 files changed
+197
-106
No files matched your search
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"config": {
|
||||
"title": "Locative Webhook",
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "Set up the Locative Webhook",
|
||||
"description": "Are you sure you want to set up the Locative Webhook?"
|
||||
}
|
||||
},
|
||||
"abort": {
|
||||
"one_instance_allowed": "Only a single instance is necessary.",
|
||||
"not_internet_accessible": "Your Home Assistant instance needs to be accessible from the internet to receive messages from Geofency."
|
||||
},
|
||||
"create_entry": {
|
||||
"default": "To send locations to Home Assistant, you will need to setup the webhook feature in the Locative app.\n\nFill in the following info:\n\n- URL: `{webhook_url}`\n- Method: POST\n\nSee [the documentation]({docs_url}) for further details."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -5,79 +5,98 @@ For more details about this component, please refer to the documentation at
|
||||
https://home-assistant.io/components/locative/
|
||||
"""
|
||||
import logging
|
||||
from typing import Dict
|
||||
|
||||
import voluptuous as vol
|
||||
from aiohttp import web
|
||||
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.components.device_tracker import \
|
||||
DOMAIN as DEVICE_TRACKER_DOMAIN
|
||||
from homeassistant.components.http import HomeAssistantView
|
||||
from homeassistant.const import HTTP_UNPROCESSABLE_ENTITY, ATTR_LATITUDE, \
|
||||
ATTR_LONGITUDE, STATE_NOT_HOME
|
||||
ATTR_LONGITUDE, STATE_NOT_HOME, CONF_WEBHOOK_ID, ATTR_ID, HTTP_OK
|
||||
from homeassistant.helpers import config_entry_flow
|
||||
from homeassistant.helpers.discovery import async_load_platform
|
||||
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
DOMAIN = 'locative'
|
||||
DEPENDENCIES = ['http']
|
||||
|
||||
URL = '/api/locative'
|
||||
DEPENDENCIES = ['webhook']
|
||||
|
||||
TRACKER_UPDATE = '{}_tracker_update'.format(DOMAIN)
|
||||
|
||||
|
||||
ATTR_DEVICE_ID = 'device'
|
||||
ATTR_TRIGGER = 'trigger'
|
||||
|
||||
|
||||
def _id(value: str) -> str:
|
||||
"""Coerce id by removing '-'."""
|
||||
return value.replace('-', '')
|
||||
|
||||
|
||||
def _validate_test_mode(obj: Dict) -> Dict:
|
||||
"""Validate that id is provided outside of test mode."""
|
||||
if ATTR_ID not in obj and obj[ATTR_TRIGGER] != 'test':
|
||||
raise vol.Invalid('Location id not specified')
|
||||
return obj
|
||||
|
||||
|
||||
WEBHOOK_SCHEMA = vol.All(
|
||||
vol.Schema({
|
||||
vol.Required(ATTR_LATITUDE): cv.latitude,
|
||||
vol.Required(ATTR_LONGITUDE): cv.longitude,
|
||||
vol.Required(ATTR_DEVICE_ID): cv.string,
|
||||
vol.Required(ATTR_TRIGGER): cv.string,
|
||||
vol.Optional(ATTR_ID): vol.All(cv.string, _id)
|
||||
}),
|
||||
_validate_test_mode
|
||||
)
|
||||
|
||||
|
||||
async def async_setup(hass, hass_config):
|
||||
"""Set up the Locative component."""
|
||||
hass.http.register_view(LocativeView)
|
||||
hass.async_create_task(
|
||||
async_load_platform(hass, 'device_tracker', DOMAIN, {}, hass_config)
|
||||
)
|
||||
return True
|
||||
|
||||
|
||||
class LocativeView(HomeAssistantView):
|
||||
"""View to handle Locative requests."""
|
||||
async def handle_webhook(hass, webhook_id, request):
|
||||
"""Handle incoming webhook from Locative."""
|
||||
try:
|
||||
data = WEBHOOK_SCHEMA(dict(await request.post()))
|
||||
except vol.MultipleInvalid as error:
|
||||
return web.Response(
|
||||
body=error.error_message,
|
||||
status=HTTP_UNPROCESSABLE_ENTITY
|
||||
)
|
||||
|
||||
url = URL
|
||||
name = 'api:locative'
|
||||
device = data[ATTR_DEVICE_ID]
|
||||
location_name = data.get(ATTR_ID, data[ATTR_TRIGGER]).lower()
|
||||
direction = data[ATTR_TRIGGER]
|
||||
gps_location = (data[ATTR_LATITUDE], data[ATTR_LONGITUDE])
|
||||
|
||||
def __init__(self):
|
||||
"""Initialize Locative URL endpoints."""
|
||||
if direction == 'enter':
|
||||
async_dispatcher_send(
|
||||
hass,
|
||||
TRACKER_UPDATE,
|
||||
device,
|
||||
gps_location,
|
||||
location_name
|
||||
)
|
||||
return web.Response(
|
||||
body='Setting location to {}'.format(location_name),
|
||||
status=HTTP_OK
|
||||
)
|
||||
|
||||
async def get(self, request):
|
||||
"""Locative message received as GET."""
|
||||
return await self._handle(request.app['hass'], request.query)
|
||||
if direction == 'exit':
|
||||
current_state = hass.states.get(
|
||||
'{}.{}'.format(DEVICE_TRACKER_DOMAIN, device))
|
||||
|
||||
async def post(self, request):
|
||||
"""Locative message received."""
|
||||
data = await request.post()
|
||||
return await self._handle(request.app['hass'], data)
|
||||
|
||||
async def _handle(self, hass, data):
|
||||
"""Handle locative request."""
|
||||
if 'latitude' not in data or 'longitude' not in data:
|
||||
return ('Latitude and longitude not specified.',
|
||||
HTTP_UNPROCESSABLE_ENTITY)
|
||||
|
||||
if 'device' not in data:
|
||||
_LOGGER.error('Device id not specified.')
|
||||
return ('Device id not specified.',
|
||||
HTTP_UNPROCESSABLE_ENTITY)
|
||||
|
||||
if 'trigger' not in data:
|
||||
_LOGGER.error('Trigger is not specified.')
|
||||
return ('Trigger is not specified.',
|
||||
HTTP_UNPROCESSABLE_ENTITY)
|
||||
|
||||
if 'id' not in data and data['trigger'] != 'test':
|
||||
_LOGGER.error('Location id not specified.')
|
||||
return ('Location id not specified.',
|
||||
HTTP_UNPROCESSABLE_ENTITY)
|
||||
|
||||
device = data['device'].replace('-', '')
|
||||
location_name = data.get('id', data['trigger']).lower()
|
||||
direction = data['trigger']
|
||||
gps_location = (data[ATTR_LATITUDE], data[ATTR_LONGITUDE])
|
||||
|
||||
if direction == 'enter':
|
||||
if current_state is None or current_state.state == location_name:
|
||||
location_name = STATE_NOT_HOME
|
||||
async_dispatcher_send(
|
||||
hass,
|
||||
TRACKER_UPDATE,
|
||||
@@ -85,36 +104,54 @@ class LocativeView(HomeAssistantView):
|
||||
gps_location,
|
||||
location_name
|
||||
)
|
||||
return 'Setting location to {}'.format(location_name)
|
||||
return web.Response(
|
||||
body='Setting location to not home',
|
||||
status=HTTP_OK
|
||||
)
|
||||
|
||||
if direction == 'exit':
|
||||
current_state = hass.states.get(
|
||||
'{}.{}'.format(DEVICE_TRACKER_DOMAIN, device))
|
||||
# Ignore the message if it is telling us to exit a zone that we
|
||||
# aren't currently in. This occurs when a zone is entered
|
||||
# before the previous zone was exited. The enter message will
|
||||
# be sent first, then the exit message will be sent second.
|
||||
return web.Response(
|
||||
body='Ignoring exit from {} (already in {})'.format(
|
||||
location_name, current_state
|
||||
),
|
||||
status=HTTP_OK
|
||||
)
|
||||
|
||||
if current_state is None or current_state.state == location_name:
|
||||
location_name = STATE_NOT_HOME
|
||||
async_dispatcher_send(
|
||||
hass,
|
||||
TRACKER_UPDATE,
|
||||
device,
|
||||
gps_location,
|
||||
location_name
|
||||
)
|
||||
return 'Setting location to not home'
|
||||
if direction == 'test':
|
||||
# In the app, a test message can be sent. Just return something to
|
||||
# the user to let them know that it works.
|
||||
return web.Response(
|
||||
body='Received test message.',
|
||||
status=HTTP_OK
|
||||
)
|
||||
|
||||
# Ignore the message if it is telling us to exit a zone that we
|
||||
# aren't currently in. This occurs when a zone is entered
|
||||
# before the previous zone was exited. The enter message will
|
||||
# be sent first, then the exit message will be sent second.
|
||||
return 'Ignoring exit from {} (already in {})'.format(
|
||||
location_name, current_state)
|
||||
_LOGGER.error('Received unidentified message from Locative: %s',
|
||||
direction)
|
||||
return web.Response(
|
||||
body='Received unidentified message: {}'.format(direction),
|
||||
status=HTTP_UNPROCESSABLE_ENTITY
|
||||
)
|
||||
|
||||
if direction == 'test':
|
||||
# In the app, a test message can be sent. Just return something to
|
||||
# the user to let them know that it works.
|
||||
return 'Received test message.'
|
||||
|
||||
_LOGGER.error('Received unidentified message from Locative: %s',
|
||||
direction)
|
||||
return ('Received unidentified message: {}'.format(direction),
|
||||
HTTP_UNPROCESSABLE_ENTITY)
|
||||
async def async_setup_entry(hass, entry):
|
||||
"""Configure based on config entry."""
|
||||
hass.components.webhook.async_register(
|
||||
DOMAIN, 'Locative', entry.data[CONF_WEBHOOK_ID], handle_webhook)
|
||||
return True
|
||||
|
||||
|
||||
async def async_unload_entry(hass, entry):
|
||||
"""Unload a config entry."""
|
||||
hass.components.webhook.async_unregister(entry.data[CONF_WEBHOOK_ID])
|
||||
return True
|
||||
|
||||
config_entry_flow.register_webhook_flow(
|
||||
DOMAIN,
|
||||
'Locative Webhook',
|
||||
{
|
||||
'docs_url': 'https://www.home-assistant.io/components/locative/'
|
||||
}
|
||||
)
|
||||
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"config": {
|
||||
"title": "Locative Webhook",
|
||||
"step": {
|
||||
"user": {
|
||||
"title": "Set up the Locative Webhook",
|
||||
"description": "Are you sure you want to set up the Locative Webhook?"
|
||||
}
|
||||
},
|
||||
"abort": {
|
||||
"one_instance_allowed": "Only a single instance is necessary.",
|
||||
"not_internet_accessible": "Your Home Assistant instance needs to be accessible from the internet to receive messages from Geofency."
|
||||
},
|
||||
"create_entry": {
|
||||
"default": "To send locations to Home Assistant, you will need to setup the webhook feature in the Locative app.\n\nFill in the following info:\n\n- URL: `{webhook_url}`\n- Method: POST\n\nSee [the documentation]({docs_url}) for further details."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -149,6 +149,7 @@ FLOWS = [
|
||||
'ifttt',
|
||||
'ios',
|
||||
'lifx',
|
||||
'locative',
|
||||
'luftdaten',
|
||||
'mailgun',
|
||||
'mqtt',
|
||||
|
||||
Reference in new issue
Block a user