Create buildings table

backend/app/models/__init__.py

@@ -12,6 +12,7 @@ def init_app(app):
     from .log_records import LogRecords
     from .tag import Tag
     from .residents import Residents
+    from .buildings import Buildings
 
     app.app_context().push()
     db.init_app(app)

backend/app/models/buildings.py

@@ -0,0 +1,32 @@
+from . import db
+from sqlalchemy import inspect, cast, String
+from sqlalchemy.orm.properties import ColumnProperty
+
+
+class Buildings(db.Model):
+    __tablename__ = "buildings"
+    id = db.Column(db.Integer, primary_key=True, nullable=False)
+    address = db.Column(db.String, nullable=False)
+    name = db.Column(db.String, nullable=False)
+    log_record = db.relationship("LogRecords", back_populates="building")
+    resident = db.relationship("Residents", back_populates="building")
+
+    def to_dict(self, include_relationships=False):
+        # define the entities table
+        cls = type(self)
+
+        mapper = inspect(cls)
+        formatted = {}
+        for column in mapper.attrs:
+            field = column.key
+            attr = getattr(self, field)
+            # if it's a regular column, extract the value
+            if isinstance(column, ColumnProperty):
+                formatted[field] = attr
+            # otherwise, it's a relationship field
+            # (currently not applicable, but may be useful for entity groups)
+            elif include_relationships:
+                # recursively format the relationship
+                # don't format the relationship's relationships
+                formatted[field] = [obj.to_dict() for obj in attr]
+        return formatted

backend/app/models/log_records.py

@@ -14,7 +14,8 @@ class LogRecords(db.Model):
     # TODO: replace open String fields with VarChar(NUM_CHARS)
     note = db.Column(db.String, nullable=False)
     tags = db.Column(db.ARRAY(db.String), nullable=True)
-    building = db.Column(db.String, nullable=False)
+    building_id = db.Column(db.Integer, db.ForeignKey("buildings.id"), nullable=False)
+    building = db.relationship("Buildings", back_populates="log_record")
 
     def to_dict(self, include_relationships=False):
         # define the entities table

backend/app/models/residents.py

@@ -10,7 +10,8 @@ class Residents(db.Model):
     room_num = db.Column(db.Integer, nullable=False)
     date_joined = db.Column(db.Date, nullable=False)
     date_left = db.Column(db.Date, nullable=True)
-    building = db.Column(db.Enum("144", "402", "362", name="buildings"), nullable=False)
+    building_id = db.Column(db.Integer, db.ForeignKey("buildings.id"), nullable=False)
+    building = db.relationship("Buildings", back_populates="resident")
 
     resident_id = db.column_property(initial + cast(room_num, String))
 

backend/app/rest/tags_routes.py

@@ -1,10 +1,11 @@
-from flask import Blueprint, current_app, jsonify,request
+from flask import Blueprint, current_app, jsonify, request
 from ..middlewares.auth import require_authorization_by_role
 from ..services.implementations.tags_service import TagsService
 
 tags_service = TagsService(current_app.logger)
 blueprint = Blueprint("tags", __name__, url_prefix="/tags")
 
+
 @blueprint.route("/", methods=["GET"], strict_slashes=False)
 @require_authorization_by_role({"Admin"})
 def get_tags():
@@ -18,6 +19,7 @@ def get_tags():
         error_message = getattr(e, "message", None)
         return jsonify({"error": (error_message if error_message else str(e))}), 500
 
+
 @blueprint.route("/<int:tag_id>", methods=["PUT"], strict_slashes=False)
 @require_authorization_by_role({"Admin"})
 def update_tag(tag_id):
