Merge pull request #38 from alphagov/create-queue-for-service

Create queue for service

app/dao/services_dao.py

@@ -35,13 +35,15 @@ def delete_model_service(service):
     db.session.commit()
 
 
-def get_model_services(service_id=None, user_id=None):
+def get_model_services(service_id=None, user_id=None, _raise=True):
     # TODO need better mapping from function params to sql query.
     if user_id and service_id:
         return Service.query.filter(
             Service.users.any(id=user_id)).filter_by(id=service_id).one()
     elif service_id:
-        return Service.query.filter_by(id=service_id).one()
+        result = Service.query.filter_by(id=service_id).one() if _raise else Service.query.filter_by(
+            id=service_id).first()
+        return result
     elif user_id:
         return Service.query.filter(Service.users.any(id=user_id)).all()
     return Service.query.all()

app/models.py

@@ -1,3 +1,5 @@
+import uuid
+
 from sqlalchemy import UniqueConstraint
 
 from . import db
@@ -84,6 +86,7 @@ class Service(db.Model):
         secondary=user_to_service,
         backref=db.backref('user_to_service', lazy='dynamic'))
     restricted = db.Column(db.Boolean, index=False, unique=False, nullable=False)
+    queue_name = db.Column(UUID(as_uuid=True), default=uuid.uuid4)
 
 
 class ApiKey(db.Model):

app/notifications/rest.py

@@ -1,10 +1,13 @@
+import json
+
+import boto3
 from flask import (
     Blueprint,
     jsonify,
     request,
     current_app
 )
-
+from itsdangerous import URLSafeSerializer
 from app import notify_alpha_client
 from app import api_user
 from app.dao import (templates_dao, services_dao)
@@ -24,19 +27,35 @@ def get_notifications(notification_id):
 def create_sms_notification():
     notification = request.get_json()['notification']
     errors = {}
-    to, to_errors = validate_to(notification, api_user['client'])
+    to, to_errors = validate_to(notification)
-    print("create sms")
-    print(notification)
-    template, template_errors = validate_template(notification, api_user['client'])
     if to_errors['to']:
         errors.update(to_errors)
-    if template_errors['template']:
+
-        errors.update(template_errors)
+    # TODO: should create a different endpoint for the admin client to send verify codes.
-    if errors:
+    if api_user['client'] == current_app.config.get('ADMIN_CLIENT_USER_NAME'):
-        return jsonify(result="error", message=errors), 400
+        content, content_errors = validate_content_for_admin_client(notification)
-    return jsonify(notify_alpha_client.send_sms(
+        if content_errors['content']:
-        mobile_number=to,
+            errors.update(content_errors)
-        message=template)), 200
+        if errors:
+            return jsonify(result="error", message=errors), 400
+
+        return jsonify(notify_alpha_client.send_sms(mobile_number=to, message=content)), 200
+
+    else:
+        to, restricted_errors = validate_to_for_service(notification, api_user['client'])
+        if restricted_errors['restricted']:
+            errors.update(restricted_errors)
+
+        template, template_errors = validate_template(notification, api_user['client'])
+        if template_errors['template']:
+            errors.update(template_errors)
+        if errors:
+            return jsonify(result="error", message=errors), 400
+
+        # add notification to the queue
+        service = services_dao.get_model_services(api_user['client'], _raise=False)
+        _add_notification_to_queue(template.id, service, 'sms', to)
+        return jsonify(notify_alpha_client.send_sms(mobile_number=to, message=template.content)), 200
 
 
 @notifications.route('/email', methods=['POST'])
@@ -58,7 +77,21 @@ def create_email_notification():
         notification['subject']))
 
 
-def validate_to(json_body, service_id):
+def validate_to_for_service(mob, service_id):
+    errors = {"restricted": []}
+    service = services_dao.get_model_services(service_id=service_id)
+    if service.restricted:
+        valid = False
+        for usr in service.users:
+            if mob == usr.mobile_number:
+                valid = True
+                break
+        if not valid:
+            errors['restricted'].append('Invalid phone number for restricted service')
+    return mob, errors
+
+
+def validate_to(json_body):
     errors = {"to": []}
     mob = json_body.get('to', None)
     if not mob:
@@ -66,36 +99,31 @@ def validate_to(json_body, service_id):
     else:
         if not mobile_regex.match(mob):
             errors['to'].append('invalid phone number, must be of format +441234123123')
