Extract template / csv utility code into modules

This follows a similar approach to the previous commits, noting that one module depends on the other, so we have to extract both together.
2026-07-28 03:39:29 -04:00 · 2021-06-09 15:15:35 +01:00
parent 2a4aa8b4e1
commit 0326005aeb
16 changed files with 451 additions and 452 deletions
--- a/app/utils/csv.py
+++ b/app/utils/csv.py
@@ -0,0 +1,109 @@
+from notifications_utils.recipients import RecipientCSV
+
+from app.models.spreadsheet import Spreadsheet
+from app.utils.templates import get_sample_template
+
+
+def get_errors_for_csv(recipients, template_type):
+
+    errors = []
+
+    if any(recipients.rows_with_bad_recipients):
+        number_of_bad_recipients = len(list(recipients.rows_with_bad_recipients))
+        if 'sms' == template_type:
+            if 1 == number_of_bad_recipients:
+                errors.append("fix 1 phone number")
+            else:
+                errors.append("fix {} phone numbers".format(number_of_bad_recipients))
+        elif 'email' == template_type:
+            if 1 == number_of_bad_recipients:
+                errors.append("fix 1 email address")
+            else:
+                errors.append("fix {} email addresses".format(number_of_bad_recipients))
+        elif 'letter' == template_type:
+            if 1 == number_of_bad_recipients:
+                errors.append("fix 1 address")
+            else:
+                errors.append("fix {} addresses".format(number_of_bad_recipients))
+
+    if any(recipients.rows_with_missing_data):
+        number_of_rows_with_missing_data = len(list(recipients.rows_with_missing_data))
+        if 1 == number_of_rows_with_missing_data:
+            errors.append("enter missing data in 1 row")
+        else:
+            errors.append("enter missing data in {} rows".format(number_of_rows_with_missing_data))
+
+    if any(recipients.rows_with_message_too_long):
+        number_of_rows_with_message_too_long = len(list(recipients.rows_with_message_too_long))
+        if 1 == number_of_rows_with_message_too_long:
+            errors.append("shorten the message in 1 row")
+        else:
+            errors.append("shorten the messages in {} rows".format(number_of_rows_with_message_too_long))
+
+    if any(recipients.rows_with_empty_message):
+        number_of_rows_with_empty_message = len(list(recipients.rows_with_empty_message))
+        if 1 == number_of_rows_with_empty_message:
+            errors.append("check you have content for the empty message in 1 row")
+        else:
+            errors.append("check you have content for the empty messages in {} rows".format(
+                number_of_rows_with_empty_message
+            ))
+
+    return errors
+
+
+def generate_notifications_csv(**kwargs):
+    from app import notification_api_client
+    from app.s3_client.s3_csv_client import s3download
+    if 'page' not in kwargs:
+        kwargs['page'] = 1
+
+    if kwargs.get('job_id'):
+        original_file_contents = s3download(kwargs['service_id'], kwargs['job_id'])
+        original_upload = RecipientCSV(
+            original_file_contents,
+            template=get_sample_template(kwargs['template_type']),
+        )
+        original_column_headers = original_upload.column_headers
+        fieldnames = ['Row number'] + original_column_headers + ['Template', 'Type', 'Job', 'Status', 'Time']
+    else:
+        fieldnames = ['Recipient', 'Reference', 'Template', 'Type', 'Sent by', 'Sent by email', 'Job', 'Status', 'Time']
+
+    yield ','.join(fieldnames) + '\n'
+
+    while kwargs['page']:
+        notifications_resp = notification_api_client.get_notifications_for_service(**kwargs)
+        for notification in notifications_resp['notifications']:
+            if kwargs.get('job_id'):
+                values = [
+                    notification['row_number'],
+                ] + [
+                    original_upload[notification['row_number'] - 1].get(header).data
+                    for header in original_column_headers
+                ] + [
+                    notification['template_name'],
+                    notification['template_type'],
+                    notification['job_name'],
+                    notification['status'],
+                    notification['created_at'],
+                ]
+            else:
+                values = [
+                    # the recipient for precompiled letters is the full address block
+                    notification['recipient'].splitlines()[0].lstrip().rstrip(' ,'),
+                    notification['client_reference'],
+                    notification['template_name'],
+                    notification['template_type'],
+                    notification['created_by_name'] or '',
+                    notification['created_by_email_address'] or '',
+                    notification['job_name'] or '',
+                    notification['status'],
+                    notification['created_at']
+                ]
+            yield Spreadsheet.from_rows([map(str, values)]).as_csv_data
+
+        if notifications_resp['links'].get('next'):
+            kwargs['page'] += 1
+        else:
+            return
+    raise Exception("Should never reach here")