Merge pull request #1325 from alphagov/add-update-multiple-sms-sender

Add update multiple SMS senders for a service

app/dao/service_sms_sender_dao.py

@@ -1,3 +1,5 @@
+from sqlalchemy import desc
+
 from app import db
 from app.dao.dao_utils import transactional
 from app.models import ServiceSmsSender
@@ -32,3 +34,78 @@ def insert_service_sms_sender(service, sms_sender):
                                       is_default=True
                                       )
     db.session.add(new_sms_sender)
+
+
+def dao_get_service_sms_senders_by_id(service_id, service_sms_sender_id):
+    return ServiceSmsSender.query.filter_by(
+        id=service_sms_sender_id,
+        service_id=service_id
+    ).one()
+
+
+def dao_get_sms_senders_by_service_id(service_id):
+    return ServiceSmsSender.query.filter_by(service_id=service_id).order_by(desc(ServiceSmsSender.is_default)).all()
+
+
+@transactional
+def dao_add_sms_sender_for_service(service_id, sms_sender, is_default, inbound_number_id=None):
+    old_default = _get_existing_default(service_id=service_id)
+    if is_default:
+        _reset_old_default_to_false(old_default)
+    else:
+        _raise_when_no_default(old_default)
+
+    new_sms_sender = ServiceSmsSender(
+        service_id=service_id,
+        sms_sender=sms_sender,
+        is_default=is_default,
+        inbound_number_id=inbound_number_id
+    )
+
+    db.session.add(new_sms_sender)
+    return new_sms_sender
+
+
+@transactional
+def dao_update_service_sms_sender(service_id, service_sms_sender_id, is_default, sms_sender=None):
+    old_default = _get_existing_default(service_id)
+    if is_default:
+        _reset_old_default_to_false(old_default)
+    else:
+        if old_default.id == service_sms_sender_id:
+            raise Exception("You must have at least one SMS sender as the default")
+
+    sms_sender_to_update = ServiceSmsSender.query.get(service_sms_sender_id)
+    sms_sender_to_update.is_default = is_default
+    if not sms_sender_to_update.inbound_number_id and sms_sender:
+        sms_sender_to_update.sms_sender = sms_sender
+    db.session.add(sms_sender_to_update)
+    return sms_sender_to_update
+
+
+def _get_existing_default(service_id):
+    sms_senders = dao_get_sms_senders_by_service_id(service_id=service_id)
+    if sms_senders:
+        old_default = [x for x in sms_senders if x.is_default]
+        if len(old_default) == 1:
+            return old_default[0]
+        else:
+            raise Exception(
+                "There should only be one default sms sender for each service. Service {} has {}".format(
+                    service_id,
+                    len(old_default)
+                )
+            )
+    return None
+
+
+def _reset_old_default_to_false(old_default):
+    if old_default:
+        old_default.is_default = False
+        db.session.add(old_default)
+
+
+def _raise_when_no_default(old_default):
+    # check that the update is not updating the only default to false
+    if not old_default:
+        raise Exception("You must have at least one SMS sender as the default.", 400)

app/models.py

@@ -326,7 +326,7 @@ class ServiceSmsSender(db.Model):
 
     id = db.Column(UUID(as_uuid=True), primary_key=True, default=uuid.uuid4)
     sms_sender = db.Column(db.String(11), nullable=False)