-        if service_id != current_app.config.get('ADMIN_CLIENT_USER_NAME'):
-            service = services_dao.get_model_services(service_id=service_id)
-            if service.restricted:
-                valid = False
-                for usr in service.users:
-                    if mob == usr.mobile_number:
-                        valid = True
-                        break
-                if not valid:
-                    errors['to'].append('Invalid phone number for restricted service')
     return mob, errors
 
 
 def validate_template(json_body, service_id):
     errors = {"template": []}
     template_id = json_body.get('template', None)
-    content = ''
+    template = ''
     if not template_id:
         errors['template'].append('Required data missing')
     else:
-        if service_id == current_app.config.get('ADMIN_CLIENT_USER_NAME'):
+        try:
-            content = json_body['template']
+            template = templates_dao.get_model_templates(
-        else:
+                template_id=json_body['template'],
-            try:
+                service_id=service_id)
-                template = templates_dao.get_model_templates(
+        except:
-                    template_id=json_body['template'],
+            errors['template'].append("Unable to load template.")
-                    service_id=service_id)
+    return template, errors
-                content = template.content
+
-            except:
+
-                errors['template'].append("Unable to load template.")
+def validate_content_for_admin_client(json_body):
+    errors = {"content": []}
+    content = json_body.get('template', None)
+    if not content:
+        errors['content'].append('Required content')
+
     return content, errors
 
 
@@ -104,3 +132,22 @@ def validate_required_and_something(json_body, field):
     if field not in json_body and json_body[field]:
         errors.append('Required data for field.')
     return {field: errors} if errors else None
+
+
+def _add_notification_to_queue(template_id, service, msg_type, to):
+    q = boto3.resource('sqs', region_name=current_app.config['AWS_REGION']).create_queue(
+        QueueName=str(service.queue_name))
+    import uuid
+    message_id = str(uuid.uuid4())
+    notification = json.dumps({'message_id': message_id,
+                               'service_id': service.id,
+                               'to': to,
+                               'message_type': msg_type,
+                               'template_id': template_id})
+    serializer = URLSafeSerializer(current_app.config.get('SECRET_KEY'))
+    encrypted = serializer.dumps(notification, current_app.config.get('DANGEROUS_SALT'))
+    q.send_message(MessageBody=encrypted,
+                   MessageAttributes={'type': {'StringValue': msg_type, 'DataType': 'String'},
+                                      'message_id': {'StringValue': message_id, 'DataType': 'String'},
+                                      'service_id': {'StringValue': str(service.id), 'DataType': 'String'},
+                                      'template_id': {'StringValue': str(template_id), 'DataType': 'String'}})

app/schemas.py

@@ -20,7 +20,7 @@ class UserSchema(ma.ModelSchema):
 class ServiceSchema(ma.ModelSchema):
     class Meta:
         model = models.Service
-        exclude = ("updated_at", "created_at", "api_keys", "templates", "jobs")
+        exclude = ("updated_at", "created_at", "api_keys", "templates", "jobs", "queue_name")
 
 
 class TemplateSchema(ma.ModelSchema):

config.py

@@ -14,6 +14,8 @@ class Config(object):
     ADMIN_CLIENT_USER_NAME = None
     ADMIN_CLIENT_SECRET = None
 
+    AWS_REGION = 'eu-west-1'
+
 
 class Development(Config):
     DEBUG = True

migrations/versions/0010_add_queue_name_to_service.py

@@ -0,0 +1,28 @@
+"""empty message
+
+Revision ID: 0010_add_queue_name_to_service
+Revises: 0009_unique_service_to_key_name
+Create Date: 2016-01-27 13:53:34.717916
+
+"""
+
+# revision identifiers, used by Alembic.
+
+revision = '0010_add_queue_name_to_service'
+down_revision = '0009_unique_service_to_key_name'
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('services', sa.Column('queue_name', postgresql.UUID(as_uuid=True), nullable=True))
+    op.get_bind()
+    op.execute('update services set queue_name = (SELECT uuid_in(md5(random()::text || now()::text)::cstring))')
+    ### end Alembic commands ###
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('services', 'queue_name')
+    ### end Alembic commands ###

requirements.txt

@@ -12,6 +12,7 @@ flask-marshmallow==0.6.2
 itsdangerous==0.24
 Flask-Bcrypt==0.6.2
 credstash==1.8.0
+boto3==1.2.3
 
 git+https://github.com/alphagov/notifications-python-client.git@0.2.1#egg=notifications-python-client==0.2.1
 

requirements_for_test.txt

@@ -3,4 +3,5 @@ pep8==1.5.7
 pytest==2.8.1
 pytest-mock==0.8.1
 pytest-cov==2.2.0
-mock==1.0.1
+mock==1.0.1
+moto==0.4.19

tests/app/conftest.py

@@ -1,4 +1,6 @@
 import pytest
