Prepare rachio for cloudhooks conversion (#33422)

Reorganize code in order to prepare for webhooks

homeassistant/components/rachio/webhooks.py

@@ -0,0 +1,96 @@
+"""Webhooks used by rachio."""
+
+import logging
+
+from aiohttp import web
+
+from homeassistant.components.http import HomeAssistantView
+from homeassistant.const import URL_API
+from homeassistant.helpers.dispatcher import async_dispatcher_send
+
+from .const import (
+    DOMAIN,
+    KEY_EXTERNAL_ID,
+    KEY_TYPE,
+    SIGNAL_RACHIO_CONTROLLER_UPDATE,
+    SIGNAL_RACHIO_SCHEDULE_UPDATE,
+    SIGNAL_RACHIO_ZONE_UPDATE,
+)
+
+# Device webhook values
+TYPE_CONTROLLER_STATUS = "DEVICE_STATUS"
+SUBTYPE_OFFLINE = "OFFLINE"
+SUBTYPE_ONLINE = "ONLINE"
+SUBTYPE_OFFLINE_NOTIFICATION = "OFFLINE_NOTIFICATION"
+SUBTYPE_COLD_REBOOT = "COLD_REBOOT"
+SUBTYPE_SLEEP_MODE_ON = "SLEEP_MODE_ON"
+SUBTYPE_SLEEP_MODE_OFF = "SLEEP_MODE_OFF"
+SUBTYPE_BROWNOUT_VALVE = "BROWNOUT_VALVE"
+SUBTYPE_RAIN_SENSOR_DETECTION_ON = "RAIN_SENSOR_DETECTION_ON"
+SUBTYPE_RAIN_SENSOR_DETECTION_OFF = "RAIN_SENSOR_DETECTION_OFF"
+SUBTYPE_RAIN_DELAY_ON = "RAIN_DELAY_ON"
+SUBTYPE_RAIN_DELAY_OFF = "RAIN_DELAY_OFF"
+
+# Schedule webhook values
+TYPE_SCHEDULE_STATUS = "SCHEDULE_STATUS"
+SUBTYPE_SCHEDULE_STARTED = "SCHEDULE_STARTED"
+SUBTYPE_SCHEDULE_STOPPED = "SCHEDULE_STOPPED"
+SUBTYPE_SCHEDULE_COMPLETED = "SCHEDULE_COMPLETED"
+SUBTYPE_WEATHER_NO_SKIP = "WEATHER_INTELLIGENCE_NO_SKIP"
+SUBTYPE_WEATHER_SKIP = "WEATHER_INTELLIGENCE_SKIP"
+SUBTYPE_WEATHER_CLIMATE_SKIP = "WEATHER_INTELLIGENCE_CLIMATE_SKIP"
+SUBTYPE_WEATHER_FREEZE = "WEATHER_INTELLIGENCE_FREEZE"
+
+# Zone webhook values
+TYPE_ZONE_STATUS = "ZONE_STATUS"
+SUBTYPE_ZONE_STARTED = "ZONE_STARTED"
+SUBTYPE_ZONE_STOPPED = "ZONE_STOPPED"
+SUBTYPE_ZONE_COMPLETED = "ZONE_COMPLETED"
+SUBTYPE_ZONE_CYCLING = "ZONE_CYCLING"
+SUBTYPE_ZONE_CYCLING_COMPLETED = "ZONE_CYCLING_COMPLETED"
+
+# Webhook callbacks
+LISTEN_EVENT_TYPES = ["DEVICE_STATUS_EVENT", "ZONE_STATUS_EVENT"]
+WEBHOOK_CONST_ID = "homeassistant.rachio:"
+WEBHOOK_PATH = URL_API + DOMAIN
+
+SIGNAL_MAP = {
+    TYPE_CONTROLLER_STATUS: SIGNAL_RACHIO_CONTROLLER_UPDATE,
+    TYPE_SCHEDULE_STATUS: SIGNAL_RACHIO_SCHEDULE_UPDATE,
+    TYPE_ZONE_STATUS: SIGNAL_RACHIO_ZONE_UPDATE,
+}
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class RachioWebhookView(HomeAssistantView):
+    """Provide a page for the server to call."""
+
+    requires_auth = False  # Handled separately
+
+    def __init__(self, entry_id, webhook_url):
+        """Initialize the instance of the view."""
+        self._entry_id = entry_id
+        self.url = webhook_url
+        self.name = webhook_url[1:].replace("/", ":")
+        _LOGGER.debug(
+            "Initialize webhook at url: %s, with name %s", self.url, self.name
+        )
+
+    async def post(self, request) -> web.Response:
+        """Handle webhook calls from the server."""
+        hass = request.app["hass"]
+        data = await request.json()
+
+        try:
+            auth = data.get(KEY_EXTERNAL_ID, str()).split(":")[1]
+            assert auth == hass.data[DOMAIN][self._entry_id].rachio.webhook_auth
+        except (AssertionError, IndexError):
+            return web.Response(status=web.HTTPForbidden.status_code)
+
+        update_type = data[KEY_TYPE]
+        if update_type in SIGNAL_MAP:
+            async_dispatcher_send(hass, SIGNAL_MAP[update_type], data)
+
+        return web.Response(status=web.HTTPNoContent.status_code)