darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-05-27 17:39:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #193 from alphagov/email-templates-part-2

Browse Source 
Allow creation and editing of email templates
This commit is contained in:
Adam Shimali
2016-02-24 17:27:51 +00:00
parent 96e7239064 97cebe4511
commit bcf21f5ab2
27 changed files with 385 additions and 236 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@@ -1,7 +1,7 @@
sudo: false
language: python
python:
- '3.4'
- '3.5'
env:
secure: jT9BIioqBMkOdLZhU+WJNdnRJ+06G7qUx4QqEVldp96dJwmWpPEvA0XbitdnQt/WXYkpMlDbgSApvvGj2ZNvdpowRRe5HFX8D2Udhi2g9+cXgKrQxH6zv0evJyQLOjCINW6KtgMCJ5wkYR3qQ4BQawlDt6ecpmeboKTmvs2W8jZ09aV4IKKvdd7BwFon10QVPF5ny10G83unLtKnKgRMjSSLnaEiA78pE/LSUkekK4mhmtl+yfQf60cIuQGcN9NCYIt5PrdYYyMkbUaht9ykwL2C11sp5JYPClI9k6lrlpGJCdL9wbJwejGhR/pEqwJ4tKK8Zv+mngmkbzE6fd5ehuRMnIUAifG4t3p6WbhKwY5pJsdVyPgWcRSPXOJA7yEcAeTAvWcC++6mCIFBeMxt/yQNw02jkFHeNKRh2twTRvr4xWZHq9FsVxTEVz89OOuue3IkkyDNmVusGJ9+AVRIn9Oa+U/r3bDnrs7jz+meSwb82GZUBzFpUe2pe8qeBE572Ay7yHB73VHUgp/2A1qkZ4SnTjTpMbnS5RdXTgwtMkOs5MLZgteCVxFL3sHcr9e/B3UIUnzKUSPXXOjHyDxBwrABWo81V9Vp2IPV7P9Ofv8zroudjQxK5MOcbmiPQF+eEB9L4DvkUBNsGxtJ/nmPp6tmN0Xjo0xXVdZCEVj29Og=
before_install:

2
app/assets/stylesheets/components/banner.scss
View File

@@ -71,7 +71,7 @@
color: $text-colour;
background-image: file-url('icon-important-2x.png');
background-size: 34px 34px;
background-position: 0 0px;
background-position: 0 0;
background-repeat: no-repeat;
padding: 7px 0 5px 50px;
}

23
app/assets/stylesheets/components/email-message.scss
View File

