Merge pull request #1294 from alphagov/add-new-letter-block-endpoints

Add new letter contact block endpoints (multiple addresses)

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,12 +12,23 @@ 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
 
 
+def dao_get_letter_contact_by_id(service_id, letter_contact_id):
+    letter_contact = db.session.query(
+        ServiceLetterContact
+    ).filter(
+        ServiceLetterContact.service_id == service_id,
+        ServiceLetterContact.id == letter_contact_id
+    ).one()
+    return letter_contact
+
+
 def create_or_update_letter_contact(service_id, contact_block):
     letter_contacts = dao_get_letter_contacts_by_service_id(service_id)
     if len(letter_contacts) == 0:

app/service/rest.py

@@ -53,7 +53,13 @@ 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,
+    dao_get_letter_contact_by_id,
+    add_letter_contact_for_service,
+    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 (
@@ -64,7 +70,10 @@ from app.models import Service, ServiceInboundApi
 from app.schema_validation import validate
 from app.service import statistics
 from app.service.service_inbound_api_schema import service_inbound_api, update_service_inbound_api_schema
-from app.service.service_senders_schema import add_service_email_reply_to_request
+from app.service.service_senders_schema import (
+    add_service_email_reply_to_request,
+    add_service_letter_contact_block_request,
+)
 from app.service.utils import get_whitelist_objects
 from app.service.sender import send_notification_to_service_users
 from app.service.send_notification import send_one_off_notification
@@ -571,6 +580,41 @@ 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('/<uuid:service_id>/letter-contact/<uuid:letter_contact_id>', methods=["GET"])
+def get_letter_contact_by_id(service_id, letter_contact_id):
+    result = dao_get_letter_contact_by_id(service_id=service_id, letter_contact_id=letter_contact_id)
+    return jsonify(result.serialize()), 200
+
+
+@service_blueprint.route('/<uuid:service_id>/letter-contact', methods=['POST'])
+def add_service_letter_contact(service_id):
+    # validate the service exists, throws ResultNotFound exception.
+    dao_fetch_service_by_id(service_id)
+    form = validate(request.get_json(), add_service_letter_contact_block_request)
+    new_letter_contact = add_letter_contact_for_service(service_id=service_id,
+                                                        contact_block=form['contact_block'],
+                                                        is_default=form.get('is_default', True))
+    return jsonify(data=new_letter_contact.serialize()), 201
+
+
+@service_blueprint.route('/<uuid:service_id>/letter-contact/<uuid:letter_contact_id>', methods=['POST'])
+def update_service_letter_contact(service_id, letter_contact_id):
+    # validate the service exists, throws ResultNotFound exception.
+    dao_fetch_service_by_id(service_id)
+    form = validate(request.get_json(), add_service_letter_contact_block_request)
+    new_reply_to = update_letter_contact(service_id=service_id,
+                                         letter_contact_id=letter_contact_id,
+                                         contact_block=form['contact_block'],
+                                         is_default=form.get('is_default', True))
+    return jsonify(data=new_reply_to.serialize()), 200
+
+
 @service_blueprint.route('/unique', methods=["GET"])
 def is_service_name_unique():
     name, email_from = check_request_args(request)

app/service/service_senders_schema.py

@@ -9,3 +9,16 @@ add_service_email_reply_to_request = {
     },
     "required": ["email_address", "is_default"]
 }
+
+
+add_service_letter_contact_block_request = {
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "POST service letter contact block",
+    "type": "object",
+    "title": "Add new letter contact block for service",
+    "properties": {
+        "contact_block": {"type": "string"},
+        "is_default": {"type": "boolean"}
+    },
+    "required": ["contact_block", "is_default"]
+}