mirror of
https://github.com/caronc/apprise.git
synced 2025-06-22 02:31:41 +02:00
SparkPost Notification Support (#307)
This commit is contained in:
parent
8ca8e51833
commit
a2525f671e
@ -69,6 +69,7 @@ The table below identifies the services this tool supports and some example serv
|
|||||||
| [SendGrid](https://github.com/caronc/apprise/wiki/Notify_sendgrid) | sendgrid:// | (TCP) 443 | sendgrid://APIToken:FromEmail/<br />sendgrid://APIToken:FromEmail/ToEmail<br />sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
|
| [SendGrid](https://github.com/caronc/apprise/wiki/Notify_sendgrid) | sendgrid:// | (TCP) 443 | sendgrid://APIToken:FromEmail/<br />sendgrid://APIToken:FromEmail/ToEmail<br />sendgrid://APIToken:FromEmail/ToEmail1/ToEmail2/ToEmailN/
|
||||||
| [SimplePush](https://github.com/caronc/apprise/wiki/Notify_simplepush) | spush:// | (TCP) 443 | spush://apikey<br />spush://salt:password@apikey<br />spush://apikey?event=Apprise
|
| [SimplePush](https://github.com/caronc/apprise/wiki/Notify_simplepush) | spush:// | (TCP) 443 | spush://apikey<br />spush://salt:password@apikey<br />spush://apikey?event=Apprise
|
||||||
| [Slack](https://github.com/caronc/apprise/wiki/Notify_slack) | slack:// | (TCP) 443 | slack://TokenA/TokenB/TokenC/<br />slack://TokenA/TokenB/TokenC/Channel<br />slack://botname@TokenA/TokenB/TokenC/Channel<br />slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN
|
| [Slack](https://github.com/caronc/apprise/wiki/Notify_slack) | slack:// | (TCP) 443 | slack://TokenA/TokenB/TokenC/<br />slack://TokenA/TokenB/TokenC/Channel<br />slack://botname@TokenA/TokenB/TokenC/Channel<br />slack://user@TokenA/TokenB/TokenC/Channel1/Channel2/ChannelN
|
||||||
|
| [SparkPost](https://github.com/caronc/apprise/wiki/Notify_sparkpost) | sparkpost:// | (TCP) 443 | sparkpost://user@hostname/apikey<br />sparkpost://user@hostname/apikey/email<br />sparkpost://user@hostname/apikey/email1/email2/emailN<br />sparkpost://user@hostname/apikey/?name="From%20User"
|
||||||
| [Spontit](https://github.com/caronc/apprise/wiki/Notify_spontit) | spontit:// | (TCP) 443 | spontit://UserID@APIKey/<br />spontit://UserID@APIKey/Channel<br />spontit://UserID@APIKey/Channel1/Channel2/ChannelN
|
| [Spontit](https://github.com/caronc/apprise/wiki/Notify_spontit) | spontit:// | (TCP) 443 | spontit://UserID@APIKey/<br />spontit://UserID@APIKey/Channel<br />spontit://UserID@APIKey/Channel1/Channel2/ChannelN
|
||||||
| [Syslog](https://github.com/caronc/apprise/wiki/Notify_syslog) | syslog:// | n/a | syslog://<br />syslog://Facility
|
| [Syslog](https://github.com/caronc/apprise/wiki/Notify_syslog) | syslog:// | n/a | syslog://<br />syslog://Facility
|
||||||
| [Telegram](https://github.com/caronc/apprise/wiki/Notify_telegram) | tgram:// | (TCP) 443 | tgram://bottoken/ChatID<br />tgram://bottoken/ChatID1/ChatID2/ChatIDN
|
| [Telegram](https://github.com/caronc/apprise/wiki/Notify_telegram) | tgram:// | (TCP) 443 | tgram://bottoken/ChatID<br />tgram://bottoken/ChatID1/ChatID2/ChatIDN
|
||||||
|
@ -280,7 +280,7 @@ class URLBase(object):
|
|||||||
self._last_io_datetime = reference
|
self._last_io_datetime = reference
|
||||||
return
|
return
|
||||||
|
|
||||||
if self.request_rate_per_sec <= 0.0:
|
if self.request_rate_per_sec <= 0.0 and not wait:
|
||||||
# We're done if there is no throttle limit set
|
# We're done if there is no throttle limit set
|
||||||
return
|
return
|
||||||
|
|
||||||
|
785
apprise/plugins/NotifySparkPost.py
Normal file
785
apprise/plugins/NotifySparkPost.py
Normal file
@ -0,0 +1,785 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (C) 2020 Chris Caron <lead2gold@gmail.com>
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
# Signup @ https://www.sparkpost.com
|
||||||
|
#
|
||||||
|
# Ensure you've added a Senders Domain and have generated yourself an
|
||||||
|
# API Key at:
|
||||||
|
# https://app.sparkpost.com/dashboard
|
||||||
|
|
||||||
|
# Note: For SMTP Access, your API key must have at least been granted the
|
||||||
|
# 'Send via SMTP' privileges.
|
||||||
|
|
||||||
|
# From here you can click on the domain you're interested in. You can acquire
|
||||||
|
# the API Key from here which will look something like:
|
||||||
|
# 1e1d479fcf1a87527e9411e083c700689fa1acdc
|
||||||
|
#
|
||||||
|
# Knowing this, you can buid your sparkpost url as follows:
|
||||||
|
# sparkpost://{user}@{domain}/{apikey}
|
||||||
|
# sparkpost://{user}@{domain}/{apikey}/{email}
|
||||||
|
#
|
||||||
|
# You can email as many addresses as you want as:
|
||||||
|
# sparkpost://{user}@{domain}/{apikey}/{email1}/{email2}/{emailN}
|
||||||
|
#
|
||||||
|
# The {user}@{domain} effectively assembles the 'from' email address
|
||||||
|
# the email will be transmitted from. If no email address is specified
|
||||||
|
# then it will also become the 'to' address as well.
|
||||||
|
#
|
||||||
|
# The {domain} must cross reference a domain you've set up with Spark Post
|
||||||
|
#
|
||||||
|
# API Documentation: https://developers.sparkpost.com/api/
|
||||||
|
# Specifically: https://developers.sparkpost.com/api/transmissions/
|
||||||
|
import requests
|
||||||
|
import base64
|
||||||
|
from json import loads
|
||||||
|
from json import dumps
|
||||||
|
from .NotifyBase import NotifyBase
|
||||||
|
from ..common import NotifyType
|
||||||
|
from ..common import NotifyFormat
|
||||||
|
from ..utils import is_email
|
||||||
|
from email.utils import formataddr
|
||||||
|
from ..utils import validate_regex
|
||||||
|
from ..utils import parse_emails
|
||||||
|
from ..utils import parse_bool
|
||||||
|
from ..AppriseLocale import gettext_lazy as _
|
||||||
|
|
||||||
|
# Provide some known codes SparkPost uses and what they translate to:
|
||||||
|
# Based on https://www.sparkpost.com/docs/tech-resources/extended-error-codes/
|
||||||
|
SPARKPOST_HTTP_ERROR_MAP = {
|
||||||
|
400: 'A bad request was made to the server',
|
||||||
|
401: 'Invalid User ID and/or Unauthorized User',
|
||||||
|
403: 'Permission Denied; the provided API Key was not valid',
|
||||||
|
404: 'There is a problem with the server query URI.',
|
||||||
|
405: 'Invalid HTTP method',
|
||||||
|
420: 'Sending limit reached.',
|
||||||
|
422: 'Invalid data/format/type/length',
|
||||||
|
429: 'To many requests per sec; rate limit',
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Priorities
|
||||||
|
class SparkPostRegion(object):
|
||||||
|
US = 'us'
|
||||||
|
EU = 'eu'
|
||||||
|
|
||||||
|
|
||||||
|
# SparkPost APIs
|
||||||
|
SPARKPOST_API_LOOKUP = {
|
||||||
|
SparkPostRegion.US: 'https://api.sparkpost.com/api/v1',
|
||||||
|
SparkPostRegion.EU: 'https://api.eu.sparkpost.com/api/v1',
|
||||||
|
}
|
||||||
|
|
||||||
|
# A List of our regions we can use for verification
|
||||||
|
SPARKPOST_REGIONS = (
|
||||||
|
SparkPostRegion.US,
|
||||||
|
SparkPostRegion.EU,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class NotifySparkPost(NotifyBase):
|
||||||
|
"""
|
||||||
|
A wrapper for SparkPost Notifications
|
||||||
|
"""
|
||||||
|
|
||||||
|
# The default descriptive name associated with the Notification
|
||||||
|
service_name = 'SparkPost'
|
||||||
|
|
||||||
|
# The services URL
|
||||||
|
service_url = 'https://sparkpost.com/'
|
||||||
|
|
||||||
|
# All notification requests are secure
|
||||||
|
secure_protocol = 'sparkpost'
|
||||||
|
|
||||||
|
# SparkPost advertises they allow 300 requests per minute.
|
||||||
|
# 60/300 = 0.2
|
||||||
|
request_rate_per_sec = 0.20
|
||||||
|
|
||||||
|
# Words straight from their website:
|
||||||
|
# https://developers.sparkpost.com/api/#header-rate-limiting
|
||||||
|
# These limits are dynamic, but as a general rule, wait 1 to 5 seconds
|
||||||
|
# after receiving a 429 response before requesting again.
|
||||||
|
|
||||||
|
# As a simple work around, this is what we will do... Wait X seconds
|
||||||
|
# (defined below) before trying again when we get a 429 error
|
||||||
|
sparkpost_retry_wait_sec = 5
|
||||||
|
|
||||||
|
# The maximum number of times we'll retry to send our message when we've
|
||||||
|
# reached a throttling situatin before giving up
|
||||||
|
sparkpost_retry_attempts = 3
|
||||||
|
|
||||||
|
# The maximum amount of emails that can reside within a single
|
||||||
|
# batch transfer based on:
|
||||||
|
# https://www.sparkpost.com/docs/tech-resources/\
|
||||||
|
# smtp-rest-api-performance/#sending-via-the-transmission-rest-api
|
||||||
|
default_batch_size = 10000
|
||||||
|
|
||||||
|
# A URL that takes you to the setup/help of the specific protocol
|
||||||
|
setup_url = 'https://github.com/caronc/apprise/wiki/Notify_sparkpost'
|
||||||
|
|
||||||
|
# Default Notify Format
|
||||||
|
notify_format = NotifyFormat.HTML
|
||||||
|
|
||||||
|
# The default region to use if one isn't otherwise specified
|
||||||
|
sparkpost_default_region = SparkPostRegion.US
|
||||||
|
|
||||||
|
# Define object templates
|
||||||
|
templates = (
|
||||||
|
'{schema}://{user}@{host}:{apikey}/',
|
||||||
|
'{schema}://{user}@{host}:{apikey}/{targets}',
|
||||||
|
)
|
||||||
|
|
||||||
|
# Define our template tokens
|
||||||
|
template_tokens = dict(NotifyBase.template_tokens, **{
|
||||||
|
'user': {
|
||||||
|
'name': _('User Name'),
|
||||||
|
'type': 'string',
|
||||||
|
'required': True,
|
||||||
|
},
|
||||||
|
'host': {
|
||||||
|
'name': _('Domain'),
|
||||||
|
'type': 'string',
|
||||||
|
'required': True,
|
||||||
|
},
|
||||||
|
'apikey': {
|
||||||
|
'name': _('API Key'),
|
||||||
|
'type': 'string',
|
||||||
|
'private': True,
|
||||||
|
'required': True,
|
||||||
|
},
|
||||||
|
'targets': {
|
||||||
|
'name': _('Target Emails'),
|
||||||
|
'type': 'list:string',
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
# Define our template arguments
|
||||||
|
template_args = dict(NotifyBase.template_args, **{
|
||||||
|
'name': {
|
||||||
|
'name': _('From Name'),
|
||||||
|
'type': 'string',
|
||||||
|
'map_to': 'from_name',
|
||||||
|
},
|
||||||
|
'region': {
|
||||||
|
'name': _('Region Name'),
|
||||||
|
'type': 'choice:string',
|
||||||
|
'values': SPARKPOST_REGIONS,
|
||||||
|
'default': SparkPostRegion.US,
|
||||||
|
'map_to': 'region_name',
|
||||||
|
},
|
||||||
|
'to': {
|
||||||
|
'alias_of': 'targets',
|
||||||
|
},
|
||||||
|
'cc': {
|
||||||
|
'name': _('Carbon Copy'),
|
||||||
|
'type': 'list:string',
|
||||||
|
},
|
||||||
|
'bcc': {
|
||||||
|
'name': _('Blind Carbon Copy'),
|
||||||
|
'type': 'list:string',
|
||||||
|
},
|
||||||
|
'batch': {
|
||||||
|
'name': _('Batch Mode'),
|
||||||
|
'type': 'bool',
|
||||||
|
'default': False,
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
# Define any kwargs we're using
|
||||||
|
template_kwargs = {
|
||||||
|
'headers': {
|
||||||
|
'name': _('HTTP Header'),
|
||||||
|
'prefix': '+',
|
||||||
|
},
|
||||||
|
'tokens': {
|
||||||
|
'name': _('Template Tokens'),
|
||||||
|
'prefix': ':',
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
def __init__(self, apikey, targets, cc=None, bcc=None, from_name=None,
|
||||||
|
region_name=None, headers=None, tokens=None, batch=False,
|
||||||
|
**kwargs):
|
||||||
|
"""
|
||||||
|
Initialize SparkPost Object
|
||||||
|
"""
|
||||||
|
super(NotifySparkPost, self).__init__(**kwargs)
|
||||||
|
|
||||||
|
# API Key (associated with project)
|
||||||
|
self.apikey = validate_regex(apikey)
|
||||||
|
if not self.apikey:
|
||||||
|
msg = 'An invalid SparkPost API Key ' \
|
||||||
|
'({}) was specified.'.format(apikey)
|
||||||
|
self.logger.warning(msg)
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
# Validate our username
|
||||||
|
if not self.user:
|
||||||
|
msg = 'No SparkPost username was specified.'
|
||||||
|
self.logger.warning(msg)
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
# Acquire Email 'To'
|
||||||
|
self.targets = list()
|
||||||
|
|
||||||
|
# Acquire Carbon Copies
|
||||||
|
self.cc = set()
|
||||||
|
|
||||||
|
# Acquire Blind Carbon Copies
|
||||||
|
self.bcc = set()
|
||||||
|
|
||||||
|
# For tracking our email -> name lookups
|
||||||
|
self.names = {}
|
||||||
|
|
||||||
|
# Store our region
|
||||||
|
try:
|
||||||
|
self.region_name = self.sparkpost_default_region \
|
||||||
|
if region_name is None else region_name.lower()
|
||||||
|
|
||||||
|
if self.region_name not in SPARKPOST_REGIONS:
|
||||||
|
# allow the outer except to handle this common response
|
||||||
|
raise
|
||||||
|
except:
|
||||||
|
# Invalid region specified
|
||||||
|
msg = 'The SparkPost region specified ({}) is invalid.' \
|
||||||
|
.format(region_name)
|
||||||
|
self.logger.warning(msg)
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
# Get our From username (if specified)
|
||||||
|
self.from_name = from_name
|
||||||
|
|
||||||
|
# Get our from email address
|
||||||
|
self.from_addr = '{user}@{host}'.format(user=self.user, host=self.host)
|
||||||
|
|
||||||
|
if not is_email(self.from_addr):
|
||||||
|
# Parse Source domain based on from_addr
|
||||||
|
msg = 'Invalid ~From~ email format: {}'.format(self.from_addr)
|
||||||
|
self.logger.warning(msg)
|
||||||
|
raise TypeError(msg)
|
||||||
|
|
||||||
|
self.headers = {}
|
||||||
|
if headers:
|
||||||
|
# Store our extra headers
|
||||||
|
self.headers.update(headers)
|
||||||
|
|
||||||
|
self.tokens = {}
|
||||||
|
if tokens:
|
||||||
|
# Store our template tokens
|
||||||
|
self.tokens.update(tokens)
|
||||||
|
|
||||||
|
# Prepare Batch Mode Flag
|
||||||
|
self.batch = batch
|
||||||
|
|
||||||
|
if targets:
|
||||||
|
# Validate recipients (to:) and drop bad ones:
|
||||||
|
for recipient in parse_emails(targets):
|
||||||
|
result = is_email(recipient)
|
||||||
|
if result:
|
||||||
|
self.targets.append(
|
||||||
|
(result['name'] if result['name'] else False,
|
||||||
|
result['full_email']))
|
||||||
|
continue
|
||||||
|
|
||||||
|
self.logger.warning(
|
||||||
|
'Dropped invalid To email '
|
||||||
|
'({}) specified.'.format(recipient),
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
# If our target email list is empty we want to add ourselves to it
|
||||||
|
self.targets.append(
|
||||||
|
(self.from_name if self.from_name else False, self.from_addr))
|
||||||
|
|
||||||
|
# Validate recipients (cc:) and drop bad ones:
|
||||||
|
for recipient in parse_emails(cc):
|
||||||
|
email = is_email(recipient)
|
||||||
|
if email:
|
||||||
|
self.cc.add(email['full_email'])
|
||||||
|
|
||||||
|
# Index our name (if one exists)
|
||||||
|
self.names[email['full_email']] = \
|
||||||
|
email['name'] if email['name'] else False
|
||||||
|
continue
|
||||||
|
|
||||||
|
self.logger.warning(
|
||||||
|
'Dropped invalid Carbon Copy email '
|
||||||
|
'({}) specified.'.format(recipient),
|
||||||
|
)
|
||||||
|
|
||||||
|
# Validate recipients (bcc:) and drop bad ones:
|
||||||
|
for recipient in parse_emails(bcc):
|
||||||
|
email = is_email(recipient)
|
||||||
|
if email:
|
||||||
|
self.bcc.add(email['full_email'])
|
||||||
|
|
||||||
|
# Index our name (if one exists)
|
||||||
|
self.names[email['full_email']] = \
|
||||||
|
email['name'] if email['name'] else False
|
||||||
|
continue
|
||||||
|
|
||||||
|
self.logger.warning(
|
||||||
|
'Dropped invalid Blind Carbon Copy email '
|
||||||
|
'({}) specified.'.format(recipient),
|
||||||
|
)
|
||||||
|
|
||||||
|
def __post(self, payload, retry):
|
||||||
|
"""
|
||||||
|
Performs the actual post and returns the response
|
||||||
|
|
||||||
|
"""
|
||||||
|
# Prepare our headers
|
||||||
|
headers = {
|
||||||
|
'User-Agent': self.app_id,
|
||||||
|
'Accept': 'application/json',
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
'Authorization': self.apikey,
|
||||||
|
}
|
||||||
|
|
||||||
|
# Prepare our URL as it's based on our hostname
|
||||||
|
url = '{}/transmissions/'.format(
|
||||||
|
SPARKPOST_API_LOOKUP[self.region_name])
|
||||||
|
|
||||||
|
# Some Debug Logging
|
||||||
|
self.logger.debug('SparkPost POST URL: {} (cert_verify={})'.format(
|
||||||
|
url, self.verify_certificate))
|
||||||
|
|
||||||
|
if 'attachments' in payload['content']:
|
||||||
|
# Since we print our payload; attachments make it a bit too noisy
|
||||||
|
# we just strip out the data block to accomodate it
|
||||||
|
log_payload = \
|
||||||
|
{k: v for k, v in payload.items() if k != "content"}
|
||||||
|
log_payload['content'] = \
|
||||||
|
{k: v for k, v in payload['content'].items()
|
||||||
|
if k != "attachments"}
|
||||||
|
log_payload['content']['attachments'] = \
|
||||||
|
[{k: v for k, v in x.items() if k != "data"}
|
||||||
|
for x in payload['content']['attachments']]
|
||||||
|
else:
|
||||||
|
# No tidying is needed
|
||||||
|
log_payload = payload
|
||||||
|
|
||||||
|
self.logger.debug('SparkPost Payload: {}' .format(log_payload))
|
||||||
|
|
||||||
|
wait = None
|
||||||
|
|
||||||
|
# For logging output of success and errors; we get a head count
|
||||||
|
# of our outbound details:
|
||||||
|
verbose_dest = ', '.join(
|
||||||
|
[x['address']['email'] for x in payload['recipients']]) \
|
||||||
|
if len(payload['recipients']) <= 3 \
|
||||||
|
else '{} recipients'.format(len(payload['recipients']))
|
||||||
|
|
||||||
|
# Initialize our response object
|
||||||
|
json_response = {}
|
||||||
|
|
||||||
|
# Set ourselves a status code
|
||||||
|
status_code = -1
|
||||||
|
|
||||||
|
while 1: # pragma: no branch
|
||||||
|
|
||||||
|
# Always call throttle before any remote server i/o is made
|
||||||
|
self.throttle(wait=wait)
|
||||||
|
try:
|
||||||
|
r = requests.post(
|
||||||
|
url,
|
||||||
|
data=dumps(payload),
|
||||||
|
headers=headers,
|
||||||
|
verify=self.verify_certificate,
|
||||||
|
timeout=self.request_timeout,
|
||||||
|
)
|
||||||
|
|
||||||
|
# A Good response (200) looks like this:
|
||||||
|
# "results": {
|
||||||
|
# "total_rejected_recipients": 0,
|
||||||
|
# "total_accepted_recipients": 1,
|
||||||
|
# "id": "11668787484950529"
|
||||||
|
# }
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
# A Bad response looks like this:
|
||||||
|
# {
|
||||||
|
# "errors": [
|
||||||
|
# {
|
||||||
|
# "description":
|
||||||
|
# "Unconfigured or unverified sending domain.",
|
||||||
|
# "code": "7001",
|
||||||
|
# "message": "Invalid domain"
|
||||||
|
# }
|
||||||
|
# ]
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
try:
|
||||||
|
# Update our status response if we can
|
||||||
|
json_response = loads(r.content)
|
||||||
|
|
||||||
|
except (AttributeError, TypeError, ValueError):
|
||||||
|
# ValueError = r.content is Unparsable
|
||||||
|
# TypeError = r.content is None
|
||||||
|
# AttributeError = r is None
|
||||||
|
|
||||||
|
# We could not parse JSON response.
|
||||||
|
# We will just use the status we already have.
|
||||||
|
pass
|
||||||
|
|
||||||
|
status_code = r.status_code
|
||||||
|
|
||||||
|
payload['recipients'] = list()
|
||||||
|
if status_code == requests.codes.ok:
|
||||||
|
self.logger.info(
|
||||||
|
'Sent SparkPost notification to {}.'.format(
|
||||||
|
verbose_dest))
|
||||||
|
return status_code, json_response
|
||||||
|
|
||||||
|
# We had a problem if we get here
|
||||||
|
status_str = \
|
||||||
|
NotifyBase.http_response_code_lookup(
|
||||||
|
status_code, SPARKPOST_API_LOOKUP)
|
||||||
|
|
||||||
|
self.logger.warning(
|
||||||
|
'Failed to send SparkPost notification to {}: '
|
||||||
|
'{}{}error={}.'.format(
|
||||||
|
verbose_dest,
|
||||||
|
status_str,
|
||||||
|
', ' if status_str else '',
|
||||||
|
status_code))
|
||||||
|
|
||||||
|
self.logger.debug(
|
||||||
|
'Response Details:\r\n{}'.format(r.content))
|
||||||
|
|
||||||
|
if status_code == requests.codes.too_many_requests and retry:
|
||||||
|
retry = retry - 1
|
||||||
|
if retry > 0:
|
||||||
|
wait = self.sparkpost_retry_wait_sec
|
||||||
|
continue
|
||||||
|
|
||||||
|
except requests.RequestException as e:
|
||||||
|
self.logger.warning(
|
||||||
|
'A Connection error occurred sending SparkPost '
|
||||||
|
'notification')
|
||||||
|
self.logger.debug('Socket Exception: %s' % str(e))
|
||||||
|
|
||||||
|
# Anything else and we're done
|
||||||
|
return status_code, json_response
|
||||||
|
|
||||||
|
# Our code will never reach here (outside of infinite while loop above)
|
||||||
|
|
||||||
|
def send(self, body, title='', notify_type=NotifyType.INFO, attach=None,
|
||||||
|
**kwargs):
|
||||||
|
"""
|
||||||
|
Perform SparkPost Notification
|
||||||
|
"""
|
||||||
|
|
||||||
|
if not self.targets:
|
||||||
|
# There is no one to email; we're done
|
||||||
|
self.logger.warning(
|
||||||
|
'There are no Email recipients to notify')
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Initialize our has_error flag
|
||||||
|
has_error = False
|
||||||
|
|
||||||
|
# Send in batches if identified to do so
|
||||||
|
batch_size = 1 if not self.batch else self.default_batch_size
|
||||||
|
|
||||||
|
try:
|
||||||
|
reply_to = formataddr((self.from_name if self.from_name else False,
|
||||||
|
self.from_addr), charset='utf-8')
|
||||||
|
except TypeError:
|
||||||
|
# Python v2.x Support (no charset keyword)
|
||||||
|
# Format our cc addresses to support the Name field
|
||||||
|
reply_to = formataddr((self.from_name if self.from_name else False,
|
||||||
|
self.from_addr))
|
||||||
|
payload = {
|
||||||
|
"options": {
|
||||||
|
# When set to True, an image is included with the email which
|
||||||
|
# is used to detect if the user looked at the image or not.
|
||||||
|
'open_tracking': False,
|
||||||
|
|
||||||
|
# Track if links were clicked that were found within email
|
||||||
|
'click_tracking': False,
|
||||||
|
},
|
||||||
|
"content": {
|
||||||
|
"from": {
|
||||||
|
"name": self.from_name
|
||||||
|
if self.from_name else self.app_desc,
|
||||||
|
"email": self.from_addr,
|
||||||
|
},
|
||||||
|
|
||||||
|
# SparkPost does not allow empty subject lines or lines that
|
||||||
|
# only contain whitespace; Since Apprise allows an empty title
|
||||||
|
# parameter we swap empty title entries with the period
|
||||||
|
"subject": title if title.strip() else '.',
|
||||||
|
"reply_to": reply_to,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if self.notify_format == NotifyFormat.HTML:
|
||||||
|
payload['content']['html'] = body
|
||||||
|
|
||||||
|
else:
|
||||||
|
payload['content']['text'] = body
|
||||||
|
|
||||||
|
if self.headers:
|
||||||
|
payload['content']['headers'] = self.headers
|
||||||
|
|
||||||
|
if attach:
|
||||||
|
# Prepare ourselves an attachment object
|
||||||
|
payload['content']['attachments'] = []
|
||||||
|
|
||||||
|
for attachment in attach:
|
||||||
|
# Perform some simple error checking
|
||||||
|
if not attachment:
|
||||||
|
# We could not access the attachment
|
||||||
|
self.logger.error(
|
||||||
|
'Could not access attachment {}.'.format(
|
||||||
|
attachment.url(privacy=True)))
|
||||||
|
return False
|
||||||
|
|
||||||
|
self.logger.debug(
|
||||||
|
'Preparing SparkPost attachment {}'.format(
|
||||||
|
attachment.url(privacy=True)))
|
||||||
|
|
||||||
|
try:
|
||||||
|
with open(attachment.path, 'rb') as fp:
|
||||||
|
# Prepare API Upload Payload
|
||||||
|
payload['content']['attachments'].append({
|
||||||
|
'name': attachment.name,
|
||||||
|
'type': attachment.mimetype,
|
||||||
|
'data': base64.b64encode(fp.read()).decode("ascii")
|
||||||
|
})
|
||||||
|
|
||||||
|
except (OSError, IOError) as e:
|
||||||
|
self.logger.warning(
|
||||||
|
'An I/O error occurred while reading {}.'.format(
|
||||||
|
attachment.name if attachment else 'attachment'))
|
||||||
|
self.logger.debug('I/O Exception: %s' % str(e))
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Take a copy of our token dictionary
|
||||||
|
tokens = self.tokens.copy()
|
||||||
|
|
||||||
|
# Apply some defaults template values
|
||||||
|
tokens['app_body'] = body
|
||||||
|
tokens['app_title'] = title
|
||||||
|
tokens['app_type'] = notify_type
|
||||||
|
tokens['app_id'] = self.app_id
|
||||||
|
tokens['app_desc'] = self.app_desc
|
||||||
|
tokens['app_color'] = self.color(notify_type)
|
||||||
|
tokens['app_url'] = self.app_url
|
||||||
|
|
||||||
|
# Store our tokens if they're identified
|
||||||
|
payload['substitution_data'] = self.tokens
|
||||||
|
|
||||||
|
# Create a copy of the targets list
|
||||||
|
emails = list(self.targets)
|
||||||
|
|
||||||
|
# Initialize our headers
|
||||||
|
headers = self.headers.copy()
|
||||||
|
|
||||||
|
for index in range(0, len(emails), batch_size):
|
||||||
|
# Generate our email listing
|
||||||
|
payload['recipients'] = list()
|
||||||
|
|
||||||
|
# Initialize our cc list
|
||||||
|
cc = (self.cc - self.bcc)
|
||||||
|
|
||||||
|
# Initialize our bcc list
|
||||||
|
bcc = set(self.bcc)
|
||||||
|
|
||||||
|
for addr in self.targets[index:index + batch_size]:
|
||||||
|
entry = {
|
||||||
|
'address': {
|
||||||
|
'email': addr[1],
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
# Strip target out of cc list if in To
|
||||||
|
cc = (cc - set([addr]))
|
||||||
|
|
||||||
|
# Strip target out of bcc list if in To
|
||||||
|
bcc = (bcc - set([addr]))
|
||||||
|
|
||||||
|
if addr[0]:
|
||||||
|
entry['address']['name'] = addr[0]
|
||||||
|
|
||||||
|
# Add our recipient to our list
|
||||||
|
payload['recipients'].append(entry)
|
||||||
|
|
||||||
|
if cc:
|
||||||
|
# Handle our cc List
|
||||||
|
for addr in cc:
|
||||||
|
entry = {
|
||||||
|
'address': {
|
||||||
|
'email': addr,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if self.names.get(addr):
|
||||||
|
entry['address']['name'] = self.names[addr]
|
||||||
|
|
||||||
|
# Add our recipient to our list
|
||||||
|
payload['recipients'].append(entry)
|
||||||
|
|
||||||
|
headers['CC'] = ','.join(cc)
|
||||||
|
|
||||||
|
# Handle our bcc List
|
||||||
|
for addr in bcc:
|
||||||
|
# Add our recipient to our list
|
||||||
|
payload['recipients'].append({
|
||||||
|
'address': {
|
||||||
|
'email': addr,
|
||||||
|
'header_to':
|
||||||
|
# Take the first email in the To
|
||||||
|
self.targets[index:index + batch_size][0][1],
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
if headers:
|
||||||
|
payload['headers'] = headers
|
||||||
|
|
||||||
|
# Send our message
|
||||||
|
status_code, response = \
|
||||||
|
self.__post(payload, self.sparkpost_retry_attempts)
|
||||||
|
|
||||||
|
# Failed
|
||||||
|
if status_code != requests.codes.ok:
|
||||||
|
has_error = True
|
||||||
|
|
||||||
|
return not has_error
|
||||||
|
|
||||||
|
def url(self, privacy=False, *args, **kwargs):
|
||||||
|
"""
|
||||||
|
Returns the URL built dynamically based on specified arguments.
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Define any URL parameters
|
||||||
|
params = {
|
||||||
|
'region': self.region_name,
|
||||||
|
'batch': 'yes' if self.batch else 'no',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Append our headers into our parameters
|
||||||
|
params.update({'+{}'.format(k): v for k, v in self.headers.items()})
|
||||||
|
|
||||||
|
# Append our template tokens into our parameters
|
||||||
|
params.update({':{}'.format(k): v for k, v in self.tokens.items()})
|
||||||
|
|
||||||
|
# Extend our parameters
|
||||||
|
params.update(self.url_parameters(privacy=privacy, *args, **kwargs))
|
||||||
|
|
||||||
|
if self.from_name is not None:
|
||||||
|
# from_name specified; pass it back on the url
|
||||||
|
params['name'] = self.from_name
|
||||||
|
|
||||||
|
if len(self.cc) > 0:
|
||||||
|
# Handle our Carbon Copy Addresses
|
||||||
|
params['cc'] = ','.join(
|
||||||
|
['{}{}'.format(
|
||||||
|
'' if not e not in self.names
|
||||||
|
else '{}:'.format(self.names[e]), e) for e in self.cc])
|
||||||
|
|
||||||
|
if len(self.bcc) > 0:
|
||||||
|
# Handle our Blind Carbon Copy Addresses
|
||||||
|
params['bcc'] = ','.join(
|
||||||
|
['{}{}'.format(
|
||||||
|
'' if not e not in self.names
|
||||||
|
else '{}:'.format(self.names[e]), e) for e in self.bcc])
|
||||||
|
|
||||||
|
# a simple boolean check as to whether we display our target emails
|
||||||
|
# or not
|
||||||
|
has_targets = \
|
||||||
|
not (len(self.targets) == 1
|
||||||
|
and self.targets[0][1] == self.from_addr)
|
||||||
|
|
||||||
|
return '{schema}://{user}@{host}/{apikey}/{targets}/?{params}'.format(
|
||||||
|
schema=self.secure_protocol,
|
||||||
|
host=self.host,
|
||||||
|
user=NotifySparkPost.quote(self.user, safe=''),
|
||||||
|
apikey=self.pprint(self.apikey, privacy, safe=''),
|
||||||
|
targets='' if not has_targets else '/'.join(
|
||||||
|
[NotifySparkPost.quote('{}{}'.format(
|
||||||
|
'' if not e[0] else '{}:'.format(e[0]), e[1]),
|
||||||
|
safe='') for e in self.targets]),
|
||||||
|
params=NotifySparkPost.urlencode(params))
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def parse_url(url):
|
||||||
|
"""
|
||||||
|
Parses the URL and returns enough arguments that can allow
|
||||||
|
us to re-instantiate 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
|
||||||
|
|
||||||
|
# Get our entries; split_path() looks after unquoting content for us
|
||||||
|
# by default
|
||||||
|
results['targets'] = NotifySparkPost.split_path(results['fullpath'])
|
||||||
|
|
||||||
|
# Our very first entry is reserved for our api key
|
||||||
|
try:
|
||||||
|
results['apikey'] = results['targets'].pop(0)
|
||||||
|
|
||||||
|
except IndexError:
|
||||||
|
# We're done - no API Key found
|
||||||
|
results['apikey'] = None
|
||||||
|
|
||||||
|
if 'name' in results['qsd'] and len(results['qsd']['name']):
|
||||||
|
# Extract from name to associate with from address
|
||||||
|
results['from_name'] = \
|
||||||
|
NotifySparkPost.unquote(results['qsd']['name'])
|
||||||
|
|
||||||
|
if 'region' in results['qsd'] and len(results['qsd']['region']):
|
||||||
|
# Extract from name to associate with from address
|
||||||
|
results['region_name'] = \
|
||||||
|
NotifySparkPost.unquote(results['qsd']['region'])
|
||||||
|
|
||||||
|
# Handle 'to' email address
|
||||||
|
if 'to' in results['qsd'] and len(results['qsd']['to']):
|
||||||
|
results['targets'].append(results['qsd']['to'])
|
||||||
|
|
||||||
|
# Handle Carbon Copy Addresses
|
||||||
|
if 'cc' in results['qsd'] and len(results['qsd']['cc']):
|
||||||
|
results['cc'] = results['qsd']['cc']
|
||||||
|
|
||||||
|
# Handle Blind Carbon Copy Addresses
|
||||||
|
if 'bcc' in results['qsd'] and len(results['qsd']['bcc']):
|
||||||
|
results['bcc'] = results['qsd']['bcc']
|
||||||
|
|
||||||
|
# Add our Meta Headers that the user can provide with their outbound
|
||||||
|
# emails
|
||||||
|
results['headers'] = {NotifyBase.unquote(x): NotifyBase.unquote(y)
|
||||||
|
for x, y in results['qsd+'].items()}
|
||||||
|
|
||||||
|
# Add our template tokens (if defined)
|
||||||
|
results['tokens'] = {NotifyBase.unquote(x): NotifyBase.unquote(y)
|
||||||
|
for x, y in results['qsd:'].items()}
|
||||||
|
|
||||||
|
# Get Batch Mode Flag
|
||||||
|
results['batch'] = \
|
||||||
|
parse_bool(results['qsd'].get('batch', False))
|
||||||
|
return results
|
@ -52,8 +52,8 @@ IFTTT, Join, Kavenegar, KODI, Kumulos, LaMetric, MacOSX, Mailgun, MatterMost,
|
|||||||
Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MSG91, MyAndroid,
|
Matrix, Microsoft Windows, Microsoft Teams, MessageBird, MSG91, MyAndroid,
|
||||||
Nexmo, Nextcloud, Notica, Notifico, Office365, PopcornNotify, Prowl, Pushalot,
|
Nexmo, Nextcloud, Notica, Notifico, Office365, PopcornNotify, Prowl, Pushalot,
|
||||||
PushBullet, Pushjet, Pushover, PushSafer, Rocket.Chat, SendGrid, SimplePush,
|
PushBullet, Pushjet, Pushover, PushSafer, Rocket.Chat, SendGrid, SimplePush,
|
||||||
Sinch, Slack, Spontit, Super Toasty, Stride, Syslog, Techulus Push, Telegram,
|
Sinch, Slack, Spontit, SparkPost, Super Toasty, Stride, Syslog, Techulus Push,
|
||||||
Twilio, Twitter, Twist, XBMC, XMPP, Webex Teams}
|
Telegram, Twilio, Twitter, Twist, XBMC, XMPP, Webex Teams}
|
||||||
|
|
||||||
Name: python-%{pypi_name}
|
Name: python-%{pypi_name}
|
||||||
Version: 0.8.8
|
Version: 0.8.8
|
||||||
|
6
setup.py
6
setup.py
@ -74,9 +74,9 @@ setup(
|
|||||||
'Kavenegar KODI Kumulos LaMetric MacOS Mailgun Matrix Mattermost '
|
'Kavenegar KODI Kumulos LaMetric MacOS Mailgun Matrix Mattermost '
|
||||||
'MessageBird MSG91 Nexmo Nextcloud Notica Notifico Office365 '
|
'MessageBird MSG91 Nexmo Nextcloud Notica Notifico Office365 '
|
||||||
'PopcornNotify Prowl PushBullet Pushjet Pushed Pushover PushSafer '
|
'PopcornNotify Prowl PushBullet Pushjet Pushed Pushover PushSafer '
|
||||||
'Rocket.Chat Ryver SendGrid SimplePush Sinch Slack Spontit Stride '
|
'Rocket.Chat Ryver SendGrid SimplePush Sinch Slack SparkPost Spontit '
|
||||||
'Syslog Techulus Push Telegram Twilio Twist Twitter XBMC Microsoft '
|
'Stride Syslog Techulus Push Telegram Twilio Twist Twitter XBMC '
|
||||||
'MSTeams Windows Webex CLI API',
|
'MSTeams Microsoft Windows Webex CLI API',
|
||||||
author='Chris Caron',
|
author='Chris Caron',
|
||||||
author_email='lead2gold@gmail.com',
|
author_email='lead2gold@gmail.com',
|
||||||
packages=find_packages(),
|
packages=find_packages(),
|
||||||
|
@ -3349,6 +3349,215 @@ TEST_URLS = (
|
|||||||
'test_requests_exceptions': True,
|
'test_requests_exceptions': True,
|
||||||
}),
|
}),
|
||||||
|
|
||||||
|
##################################
|
||||||
|
# NotifySparkPost
|
||||||
|
##################################
|
||||||
|
('sparkpost://', {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
('sparkpost://:@/', {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# No Token specified
|
||||||
|
('sparkpost://user@localhost.localdomain', {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# Token is valid, but no user name specified
|
||||||
|
('sparkpost://localhost.localdomain/{}'.format('a' * 32), {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# Invalid from email address
|
||||||
|
('sparkpost://!@localhost.localdomain/{}'.format('b' * 32), {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# No To email address, but everything else is valid
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'.format('c' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?format=markdown'
|
||||||
|
.format('d' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?format=html'
|
||||||
|
.format('d' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?format=text'
|
||||||
|
.format('d' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# valid url with region specified (case insensitve)
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?region=uS'.format('d' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# valid url with region specified (case insensitve)
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?region=EU'.format('e' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# headers
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'
|
||||||
|
'?+X-Customer-Campaign-ID=Apprise'.format('f' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# template tokens
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'
|
||||||
|
'?:name=Chris&:status=admin'.format('g' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# bcc and cc
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'
|
||||||
|
'?bcc=user@example.com&cc=user2@example.com'.format('h' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# invalid url with region specified (case insensitve)
|
||||||
|
('sparkpost://user@localhost.localdomain/{}?region=invalid'.format(
|
||||||
|
'a' * 32), {
|
||||||
|
'instance': TypeError,
|
||||||
|
}),
|
||||||
|
# One 'To' Email address
|
||||||
|
('sparkpost://user@localhost.localdomain/{}/test@example.com'.format(
|
||||||
|
'a' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# Invalid 'To' Email address
|
||||||
|
('sparkpost://user@localhost.localdomain/{}/invalid'.format(
|
||||||
|
'i' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
# Expected notify() response
|
||||||
|
'notify_response': False,
|
||||||
|
}),
|
||||||
|
# Multiple 'To', 'Cc', and 'Bcc' addresses (with invalid ones)
|
||||||
|
('sparkpost://user@example.com/{}/{}?bcc={}&cc={}'.format(
|
||||||
|
'j' * 32,
|
||||||
|
'/'.join(('user1@example.com', 'invalid', 'User2:user2@example.com')),
|
||||||
|
','.join(('user3@example.com', 'i@v', 'User1:user1@example.com')),
|
||||||
|
','.join(('user4@example.com', 'g@r@b', 'Da:user5@example.com'))), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/'
|
||||||
|
'{}?to=test@example.com'.format('k' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# One To Email address, a from name specified too
|
||||||
|
('sparkpost://user@localhost.localdomain/{}/'
|
||||||
|
'test@example.com?name="Frodo"'.format('l' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': {
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
}),
|
||||||
|
# Test invalid JSON response
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'.format('m' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
'requests_response_text': "{",
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'.format('n' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
# force a failure
|
||||||
|
'response': False,
|
||||||
|
'requests_response_code': requests.codes.internal_server_error,
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'.format('o' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
# throw a bizzare code forcing us to fail to look it up
|
||||||
|
'response': False,
|
||||||
|
'requests_response_code': 999,
|
||||||
|
}),
|
||||||
|
('sparkpost://user@localhost.localdomain/{}'.format('p' * 32), {
|
||||||
|
'instance': plugins.NotifySparkPost,
|
||||||
|
# Throws a series of connection and transfer exceptions when this flag
|
||||||
|
# is set and tests that we gracfully handle them
|
||||||
|
'test_requests_exceptions': True,
|
||||||
|
}),
|
||||||
|
|
||||||
##################################
|
##################################
|
||||||
# NotifySpontit
|
# NotifySpontit
|
||||||
##################################
|
##################################
|
||||||
|
163
test/test_sparkpost.py
Normal file
163
test/test_sparkpost.py
Normal file
@ -0,0 +1,163 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Copyright (C) 2020 Chris Caron <lead2gold@gmail.com>
|
||||||
|
# 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.
|
||||||
|
|
||||||
|
import os
|
||||||
|
import pytest
|
||||||
|
import mock
|
||||||
|
import requests
|
||||||
|
from json import dumps
|
||||||
|
from apprise import plugins
|
||||||
|
from apprise import Apprise
|
||||||
|
from apprise import AppriseAttachment
|
||||||
|
from apprise import NotifyType
|
||||||
|
|
||||||
|
# Disable logging for a cleaner testing output
|
||||||
|
import logging
|
||||||
|
logging.disable(logging.CRITICAL)
|
||||||
|
|
||||||
|
# Attachment Directory
|
||||||
|
TEST_VAR_DIR = os.path.join(os.path.dirname(__file__), 'var')
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch('requests.post')
|
||||||
|
def test_notify_sparkpost_plugin_throttling(mock_post):
|
||||||
|
"""
|
||||||
|
API: NotifySpark() Throttling
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# Disable Throttling to speed testing
|
||||||
|
plugins.NotifyBase.request_rate_per_sec = 0
|
||||||
|
plugins.NotifySparkPost.sparkpost_retry_wait_sec = 0.1
|
||||||
|
plugins.NotifySparkPost.sparkpost_retry_attempts = 3
|
||||||
|
|
||||||
|
# API Key
|
||||||
|
apikey = 'abc123'
|
||||||
|
user = 'user'
|
||||||
|
host = 'example.com'
|
||||||
|
targets = '{}@{}'.format(user, host)
|
||||||
|
|
||||||
|
# Exception should be thrown about the fact no user was specified
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifySparkPost(
|
||||||
|
apikey=apikey, targets=targets, host=host)
|
||||||
|
|
||||||
|
# Exception should be thrown about the fact no private key was specified
|
||||||
|
with pytest.raises(TypeError):
|
||||||
|
plugins.NotifySparkPost(
|
||||||
|
apikey=None, targets=targets, user=user, host=host)
|
||||||
|
|
||||||
|
okay_response = requests.Request()
|
||||||
|
okay_response.status_code = requests.codes.ok
|
||||||
|
okay_response.content = dumps({
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
retry_response = requests.Request()
|
||||||
|
retry_response.status_code = requests.codes.too_many_requests
|
||||||
|
retry_response.content = dumps({
|
||||||
|
"errors": [
|
||||||
|
{
|
||||||
|
"description":
|
||||||
|
"Unconfigured or unverified sending domain.",
|
||||||
|
"code": "7001",
|
||||||
|
"message": "Invalid domain"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})
|
||||||
|
|
||||||
|
# Prepare Mock (force 2 retry responses and then one okay)
|
||||||
|
mock_post.side_effect = \
|
||||||
|
(retry_response, retry_response, okay_response)
|
||||||
|
|
||||||
|
obj = Apprise.instantiate(
|
||||||
|
'sparkpost://user@localhost.localdomain/{}'.format(apikey))
|
||||||
|
assert isinstance(obj, plugins.NotifySparkPost)
|
||||||
|
|
||||||
|
# We'll successfully perform the notification as we're within
|
||||||
|
# our retry limit
|
||||||
|
assert obj.notify('test') is True
|
||||||
|
|
||||||
|
mock_post.reset_mock()
|
||||||
|
mock_post.side_effect = \
|
||||||
|
(retry_response, retry_response, retry_response)
|
||||||
|
|
||||||
|
# Now we are less than our expected limit check so we will fail
|
||||||
|
assert obj.notify('test') is False
|
||||||
|
|
||||||
|
|
||||||
|
@mock.patch('requests.post')
|
||||||
|
def test_notify_sparkpost_plugin_attachments(mock_post):
|
||||||
|
"""
|
||||||
|
API: NotifySpark() Attachments
|
||||||
|
|
||||||
|
"""
|
||||||
|
# Disable Throttling to speed testing
|
||||||
|
plugins.NotifyBase.request_rate_per_sec = 0
|
||||||
|
plugins.NotifySparkPost.sparkpost_retry_wait_sec = 0.1
|
||||||
|
plugins.NotifySparkPost.sparkpost_retry_attempts = 3
|
||||||
|
|
||||||
|
okay_response = requests.Request()
|
||||||
|
okay_response.status_code = requests.codes.ok
|
||||||
|
okay_response.content = dumps({
|
||||||
|
"results": {
|
||||||
|
"total_rejected_recipients": 0,
|
||||||
|
"total_accepted_recipients": 1,
|
||||||
|
"id": "11668787484950529"
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
# Assign our mock object our return value
|
||||||
|
mock_post.return_value = okay_response
|
||||||
|
|
||||||
|
# API Key
|
||||||
|
apikey = 'abc123'
|
||||||
|
|
||||||
|
obj = Apprise.instantiate(
|
||||||
|
'sparkpost://user@localhost.localdomain/{}'.format(apikey))
|
||||||
|
assert isinstance(obj, plugins.NotifySparkPost)
|
||||||
|
|
||||||
|
# Test Valid Attachment
|
||||||
|
path = os.path.join(TEST_VAR_DIR, 'apprise-test.gif')
|
||||||
|
attach = AppriseAttachment(path)
|
||||||
|
assert obj.notify(
|
||||||
|
body='body', title='title', notify_type=NotifyType.INFO,
|
||||||
|
attach=attach) is True
|
||||||
|
|
||||||
|
# Test invalid attachment
|
||||||
|
path = os.path.join(TEST_VAR_DIR, '/invalid/path/to/an/invalid/file.jpg')
|
||||||
|
assert obj.notify(
|
||||||
|
body='body', title='title', notify_type=NotifyType.INFO,
|
||||||
|
attach=path) is False
|
||||||
|
|
||||||
|
with mock.patch('base64.b64encode', side_effect=OSError()):
|
||||||
|
# We can't send the message if we fail to parse the data
|
||||||
|
assert obj.notify(
|
||||||
|
body='body', title='title', notify_type=NotifyType.INFO,
|
||||||
|
attach=attach) is False
|
Loading…
x
Reference in New Issue
Block a user