github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

NextCloud -> Nextcloud, + header fix as per user feedback

pull/186/head
Chris Caron 2019-12-10 21:23:35 -05:00
parent 5949e757fa
commit 765f4346c1
5 changed files with 46 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -50,7 +50,7 @@ The table below identifies the services this tool supports and some example serv
| [Matrix](https://github.com/caronc/apprise/wiki/Notify_matrix) | matrix:// or matrixs:// | (TCP) 80 or 443 | matrix://hostname<br />matrix://user@hostname<br />matrixs://user:pass@hostname:port/#room_alias<br />matrixs://user:pass@hostname:port/!room_id<br />matrixs://user:pass@hostname:port/#room_alias/!room_id/#room2<br />matrixs://token@hostname:port/?webhook=matrix<br />matrix://user:token@hostname/?webhook=slack&format=markdown | [Matrix](https://github.com/caronc/apprise/wiki/Notify_matrix) | matrix:// or matrixs:// | (TCP) 80 or 443 | matrix://hostname<br />matrix://user@hostname<br />matrixs://user:pass@hostname:port/#room_alias<br />matrixs://user:pass@hostname:port/!room_id<br />matrixs://user:pass@hostname:port/#room_alias/!room_id/#room2<br />matrixs://token@hostname:port/?webhook=matrix<br />matrix://user:token@hostname/?webhook=slack&format=markdown
| [Mattermost](https://github.com/caronc/apprise/wiki/Notify_mattermost) | mmost:// | (TCP) 8065 | mmost://hostname/authkey<br />mmost://hostname:80/authkey<br />mmost://user@hostname:80/authkey<br />mmost://hostname/authkey?channel=channel<br />mmosts://hostname/authkey<br />mmosts://user@hostname/authkey<br /> | [Mattermost](https://github.com/caronc/apprise/wiki/Notify_mattermost) | mmost:// | (TCP) 8065 | mmost://hostname/authkey<br />mmost://hostname:80/authkey<br />mmost://user@hostname:80/authkey<br />mmost://hostname/authkey?channel=channel<br />mmosts://hostname/authkey<br />mmosts://user@hostname/authkey<br />
| [Microsoft Teams](https://github.com/caronc/apprise/wiki/Notify_msteams) | msteams:// | (TCP) 443 | msteams://TokenA/TokenB/TokenC/ | [Microsoft Teams](https://github.com/caronc/apprise/wiki/Notify_msteams) | msteams:// | (TCP) 443 | msteams://TokenA/TokenB/TokenC/
| [NextCloud](https://github.com/caronc/apprise/wiki/Notify_nextcloud) | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:pass@host/User<br/>nclouds://adminuser:pass@host/User1/User2/UserN | [Nextcloud](https://github.com/caronc/apprise/wiki/Notify_nextcloud) | ncloud:// or nclouds:// | (TCP) 80 or 443 | ncloud://adminuser:pass@host/User<br/>nclouds://adminuser:pass@host/User1/User2/UserN
| [Notica](https://github.com/caronc/apprise/wiki/Notify_notica) | notica:// | (TCP) 443 | notica://Token/ | [Notica](https://github.com/caronc/apprise/wiki/Notify_notica) | notica:// | (TCP) 443 | notica://Token/
| [Notifico](https://github.com/caronc/apprise/wiki/Notify_notifico) | notifico:// | (TCP) 443 | notifico://ProjectID/MessageHook/ | [Notifico](https://github.com/caronc/apprise/wiki/Notify_notifico) | notifico:// | (TCP) 443 | notifico://ProjectID/MessageHook/
| [Prowl](https://github.com/caronc/apprise/wiki/Notify_prowl) | prowl:// | (TCP) 443 | prowl://apikey<br />prowl://apikey/providerkey | [Prowl](https://github.com/caronc/apprise/wiki/Notify_prowl) | prowl:// | (TCP) 443 | prowl://apikey<br />prowl://apikey/providerkey

66
apprise/plugins/NotifyNextCloud.py → apprise/plugins/NotifyNextcloud.py
View File

@ -31,13 +31,13 @@ from ..utils import parse_list
from ..AppriseLocale import gettext_lazy as _ from ..AppriseLocale import gettext_lazy as _
class NotifyNextCloud(NotifyBase): class NotifyNextcloud(NotifyBase):
""" """
A wrapper for NextCloud Notifications A wrapper for Nextcloud Notifications
""" """
# The default descriptive name associated with the Notification # The default descriptive name associated with the Notification
service_name = 'NextCloud' service_name = 'Nextcloud'
# The services URL # The services URL
service_url = 'https://github.com/nextcloud/notifications' service_url = 'https://github.com/nextcloud/notifications'
@ -51,22 +51,16 @@ class NotifyNextCloud(NotifyBase):
# A URL that takes you to the setup/help of the specific protocol # A URL that takes you to the setup/help of the specific protocol
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_nextcloud' setup_url = 'https://github.com/caronc/apprise/wiki/Notify_nextcloud'
# NextCloud URL # Nextcloud URL
notify_url = '{schema}://{host}/ocs/v2.php/apps/admin_notifications/' \ notify_url = '{schema}://{host}/ocs/v2.php/apps/admin_notifications/' \
'api/v1/notifications/{target}' 'api/v1/notifications/{target}'
# NextCloud does not support a title # Nextcloud does not support a title
title_maxlen = 0 title_maxlen = 255
# Defines the maximum allowable characters per message. # Defines the maximum allowable characters per message.
body_maxlen = 4000 body_maxlen = 4000
# If the message is less than this number of characters, there is another
# method of posting the message to Nextcloud. We use this if we can, but
# otherwise fall back to the larger size (which is our Apprise fixed limit)
# defined above.
short_message_length = 255
# Define object templates # Define object templates
templates = ( templates = (
'{schema}://{user}:{password}@{host}/{targets}', '{schema}://{user}:{password}@{host}/{targets}',
@ -117,13 +111,13 @@ class NotifyNextCloud(NotifyBase):
def __init__(self, targets=None, headers=None, **kwargs): def __init__(self, targets=None, headers=None, **kwargs):
""" """
Initialize NextCloud Object Initialize Nextcloud Object
""" """
super(NotifyNextCloud, self).__init__(**kwargs) super(NotifyNextcloud, self).__init__(**kwargs)
self.targets = parse_list(targets) self.targets = parse_list(targets)
if len(self.targets) == 0: if len(self.targets) == 0:
msg = 'At least one NextCloud target user must be specified.' msg = 'At least one Nextcloud target user must be specified.'
self.logger.warning(msg) self.logger.warning(msg)
raise TypeError(msg) raise TypeError(msg)
@ -136,14 +130,18 @@ class NotifyNextCloud(NotifyBase):
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
""" """
Perform NextCloud Notification Perform Nextcloud Notification
""" """
# Prepare our Header # Prepare our Header
headers = { headers = {
'User-Agent': self.app_id, 'User-Agent': self.app_id,
'OCS-APIREQUEST': 'true',
} }
# Apply any/all header over-rides defined
headers.update(self.headers)
# error tracking (used for function return) # error tracking (used for function return)
has_error = False has_error = False
@ -153,12 +151,10 @@ class NotifyNextCloud(NotifyBase):
target = targets.pop(0) target = targets.pop(0)
# Prepare our Payload # Prepare our Payload
payload = {} payload = {
if len(body) > 255: 'shortMessage': title,
payload['longMessage'] = body 'longMessage': body,
}
else:
payload['shortMessage'] = body
auth = None auth = None
if self.user: if self.user:
@ -171,10 +167,10 @@ class NotifyNextCloud(NotifyBase):
target=target, target=target,
) )
self.logger.debug('NextCloud POST URL: %s (cert_verify=%r)' % ( self.logger.debug('Nextcloud POST URL: %s (cert_verify=%r)' % (
notify_url, self.verify_certificate, notify_url, self.verify_certificate,
)) ))
self.logger.debug('NextCloud Payload: %s' % str(payload)) self.logger.debug('Nextcloud Payload: %s' % str(payload))
# Always call throttle before any remote server i/o is made # Always call throttle before any remote server i/o is made
self.throttle() self.throttle()
@ -190,11 +186,11 @@ class NotifyNextCloud(NotifyBase):
if r.status_code != requests.codes.ok: if r.status_code != requests.codes.ok:
# We had a problem # We had a problem
status_str = \ status_str = \
NotifyNextCloud.http_response_code_lookup( NotifyNextcloud.http_response_code_lookup(
r.status_code) r.status_code)
self.logger.warning( self.logger.warning(
'Failed to send NextCloud notification:' 'Failed to send Nextcloud notification:'
'{}{}error={}.'.format( '{}{}error={}.'.format(
status_str, status_str,
', ' if status_str else '', ', ' if status_str else '',
@ -207,11 +203,11 @@ class NotifyNextCloud(NotifyBase):
continue continue
else: else:
self.logger.info('Sent NextCloud notification.') self.logger.info('Sent Nextcloud notification.')
except requests.RequestException as e: except requests.RequestException as e:
self.logger.warning( self.logger.warning(
'A Connection error occured sending NextCloud ' 'A Connection error occured sending Nextcloud '
'notification.', 'notification.',
) )
self.logger.debug('Socket Exception: %s' % str(e)) self.logger.debug('Socket Exception: %s' % str(e))
@ -241,13 +237,13 @@ class NotifyNextCloud(NotifyBase):
auth = '' auth = ''
if self.user and self.password: if self.user and self.password:
auth = '{user}:{password}@'.format( auth = '{user}:{password}@'.format(
user=NotifyNextCloud.quote(self.user, safe=''), user=NotifyNextcloud.quote(self.user, safe=''),
password=self.pprint( password=self.pprint(
self.password, privacy, mode=PrivacyMode.Secret, safe=''), self.password, privacy, mode=PrivacyMode.Secret, safe=''),
) )
elif self.user: elif self.user:
auth = '{user}@'.format( auth = '{user}@'.format(
user=NotifyNextCloud.quote(self.user, safe=''), user=NotifyNextcloud.quote(self.user, safe=''),
) )
default_port = 443 if self.secure else 80 default_port = 443 if self.secure else 80
@ -257,12 +253,12 @@ class NotifyNextCloud(NotifyBase):
schema=self.secure_protocol schema=self.secure_protocol
if self.secure else self.protocol, if self.secure else self.protocol,
auth=auth, auth=auth,
hostname=NotifyNextCloud.quote(self.host, safe=''), hostname=NotifyNextcloud.quote(self.host, safe=''),
port='' if self.port is None or self.port == default_port port='' if self.port is None or self.port == default_port
else ':{}'.format(self.port), else ':{}'.format(self.port),
targets='/'.join([NotifyNextCloud.quote(x) targets='/'.join([NotifyNextcloud.quote(x)
for x in self.targets]), for x in self.targets]),
args=NotifyNextCloud.urlencode(args), args=NotifyNextcloud.urlencode(args),
) )
@staticmethod @staticmethod
@ -280,12 +276,12 @@ class NotifyNextCloud(NotifyBase):
# Fetch our targets # Fetch our targets
results['targets'] = \ results['targets'] = \
NotifyNextCloud.split_path(results['fullpath']) NotifyNextcloud.split_path(results['fullpath'])
# The 'to' makes it easier to use yaml configuration # The 'to' makes it easier to use yaml configuration
if 'to' in results['qsd'] and len(results['qsd']['to']): if 'to' in results['qsd'] and len(results['qsd']['to']):
results['targets'] += \ results['targets'] += \
NotifyNextCloud.parse_list(results['qsd']['to']) NotifyNextcloud.parse_list(results['qsd']['to'])
# Add our headers that the user can potentially over-ride if they # Add our headers that the user can potentially over-ride if they
# wish to to our returned result set # wish to to our returned result set

2
packaging/redhat/python-apprise.spec
View File

@ -49,7 +49,7 @@ it easy to access:
Boxcar, ClickSend, Discord, E-Mail, Emby, Faast, Flock, Gitter, Gotify, Growl, Boxcar, ClickSend, Discord, E-Mail, Emby, Faast, Flock, Gitter, Gotify, Growl,
IFTTT, Join, KODI, Kumulos, Mailgun, MatterMost, Matrix, Microsoft Windows IFTTT, Join, KODI, Kumulos, Mailgun, MatterMost, Matrix, Microsoft Windows
Notifications, Microsoft Teams, MessageBird, MSG91, Nexmo, NextCloud, Notica, Notifications, Microsoft Teams, MessageBird, MSG91, Nexmo, Nextcloud, Notica,
Notifico, Notify MyAndroid, Prowl, Pushalot, PushBullet, Pushjet, Pushover, Notifico, Notify MyAndroid, Prowl, Pushalot, PushBullet, Pushjet, Pushover,
PushSafer, Rocket.Chat, SendGrid, SimplePush, Slack, Super Toasty, Stride, PushSafer, Rocket.Chat, SendGrid, SimplePush, Slack, Super Toasty, Stride,
Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP, Syslog, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP,

2
setup.py
View File

@ -72,7 +72,7 @@ setup(
keywords='Push Notifications Alerts Email AWS SNS Boxcar ClickSend ' keywords='Push Notifications Alerts Email AWS SNS Boxcar ClickSend '
'Discord Dbus Emby Faast Flock Gitter Gnome Gotify Growl IFTTT Join ' 'Discord Dbus Emby Faast Flock Gitter Gnome Gotify Growl IFTTT Join '
'KODI Kumulos Mailgun Matrix Mattermost MessageBird MSG91 Nexmo ' 'KODI Kumulos Mailgun Matrix Mattermost MessageBird MSG91 Nexmo '
'NextCloud Notica, Notifico Prowl PushBullet Pushjet Pushed Pushover ' 'Nextcloud Notica, Notifico Prowl PushBullet Pushjet Pushed Pushover '
'PushSafer Rocket.Chat Ryver SendGrid SimplePush Slack Stride Syslog ' 'PushSafer Rocket.Chat Ryver SendGrid SimplePush Slack Stride Syslog '
'Techulus Push Telegram Twilio Twist Twitter XBMC Microsoft MSTeams ' 'Techulus Push Telegram Twilio Twist Twitter XBMC Microsoft MSTeams '
'Windows Webex CLI API', 'Windows Webex CLI API',

24
test/test_rest_plugins.py
View File

@ -1738,7 +1738,7 @@ TEST_URLS = (
}), }),
################################## ##################################
# NotifyNextCloud # NotifyNextcloud
################################## ##################################
('ncloud://:@/', { ('ncloud://:@/', {
'instance': None, 'instance': None,
@ -1755,49 +1755,49 @@ TEST_URLS = (
'instance': TypeError, 'instance': TypeError,
}), }),
('ncloud://localhost/admin', { ('ncloud://localhost/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('ncloud://user@localhost/admin', { ('ncloud://user@localhost/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('ncloud://user@localhost?to=user1,user2', { ('ncloud://user@localhost?to=user1,user2', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('ncloud://user:pass@localhost/user1/user2', { ('ncloud://user:pass@localhost/user1/user2', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
# Our expected url(privacy=True) startswith() response: # Our expected url(privacy=True) startswith() response:
'privacy_url': 'ncloud://user:****@localhost/user1/user2', 'privacy_url': 'ncloud://user:****@localhost/user1/user2',
}), }),
('ncloud://user:pass@localhost:8080/admin', { ('ncloud://user:pass@localhost:8080/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('nclouds://user:pass@localhost/admin', { ('nclouds://user:pass@localhost/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
# Our expected url(privacy=True) startswith() response: # Our expected url(privacy=True) startswith() response:
'privacy_url': 'nclouds://user:****@localhost/admin', 'privacy_url': 'nclouds://user:****@localhost/admin',
}), }),
('nclouds://user:pass@localhost:8080/admin/', { ('nclouds://user:pass@localhost:8080/admin/', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('ncloud://localhost:8080/admin?-HeaderKey=HeaderValue', { ('ncloud://localhost:8080/admin?-HeaderKey=HeaderValue', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
}), }),
('ncloud://user:pass@localhost:8081/admin', { ('ncloud://user:pass@localhost:8081/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
# force a failure # force a failure
'response': False, 'response': False,
'requests_response_code': requests.codes.internal_server_error, 'requests_response_code': requests.codes.internal_server_error,
}), }),
('ncloud://user:pass@localhost:8082/admin', { ('ncloud://user:pass@localhost:8082/admin', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
# throw a bizzare code forcing us to fail to look it up # throw a bizzare code forcing us to fail to look it up
'response': False, 'response': False,
'requests_response_code': 999, 'requests_response_code': 999,
}), }),
('ncloud://user:pass@localhost:8083/user1/user2/user3', { ('ncloud://user:pass@localhost:8083/user1/user2/user3', {
'instance': plugins.NotifyNextCloud, 'instance': plugins.NotifyNextcloud,
# Throws a series of connection and transfer exceptions when this flag # Throws a series of connection and transfer exceptions when this flag
# is set and tests that we gracfully handle them # is set and tests that we gracfully handle them
'test_requests_exceptions': True, 'test_requests_exceptions': True,