diff --git a/.coveragerc b/.coveragerc index 868d38e0542..61e0ec7a399 100644 --- a/.coveragerc +++ b/.coveragerc @@ -110,6 +110,7 @@ omit = homeassistant/components/notify/free_mobile.py homeassistant/components/notify/googlevoice.py homeassistant/components/notify/instapush.py + homeassistant/components/notify/message_bird.py homeassistant/components/notify/nma.py homeassistant/components/notify/pushbullet.py homeassistant/components/notify/pushetta.py diff --git a/homeassistant/components/notify/message_bird.py b/homeassistant/components/notify/message_bird.py new file mode 100644 index 00000000000..f2c8f042c5d --- /dev/null +++ b/homeassistant/components/notify/message_bird.py @@ -0,0 +1,87 @@ +""" +MessageBird platform for notify component. + +For more details about this platform, please refer to the documentation at +https://home-assistant.io/components/notify.message_bird/ +""" +import logging + +from homeassistant.components.notify import ( + ATTR_TARGET, DOMAIN, BaseNotificationService) +from homeassistant.const import CONF_API_KEY +from homeassistant.helpers import validate_config + +CONF_SENDER = 'sender' + +_LOGGER = logging.getLogger(__name__) +REQUIREMENTS = ['messagebird==1.1.1'] + + +def is_valid_sender(sender): + """Test if the sender config option is valid.""" + length = len(sender) + if length > 1: + if sender[0] == '+': + return sender[1:].isdigit() + elif length <= 11: + return sender.isalpha() + return False + + +# pylint: disable=unused-argument +def get_service(hass, config): + """Get the MessageBird notification service.""" + import messagebird + + if not validate_config({DOMAIN: config}, + {DOMAIN: [CONF_API_KEY]}, + _LOGGER): + return None + + sender = config.get(CONF_SENDER, 'HA') + if not is_valid_sender(sender): + _LOGGER.error('Sender is invalid: It must be a phone number or ' + 'a string not longer than 11 characters.') + return None + + client = messagebird.Client(config[CONF_API_KEY]) + try: + # validates the api key + client.balance() + except messagebird.client.ErrorException: + _LOGGER.error('The specified MessageBird API key is invalid.') + return None + + return MessageBirdNotificationService(sender, client) + + +# pylint: disable=too-few-public-methods +class MessageBirdNotificationService(BaseNotificationService): + """Implement the notification service for MessageBird.""" + + def __init__(self, sender, client): + """Initialize the service.""" + self.sender = sender + self.client = client + + def send_message(self, message=None, **kwargs): + """Send a message to a specified target.""" + from messagebird.client import ErrorException + + targets = kwargs.get(ATTR_TARGET) + if not targets: + _LOGGER.error('No target specified.') + return + + if not isinstance(targets, list): + targets = [targets] + + for target in targets: + try: + self.client.message_create(self.sender, + target, + message, + {'reference': 'HA'}) + except ErrorException as exception: + _LOGGER.error('Failed to notify %s: %s', target, exception) + continue diff --git a/requirements_all.txt b/requirements_all.txt index 8c9e9a5dcde..55955fb4cbf 100644 --- a/requirements_all.txt +++ b/requirements_all.txt @@ -114,6 +114,9 @@ liffylights==0.9.4 # homeassistant.components.light.limitlessled limitlessled==1.0.0 +# homeassistant.components.notify.message_bird +messagebird==1.1.1 + # homeassistant.components.sensor.mfi # homeassistant.components.switch.mfi mficlient==0.3.0