Added Techulus Push Notifications (#138)

README.md

@@ -52,6 +52,7 @@ The table below identifies the services this tool supports and some example serv
 | [Prowl](https://github.com/caronc/apprise/wiki/Notify_prowl) | prowl://   | (TCP) 443    | prowl://apikey<br />prowl://apikey/providerkey
 | [PushBullet](https://github.com/caronc/apprise/wiki/Notify_pushbullet) | pbul://    | (TCP) 443    | pbul://accesstoken<br />pbul://accesstoken/#channel<br/>pbul://accesstoken/A_DEVICE_ID<br />pbul://accesstoken/[email protected]<br />pbul://accesstoken/#channel/#channel2/[email protected]/DEVICE
 | [Pushjet](https://github.com/caronc/apprise/wiki/Notify_pushjet) | pjet:// or pjets:// | (TCP) 80 or 443 | pjet://secret@hostname<br />pjet://secret@hostname:port<br />pjets://secret@hostname<br />pjets://secret@hostname:port
+| [Push (Techulus)](https://github.com/caronc/apprise/wiki/Notify_techulus) | push://    | (TCP) 443    | push://apikey/
 | [Pushed](https://github.com/caronc/apprise/wiki/Notify_pushed) | pushed://    | (TCP) 443    | pushed://appkey/appsecret/<br/>pushed://appkey/appsecret/#ChannelAlias<br/>pushed://appkey/appsecret/#ChannelAlias1/#ChannelAlias2/#ChannelAliasN<br/>pushed://appkey/appsecret/@UserPushedID<br/>pushed://appkey/appsecret/@UserPushedID1/@UserPushedID2/@UserPushedIDN
 | [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
 | [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

apprise/plugins/NotifyTechulusPush.py

@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2019 Chris Caron <[email protected]>
+# 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.
+
+# To use this plugin, you need to download the app
+# - Apple: https://itunes.apple.com/us/app/\
+#              push-by-techulus/id1444391917?ls=1&mt=8
+# - Android: https://play.google.com/store/apps/\
+#              details?id=com.techulus.push
+#
+# You have to sign up through the account via your mobile device.
+#
+# Once you've got your account, you can get your API key from here:
+#   https://push.techulus.com/login.html
+#
+# You can also just get the {apikey} right out of the phone app that is
+# installed.
+#
+# your {apikey} will look something like:
+#   b444a40f-3db9-4224-b489-9a514c41c009
+#
+# You will need to assemble all of your URLs for this plugin to work as:
+#   push://{apikey}
+#
+# Resources
+# - https://push.techulus.com/ - Main Website
+# - https://pushtechulus.docs.apiary.io - API Documentation
+
+import re
+import requests
+from json import dumps
+
+from .NotifyBase import NotifyBase
+from ..common import NotifyType
+from ..AppriseLocale import gettext_lazy as _
+
+# Token required as part of the API request
+# Used to prepare our UUID regex matching
+UUID4_RE = \
+    r'[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}'
+
+# API Key
+VALIDATE_APIKEY = re.compile(UUID4_RE, re.I)
+
+
+class NotifyTechulusPush(NotifyBase):
+    """
+    A wrapper for Techulus Push Notifications
+    """
+
+    # The default descriptive name associated with the Notification
+    service_name = 'Techulus Push'
+
+    # The services URL
+    service_url = 'https://push.techulus.com'
+
+    # The default secure protocol
+    secure_protocol = 'push'
+
+    # A URL that takes you to the setup/help of the specific protocol
+    setup_url = 'https://github.com/caronc/apprise/wiki/Notify_techulus'
+
+    # Techulus Push uses the http protocol with JSON requests
+    notify_url = 'https://push.techulus.com/api/v1/notify'
+
+    # The maximum allowable characters allowed in the body per message
+    body_maxlen = 1000
+
+    # Define object templates
+    templates = (
+        '{schema}://{apikey}',
+    )
+
+    # Define our template apikeys
+    template_tokens = dict(NotifyBase.template_tokens, **{
+        'apikey': {
+            'name': _('API Key'),
+            'type': 'string',
+            'private': True,
+            'required': True,
+            'regex': (UUID4_RE, 'i'),
+        },
+    })
+
+    def __init__(self, apikey, **kwargs):
+        """
+        Initialize Techulus Push Object
+        """
+        super(NotifyTechulusPush, self).__init__(**kwargs)
+
+        if not apikey:
+            msg = 'The Techulus Push apikey is not specified.'
+            self.logger.warning(msg)
+            raise TypeError(msg)
+
+        if not VALIDATE_APIKEY.match(apikey.strip()):
+            msg = 'The Techulus Push apikey specified ({}) is invalid.'\
+                .format(apikey)
+            self.logger.warning(msg)
+            raise TypeError(msg)
+
+        # The apikey associated with the account
+        self.apikey = apikey.strip()
+
+    def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs):
+        """
+        Perform Techulus Push Notification
+        """
+
+        # Setup our headers
+        headers = {
+            'User-Agent': self.app_id,
+            'Content-Type': 'application/json',
+            'x-api-key': self.apikey,
+        }
+
+        payload = {
+            'title': title,
+            'body': body,
+        }
+
+        self.logger.debug('Techulus Push POST URL: %s (cert_verify=%r)' % (
+            self.notify_url, self.verify_certificate,
+        ))
+        self.logger.debug('Techulus Push Payload: %s' % str(payload))
+
+        # Always call throttle before any remote server i/o is made
+        self.throttle()
+        try:
+            r = requests.post(
+                self.notify_url,
+                data=dumps(payload),
+                headers=headers,
+                verify=self.verify_certificate,
+            )
+            if r.status_code not in (
+                    requests.codes.ok, requests.codes.no_content):
+                # We had a problem
+                status_str = \
+                    NotifyTechulusPush.http_response_code_lookup(
+                        r.status_code)
+
+                self.logger.warning(
+                    'Failed to send Techulus Push 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 Techulus Push notification.')
+
+        except requests.RequestException as e:
+            self.logger.warning(
+                'A Connection error occured sending Techulus Push '
+                'notification.'
+            )
+            self.logger.debug('Socket Exception: %s' % str(e))
+
+            return False
+
+        return True
+
+    def url(self):
+        """
+        Returns the URL built dynamically based on specified arguments.
+        """
+
+        # Define any arguments set
+        args = {
+            'format': self.notify_format,
+            'overflow': self.overflow_mode,
+            'verify': 'yes' if self.verify_certificate else 'no',
+        }
+
+        return '{schema}://{apikey}/?{args}'.format(
+            schema=self.secure_protocol,
+            apikey=NotifyTechulusPush.quote(self.apikey, safe=''),
+            args=NotifyTechulusPush.urlencode(args),
+        )
+
+    @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 load the results
+            return results
+
+        # The first apikey is stored in the hostname
+        results['apikey'] = NotifyTechulusPush.unquote(results['host'])
+
+        return results

packaging/redhat/python-apprise.spec

@@ -50,8 +50,8 @@ it easy to access:
 Boxcar, Discord, E-Mail, Emby, Faast, Flock, Gitter, Gotify, Growl, IFTTT,
 Join, KODI, Mailgun, MatterMost, Matrix, Microsoft Windows Notifications,
 Microsoft Teams, Nexmo, Notify MyAndroid, Prowl, Pushalot, PushBullet, Pushjet,
-Pushover, Rocket.Chat, Slack, Super Toasty, Stride, Telegram, Twilio, Twitter,
-Twist, XBMC, XMPP, Webex Teams}
+Pushover, Rocket.Chat, Slack, Super Toasty, Stride, Techulus Push, Telegram,
+Twilio, Twitter, Twist, XBMC, XMPP, Webex Teams}
 
 Name:           python-%{pypi_name}
 Version:        0.7.8

setup.py

@@ -72,8 +72,8 @@
     keywords='Push Notifications Alerts Email AWS SNS Boxcar Discord Dbus '
         'Emby Faast Flock Gitter Gnome Gotify Growl IFTTT Join KODI Mailgun '
         'Matrix Mattermost Nexmo Prowl PushBullet Pushjet Pushed Pushover '
-        'Rocket.Chat Ryver Slack Stride Telegram Twilio Twist Twitter XBMC '
-        'Microsoft MSTeams Windows Webex CLI API',
+        'Rocket.Chat Ryver Slack Stride Techulus Push Telegram Twilio Twist '
+        'Twitter XBMC Microsoft MSTeams Windows Webex CLI API',
     author='Chris Caron',
     author_email='[email protected]',
     packages=find_packages(),

test/test_rest_plugins.py

@@ -1335,6 +1335,43 @@
         'test_requests_exceptions': True,
     }),
 
+    ##################################
+    # NotifyTechulusPush
+    ##################################
+    ('push://', {
+        # Missing APIKey
+        'instance': TypeError,
+    }),
+    # Invalid APIKey
+    ('push://%s' % ('+' * 24), {
+        'instance': TypeError,
+    }),
+    # APIkey
+    ('push://%s' % UUID4, {
+        'instance': plugins.NotifyTechulusPush,
+    }),
+    # APIKey + bad url
+    ('push://:@/', {
+        'instance': TypeError,
+    }),
+    ('push://%s' % UUID4, {
+        'instance': plugins.NotifyTechulusPush,
+        # force a failure
+        'response': False,
+        'requests_response_code': requests.codes.internal_server_error,
+    }),
+    ('push://%s' % UUID4, {
+        'instance': plugins.NotifyTechulusPush,
+        # throw a bizzare code forcing us to fail to look it up
+        'response': False,
+        'requests_response_code': 999,
+    }),
+    ('push://%s' % UUID4, {
+        'instance': plugins.NotifyTechulusPush,
+        # Throws a series of connection and transfer exceptions when this flag
+        # is set and tests that we gracfully handle them
+        'test_requests_exceptions': True,
+    }),
 
     ##################################
     # NotifyPushed