# -*- coding: utf-8 -*- # # JSON Notify Wrapper # # Copyright (C) 2017-2018 Chris Caron # # This file is part of apprise. # # This program is free software; you can redistribute it and/or modify it # under the terms of the GNU Lesser General Public License as published by # the Free Software Foundation; either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser General Public License for more details. import requests from json import dumps from .NotifyBase import NotifyBase from .NotifyBase import HTTP_ERROR_MAP from ..common import NotifyImageSize from ..utils import compat_is_basestring class NotifyJSON(NotifyBase): """ A wrapper for JSON Notifications """ # The default descriptive name associated with the Notification service_name = 'JSON' # The default protocol protocol = 'json' # The default secure protocol secure_protocol = 'jsons' # A URL that takes you to the setup/help of the specific protocol setup_url = 'https://github.com/caronc/apprise/wiki/Notify_Custom_JSON' # Allows the user to specify the NotifyImageSize object image_size = NotifyImageSize.XY_128 def __init__(self, **kwargs): """ Initialize JSON Object """ super(NotifyJSON, self).__init__(**kwargs) if self.secure: self.schema = 'https' else: self.schema = 'http' self.fullpath = kwargs.get('fullpath') if not compat_is_basestring(self.fullpath): self.fullpath = '/' return def notify(self, title, body, notify_type, **kwargs): """ Perform JSON Notification """ # prepare JSON Object payload = { # Version: Major.Minor, Major is only updated if the entire # schema is changed. If just adding new items (or removing # old ones, only increment the Minor! 'version': '1.0', 'title': title, 'message': body, 'type': notify_type, } headers = { 'User-Agent': self.app_id, 'Content-Type': 'application/json' } auth = None if self.user: auth = (self.user, self.password) url = '%s://%s' % (self.schema, self.host) if isinstance(self.port, int): url += ':%d' % self.port url += self.fullpath self.logger.debug('JSON POST URL: %s (cert_verify=%r)' % ( url, self.verify_certificate, )) self.logger.debug('JSON Payload: %s' % str(payload)) try: r = requests.post( url, data=dumps(payload), headers=headers, auth=auth, verify=self.verify_certificate, ) if r.status_code != requests.codes.ok: try: self.logger.warning( 'Failed to send JSON notification: ' '%s (error=%s).' % ( HTTP_ERROR_MAP[r.status_code], r.status_code)) except KeyError: self.logger.warning( 'Failed to send JSON notification ' '(error=%s).' % (r.status_code)) # Return; we're done return False else: self.logger.info('Sent JSON notification.') except requests.RequestException as e: self.logger.warning( 'A Connection error occured sending JSON ' 'notification to %s.' % self.host) self.logger.debug('Socket Exception: %s' % str(e)) # Return; we're done return False return True