Add endpoint to return all letter contact blocks

Added the GET '/<uuid:service_id>/letter-contact' endpoint for returning
all letter contact blocks for a service.

Updated the DAO for service letter contacts to return the default letter
contact first.

app/dao/service_letter_contact_dao.py

@@ -1,3 +1,5 @@
+from sqlalchemy import desc
+
 from app import db
 from app.dao.dao_utils import transactional
 from app.errors import InvalidRequest
@@ -10,7 +12,8 @@ def dao_get_letter_contacts_by_service_id(service_id):
     ).filter(
         ServiceLetterContact.service_id == service_id
     ).order_by(
-        ServiceLetterContact.created_at
+        desc(ServiceLetterContact.is_default),
+        desc(ServiceLetterContact.created_at)
     ).all()
 
     return letter_contacts

app/service/rest.py

@@ -53,7 +53,7 @@ from app.dao.service_email_reply_to_dao import (
     dao_get_reply_to_by_service_id,
     update_reply_to_email_address
 )
-from app.dao.service_letter_contact_dao import create_or_update_letter_contact
+from app.dao.service_letter_contact_dao import dao_get_letter_contacts_by_service_id, create_or_update_letter_contact
 from app.dao.provider_statistics_dao import get_fragment_count
 from app.dao.users_dao import get_user_by_id
 from app.errors import (
@@ -571,6 +571,12 @@ def update_service_reply_to_email_address(service_id, reply_to_email_id):
     return jsonify(data=new_reply_to.serialize()), 200
 
 
+@service_blueprint.route('/<uuid:service_id>/letter-contact', methods=["GET"])
+def get_letter_contacts(service_id):
+    result = dao_get_letter_contacts_by_service_id(service_id)
+    return jsonify([i.serialize() for i in result]), 200
+
+
 @service_blueprint.route('/unique', methods=["GET"])
 def is_service_name_unique():
     name, email_from = check_request_args(request)

tests/app/dao/test_service_letter_contact_dao.py

@@ -14,13 +14,15 @@ from tests.app.db import create_letter_contact, create_service
 def test_dao_get_letter_contacts_by_service_id(notify_db_session):
     service = create_service()
     default_letter_contact = create_letter_contact(service=service, contact_block='Edinburgh, ED1 1AA')
-    another_letter_contact = create_letter_contact(service=service, contact_block='Cardiff, CA1 2DB')
+    second_letter_contact = create_letter_contact(service=service, contact_block='Cardiff, CA1 2DB', is_default=False)
+    third_letter_contact = create_letter_contact(service=service, contact_block='London, E1 8QS', is_default=False)
 
     results = dao_get_letter_contacts_by_service_id(service_id=service.id)
 
-    assert len(results) == 2
+    assert len(results) == 3
-    assert default_letter_contact in results
+    assert default_letter_contact == results[0]
-    assert another_letter_contact in results
+    assert third_letter_contact == results[1]
+    assert second_letter_contact == results[2]
 
 
 def test_create_or_update_letter_contact_creates_new_entry(notify_db_session):
@@ -105,11 +107,11 @@ def test_add_another_letter_contact_as_default_overrides_existing(notify_db_sess
 
     assert len(results) == 2
 
-    assert results[0].contact_block == 'Edinburgh, ED1 1AA'
+    assert results[0].contact_block == 'Swansea, SN1 3CC'
-    assert not results[0].is_default
+    assert results[0].is_default
 
-    assert results[1].contact_block == 'Swansea, SN1 3CC'
+    assert results[1].contact_block == 'Edinburgh, ED1 1AA'
-    assert results[1].is_default
+    assert not results[1].is_default
 
 
 def test_add_letter_contact_does_not_override_default(notify_db_session):
@@ -182,11 +184,11 @@ def test_update_letter_contact_as_default_overides_existing_default(notify_db_se
     results = dao_get_letter_contacts_by_service_id(service_id=service.id)
     assert len(results) == 2
 
-    assert results[0].contact_block == 'Aberdeen, AB12 23X'
+    assert results[0].contact_block == 'Warwick, W14 TSR'
-    assert not results[0].is_default
+    assert results[0].is_default
 
-    assert results[1].contact_block == 'Warwick, W14 TSR'
+    assert results[1].contact_block == 'Aberdeen, AB12 23X'
-    assert results[1].is_default
+    assert not results[1].is_default
 
 
 def test_update_letter_contact_unset_default_for_only_letter_contact_raises_exception(notify_db_session):

tests/app/service/test_rest.py

@@ -25,7 +25,13 @@ from tests.app.conftest import (
     sample_notification_history as create_notification_history,
     sample_notification_with_job
 )
-from tests.app.db import create_template, create_service_inbound_api, create_notification, create_reply_to_email
+from tests.app.db import (
+    create_template,
+    create_service_inbound_api,
+    create_notification,
+    create_reply_to_email,
+    create_letter_contact,
+)
 from tests.app.db import create_user
 
 
@@ -2320,3 +2326,54 @@ def test_update_service_letter_contact_upserts_letter_contact(admin_request, sam
     assert letter_contacts[0].contact_block == 'Aberdeen, AB23 1XH'
     assert letter_contacts[0].is_default
     assert response['data']['letter_contact_block'] == 'Aberdeen, AB23 1XH'
+
+
+def test_get_letter_contacts_when_there_are_no_letter_contacts(client, sample_service):
+    response = client.get('/service/{}/letter-contact'.format(sample_service.id),
+                          headers=[create_authorization_header()])
+
+    assert json.loads(response.get_data(as_text=True)) == []
+    assert response.status_code == 200
+
+
+def test_get_letter_contacts_with_one_letter_contact(client, notify_db, notify_db_session):
+    service = create_service(notify_db=notify_db, notify_db_session=notify_db_session)
+    letter_contact = create_letter_contact(service, 'Aberdeen, AB23 1XH')
+
+    response = client.get('/service/{}/letter-contact'.format(service.id),
+                          headers=[create_authorization_header()])
+    json_response = json.loads(response.get_data(as_text=True))
+
+    assert len(json_response) == 1
+    assert json_response[0]['contact_block'] == 'Aberdeen, AB23 1XH'
+    assert json_response[0]['is_default']
+    assert json_response[0]['created_at']
+    assert not json_response[0]['updated_at']
+    assert response.status_code == 200
+
+
+def test_get_letter_contacts_with_multiple_letter_contacts(client, notify_db, notify_db_session):
+    service = create_service(notify_db=notify_db, notify_db_session=notify_db_session)
+    letter_contact_a = create_letter_contact(service, 'Aberdeen, AB23 1XH')
+    letter_contact_b = create_letter_contact(service, 'London, E1 8QS', False)
+
+    response = client.get('/service/{}/letter-contact'.format(service.id),
+                          headers=[create_authorization_header()])
+    json_response = json.loads(response.get_data(as_text=True))
+
+    assert len(json_response) == 2
+    assert response.status_code == 200
+
+    assert json_response[0]['id'] == str(letter_contact_a.id)
+    assert json_response[0]['service_id'] == str(letter_contact_a.service_id)
+    assert json_response[0]['contact_block'] == 'Aberdeen, AB23 1XH'
+    assert json_response[0]['is_default']
+    assert json_response[0]['created_at']
+    assert not json_response[0]['updated_at']
+
+    assert json_response[1]['id'] == str(letter_contact_b.id)
+    assert json_response[1]['service_id'] == str(letter_contact_b.service_id)
+    assert json_response[1]['contact_block'] == 'London, E1 8QS'
+    assert not json_response[1]['is_default']
+    assert json_response[1]['created_at']
+    assert not json_response[1]['updated_at']