Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,7 @@ omit =
homeassistant/components/sensor/discogs.py
homeassistant/components/sensor/dnsip.py
homeassistant/components/sensor/dovado.py
homeassistant/components/sensor/domain_expiry.py
homeassistant/components/sensor/dte_energy_bridge.py
homeassistant/components/sensor/dublin_bus_transport.py
homeassistant/components/sensor/dwd_weather_warnings.py
Expand Down
76 changes: 76 additions & 0 deletions homeassistant/components/sensor/domain_expiry.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
"""
Counter for the days till domain will expire.

For more details about this sensor please refer to the documentation at
https://home-assistant.io/components/sensor.domain_expiry/
"""
import logging
from datetime import datetime, timedelta

import voluptuous as vol

import homeassistant.helpers.config_validation as cv
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import (CONF_NAME, CONF_HOST)
from homeassistant.helpers.entity import Entity

REQUIREMENTS = ['python-whois==0.6.9']

_LOGGER = logging.getLogger(__name__)

DEFAULT_NAME = 'Domain Expiry'

SCAN_INTERVAL = timedelta(hours=24)

PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_HOST): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string
})


def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up domain expiry sensor."""
server_name = config.get(CONF_HOST)
sensor_name = config.get(CONF_NAME)

add_devices([DomainExpiry(sensor_name, server_name)], True)


class DomainExpiry(Entity):
"""Implementation of the domain expiry sensor."""

def __init__(self, sensor_name, server_name):
"""Initialize the sensor."""
self.server_name = server_name
self._name = sensor_name
self._state = None

@property
def name(self):
"""Return the name of the sensor."""
return self._name

@property
def unit_of_measurement(self):
"""Return the unit this state is expressed in."""
return 'days'

@property
def state(self):
"""Return the state of the sensor."""
return self._state

@property
def icon(self):
"""Icon to use in the frontend, if any."""
return 'mdi:earth'

def update(self):
"""Fetch the domain information."""
import whois
domain = whois.whois(self.server_name)
if isinstance(domain.expiration_date, datetime):
expiry = domain.expiration_date - datetime.today()
self._state = expiry.days
else:
_LOGGER.error("Cannot get expiry date for %s", self.server_name)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set self._state = None ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't change it because expiration date will always be datetime. This check is for some domains that don't share this information and error will be triggered only for them

3 changes: 3 additions & 0 deletions requirements_all.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1035,6 +1035,9 @@ python-velbus==2.0.11
# homeassistant.components.media_player.vlc
python-vlc==1.1.2

# homeassistant.components.sensor.domain_expiry
python-whois==0.6.9

# homeassistant.components.wink
python-wink==1.7.3

Expand Down