Merge pull request #69 from snowflake-app/notification-api

Notification API

Author: recrsn

Pipfile.lock

@@ -1,14 +1,16 @@
-from flask import Blueprint, jsonify
+from flask import Blueprint, jsonify, request
 from flask_login import login_required, current_user
 
+from .request import requires_json
 from .response import not_found
 from ...db import db
 from ...models import Notification
-from ...schemas.notification import NotificationSchema
+from ...schemas.notification import NotificationSchema, UpdateNotificationSchema
 
 blueprint = Blueprint('api.notifications', __name__)
 
 schema = NotificationSchema()
+update_notification_schema = UpdateNotificationSchema()
 
 
 @blueprint.route('/_count')
@@ -17,21 +19,25 @@ def notification_count():
     return jsonify(Notification.count_unread_by_user(current_user))
 
 
-@blueprint.route('/<_id>/mark_as_read', methods=['POST'])
+@blueprint.route('/<_id>', methods=['PATCH'])
 @login_required
-def mark_as_read(_id):
-    n = Notification.get(_id)
-    if not n:
+@requires_json
+def update_notification(_id):
+    notification = Notification.get(_id)
+    if not notification:
         return not_found()
 
-    n.read = True
-    db.session.add(n)
+    req_body = update_notification_schema.load(request.json)
+
+    notification.read = req_body['read']
+
+    db.session.add(notification)
     db.session.commit()
 
-    return schema.jsonify(n)
+    return schema.jsonify(notification)
 
 
-@blueprint.route('/introspect', methods=['GET'])
+@blueprint.route('/', methods=['GET'])
 @login_required
-def notification():
+def get_all_notifications():
     return schema.jsonify(Notification.get_by_user(current_user), many=True)

snowflake/controllers/api/notifications.py

@@ -0,0 +1,13 @@
+from flask import request
+
+from .response import bad_request
+
+
+def requires_json(wrapped_func):
+    def func(*args, **kwargs):
+        if not request.is_json:
+            return bad_request()
+
+        return wrapped_func(*args, **kwargs)
+
+    return func

snowflake/controllers/api/request.py

@@ -1,7 +1,17 @@
-from .base import BaseSQLAlchemyAutoSchema
+from marshmallow.fields import Boolean
+from marshmallow_sqlalchemy.fields import Nested
+
+from .base import BaseSQLAlchemyAutoSchema, BaseSchema
+from .object import ObjectSchema
 from ..models import Notification
 
 
 class NotificationSchema(BaseSQLAlchemyAutoSchema):
     class Meta:
         model = Notification
+
+    object = Nested(ObjectSchema)
+
+
+class UpdateNotificationSchema(BaseSchema):
+    read: Boolean()

snowflake/schemas/notification.py

@@ -0,0 +1,11 @@
+from marshmallow import Schema
+from marshmallow.fields import Nested, DateTime
+
+from .user import UserSchema
+from ..marshmallow import marshmallow
+
+
+class ObjectSchema(Schema):
+    id: marshmallow.auto_field()
+    created_at = DateTime()
+    created_by = Nested(UserSchema)