darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2026-02-04 18:32:33 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #88 from alphagov/integrate_template_api

Browse Source 
Mapped template actions to the api and mocked tests.
This commit is contained in:
Adam Shimali
2016-01-19 16:47:35 +00:00
parent 4cd6ea6d09 f6f4fe15b2
commit 0304838a2f
13 changed files with 319 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
app/main/dao/services_dao.py
View File

@@ -1,9 +1,5 @@
from flask import url_for
from datetime import datetime
from client.errors import HTTPError, InvalidResponse
from sqlalchemy.orm import load_only
from flask.ext.login import current_user
from app import (db, notifications_api_client)
from app import notifications_api_client
from app.main.utils import BrowsableItem

49
app/main/dao/templates_dao.py Normal file
View File

@@ -0,0 +1,49 @@
from flask import url_for
from app import notifications_api_client
from app.main.utils import BrowsableItem
def insert_service_template(name, type_, content, service_id):
return notifications_api_client.create_service_template(
name, type_, content, service_id)
def update_service_template(id_, name, type_, content, service_id):
return notifications_api_client.update_service_template(
id_, name, type_, content, service_id)
def get_service_templates(service_id):
return notifications_api_client.get_service_templates(service_id)
def get_service_template(service_id, template_id):
return notifications_api_client.get_service_template(
service_id, template_id)
def delete_service_template(service_id, template_id):
return notifications_api_client.delete_service_template(
service_id, template_id)
class TemplatesBrowsableItem(BrowsableItem):
@property
def title(self):
return self._item['name']
@property
def link(self):
return url_for(
'main.edit_service_template',
service_id=self._item['service'],
template_id=self._item['id'])
@property
def destructive(self):
return False
@property
def hint(self):
return "Some service template hint here"

12
app/main/forms.py
View File

@@ -6,7 +6,8 @@ from wtforms import (
PasswordField,
ValidationError,
TextAreaField,
FileField
FileField,
SelectField
)
from wtforms.validators import DataRequired, Email, Length, Regexp
@@ -187,8 +188,13 @@ class ConfirmPasswordForm(Form):
class TemplateForm(Form):
template_name = StringField(u'Template name')
template_body = TextAreaField(u'Message')
name = StringField(
u'Template name',
validators=[DataRequired(message="Template name cannot be empty")])
template_type = SelectField(u'Template type', choices=[('sms', 'SMS')])
content = TextAreaField(
u'Message',
validators=[DataRequired(message="Template content cannot be empty")])
class ForgotPasswordForm(Form):

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

