-
-
Notifications
You must be signed in to change notification settings - Fork 374
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
294 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ Boxcar | |
| BulkSMS | ||
| BulkVS | ||
| Burst SMS | ||
| Chantify | ||
| Chat | ||
| CLI | ||
| ClickSend | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| # -*- 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. | ||
|
|
||
| # Chantify | ||
| # 1. Visit https://chanify.net/ | ||
|
|
||
| # The API URL will look something like this: | ||
| # https://api.chanify.net/v1/sender/token | ||
| # | ||
|
|
||
| import requests | ||
|
|
||
| from .NotifyBase import NotifyBase | ||
| from ..common import NotifyType | ||
| from ..utils import validate_regex | ||
| from ..AppriseLocale import gettext_lazy as _ | ||
|
|
||
|
|
||
| class NotifyChantify(NotifyBase): | ||
| """ | ||
| A wrapper for Chantify Notifications | ||
| """ | ||
|
|
||
| # The default descriptive name associated with the Notification | ||
| service_name = _('Chantify') | ||
|
|
||
| # The services URL | ||
| service_url = 'https://api.chanify.net/v1/sender' | ||
|
|
||
| # The default secure protocol | ||
| secure_protocol = 'chantify' | ||
|
|
||
| # A URL that takes you to the setup/help of the specific protocol | ||
| setup_url = 'https://github.com/caronc/apprise/wiki/Notify_chantify' | ||
|
|
||
| # Notification URL | ||
| notify_url = 'https://api.chanify.net/v1/sender/{token}/' | ||
|
|
||
| # Define object templates | ||
| templates = ( | ||
| '{schema}://{token}', | ||
| ) | ||
|
|
||
| # The title is not used | ||
| title_maxlen = 0 | ||
|
|
||
| # 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 Chantify Object | ||
| """ | ||
| super().__init__(**kwargs) | ||
|
|
||
| self.token = validate_regex( | ||
| token, *self.template_tokens['token']['regex']) | ||
| if not self.token: | ||
| msg = 'The Chantify 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/x-www-form-urlencoded', | ||
| } | ||
|
|
||
| # Our Message | ||
| payload = { | ||
| 'text': body | ||
| } | ||
|
|
||
| self.logger.debug('Chantify GET URL: %s (cert_verify=%r)' % ( | ||
| self.notify_url, self.verify_certificate)) | ||
| self.logger.debug('Chantify 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=payload, | ||
| headers=headers, | ||
| verify=self.verify_certificate, | ||
| timeout=self.request_timeout, | ||
| ) | ||
| if r.status_code != requests.codes.ok: | ||
| # We had a problem | ||
| status_str = \ | ||
| NotifyChantify.http_response_code_lookup(r.status_code) | ||
|
|
||
| self.logger.warning( | ||
| 'Failed to send Chantify 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 Chantify notification.') | ||
|
|
||
| except requests.RequestException as e: | ||
| self.logger.warning( | ||
| 'A Connection error occurred sending Chantify ' | ||
| '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=NotifyChantify.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'] = NotifyChantify.unquote(results['qsd']['token']) | ||
|
|
||
| else: | ||
| results['token'] = NotifyChantify.unquote(results['host']) | ||
|
|
||
| return results |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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.NotifyChantify import NotifyChantify | ||
| from helpers import AppriseURLTester | ||
|
|
||
| # Disable logging for a cleaner testing output | ||
| import logging | ||
| logging.disable(logging.CRITICAL) | ||
|
|
||
| # Our Testing URLs | ||
| apprise_url_tests = ( | ||
| ('chantify://', { | ||
| 'instance': TypeError, | ||
| }), | ||
| ('chantify://:@/', { | ||
| 'instance': TypeError, | ||
| }), | ||
| ('chantify://%badtoken%', { | ||
| 'instance': TypeError, | ||
| }), | ||
| ('chantify://abc123', { | ||
| # Test token | ||
| 'instance': NotifyChantify, | ||
| }), | ||
| ('chantify://?token=abc123', { | ||
| # Test token | ||
| 'instance': NotifyChantify, | ||
| }), | ||
| ('chantify://token', { | ||
| 'instance': NotifyChantify, | ||
| # force a failure | ||
| 'response': False, | ||
| 'requests_response_code': requests.codes.internal_server_error, | ||
| }), | ||
| ('chantify://token', { | ||
| 'instance': NotifyChantify, | ||
| # throw a bizzare code forcing us to fail to look it up | ||
| 'response': False, | ||
| 'requests_response_code': 999, | ||
| }), | ||
| ('chantify://token', { | ||
| 'instance': NotifyChantify, | ||
| # 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_chantify_urls(): | ||
| """ | ||
| NotifyChantify() Apprise URLs | ||
| """ | ||
|
|
||
| # Run our general tests | ||
| AppriseURLTester(tests=apprise_url_tests).run_all() |