Merge pull request #5 from GuilleGF/interval

feat: add timeout and config interval

README.md

@@ -12,6 +12,8 @@ To use the integration in your installation, add the following to your `configur
 | `domain` | yes | string |  The subdomain you are modifying the DNS configuration for |
 | `username` | yes | string | The DynHost username |
 | `password` | yes | string | Password for the DynHost username |
+| `scan_interval` | no |  time | How often to call the update service. (default: 10 minutes) |
+
 #### Basic Example:
 
 ```yaml
@@ -20,4 +22,4 @@ ovh:
   username: YOUR_USERNAME
   password: YOUR_PASSWORD
 ```
-Based on the official [No-IP.com](https://github.com/home-assistant/core/tree/dev/homeassistant/components/no_ip) integration. Thanks to the creators!
+Based on the official [No-IP.com](https://github.com/home-assistant/core/tree/dev/homeassistant/components/no_ip) and [Mythic Beasts](https://github.com/home-assistant/core/blob/dev/homeassistant/components/mythicbeastsdns) integrations. Thanks to the creators!

custom_components/ovh/__init__.py

@@ -4,25 +4,28 @@
 import logging
 
 import aiohttp
-from aiohttp.hdrs import USER_AGENT
 from aiohttp import BasicAuth
 import async_timeout
 import voluptuous as vol
 
-from homeassistant.const import CONF_DOMAIN, CONF_PASSWORD, CONF_TIMEOUT, CONF_USERNAME
-from homeassistant.helpers.aiohttp_client import SERVER_SOFTWARE
+from homeassistant.const import (
+    CONF_DOMAIN,
+    CONF_PASSWORD,
+    CONF_USERNAME,
+    CONF_SCAN_INTERVAL
+)
 import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.aiohttp_client import async_get_clientsession
+from homeassistant.helpers.event import async_track_time_interval
 
 _LOGGER = logging.getLogger(__name__)
 
 DOMAIN = "ovh"
 
-# We should set a dedicated address for the user agent.
-EMAIL = "[email protected]"
-
-INTERVAL = timedelta(minutes=5)
+DEFAULT_INTERVAL = timedelta(minutes=10)
 
-DEFAULT_TIMEOUT = 10
+TIMEOUT = 10
+UPDATE_URL = "https://www.ovh.com/nic/update"
 
 OVH_ERRORS = {
     "nohost": "Hostname supplied does not exist under specified account",
@@ -32,60 +35,59 @@
     "abuse": "Username is blocked due to abuse",
 }
 
-UPDATE_URL = "https://www.ovh.com/nic/update"
-HA_USER_AGENT = f"{SERVER_SOFTWARE} {EMAIL}"
-
 CONFIG_SCHEMA = vol.Schema(
     {
         DOMAIN: vol.Schema(
             {
                 vol.Required(CONF_DOMAIN): cv.string,
                 vol.Required(CONF_USERNAME): cv.string,
                 vol.Required(CONF_PASSWORD): cv.string,
-                vol.Optional(CONF_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
+                vol.Optional(CONF_SCAN_INTERVAL, default=DEFAULT_INTERVAL): vol.All(
+                    cv.time_period, cv.positive_timedelta
+                ),
             }
         )
     },
     extra=vol.ALLOW_EXTRA,
 )
 
-
 async def async_setup(hass, config):
     """Initialize the OVH component."""
-    domain = config[DOMAIN].get(CONF_DOMAIN)
-    user = config[DOMAIN].get(CONF_USERNAME)
-    password = config[DOMAIN].get(CONF_PASSWORD)
-    timeout = config[DOMAIN].get(CONF_TIMEOUT)
+    conf = config[DOMAIN]
+    domain = conf.get(CONF_DOMAIN)
+    user = conf.get(CONF_USERNAME)
+    password = conf.get(CONF_PASSWORD)
+    interval = conf.get(CONF_SCAN_INTERVAL)
 
-    session = hass.helpers.aiohttp_client.async_get_clientsession()
+    session = async_get_clientsession(hass)
 
-    result = await _update_ovh(hass, session, domain, user, password, timeout)
+    result = await _update_ovh(hass, session, domain, user, password)
 
     if not result:
         return False
 
     async def update_domain_interval(now):
         """Update the OVH entry."""
-        await _update_ovh(hass, session, domain, user, password, timeout)
+        await _update_ovh(hass, session, domain, user, password)
 
-    hass.helpers.event.async_track_time_interval(update_domain_interval, INTERVAL)
+    async_track_time_interval(hass, update_domain_interval, interval)
 
     return True
 
 
-async def _update_ovh(hass, session, domain, user, password, timeout):
+async def _update_ovh(hass, session, domain, user, password):
     """Update OVH."""
-    url = UPDATE_URL
     params = {"system": "dyndns", "hostname": domain}
-    headers = {USER_AGENT: HA_USER_AGENT}
     authentication = BasicAuth(user, password)
 
     try:
-        with async_timeout.timeout(timeout):
-            resp = await session.get(url, params=params, headers=headers, auth=authentication)
+        with async_timeout.timeout(TIMEOUT):
+            resp = await session.get(UPDATE_URL, params=params, auth=authentication)
             body = await resp.text()
 
             if body.startswith("good") or body.startswith("nochg"):
+                _LOGGER.info("Updating OVH for domain: %s", domain)
+
                 return True
 
             _LOGGER.warning("Updating OVH failed: %s => %s", domain, OVH_ERRORS[body.strip()])

custom_components/ovh/manifest.json

@@ -5,5 +5,5 @@
   "issue_tracker": "https://github.com/GuilleGF/hassio-ovh/issues",
   "codeowners": ["@GuilleGF"],
   "iot_class": "cloud_polling",
-  "version": "1.1.0"
+  "version": "2.0.0"
 }

hacs.json

@@ -1,5 +1,4 @@
 {
   "name": "OVH DynHost",
-  "render_readme": true,
-  "iot_class": "cloud_push"
+  "render_readme": true
 }