Convert Pollen.com sensor into IQVIA component (#22986)

* Moved pollen integration to iqvia

* Stitched in new library

* Added __init__

* Completed component v1

* Updated requirements

* Updated CODEOWNERS

* Updated .coveragerc

* Removed requirements

* Static check

.coveragerc

@@ -278,6 +278,7 @@ omit =
     homeassistant/components/ios/*
     homeassistant/components/iota/*
     homeassistant/components/iperf3/*
+    homeassistant/components/iqvia/*
     homeassistant/components/irish_rail_transport/sensor.py
     homeassistant/components/iss/binary_sensor.py
     homeassistant/components/isy994/*
@@ -441,7 +442,6 @@ omit =
     homeassistant/components/plum_lightpad/*
     homeassistant/components/pocketcasts/sensor.py
     homeassistant/components/point/*
-    homeassistant/components/pollen/sensor.py
     homeassistant/components/postnl/sensor.py
     homeassistant/components/prezzibenzina/sensor.py
     homeassistant/components/proliphix/climate.py

CODEOWNERS

@@ -117,6 +117,7 @@ homeassistant/components/input_text/* @home-assistant/core
 homeassistant/components/integration/* @dgomes
 homeassistant/components/ios/* @robbiet480
 homeassistant/components/ipma/* @dgomes
+homeassistant/components/iqvia/* @bachya
 homeassistant/components/irish_rail_transport/* @ttroy50
 homeassistant/components/jewish_calendar/* @tsvi
 homeassistant/components/knx/* @Julius2342
@@ -170,7 +171,6 @@ homeassistant/components/persistent_notification/* @home-assistant/core
 homeassistant/components/pi_hole/* @fabaff
 homeassistant/components/plant/* @ChristianKuehnel
 homeassistant/components/point/* @fredrike
-homeassistant/components/pollen/* @bachya
 homeassistant/components/ps4/* @ktnrg45
 homeassistant/components/push/* @dgomes
 homeassistant/components/pvoutput/* @fabaff

homeassistant/components/iqvia/__init__.py

@@ -0,0 +1,238 @@
+"""Support for IQVIA."""
+from datetime import timedelta
+import logging
+
+import voluptuous as vol
+
+from homeassistant.const import (
+    ATTR_ATTRIBUTION, CONF_MONITORED_CONDITIONS, CONF_SCAN_INTERVAL)
+from homeassistant.core import callback
+from homeassistant.helpers import (
+    aiohttp_client, config_validation as cv, discovery)
+from homeassistant.helpers.dispatcher import (
+    async_dispatcher_connect, async_dispatcher_send)
+from homeassistant.helpers.entity import Entity
+from homeassistant.helpers.event import async_track_time_interval
+
+from .const import (
+    DATA_CLIENT, DATA_LISTENER, DOMAIN, SENSORS, TOPIC_DATA_UPDATE,
+    TYPE_ALLERGY_FORECAST, TYPE_ALLERGY_HISTORIC, TYPE_ALLERGY_INDEX,
+    TYPE_ALLERGY_OUTLOOK, TYPE_ALLERGY_TODAY, TYPE_ALLERGY_TOMORROW,
+    TYPE_ALLERGY_YESTERDAY, TYPE_ASTHMA_FORECAST, TYPE_ASTHMA_HISTORIC,
+    TYPE_ASTHMA_INDEX, TYPE_ASTHMA_TODAY, TYPE_ASTHMA_TOMORROW,
+    TYPE_ASTHMA_YESTERDAY, TYPE_DISEASE_FORECAST)
+
+_LOGGER = logging.getLogger(__name__)
+
+CONF_ZIP_CODE = 'zip_code'
+
+DATA_CONFIG = 'config'
+
+DEFAULT_ATTRIBUTION = 'Data provided by IQVIA™'
+DEFAULT_SCAN_INTERVAL = timedelta(minutes=30)
+
+NOTIFICATION_ID = 'iqvia_setup'
+NOTIFICATION_TITLE = 'IQVIA Setup'
+
+CONFIG_SCHEMA = vol.Schema({
+    DOMAIN: vol.Schema({
+        vol.Required(CONF_ZIP_CODE): str,
+        vol.Required(CONF_MONITORED_CONDITIONS, default=list(SENSORS)):
+            vol.All(cv.ensure_list, [vol.In(SENSORS)])
+    })
+}, extra=vol.ALLOW_EXTRA)
+
+
+async def async_setup(hass, config):
+    """Set up the IQVIA component."""
+    from pyiqvia import Client
+    from pyiqvia.errors import IQVIAError
+
+    hass.data[DOMAIN] = {}
+    hass.data[DOMAIN][DATA_CLIENT] = {}
+    hass.data[DOMAIN][DATA_LISTENER] = {}
+
+    if DOMAIN not in config:
+        return True
+
+    conf = config[DOMAIN]
+
+    websession = aiohttp_client.async_get_clientsession(hass)
+
+    try:
+        iqvia = IQVIAData(
+            Client(conf[CONF_ZIP_CODE], websession),
+            conf[CONF_MONITORED_CONDITIONS])
+        await iqvia.async_update()
+    except IQVIAError as err:
+        _LOGGER.error('Unable to set up IQVIA: %s', err)
+        hass.components.persistent_notification.create(
+            'Error: {0}<br />'
+            'You will need to restart hass after fixing.'
+            ''.format(err),
+            title=NOTIFICATION_TITLE,
+            notification_id=NOTIFICATION_ID)
+        return False
+
+    hass.data[DOMAIN][DATA_CLIENT] = iqvia
+
+    discovery.load_platform(hass, 'sensor', DOMAIN, {}, conf)
+
+    async def refresh(event_time):
+        """Refresh IQVIA data."""
+        _LOGGER.debug('Updating IQVIA data')
+        await iqvia.async_update()
+        async_dispatcher_send(hass, TOPIC_DATA_UPDATE)
+
+    hass.data[DOMAIN][DATA_LISTENER] = async_track_time_interval(
+        hass, refresh,
+        timedelta(
+            seconds=conf.get(
+                CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL.seconds)))
+
+    return True
+
+
+class IQVIAData:
+    """Define a data object to retrieve info from IQVIA."""
+
+    def __init__(self, client, sensor_types):
+        """Initialize."""
+        self._client = client
+        self.data = {}
+        self.sensor_types = sensor_types
+        self.zip_code = client.zip_code
+
+    async def _get_data(self, method, key):
+        """Return API data from a specific call."""
+        from pyiqvia.errors import IQVIAError
+
+        try:
+            data = await method()
+            self.data[key] = data
+        except IQVIAError as err:
+            _LOGGER.error('Unable to get "%s" data: %s', key, err)
+            self.data[key] = {}
+
+    async def async_update(self):
+        """Update IQVIA data."""
+        from pyiqvia.errors import InvalidZipError
+
+        # IQVIA sites require a bit more complicated error handling, given that
+        # it sometimes has parts (but not the whole thing) go down:
+        #
+        # 1. If `InvalidZipError` is thrown, quit everything immediately.
+        # 2. If an individual request throws any other error, try the others.
+        try:
+            if TYPE_ALLERGY_FORECAST in self.sensor_types:
+                await self._get_data(
+                    self._client.allergens.extended, TYPE_ALLERGY_FORECAST)
+                await self._get_data(
+                    self._client.allergens.outlook, TYPE_ALLERGY_OUTLOOK)
+
+            if TYPE_ALLERGY_HISTORIC in self.sensor_types:
+                await self._get_data(
+                    self._client.allergens.historic, TYPE_ALLERGY_HISTORIC)
+
+            if any(s in self.sensor_types
+                   for s in [TYPE_ALLERGY_TODAY, TYPE_ALLERGY_TOMORROW,
+                             TYPE_ALLERGY_YESTERDAY]):
+                await self._get_data(
+                    self._client.allergens.current, TYPE_ALLERGY_INDEX)
+
+            if TYPE_ASTHMA_FORECAST in self.sensor_types:
+                await self._get_data(
+                    self._client.asthma.extended, TYPE_ASTHMA_FORECAST)
+
+            if TYPE_ASTHMA_HISTORIC in self.sensor_types:
+                await self._get_data(
+                    self._client.asthma.historic, TYPE_ASTHMA_HISTORIC)
+
+            if any(s in self.sensor_types
+                   for s in [TYPE_ASTHMA_TODAY, TYPE_ASTHMA_TOMORROW,
+                             TYPE_ASTHMA_YESTERDAY]):
+                await self._get_data(
+                    self._client.asthma.current, TYPE_ASTHMA_INDEX)
+
+            if TYPE_DISEASE_FORECAST in self.sensor_types:
+                await self._get_data(
+                    self._client.disease.extended, TYPE_DISEASE_FORECAST)
+
+            _LOGGER.debug("New data retrieved: %s", self.data)
+        except InvalidZipError:
+            _LOGGER.error(
+                "Cannot retrieve data for ZIP code: %s", self._client.zip_code)
+            self.data = {}
+
+
+class IQVIAEntity(Entity):
+    """Define a base IQVIA entity."""
+
+    def __init__(self, iqvia, kind, name, icon, zip_code):
+        """Initialize the sensor."""
+        self._async_unsub_dispatcher_connect = None
+        self._attrs = {ATTR_ATTRIBUTION: DEFAULT_ATTRIBUTION}
+        self._icon = icon
+        self._iqvia = iqvia
+        self._kind = kind
+        self._name = name
+        self._state = None
+        self._zip_code = zip_code
+
+    @property
+    def available(self):
+        """Return True if entity is available."""
+        if self._kind in (TYPE_ALLERGY_TODAY, TYPE_ALLERGY_TOMORROW,
+                          TYPE_ALLERGY_YESTERDAY):
+            return self._iqvia.data.get(TYPE_ALLERGY_INDEX) is not None
+
+        if self._kind in (TYPE_ASTHMA_TODAY, TYPE_ASTHMA_TOMORROW,
+                          TYPE_ASTHMA_YESTERDAY):
+            return self._iqvia.data.get(TYPE_ASTHMA_INDEX) is not None
+
+        return self._iqvia.data.get(self._kind) is not None
+
+    @property
+    def device_state_attributes(self):
+        """Return the device state attributes."""
+        return self._attrs
+
+    @property
+    def icon(self):
+        """Return the icon."""
+        return self._icon
+
+    @property
+    def name(self):
+        """Return the name."""
+        return self._name
+
+    @property
+    def state(self):
+        """Return the state."""
+        return self._state
+
+    @property
+    def unique_id(self):
+        """Return a unique, HASS-friendly identifier for this entity."""
+        return '{0}_{1}'.format(self._zip_code, self._kind)
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit the value is expressed in."""
+        return 'index'
+
+    async def async_added_to_hass(self):
+        """Register callbacks."""
+        @callback
+        def update():
+            """Update the state."""
+            self.async_schedule_update_ha_state(True)
+
+        self._async_unsub_dispatcher_connect = async_dispatcher_connect(
+            self.hass, TOPIC_DATA_UPDATE, update)
+
+    async def async_will_remove_from_hass(self):
+        """Disconnect dispatcher listener when removed."""
+        if self._async_unsub_dispatcher_connect:
+            self._async_unsub_dispatcher_connect()

homeassistant/components/iqvia/const.py

@@ -0,0 +1,45 @@
+"""Define IQVIA constants."""
+DOMAIN = 'iqvia'
+
+DATA_CLIENT = 'client'
+DATA_LISTENER = 'listener'
+
+TOPIC_DATA_UPDATE = 'data_update'
+
+TYPE_ALLERGY_FORECAST = 'allergy_average_forecasted'
+TYPE_ALLERGY_HISTORIC = 'allergy_average_historical'
+TYPE_ALLERGY_INDEX = 'allergy_index'
+TYPE_ALLERGY_OUTLOOK = 'allergy_outlook'
+TYPE_ALLERGY_TODAY = 'allergy_index_today'
+TYPE_ALLERGY_TOMORROW = 'allergy_index_tomorrow'
+TYPE_ALLERGY_YESTERDAY = 'allergy_index_yesterday'
+TYPE_ASTHMA_FORECAST = 'asthma_average_forecasted'
+TYPE_ASTHMA_HISTORIC = 'asthma_average_historical'
+TYPE_ASTHMA_INDEX = 'asthma_index'
+TYPE_ASTHMA_TODAY = 'asthma_index_today'
+TYPE_ASTHMA_TOMORROW = 'asthma_index_tomorrow'
+TYPE_ASTHMA_YESTERDAY = 'asthma_index_yesterday'
+TYPE_DISEASE_FORECAST = 'disease_average_forecasted'
+
+SENSORS = {
+    TYPE_ALLERGY_FORECAST: (
+        'ForecastSensor', 'Allergy Index: Forecasted Average', 'mdi:flower'),
+    TYPE_ALLERGY_HISTORIC: (
+        'HistoricalSensor', 'Allergy Index: Historical Average', 'mdi:flower'),
+    TYPE_ALLERGY_TODAY: ('IndexSensor', 'Allergy Index: Today', 'mdi:flower'),
+    TYPE_ALLERGY_TOMORROW: (
+        'IndexSensor', 'Allergy Index: Tomorrow', 'mdi:flower'),
+    TYPE_ALLERGY_YESTERDAY: (
+        'IndexSensor', 'Allergy Index: Yesterday', 'mdi:flower'),
+    TYPE_ASTHMA_TODAY: ('IndexSensor', 'Asthma Index: Today', 'mdi:flower'),
+    TYPE_ASTHMA_TOMORROW: (
+        'IndexSensor', 'Asthma Index: Tomorrow', 'mdi:flower'),
+    TYPE_ASTHMA_YESTERDAY: (
+        'IndexSensor', 'Asthma Index: Yesterday', 'mdi:flower'),
+    TYPE_ASTHMA_FORECAST: (
+        'ForecastSensor', 'Asthma Index: Forecasted Average', 'mdi:flower'),
+    TYPE_ASTHMA_HISTORIC: (
+        'HistoricalSensor', 'Asthma Index: Historical Average', 'mdi:flower'),
+    TYPE_DISEASE_FORECAST: (
+        'ForecastSensor', 'Cold & Flu: Forecasted Average', 'mdi:snowflake')
+}

homeassistant/components/iqvia/manifest.json

@@ -0,0 +1,13 @@
+{
+  "domain": "iqvia",
+  "name": "IQVIA",
+  "documentation": "https://www.home-assistant.io/components/iqvia",
+  "requirements": [
+    "numpy==1.16.2",
+    "pyiqvia==0.2.0"
+  ],
+  "dependencies": [],
+  "codeowners": [
+    "@bachya"
+  ]
+}