@@ -7,9 +7,26 @@
margin: 20px 0 10px 0;
}
&-subject,
&-from {
margin: 10px 0;
&-meta {
@include core-19;
margin: 0;
td,
th {
@include core-19;
border-bottom: 0;
border-top: 1px solid $border-colour;
}
th {
color: $secondary-text-colour;
}
td {
width: 99%;
}
}
&-from {

2
app/assets/stylesheets/components/sms-message.scss
View File

@@ -40,7 +40,7 @@
.sms-message-use-links {
@include copy-19;
margin-top: 55px;
margin-top: 52px;
a {

2
app/main/__init__.py
View File

@@ -3,7 +3,7 @@ from flask import Blueprint
main = Blueprint('main', __name__)
from app.main.views import (
index, sign_in, sign_out, register, two_factor, verify, sms, add_service,
index, sign_in, sign_out, register, two_factor, verify, send, add_service,
code_not_received, jobs, dashboard, templates, service_settings, forgot_password,
new_password, styleguide, user_profile, choose_service, api_keys, manage_users
)

8
app/main/dao/templates_dao.py
View File

@@ -4,14 +4,14 @@ from app.utils import BrowsableItem
from notifications_python_client.errors import HTTPError
def insert_service_template(name, content, service_id):
def insert_service_template(name, type_, content, service_id, subject=None):
return notifications_api_client.create_service_template(
name, 'sms', content, service_id)
name, type_, content, service_id, subject)
def update_service_template(id_, name, content, service_id):
def update_service_template(id_, name, type_, content, service_id, subject=None):
return notifications_api_client.update_service_template(
id_, name, 'sms', content, service_id)
id_, name, type_, content, service_id)
def get_service_templates(service_id):

9
app/main/forms.py
View File

@@ -188,7 +188,7 @@ class ConfirmPasswordForm(Form):
raise ValidationError('Invalid password')
class TemplateForm(Form):
class SMSTemplateForm(Form):
name = StringField(
u'Template name',
validators=[DataRequired(message="Template name cannot be empty")])
@@ -198,6 +198,13 @@ class TemplateForm(Form):
validators=[DataRequired(message="Template content cannot be empty")])
class EmailTemplateForm(SMSTemplateForm):
subject = StringField(
u'Subject',
validators=[DataRequired(message="Subject cannot be empty")])
class ForgotPasswordForm(Form):
email_address = email_address()

0
app/main/views/email.py Normal file
View File

12
app/main/views/index.py
View File

@@ -22,15 +22,3 @@ def register_from_invite():
@login_required
def verify_mobile():
return render_template('views/verify-mobile.html')
@main.route("/services/<service_id>/send-email")
@login_required
def send_email(service_id):
return render_template('views/send-email.html', service_id=service_id)
@main.route("/services/<service_id>/check-email")
@login_required
def check_email(service_id):
return render_template('views/check-email.html')

85
app/main/views/sms.py → app/main/views/send.py
View File

@@ -28,15 +28,23 @@ from app.main.uploader import (
s3download
)
from app.main.dao import templates_dao
from app.main.dao import services_dao
from app import job_api_client
from app.utils import (
validate_phone_number,
InvalidPhoneError
)
from app.utils import validate_recipient, InvalidPhoneError, InvalidEmailError
first_column_header = {
'email': 'email',
'sms': 'phone'
}
@main.route("/services/<service_id>/sms/send", methods=['GET'])
def choose_sms_template(service_id):
@main.route("/services/<service_id>/send/<template_type>", methods=['GET'])
def choose_template(service_id, template_type):
services_dao.get_service_by_id_or_404(service_id)
if template_type not in ['email', 'sms']:
abort(404)
try:
jobs = job_api_client.get_job(service_id)['data']
except HTTPError as e:
@@ -44,23 +52,20 @@ def choose_sms_template(service_id):
abort(404)
else:
raise e
print("="*80)
print(jobs)
print(len(jobs))
print(bool(len(jobs)))
return render_template(
'views/choose-sms-template.html',
'views/choose-{}-template.html'.format(template_type),
templates=[
Template(template) for template in templates_dao.get_service_templates(service_id)['data']
if template['template_type'] == template_type
],
has_jobs=len(jobs),
service_id=service_id
)
@main.route("/services/<service_id>/sms/send/<template_id>", methods=['GET', 'POST'])
@main.route("/services/<service_id>/send/<int:template_id>", methods=['GET', 'POST'])
@login_required
def send_sms(service_id, template_id):
def send_messages(service_id, template_id):
form = CsvUploadForm()
if form.validate_on_submit():
@@ -70,48 +75,50 @@ def send_sms(service_id, template_id):
upload_id = str(uuid.uuid4())
s3upload(upload_id, service_id, filedata, current_app.config['AWS_REGION'])
session['upload_data'] = {"template_id": template_id, "original_file_name": filedata['file_name']}
return redirect(url_for('.check_sms',
return redirect(url_for('.check_messages',
service_id=service_id,
upload_id=upload_id))
except ValueError as e:
flash('There was a problem uploading: {}'.format(csv_file.filename))
flash(str(e))
return redirect(url_for('.send_sms', service_id=service_id, template_id=template_id))
return redirect(url_for('.send_messages', service_id=service_id, template_id=template_id))
service = services_dao.get_service_by_id_or_404(service_id)
template = Template(
templates_dao.get_service_template_or_404(service_id, template_id)['data']
)
return render_template(
'views/send-sms.html',
'views/send.html',
template=template,
column_headers=['phone'] + template.placeholders_as_markup,
column_headers=[first_column_header[template.template_type]] + template.placeholders_as_markup,
form=form,
service=service,
service_id=service_id
)
@main.route("/services/<service_id>/sms/send/<template_id>.csv", methods=['GET'])
@main.route("/services/<service_id>/send/<template_id>.csv", methods=['GET'])
@login_required
def get_example_csv(service_id, template_id):
template = templates_dao.get_service_template_or_404(service_id, template_id)['data']
placeholders = list(Template(template).placeholders)
output = io.StringIO()
writer = csv.writer(output)
writer.writerow(['phone'] + placeholders)
writer.writerow([first_column_header[template['template_type']]] + placeholders)
writer.writerow([current_user.mobile_number] + ["test {}".format(header) for header in placeholders])
return(output.getvalue(), 200, {'Content-Type': 'text/csv; charset=utf-8'})
@main.route("/services/<service_id>/sms/send/<template_id>/to-self", methods=['GET'])
@main.route("/services/<service_id>/send/<template_id>/to-self", methods=['GET'])
@login_required
def send_sms_to_self(service_id, template_id):
def send_message_to_self(service_id, template_id):
template = templates_dao.get_service_template_or_404(service_id, template_id)['data']
placeholders = list(Template(template).placeholders)
output = io.StringIO()
writer = csv.writer(output)
writer.writerow(['phone'] + placeholders)
writer.writerow([first_column_header[template['template_type']]] + placeholders)
writer.writerow([current_user.mobile_number] + ["test {}".format(header) for header in placeholders])
filedata = {
'file_name': 'Test run',
@@ -121,35 +128,37 @@ def send_sms_to_self(service_id, template_id):
s3upload(upload_id, service_id, filedata, current_app.config['AWS_REGION'])
session['upload_data'] = {"template_id": template_id, "original_file_name": filedata['file_name']}
return redirect(url_for('.check_sms',
return redirect(url_for('.check_messages',
service_id=service_id,
upload_id=upload_id))
@main.route("/services/<service_id>/sms/check/<upload_id>",
@main.route("/services/<service_id>/check/<upload_id>",
methods=['GET', 'POST'])
@login_required
def check_sms(service_id, upload_id):
def check_messages(service_id, upload_id):
upload_data = session['upload_data']
template_id = upload_data.get('template_id')
if request.method == 'GET':
contents = s3download(service_id, upload_id)
if not contents:
flash('There was a problem reading your upload file')
upload_data = session['upload_data']
template_id = upload_data.get('template_id')
raw_template = templates_dao.get_service_template_or_404(service_id, template_id)['data']
recipient_type = first_column_header[raw_template['template_type']]
upload_result = _get_rows(contents, raw_template)
session['upload_data']['notification_count'] = len(upload_result['rows'])
template = Template(
raw_template,
values=upload_result['rows'][0] if upload_result['valid'] else {},
drop_values={'phone'}
drop_values={recipient_type}
)
return render_template(
'views/check-sms.html',
upload_result=upload_result,
template=template,
column_headers=['phone number'] + list(
column_headers=[recipient_type] + list(
template.placeholders if upload_result['valid'] else template.placeholders_as_markup
),
original_file_name=upload_data.get('original_file_name'),
@@ -157,9 +166,7 @@ def check_sms(service_id, upload_id):
form=CsvUploadForm()
)
elif request.method == 'POST':
upload_data = session['upload_data']
original_file_name = upload_data.get('original_file_name')
template_id = upload_data.get('template_id')
notification_count = upload_data.get('notification_count')
session.pop('upload_data')
try:
@@ -171,9 +178,9 @@ def check_sms(service_id, upload_id):
raise e
flash('We’ve started sending your messages', 'default_with_tick')
return redirect(url_for('main.view_job',
service_id=service_id,
job_id=upload_id))
return redirect(
url_for('main.view_job', service_id=service_id, job_id=upload_id)
)
def _get_filedata(file):
@@ -196,8 +203,12 @@ def _get_rows(contents, raw_template):
for row in reader:
rows.append(row)
try:
validate_phone_number(row['phone'])
Template(raw_template, values=row, drop_values={'phone'}).replaced
except (InvalidPhoneError, NeededByTemplateError, NoPlaceholderForDataError):
recipient_column = first_column_header[raw_template['template_type']]
validate_recipient(
row[recipient_column],
template_type=raw_template['template_type']
)
Template(raw_template, values=row, drop_values={recipient_column}).replaced
except (InvalidEmailError, InvalidPhoneError, NeededByTemplateError, NoPlaceholderForDataError):
valid = False
return {"valid": valid, "rows": rows}

79
app/main/views/templates.py
View File

@@ -5,45 +5,44 @@ from notifications_python_client.errors import HTTPError
from utils.template import Template
from app.main import main
from app.main.forms import TemplateForm
from app.main.forms import SMSTemplateForm, EmailTemplateForm
from app import job_api_client
from app.main.dao.services_dao import get_service_by_id
from app.main.dao.services_dao import get_service_by_id_or_404
from app.main.dao import templates_dao as tdao
from app.main.dao import services_dao as sdao
@main.route("/services/<service_id>/templates")
form_objects = {
'email': EmailTemplateForm,
'sms': SMSTemplateForm
}
@main.route("/services/<service_id>/templates/add-<template_type>", methods=['GET', 'POST'])
@login_required
def manage_service_templates(service_id):
return redirect(url_for(
'.choose_sms_template',
service_id=service_id
))
def add_service_template(service_id, template_type):
service = sdao.get_service_by_id_or_404(service_id)
@main.route("/services/<service_id>/templates/add", methods=['GET', 'POST'])
@login_required
def add_service_template(service_id):
try:
service = sdao.get_service_by_id(service_id)['data']
except HTTPError as e:
if e.status_code == 404:
abort(404)
else:
raise e
if template_type not in ['sms', 'email']:
abort(404)
form = TemplateForm()
form = form_objects[template_type]()
if form.validate_on_submit():
tdao.insert_service_template(
form.name.data, form.template_content.data, service_id)
return redirect(url_for(
'.choose_sms_template', service_id=service_id))
form.name.data, template_type, form.template_content.data, service_id, form.subject.data or None
)
return redirect(
url_for('.choose_template', service_id=service_id, template_type=template_type)
)
return render_template(
'views/edit-template.html',
h1='Add a text message template',
'views/edit-{}-template.html'.format(template_type),
form=form,
service_id=service_id)
template_type=template_type,
service_id=service_id
)
@main.route("/services/<service_id>/templates/<int:template_id>", methods=['GET', 'POST'])
@@ -51,20 +50,26 @@ def add_service_template(service_id):
def edit_service_template(service_id, template_id):
template = tdao.get_service_template_or_404(service_id, template_id)['data']
template['template_content'] = template['content']
form = TemplateForm(**template)
form = form_objects[template['template_type']](**template)
if form.validate_on_submit():
tdao.update_service_template(
template_id, form.name.data,
form.template_content.data, service_id)
return redirect(url_for('.choose_sms_template', service_id=service_id))
template_id, form.name.data, template['template_type'],
form.template_content.data, service_id
)
return redirect(url_for(
'.choose_template',
service_id=service_id,
template_type=template['template_type']
))
return render_template(
'views/edit-template.html',
h1='Edit template',
'views/edit-{}-template.html'.format(template['template_type']),
form=form,
service_id=service_id,
template_id=template_id)
template_id=template_id,
template_type=template['template_type']
)
@main.route("/services/<service_id>/templates/<int:template_id>/delete", methods=['GET', 'POST'])
@@ -74,13 +79,17 @@ def delete_service_template(service_id, template_id):
if request.method == 'POST':
tdao.delete_service_template(service_id, template_id)
return redirect(url_for('.manage_service_templates', service_id=service_id))
return redirect(url_for(
'.choose_template',
service_id=service_id,
template_type=template['template_type']
))
template['template_content'] = template['content']
form = TemplateForm(**template)
form = form_objects[template['template_type']](**template)
flash('Are you sure you want to delete ‘{}’?'.format(form.name.data), 'delete')
return render_template(
'views/edit-template.html',
'views/edit-{}-template.html'.format(template['template_type']),
h1='Edit template',
form=form,
service_id=service_id,

14
app/notify_client/api_client.py
View File

@@ -70,7 +70,7 @@ class NotificationsAdminAPIClient(NotificationsAPIClient):
endpoint = "/service/{0}".format(service_id)
return self.put(endpoint, data)
def create_service_template(self, name, type_, content, service_id):
def create_service_template(self, name, type_, content, service_id, subject=None):
"""
Create a service template.
"""
@@ -80,10 +80,14 @@ class NotificationsAdminAPIClient(NotificationsAPIClient):
"content": content,
"service": service_id
}
if subject:
data.update({
'subject': subject
})
endpoint = "/service/{0}/template".format(service_id)
return self.post(endpoint, data)
def update_service_template(self, id_, name, type_, content, service_id):
def update_service_template(self, id_, name, type_, content, service_id, subject=None):
"""
Update a service template.
"""
@@ -94,8 +98,12 @@ class NotificationsAdminAPIClient(NotificationsAPIClient):
'content': content,
'service': service_id
}
if subject:
data.update({
'subject': subject
})
endpoint = "/service/{0}/template/{1}".format(service_id, id_)
return self.put(endpoint, data)
return self.post(endpoint, data)
def get_service_template(self, service_id, template_id, *params):
"""

44
app/templates/components/email-message.html
View File

@@ -9,29 +9,27 @@
</h3>
{% endif %}
<div class="email-message">
{% if from_name and from_address %}
<div class="email-message-from">
<div class="grid-row">
<div class="column-one-eighth">
<span class="form-hint">From</span>
</div>
<div class="column-seven-eighths">
{{ from_name }} &lt;{{ from_address }}&gt;
</div>
</div>
</div>
{% endif %}
{% if subject %}
<div class="email-message-subject">
<div class="grid-row">
<div class="column-one-eighth">
<span class="form-hint">Subject</span>
</div>
<div class="column-seven-eighths">
{{ subject }}
</div>
</div>
</div>
{% if from_name or subject %}
<table class="email-message-meta">
<tbody>
{% if from_name and from_address %}
<tr>
<th>From</th>
<td>
{{ from_name }} &lt;{{ from_address }}&gt;
</td>
</tr>
{% endif %}
{% if subject %}
<tr class="email-message-meta">
<th>Subject</th>
<td>
{{ subject }}
</td>
</div>
{% endif %}
</tbody>
</table>
{% endif %}
<div class="email-message-body">
{{ body|nl2br }}

4
app/templates/main_nav.html
View File

@@ -3,8 +3,8 @@
<a href="{{ url_for('.service_dashboard', service_id=service_id) }}">{{ session.get('service_name', 'Service') }}</a>
</h2>
<ul>
<li><a href="{{ url_for('.choose_sms_template', service_id=service_id) }}">Send text messages</a></li>
<li><a href="{{ url_for('.send_email', service_id=service_id) }}">Send emails</a></li>
<li><a href="{{ url_for('.choose_template', service_id=service_id, template_type='sms') }}">Send text messages</a></li>
<li><a href="{{ url_for('.choose_template', service_id=service_id, template_type='email') }}">Send emails</a></li>
</ul>
<ul>
<li><a href="{{ url_for('.manage_users', service_id=service_id) }}">Manage team</a></li>

2
app/templates/views/check-sms.html
View File

@@ -42,7 +42,7 @@
<form method="post" enctype="multipart/form-data">
<input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
<input type="submit" class="button" value="{{ "Send {} text message{}".format(upload_result.rows|count, '' if upload_result.rows|count == 1 else 's') }}" />
<a href="{{url_for('.send_sms', service_id=service_id, template_id=template.id)}}" class="page-footer-back-link">Back</a>
<a href="{{url_for('.send_messages', service_id=service_id, template_id=template.id)}}" class="page-footer-back-link">Back</a>
</form>
{% else %}
{{file_upload(form.file, button_text='Upload a CSV file')}}

36
app/templates/views/choose-email-template.html Normal file
View File

@@ -0,0 +1,36 @@
{% extends "withnav_template.html" %}
{% from "components/email-message.html" import email_message %}
{% from "components/page-footer.html" import page_footer %}
{% from "components/textbox.html" import textbox %}
{% block page_title %}
Send emails – GOV.UK Notify
{% endblock %}
{% block maincolumn_content %}
<h1 class="heading-large">Send emails</h1>
<form method="POST" enctype="multipart/form-data">
{% if templates %}
<div class="grid-row">
{% for template in templates %}
<div class="column-two-thirds">
{{ email_message(template.subject, template.formatted_as_markup, name=template.name) }}
</div>
<div class="column-one-third">
<div class="sms-message-use-links">
<a href="{{ url_for(".edit_service_template", service_id=service_id, template_id=template.id) }}">Edit template</a>
</div>
</div>
{% endfor %}
</div>
{% endif %}
<p>
<a href="{{ url_for('.add_service_template', service_id=service_id, template_type='email') }}" class="button">Add a new template</a>
</p>
</form>
{% endblock %}

6
app/templates/views/choose-sms-template.html
View File

@@ -30,8 +30,8 @@
</div>
<div class="column-one-third">
<div class="sms-message-use-links">
<a href="{{ url_for(".send_sms", service_id=service_id, template_id=template.id) }}">Add recipients</a>
<a href="{{ url_for(".send_sms_to_self", service_id=service_id, template_id=template.id) }}">Send yourself a test</a>
<a href="{{ url_for(".send_messages", service_id=service_id, template_id=template.id) }}">Add recipients</a>
<a href="{{ url_for(".send_message_to_self", service_id=service_id, template_id=template.id) }}">Send yourself a test</a>
<a href="{{ url_for(".edit_service_template", service_id=service_id, template_id=template.id) }}">Edit template</a>
</div>
</div>
@@ -40,7 +40,7 @@
{% endif %}
<p>
<a href="{{ url_for('.add_service_template', service_id=service_id) }}" class="button">Add a new template</a>
<a href="{{ url_for('.add_service_template', service_id=service_id, template_type='sms') }}" class="button">Add a new template</a>
</p>
</form>

7
app/templates/views/edit-template.html → app/templates/views/edit-email-template.html
View File

@@ -8,12 +8,15 @@
{% block maincolumn_content %}
<h1 class="heading-large">{{ h1 }}</h1>
<h1 class="heading-large">Edit email template</h1>
<form method="post">
<div class="grid-row">
<div class="column-two-thirds">
{{ textbox(form.name, width='1-1') }}
{% if 'email' == template_type %}
{{ textbox(form.subject, width='1-1') }}
{% endif %}
</div>
</div>
<div class="grid-row">
@@ -31,7 +34,7 @@
'Save',
delete_link=url_for('.delete_service_template', service_id=service_id, template_id=template_id) if template_id or None,
delete_link_text='Delete this template',
back_link=url_for('.choose_sms_template', service_id=service_id),
back_link=url_for('.choose_template', template_type=template_type, service_id=service_id),
back_link_text='Cancel'
) }}
</form>

43
app/templates/views/edit-sms-template.html Normal file
View File

@@ -0,0 +1,43 @@
{% extends "withnav_template.html" %}
{% from "components/textbox.html" import textbox %}
{% from "components/page-footer.html" import page_footer %}
{% block page_title %}
{{ h1 }} – GOV.UK Notify
{% endblock %}
{% block maincolumn_content %}
<h1 class="heading-large">Edit text message template</h1>
<form method="post">
<div class="grid-row">
<div class="column-two-thirds">
{{ textbox(form.name, width='1-1') }}
{% if 'email' == template_type %}
{{ textbox(form.subject, width='1-1') }}
{% endif %}
</div>
</div>
<div class="grid-row">
<div class="column-two-thirds">
{{ textbox(form.template_content, highlight_tags=True, width='1-1') }}
</div>
<div class="column-one-third">
<label for='template_content' class='edit-template-placeholder-hint'>
Add placeholders using double brackets, eg Your thing
is due on ((date))
</label>
</div>
</div>
{{ page_footer(
'Save',
delete_link=url_for('.delete_service_template', service_id=service_id, template_id=template_id) if template_id or None,
delete_link_text='Delete this template',
back_link=url_for('.choose_template', service_id=service_id, template_type=template_type),
back_link_text='Cancel'
) }}
</form>
{% endblock %}

17
app/templates/views/send-email.html
View File

@@ -1,17 +0,0 @@
{% extends "withnav_template.html" %}
{% block page_title %}
Send email – GOV.UK Notify
{% endblock %}
{% block maincolumn_content %}
<h1 class="heading-large">Send email</h1>
<p>This page will be where we construct email messages</p>
<p>
<a class="button" href="check-email" role="button">Continue</a>
</p>
{% endblock %}

19
app/templates/views/send-sms.html → app/templates/views/send.html
View File

@@ -1,5 +1,6 @@
{% extends "withnav_template.html" %}
{% from "components/sms-message.html" import sms_message %}
{% from "components/email-message.html" import email_message %}
{% from "components/page-footer.html" import page_footer %}
{% from "components/file-upload.html" import file_upload %}
{% from "components/table.html" import list_table, field %}
@@ -14,14 +15,22 @@
<div class="grid-row">
<div class="column-two-thirds">
{{ sms_message(template.formatted_as_markup) }}
{% if 'sms' == template.template_type %}
{{ sms_message(template.formatted_as_markup) }}
{% elif 'email' == template.template_type %}
{{ email_message(
template.subject,
template.formatted_as_markup,
from_address='{}@notifications.service.gov.uk'.format(service.email_from),
from_name=service.name
) }}
{% endif %}
{{ banner(
'You can upload real data, but we’ll only send to your mobile number until you <a href="{}">request to go live</a>'|safe,
'You can upload real data, but we’ll only send to your mobile number until you <a href="{}">request to go live</a>'.format(
url_for('.service_request_to_go_live', service_id=service_id)
)|safe,
'info'
)}}
</div>
</div>

4
app/templates/views/service_dashboard.html
View File

@@ -36,7 +36,7 @@
</ol>
""".format(
url_for(".add_service_template", service_id=service_id),
url_for(".choose_sms_template", service_id=service_id)
url_for(".choose_template", service_id=service_id, template_type="sms")
)|safe,
subhead='Get started',
type="tip"
@@ -46,7 +46,7 @@
"""
<a href='{}'>Send yourself a text message</a>
""".format(
url_for(".choose_sms_template", service_id=service_id)
url_for(".choose_template", service_id=service_id, template_type="sms")
)|safe,
subhead='Next step',
type="tip"

20
app/utils.py
View File

@@ -1,3 +1,5 @@
import re
from functools import wraps
from flask import abort
@@ -28,6 +30,11 @@ class BrowsableItem(object):
pass
class InvalidEmailError(Exception):
def __init__(self, message):
self.message = message
class InvalidPhoneError(Exception):
def __init__(self, message):
self.message = message
@@ -74,6 +81,19 @@ def format_phone_number(number):
return '+447{}{}{}'.format(*re.findall('...', number))
def validate_email_address(email_address):
if re.match(r"(^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$)", email_address):
return
raise InvalidEmailError('Not a valid email address')
def validate_recipient(recipient, template_type):
return {
'email': validate_email_address,
'sms': validate_phone_number
}[template_type](recipient)
def user_has_permissions(*permissions):
def wrap(func):
@wraps(func)

4
requirements.txt
View File

@@ -12,6 +12,6 @@ credstash==1.8.0
boto3==1.2.3
Pygments==2.0.2
git+https://github.com/alphagov/notifications-python-client.git@0.2.5#egg=notifications-python-client==0.2.7
git+https://github.com/alphagov/notifications-python-client.git@0.2.8#egg=notifications-python-client==0.2.8
git+https://github.com/alphagov/notifications-utils.git@0.1.0#egg=notifications-utils==0.1.0
git+https://github.com/alphagov/notifications-utils.git@0.1.1#egg=notifications-utils==0.1.1

126
tests/app/main/views/test_sms.py → tests/app/main/views/test_send.py
View File

@@ -1,56 +1,70 @@
from io import BytesIO
from flask import url_for
import pytest
import moto
template_types = ['email', 'sms']
def test_choose_sms_template(app_,
api_user_active,
mock_login,
mock_get_user,
mock_check_verify_code,
mock_get_service_templates,
mock_get_jobs):
@pytest.mark.parametrize("template_type", template_types)
def test_choose_template(
template_type,
app_,
api_user_active,
mock_login,
mock_get_user,
mock_get_service,
mock_check_verify_code,
mock_get_service_templates,
mock_get_jobs
):
with app_.test_request_context():
with app_.test_client() as client:
client.login(api_user_active)
response = client.get(url_for('main.choose_sms_template', service_id=12345))
response = client.get(url_for('main.choose_template', template_type=template_type, service_id=12345))
assert response.status_code == 200
content = response.get_data(as_text=True)
assert 'template_one' in content
assert 'template one content' in content
assert 'template_two' in content
assert 'template two content' in content
assert '{}_template_one'.format(template_type) in content
assert '{} template one content'.format(template_type) in content
assert '{}_template_two'.format(template_type) in content
assert '{} template two content'.format(template_type) in content
def test_upload_empty_csvfile_returns_to_upload_page(app_,
api_user_active,
mock_login,
mock_get_user,
mock_get_service_templates,
mock_check_verify_code,
mock_get_service_template):
def test_upload_empty_csvfile_returns_to_upload_page(
app_,
api_user_active,
mock_login,
mock_get_user,
mock_get_service,
mock_get_service_templates,
mock_check_verify_code,
mock_get_service_template
):
with app_.test_request_context():
with app_.test_client() as client:
client.login(api_user_active)
upload_data = {'file': (BytesIO(''.encode('utf-8')), 'emtpy.csv')}
response = client.post(url_for('main.send_sms', service_id=12345, template_id=54321),
data=upload_data, follow_redirects=True)
response = client.post(
url_for('main.send_messages', service_id=12345, template_id=54321),
data=upload_data,
follow_redirects=True
)
assert response.status_code == 200
content = response.get_data(as_text=True)
assert 'The file emtpy.csv contained no data' in content
@pytest.mark.skipif(True, reason='Errors on travis')
@moto.mock_s3
def test_upload_csvfile_with_invalid_phone_shows_check_page_with_errors(app_,
mocker,
api_user_active,
mock_login,
mock_get_user,
mock_get_user_by_email,
mock_get_service_template):
def test_upload_csvfile_with_invalid_phone_shows_check_page_with_errors(
app_,
api_user_active,
mock_login,
mock_get_service_template
):
contents = 'phone\n+44 123\n+44 456'
file_data = (BytesIO(contents.encode('utf-8')), 'invalid.csv')
@@ -59,9 +73,11 @@ def test_upload_csvfile_with_invalid_phone_shows_check_page_with_errors(app_,
with app_.test_client() as client:
client.login(api_user_active)
upload_data = {'file': file_data}
response = client.post(url_for('main.send_sms', service_id=12345, template_id=54321),
data=upload_data,
follow_redirects=True)
response = client.post(
url_for('main.send_messages', service_id=12345, template_id=54321),
data=upload_data,
follow_redirects=True
)
assert response.status_code == 200
content = response.get_data(as_text=True)
assert 'Your CSV file contained missing or invalid data' in content
@@ -70,6 +86,7 @@ def test_upload_csvfile_with_invalid_phone_shows_check_page_with_errors(app_,
assert 'Upload a CSV file' in content
@pytest.mark.skipif(True, reason='Errors on travis')
@moto.mock_s3
def test_send_test_message_to_self(
app_,
@@ -85,7 +102,7 @@ def test_send_test_message_to_self(
with app_.test_client() as client:
client.login(api_user_active)
response = client.get(
url_for('main.send_sms_to_self', service_id=12345, template_id=54321),
url_for('main.send_message_to_self', service_id=12345, template_id=54321),
follow_redirects=True
)
assert response.status_code == 200
@@ -94,6 +111,7 @@ def test_send_test_message_to_self(
assert '+4412341234' in content
@pytest.mark.skipif(True, reason='Errors on travis')
@moto.mock_s3
def test_download_example_csv(
app_,
@@ -117,14 +135,17 @@ def test_download_example_csv(
assert 'text/csv' in response.headers['Content-Type']
@pytest.mark.skipif(True, reason='Errors on travis')
@moto.mock_s3
def test_upload_csvfile_with_valid_phone_shows_all_numbers(app_,
mocker,
api_user_active,
mock_login,
mock_get_user,
mock_get_user_by_email,
mock_get_service_template):
def test_upload_csvfile_with_valid_phone_shows_all_numbers(
app_,
mocker,
api_user_active,
mock_login,
mock_get_user,
mock_get_user_by_email,
mock_get_service_template
):
contents = 'phone\n+44 7700 900981\n+44 7700 900982\n+44 7700 900983\n+44 7700 900984\n+44 7700 900985\n+44 7700 900986' # noqa
@@ -134,7 +155,7 @@ def test_upload_csvfile_with_valid_phone_shows_all_numbers(app_,
with app_.test_client() as client:
client.login(api_user_active)
upload_data = {'file': file_data}
response = client.post(url_for('main.send_sms', service_id=12345, template_id=54321),
response = client.post(url_for('main.send_messages', service_id=12345, template_id=54321),
data=upload_data,
follow_redirects=True)
with client.session_transaction() as sess:
@@ -153,17 +174,20 @@ def test_upload_csvfile_with_valid_phone_shows_all_numbers(app_,
assert '+44 7700 900986' in content
@pytest.mark.skipif(True, reason='Errors on travis')
@moto.mock_s3
def test_create_job_should_call_api(app_,
service_one,
api_user_active,
mock_get_user,
mock_get_user_by_email,
mock_login,
job_data,
mock_create_job,
mock_get_job,
mock_get_service_template):
def test_create_job_should_call_api(
app_,
service_one,
api_user_active,
mock_get_user,
mock_get_user_by_email,
mock_login,
job_data,
mock_create_job,
mock_get_job,
mock_get_service_template
):
service_id = service_one['id']
job_id = job_data['id']
@@ -178,7 +202,7 @@ def test_create_job_should_call_api(app_,
session['upload_data'] = {'original_file_name': original_file_name,
'template_id': template_id,
'notification_count': notification_count}
url = url_for('main.check_sms', service_id=service_one['id'], upload_id=job_id)
url = url_for('main.check_messages', service_id=service_one['id'], upload_id=job_id)
response = client.post(url, data=job_data, follow_redirects=True)
assert response.status_code == 200

32
tests/app/main/views/test_templates.py
View File

@@ -4,24 +4,6 @@ import uuid
from flask import url_for
def test_should_return_list_of_all_templates(app_,
api_user_active,
mock_get_service_templates,
mock_get_user,
mock_get_user_by_email,
mock_login,
mock_get_jobs):
with app_.test_request_context():
with app_.test_client() as client:
client.login(api_user_active)
service_id = str(uuid.uuid4())
response = client.get(url_for(
'.manage_service_templates', service_id=service_id), follow_redirects=True)
assert response.status_code == 200
mock_get_service_templates.assert_called_with(service_id)
def test_should_show_page_for_one_templates(app_,
api_user_active,
mock_get_service_template,
@@ -62,8 +44,9 @@ def test_should_redirect_when_saving_a_template(app_,
data = {
'id': template_id,
'name': name,
"template_content": content,
"service": service_id
'template_content': content,
'type': 'sms',
'service': service_id
}
response = client.post(url_for(
'.edit_service_template',
@@ -72,7 +55,7 @@ def test_should_redirect_when_saving_a_template(app_,
assert response.status_code == 302
assert response.location == url_for(
'.choose_sms_template', service_id=service_id, _external=True)
'.choose_template', service_id=service_id, template_type='sms', _external=True)
mock_update_service_template.assert_called_with(
template_id, name, 'sms', content, service_id)
@@ -127,12 +110,13 @@ def test_should_redirect_when_deleting_a_template(app_,
response = client.post(url_for(
'.delete_service_template',
service_id=service_id,
template_id=template_id), data=data)
template_id=template_id
), data=data)
assert response.status_code == 302
assert response.location == url_for(
'.manage_service_templates',
service_id=service_id, _external=True)
'.choose_template',
service_id=service_id, template_type=type_, _external=True)
mock_get_service_template.assert_called_with(
service_id, template_id)
mock_delete_service_template.assert_called_with(

19
tests/conftest.py
View File

@@ -163,11 +163,20 @@ def mock_update_service_template(mocker):
@pytest.fixture(scope='function')
def mock_get_service_templates(mocker):
def _create(service_id):
template_one = template_json(
1, "template_one", "sms", "template one content", service_id)
template_two = template_json(
2, "template_two", "sms", "template two content", service_id)
return {'data': [template_one, template_two]}
return {'data': [
template_json(
1, "sms_template_one", "sms", "sms template one content", service_id
),
template_json(
2, "sms_template_two", "sms", "sms template two content", service_id
),
template_json(
3, "email_template_one", "email", "email template one content", service_id
),
template_json(
4, "email_template_two", "email", "email template two content", service_id
)
]}
return mocker.patch(
'app.notifications_api_client.get_service_templates',