Merge pull request #38 from jadmsaadaot/SUBMIT-task#30

Handle inserting projects to account and getting projects by account

submit-api/migrations/versions/0223afc14044_.py

@@ -1,4 +1,4 @@
-"""empty message
+"""Create account, role, account_project, account_user, account_role, project_team tables
 
 Revision ID: 0223afc14044
 Revises: 20bcb68bc2ac

submit-api/migrations/versions/20bcb68bc2ac_.py

@@ -1,4 +1,4 @@
-"""
+"""Create staff_users table
 
 Revision ID: 20bcb68bc2ac
 Revises: 

submit-api/migrations/versions/6dfc3501adbb_.py

@@ -1,4 +1,4 @@
-"""empty message
+"""Add description column to roles table
 
 Revision ID: 6dfc3501adbb
 Revises: 0223afc14044

submit-api/migrations/versions/8e112bda0a34_.py

@@ -1,4 +1,4 @@
-"""empty message
+"""Add unique constraint to account proponent_id
 
 Revision ID: 8e112bda0a34
 Revises: 97de805275ec

submit-api/migrations/versions/97de805275ec_.py

@@ -1,4 +1,4 @@
-"""empty message
+"""Add ACCOUNT_PRIMARY_ADMIN role
 
 Revision ID: 97de805275ec
 Revises: 6dfc3501adbb

submit-api/migrations/versions/a4785881834c_.py

@@ -0,0 +1,43 @@
+"""Add projects table
+
+Revision ID: a4785881834c
+Revises: 5a6eda61c0c4
+Create Date: 2024-08-19 17:45:56.220026
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = 'a4785881834c'
+down_revision = '5a6eda61c0c4'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('projects',
+    sa.Column('id', sa.Integer(), autoincrement=True, nullable=False),
+    sa.Column('name', sa.String(), nullable=False),
+    sa.Column('proponent_id', sa.String(), nullable=False),
+    sa.Column('proponent_name', sa.String(), nullable=False),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('proponent_id')
+    )
+    with op.batch_alter_table('account_projects', schema=None) as batch_op:
+        batch_op.create_foreign_key(None, 'projects', ['project_id'], ['id'])
+        batch_op.drop_column('name')
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('account_projects', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('name', sa.VARCHAR(), autoincrement=False, nullable=False))
+        batch_op.drop_constraint(None, type_='foreignkey')
+
+    op.drop_table('projects')
+    # ### end Alembic commands ###

submit-api/migrations/versions/b79603b76ea0_.py

@@ -0,0 +1,42 @@
+"""Change proponent_id column type to integer
+
+Revision ID: b79603b76ea0
+Revises: a4785881834c
+Create Date: 2024-08-20 15:17:44.896108
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'b79603b76ea0'
+down_revision = 'a4785881834c'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('accounts', schema=None) as batch_op:
+        batch_op.alter_column('proponent_id',
+               existing_type=sa.VARCHAR(),
+               type_=sa.Integer(),
+               existing_nullable=False,
+               postgresql_using='proponent_id::integer')
+
+    with op.batch_alter_table('projects', schema=None) as batch_op:
+        batch_op.alter_column('proponent_id',
+               existing_type=sa.VARCHAR(),
+               type_=sa.Integer(),
+               existing_nullable=False,
+               postgresql_using='proponent_id::integer')
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    pass
+
+    # ### end Alembic commands ###

submit-api/src/submit_api/models/__init__.py

@@ -20,5 +20,6 @@
 from .account_user import AccountUser
 from .base_model import BaseModel
 from .db import db, ma, migrate
+from .project import Project
 from .project_team import ProjectTeam
 from .role import Role

submit-api/src/submit_api/models/account.py

@@ -16,7 +16,7 @@ class Account(BaseModel):
     __tablename__ = 'accounts'
 
     id = Column(db.Integer, primary_key=True, autoincrement=True)
-    proponent_id = Column(db.String(), nullable=False, unique=True)
+    proponent_id = Column(db.Integer(), nullable=False, unique=True)
 
     @classmethod
     def get_by_proponent_id(cls, proponent_id) -> Account:

submit-api/src/submit_api/models/account_project.py

@@ -17,8 +17,7 @@ class AccountProject(BaseModel):
 
     id = Column(db.Integer, primary_key=True, autoincrement=True)
     account_id = Column(db.Integer, ForeignKey('accounts.id'), nullable=False)
-    project_id = Column(db.Integer, nullable=False)
-    name = Column(db.String(), nullable=False)
+    project_id = Column(db.Integer, ForeignKey('projects.id'), nullable=False)
 
     @classmethod
     def add_projects_bulk(cls, projects):

submit-api/src/submit_api/models/account_user.py

