Add CRUD capabilities for a supervisor who is assigned students and a single teacher

[ghost]

Please note, Sherpa may occasionally provide incomplete or inaccurate information. Always verify critical details and double-check suggested changes before implementation.

Problem Summary

The issue is to add CRUD (Create, Read, Update, Delete) capabilities for a supervisor who is assigned students and a single teacher within the bit-backend repository. This involves creating or modifying existing endpoints and possibly database models to support these operations.

Relevant Files

• backend/models.py: Defines the data models, including Classroom, Student, and Teacher, which are likely related to supervisors.
• backend/classrooms/decorators.py: Contains decorators that may be used for access control and validation.
• backend/classrooms/schemas.py: Defines schemas for serializing and validating classroom data.
• backend/classrooms/utils.py: Contains utility functions for classroom operations.
• backend/classrooms/views.py: Manages classroom-related API endpoints, where CRUD operations for supervisors might be implemented.

Changes Required

backend/models.py

• Add a Supervisor Model: Define a new Supervisor model if it doesn't exist. It should have relationships with Student and Teacher.

  class Supervisor(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    students = db.relationship('Student', back_populates='supervisor')
    teacher_id = db.Column(db.Integer, db.ForeignKey('teacher.id'))
    teacher = db.relationship('Teacher', back_populates='supervisors')

backend/classrooms/decorators.py

• Access Control: Implement or modify decorators to ensure only authorized users (e.g., supervisors) can perform CRUD operations.

backend/classrooms/schemas.py

• Supervisor Schema: Create a schema to serialize and validate supervisor data.

  class SupervisorSchema(ma.Schema):
    id = fields.Int(required=True)
    students = fields.Nested(StudentSchema, many=True)
    teacher = fields.Nested(TeacherSchema)

backend/classrooms/utils.py

• Utility Functions: Add functions to handle CRUD operations for supervisors.

  def create_supervisor(data):
    supervisor = Supervisor(**data)
    db.session.add(supervisor)
    db.session.commit()
    return supervisor

backend/classrooms/views.py

• API Endpoints: Implement API endpoints for supervisor CRUD operations.

  class SupervisorCRUD(Resource):
    def get(self, supervisor_id):
        supervisor = Supervisor.query.get(supervisor_id)
        return SupervisorSchema().dump(supervisor)
  
    def post(self):
        data = request.get_json()
        supervisor = create_supervisor(data)
        return SupervisorSchema().dump(supervisor), 201
  
    def put(self, supervisor_id):
        data = request.get_json()
        supervisor = Supervisor.query.get(supervisor_id)
        # Update logic here
        db.session.commit()
        return SupervisorSchema().dump(supervisor)
  
    def delete(self, supervisor_id):
        supervisor = Supervisor.query.get(supervisor_id)
        db.session.delete(supervisor)
        db.session.commit()
        return '', 204

Next Steps

1. Model Adjustments: Verify and adjust the data models to ensure all necessary relationships for supervisors are established.
2. Schema and Validation: Ensure new schemas are properly defined for data validation.
3. API Implementation: Implement the CRUD endpoints and test them for expected behavior.
4. Access Control: Apply necessary access control to protect the endpoints.
5. Testing: Write unit and integration tests to ensure the new functionality works as expected.

By following these steps, you will be able to add CRUD capabilities for supervisors in your application.