app/main/views/templates.py

from flask import request, render_template, redirect, url_for, flash
from flask_login import login_required

from app.main import main
from app.main.forms import TemplateForm

from ._templates import templates


@main.route("/services/<int:service_id>/templates")
@login_required
def manage_templates(service_id):
    return render_template(
        'views/manage-templates.html',
        service_id=service_id,
        templates=templates,
    )


@main.route("/services/<int:service_id>/templates/add", methods=['GET', 'POST'])
@login_required
def add_template(service_id):

    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))


@main.route("/services/<int:service_id>/templates/<int:template_id>", methods=['GET', 'POST'])
@login_required
def edit_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':
        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))


@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))
        else:
            return redirect(url_for('.manage_templates', service_id=service_id))
-												Add link to delete a template

This is a link not a button because:
- it’s less prominent—delete is an infrequent action
- it’s a two-step process, and only the second part changes any data (so it has
  a button)

											
										
										
											2016-01-14 09:44:06 +00:00
+								from flask import request, render_template, redirect, url_for, flash
-												Add login_required for all endpoints where it makes sense.
https://www.pivotaltracker.com/story/show/111240834

											
										
										
											2016-01-11 16:03:41 +00:00
+								from flask_login import login_required
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
 								from app.main import main
-												Add a WTForms-compatible textbox macro

This macro:
- accepts a WTForm form field as a parameter
- renders a form field which follows the GOV.UK Elements patterns, both visually
  and in markup terms

It then changes any page which uses either:
- the old, non-WTForms macro or
- the old, WTFforms `render_field` macro

…to use this new macro and removes both of the old ones.

It also adds the option to display hint text above the textbox.

											
										
										
											2016-01-11 13:15:10 +00:00
+								from app.main.forms import TemplateForm
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
-												Add a prototype email template

If the templates page contains text messages and emails then there’s two ways it
could be structured:
- into two sections, all text messages first, then all emails
- emails and text messages interleaved, sorted by date

I think the second one is better. Imagine a situation where you mostly do emails
but have a few text messages. You’d have to scroll past the text messages to get
to your emails. Every time.

I reckon that the most commonly accessed templates will be the most recent ones.

											
										
										
											2016-01-13 16:27:54 +00:00
+								from ._templates import templates
-												Add some SMS messages to the choose template page

											
										
										
											2016-01-13 16:21:29 +00:00
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
-												Add /services prefix to all service-related URLs

The URLs will be easier to parse if the parts are clearly labelled.

This is a precursor to making a blueprint for all service-related URLs.

											
										
										
											2016-01-13 13:14:23 +00:00
+								@main.route("/services/<int:service_id>/templates")
-												Add login_required for all endpoints where it makes sense.
https://www.pivotaltracker.com/story/show/111240834

											
										
										
											2016-01-11 16:03:41 +00:00
+								@login_required
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								def manage_templates(service_id):
 								    return render_template(
 								        'views/manage-templates.html',
-												Add some SMS messages to the choose template page

											
										
										
											2016-01-13 16:21:29 +00:00
+								        service_id=service_id,
-												Add a prototype email template

If the templates page contains text messages and emails then there’s two ways it
could be structured:
- into two sections, all text messages first, then all emails
- emails and text messages interleaved, sorted by date

I think the second one is better. Imagine a situation where you mostly do emails
but have a few text messages. You’d have to scroll past the text messages to get
to your emails. Every time.

I reckon that the most commonly accessed templates will be the most recent ones.

											
										
										
											2016-01-13 16:27:54 +00:00
+								        templates=templates,
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								    )
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
-												Add stubbed template_id to template pages

So that we can get a better sense of what the URLs look like.

Leaving unsigned for now because we don’t know if the ID will be a string or int
or…

											
										
										
											2016-01-13 13:24:06 +00:00
+								@main.route("/services/<int:service_id>/templates/add", methods=['GET', 'POST'])
-												Add login_required for all endpoints where it makes sense.
https://www.pivotaltracker.com/story/show/111240834

											
										
										
											2016-01-11 16:03:41 +00:00
+								@login_required
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								def add_template(service_id):
-												Add a WTForms-compatible textbox macro

This macro:
- accepts a WTForm form field as a parameter
- renders a form field which follows the GOV.UK Elements patterns, both visually
  and in markup terms

It then changes any page which uses either:
- the old, non-WTForms macro or
- the old, WTFforms `render_field` macro