@@ -26,9 +28,7 @@ def update_tag(tag_id):
     """
     updated_tag_record = request.json
     try:
-        updated_tag_record = tags_service.update_tag(
-            tag_id, updated_tag_record
-        )
+        updated_tag_record = tags_service.update_tag(tag_id, updated_tag_record)
         return (
             jsonify(
                 {
@@ -41,4 +41,4 @@ def update_tag(tag_id):
         )
     except Exception as e:
         error_message = getattr(e, "message", None)
-        return jsonify({"error": (error_message if error_message else str(e))}), 500
+        return jsonify({"error": (error_message if error_message else str(e))}), 500

backend/app/services/implementations/log_records_service.py

@@ -47,19 +47,20 @@ def to_json_list(self, logs):
                         "attn_to": log[5],
                         "note": log[6],
                         "tags": log[7],
-                        "building": log[8],
-                        "employee_first_name": log[9],
-                        "employee_last_name": log[10],
-                        "attn_to_first_name": log[11],
-                        "attn_to_last_name": log[12],
+                        "building_id": log[8],
+                        "building": log[9],
+                        "employee_first_name": log[10],
+                        "employee_last_name": log[11],
+                        "attn_to_first_name": log[12],
+                        "attn_to_last_name": log[13],
                     }
                 )
             return logs_list
         except Exception as postgres_error:
             raise postgres_error
 
-    def filter_by_building(self, building):
-        return f"\nlogs.building='{building}'"
+    def filter_by_building_id(self, building_id):
+        return f"\nlogs.building_id='{building_id}'"
 
     def filter_by_employee_id(self, employee_id):
         if type(employee_id) == list:
@@ -88,17 +89,17 @@ def filter_by_attn_to(self, attn_to):
     def filter_by_date_range(self, date_range):
         sql = ""
         if len(date_range) > 0:
-            if (date_range[0] != ""):
+            if date_range[0] != "":
                 start_date = datetime.strptime(date_range[0], "%Y-%m-%d").replace(
                     hour=0, minute=0
                 )
                 sql += f"\ndatetime>='{start_date}'"
-            if (date_range[-1] != ""):
+            if date_range[-1] != "":
                 end_date = datetime.strptime(
                     date_range[len(date_range) - 1], "%Y-%m-%d"
                 ).replace(hour=23, minute=59)
-                
-                if (sql == ""):
+
+                if sql == "":
                     sql += f"\ndatetime<='{end_date}'"
                 else:
                     sql += f"\nAND datetime<='{end_date}'"
@@ -121,7 +122,7 @@ def filter_log_records(self, filters=None):
             is_first_filter = True
 
             options = {
-                "building": self.filter_by_building,
+                "building_id": self.filter_by_building_id,
                 "employee_id": self.filter_by_employee_id,
                 "resident_id": self.filter_by_resident_id,
                 "attn_to": self.filter_by_attn_to,
@@ -152,15 +153,17 @@ def get_log_records(
             logs.attn_to,\n \
             logs.note,\n \
             logs.tags,\n \
-            logs.building,\n \
+            buildings.id AS building_id,\n \
+            buildings.name AS building,\n \
             employees.first_name AS employee_first_name,\n \
             employees.last_name AS employee_last_name,\n \
             attn_tos.first_name AS attn_to_first_name,\n \
             attn_tos.last_name AS attn_to_last_name\n \
             FROM log_records logs\n \
             LEFT JOIN users attn_tos ON logs.attn_to = attn_tos.id\n \
             JOIN users employees ON logs.employee_id = employees.id \n \
-            JOIN residents ON logs.resident_id = residents.id"
+            JOIN residents ON logs.resident_id = residents.id \n \
+            JOIN buildings on logs.building_id = buildings.id"
 
             sql += self.filter_log_records(filters)
 
@@ -235,7 +238,7 @@ def update_log_record(self, log_id, updated_log_record):
                 LogRecords.employee_id: updated_log_record["employee_id"],
                 LogRecords.resident_id: updated_log_record["resident_id"],
                 LogRecords.flagged: updated_log_record["flagged"],
-                LogRecords.building: updated_log_record["building"],
+                LogRecords.building_id: updated_log_record["building_id"],
                 LogRecords.note: updated_log_record["note"],
                 LogRecords.datetime: updated_log_record["datetime"],
             }

backend/app/services/implementations/residents_service.py

@@ -1,6 +1,7 @@
 from ..interfaces.residents_service import IResidentsService
 from ...models.residents import Residents
 from ...models.log_records import LogRecords
+from ...models.buildings import Buildings
 from ...models import db
 from datetime import datetime
 from sqlalchemy import select, cast, Date
@@ -21,6 +22,27 @@ def __init__(self, logger):
         """
         self.logger = logger
 
+    def to_residents_json_list(self, resident_results):
+        residents_json_list = []
+        for result in resident_results:
+            date_left = None
+            if result[0].date_left:
+                date_left = result[0].date_left.strftime("%Y-%m-%d")
+
+            residents_json_list.append(
+                {
+                    "id": result[0].id,
+                    "initial": result[0].initial,
+                    "room_num": result[0].room_num,
+                    "date_joined": result[0].date_joined.strftime("%Y-%m-%d"),
+                    "date_left": date_left,
+                    "resident_id": result[0].resident_id,
+                    "building_id": result[0].building_id,
+                    "building": result[1]
+                }
+            )
+        return residents_json_list
+
     def convert_to_date_obj(self, date):
         return datetime.strptime(date, "%Y-%m-%d")
 
@@ -94,20 +116,32 @@ def get_residents(
     ):
         try:
             if resident_id:
-                residents_results = Residents.query.filter_by(resident_id=resident_id)
+                residents_results = (
+                    Residents.query.join(
+                        Buildings, Buildings.id == Residents.building_id
+                    )
+                    .with_entities(Residents, Buildings.name.label("building"))
+                    .filter_by(resident_id=resident_id)
+                )
             elif return_all:
