From 4e020b90e113135225c86ce0ddd8712a21a0f145 Mon Sep 17 00:00:00 2001 From: Rohan Kapoor Date: Sat, 12 Jan 2019 19:18:33 -0800 Subject: [PATCH] Switch locative to use the webhook component --- .../components/locative/.translations/en.json | 18 +++ homeassistant/components/locative/__init__.py | 144 +++++++++--------- .../components/locative/strings.json | 18 +++ homeassistant/config_entries.py | 1 + tests/components/locative/test_init.py | 71 ++++++--- 5 files changed, 158 insertions(+), 94 deletions(-) create mode 100644 homeassistant/components/locative/.translations/en.json create mode 100644 homeassistant/components/locative/strings.json diff --git a/homeassistant/components/locative/.translations/en.json b/homeassistant/components/locative/.translations/en.json new file mode 100644 index 00000000000..b2a538a0fa5 --- /dev/null +++ b/homeassistant/components/locative/.translations/en.json @@ -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." + } + } +} \ No newline at end of file diff --git a/homeassistant/components/locative/__init__.py b/homeassistant/components/locative/__init__.py index 1f924987dd3..7a4cfcc991b 100644 --- a/homeassistant/components/locative/__init__.py +++ b/homeassistant/components/locative/__init__.py @@ -8,76 +8,72 @@ import logging 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 +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) 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.""" + data = await request.post() - url = URL - name = 'api:locative' + if 'latitude' not in data or 'longitude' not in data: + return ('Latitude and longitude not specified.', + HTTP_UNPROCESSABLE_ENTITY) - def __init__(self): - """Initialize Locative URL endpoints.""" + if 'device' not in data: + _LOGGER.error('Device id not specified.') + return ('Device id not specified.', + HTTP_UNPROCESSABLE_ENTITY) - async def get(self, request): - """Locative message received as GET.""" - return await self._handle(request.app['hass'], request.query) + if 'trigger' not in data: + _LOGGER.error('Trigger is not specified.') + return ('Trigger is not specified.', + HTTP_UNPROCESSABLE_ENTITY) - async def post(self, request): - """Locative message received.""" - data = await request.post() - return await self._handle(request.app['hass'], data) + if 'id' not in data and data['trigger'] != 'test': + _LOGGER.error('Location id not specified.') + return ('Location id not specified.', + HTTP_UNPROCESSABLE_ENTITY) - 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) + device = data['device'].replace('-', '') + location_name = data.get('id', data['trigger']).lower() + direction = data['trigger'] + gps_location = (data[ATTR_LATITUDE], data[ATTR_LONGITUDE]) - if 'device' not in data: - _LOGGER.error('Device id not specified.') - return ('Device id not specified.', - HTTP_UNPROCESSABLE_ENTITY) + if direction == 'enter': + async_dispatcher_send( + hass, + TRACKER_UPDATE, + device, + gps_location, + location_name + ) + return 'Setting location to {}'.format(location_name) - if 'trigger' not in data: - _LOGGER.error('Trigger is not specified.') - return ('Trigger is not specified.', - HTTP_UNPROCESSABLE_ENTITY) + if direction == 'exit': + current_state = hass.states.get( + '{}.{}'.format(DEVICE_TRACKER_DOMAIN, device)) - 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 +81,42 @@ class LocativeView(HomeAssistantView): gps_location, location_name ) - return 'Setting location to {}'.format(location_name) + return 'Setting location to not home' - 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 'Ignoring exit from {} (already in {})'.format( + location_name, current_state) - 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 'Received test message.' - # 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 ('Received unidentified message: {}'.format(direction), + 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/' + } +) \ No newline at end of file diff --git a/homeassistant/components/locative/strings.json b/homeassistant/components/locative/strings.json new file mode 100644 index 00000000000..b2a538a0fa5 --- /dev/null +++ b/homeassistant/components/locative/strings.json @@ -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." + } + } +} \ No newline at end of file diff --git a/homeassistant/config_entries.py b/homeassistant/config_entries.py index dde542e5fc0..fbc44b3775e 100644 --- a/homeassistant/config_entries.py +++ b/homeassistant/config_entries.py @@ -148,6 +148,7 @@ FLOWS = [ 'ifttt', 'ios', 'lifx', + 'locative', 'luftdaten', 'mailgun', 'mqtt', diff --git a/tests/components/locative/test_init.py b/tests/components/locative/test_init.py index 50c72f468af..067bb73236b 100644 --- a/tests/components/locative/test_init.py +++ b/tests/components/locative/test_init.py @@ -1,11 +1,12 @@ """The tests the for Locative device tracker platform.""" -from unittest.mock import patch +from unittest.mock import patch, Mock import pytest +from homeassistant import data_entry_flow from homeassistant.components.device_tracker import \ DOMAIN as DEVICE_TRACKER_DOMAIN -from homeassistant.components.locative import URL, DOMAIN +from homeassistant.components.locative import DOMAIN from homeassistant.const import HTTP_OK, HTTP_UNPROCESSABLE_ENTITY from homeassistant.setup import async_setup_component @@ -36,8 +37,26 @@ def locative_client(loop, hass, hass_client): yield loop.run_until_complete(hass_client()) -async def test_missing_data(locative_client): +@pytest.fixture +async def webhook_id(hass, locative_client): + """Initialize the Geofency component and get the webhook_id.""" + hass.config.api = Mock(base_url='http://example.com') + result = await hass.config_entries.flow.async_init('locative', context={ + 'source': 'user' + }) + assert result['type'] == data_entry_flow.RESULT_TYPE_FORM, result + + result = await hass.config_entries.flow.async_configure( + result['flow_id'], {}) + assert result['type'] == data_entry_flow.RESULT_TYPE_CREATE_ENTRY + + return result['result'].data['webhook_id'] + + +async def test_missing_data(locative_client, webhook_id): """Test missing data.""" + url = '/api/webhook/{}'.format(webhook_id) + data = { 'latitude': 1.0, 'longitude': 1.1, @@ -47,55 +66,57 @@ async def test_missing_data(locative_client): } # No data - req = await locative_client.get(_url({})) + req = await locative_client.post(url) assert req.status == HTTP_UNPROCESSABLE_ENTITY # No latitude copy = data.copy() del copy['latitude'] - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_UNPROCESSABLE_ENTITY # No device copy = data.copy() del copy['device'] - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_UNPROCESSABLE_ENTITY # No location copy = data.copy() del copy['id'] - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_UNPROCESSABLE_ENTITY # No trigger copy = data.copy() del copy['trigger'] - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_UNPROCESSABLE_ENTITY # Test message copy = data.copy() copy['trigger'] = 'test' - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_OK # Test message, no location copy = data.copy() copy['trigger'] = 'test' del copy['id'] - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_OK # Unknown trigger copy = data.copy() copy['trigger'] = 'foobar' - req = await locative_client.get(_url(copy)) + req = await locative_client.post(url, data=copy) assert req.status == HTTP_UNPROCESSABLE_ENTITY -async def test_enter_and_exit(hass, locative_client): +async def test_enter_and_exit(hass, locative_client, webhook_id): """Test when there is a known zone.""" + url = '/api/webhook/{}'.format(webhook_id) + data = { 'latitude': 40.7855, 'longitude': -111.7367, @@ -105,7 +126,7 @@ async def test_enter_and_exit(hass, locative_client): } # Enter the Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK state_name = hass.states.get('{}.{}'.format(DEVICE_TRACKER_DOMAIN, @@ -116,7 +137,7 @@ async def test_enter_and_exit(hass, locative_client): data['trigger'] = 'exit' # Exit Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK state_name = hass.states.get('{}.{}'.format(DEVICE_TRACKER_DOMAIN, @@ -127,7 +148,7 @@ async def test_enter_and_exit(hass, locative_client): data['trigger'] = 'enter' # Enter Home again - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK state_name = hass.states.get('{}.{}'.format(DEVICE_TRACKER_DOMAIN, @@ -137,7 +158,7 @@ async def test_enter_and_exit(hass, locative_client): data['trigger'] = 'exit' # Exit Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK state_name = hass.states.get('{}.{}'.format(DEVICE_TRACKER_DOMAIN, @@ -148,7 +169,7 @@ async def test_enter_and_exit(hass, locative_client): data['trigger'] = 'enter' # Enter Work - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK state_name = hass.states.get('{}.{}'.format(DEVICE_TRACKER_DOMAIN, @@ -156,8 +177,10 @@ async def test_enter_and_exit(hass, locative_client): assert 'work' == state_name -async def test_exit_after_enter(hass, locative_client): +async def test_exit_after_enter(hass, locative_client, webhook_id): """Test when an exit message comes after an enter message.""" + url = '/api/webhook/{}'.format(webhook_id) + data = { 'latitude': 40.7855, 'longitude': -111.7367, @@ -167,7 +190,7 @@ async def test_exit_after_enter(hass, locative_client): } # Enter Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK @@ -178,7 +201,7 @@ async def test_exit_after_enter(hass, locative_client): data['id'] = 'Work' # Enter Work - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK @@ -190,7 +213,7 @@ async def test_exit_after_enter(hass, locative_client): data['trigger'] = 'exit' # Exit Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK @@ -199,8 +222,10 @@ async def test_exit_after_enter(hass, locative_client): assert state.state == 'work' -async def test_exit_first(hass, locative_client): +async def test_exit_first(hass, locative_client, webhook_id): """Test when an exit message is sent first on a new device.""" + url = '/api/webhook/{}'.format(webhook_id) + data = { 'latitude': 40.7855, 'longitude': -111.7367, @@ -210,7 +235,7 @@ async def test_exit_first(hass, locative_client): } # Exit Home - req = await locative_client.get(_url(data)) + req = await locative_client.post(url, data=data) await hass.async_block_till_done() assert req.status == HTTP_OK