(feat + fix) create lists subsystem and fix db

Previously, the sqlalchemy database URI was incorrectly passed in the configuration. Fix this by using only two // instead of //// in the URI. Also create the lists GET and POST APIs
and database models. Also fix the migration file by adding tasks and list_properties tables.

Author: ProgrammingMuffin

.gitignore

@@ -1 +1,3 @@
 */__pycache__
+__pycache__
+

alembic/versions/fb82c06d1fa2_create_lists_subsystem.py

@@ -25,7 +25,31 @@ def upgrade():
         sa.Column("modified_at", sa.DateTime, nullable=False)
     )
 
+    op.create_table("tasks",
+        sa.Column("id", sa.BIGINT, primary_key=True),
+        sa.Column("name", sa.Text, nullable=False),
+        sa.Column("status", sa.String(64), nullable=False),
+        sa.Column("description", sa.Text),
+        sa.Column("list_id", sa.BIGINT, nullable=False),
+        sa.Column("soft_deleted", sa.BOOLEAN, nullable=False),
+        sa.Column("created_at", sa.DateTime, nullable=False),
+        sa.Column("modified_at", sa.DateTime, nullable=False),
+        sa.ForeignKeyConstraint(['list_id'], ['lists.id'])
+    )
+
+    op.create_table("list_properties",
+        sa.Column("id", sa.BIGINT, primary_key=True),
+        sa.Column("name", sa.Text, nullable=False),
+        sa.Column("value", sa.Text, nullable=False),
+        sa.Column("list_id", sa.BIGINT, nullable=False),
+        sa.Column("created_at", sa.DateTime, nullable=False),
+        sa.Column("modified_at", sa.DateTime, nullable=False),
+        sa.ForeignKeyConstraint(['list_id'], ['lists.id'])
+    )
+
 
 def downgrade():
+    op.drop_table("list_properties")
+    op.drop_table("tasks")
     op.drop_table("lists")
 

config.py

@@ -1 +1 @@
-SQLALCHEMY_DATABASE_URI = 'mysql+pymysql:////root:password@mysql-clusterip/taskmanager'
+SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://root:password@mysql-clusterip:3306/taskmanager'

database.py

@@ -0,0 +1,3 @@
+from flask_sqlalchemy import SQLAlchemy
+
+db = SQLAlchemy()

lists/dtos.py

@@ -0,0 +1,28 @@
+#######################
+# DTOs are Data Transfer Objects
+# They can be serialized to json
+# or anything for that matter
+#######################
+
+class TaskListsDto:
+
+    def __init__(self):
+        self.lists = []
+    
+    def set_lists(self, taskListDtos=[]):
+        self.lists = taskListDtos
+
+
+class TaskListDto:
+
+    def __init__(self):
+        self.name = ""
+        self.recurring_deadline = None
+
+    def set_name(self, name):
+        self.name = name
+
+    def set_recurring_deadline(self, recurring_deadline):
+        self.recurring_deadline = recurring_deadline
+
+

lists/list_service.py

@@ -0,0 +1,38 @@
+from .models import List
+from database import db
+from .dtos import TaskListDto, TaskListsDto
+import json
+import time
+
+global STRP_FORMAT
+STRP_FORMAT = "%H:%M:%S"
+
+
+def create_and_get_list(name, recurring_deadline):
+    new_list = List(name=name, recurring_deadline=\
+            time.strptime(recurring_deadline, STRP_FORMAT))
+    return new_list
+
+
+def create_task_list(request_dict):
+    new_list = create_and_get_list(request_dict["name"],
+            request_dict["recurring_deadline"])
+    db.session.add(new_list)
+    db.session.commit()
+    response = dict()
+    response["message"] = "created a new list"
+    return response
+
+
+def get_all_lists():
+    task_lists = List.query.all()
+    task_list_dtos = []
+    for task_list in task_lists:
+        task_list_dto = TaskListDto()
+        task_list_dto.set_name(task_list.name)
+        task_list_dto.set_recurring_deadline(
+                task_list.recurring_deadline.strftime(STRP_FORMAT))
+        task_list_dtos.append(task_list_dto.__dict__)
+    task_lists_dto = TaskListsDto()
+    task_lists_dto.set_lists(task_list_dtos)
+    return json.dumps(task_lists_dto.__dict__)

lists/models.py

@@ -1,6 +1,38 @@
-from main import db
-import flask_sqlalchemy as sa
+from database import db
+from datetime import datetime
 
-class List(db.Model):
+
+class Audited: 
+    created_at = db.Column("created_at",
+            db.DateTime, nullable=False, default=datetime.now())
+    modified_at = db.Column("modified_at",
+            db.DateTime, nullable=False, default=datetime.now())
+
+
+class List(db.Model, Audited):
     ''' This class represents a list '''
-    
+    __tablename__ = "lists"
+    id = db.Column("id", db.Integer, primary_key=True)
+    name = db.Column("name", db.String, nullable=False)
+    recurring_deadline = db.Column("recurring_deadline", 
+            db.Time, nullable=False)
+    tasks = db.relationship("Task", backref="task_list")
+    list_properties = db.relationship("ListProperty", backref="task_list")
+
+
+class Task(db.Model, Audited):
+    id = db.Column("id", db.Integer, primary_key=True)
+    name = db.Column("name", db.String, nullable=False)
+    status = db.Column("status", db.String, nullable=False)
+    description = db.Column("description", db.String)
+    list_id = db.Column("list_id", db.ForeignKey(List.id),
+            nullable=False)
+    soft_deleted = db.Column("soft_deleted", db.BOOLEAN, nullable=False)
+
+
+class ListProperty(db.Model, Audited):
+    id = db.Column("id", db.Integer, primary_key=True)
+    name = db.Column("name", db.String, nullable=False)
+    value = db.Column("value", db.String, nullable=False)
+    list_id = db.Column("list_id", db.ForeignKey(List.id),
+            nullable=False)

lists/views.py

@@ -1,9 +1,19 @@
-from flask import Blueprint
+from flask import Blueprint, request
+from .models import List
+from . import list_service
+from database import db
 
 
 lists = Blueprint("list_controller", __name__)
 
+
 @lists.route("", methods=["POST"])
 def createList():
-    return "created a list"
+    request_json = request.json
+    response = list_service.create_task_list(request_json)
+    return response
+
 
+@lists.route("", methods=["GET"])
+def getAllLists():
+    return list_service.get_all_lists()

main.py

@@ -1,12 +1,13 @@
 from flask import Flask
-from flask_sqlalchemy import SQLAlchemy
-import os
 from lists.views import lists
+from database import db
+import pymysql
+import os
 
 
 app = Flask(__name__)
 app.config.from_pyfile(os.path.join('.', 'config.py'))
-db = SQLAlchemy(app)
+db.init_app(app)
 
 app.register_blueprint(lists, url_prefix="/lists")
 

taskmanager-deployment.yaml

@@ -31,5 +31,6 @@ spec:
   ports:
     - port: 5000
       targetPort: 5000
+      nodePort: 31001
   type: NodePort
 ---