Migrate notifications api to use marshmallow

Author: recrsn

Pipfile

@@ -19,6 +19,8 @@ gunicorn = "*"
 python-dotenv = "*"
 markupsafe = "*"
 flask-sqlalchemy = "*"
+flask-marshmallow = "*"
+marshmallow-sqlalchemy = "*"
 
 [requires]
 python_version = "3.8"

Pipfile.lock

@@ -7,6 +7,7 @@
 from . import filters, settings, logger
 from .controllers import api, login, register, profile, index, one_on_one, appreciation, logout, notifications
 from .db import db
+from .marshmallow import marshmallow
 from .models import User
 
 load_dotenv()
@@ -16,6 +17,7 @@
 
 db.init_app(app)
 settings.init_app(app)
+marshmallow.init_app(app)
 
 login_manager = LoginManager()
 login_manager.init_app(app)

snowflake/app.py

@@ -1,31 +1,14 @@
 from flask import Blueprint, jsonify
 from flask_login import login_required, current_user
 
-from snowflake.controllers.api.response import not_found
-from snowflake.db import db
-from snowflake.models import User
-from snowflake.models.notification import Notification
+from .response import not_found
+from ...db import db
+from ...models import Notification
+from ...schemas.notification import NotificationSchema
 
 blueprint = Blueprint('api.notifications', __name__)
 
-
-def user_to_json(user: User):
-    return {
-        'id': user.id,
-        'username': user.username,
-        'name': user.name
-    }
-
-
-def to_json(n):
-    return {
-        'id': n.id,
-        'created_at': n.created_at,
-        'user': user_to_json(n.user),
-        'type': n.type,
-        'object_id': n.object_id,
-        'read': n.read
-    }
+schema = NotificationSchema()
 
 
 @login_required
@@ -37,18 +20,18 @@ def notification_count():
 @login_required
 @blueprint.route('/<_id>/mark_as_read', methods=['POST'])
 def mark_as_read(_id):
-    notification = Notification.get(_id)
-    if not notification:
+    n = Notification.get(_id)
+    if not n:
         return not_found()
 
-    notification.read = True
-    db.session.add(notification)
+    n.read = True
+    db.session.add(n)
     db.session.commit()
 
-    return to_json(notification)
+    return schema.jsonify(n)
 
 
 @login_required
 @blueprint.route('')
 def notification():
-    return jsonify([to_json(n) for n in Notification.get_by_user(current_user)])
+    return schema.jsonify(Notification.get_by_user(current_user), many=True)

snowflake/controllers/api/notifications.py

@@ -0,0 +1,3 @@
+from flask_marshmallow import Marshmallow
+
+marshmallow = Marshmallow()

snowflake/marshmallow.py

@@ -0,0 +1,12 @@
+from marshmallow_sqlalchemy.fields import Nested
+
+from .user import UserSchema
+from ..marshmallow import marshmallow
+from ..models import Notification
+
+
+class NotificationSchema(marshmallow.SQLAlchemyAutoSchema):
+    class Meta:
+        model = Notification
+
+    user = Nested(UserSchema)

snowflake/schemas/__init__.py

@@ -0,0 +1,8 @@
+from ..marshmallow import marshmallow
+from ..models import User
+
+
+class UserSchema(marshmallow.SQLAlchemyAutoSchema):
+    class Meta:
+        model = User
+        exclude = ("id",)