9db1aa7629
* Add mysensors notify platform * Make add_devices optional in platform callback function. * Use new argument structure for all existing mysensors platforms. * Add notify platform. * Update mysensors gateway. * Refactor notify setup * Enable discovery of notify platforms. * Update and add tests for notify component and some platforms. * Continue setup of notify platforms if a platform fails setup. * Remove notify tests that check platform config. These tests are not needed when config validation is used. * Add config validation to APNS notify platform. * Use discovery to set up mysensors notify platform. * Add discovery_info to get_service and update tests * Add discovery_info as keyword argument to the get_service function signature and update all notify platforms. * Update existing notify tests to check config validation using test helper. * Add removed tests back in that checked config in apns, command_line and file platforms, but use config validation test helper to verify config. * Add a test for notify file to increase coverage. * Fix some PEP issues. * Fix comments and use more constants * Move apns notify service under notify domain
103 lines
3.3 KiB
Python
103 lines
3.3 KiB
Python
"""
|
|
Telstra API platform for notify component.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/notify.telstra/
|
|
"""
|
|
import logging
|
|
|
|
import requests
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.notify import (
|
|
BaseNotificationService, ATTR_TITLE, PLATFORM_SCHEMA)
|
|
from homeassistant.const import CONTENT_TYPE_JSON
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONF_CONSUMER_KEY = 'consumer_key'
|
|
CONF_CONSUMER_SECRET = 'consumer_secret'
|
|
CONF_PHONE_NUMBER = 'phone_number'
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
|
vol.Required(CONF_CONSUMER_KEY): cv.string,
|
|
vol.Required(CONF_CONSUMER_SECRET): cv.string,
|
|
vol.Required(CONF_PHONE_NUMBER): cv.string,
|
|
})
|
|
|
|
|
|
def get_service(hass, config, discovery_info=None):
|
|
"""Get the Telstra SMS API notification service."""
|
|
consumer_key = config.get(CONF_CONSUMER_KEY)
|
|
consumer_secret = config.get(CONF_CONSUMER_SECRET)
|
|
phone_number = config.get(CONF_PHONE_NUMBER)
|
|
|
|
if _authenticate(consumer_key, consumer_secret) is False:
|
|
_LOGGER.exception('Error obtaining authorization from Telstra API')
|
|
return None
|
|
|
|
return TelstraNotificationService(
|
|
consumer_key, consumer_secret, phone_number)
|
|
|
|
|
|
class TelstraNotificationService(BaseNotificationService):
|
|
"""Implementation of a notification service for the Telstra SMS API."""
|
|
|
|
def __init__(self, consumer_key, consumer_secret, phone_number):
|
|
"""Initialize the service."""
|
|
self._consumer_key = consumer_key
|
|
self._consumer_secret = consumer_secret
|
|
self._phone_number = phone_number
|
|
|
|
def send_message(self, message="", **kwargs):
|
|
"""Send a message to a user."""
|
|
title = kwargs.get(ATTR_TITLE)
|
|
|
|
# Retrieve authorization first
|
|
token_response = _authenticate(
|
|
self._consumer_key, self._consumer_secret)
|
|
if token_response is False:
|
|
_LOGGER.exception("Error obtaining authorization from Telstra API")
|
|
return
|
|
|
|
# Send the SMS
|
|
if title:
|
|
text = '{} {}'.format(title, message)
|
|
else:
|
|
text = message
|
|
|
|
message_data = {
|
|
'to': self._phone_number,
|
|
'body': text,
|
|
}
|
|
message_resource = 'https://api.telstra.com/v1/sms/messages'
|
|
message_headers = {
|
|
'Content-Type': CONTENT_TYPE_JSON,
|
|
'Authorization': 'Bearer ' + token_response['access_token'],
|
|
}
|
|
message_response = requests.post(
|
|
message_resource, headers=message_headers, json=message_data,
|
|
timeout=10)
|
|
|
|
if message_response.status_code != 202:
|
|
_LOGGER.exception("Failed to send SMS. Status code: %d",
|
|
message_response.status_code)
|
|
|
|
|
|
def _authenticate(consumer_key, consumer_secret):
|
|
"""Authenticate with the Telstra API."""
|
|
token_data = {
|
|
'client_id': consumer_key,
|
|
'client_secret': consumer_secret,
|
|
'grant_type': 'client_credentials',
|
|
'scope': 'SMS'
|
|
}
|
|
token_resource = 'https://api.telstra.com/v1/oauth/token'
|
|
token_response = requests.get(
|
|
token_resource, params=token_data, timeout=10).json()
|
|
|
|
if 'error' in token_response:
|
|
return False
|
|
|
|
return token_response
|