Merge remote-tracking branch 'origin/master' into remove_alpha_client_from_api

app/dao/notifications_dao.py

@@ -0,0 +1,22 @@
+from app import db
+from app.models import Notification
+
+
+def save_notification(notification, update_dict={}):
+    if update_dict:
+        update_dict.pop('id', None)
+        update_dict.pop('job', None)
+        update_dict.pop('service', None)
+        update_dict.pop('template', None)
+        Notification.query.filter_by(id=notification.id).update(update_dict)
+    else:
+        db.session.add(notification)
+    db.session.commit()
+
+
+def get_notification(service_id, job_id, notification_id):
+    return Notification.query.filter_by(service_id=service_id, job_id=job_id, id=notification_id).one()
+
+
+def get_notifications(service_id, job_id):
+    return Notification.query.filter_by(service_id=service_id, job_id=job_id).all()

app/job/rest.py

@@ -8,7 +8,6 @@ from flask import (
     current_app
 )
 
-from sqlalchemy.exc import SQLAlchemyError
 from sqlalchemy.exc import DataError
 from sqlalchemy.orm.exc import NoResultFound
 
@@ -18,10 +17,19 @@ from app.dao.jobs_dao import (
     get_jobs_by_service
 )
 
+from app.dao.notifications_dao import (
+    save_notification,
+    get_notification,
+    get_notifications
+)
+
 from app.schemas import (
     job_schema,
     jobs_schema,
-    job_schema_load_json
+    job_schema_load_json,
+    notification_status_schema,
+    notifications_status_schema,
+    notification_status_schema_load_json
 )
 
 job = Blueprint('job', __name__, url_prefix='/service/<service_id>/job')
@@ -72,6 +80,55 @@ def update_job(service_id, job_id):
     return jsonify(data=job_schema.dump(job).data), 200
 
 
+@job.route('/<job_id>/notification', methods=['POST'])
+def create_notification_for_job(service_id, job_id):
+
+    # TODO assert service_id == payload service id
+    # and same for job id
+    notification, errors = notification_status_schema.load(request.get_json())
+    if errors:
+        return jsonify(result="error", message=errors), 400
+    try:
+        save_notification(notification)
+    except Exception as e:
+        return jsonify(result="error", message=str(e)), 500
+    return jsonify(data=notification_status_schema.dump(notification).data), 201
+
+
+@job.route('/<job_id>/notification', methods=['GET'])
+@job.route('/<job_id>/notification/<notification_id>')
+def get_notification_for_job(service_id, job_id, notification_id=None):
+    if notification_id:
+        try:
+            notification = get_notification(service_id, job_id, notification_id)
+            data, errors = notification_status_schema.dump(notification)
+            return jsonify(data=data)
+        except DataError:
+            return jsonify(result="error", message="Invalid notification id"), 400
+        except NoResultFound:
+            return jsonify(result="error", message="Notification not found"), 404
+    else:
+        notifications = get_notifications(service_id, job_id)
+        data, errors = notifications_status_schema.dump(notifications)
+        return jsonify(data=data)
+
+
+@job.route('/<job_id>/notification/<notification_id>', methods=['PUT'])
+def update_notification_for_job(service_id, job_id, notification_id):
+
+    notification = get_notification(service_id, job_id, notification_id)
+    update_dict, errors = notification_status_schema_load_json.load(request.get_json())
+
+    if errors:
+        return jsonify(result="error", message=errors), 400
+    try:
+        save_notification(notification, update_dict=update_dict)
+    except Exception as e:
+        return jsonify(result="error", message=str(e)), 400
+
+    return jsonify(data=job_schema.dump(notification).data), 200
+
+
 def _enqueue_job(job):
     aws_region = current_app.config['AWS_REGION']
     queue_name = current_app.config['NOTIFY_JOB_QUEUE']

app/models.py

@@ -189,3 +189,34 @@ class VerifyCode(db.Model):
 
     def check_code(self, cde):
         return check_hash(cde, self._code)
+
+
+NOTIFICATION_STATUS_TYPES = ['sent', 'failed']
+
+
+class Notification(db.Model):
+
+    __tablename__ = 'notifications'
+
+    id = db.Column(UUID(as_uuid=True), primary_key=True)
+    to = db.Column(db.String, nullable=False)
+    job_id = db.Column(UUID(as_uuid=True), db.ForeignKey('jobs.id'), index=True, unique=False, nullable=False)
+    job = db.relationship('Job', backref=db.backref('notifications', lazy='dynamic'))
+    service_id = db.Column(UUID(as_uuid=True), db.ForeignKey('services.id'), index=True, unique=False)
+    service = db.relationship('Service')
+    template_id = db.Column(db.BigInteger, db.ForeignKey('templates.id'), index=True, unique=False)
+    template = db.relationship('Template')
+    created_at = db.Column(
+        db.DateTime,
+        index=False,
+        unique=False,
+        nullable=False,
+        default=datetime.datetime.now)
+    updated_at = db.Column(
+        db.DateTime,
+        index=False,
+        unique=False,
+        nullable=True,
+        onupdate=datetime.datetime.now)
+    status = db.Column(
+        db.Enum(*NOTIFICATION_STATUS_TYPES, name='notification_status_types'), nullable=False, default='sent')

app/schemas.py

@@ -129,6 +129,12 @@ class EmailNotificationSchema(NotificationSchema):
     body = fields.Str(load_from="message", dump_to='message', required=True)
 
 
+class NotificationStatusSchema(BaseSchema):
+
+    class Meta:
+        model = models.Notification
+
+
 user_schema = UserSchema()
 user_schema_load_json = UserSchema(load_json=True)
 users_schema = UserSchema(many=True)
@@ -148,3 +154,6 @@ request_verify_code_schema = RequestVerifyCodeSchema()
 sms_admin_notification_schema = SmsAdminNotificationSchema()
 sms_template_notification_schema = SmsTemplateNotificationSchema()
 email_notification_schema = EmailNotificationSchema()
+notification_status_schema = NotificationStatusSchema()
+notifications_status_schema = NotificationStatusSchema(many=True)
+notification_status_schema_load_json = NotificationStatusSchema(load_json=True)