+from flask import jsonify
+
 from app.models import (User, Service, Template, ApiKey, Job, VerifyCode)
 from app.dao.users_dao import (save_model_user, create_user_code, create_secret_code)
 from app.dao.services_dao import save_model_service
@@ -76,7 +78,8 @@ def sample_service(notify_db,
         'users': [user],
         'limit': 1000,
         'active': False,
-        'restricted': False}
+        'restricted': False,
+        'queue_name': str(uuid.uuid4())}
     service = Service.query.filter_by(name=service_name).first()
     if not service:
         service = Service(**data)

tests/app/notifications/test_rest.py

@@ -1,3 +1,6 @@
+import boto3
+import moto
+
 from tests import create_authorization_header
 from flask import url_for, json
 from app import notify_alpha_client
@@ -5,7 +8,7 @@ from app.models import Service
 
 
 def test_get_notifications(
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+        notify_api, notify_db, notify_db_session, sample_api_key, mocker):
     """
     Tests GET endpoint '/' to retrieve entire service list.
     """
@@ -24,7 +27,7 @@ def test_get_notifications(
             )
 
             auth_header = create_authorization_header(
-                service_id=sample_admin_service_id,
+                service_id=sample_api_key.service_id,
                 path=url_for('notifications.get_notifications', notification_id=123),
                 method='GET')
 
