1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
# Copyright (C) 2014 Linaro Ltd.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Collection of utilities to handle subscriptions."""
import pymongo
import models
import models.subscription as mods
from utils import LOG
from utils.db import (
find_one,
save,
update,
)
def subscribe(database, json_obj):
"""Subscribe an email to a job.
It accepts a dict-like object that should contain at least the `job_id' and
`email' keys. All other keys will not be considered.
At the moment no validation is run on the email provided.
:param database: The database where to store the data.
:param json_obj: A dict-like object with `job_id' and `email' fields.
:return This function return 201 when the subscription has been performed,
404 if the job to subscribe to does not exist, or 500 in case of
an internal database error.
"""
ret_val = 404
job = json_obj['job']
emails = json_obj['email']
job_doc = find_one(database[models.JOB_COLLECTION], job)
if job_doc:
job_id = job_doc[models.ID_KEY]
subscription = find_one(
database[models.SUBSCRIPTION_COLLECTION],
job_id,
'job_id'
)
if subscription:
sub_obj = mods.SubscriptionDocument.from_json(subscription)
sub_obj.emails = emails
else:
sub_id = (
models.SUBSCRIPTION_DOCUMENT_NAME % job_id
)
sub_obj = mods.SubscriptionDocument(sub_id, job_id)
sub_obj.emails = emails
ret_val = save(database, sub_obj)
return ret_val
def unsubscribe(collection, doc_id, email):
"""Unsubscribe an email from a job.
:param collection: The collection where operation will be performed.
:param doc_id: The job ID from which the email should be unsubscribed.
:type str
:param email: The email to unsubscribe.
:type str
:return 200 on success, 400 if there is an error removing an email, 500
in case of a database error.
"""
ret_val = 400
subscription = find_one(collection, doc_id)
if subscription:
emails = subscription['emails']
try:
emails.remove(email)
ret_val = update(
collection, {'_id': doc_id}, {'emails': emails}
)
except ValueError, ex:
LOG.error(
"Error removing email address from subscription with "
"'_id': %s" % (doc_id)
)
LOG.exception(str(ex))
return ret_val
def send(job_id):
"""Send emails to the subscribers.
:param job_id: The job ID for which to send notifications.
"""
# TODO: add logic to make sure we can send the notifications.
# We should store the job status.
database = pymongo.MongoClient()[models.DB_NAME]
subscription = find_one(
database[models.SUBSCRIPTION_COLLECTION], job_id, 'job_id'
)
if subscription:
emails = subscription['emails']
LOG.info("Sending emails to: %s" % (str(emails)))
|