@@ -3,80 +3,99 @@ from flask_login import login_required
from app.main import main
from app.main.forms import TemplateForm
from ._templates import templates
from app.main.dao.services_dao import get_service_by_id
from app.main.dao import templates_dao as dao
from client.errors import HTTPError
@main.route("/services/<int:service_id>/templates")
@login_required
def manage_templates(service_id):
def manage_service_templates(service_id):
try:
templates = dao.get_service_templates(service_id)['data']
except HTTPError as e:
if e.status_code == 404:
abort(404)
else:
raise e
return render_template(
'views/manage-templates.html',
service_id=service_id,
templates=templates,
)
templates=templates)
@main.route("/services/<int:service_id>/templates/add", methods=['GET', 'POST'])
@login_required
def add_template(service_id):
def add_service_template(service_id):
try:
service = dao.get_service_by_id(service_id)['data']
except HTTPError as e:
if e.status_code == 404:
abort(404)
else:
raise e
form = TemplateForm()
if request.method == 'GET':
return render_template(
'views/edit-template.html',
h1='Add template',
form=form,
service_id=service_id
)
elif request.method == 'POST':
return redirect(url_for('.manage_templates', service_id=service_id))
if form.validate_on_submit():
dao.insert_service_template(
form.name.data, form.template_type.data, form.content.data, service_id)
return redirect(url_for(
'.manage_service_templates', service_id=service_id))
return render_template(
'views/edit-template.html',
h1='Add template',
form=form,
service_id=service_id)
@main.route("/services/<int:service_id>/templates/<int:template_id>", methods=['GET', 'POST'])
@login_required
def edit_template(service_id, template_id):
def edit_service_template(service_id, template_id):
try:
template = dao.get_service_template(service_id, template_id)['data']
except HTTPError as e:
if e.status_code == 404:
abort(404)
else:
raise e
form = TemplateForm(form_data=template)
form = TemplateForm()
if form.validate_on_submit():
dao.update_service_template(
template_id, form.name.data, form.template_type.data,
form.content.data, service_id)
return redirect(url_for('.manage_service_templates', service_id=service_id))
form.template_name.data = templates[template_id - 1]['name']
form.template_body.data = templates[template_id - 1]['body']
if request.method == 'GET':
return render_template(
'views/edit-template.html',
h1='Edit template',
form=form,
service_id=service_id,
template_id=template_id
)
elif request.method == 'POST':
return redirect(url_for('.manage_templates', service_id=service_id))
return render_template(
'views/edit-template.html',
h1='Edit template',
form=form,
service_id=service_id,
template_id=template_id)
@main.route("/services/<int:service_id>/templates/<int:template_id>/delete", methods=['GET', 'POST'])
@login_required
def delete_template(service_id, template_id):
form = TemplateForm()
form.template_name.data = templates[template_id - 1]['name']
form.template_body.data = templates[template_id - 1]['body']
if request.method == 'GET':
flash('Are you sure you want to delete ‘{}’?'.format(form.template_name.data), 'delete')
return render_template(
'views/edit-template.html',
h1='Edit template',
form=form,
service_id=service_id,
template_id=template_id
)
elif request.method == 'POST':
if request.form.get('delete'):
return redirect(url_for('.manage_templates', service_id=service_id))
def delete_service_template(service_id, template_id):
try:
template = dao.get_service_template(service_id, template_id)['data']
except HTTPError as e:
if e.status_code == 404:
abort(404)
else:
return redirect(url_for('.manage_templates', service_id=service_id))
raise e
form = TemplateForm(form_data=template)
if form.validate_on_submit():
dao.delete_service_template(service_id, template_id)
return redirect(url_for('.manage_service_templates', service_id=service_id))
flash('Are you sure you want to delete ‘{}’?'.format(form.name.data), 'delete')
return render_template(
'views/edit-template.html',
h1='Edit template',
form=form,
service_id=service_id,
template_id=template_id)

14
app/notify_client/api_client.py
View File

