Create a new URL converter for daily limit types.

Author: CrystalPea

app/__init__.py

@@ -140,6 +140,7 @@
 from app.url_converters import (
     AgreementTypeConverter,
     BrandingTypeConverter,
+    DailyLimitTypeConverter,
     LetterFileExtensionConverter,
     SimpleDateTypeConverter,
     TemplateTypeConverter,
@@ -271,6 +272,7 @@ def inject_global_template_variables():
     application.url_map.converters["uuid"].to_python = lambda self, value: value.lower()
     application.url_map.converters["agreement_type"] = AgreementTypeConverter
     application.url_map.converters["template_type"] = TemplateTypeConverter
+    application.url_map.converters["daily_limit_type"] = DailyLimitTypeConverter
     application.url_map.converters["branding_type"] = BrandingTypeConverter
     application.url_map.converters["ticket_type"] = TicketTypeConverter
     application.url_map.converters["letter_file_extension"] = LetterFileExtensionConverter

app/main/views/service_settings/index.py

@@ -611,27 +611,27 @@ def set_per_day_international_sms_message_limit(service_id):
         "views/service-settings/set-message-limit-for-international-sms.html",
         form=form,
         error_summary_enabled=True,
-        partials=get_daily_limit_partials(notification_type="international_sms"),
+        partials=get_daily_limit_partials(daily_limit_type="international_sms"),
         updates_url=url_for(
             "json_updates.view_remaining_limit",
             service_id=service_id,
-            notification_type="international_sms",
+            daily_limit_type="international_sms",
         ),
     )
 
 
 @json_updates.route(
-    "/services/<uuid:service_id>/service-settings/<template_type:notification_type>/remaining-today.json"
+    "/services/<uuid:service_id>/service-settings/<daily_limit_type:daily_limit_type>/remaining-today.json"
 )
 @user_has_permissions("manage_service")
-def view_remaining_limit(service_id, notification_type):
-    return jsonify(**get_daily_limit_partials(notification_type=notification_type))
+def view_remaining_limit(service_id, daily_limit_type):
+    return jsonify(**get_daily_limit_partials(daily_limit_type=daily_limit_type))
 
 
-def get_daily_limit_partials(notification_type):
+def get_daily_limit_partials(daily_limit_type):
     return {
         "remaining_limit": render_template(
-            "partials/daily-limits/remaining-limit.html", notification_type=notification_type
+            "partials/daily-limits/remaining-limit.html", daily_limit_type=daily_limit_type
         ),
     }
 

app/templates/partials/daily-limits/remaining-limit.html

@@ -1,12 +1,12 @@
 {% from "govuk_frontend_jinja/components/inset-text/macro.html" import govukInsetText %}
 
-{% set sent_today = current_service.sent_today(notification_type) %}
-{% set remaining_limit = current_service.remaining_messages(notification_type) %}
+{% set sent_today = current_service.sent_today(daily_limit_type) %}
+{% set remaining_limit = current_service.remaining_messages(daily_limit_type) %}
 
 <div class="ajax-block-container">
     {{ govukInsetText({
         "text": "You have sent {} today ({} remaining).".format(
-            sent_today|message_count(notification_type),
+            sent_today|message_count(daily_limit_type),
             remaining_limit|format_thousands
         ),
         "classes": "govuk-!-margin-top-0"

app/url_converters.py

@@ -13,13 +13,17 @@ class AgreementTypeConverter(BaseConverter):
 
 
 class TemplateTypeConverter(BaseConverter):
-    regex = f"(?:{'|'.join(Service.TEMPLATE_TYPES)}|international_sms)"
+    regex = f"(?:{'|'.join(Service.TEMPLATE_TYPES)})"
 
 
 class BrandingTypeConverter(BaseConverter):
     regex = "(?:email|letter)"
 
 
+class DailyLimitTypeConverter(BaseConverter):
+    regex = f"(?:{'|'.join(Service.TEMPLATE_TYPES)}|international_sms)"
+
+
 class TicketTypeConverter(BaseConverter):
     regex = f"(?:{PROBLEM_TICKET_TYPE}|{QUESTION_TICKET_TYPE}|{GENERAL_TICKET_TYPE})"
 

tests/app/main/test_init.py

@@ -11,7 +11,7 @@ def test_all_routes_return_401_for_unauthorised(self, notify_admin, client_reque
             "template_type": "email",
             "message_type": "email",
             "job_id": fake_uuid,
-            "notification_type": "email",
+            "daily_limit_type": "email",
         }
         bad_views = []
         client_request.logout()

tests/app/main/test_permissions.py

@@ -332,6 +332,7 @@ def test_routes_have_permissions_decorators():
 def test_routes_require_types(client_request):
     partial_param_name_to_type = {
         "_id": "uuid",
+        "daily_limit_type": "daily_limit_type",
         "template_type": "template_type",
         "notification_type": "template_type",
         "branding_type": "branding_type",

tests/route-list.json

@@ -218,7 +218,7 @@
     "/services/<uuid:service_id>/service-settings",
     "/services/<uuid:service_id>/service-settings/<branding_type:branding_type>-branding/confirm-change",
     "/services/<uuid:service_id>/service-settings/<branding_type:branding_type>-branding/nhs",
-    "/services/<uuid:service_id>/service-settings/<template_type:notification_type>/remaining-today.json",
+    "/services/<uuid:service_id>/service-settings/<daily_limit_type:daily_limit_type>/remaining-today.json",
     "/services/<uuid:service_id>/service-settings/archive",
     "/services/<uuid:service_id>/service-settings/email-branding",
     "/services/<uuid:service_id>/service-settings/email-branding/add-banner",