@@ -41,7 +44,7 @@ def test_get_notifications(
 
 
 def test_get_notifications_empty_result(
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+        notify_api, notify_db, notify_db_session, sample_api_key, mocker):
     """
     Tests GET endpoint '/' to retrieve entire service list.
     """
@@ -56,7 +59,7 @@ def test_get_notifications_empty_result(
             )
 
             auth_header = create_authorization_header(
-                service_id=sample_admin_service_id,
+                service_id=sample_api_key.service_id,
                 path=url_for('notifications.get_notifications', notification_id=123),
                 method='GET')
 
@@ -70,8 +73,8 @@ def test_get_notifications_empty_result(
             notify_alpha_client.fetch_notification_by_id.assert_called_with("123")
 
 
-def test_should_reject_if_no_phone_numbers(
+def test_create_sms_should_reject_if_no_phone_numbers(
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+        notify_api, notify_db, notify_db_session, sample_api_key, mocker):
     """
     Tests GET endpoint '/' to retrieve entire service list.
     """
@@ -87,7 +90,7 @@ def test_should_reject_if_no_phone_numbers(
                 }
             }
             auth_header = create_authorization_header(
-                service_id=sample_admin_service_id,
+                service_id=sample_api_key.service_id,
                 request_body=json.dumps(data),
                 path=url_for('notifications.create_sms_notification'),
                 method='POST')
@@ -105,7 +108,7 @@ def test_should_reject_if_no_phone_numbers(
 
 
 def test_should_reject_bad_phone_numbers(
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+        notify_api, notify_db, notify_db_session, mocker):
     """
     Tests GET endpoint '/' to retrieve entire service list.
     """
@@ -122,7 +125,6 @@ def test_should_reject_bad_phone_numbers(
                 }
             }
             auth_header = create_authorization_header(
-                service_id=sample_admin_service_id,
                 request_body=json.dumps(data),
                 path=url_for('notifications.create_sms_notification'),
                 method='POST')
@@ -139,8 +141,8 @@ def test_should_reject_bad_phone_numbers(
             assert not notify_alpha_client.send_sms.called
 
 
-def test_should_reject_missing_template(
+def test_should_reject_missing_content(
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+        notify_api, notify_db, notify_db_session, mocker):
     """
     Tests GET endpoint '/' to retrieve entire service list.
     """
@@ -156,7 +158,6 @@ def test_should_reject_missing_template(
                 }
             }
             auth_header = create_authorization_header(
-                service_id=sample_admin_service_id,
                 request_body=json.dumps(data),
                 path=url_for('notifications.create_sms_notification'),
                 method='POST')
@@ -169,22 +170,23 @@ def test_should_reject_missing_template(
             json_resp = json.loads(response.get_data(as_text=True))
             assert response.status_code == 400
             assert json_resp['result'] == 'error'
-            assert 'Required data missing' in json_resp['message']['template']
+            assert 'Required content' in json_resp['message']['content']
             assert not notify_alpha_client.send_sms.called
 
 
+@moto.mock_sqs
 def test_send_template_content(notify_api,
                                notify_db,
                                notify_db_session,
-                               sample_api_key,
-                               sample_template,
-                               sample_user,
                                mocker):
     """
     Test POST endpoint '/sms' with service notification.
     """
     with notify_api.test_request_context():
         with notify_api.test_client() as client:
+            set_up_mock_queue()
+            mobile = '+447719087678'
+            msg = 'Message content'
             mocker.patch(
                 'app.notify_alpha_client.send_sms',
                 return_value={
@@ -192,21 +194,20 @@ def test_send_template_content(notify_api,
                         "createdAt": "2015-11-03T09:37:27.414363Z",
                         "id": 100,
                         "jobId": 65,
-                        "message": sample_template.content,
+                        "message": msg,
                         "method": "sms",
                         "status": "created",
-                        "to": sample_user.mobile_number
+                        "to": mobile
                     }
                 }
             )
             data = {
                 'notification': {
-                    'to': sample_user.mobile_number,
+                    'to': mobile,
-                    'template': sample_template.id
+                    'template': msg
                 }
             }
             auth_header = create_authorization_header(
-                service_id=sample_template.service.id,
                 request_body=json.dumps(data),
                 path=url_for('notifications.create_sms_notification'),
                 method='POST')
@@ -220,8 +221,8 @@ def test_send_template_content(notify_api,
             assert response.status_code == 200
             assert json_resp['notification']['id'] == 100
             notify_alpha_client.send_sms.assert_called_with(
-                mobile_number=sample_user.mobile_number,
+                mobile_number=mobile,
-                message=sample_template.content)
+                message=msg)
 
 
 def test_send_notification_restrict_mobile(notify_api,
@@ -237,6 +238,7 @@ def test_send_notification_restrict_mobile(notify_api,
     """
     with notify_api.test_request_context():
         with notify_api.test_client() as client:
+
             Service.query.filter_by(
                 id=sample_template.service.id).update({'restricted': True})
             invalid_mob = '+449999999999'
@@ -264,16 +266,18 @@ def test_send_notification_restrict_mobile(notify_api,
 
             json_resp = json.loads(response.get_data(as_text=True))
             assert response.status_code == 400
-            assert 'Invalid phone number for restricted service' in json_resp['message']['to']
+            assert 'Invalid phone number for restricted service' in json_resp['message']['restricted']
+            assert not notify_alpha_client.send_sms.called
 
 
-def test_should_allow_valid_message(
+@moto.mock_sqs
-        notify_api, notify_db, notify_db_session, sample_service, sample_admin_service_id, mocker):
+def test_should_allow_valid_message(notify_api, notify_db, notify_db_session, mocker):
     """
     Tests POST endpoint '/sms' with notifications-admin notification.
     """
     with notify_api.test_request_context():
         with notify_api.test_client() as client:
+            set_up_mock_queue()
             mocker.patch(
                 'app.notify_alpha_client.send_sms',
                 return_value={
@@ -281,7 +285,7 @@ def test_should_allow_valid_message(
                         "createdAt": "2015-11-03T09:37:27.414363Z",
                         "id": 100,
                         "jobId": 65,
-                        "message": "This is the message",
+                        "message": "valid",
                         "method": "sms",
                         "status": "created",
                         "to": "+449999999999"
@@ -307,7 +311,7 @@ def test_should_allow_valid_message(
             json_resp = json.loads(response.get_data(as_text=True))
             assert response.status_code == 200
             assert json_resp['notification']['id'] == 100
-            notify_alpha_client.send_sms.assert_called_with(mobile_number='+441234123123', message='valid')
+            notify_alpha_client.send_sms.assert_called_with(mobile_number='+441234123123', message="valid")
 
 
 def test_send_email_valid_data(notify_api,
@@ -318,7 +322,6 @@ def test_send_email_valid_data(notify_api,
                                mocker):
     with notify_api.test_request_context():
         with notify_api.test_client() as client:
-
             to_address = "to@notify.com"
             from_address = "from@notify.com"
             subject = "This is the subject"
@@ -362,3 +365,9 @@ def test_send_email_valid_data(notify_api,
             assert json_resp['notification']['id'] == 100
             notify_alpha_client.send_email.assert_called_with(
                 to_address, message, from_address, subject)
+
+
+def set_up_mock_queue():
+    # set up mock queue
+    boto3.setup_default_session(region_name='eu-west-1')
+    conn = boto3.resource('sqs')

tests/app/service/test_rest.py

@@ -93,6 +93,7 @@ def test_post_service(notify_api, notify_db, notify_db_session, sample_user, sam
             json_resp = json.loads(resp.get_data(as_text=True))
             assert json_resp['data']['name'] == service.name
             assert json_resp['data']['limit'] == service.limit
+            assert service.queue_name is not None
 
 
 def test_post_service_multiple_users(notify_api, notify_db, notify_db_session, sample_user, sample_admin_service_id):