jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 05:07:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Made API Key a required config variable

Browse Source
This commit is contained in:
jamespcole 2015-03-22 15:13:57 +11:00
parent a0f1c1d17a
commit 20f52a7fb1
1 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
homeassistant/components/notify/pushover.py
View File

@ -8,10 +8,25 @@ to your config/configuration.yaml
notify: notify:
platform: pushover platform: pushover
api_key: ABCDEFGHJKLMNOPQRSTUVXYZ
user_key: ABCDEFGHJKLMNOPQRSTUVXYZ user_key: ABCDEFGHJKLMNOPQRSTUVXYZ
VARIABLES: VARIABLES:
api_key
*Required
This parameter is optional but should be configured, in order to get an API
key you should go to pushover.com and register a new application.
This is a quote from the pushover website regarding free/open source apps:
"If you are creating a client-side library, application, or open source project
that will be redistributed and installed by end-users, you may want to require
each of your users to register their own application rather than including your
own API token with the software."
When setting up the application I recommend using the icon located here:
https://home-assistant.io/images/favicon-192x192.png
user_key user_key
*Required *Required
To retrieve this value log into your account at http://pushover.com To retrieve this value log into your account at http://pushover.com
@ -22,22 +37,22 @@ import logging
from homeassistant.helpers import validate_config from homeassistant.helpers import validate_config
from homeassistant.components.notify import ( from homeassistant.components.notify import (
DOMAIN, ATTR_TITLE, BaseNotificationService) DOMAIN, ATTR_TITLE, BaseNotificationService)
from homeassistant.const import CONF_API_KEY
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
_API_TOKEN = 'a99PmRoFWhchykrsS6MQwgM3mPdhEv'
def get_service(hass, config): def get_service(hass, config):
""" Get the pushover notification service. """ """ Get the pushover notification service. """
if not validate_config(config, if not validate_config(config,
{DOMAIN: ['user_key']}, {DOMAIN: ['user_key', CONF_API_KEY]},
_LOGGER): _LOGGER):
return None return None
try: try:
# pylint: disable=unused-variable # pylint: disable=unused-variable
from pushover import Client from pushover import Client, InitError, RequestError
except ImportError: except ImportError:
_LOGGER.exception( _LOGGER.exception(
@ -47,9 +62,13 @@ def get_service(hass, config):
return None return None
try: try:
return PushoverNotificationService(config[DOMAIN]['user_key']) api_token = config[DOMAIN].get(CONF_API_KEY)
return PushoverNotificationService(
config[DOMAIN]['user_key'],
api_token
)
except InvalidKeyError: except InitError:
_LOGGER.error( _LOGGER.error(
"Wrong API key supplied. " "Wrong API key supplied. "
"Get it at https://www.pushover.com") "Get it at https://www.pushover.com")
@ -59,14 +78,17 @@ def get_service(hass, config):
class PushoverNotificationService(BaseNotificationService): class PushoverNotificationService(BaseNotificationService):
""" Implements notification service for Pushover. """ """ Implements notification service for Pushover. """
def __init__(self, user_key): def __init__(self, user_key, api_token):
from pushover import Client from pushover import Client, RequestError
self.user_key = user_key self._user_key = user_key
self.pushover = client = Client(self.user_key, api_token=_API_TOKEN) self._api_token = api_token
self.pushover = client = Client(self._user_key, api_token=self._api_token)
def send_message(self, message="", **kwargs): def send_message(self, message="", **kwargs):
""" Send a message to a user. """ """ Send a message to a user. """
title = kwargs.get(ATTR_TITLE) title = kwargs.get(ATTR_TITLE)
try:
self.pushover.send_message(message, title=title) self.pushover.send_message(message, title=title)
except RequestError:
_LOGGER.exception("Could not send pushover notification")