From 5a2f2a9ec295053306477ec04ed6377118e506ea Mon Sep 17 00:00:00 2001 From: Chris Hill-Scott Date: Mon, 22 Jun 2020 10:20:53 +0100 Subject: [PATCH] Rename JSONModel to SerialisedModel 2/2 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This class doesn’t actually wrap JSON, it wraps serialised data. So this name feels better. --- app/notifications/validators.py | 4 ++-- app/serialised_models.py | 4 ++-- .../notifications/test_process_letter_notifications.py | 8 ++++---- tests/app/notifications/test_process_notification.py | 10 +++++----- tests/app/notifications/test_validators.py | 6 +++--- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/app/notifications/validators.py b/app/notifications/validators.py index 8bc19d2d9..7eacd8ede 100644 --- a/app/notifications/validators.py +++ b/app/notifications/validators.py @@ -21,7 +21,7 @@ from app.notifications.process_notifications import create_content_for_notificat from app.utils import get_public_notify_type_text from app.dao.service_email_reply_to_dao import dao_get_reply_to_by_id from app.dao.service_letter_contact_dao import dao_get_letter_contact_by_id -from app.serialised_models import TemplateJSONModel +from app.serialised_models import SerialisedTemplate from gds_metrics.metrics import Histogram @@ -159,7 +159,7 @@ def check_notification_content_is_not_empty(template_with_content): def validate_template(template_id, personalisation, service, notification_type): try: - template = TemplateJSONModel.from_id_and_service_id(template_id, service.id) + template = SerialisedTemplate.from_id_and_service_id(template_id, service.id) except NoResultFound: message = 'Template not found' raise BadRequestError(message=message, diff --git a/app/serialised_models.py b/app/serialised_models.py index 27cc44cee..d3b1cd5ca 100644 --- a/app/serialised_models.py +++ b/app/serialised_models.py @@ -3,7 +3,7 @@ from abc import ABC, abstractmethod from app.dao import templates_dao -class JSONModel(ABC): +class SerialisedModel(ABC): @property @abstractmethod @@ -18,7 +18,7 @@ class JSONModel(ABC): return super().__dir__() + list(sorted(self.ALLOWED_PROPERTIES)) -class TemplateJSONModel(JSONModel): +class SerialisedTemplate(SerialisedModel): ALLOWED_PROPERTIES = { 'archived', 'content', diff --git a/tests/app/notifications/test_process_letter_notifications.py b/tests/app/notifications/test_process_letter_notifications.py index 5f266b285..7744aa142 100644 --- a/tests/app/notifications/test_process_letter_notifications.py +++ b/tests/app/notifications/test_process_letter_notifications.py @@ -2,7 +2,7 @@ from app.models import LETTER_TYPE from app.models import Notification from app.models import NOTIFICATION_CREATED from app.notifications.process_letter_notifications import create_letter_notification -from app.json_models import TemplateJSONModel +from app.serialised_models import SerialisedTemplate def test_create_letter_notification_creates_notification(sample_letter_template, sample_api_key): @@ -14,7 +14,7 @@ def test_create_letter_notification_creates_notification(sample_letter_template, } } - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_letter_template.id, sample_letter_template.service_id ) @@ -49,7 +49,7 @@ def test_create_letter_notification_sets_reference(sample_letter_template, sampl 'reference': 'foo' } - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_letter_template.id, sample_letter_template.service_id ) @@ -73,7 +73,7 @@ def test_create_letter_notification_sets_billable_units(sample_letter_template, }, } - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_letter_template.id, sample_letter_template.service_id ) diff --git a/tests/app/notifications/test_process_notification.py b/tests/app/notifications/test_process_notification.py index 49c114c74..94521959a 100644 --- a/tests/app/notifications/test_process_notification.py +++ b/tests/app/notifications/test_process_notification.py @@ -20,14 +20,14 @@ from app.notifications.process_notifications import ( send_notification_to_queue, simulated_recipient ) -from app.serialised_models import TemplateJSONModel +from app.serialised_models import SerialisedTemplate from notifications_utils.recipients import validate_and_format_phone_number, validate_and_format_email_address from app.v2.errors import BadRequestError from tests.app.db import create_service, create_template, create_api_key def test_create_content_for_notification_passes(sample_email_template): - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_email_template.id, sample_email_template.service_id ) content = create_content_for_notification(template, None) @@ -35,7 +35,7 @@ def test_create_content_for_notification_passes(sample_email_template): def test_create_content_for_notification_with_placeholders_passes(sample_template_with_placeholders): - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_template_with_placeholders.id, sample_template_with_placeholders.service_id ) content = create_content_for_notification(template, {'name': 'Bobby'}) @@ -44,7 +44,7 @@ def test_create_content_for_notification_with_placeholders_passes(sample_templat def test_create_content_for_notification_fails_with_missing_personalisation(sample_template_with_placeholders): - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_template_with_placeholders.id, sample_template_with_placeholders.service_id ) with pytest.raises(BadRequestError): @@ -52,7 +52,7 @@ def test_create_content_for_notification_fails_with_missing_personalisation(samp def test_create_content_for_notification_allows_additional_personalisation(sample_template_with_placeholders): - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( sample_template_with_placeholders.id, sample_template_with_placeholders.service_id ) create_content_for_notification(template, {'name': 'Bobby', 'Additional placeholder': 'Data'}) diff --git a/tests/app/notifications/test_validators.py b/tests/app/notifications/test_validators.py index e2e200f87..1c4db4190 100644 --- a/tests/app/notifications/test_validators.py +++ b/tests/app/notifications/test_validators.py @@ -23,7 +23,7 @@ from app.notifications.validators import ( validate_and_format_recipient, validate_template, ) -from app.serialised_models import TemplateJSONModel +from app.serialised_models import SerialisedTemplate from app.utils import get_template_instance from app.v2.errors import ( @@ -315,7 +315,7 @@ def test_check_content_char_count_passes_for_long_email_or_letter(sample_service def test_check_notification_content_is_not_empty_passes(notify_api, mocker, sample_service): template_id = create_template(sample_service, content="Content is not empty").id - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( template_id=template_id, service_id=sample_service.id ) @@ -331,7 +331,7 @@ def test_check_notification_content_is_not_empty_fails( notify_api, mocker, sample_service, template_content, notification_values ): template_id = create_template(sample_service, content=template_content).id - template = TemplateJSONModel.from_id_and_service_id( + template = SerialisedTemplate.from_id_and_service_id( template_id=template_id, service_id=sample_service.id )