@@ -83,6 +83,20 @@ class NotificationsAdminAPIClient(NotificationsAPIClient):
endpoint = "/service/{0}/template".format(service_id)
return self.post(endpoint, data)
def update_service_template(self, id_, name, type_, content, service_id):
"""
Update a service template.
"""
data = {
'id': id_,
'name': name,
'template_type': type_,
'content': content,
'service': service_id
}
endpoint = "/service/{0}/template/{1}".format(service_id, id_)
return self.put(endpoint, data)
def get_service_template(self, service_id, template_id, *params):
"""
Retrieve a service template.

2
app/templates/main_nav.html
View File

@@ -6,7 +6,7 @@
<li><a href="{{ url_for('.send_sms', 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('.view_jobs', service_id=service_id) }}">Activity</a></li>
<li><a href="{{ url_for('.manage_templates', service_id=service_id) }}">Templates</a></li>
<li><a href="{{ url_for('.manage_service_templates', service_id=service_id) }}">Templates</a></li>
</ul>
<ul>
<li><a href="{{ url_for('.api_keys', service_id=service_id) }}">API keys and documentation</a></li>

8
app/templates/views/edit-template.html
View File

@@ -11,12 +11,12 @@ GOV.UK Notify | Edit template
<h1 class="heading-xlarge">{{ h1 }}</h1>
<form method="post">
{{ textbox(form.template_name) }}
{{ textbox(form.template_body, highlight_tags=True) }}
{{ textbox(form.name) }}
{{ textbox(form.content, highlight_tags=True) }}
{{ page_footer(
'Save',
delete_link=url_for('.delete_template', service_id=service_id, template_id=template_id) if template_id or None,
back_link=url_for('.manage_templates', service_id=service_id),
delete_link=url_for('.delete_service_template', service_id=service_id, template_id=template_id) if template_id or None,
back_link=url_for('.manage_service_templates', service_id=service_id),
back_link_text='Back to templates'
) }}
</form>

2
app/templates/views/job.html
View File

@@ -38,7 +38,7 @@ GOV.UK Notify | Notifications activity
</ul>
<p>
Sent with template <a href="{{ url_for('.edit_template', service_id=service_id, template_id=1) }}">{{ template_used }}</a> at {{ uploaded_file_time }}
Sent with template <a href="{{ url_for('.edit_service_template', service_id=service_id, template_id=1) }}">{{ template_used }}</a> at {{ uploaded_file_time }}
</p>
{% call(item) list_table(

12
app/templates/views/manage-templates.html
View File

@@ -15,21 +15,21 @@ GOV.UK Notify | Manage templates
<h1 class="heading-xlarge">Templates</h1>
<p>
<a href="{{ url_for('.add_template', service_id=service_id) }}">Create new template</a>
<a href="{{ url_for('.add_service_template', service_id=service_id) }}">Create new template</a>
{% for template in templates %}
{% if template.type == 'sms' %}
{{ sms_message(
template.body,
template.content,
name=template.name,
edit_link=url_for('.edit_template', service_id=service_id, template_id=loop.index)
edit_link=url_for('.edit_service_template', service_id=template.service, template_id=template.id)
) }}
{% elif template.type == 'email' %}
{{ email_message(
template.subject,
template.body,
"template subject",
template.content,
name=template.name,
edit_link=url_for('.edit_template', service_id=service_id, template_id=loop.index)
edit_link=url_for('.edit_service_template', service_id=template.service, template_id=template.id)
) }}
{% endif %}
{% endfor %}

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

@@ -23,7 +23,7 @@
</fieldset>
<p>
or <a href="{{ url_for(".add_template", service_id=service_id) }}">create a new template</a>
or <a href="{{ url_for('.add_service_template', service_id=service_id) }}">create a new template</a>
</p>
<h2 class="heading-medium">2. Add recipients</h2>

10
tests/__init__.py
View File

@@ -29,6 +29,16 @@ def service_json(id_, name, users, limit=1000, active=False, restricted=True):
}
def template_json(id_, name, type_, content, service_id):
return {
'id': id_,
'name': name,
'template_type': type_,
'content': content,
'service': service_id
}
TEST_USER_EMAIL = 'test@user.gov.uk'

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

@@ -1,49 +1,128 @@
import json
from flask import url_for
def test_should_return_list_of_all_templates(app_, db_, db_session, active_user):
def test_should_return_list_of_all_templates(app_,
db_,
db_session,
active_user,
mock_get_service_templates):
with app_.test_request_context():
with app_.test_client() as client:
client.login(active_user)
response = client.get(url_for('.manage_templates', service_id=123))
service_id = 123
response = client.get(url_for(
'.manage_service_templates', service_id=service_id))
assert response.status_code == 200
mock_get_service_templates.assert_called_with(service_id)
def test_should_show_page_for_one_templates(app_, db_, db_session, active_user):
def test_should_show_page_for_one_templates(app_,
db_,
db_session,
active_user,
mock_get_service_template):
with app_.test_request_context():
with app_.test_client() as client:
client.login(active_user)
response = client.get(url_for('.edit_template', service_id=123, template_id=1))
service_id = 123
template_id = 456
response = client.get(url_for(
'.edit_service_template',
service_id=service_id,
template_id=template_id))
assert response.status_code == 200
mock_get_service_template.assert_called_with(
service_id, template_id)
def test_should_redirect_when_saving_a_template(app_, db_, db_session, active_user):
def test_should_redirect_when_saving_a_template(app_,
db_,
db_session,
active_user,
mock_get_service_template,
mock_update_service_template):
with app_.test_request_context():
with app_.test_client() as client:
client.login(active_user)
response = client.post(url_for('.edit_template', service_id=123, template_id=1))
service_id = 123
template_id = 456
name = "new name"
type_ = "sms"
content = "template content"
data = {
'id': template_id,
'name': name,
'template_type': type_,
"content": content,
"service": service_id
}
response = client.post(url_for(
'.edit_service_template',
service_id=service_id,
template_id=template_id), data=data)
assert response.status_code == 302
assert response.location == url_for('.manage_templates', service_id=123, _external=True)
assert response.location == url_for(
'.manage_service_templates', service_id=service_id, _external=True)
mock_update_service_template.assert_called_with(
template_id, name, type_, content, service_id)
def test_should_show_delete_template_page(app_, db_, db_session, active_user):
def test_should_show_delete_template_page(app_,
db_,
db_session,
active_user,
mock_get_service_template):
with app_.test_request_context():
with app_.test_client() as client:
client.login(active_user)
response = client.get(url_for('.delete_template', service_id=123, template_id=1))
service_id = 123
template_id = 456
response = client.get(url_for(
'.delete_service_template',
service_id=service_id,
template_id=template_id))
assert response.status_code == 200
assert 'Are you sure' in response.get_data(as_text=True)
mock_get_service_template.assert_called_with(
service_id, template_id)
def test_should_redirect_when_deleting_a_template(app_, db_, db_session, active_user):
def test_should_redirect_when_deleting_a_template(app_,
db_,
db_session,
active_user,
mock_get_service_template,
mock_delete_service_template):
with app_.test_request_context():
with app_.test_client() as client:
client.login(active_user)
response = client.post(url_for('.delete_template', service_id=123, template_id=1))
service_id = 123
template_id = 456
name = "new name"
type_ = "sms"
content = "template content"
data = {
'id': template_id,
'name': name,
'template_type': type_,
'content': content,
'service': service_id
}
response = client.post(url_for(
'.delete_service_template',
service_id=service_id,
template_id=template_id), data=data)
assert response.status_code == 302
assert response.location == url_for('.manage_templates', service_id=123, _external=True)
assert response.location == url_for(
'.manage_service_templates',
service_id=service_id, _external=True)
mock_get_service_template.assert_called_with(
service_id, template_id)
mock_delete_service_template.assert_called_with(
service_id, template_id)

64
tests/conftest.py
View File

@@ -7,7 +7,7 @@ from flask.ext.script import Manager
from sqlalchemy.schema import MetaData
from . import (
create_test_user, create_another_test_user, service_json, TestClient,
get_test_user)
get_test_user, template_json)
from app import create_app, db
@@ -94,12 +94,11 @@ def mock_get_service(mocker, active_user):
@pytest.fixture(scope='function')
def mock_create_service(mocker):
# TODO fix token generation
def _create(service_name, active, limit, restricted, user_id):
service = service_json(
101, service_name, [user_id], limit=limit,
active=active, restricted=restricted)
return {'data': service, 'token': 1}
return {'data': service}
mock_class = mocker.patch(
'app.notifications_api_client.create_service', side_effect=_create)
return mock_class
@@ -145,6 +144,65 @@ def mock_delete_service(mocker, mock_get_service):
@pytest.fixture(scope='function')
def mock_get_service_template(mocker):
def _create(service_id, template_id):
template = template_json(
template_id, "Template Name", "sms", "template content", service_id)
return {'data': template}
return mocker.patch(
'app.notifications_api_client.get_service_template',
side_effect=_create)
@pytest.fixture(scope='function')
def mock_create_service_template(mocker):
def _create(name, type_, content, service):
template = template_json(
101, name, type_, content, service)
return {'data': template}
mock_class = mocker.patch(
'app.notifications_api_client.create_service_template',
side_effect=_create)
return mock_class
@pytest.fixture(scope='function')
def mock_update_service_template(mocker):
def _update(id_, name, type_, content, service):
template = template_json(
id_, name, type_, content, service)
return {'data': template}
mock_class = mocker.patch(
'app.notifications_api_client.update_service_template',
side_effect=_update)
return mock_class
@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]}
mock_class = mocker.patch(
'app.notifications_api_client.get_service_templates',
side_effect=_create)
return mock_class
@pytest.fixture(scope='function')
def mock_delete_service_template(mocker):
def _delete(service_id, template_id):
template = template_json(
template_id, "Template to delete",
"sms", "content to be deleted", service_id)
return {'data': template}
return mocker.patch(
'app.notifications_api_client.delete_service_template', side_effect=_delete)
def mock_register_user(mocker, user_data):
data = {
"email_address": user_data['email_address'],