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

Make send a test teach you how placeholders work

Browse Source 
This commit does two main things:

- adds textboxes to the send yourself a test page, so you can replace
  ((name)) with ‘Chris’, or whatever your name is
- rejigs the send page a bit to make it clearer what the CSV upload is
  for and how to use it

The idea being that, since most users go into ‘send yourself a test’
first, it teaches them about how placeholders work by making them do the
replacing themselves.
This commit is contained in:
Chris Hill-Scott
2016-05-05 08:39:36 +01:00
parent 9d37040d49
commit 687ccad018
9 changed files with 245 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
app/main/views/send.py
View File

@@ -50,20 +50,26 @@ def get_page_headings(template_type):
}[template_type]
def get_example_csv_rows(template, number_of_rows=2):
def get_example_csv_fields(column_headers, use_example_as_example, submitted_fields):
print("="*40)
print(list(column_headers))
if use_example_as_example:
return ["example" for header in column_headers]
elif submitted_fields:
return [submitted_fields.get(header) for header in column_headers]
else:
return list(column_headers)
def get_example_csv_rows(template, use_example_as_example=True, submitted_fields=False):
return [
[
{
'email': current_user.email_address,
'sms': validate_and_format_phone_number(
current_user.mobile_number, human_readable=True
)
}[template.template_type]
] + [
"{} {}".format(header, i) for header in template.placeholders
]
for i in range(1, number_of_rows + 1)
]
{
'email': 'test@example.com' if use_example_as_example else current_user.email_address,
'sms': '07700 900321' if use_example_as_example else validate_and_format_phone_number(
current_user.mobile_number, human_readable=True
)
}[template.template_type]
] + get_example_csv_fields(template.placeholders, use_example_as_example, submitted_fields)
@main.route("/services/<service_id>/send/<template_type>", methods=['GET'])
@@ -131,7 +137,7 @@ def send_messages(service_id, template_id):
'views/send.html',
template=template,
recipient_column=first_column_heading[template.template_type],
example=get_example_csv_rows(template),
example=[get_example_csv_rows(template, use_example_as_example=True)],
form=form
)
@@ -139,43 +145,58 @@ def send_messages(service_id, template_id):
@main.route("/services/<service_id>/send/<template_id>.csv", methods=['GET'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters', 'manage_templates', any_=True)
def get_example_csv(service_id, template_id, number_of_rows=2):
def get_example_csv(service_id, template_id):
template = Template(service_api_client.get_service_template(service_id, template_id)['data'])
with io.StringIO() as output:
writer = csv.writer(output)
writer.writerows(
[
[first_column_heading[template.template_type]] +
list(template.placeholders)
] +
get_example_csv_rows(template, number_of_rows=number_of_rows)
)
writer.writerows([
[first_column_heading[template.template_type]] + list(template.placeholders),
get_example_csv_rows(template)
])
return output.getvalue(), 200, {
'Content-Type': 'text/csv; charset=utf-8',
'Content-Disposition': 'inline; filename="{}.csv"'.format(template.name)
}
@main.route("/services/<service_id>/send/<template_id>/to-self", methods=['GET'])
@main.route("/services/<service_id>/send/<template_id>/test", methods=['GET', 'POST'])
@login_required
@user_has_permissions('send_texts', 'send_emails', 'send_letters')
def send_message_to_self(service_id, template_id):
template = Template(service_api_client.get_service_template(service_id, template_id)['data'])
def send_test(service_id, template_id):
filedata = {
'file_name': 'Test run',
'data': get_example_csv(service_id, template_id, number_of_rows=1)[0]
}
template = Template(
service_api_client.get_service_template(service_id, template_id)['data'],
prefix=current_service['name']
)
upload_id = str(uuid.uuid4())
if len(template.placeholders) == 0 or request.method == 'POST':
with io.StringIO() as output:
writer = csv.writer(output)
writer.writerows([
[first_column_heading[template.template_type]] + list(template.placeholders),
get_example_csv_rows(template, use_example_as_example=False, submitted_fields=request.form)
])
filedata = {
'file_name': 'Test run',
'data': output.getvalue()
}
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_messages',
upload_id=upload_id,
service_id=service_id,
template_type=template.template_type,
from_test=True
))
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_messages',
upload_id=upload_id,
service_id=service_id,
template_type=template.template_type))
return render_template(
'views/send-test.html',
template=template,
recipient_column=first_column_heading[template.template_type],
example=[get_example_csv_rows(template, use_example_as_example=False)]
)
@main.route("/services/<service_id>/send/<template_id>/from-api", methods=['GET'])
@@ -232,6 +253,11 @@ def check_messages(service_id, template_type, upload_id):
) if current_service['restricted'] else None
)
if request.args.get('from_test'):
back_link = url_for('.send_test', service_id=service_id, template_id=template.id)
else:
back_link = url_for('.send_messages', service_id=service_id, template_id=template.id)
with suppress(StopIteration):
template.values = next(recipients.rows)
first_recipient = template.values.get(recipients.recipient_column_header, '')
@@ -256,7 +282,8 @@ def check_messages(service_id, template_type, upload_id):
send_button_text=get_send_button_text(template.template_type, session['upload_data']['notification_count']),
upload_id=upload_id,
form=CsvUploadForm(),
statistics=statistics
statistics=statistics,
back_link=back_link
)