app/url_converters.py

from werkzeug.routing import BaseConverter

from app.models.feedback import (
    GENERAL_TICKET_TYPE,
    PROBLEM_TICKET_TYPE,
    QUESTION_TICKET_TYPE,
)


class TemplateTypeConverter(BaseConverter):

    regex = '(?:email|sms|letter)'


class TicketTypeConverter(BaseConverter):

    regex = f'(?:{PROBLEM_TICKET_TYPE}|{QUESTION_TICKET_TYPE}|{GENERAL_TICKET_TYPE})'


class LetterFileExtensionConverter(BaseConverter):

    regex = '(?:pdf|png)'


class SimpleDateTypeConverter(BaseConverter):
    regex = r'([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))'
Add URL converters for template and file types Sometimes we manually check that a URL parameter is in a required set. Sometimes we don’t bother. This commit adds a URL converter to do this so that: - we don’t have to re-write the same code every time - it’s easier to apply this check to other endpoints This means endpoints that previously allowed a `template_type` or `message_type` of `None` now 404. So I’ve had to add new routes for with URLs that don’t include such parameters. So this…: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/None.csv ``` …becomes: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications.csv ``` This matches what we do for the HTML-responding equivalent (see https://github.com/alphagov/notifications-admin/blob/265931d21746918c4ddfc19c4ad3f8cb5683c1bf/app/main/views/jobs.py#L215-L216) 2019-11-04 11:20:08 +00:00			`from werkzeug.routing import BaseConverter`

Add a ‘general’ ticket type This is for tickets coming from non-logged-in users. It’s effectively the same as reporting a problem, but doesn’t have the banner about the status page (because we can’t tell if they’re actually reporting a problem now we’re not asking). It also gives a more generic page title. 2020-03-24 15:45:13 +00:00			`from app.models.feedback import (`
			`GENERAL_TICKET_TYPE,`
			`PROBLEM_TICKET_TYPE,`
			`QUESTION_TICKET_TYPE,`
			`)`
Refactor so constants are used everywhere 2020-03-24 15:36:39 +00:00
Add URL converters for template and file types Sometimes we manually check that a URL parameter is in a required set. Sometimes we don’t bother. This commit adds a URL converter to do this so that: - we don’t have to re-write the same code every time - it’s easier to apply this check to other endpoints This means endpoints that previously allowed a `template_type` or `message_type` of `None` now 404. So I’ve had to add new routes for with URLs that don’t include such parameters. So this…: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/None.csv ``` …becomes: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications.csv ``` This matches what we do for the HTML-responding equivalent (see https://github.com/alphagov/notifications-admin/blob/265931d21746918c4ddfc19c4ad3f8cb5683c1bf/app/main/views/jobs.py#L215-L216) 2019-11-04 11:20:08 +00:00
			`class TemplateTypeConverter(BaseConverter):`

			`regex = '(?:email\|sms\|letter)'`


Use the same form for problems and questions 2020-03-24 15:13:53 +00:00			`class TicketTypeConverter(BaseConverter):`

Add a ‘general’ ticket type This is for tickets coming from non-logged-in users. It’s effectively the same as reporting a problem, but doesn’t have the banner about the status page (because we can’t tell if they’re actually reporting a problem now we’re not asking). It also gives a more generic page title. 2020-03-24 15:45:13 +00:00			`regex = f'(?:{PROBLEM_TICKET_TYPE}\|{QUESTION_TICKET_TYPE}\|{GENERAL_TICKET_TYPE})'`
Use the same form for problems and questions 2020-03-24 15:13:53 +00:00

Add URL converters for template and file types Sometimes we manually check that a URL parameter is in a required set. Sometimes we don’t bother. This commit adds a URL converter to do this so that: - we don’t have to re-write the same code every time - it’s easier to apply this check to other endpoints This means endpoints that previously allowed a `template_type` or `message_type` of `None` now 404. So I’ve had to add new routes for with URLs that don’t include such parameters. So this…: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/None.csv ``` …becomes: ``` /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications/sms.csv /services/128b91b6-2996-4107-bb65-51b7c24a728d/notifications.csv ``` This matches what we do for the HTML-responding equivalent (see https://github.com/alphagov/notifications-admin/blob/265931d21746918c4ddfc19c4ad3f8cb5683c1bf/app/main/views/jobs.py#L215-L216) 2019-11-04 11:20:08 +00:00			`class LetterFileExtensionConverter(BaseConverter):`

			`regex = '(?:pdf\|png)'`
Add a url_converter to check the date format. 2019-12-30 16:53:32 +00:00

			`class SimpleDateTypeConverter(BaseConverter):`
			`regex = r'([12]\d{3}-(0[1-9]\|1[0-2])-(0[1-9]\|[12]\d\|3[01]))'`