@@ -25,6 +25,7 @@ class AccountUser(BaseModel):
     work_email_address = Column(db.String(100), nullable=False)
     work_contact_number = Column(db.String(50), nullable=False)
     auth_guid = Column(db.String(), nullable=False, unique=True)
+    account = db.relationship('Account', foreign_keys=[account_id], lazy='joined')
 
     __table_args__ = (
         Index('ix_account_users_auth_guid', 'auth_guid', unique=True),

submit-api/src/submit_api/models/project.py

@@ -0,0 +1,62 @@
+"""Account Project model class.
+
+Manages the account project
+"""
+from __future__ import annotations
+
+from sqlalchemy import Column, event
+from sqlalchemy.exc import ArgumentError, IntegrityError
+
+from submit_api.exceptions import PermissionDeniedError
+
+from .db import db
+
+
+class Project(db.Model):
+    """Definition of the Project entity."""
+
+    __tablename__ = 'projects'
+
+    id = Column(db.Integer, primary_key=True, autoincrement=True)
+    name = Column(db.String(), nullable=False)
+    proponent_id = Column(db.Integer(), nullable=False, unique=True)
+    proponent_name = Column(db.String(), nullable=False)
+
+    def __init__(self, **kwargs):
+        """Initialize the Project entity."""
+        raise ArgumentError("Project is read-only, cannot create new instances.")
+
+    @classmethod
+    def get_all_projects_in_ids(cls, project_ids):
+        """Get all projects in the given project ids."""
+        return cls.query.filter(cls.id.in_(project_ids)).all()
+
+
+@event.listens_for(Project, 'before_insert')
+def before_insert():
+    """Raise an error when trying to insert into the Project table."""
+    raise IntegrityError(
+        "Insertions are not allowed on this table",
+        params=None,
+        orig=PermissionDeniedError('Insertions are not allowed on this table')
+    )
+
+
+@event.listens_for(Project, 'before_update')
+def before_update():
+    """Raise an error when trying to update the Project table."""
+    raise IntegrityError(
+        "Updates are not allowed on this table",
+        params=None,
+        orig=PermissionDeniedError('Updates are not allowed on this table')
+    )
+
+
+@event.listens_for(Project, 'before_delete')
+def before_delete():
+    """Raise an error when trying to delete from the Project table."""
+    raise IntegrityError(
+        "Deletions are not allowed on this table",
+        params=None,
+        orig=PermissionDeniedError('Deletions are not allowed on this table')
+    )

submit-api/src/submit_api/models/queries/account_user.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 """Model to handle all complex operations related to User."""
-from submit_api.models import AccountUser, db
+from submit_api.models import AccountUser, db, Account
 
 
 # pylint: disable=too-few-public-methods
@@ -24,5 +24,6 @@ def get_by_guid(cls, guid: str):
         """Find user by guid"""
         result = (db.session.query(AccountUser)
                   .filter(AccountUser.auth_guid == guid)
+                  .join(Account)
                   .first())
         return result

submit-api/src/submit_api/models/queries/project.py

@@ -0,0 +1,36 @@
+# Copyright © 2024 Province of British Columbia
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+"""Model to handle all complex operations related to User."""
+from submit_api.models import db, AccountProject, Project
+
+
+# pylint: disable=too-few-public-methods
+class ProjectQueries:
+    """Query module for complex projects queries"""
+
+    @classmethod
+    def get_projects_by_account_id(cls, account_id: int):
+        """Find projects by account_id"""
+        result = (db.session.query(AccountProject)
+                  .filter(AccountProject.account_id == account_id)
+                  .join(Project)
+                  .first())
+        return result
+
+    @classmethod
+    def get_projects_by_proponent_id(cls, proponent_id: int):
+        """Find projects by proponent_id"""
+        result = (db.session.query(Project)
+                  .filter(Project.proponent_id == proponent_id))
+        return result

submit-api/src/submit_api/resources/account.py

@@ -65,7 +65,7 @@ def post():
 
 
 @cors_preflight("GET, OPTIONS")
-@API.route("/proponent/<proponent_id>", methods=["GET", "OPTIONS"])
+@API.route("/proponent/<int:proponent_id>", methods=["GET", "OPTIONS"])
 @API.doc(params={"proponent_id": "The account identifier"})
 class User(Resource):
     """Resource for managing a single account"""

submit-api/src/submit_api/resources/project.py

@@ -37,18 +37,46 @@
 
 
 @cors_preflight("GET, OPTIONS, POST")
-@API.route("", methods=["POST", "GET", "OPTIONS"])
-class Projects(Resource):
+@API.route("/accounts/<int:account_id>", methods=["POST", "GET", "OPTIONS"])
+class ProjectsByAccount(Resource):
     """Resource for managing projects."""
 
+    @staticmethod
+    @ApiHelper.swagger_decorators(API, endpoint_description="Get projects by account id")
+    @API.expect(project_add_list)
+    @API.response(code=HTTPStatus.CREATED, model=project_list_model, description="Get projects")
+    @API.response(HTTPStatus.BAD_REQUEST, "Bad Request")
+    @cors.crossdomain(origin="*")
+    def get(account_id):
+        """Get projects by account id."""
+        projects = ProjectService.get_projects_by_account_id(account_id)
+        return ProjectSchema(many=True).dump(projects), HTTPStatus.OK
+
     @staticmethod
     @ApiHelper.swagger_decorators(API, endpoint_description="Add projects in bulk")
     @API.expect(project_add_list)
     @API.response(code=HTTPStatus.CREATED, model=project_list_model, description="Added projects")
     @API.response(HTTPStatus.BAD_REQUEST, "Bad Request")
     @cors.crossdomain(origin="*")
-    def post():
+    def post(account_id):
         """Add projects in bulk."""
-        projects_data = AddProjectSchema(many=True).load(API.payload)
-        added_projects = ProjectService.bulk_add_projects(projects_data)
+        projects_data = AddProjectSchema().load(API.payload)
+        added_projects = ProjectService.bulk_add_projects(account_id, projects_data.get("project_ids"))
         return ProjectSchema(many=True).dump(added_projects), HTTPStatus.CREATED
+
+
+@cors_preflight("GET, OPTIONS, POST")
+@API.route("/proponents/<int:proponent_id>", methods=["POST", "GET", "OPTIONS"])
+class Projects(Resource):
+    """Resource for managing projects."""
+
+    @staticmethod
+    @ApiHelper.swagger_decorators(API, endpoint_description="Get projects by proponent id")
+    @API.expect(project_add_list)
+    @API.response(code=HTTPStatus.CREATED, model=project_list_model, description="Get projects")
+    @API.response(HTTPStatus.BAD_REQUEST, "Bad Request")
+    @cors.crossdomain(origin="*")
+    def get(proponent_id):
+        """Get projects by proponent id."""
+        projects = ProjectService.get_projects_by_proponent_id(proponent_id)
+        return ProjectSchema(many=True).dump(projects), HTTPStatus.OK

submit-api/src/submit_api/schemas/account.py

@@ -15,7 +15,7 @@ class Meta:  # pylint: disable=too-few-public-methods
         unknown = EXCLUDE
 
     id = fields.Int(data_key="id")
-    proponent_id = fields.Str(data_key="proponent_id")
+    proponent_id = fields.Int(data_key="proponent_id")
 
 
 class AccountCreateSchema(Schema):
@@ -31,5 +31,5 @@ class Meta:  # pylint: disable=too-few-public-methods
     work_email_address = fields.Str(data_key="work_email_address")
     work_contact_number = fields.Str(data_key="work_contact_number")
     position = fields.Str(data_key="position")
-    proponent_id = fields.Str(data_key="proponent_id")
+    proponent_id = fields.Int(data_key="proponent_id")
     auth_guid = fields.Str(data_key="auth_guid")

submit-api/src/submit_api/schemas/project.py

@@ -16,8 +16,8 @@ class Meta:  # pylint: disable=too-few-public-methods
 
     id = fields.Int(data_key="id")
     name = fields.Str(data_key="name")
-    project_id = fields.Str(data_key="project_id")
-    account_id = fields.Str(data_key="account_id")
+    proponent_id = fields.Int(data_key="proponent_id")
+    proponent_name = fields.Str(data_key="proponent_name")
 
 
 class AddProjectSchema(Schema):
@@ -28,6 +28,4 @@ class Meta:  # pylint: disable=too-few-public-methods
 
         unknown = EXCLUDE
 
-    name = fields.Str(data_key="name")
-    project_id = fields.Int(data_key="project_id")
-    account_id = fields.Int(data_key="account_id")
+    project_ids = fields.List(fields.Int(), data_key="project_ids")

submit-api/src/submit_api/schemas/user.py

@@ -5,6 +5,8 @@
 
 from marshmallow import EXCLUDE, Schema, fields
 
+from submit_api.schemas.account import AccountSchema
+
 
 class UserSchema(Schema):
     """User schema."""
@@ -20,3 +22,4 @@ class Meta:  # pylint: disable=too-few-public-methods
     work_email_address = fields.Str(data_key="email_address")
     work_contact_number = fields.Str(data_key="contact_number")
     account_id = fields.Int(data_key="account_id")
+    account = fields.Nested(AccountSchema, data_key="account", dump_only=True)