-                residents_results = Residents.query.all()
+                residents_results = (
+                    Residents.query.join(
+                        Buildings, Buildings.id == Residents.building_id
+                    )
+                    .with_entities(Residents, Buildings.name.label("building"))
+                    .all()
+                )
             else:
                 residents_results = (
-                    Residents.query.limit(results_per_page)
+                    Residents.query
+                    .join(Buildings, Buildings.id == Residents.building_id)
+                    .limit(results_per_page)
                     .offset((page_number - 1) * results_per_page)
+                    .with_entities(Residents, Buildings.name.label("building"))
                     .all()
                 )
 
-            residents_results = list(
-                map(lambda resident: resident.to_dict(), residents_results)
-            )
-            return {"residents": residents_results}
+            return {"residents": self.to_residents_json_list(residents_results)}
         except Exception as postgres_error:
             raise postgres_error
 

backend/app/services/implementations/tags_service.py

@@ -2,6 +2,7 @@
 from ...models.tag import Tag
 from ...models import db
 
+
 class TagsService(ITagsService):
     """
     Tags implementation with tags management methods
@@ -19,9 +20,7 @@ def __init__(self, logger):
     def get_tags(self):
         try:
             tags_results = Tag.query.all()
-            tags_results = list(
-                map(lambda tag: tag.to_dict(), tags_results)
-            )
+            tags_results = list(map(lambda tag: tag.to_dict(), tags_results))
             return {"tags": tags_results}
         except Exception as postgres_error:
             raise postgres_error
@@ -32,14 +31,10 @@ def update_tag(self, tag_id, updated_tag):
         if name_check is not None:
             raise Exception("Tag name {name} already exists".format(name=updated_name))
         create_update_tag = Tag.query.filter_by(tag_id=tag_id).update(
-            { 
+            {
                 **updated_tag,
             }
         )
         if not create_update_tag:
-            raise Exception(
-                "Tag with id {tag_id} not found".format(
-                    tag_id=tag_id
-                )
-            )
-        db.session.commit()
+            raise Exception("Tag with id {tag_id} not found".format(tag_id=tag_id))
+        db.session.commit()

backend/app/services/interfaces/residents_service.py

@@ -7,21 +7,21 @@ class IResidentsService(ABC):
     """
 
     @abstractmethod
-    def add_resident(self, id, initial, room_num, date_joined, date_left, building):
+    def add_resident(self, id, initial, room_num, date_joined, date_left, building_id):
         """
         Add a resident to the database
         :param id: autogenerated unique id of the resident
         :type id: int
         :param initial: initial of resident
         :type initial: string
         :param room_num: room number which the resident resides in
-        :type room_num: integer
+        :type room_num: int
         :param date_joined: the date the resident joined
         :type date_joined: date
         :param date_left: the date the resident left, if exists
         :type date_left: date
-        :param building: the building in which the resident is staying
-        :type building: Enum("144", "402", "362)
+        :param building_id: the building_id in which the resident is staying
+        :type building_id: int
         :raises Exception: if resident creation fails
         """
         pass

backend/app/services/interfaces/tags_service.py

@@ -12,7 +12,7 @@ def get_tags(self):
         Gets tags in json format.
         """
         pass
-    
+
     @abstractmethod
     def update_tag(self, tag_id, updated_tag):
         """
@@ -22,4 +22,4 @@ def update_tag(self, tag_id, updated_tag):
             tag_id (int): tag ID of the tag that is to be updated
             updated_tag (json): json object that contains the info of the tag that is to be updated
         """
-        pass
+        pass

backend/migrations/versions/a5d22b31faab_add_resident_table.py

@@ -25,8 +25,10 @@ def upgrade():
         sa.Column("room_num", sa.Integer(), nullable=False),
         sa.Column("date_joined", sa.DateTime(timezone=True), nullable=False),
         sa.Column("date_left", sa.DateTime(timezone=True), nullable=True),
-        sa.Column(
-            "building", sa.Enum("144", "402", "362", name="buildings"), nullable=False
+        sa.Column("building_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["building_id"],
+            ["buildings.id"],
         ),
         sa.PrimaryKeyConstraint("id"),
     )
@@ -48,7 +50,6 @@ def upgrade():
 
 def downgrade():
     # ### commands auto generated by Alembic - please adjust! ###
-    op.drop_constraint("check_date_left_valid", "residents", type_="check")
     with op.batch_alter_table("log_records", schema=None) as batch_op:
         batch_op.add_column(
             sa.Column(

backend/migrations/versions/c24644595836_adding_buildings_table.py

@@ -0,0 +1,34 @@
+"""adding buildings table
+
+Revision ID: c24644595836
+Revises: a5d22b31faab
+Create Date: 2023-06-26 23:12:08.724039
+
+"""
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "c24644595836"
+down_revision = "58313513d17f"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "buildings",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("address", sa.String(), nullable=False),
+        sa.Column("name", sa.String(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("buildings")
+    # ### end Alembic commands ###