assignment.router.ts

// Libraries
import multer from 'multer'
import express from 'express'

// Middleware
import validator from './assignment.validator'
import { asInt } from '../../middleware/validator/generic.validator'

// Controller
import AssignmentsController from './assignment.controller'
import { isAuthorized, isAuthorizedByAssignmentStatus } from '../../authorization/authorization.middleware'

const Router = express.Router({ mergeParams: true })
const upload = multer({ limits: { fileSize: 1024 * 1024 * 5 } }) // 5MB file size limit

/**
 * @swagger
 * /course/:courseId/assignments/released:
 *   get:
 *     summary: Retrieve a list of a course's assignments that have been released (Start date prior to current time)
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: OK
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 */
Router.get('/released', isAuthorized('assignmentViewReleased'), AssignmentsController.getReleased)

/**
 * @swagger
 * /course/:courseId/assignments:
 *   get:
 *     summary: Retrieve a list of a course's assignments
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: OK
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 */
Router.get('/', isAuthorized('assignmentViewAll'), AssignmentsController.getByCourse)

/**
 * @swagger
 * /course/:courseId/assignments/attachments/{assignmentId}/{filename}:
 *   get:
 *     summary: Retrieve an attachment for assignment
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: OK
 *       '400':
 *         description: Missing the 'assignment id' or 'course id' or 'filename'
 *       '404':
 *         description: file not found or not part of the assigment
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 *       - name: assignmentId
 *         in: path
 *         description: Enter assignment id
 *         required: true
 *         schema:
 *           type: integer
 *       - name: filename
 *         in: path
 *         description: Enter filename hash
 *         required: true
 *         schema:
 *           type: string
 */
Router.get('/attachments/:assignmentId/:filename', isAuthorizedByAssignmentStatus, AssignmentsController.handleAttachmentLink)

/**
 * @swagger
 * /course/:courseId/assignments/{id}:
 *   get:
 *     summary: Retrieve a single assignment
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: OK
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 *       - name: id
 *         in: path
 *         description: Enter assignment id
 *         required: true
 *         schema:
 *           type: integer
 */
Router.get('/:assignmentId', asInt('assignmentId'), isAuthorizedByAssignmentStatus, AssignmentsController.detail)

/**
 * @swagger
 * /course/:courseId/assignments:
 *   post:
 *     summary: Create an assignment
 *     tags:
 *       - Assignments
 *     responses:
 *       '201':
 *         description: Created
 *       '400':
 *         description: Bad Request
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 *     requestBody:
 *       content:
 *         application/x-www-form-urlencoded:
 *           schema:
 *             type: object
 *             required: [courseId, name, categoryName, maxFileSize, disableHandins, startDate, dueDate, endDate]
 *             properties:
 *               courseId:
 *                 type: integer
 *               name:
 *                 type: string
 *                 maxLength: 128
 *               categoryName:
 *                 type: string
 *                 maxLength: 128
 *               description:
 *                 type: string
 *                 nullable: true
 *               maxFileSize:
 *                 type: integer
 *               maxSubmissions:
 *                 type: integer
 *                 nullable: true
 *               disableHandins:
 *                 type: boolean
 *               startDate:
 *                 type: string
 *                 format: date-time
 *               dueDate:
 *                 type: string
 *                 format: date-time
 *               endDate:
 *                 type: string
 *                 format: date-time
 *               scoringType:
 *                 type: string
 *                 enum: [highest-score, latest-submission, no-score]
 *                 default: highest-score
 *                 description: Determines how the final score is chosen for the assignment
 */


Router.post('/', isAuthorized('assignmentEditAll'), upload.array('files', 5), validator, AssignmentsController.post)

/**
 * @swagger
 * /course/:courseId/assignments/{id}:
 *   put:
 *     summary: Update an assignment
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: Updated
 *       '404':
 *         description: Not Found
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 *       - name: id
 *         in: path
 *         required: true
 *         schema:
 *           type: integer
 *     requestBody:
 *       content:
 *         application/x-www-form-urlencoded:
 *           schema:
 *             type: object
 *             properties:
 *               name:
 *                 type: string
 *                 maxLength: 128
 *               categoryName:
 *                 type: string
 *                 maxLength: 128
 *               description:
 *                 type: string
 *                 nullable: true
 *               maxFileSize:
 *                 type: integer
 *               maxSubmissions:
 *                 type: integer
 *                 nullable: true
 *               disableHandins:
 *                 type: boolean
 *               startDate:
 *                 type: string
 *                 format: date-time
 *               dueDate:
 *                 type: string
 *                 format: date-time
 *               endDate:
 *                 type: string
 *                 format: date-time
 *               scoringType:
 *                 type: string
 *                 enum: [highest-score, latest-submission, no-score]
 *                 description: Determines how the final score is chosen for the assignment
 */
Router.put(
  '/:assignmentId',
  isAuthorized('assignmentEditAll'),
  asInt('assignmentId'),
  upload.array('files', 5),
  validator,
  AssignmentsController.put,
)

/**
 * @swagger
 * /course/:courseId/assignments/{id}:
 *   delete:
 *     summary: Delete an assignment
 *     tags:
 *       - Assignments
 *     responses:
 *       '200':
 *         description: OK
 *     parameters:
 *       - name: courseId
 *         in: path
 *         description: Enter course id
 *         required: true
 *         schema:
 *           type: integer
 *       - name: id
 *         in: path
 *         required: true
 *         schema:
 *           type: integer
 */
Router.delete('/:assignmentId', isAuthorized('assignmentEditAll'), asInt('assignmentId'), AssignmentsController._delete)

export default Router