mirror of https://github.com/caronc/apprise
Chris Caron
8 months ago
committed by
GitHub
5 changed files with 322 additions and 4 deletions
@ -0,0 +1,231 @@
|
||||
# -*- coding: utf-8 -*- |
||||
# BSD 2-Clause License |
||||
# |
||||
# Apprise - Push Notification Library. |
||||
# Copyright (c) 2024, Chris Caron <lead2gold@gmail.com> |
||||
# |
||||
# Redistribution and use in source and binary forms, with or without |
||||
# modification, are permitted provided that the following conditions are met: |
||||
# |
||||
# 1. Redistributions of source code must retain the above copyright notice, |
||||
# this list of conditions and the following disclaimer. |
||||
# |
||||
# 2. Redistributions in binary form must reproduce the above copyright notice, |
||||
# this list of conditions and the following disclaimer in the documentation |
||||
# and/or other materials provided with the distribution. |
||||
# |
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
||||
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
||||
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
||||
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
||||
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
||||
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
||||
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
||||
# POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
# Feishu |
||||
# 1. Visit https://open.feishu.cn |
||||
|
||||
# Custom Bot Setup |
||||
# https://open.feishu.cn/document/client-docs/bot-v3/add-custom-bot |
||||
# |
||||
|
||||
import requests |
||||
from json import dumps |
||||
|
||||
from .NotifyBase import NotifyBase |
||||
from ..common import NotifyType |
||||
from ..utils import validate_regex |
||||
from ..AppriseLocale import gettext_lazy as _ |
||||
|
||||
|
||||
class NotifyFeishu(NotifyBase): |
||||
""" |
||||
A wrapper for Feishu Notifications |
||||
""" |
||||
|
||||
# The default descriptive name associated with the Notification |
||||
service_name = _('Feishu') |
||||
|
||||
# The services URL |
||||
service_url = 'https://open.feishu.cn/' |
||||
|
||||
# The default secure protocol |
||||
secure_protocol = 'feishu' |
||||
|
||||
# A URL that takes you to the setup/help of the specific protocol |
||||
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_feishu' |
||||
|
||||
# Notification URL |
||||
notify_url = 'https://open.feishu.cn/open-apis/bot/v2/hook/{token}/' |
||||
|
||||
# Define object templates |
||||
templates = ( |
||||
'{schema}://{token}', |
||||
) |
||||
|
||||
# The title is not used |
||||
title_maxlen = 0 |
||||
|
||||
# Limit is documented to be 20K message sizes. This number safely |
||||
# allows padding around that size. |
||||
body_maxlen = 19985 |
||||
|
||||
# Define our tokens; these are the minimum tokens required required to |
||||
# be passed into this function (as arguments). The syntax appends any |
||||
# previously defined in the base package and builds onto them |
||||
template_tokens = dict(NotifyBase.template_tokens, **{ |
||||
'token': { |
||||
'name': _('Token'), |
||||
'type': 'string', |
||||
'private': True, |
||||
'required': True, |
||||
'regex': (r'^[A-Z0-9_-]+$', 'i'), |
||||
}, |
||||
}) |
||||
|
||||
# Define our template arguments |
||||
template_args = dict(NotifyBase.template_args, **{ |
||||
'token': { |
||||
'alias_of': 'token', |
||||
}, |
||||
}) |
||||
|
||||
def __init__(self, token, **kwargs): |
||||
""" |
||||
Initialize Feishu Object |
||||
""" |
||||
super().__init__(**kwargs) |
||||
|
||||
self.token = validate_regex( |
||||
token, *self.template_tokens['token']['regex']) |
||||
if not self.token: |
||||
msg = 'The Feishu token specified ({}) is invalid.'\ |
||||
.format(token) |
||||
self.logger.warning(msg) |
||||
raise TypeError(msg) |
||||
|
||||
return |
||||
|
||||
def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): |
||||
""" |
||||
Send our notification |
||||
""" |
||||
|
||||
# prepare our headers |
||||
headers = { |
||||
'User-Agent': self.app_id, |
||||
'Content-Type': "application/json", |
||||
} |
||||
|
||||
# Our Message |
||||
payload = { |
||||
'msg_type': 'text', |
||||
"content": { |
||||
"text": body, |
||||
} |
||||
} |
||||
|
||||
self.logger.debug('Feishu GET URL: %s (cert_verify=%r)' % ( |
||||
self.notify_url, self.verify_certificate)) |
||||
self.logger.debug('Feishu Payload: %s' % str(payload)) |
||||
|
||||
# Always call throttle before any remote server i/o is made |
||||
self.throttle() |
||||
|
||||
try: |
||||
r = requests.post( |
||||
self.notify_url.format(token=self.token), |
||||
data=dumps(payload).encode('utf-8'), |
||||
headers=headers, |
||||
verify=self.verify_certificate, |
||||
timeout=self.request_timeout, |
||||
) |
||||
|
||||
# |
||||
# Sample Responses |
||||
# |
||||
# Valid: |
||||
# { |
||||
# "code": 0, |
||||
# "data": {}, |
||||
# "msg": "success" |
||||
# } |
||||
|
||||
# Invalid (non 200 response): |
||||
# { |
||||
# "code": 9499, |
||||
# "msg": "Bad Request", |
||||
# "data": {} |
||||
# } |
||||
if r.status_code != requests.codes.ok: |
||||
# We had a problem |
||||
status_str = \ |
||||
NotifyFeishu.http_response_code_lookup(r.status_code) |
||||
|
||||
self.logger.warning( |
||||
'Failed to send Feishu notification: ' |
||||
'{}{}error={}.'.format( |
||||
status_str, |
||||
', ' if status_str else '', |
||||
r.status_code)) |
||||
|
||||
self.logger.debug('Response Details:\r\n{}'.format(r.content)) |
||||
|
||||
# Return; we're done |
||||
return False |
||||
|
||||
else: |
||||
self.logger.info('Sent Feishu notification.') |
||||
|
||||
except requests.RequestException as e: |
||||
self.logger.warning( |
||||
'A Connection error occurred sending Feishu ' |
||||
'notification.') |
||||
self.logger.debug('Socket Exception: %s' % str(e)) |
||||
|
||||
# Return; we're done |
||||
return False |
||||
|
||||
return True |
||||
|
||||
def url(self, privacy=False, *args, **kwargs): |
||||
""" |
||||
Returns the URL built dynamically based on specified arguments. |
||||
""" |
||||
|
||||
# Prepare our parameters |
||||
params = self.url_parameters(privacy=privacy, *args, **kwargs) |
||||
|
||||
return '{schema}://{token}/?{params}'.format( |
||||
schema=self.secure_protocol, |
||||
token=self.pprint(self.token, privacy, safe=''), |
||||
params=NotifyFeishu.urlencode(params), |
||||
) |
||||
|
||||
@staticmethod |
||||
def parse_url(url): |
||||
""" |
||||
Parses the URL and returns enough arguments that can allow |
||||
us to re-instantiate this object. |
||||
|
||||
""" |
||||
|
||||
# parse_url already handles getting the `user` and `password` fields |
||||
# populated. |
||||
results = NotifyBase.parse_url(url, verify_host=False) |
||||
if not results: |
||||
# We're done early as we couldn't load the results |
||||
return results |
||||
|
||||
# Allow over-ride |
||||
if 'token' in results['qsd'] and len(results['qsd']['token']): |
||||
results['token'] = NotifyFeishu.unquote(results['qsd']['token']) |
||||
|
||||
else: |
||||
results['token'] = NotifyFeishu.unquote(results['host']) |
||||
|
||||
return results |
||||
@ -0,0 +1,85 @@
|
||||
# -*- coding: utf-8 -*- |
||||
# BSD 2-Clause License |
||||
# |
||||
# Apprise - Push Notification Library. |
||||
# Copyright (c) 2024, Chris Caron <lead2gold@gmail.com> |
||||
# |
||||
# Redistribution and use in source and binary forms, with or without |
||||
# modification, are permitted provided that the following conditions are met: |
||||
# |
||||
# 1. Redistributions of source code must retain the above copyright notice, |
||||
# this list of conditions and the following disclaimer. |
||||
# |
||||
# 2. Redistributions in binary form must reproduce the above copyright notice, |
||||
# this list of conditions and the following disclaimer in the documentation |
||||
# and/or other materials provided with the distribution. |
||||
# |
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
||||
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
||||
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
||||
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
||||
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
||||
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
||||
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
||||
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
||||
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
||||
# POSSIBILITY OF SUCH DAMAGE. |
||||
|
||||
import requests |
||||
|
||||
from apprise.plugins.NotifyFeishu import NotifyFeishu |
||||
from helpers import AppriseURLTester |
||||
|
||||
# Disable logging for a cleaner testing output |
||||
import logging |
||||
logging.disable(logging.CRITICAL) |
||||
|
||||
# Our Testing URLs |
||||
apprise_url_tests = ( |
||||
('feishu://', { |
||||
'instance': TypeError, |
||||
}), |
||||
('feishu://:@/', { |
||||
'instance': TypeError, |
||||
}), |
||||
('feishu://%badtoken%', { |
||||
'instance': TypeError, |
||||
}), |
||||
('feishu://abc123', { |
||||
# Test token |
||||
'instance': NotifyFeishu, |
||||
}), |
||||
('feishu://?token=abc123', { |
||||
# Test token |
||||
'instance': NotifyFeishu, |
||||
}), |
||||
('feishu://token', { |
||||
'instance': NotifyFeishu, |
||||
# force a failure |
||||
'response': False, |
||||
'requests_response_code': requests.codes.internal_server_error, |
||||
}), |
||||
('feishu://token', { |
||||
'instance': NotifyFeishu, |
||||
# throw a bizzare code forcing us to fail to look it up |
||||
'response': False, |
||||
'requests_response_code': 999, |
||||
}), |
||||
('feishu://token', { |
||||
'instance': NotifyFeishu, |
||||
# 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_feishu_urls(): |
||||
""" |
||||
NotifyFeishu() Apprise URLs |
||||
|
||||
""" |
||||
|
||||
# Run our general tests |
||||
AppriseURLTester(tests=apprise_url_tests).run_all() |
||||
Loading…
Reference in new issue