…to use this new macro and removes both of the old ones.

It also adds the option to display hint text above the textbox.

											
										
										
											2016-01-11 13:15:10 +00:00
 								    form = TemplateForm()
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
+								    if request.method == 'GET':
 								        return render_template(
 								            'views/edit-template.html',
-												Add stubbed template_id to template pages

So that we can get a better sense of what the URLs look like.

Leaving unsigned for now because we don’t know if the ID will be a string or int
or…

											
										
										
											2016-01-13 13:24:06 +00:00
+								            h1='Add template',
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								            form=form,
 								            service_id=service_id
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
+								        )
 								    elif request.method == 'POST':
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								        return redirect(url_for('.manage_templates', service_id=service_id))
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
-												Add a prototype email template

If the templates page contains text messages and emails then there’s two ways it
could be structured:
- into two sections, all text messages first, then all emails
- emails and text messages interleaved, sorted by date

I think the second one is better. Imagine a situation where you mostly do emails
but have a few text messages. You’d have to scroll past the text messages to get
to your emails. Every time.

I reckon that the most commonly accessed templates will be the most recent ones.

											
										
										
											2016-01-13 16:27:54 +00:00
+								@main.route("/services/<int:service_id>/templates/<int:template_id>", methods=['GET', 'POST'])
-												Add login_required for all endpoints where it makes sense.
https://www.pivotaltracker.com/story/show/111240834

											
										
										
											2016-01-11 16:03:41 +00:00
+								@login_required
-												Add stubbed template_id to template pages

So that we can get a better sense of what the URLs look like.

Leaving unsigned for now because we don’t know if the ID will be a string or int
or…

											
										
										
											2016-01-13 13:24:06 +00:00
+								def edit_template(service_id, template_id):
-												Add a WTForms-compatible textbox macro

This macro:
- accepts a WTForm form field as a parameter
- renders a form field which follows the GOV.UK Elements patterns, both visually
  and in markup terms

It then changes any page which uses either:
- the old, non-WTForms macro or
- the old, WTFforms `render_field` macro

…to use this new macro and removes both of the old ones.

It also adds the option to display hint text above the textbox.

											
										
										
											2016-01-11 13:15:10 +00:00
 								    form = TemplateForm()
-												Add a prototype email template

If the templates page contains text messages and emails then there’s two ways it
could be structured:
- into two sections, all text messages first, then all emails
- emails and text messages interleaved, sorted by date

I think the second one is better. Imagine a situation where you mostly do emails
but have a few text messages. You’d have to scroll past the text messages to get
to your emails. Every time.

I reckon that the most commonly accessed templates will be the most recent ones.

											
										
										
											2016-01-13 16:27:54 +00:00
+								    form.template_name.data = templates[template_id - 1]['name']
 								    form.template_body.data = templates[template_id - 1]['body']
-												Add stubbed template_id to template pages

So that we can get a better sense of what the URLs look like.

Leaving unsigned for now because we don’t know if the ID will be a string or int
or…

											
										
										
											2016-01-13 13:24:06 +00:00
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
+								    if request.method == 'GET':
 								        return render_template(
 								            'views/edit-template.html',
-												Add stubbed template_id to template pages

So that we can get a better sense of what the URLs look like.

Leaving unsigned for now because we don’t know if the ID will be a string or int
or…

											
										
										
											2016-01-13 13:24:06 +00:00
+								            h1='Edit template',
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								            form=form,
-												Add link to delete a template

This is a link not a button because:
- it’s less prominent—delete is an infrequent action
- it’s a two-step process, and only the second part changes any data (so it has
  a button)

											
										
										
											2016-01-14 09:44:06 +00:00
+								            service_id=service_id,
 								            template_id=template_id
-												Add routing and pages for managing templates

So that users can see what it the flow is like to:
- add new templates
- edit existing templates

											
										
										
											2015-12-20 00:00:01 +00:00
+								        )
 								    elif request.method == 'POST':
-												Add mocked service ID to all service-specific pages

											
										
										
											2016-01-13 12:10:29 +00:00
+								        return redirect(url_for('.manage_templates', service_id=service_id))
-												Add link to delete a template

This is a link not a button because:
- it’s less prominent—delete is an infrequent action
- it’s a two-step process, and only the second part changes any data (so it has
  a button)

											
										
										
											2016-01-14 09:44:06 +00:00
 								@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))
 								        else:
 								            return redirect(url_for('.manage_templates', service_id=service_id))