-    service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), unique=True, index=True, nullable=False)
+    service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), index=True, nullable=False)
     service = db.relationship(Service, backref=db.backref("service_sms_senders", uselist=True))
     is_default = db.Column(db.Boolean, nullable=False, default=True)
     inbound_number_id = db.Column(UUID(as_uuid=True), db.ForeignKey('inbound_numbers.id'),
@@ -335,6 +335,17 @@ class ServiceSmsSender(db.Model):
     created_at = db.Column(db.DateTime, default=datetime.datetime.utcnow, nullable=False)
     updated_at = db.Column(db.DateTime, nullable=True, onupdate=datetime.datetime.utcnow)
 
+    def serialize(self):
+        return {
+            "id": str(self.id),
+            "sms_sender": self.sms_sender,
+            "service_id": str(self.service_id),
+            "is_default": self.is_default,
+            "inbound_number_id": str(self.inbound_number_id) if self.inbound_number_id else None,
+            "created_at": self.created_at.strftime(DATETIME_FORMAT),
+            "updated_at": self.updated_at.strftime(DATETIME_FORMAT) if self.updated_at else None,
+        }
+
 
 class ServicePermission(db.Model):
     __tablename__ = "service_permissions"

app/service/rest.py

@@ -17,12 +17,19 @@ from app.dao.api_key_dao import (
     get_model_api_keys,
     get_unsigned_secret,
     expire_api_key)
+from app.dao.inbound_numbers_dao import dao_allocate_number_for_service
 from app.dao.service_inbound_api_dao import (
     save_service_inbound_api,
     reset_service_inbound_api,
     get_service_inbound_api
 )
-from app.dao.service_sms_sender_dao import insert_or_update_service_sms_sender
+from app.dao.service_sms_sender_dao import (
+    insert_or_update_service_sms_sender,
+    dao_add_sms_sender_for_service,
+    dao_update_service_sms_sender,
+    dao_get_service_sms_senders_by_id,
+    dao_get_sms_senders_by_service_id
+)
 from app.dao.services_dao import (
     dao_fetch_service_by_id,
     dao_fetch_all_services,
@@ -69,11 +76,14 @@ from app.errors import (
 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_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,
     add_service_letter_contact_block_request,
-)
+    add_service_sms_sender_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
@@ -619,6 +629,55 @@ def update_service_letter_contact(service_id, letter_contact_id):
     return jsonify(data=new_reply_to.serialize()), 200
 
 
+@service_blueprint.route('/<uuid:service_id>/sms-sender', methods=['POST'])
+def add_service_sms_sender(service_id):
+    dao_fetch_service_by_id(service_id)
+    form = validate(request.get_json(), add_service_sms_sender_request)
+    inbound_number_id = form.get('inbound_number_id', None)
+    sms_sender = form.get('sms_sender')
+    if inbound_number_id:
+        updated_number = dao_allocate_number_for_service(service_id=service_id, inbound_number_id=inbound_number_id)
+        # the sms_sender in the form is the inbound_number_id from client, use number from table.
+        sms_sender = updated_number.number
+    new_sms_sender = dao_add_sms_sender_for_service(service_id=service_id,
+                                                    sms_sender=sms_sender,
+                                                    is_default=form['is_default'],
+                                                    inbound_number_id=inbound_number_id
+                                                    )
+    return jsonify(new_sms_sender.serialize()), 201
+
+
+@service_blueprint.route('/<uuid:service_id>/sms-sender/<uuid:sms_sender_id>', methods=['POST'])
+def update_service_sms_sender(service_id, sms_sender_id):
+    form = validate(request.get_json(), add_service_sms_sender_request)
+
+    sms_sender_to_update = dao_get_service_sms_senders_by_id(service_id=service_id,
+                                                             service_sms_sender_id=sms_sender_id)
+    if sms_sender_to_update.inbound_number_id and form['sms_sender'] != sms_sender_to_update.sms_sender:
+        raise InvalidRequest("You can not change the inbound number for service {}".format(service_id),
+                             status_code=400)
+
+    new_sms_sender = dao_update_service_sms_sender(service_id=service_id,
+                                                   service_sms_sender_id=sms_sender_id,
+                                                   is_default=form['is_default'],
+                                                   sms_sender=form['sms_sender']
+                                                   )
+    return jsonify(new_sms_sender.serialize()), 200
+
+
+@service_blueprint.route('/<uuid:service_id>/sms-sender/<uuid:sms_sender_id>', methods=['GET'])
+def get_service_sms_sender_by_id(service_id, sms_sender_id):
+    sms_sender = dao_get_service_sms_senders_by_id(service_id=service_id,
+                                                   service_sms_sender_id=sms_sender_id)
+    return jsonify(sms_sender.serialize()), 200
+
+
+@service_blueprint.route('/<uuid:service_id>/sms-sender', methods=['GET'])
+def get_service_sms_senders_for_service(service_id):
+    sms_senders = dao_get_sms_senders_by_service_id(service_id=service_id)
+    return jsonify([sms_sender.serialize() for sms_sender in sms_senders]), 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

@@ -1,3 +1,5 @@
+from app.schema_validation.definitions import uuid
+
 add_service_email_reply_to_request = {
     "$schema": "http://json-schema.org/draft-04/schema#",
     "description": "POST service email reply to address",
@@ -22,3 +24,17 @@ add_service_letter_contact_block_request = {
     },
     "required": ["contact_block", "is_default"]
 }
+
+
+add_service_sms_sender_request = {
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "POST add service SMS sender",
+    "type": "object",
+    "title": "Add new SMS sender for service",
+    "properties": {
+        "sms_sender": {"type": "string"},
+        "is_default": {"type": "boolean"},
+        "inbound_number_id": uuid
+    },
+    "required": ["sms_sender", "is_default"]
+}