Added PushDeer Support (#904)

KEYWORDS

@@ -65,6 +65,7 @@ Push Notifications
 Pushover
 PushSafer
 Pushy
+PushDeer
 Reddit
 Rocket.Chat
 Ryver

README.md

@@ -105,6 +105,7 @@ The table below identifies the services this tool supports and some example serv
 | [Pushover](https://github.com/caronc/apprise/wiki/Notify_pushover)  | pover://   | (TCP) 443   | pover://user@token<br />pover://user@token/DEVICE<br />pover://user@token/DEVICE1/DEVICE2/DEVICEN<br />**Note**: you must specify both your user_id and token
 | [PushSafer](https://github.com/caronc/apprise/wiki/Notify_pushsafer)  | psafer:// or psafers://  | (TCP) 80 or 443  | psafer://privatekey<br />psafers://privatekey/DEVICE<br />psafer://privatekey/DEVICE1/DEVICE2/DEVICEN
 | [Pushy](https://github.com/caronc/apprise/wiki/Notify_pushy)  | pushy://  | (TCP) 443  | pushy://apikey/DEVICE<br />pushy://apikey/DEVICE1/DEVICE2/DEVICEN<br />pushy://apikey/TOPIC<br />pushy://apikey/TOPIC1/TOPIC2/TOPICN
+| [PushDeer](https://github.com/caronc/apprise/wiki/Notify_pushdeer) | pushdeer:// or pushdeers:// | (TCP) 80 or 443 | pushdeer://pushKey<br />pushdeer://hostname/pushKey<br />pushdeer://hostname:port/pushKey
 | [Reddit](https://github.com/caronc/apprise/wiki/Notify_reddit) | reddit:// | (TCP) 443   | reddit://user:password@app_id/app_secret/subreddit<br />reddit://user:password@app_id/app_secret/sub1/sub2/subN
 | [Rocket.Chat](https://github.com/caronc/apprise/wiki/Notify_rocketchat) | rocket:// or rockets://  | (TCP) 80 or 443   | rocket://user:password@hostname/RoomID/Channel<br />rockets://user:password@hostname:443/#Channel1/#Channel1/RoomID<br />rocket://user:password@hostname/#Channel<br />rocket://webhook@hostname<br />rockets://webhook@hostname/@User/#Channel
 | [Ryver](https://github.com/caronc/apprise/wiki/Notify_ryver) | ryver://  | (TCP) 443   | ryver://Organization/Token<br />ryver://botname@Organization/Token

apprise/plugins/NotifyPushDeer.py

@@ -0,0 +1,222 @@
+# -*- coding: utf-8 -*-
+# BSD 3-Clause License
+#
+# Apprise - Push Notification Library.
+# Copyright (c) 2023, 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.
+#
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+# 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 ..common import NotifyType
+from .NotifyBase import NotifyBase
+from ..utils import validate_regex
+from ..AppriseLocale import gettext_lazy as _
+
+# Syntax:
+#  schan://{key}/
+
+
+class NotifyPushDeer(NotifyBase):
+    """
+    A wrapper for PushDeer Notifications
+    """
+
+    # The default descriptive name associated with the Notification
+    service_name = 'PushDeer'
+
+    # The services URL
+    service_url = 'https://www.pushdeer.com/'
+
+    # Insecure Protocol Access
+    protocol = 'pushdeer'
+
+    # Secure Protocol
+    secure_protocol = 'pushdeers'
+
+    # A URL that takes you to the setup/help of the specific protocol
+    setup_url = 'https://github.com/caronc/apprise/wiki/Notify_PushDeer'
+
+    # Default hostname
+    default_hostname = 'api2.pushdeer.com'
+
+    # PushDeer API
+    notify_url = '{schema}://{host}:{port}/message/push?pushkey={pushKey}'
+
+    # Define object templates
+    templates = (
+        '{schema}://{pushkey}',
+        '{schema}://{host}/{pushkey}',
+        '{schema}://{host}:{port}/{pushkey}',
+    )
+
+    # Define our template tokens
+    template_tokens = dict(NotifyBase.template_tokens, **{
+        'host': {
+            'name': _('Hostname'),
+            'type': 'string',
+        },
+        'port': {
+            'name': _('Port'),
+            'type': 'int',
+            'min': 1,
+            'max': 65535,
+        },
+        'pushkey': {
+            'name': _('Pushkey'),
+            'type': 'string',
+            'private': True,
+            'required': True,
+            'regex': (r'^[a-z0-9]+$', 'i'),
+        },
+    })
+
+    def __init__(self, pushkey, **kwargs):
+        """
+        Initialize PushDeer Object
+        """
+        super().__init__(**kwargs)
+
+        # PushKey (associated with project)
+        self.push_key = validate_regex(
+            pushkey, *self.template_tokens['pushkey']['regex'])
+        if not self.push_key:
+            msg = 'An invalid PushDeer API Pushkey ' \
+                  '({}) was specified.'.format(pushkey)
+            self.logger.warning(msg)
+            raise TypeError(msg)
+
+    def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
+        """
+        Perform PushDeer Notification
+        """
+
+        # Prepare our persistent_notification.create payload
+        payload = {
+            'text': title if title else body,
+            'type': 'text',
+            'desp': body if title else '',
+        }
+
+        # Set our schema
+        schema = 'https' if self.secure else 'http'
+
+        # Set host
+        host = self.default_hostname
+        if self.host:
+            host = self.host
+
+        # Set port
+        port = 443 if self.secure else 80
+        if self.port:
+            port = self.port
+
+        # Our Notification URL
+        notify_url = self.notify_url.format(
+            schema=schema, host=host, port=port, pushKey=self.push_key)
+
+        # Some Debug Logging
+        self.logger.debug('PushDeer URL: {} (cert_verify={})'.format(
+            notify_url, self.verify_certificate))
+        self.logger.debug('PushDeer Payload: {}'.format(payload))
+
+        # Always call throttle before any remote server i/o is made
+        self.throttle()
+
+        try:
+            r = requests.post(
+                notify_url,
+                data=payload,
+                timeout=self.request_timeout,
+            )
+
+            if r.status_code != requests.codes.ok:
+                # We had a problem
+                status_str = \
+                    NotifyPushDeer.http_response_code_lookup(
+                        r.status_code)
+
+                self.logger.warning(
+                    'Failed to send PushDeer notification: '
+                    '{}{}error={}.'.format(
+                        status_str,
+                        ', ' if status_str else '',
+                        r.status_code))
+
+                self.logger.debug(
+                    'Response Details:\r\n{}'.format(r.content))
+                return False
+
+            else:
+                self.logger.info('Sent PushDeer notification.')
+
+        except requests.RequestException as e:
+            self.logger.warning(
+                'A Connection error occured sending PushDeer '
+                'notification.'
+            )
+            self.logger.debug('Socket Exception: %s' % str(e))
+            return False
+
+        return True
+
+    def url(self, privacy=False):
+        """
+        Returns the URL built dynamically based on specified arguments.
+        """
+
+        if self.host:
+            url = '{schema}://{host}{port}/{pushkey}'
+        else:
+            url = '{schema}://{pushkey}'
+
+        return url.format(
+            schema=self.secure_protocol if self.secure else self.protocol,
+            host=self.host,
+            port='' if not self.port else ':{}'.format(self.port),
+            pushkey=self.pprint(self.push_key, privacy, safe=''))
+
+    @staticmethod
+    def parse_url(url):
+        """
+        Parses the URL and returns enough arguments that can allow
+        us to substantiate this object.
+        """
+        results = NotifyBase.parse_url(url, verify_host=False)
+        if not results:
+            # We're done early as we couldn't parse the URL
+            return results
+
+        fullpaths = NotifyPushDeer.split_path(results['fullpath'])
+
+        if len(fullpaths) == 0:
+            results['pushkey'] = results['host']
+            results['host'] = None
+        else:
+            results['pushkey'] = fullpaths.pop()
+
+        return results

packaging/redhat/python-apprise.spec

@@ -50,8 +50,8 @@ LaMetric, Line, MacOSX, Mailgun, Mastodon, Mattermost, Matrix, MessageBird,
 Microsoft Windows, Microsoft Teams, Misskey, MQTT, MSG91, MyAndroid, Nexmo,
 Nextcloud, NextcloudTalk, Notica, Notifico, ntfy, Office365, OneSignal,
 Opsgenie, PagerDuty, PagerTree, ParsePlatform, PopcornNotify, Prowl, Pushalot,
-PushBullet, Pushjet, Pushover, PushSafer, Pushy, Reddit, Rocket.Chat, SendGrid,
+PushBullet, Pushjet, Pushover, PushSafer, Pushy, PushDeer, Reddit, Rocket.Chat,
-ServerChan, Signal, SimplePush, Sinch, Slack, SMSEagle, SMTP2Go, Spontit,
+SendGrid, ServerChan, Signal, SimplePush, Sinch, Slack, SMSEagle, SMTP2Go, Spontit,
 SparkPost, Super Toasty, Streamlabs, Stride, Syslog, Techulus Push, Telegram,
 Twilio, Twitter, Twist, XBMC, Voipms, Vonage, WhatsApp, Webex Teams}
 

test/test_plugin_pushdeer.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+# BSD 3-Clause License
+#
+# Apprise - Push Notification Library.
+# Copyright (c) 2023, 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.
+#
+# 3. Neither the name of the copyright holder nor the names of its
+#    contributors may be used to endorse or promote products derived from
+#    this software without specific prior written permission.
+#
+# 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.
+
+from unittest import mock
+
+import requests
+from apprise import Apprise
+from apprise.plugins.NotifyPushDeer import NotifyPushDeer
+from helpers import AppriseURLTester
+
+# Disable logging for a cleaner testing output
+import logging
+logging.disable(logging.CRITICAL)
+
+# Our Testing URLs
+apprise_url_tests = (
+    ('pushdeer://', {
+        'instance': TypeError,
+    }),
+    ('pushdeers://', {
+        'instance': TypeError,
+    }),
+    ('pushdeer://localhost/{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # throw a bizzare code forcing us to fail to look it up
+        'response': False,
+        'requests_response_code': 999,
+    }),
+    ('pushdeer://localhost/{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # Throws a series of connection and transfer exceptions when this flag
+        # is set and tests that we gracfully handle them
+        'test_requests_exceptions': True,
+    }),
+    ('pushdeer://localhost:80/{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # throw a bizzare code forcing us to fail to look it up
+        'response': False,
+        'requests_response_code': 999,
+    }),
+    ('pushdeer://localhost:80/{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # Throws a series of connection and transfer exceptions when this flag
+        # is set and tests that we gracfully handle them
+        'test_requests_exceptions': True,
+    }),
+    ('pushdeer://{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # throw a bizzare code forcing us to fail to look it up
+        'response': False,
+        'requests_response_code': requests.codes.internal_server_error,
+    }),
+    ('pushdeer://{}'.format('a' * 8), {
+        'instance': NotifyPushDeer,
+        # 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_pushdeer_urls():
+    """
+    NotifyPushDeer() Apprise URLs
+
+    """
+
+    # Run our general tests
+    AppriseURLTester(tests=apprise_url_tests).run_all()
+
+
+@mock.patch('requests.post')
+def test_plugin_pushdeer_general(mock_post):
+    """
+    NotifyPushDeer() General Checks
+
+    """
+
+    response = mock.Mock()
+    response.content = ''
+    response.status_code = requests.codes.ok
+
+    # Prepare Mock
+    mock_post.return_value = response
+
+    # Variation Initializations
+    obj = Apprise.instantiate('pushdeer://localhost/pushKey')
+    assert isinstance(obj, NotifyPushDeer) is True
+    assert isinstance(obj.url(), str) is True
+
+    # Send Notification
+    assert obj.send(body="test") is True
+
+    assert mock_post.call_count == 1
+    assert mock_post.call_args_list[0][0][0] == \
+        'http://localhost:80/message/push?pushkey=pushKey'