mirror of
https://github.com/caronc/apprise.git
synced 2025-06-22 02:31:41 +02:00
Add support for guilded.gg (#578)
This commit is contained in:
parent
ec9d166572
commit
3c07d80975
@ -47,6 +47,7 @@ The table below identifies the services this tool supports and some example serv
|
|||||||
| [Google Chat](https://github.com/caronc/apprise/wiki/Notify_googlechat) | gchat:// | (TCP) 443 | gchat://workspace/key/token
|
| [Google Chat](https://github.com/caronc/apprise/wiki/Notify_googlechat) | gchat:// | (TCP) 443 | gchat://workspace/key/token
|
||||||
| [Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify) | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/token<br />gotifys://hostname/token?priority=high
|
| [Gotify](https://github.com/caronc/apprise/wiki/Notify_gotify) | gotify:// or gotifys:// | (TCP) 80 or 443 | gotify://hostname/token<br />gotifys://hostname/token?priority=high
|
||||||
| [Growl](https://github.com/caronc/apprise/wiki/Notify_growl) | growl:// | (UDP) 23053 | growl://hostname<br />growl://hostname:portno<br />growl://password@hostname<br />growl://password@hostname:port</br>**Note**: you can also use the get parameter _version_ which can allow the growl request to behave using the older v1.x protocol. An example would look like: growl://hostname?version=1
|
| [Growl](https://github.com/caronc/apprise/wiki/Notify_growl) | growl:// | (UDP) 23053 | growl://hostname<br />growl://hostname:portno<br />growl://password@hostname<br />growl://password@hostname:port</br>**Note**: you can also use the get parameter _version_ which can allow the growl request to behave using the older v1.x protocol. An example would look like: growl://hostname?version=1
|
||||||
|
| [Guilded](https://github.com/caronc/apprise/wiki/Notify_discord) | guilded:// | (TCP) 443 | guilded://webhook_id/webhook_token<br />guilded://avatar@webhook_id/webhook_token
|
||||||
| [Home Assistant](https://github.com/caronc/apprise/wiki/Notify_homeassistant) | hassio:// or hassios:// | (TCP) 8123 or 443 | hassio://hostname/accesstoken<br />hassio://user@hostname/accesstoken<br />hassio://user:password@hostname:port/accesstoken<br />hassio://hostname/optional/path/accesstoken
|
| [Home Assistant](https://github.com/caronc/apprise/wiki/Notify_homeassistant) | hassio:// or hassios:// | (TCP) 8123 or 443 | hassio://hostname/accesstoken<br />hassio://user@hostname/accesstoken<br />hassio://user:password@hostname:port/accesstoken<br />hassio://hostname/optional/path/accesstoken
|
||||||
| [IFTTT](https://github.com/caronc/apprise/wiki/Notify_ifttt) | ifttt:// | (TCP) 443 | ifttt://webhooksID/Event<br />ifttt://webhooksID/Event1/Event2/EventN<br/>ifttt://webhooksID/Event1/?+Key=Value<br/>ifttt://webhooksID/Event1/?-Key=value1
|
| [IFTTT](https://github.com/caronc/apprise/wiki/Notify_ifttt) | ifttt:// | (TCP) 443 | ifttt://webhooksID/Event<br />ifttt://webhooksID/Event1/Event2/EventN<br/>ifttt://webhooksID/Event1/?+Key=Value<br/>ifttt://webhooksID/Event1/?-Key=value1
|
||||||
| [Join](https://github.com/caronc/apprise/wiki/Notify_join) | join:// | (TCP) 443 | join://apikey/device<br />join://apikey/device1/device2/deviceN/<br />join://apikey/group<br />join://apikey/groupA/groupB/groupN<br />join://apikey/DeviceA/groupA/groupN/DeviceN/
|
| [Join](https://github.com/caronc/apprise/wiki/Notify_join) | join:// | (TCP) 443 | join://apikey/device<br />join://apikey/device1/device2/deviceN/<br />join://apikey/group<br />join://apikey/groupA/groupB/groupN<br />join://apikey/DeviceA/groupA/groupN/DeviceN/
|
||||||
|
88
apprise/plugins/NotifyGuilded.py
Normal file
88
apprise/plugins/NotifyGuilded.py
Normal file
@ -0,0 +1,88 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (C) 2019 Chris Caron <lead2gold@gmail.com>
|
||||||
|
# All rights reserved.
|
||||||
|
#
|
||||||
|
# This code is licensed under the MIT License.
|
||||||
|
#
|
||||||
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
# of this software and associated documentation files(the "Software"), to deal
|
||||||
|
# in the Software without restriction, including without limitation the rights
|
||||||
|
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
|
||||||
|
# copies of the Software, and to permit persons to whom the Software is
|
||||||
|
# furnished to do so, subject to the following conditions :
|
||||||
|
#
|
||||||
|
# The above copyright notice and this permission notice shall be included in
|
||||||
|
# all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
|
||||||
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
# THE SOFTWARE.
|
||||||
|
|
||||||
|
# For this to work correctly you need to create a webhook. To do this just
|
||||||
|
# click on the little gear icon next to the channel you're part of. From
|
||||||
|
# here you'll be able to access the Webhooks menu and create a new one.
|
||||||
|
#
|
||||||
|
# When you've completed, you'll get a URL that looks a little like this:
|
||||||
|
# https://media.guilded.gg/webhooks/417429632418316298/\
|
||||||
|
# JHZ7lQml277CDHmQKMHI8qBe7bk2ZwO5UKjCiOAF7711o33MyqU344Qpgv7YTpadV_js
|
||||||
|
#
|
||||||
|
# Simplified, it looks like this:
|
||||||
|
# https://media.guilded.gg/webhooks/WEBHOOK_ID/WEBHOOK_TOKEN
|
||||||
|
#
|
||||||
|
# This plugin will simply work using the url of:
|
||||||
|
# guilded://WEBHOOK_ID/WEBHOOK_TOKEN
|
||||||
|
#
|
||||||
|
# API Documentation on Webhooks:
|
||||||
|
# - https://discord.com/developers/docs/resources/webhook
|
||||||
|
#
|
||||||
|
|
||||||
|
import re
|
||||||
|
from .NotifyDiscord import NotifyDiscord
|
||||||
|
|
||||||
|
|
||||||
|
class NotifyGuilded(NotifyDiscord):
|
||||||
|
"""
|
||||||
|
A wrapper to Guilded Notifications
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# The default descriptive name associated with the Notification
|
||||||
|
service_name = 'Guilded'
|
||||||
|
|
||||||
|
# The services URL
|
||||||
|
service_url = 'https://guilded.gg/'
|
||||||
|
|
||||||
|
# The default secure protocol
|
||||||
|
secure_protocol = 'guilded'
|
||||||
|
|
||||||
|
# Guilded Webhook
|
||||||
|
notify_url = 'https://media.guilded.gg/webhooks'
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def parse_native_url(url):
|
||||||
|
"""
|
||||||
|
Support https://media.guilded.gg/webhooks/WEBHOOK_ID/WEBHOOK_TOKEN
|
||||||
|
"""
|
||||||
|
|
||||||
|
result = re.match(
|
||||||
|
r'^https?://(media\.)?guilded\.gg/webhooks/'
|
||||||
|
# a UUID, but we do we really need to be _that_ picky?
|
||||||
|
r'(?P<webhook_id>[-0-9a-f]+)/'
|
||||||
|
r'(?P<webhook_token>[A-Z0-9_-]+)/?'
|
||||||
|
r'(?P<params>\?.+)?$', url, re.I)
|
||||||
|
|
||||||
|
if result:
|
||||||
|
return NotifyGuilded.parse_url(
|
||||||
|
'{schema}://{webhook_id}/{webhook_token}/{params}'.format(
|
||||||
|
schema=NotifyGuilded.secure_protocol,
|
||||||
|
webhook_id=result.group('webhook_id'),
|
||||||
|
webhook_token=result.group('webhook_token'),
|
||||||
|
params='' if not result.group('params')
|
||||||
|
else result.group('params')))
|
||||||
|
|
||||||
|
return None
|
@ -48,7 +48,7 @@ notification services that are out there. Apprise opens the door and makes
|
|||||||
it easy to access:
|
it easy to access:
|
||||||
|
|
||||||
Apprise API, AWS SES, AWS SNS, Boxcar, ClickSend, DAPNET, DingTalk, Discord,
|
Apprise API, AWS SES, AWS SNS, Boxcar, ClickSend, DAPNET, DingTalk, Discord,
|
||||||
E-Mail, Emby, Faast, FCM, Flock, Gitter, Google Chat, Gotify, Growl, Home
|
E-Mail, Emby, Faast, FCM, Flock, Gitter, Google Chat, Gotify, Growl, Guilded, Home
|
||||||
Assistant, IFTTT, Join, Kavenegar, KODI, Kumulos, LaMetric, MacOSX, Mailgun,
|
Assistant, IFTTT, Join, Kavenegar, KODI, Kumulos, LaMetric, MacOSX, Mailgun,
|
||||||
Mattermost, Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MQTT, MSG91,
|
Mattermost, Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MQTT, MSG91,
|
||||||
MyAndroid, Nexmo, Nextcloud, NextcloudTalk, Notica, Notifico, ntfy, Office365,
|
MyAndroid, Nexmo, Nextcloud, NextcloudTalk, Notica, Notifico, ntfy, Office365,
|
||||||
|
16
setup.py
16
setup.py
@ -71,14 +71,14 @@ setup(
|
|||||||
url='https://github.com/caronc/apprise',
|
url='https://github.com/caronc/apprise',
|
||||||
keywords='Push Notifications Alerts Email AWS SES SNS Boxcar ClickSend '
|
keywords='Push Notifications Alerts Email AWS SES SNS Boxcar ClickSend '
|
||||||
'DAPNET Dingtalk Discord Dbus Emby Faast FCM Flock Gitter Gnome '
|
'DAPNET Dingtalk Discord Dbus Emby Faast FCM Flock Gitter Gnome '
|
||||||
'Google Chat Gotify Growl Home Assistant IFTTT Join Kavenegar KODI '
|
'Google Chat Gotify Growl Guilded Home Assistant IFTTT Join Kavenegar '
|
||||||
'Kumulos LaMetric MacOS Mailgun Matrix Mattermost MessageBird MQTT '
|
'KODI Kumulos LaMetric MacOS Mailgun Matrix Mattermost MessageBird '
|
||||||
'MSG91 Nexmo Nextcloud NextcloudTalk Notica Notifico Ntfy Office365 '
|
'MQTT MSG91 Nexmo Nextcloud NextcloudTalk Notica Notifico Ntfy '
|
||||||
'OneSignal Opsgenie ParsePlatform PopcornNotify Prowl PushBullet '
|
'Office365 OneSignal Opsgenie ParsePlatform PopcornNotify Prowl '
|
||||||
'Pushjet Pushed Pushover PushSafer Reddit Rocket.Chat Ryver SendGrid '
|
'PushBullet Pushjet Pushed Pushover PushSafer Reddit Rocket.Chat '
|
||||||
'ServerChan Signal SimplePush Sinch Slack SMTP2Go SparkPost Spontit '
|
'Ryver SendGrid ServerChan Signal SimplePush Sinch Slack SMTP2Go '
|
||||||
'Streamlabs Stride Syslog Techulus Telegram Twilio Twist Twitter XBMC '
|
'SparkPost Spontit Streamlabs Stride Syslog Techulus Telegram Twilio '
|
||||||
'MSTeams Microsoft Windows Webex CLI API',
|
'Twist Twitter XBMC MSTeams Microsoft Windows Webex CLI API',
|
||||||
author='Chris Caron',
|
author='Chris Caron',
|
||||||
author_email='lead2gold@gmail.com',
|
author_email='lead2gold@gmail.com',
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
|
184
test/test_plugin_guilded.py
Normal file
184
test/test_plugin_guilded.py
Normal file
@ -0,0 +1,184 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (C) 2020 Chris Caron <lead2gold@gmail.com>
|
||||||
|
# All rights reserved.
|
||||||
|
#
|
||||||
|
# This code is licensed under the MIT License.
|
||||||
|
#
|
||||||
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
# of this software and associated documentation files(the "Software"), to deal
|
||||||
|
# in the Software without restriction, including without limitation the rights
|
||||||
|
# to use, copy, modify, merge, publish, distribute, sublicense, and / or sell
|
||||||
|
# copies of the Software, and to permit persons to whom the Software is
|
||||||
|
# furnished to do so, subject to the following conditions :
|
||||||
|
#
|
||||||
|
# The above copyright notice and this permission notice shall be included in
|
||||||
|
# all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
|
||||||
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
||||||
|
# THE SOFTWARE.
|
||||||
|
|
||||||
|
import os
|
||||||
|
import six
|
||||||
|
import mock
|
||||||
|
import pytest
|
||||||
|
import requests
|
||||||
|
from helpers import AppriseURLTester
|
||||||
|
from apprise import plugins
|
||||||
|
|
||||||
|
# Disable logging for a cleaner testing output
|
||||||
|
import logging
|
||||||
|
logging.disable(logging.CRITICAL)
|
||||||
|
|
||||||
|
# Attachment Directory
|
||||||
|
TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')
|
||||||
|
|
||||||
|
# Our Testing URLs
|
||||||
|
apprise_url_tests = (
|
||||||
|
('guilded://', {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# An invalid url
|
||||||
|
('guilded://:@/', {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# No webhook_token specified
|
||||||
|
('guilded://%s' % ('i' * 24), {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# Provide both an webhook id and a webhook token
|
||||||
|
('guilded://%s/%s' % ('i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
# Provide a temporary username
|
||||||
|
('guilded://l2g@%s/%s' % ('i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
# test image= field
|
||||||
|
('guilded://%s/%s?format=markdown&footer=Yes&image=Yes' % (
|
||||||
|
'i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
# don't include an image by default
|
||||||
|
'include_image': False,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s?format=markdown&footer=Yes&image=No&fields=no' % (
|
||||||
|
'i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s?format=markdown&footer=Yes&image=Yes' % (
|
||||||
|
'i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
('https://media.guilded.gg/webhooks/{}/{}'.format(
|
||||||
|
'0' * 10, 'B' * 40), {
|
||||||
|
# Native URL Support, support the provided guilded URL from their
|
||||||
|
# webpage.
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s?format=markdown&avatar=No&footer=No' % (
|
||||||
|
'i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
# different format support
|
||||||
|
('guilded://%s/%s?format=markdown' % ('i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s?format=text' % ('i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
# Test with avatar URL
|
||||||
|
('guilded://%s/%s?avatar_url=http://localhost/test.jpg' % (
|
||||||
|
'i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
}),
|
||||||
|
# Test without image set
|
||||||
|
('guilded://%s/%s' % ('i' * 24, 't' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
'requests_response_code': requests.codes.no_content,
|
||||||
|
# don't include an image by default
|
||||||
|
'include_image': False,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s/' % ('a' * 24, 'b' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
# force a failure
|
||||||
|
'response': False,
|
||||||
|
'requests_response_code': requests.codes.internal_server_error,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s/' % ('a' * 24, 'b' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
# throw a bizzare code forcing us to fail to look it up
|
||||||
|
'response': False,
|
||||||
|
'requests_response_code': 999,
|
||||||
|
}),
|
||||||
|
('guilded://%s/%s/' % ('a' * 24, 'b' * 64), {
|
||||||
|
'instance': plugins.NotifyGuilded,
|
||||||
|
# Throws a series of connection and transfer exceptions when this flag
|
||||||
|
# is set and tests that we gracfully handle them
|
||||||
|
'test_requests_exceptions': True,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_plugin_guilded_urls():
|
||||||
|
"""
|
||||||
|
NotifyGuilded() Apprise URLs
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Run our general tests
|
||||||
|
AppriseURLTester(tests=apprise_url_tests).run_all()
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch('requests.post')
|
||||||
|
def test_plugin_guilded_general(mock_post):
|
||||||
|
"""
|
||||||
|
NotifyGuilded() General Checks
|
||||||
|
|
||||||
|
"""
|
||||||
|
# Disable Throttling to speed testing
|
||||||
|
plugins.NotifyBase.request_rate_per_sec = 0
|
||||||
|
|
||||||
|
# Initialize some generic (but valid) tokens
|
||||||
|
webhook_id = 'A' * 24
|
||||||
|
webhook_token = 'B' * 64
|
||||||
|
|
||||||
|
# Prepare Mock
|
||||||
|
mock_post.return_value = requests.Request()
|
||||||
|
mock_post.return_value.status_code = requests.codes.ok
|
||||||
|
|
||||||
|
# Invalid webhook id
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifyGuilded(webhook_id=None, webhook_token=webhook_token)
|
||||||
|
# Invalid webhook id (whitespace)
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifyGuilded(webhook_id=" ", webhook_token=webhook_token)
|
||||||
|
|
||||||
|
# Invalid webhook token
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifyGuilded(webhook_id=webhook_id, webhook_token=None)
|
||||||
|
# Invalid webhook token (whitespace)
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifyGuilded(webhook_id=webhook_id, webhook_token=" ")
|
||||||
|
|
||||||
|
obj = plugins.NotifyGuilded(
|
||||||
|
webhook_id=webhook_id,
|
||||||
|
webhook_token=webhook_token,
|
||||||
|
footer=True, thumbnail=False)
|
||||||
|
|
||||||
|
# Test that we get a string response
|
||||||
|
assert isinstance(obj.url(), six.string_types) is True
|
Loading…
x
Reference in New Issue
Block a user