From 4ff48cbe56f28cc900e7c0730d62bdda47078369 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Thu, 22 Aug 2019 20:01:20 -0400 Subject: [PATCH] MessageBird Support (#142) --- README.md | 1 + apprise/plugins/NotifyMessageBird.py | 365 +++++++++++++++++++++++++++ packaging/redhat/python-apprise.spec | 7 +- setup.py | 8 +- test/test_rest_plugins.py | 79 ++++++ 5 files changed, 453 insertions(+), 7 deletions(-) create mode 100644 apprise/plugins/NotifyMessageBird.py diff --git a/README.md b/README.md index 3dff9038..f00efa95 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ The table below identifies the services this tool supports and some example serv | -------------------- | ---------- | ------------ | -------------- | | [AWS SNS](https://github.com/caronc/apprise/wiki/Notify_sns) | sns:// | (TCP) 443 | sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo
sns://AccessKeyID/AccessSecretKey/RegionName/+PhoneNo1/+PhoneNo2/+PhoneNoN
sns://AccessKeyID/AccessSecretKey/RegionName/Topic
sns://AccessKeyID/AccessSecretKey/RegionName/Topic1/Topic2/TopicN | [D7 Networks](https://github.com/caronc/apprise/wiki/Notify_d7networks) | d7sms:// | (TCP) 443 | d7sms://user:pass@PhoneNo
d7sms://user:pass@ToPhoneNo1/ToPhoneNo2/ToPhoneNoN +| [MessageBird](https://github.com/caronc/apprise/wiki/Notify_messagebird) | msgbird:// | (TCP) 443 | msgbird://ApiKey/FromPhoneNo
msgbird://ApiKey/FromPhoneNo/ToPhoneNo
msgbird://ApiKey/FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/ | [MSG91](https://github.com/caronc/apprise/wiki/Notify_msg91) | msg91:// | (TCP) 443 | msg91://AuthKey/ToPhoneNo
msg91://SenderID@AuthKey/ToPhoneNo
msg91://AuthKey/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/ | [Nexmo](https://github.com/caronc/apprise/wiki/Notify_nexmo) | nexmo:// | (TCP) 443 | nexmo://ApiKey:ApiSecret@FromPhoneNo
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo
nexmo://ApiKey:ApiSecret@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/ | [Twilio](https://github.com/caronc/apprise/wiki/Notify_twilio) | twilio:// | (TCP) 443 | twilio://AccountSid:AuthToken@FromPhoneNo
twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo
twilio://AccountSid:AuthToken@FromPhoneNo/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/
twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo
twilio://AccountSid:AuthToken@ShortCode/ToPhoneNo1/ToPhoneNo2/ToPhoneNoN/ diff --git a/apprise/plugins/NotifyMessageBird.py b/apprise/plugins/NotifyMessageBird.py new file mode 100644 index 00000000..29ad2804 --- /dev/null +++ b/apprise/plugins/NotifyMessageBird.py @@ -0,0 +1,365 @@ +# -*- coding: utf-8 -*- +# +# Copyright (C) 2019 Chris Caron +# 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. + +# Create an account https://messagebird.com if you don't already have one +# +# Get your (apikey) and api example from the dashboard here: +# - https://dashboard.messagebird.com/en/user/index +# + +import re +import requests + +from .NotifyBase import NotifyBase +from ..common import NotifyType +from ..utils import parse_list +from ..AppriseLocale import gettext_lazy as _ + +# Token required as part of the API request +VALIDATE_APIKEY = re.compile(r'^[a-z0-9]{25}$', re.I) + +# Some Phone Number Detection +IS_PHONE_NO = re.compile(r'^\+?(?P[0-9\s)(+-]+)\s*$') + + +class NotifyMessageBird(NotifyBase): + """ + A wrapper for MessageBird Notifications + """ + + # The default descriptive name associated with the Notification + service_name = 'MessageBird' + + # The services URL + service_url = 'https://messagebird.com' + + # The default protocol + secure_protocol = 'msgbird' + + # A URL that takes you to the setup/help of the specific protocol + setup_url = 'https://github.com/caronc/apprise/wiki/Notify_msgbird' + + # MessageBird uses the http protocol with JSON requests + notify_url = 'https://rest.messagebird.com/messages' + + # The maximum length of the body + body_maxlen = 140 + + # A title can not be used for SMS Messages. Setting this to zero will + # cause any title (if defined) to get placed into the message body. + title_maxlen = 0 + + # Define object templates + templates = ( + '{schema}://{apikey}/{source}', + '{schema}://{apikey}/{source}/{targets}', + ) + + # Define our template tokens + template_tokens = dict(NotifyBase.template_tokens, **{ + 'apikey': { + 'name': _('API Key'), + 'type': 'string', + 'required': True, + 'regex': (r'[a-z0-9]{25}', 'i'), + }, + 'source': { + 'name': _('Source Phone No'), + 'type': 'string', + 'prefix': '+', + 'regex': (r'[0-9\s)(+-]+', 'i'), + }, + 'target_phone': { + 'name': _('Target Phone No'), + 'type': 'string', + 'prefix': '+', + 'regex': (r'[0-9\s)(+-]+', 'i'), + 'map_to': 'targets', + }, + 'targets': { + 'name': _('Targets'), + 'type': 'list:string', + } + }) + + # Define our template arguments + template_args = dict(NotifyBase.template_args, **{ + 'to': { + 'alias_of': 'targets', + }, + 'from': { + 'alias_of': 'source', + }, + }) + + def __init__(self, apikey, source, targets=None, **kwargs): + """ + Initialize MessageBird Object + """ + super(NotifyMessageBird, self).__init__(**kwargs) + + try: + # The authentication key associated with the account + self.apikey = apikey.strip() + + except AttributeError: + # Token was None + msg = 'No MessageBird authentication key was specified.' + self.logger.warning(msg) + raise TypeError(msg) + + if not VALIDATE_APIKEY.match(self.apikey): + msg = 'The MessageBird authentication key specified ({}) is ' \ + 'invalid.'.format(self.apikey) + self.logger.warning(msg) + raise TypeError(msg) + + result = IS_PHONE_NO.match(source) + if not result: + msg = 'The MessageBird source specified ({}) is invalid.'\ + .format(source) + self.logger.warning(msg) + raise TypeError(msg) + + # Further check our phone # for it's digit count + result = ''.join(re.findall(r'\d+', result.group('phone'))) + if len(result) < 11 or len(result) > 14: + msg = 'The MessageBird source # specified ({}) is invalid.'\ + .format(source) + self.logger.warning(msg) + raise TypeError(msg) + + # Store our source + self.source = result + + # Parse our targets + self.targets = list() + + for target in parse_list(targets): + # Validate targets and drop bad ones: + result = IS_PHONE_NO.match(target) + if result: + # Further check our phone # for it's digit count + result = ''.join(re.findall(r'\d+', result.group('phone'))) + if len(result) < 11 or len(result) > 14: + self.logger.warning( + 'Dropped invalid phone # ' + '({}) specified.'.format(target), + ) + continue + + # store valid phone number + self.targets.append(result) + continue + + self.logger.warning( + 'Dropped invalid phone # ' + '({}) specified.'.format(target), + ) + + def send(self, body, title='', notify_type=NotifyType.INFO, **kwargs): + """ + Perform MessageBird Notification + """ + + # error tracking (used for function return) + has_error = False + + # Prepare our headers + headers = { + 'User-Agent': self.app_id, + 'Content-Type': 'application/x-www-form-urlencoded', + 'Authorization': 'AccessKey {}'.format(self.apikey), + } + + # Prepare our payload + payload = { + 'originator': '+{}'.format(self.source), + 'recipients': None, + 'body': body, + + } + # Create a copy of the targets list + targets = list(self.targets) + + if len(targets) == 0: + # No sources specified, use our own phone no + targets.append(self.source) + + while len(targets): + # Get our target to notify + target = targets.pop(0) + + # Prepare our user + payload['recipients'] = '+{}'.format(target) + + # Some Debug Logging + self.logger.debug( + 'MessageBird POST URL: {} (cert_verify={})'.format( + self.notify_url, self.verify_certificate)) + self.logger.debug('MessageBird Payload: {}' .format(payload)) + + # Always call throttle before any remote server i/o is made + self.throttle() + try: + r = requests.post( + self.notify_url, + data=payload, + headers=headers, + verify=self.verify_certificate, + ) + + # Sample output of a successful transmission + # { + # "originator": "+15553338888", + # "body": "test", + # "direction": "mt", + # "mclass": 1, + # "reference": null, + # "createdDatetime": "2019-08-22T01:32:18+00:00", + # "recipients": { + # "totalCount": 1, + # "totalSentCount": 1, + # "totalDeliveredCount": 0, + # "totalDeliveryFailedCount": 0, + # "items": [ + # { + # "status": "sent", + # "statusDatetime": "2019-08-22T01:32:18+00:00", + # "recipient": 15553338888, + # "messagePartCount": 1 + # } + # ] + # }, + # "validity": null, + # "gateway": 10, + # "typeDetails": {}, + # "href": "https://rest.messagebird.com/messages/\ + # b5d424244a5b4fd0b5b5728bccaafc23", + # "datacoding": "plain", + # "scheduledDatetime": null, + # "type": "sms", + # "id": "b5d424244a5b4fd0b5b5728bccaafc23" + # } + + if r.status_code not in ( + requests.codes.ok, requests.codes.created): + # We had a problem + status_str = \ + NotifyMessageBird.http_response_code_lookup( + r.status_code) + + self.logger.warning( + 'Failed to send MessageBird notification to {}: ' + '{}{}error={}.'.format( + ','.join(target), + status_str, + ', ' if status_str else '', + r.status_code)) + + self.logger.debug( + 'Response Details:\r\n{}'.format(r.content)) + + # Mark our failure + has_error = True + continue + + else: + self.logger.info( + 'Sent MessageBird notification to {}.'.format(target)) + + except requests.RequestException as e: + self.logger.warning( + 'A Connection error occured sending MessageBird:%s ' % ( + target) + 'notification.' + ) + self.logger.debug('Socket Exception: %s' % str(e)) + + # Mark our failure + has_error = True + continue + + return not has_error + + 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}/{source}/{targets}/?{args}'.format( + schema=self.secure_protocol, + apikey=self.apikey, + source=self.source, + targets='/'.join( + [NotifyMessageBird.quote(x, safe='') for x in self.targets]), + args=NotifyMessageBird.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) + + if not results: + # We're done early as we couldn't load the results + return results + + # Get our entries; split_path() looks after unquoting content for us + # by default + results['targets'] = NotifyMessageBird.split_path(results['fullpath']) + + try: + # The first path entry is the source/originator + results['source'] = results['targets'].pop(0) + except IndexError: + # No path specified... this URL is potentially un-parseable; we can + # hope for a from= entry + pass + + # The hostname is our authentication key + results['apikey'] = NotifyMessageBird.unquote(results['host']) + + # Support the 'to' variable so that we can support targets this way too + # The 'to' makes it easier to use yaml configuration + if 'to' in results['qsd'] and len(results['qsd']['to']): + results['targets'] += \ + NotifyMessageBird.parse_list(results['qsd']['to']) + + if 'from' in results['qsd'] and len(results['qsd']['from']): + results['source'] = \ + NotifyMessageBird.unquote(results['qsd']['from']) + + return results diff --git a/packaging/redhat/python-apprise.spec b/packaging/redhat/python-apprise.spec index 9f5f8e5c..74872d00 100644 --- a/packaging/redhat/python-apprise.spec +++ b/packaging/redhat/python-apprise.spec @@ -49,9 +49,10 @@ 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, MSG91, Nexmo, Notify MyAndroid, Prowl, Pushalot, PushBullet, -Pushjet, Pushover, Rocket.Chat, SendGrid, Slack, Super Toasty, Stride, -Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP, Webex Teams} +Microsoft Teams, MessageBird, MSG91, Nexmo, Notify MyAndroid, Prowl, Pushalot, +PushBullet, Pushjet, Pushover, Rocket.Chat, SendGrid, Slack, Super Toasty, +Stride, Techulus Push, Telegram, Twilio, Twitter, Twist, XBMC, XMPP, +Webex Teams} Name: python-%{pypi_name} Version: 0.7.9 diff --git a/setup.py b/setup.py index d1eb7dec..0c6fea28 100755 --- a/setup.py +++ b/setup.py @@ -71,10 +71,10 @@ setup( url='https://github.com/caronc/apprise', keywords='Push Notifications Alerts Email AWS SNS Boxcar Discord Dbus ' 'Emby Faast Flock Gitter Gnome Gotify Growl IFTTT Join KODI Mailgun ' - 'Matrix Mattermost MSG91 Nexmo Prowl PushBullet Pushjet Pushed ' - 'Pushover Rocket.Chat Ryver SendGrid Slack Stride Techulus Push ' - 'Telegram Twilio Twist Twitter XBMC Microsoft MSTeams Windows ' - 'Webex CLI API', + 'Matrix Mattermost MessageBird MSG91 Nexmo Prowl PushBullet Pushjet ' + 'Pushed Pushover Rocket.Chat Ryver SendGrid Slack Stride ' + 'Techulus Push Telegram Twilio Twist Twitter XBMC Microsoft MSTeams ' + 'Windows Webex CLI API', author='Chris Caron', author_email='lead2gold@gmail.com', packages=find_packages(), diff --git a/test/test_rest_plugins.py b/test/test_rest_plugins.py index 316ec931..89355f35 100644 --- a/test/test_rest_plugins.py +++ b/test/test_rest_plugins.py @@ -2561,6 +2561,54 @@ TEST_URLS = ( 'test_requests_exceptions': True, }), + ################################## + # NotifyMessageBird + ################################## + ('msgbird://', { + # No hostname/apikey specified + 'instance': None, + }), + ('msgbird://{}/15551232000'.format('a' * 10), { + # invalid apikey + 'instance': TypeError, + }), + ('msgbird://{}/123'.format('a' * 25), { + # invalid phone number + 'instance': TypeError, + }), + ('msgbird://{}/abc'.format('a' * 25), { + # invalid phone number + 'instance': TypeError, + }), + ('msgbird://{}/15551232000'.format('a' * 25), { + # target phone number becomes who we text too; all is good + 'instance': plugins.NotifyMessageBird, + }), + ('msgbird://{}/15551232000/abcd'.format('a' * 25), { + # invalid target phone number; we fall back to texting ourselves + 'instance': plugins.NotifyMessageBird, + }), + ('msgbird://{}/15551232000/123'.format('a' * 25), { + # invalid target phone number; we fall back to texting ourselves + 'instance': plugins.NotifyMessageBird, + }), + ('msgbird://{}/?from=15551233000&to=15551232000'.format('a' * 25), { + # reference to to= and frome= + 'instance': plugins.NotifyMessageBird, + }), + ('msgbird://{}/15551232000'.format('a' * 25), { + 'instance': plugins.NotifyMessageBird, + # throw a bizzare code forcing us to fail to look it up + 'response': False, + 'requests_response_code': 999, + }), + ('msgbird://{}/15551232000'.format('a' * 25), { + 'instance': plugins.NotifyMessageBird, + # Throws a series of connection and transfer exceptions when this flag + # is set and tests that we gracfully handle them + 'test_requests_exceptions': True, + }), + ################################## # NotifyNexmo ################################## @@ -3670,6 +3718,37 @@ def test_notify_msg91_plugin(mock_post): assert True +@mock.patch('requests.post') +def test_notify_messagebird_plugin(mock_post): + """ + API: NotifyMessageBird() Extra Checks + + """ + # Disable Throttling to speed testing + plugins.NotifyBase.request_rate_per_sec = 0 + + # Prepare our response + response = requests.Request() + response.status_code = requests.codes.ok + + # Prepare Mock + mock_post.return_value = response + + # Initialize some generic (but valid) tokens + # authkey = '{}'.format('a' * 24) + source = '+1 (555) 123-3456' + + try: + # No authkey specified + plugins.NotifyMessageBird(apikey=None, source=source) + assert False + + except TypeError: + # Exception should be thrown about the fact authkey was not + # specified + assert True + + @mock.patch('apprise.plugins.NotifyEmby.login') @mock.patch('requests.get') @mock.patch('requests.post')