Merge branch 'develop' of https://github.com/makeopensource/devU into #121-Link-Matching-pair-page-into-edit-assignment

Author: SameepK

devU-api/src/entities/assignment/assignment.model.ts

@@ -11,6 +11,8 @@ import {
 
 import CourseModel from '../course/course.model'
 
+import { ScoringType } from 'devu-shared-modules'
+
 @Entity('assignments')
 export default class AssignmentModel {
   /**
@@ -58,6 +60,11 @@ export default class AssignmentModel {
    *          type: string
    *          array: true
    *          description: filenames of stored attachments, matches the index of the fileHashes, i.e. filename[i] is the name of hash[i]
+ *        scoringType:
+ *          type: string
+ *          enum: [highest-score, latest-submission, no-score]
+ *          default: highest-score
+ *          description: Determines how the final score is chosen for the assignment
    */
 
   @PrimaryGeneratedColumn()
@@ -109,4 +116,12 @@ export default class AssignmentModel {
 
   @Column({ name: 'attachmentsFilenames', array: true, default: [], type: 'text', nullable: false })
   attachmentsFilenames: string[]
+
+  @Column({
+    type: 'enum',
+    enum: ScoringType,
+    default: ScoringType.HIGHEST_SCORE,
+    name: 'scoring_type'
+  })
+  scoringType: ScoringType
 }

devU-api/src/entities/assignment/assignment.router.ts

@@ -123,8 +123,10 @@ Router.get('/:assignmentId', asInt('assignmentId'), isAuthorizedByAssignmentStat
  *     tags:
  *       - Assignments
  *     responses:
- *       '200':
- *         description: OK
+ *       '201':
+ *         description: Created
+ *       '400':
+ *         description: Bad Request
  *     parameters:
  *       - name: courseId
  *         in: path
@@ -136,7 +138,41 @@ Router.get('/:assignmentId', asInt('assignmentId'), isAuthorizedByAssignmentStat
  *       content:
  *         application/x-www-form-urlencoded:
  *           schema:
- *             $ref: '#/components/schemas/Assignment'
+ *             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
  */
 
 
@@ -151,7 +187,9 @@ Router.post('/', isAuthorized('assignmentEditAll'), upload.array('files', 5), va
  *       - Assignments
  *     responses:
  *       '200':
- *         description: OK
+ *         description: Updated
+ *       '404':
+ *         description: Not Found
  *     parameters:
  *       - name: courseId
  *         in: path
@@ -168,7 +206,37 @@ Router.post('/', isAuthorized('assignmentEditAll'), upload.array('files', 5), va
  *       content:
  *         application/x-www-form-urlencoded:
  *           schema:
- *             $ref: '#/components/schemas/Assignment'
+ *             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',

devU-api/src/entities/assignment/assignment.serializer.ts

@@ -17,7 +17,8 @@ export function serialize(assignment: AssignmentModel): Assignment {
     disableHandins: assignment.disableHandins,
     createdAt: assignment.createdAt.toISOString(),
     updatedAt: assignment.updatedAt.toISOString(),
+    scoringType: assignment.scoringType,
     attachmentsHashes: assignment.attachmentsHashes,
-    attachmentsFilenames: assignment.attachmentsFilenames
+    attachmentsFilenames: assignment.attachmentsFilenames,
   }
 }

devU-api/src/entities/assignment/assignment.service.ts

@@ -28,6 +28,7 @@ export async function update(assignment: Assignment) {
     disableHandins,
     attachmentsHashes,
     attachmentsFilenames,
+    scoringType,
   } = assignment
 
   if (!id) throw new Error('Missing Id')
@@ -44,6 +45,7 @@ export async function update(assignment: Assignment) {
     disableHandins,
     attachmentsHashes,
     attachmentsFilenames,
+    scoringType,
   })
 }
 
@@ -112,8 +114,6 @@ async function processFiles(req: Request) {
     } else {
       console.warn(`Files where not in array format ${req.files}`)
     }
-  } else {
-    console.warn(`No files where processed`)
   }
 
   return { fileHashes, fileNames }

devU-api/src/entities/assignment/assignment.validator.ts

@@ -2,6 +2,7 @@ import { check } from 'express-validator'
 
 import validate from '../../middleware/validator/generic.validator'
 import { isBeforeParam, isAfterParam } from '../../middleware/validator/date.validator'
+import { ScoringType } from 'devu-shared-modules'
 
 const courseId = check('courseId').isNumeric()
 const name = check('name').isString().trim().isLength({ max: 128 })
@@ -10,6 +11,10 @@ const description = check('description').isString().trim()
 const maxFileSize = check('maxFileSize').isNumeric()
 const maxSubmissions = check('maxSubmissions').isNumeric().optional({ nullable: true })
 const disableHandins = check('disableHandins').isBoolean()
+const scoringType = check('scoringType')
+  .optional()
+  .isIn(Object.values(ScoringType))
+  .withMessage(`scoringType must be one of: ${Object.values(ScoringType).join(', ')}`)
 
 const startDate = check('startDate')
   .trim()
@@ -43,6 +48,7 @@ const validator = [
   maxFileSize,
   maxSubmissions,
   disableHandins,
+  scoringType,
   validate,
 ]
 

devU-api/src/entities/assignmentProblem/assignmentProblem.controller.ts

@@ -1,4 +1,4 @@
-import { Request, Response, NextFunction } from 'express'
+import { NextFunction, Request, Response } from 'express'
 
 import AssignmentProblemService from './assignmentProblem.service'
 
@@ -33,15 +33,21 @@ export async function detail(req: Request, res: Response, next: NextFunction) {
   }
 }
 
-export async function post(req: Request, res: Response, next: NextFunction) {
+export async function post(req: Request, res: Response, _: NextFunction) {
   try {
-    const assignmentProblem = await AssignmentProblemService.create(req.body)
+    req.body.assignmentId = parseInt(req.params.assignmentId)
+    const assignmentProblem = await AssignmentProblemService.create(
+      req.body.assignmentId,
+      req.body.problemName,
+      req.body.maxScore,
+      req.body.metadata,
+    )
     const response = serialize(assignmentProblem)
 
     res.status(201).json(response)
   } catch (err) {
     if (err instanceof Error) {
-        res.status(400).json(new GenericResponse(err.message))
+      res.status(400).json(new GenericResponse(err.message))
     }
   }
 }

devU-api/src/entities/assignmentProblem/assignmentProblem.model.ts

@@ -28,6 +28,9 @@ export default class AssignmentProblemModel {
    *          type: integer
    *        problemName:
    *          type: string
+   *        metadata:
+   *          type: string
+   *          description: A json string containing additional problem metadata
    *        maxScore:
    *          type: integer
    */
@@ -43,6 +46,9 @@ export default class AssignmentProblemModel {
   @Column({ name: 'problem_name', length: 128 })
   problemName: string
 
+  @Column({ name: 'metadata', type: 'jsonb', nullable: true, default: {} })
+  metadata: any // use any since this can be any arbitrary structure
+
   @Column({ name: 'max_score' })
   maxScore: number
 

devU-api/src/entities/assignmentProblem/assignmentProblem.router.ts

@@ -21,6 +21,24 @@ const Router = express.Router({ mergeParams: true })
  *     responses:
  *       '200':
  *         description: OK
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: array
+ *               items:
+ *                 type: object
+ *                 properties:
+ *                   id:
+ *                     type: integer
+ *                   assignmentId:
+ *                     type: integer
+ *                   problemName:
+ *                     type: string
+ *                   metadata:
+ *                     type: string
+ *                     description: A json string containing additional problem metadata
+ *                   maxScore:
+ *                     type: integer
  *     parameters:
  *       - name: assignmentId
  *         description: Enter Assignment Id
@@ -43,6 +61,22 @@ Router.get('/', isAuthorized('enrolled'), AssignmentProblemController.get)
  *     responses:
  *       '200':
  *         description: OK
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 id:
+ *                   type: integer
+ *                 assignmentId:
+ *                   type: integer
+ *                 problemName:
+ *                   type: string
+ *                 metadata:
+ *                   type: string
+ *                   description: A json string containing additional problem metadata
+ *                 maxScore:
+ *                   type: integer
  *     parameters:
  *       - name: id
  *         description: Enter AssignmentProblem Id
@@ -63,8 +97,33 @@ Router.get('/:id', isAuthorized('assignmentEditAll'), asInt(), AssignmentProblem
  *     tags:
  *       - AssignmentProblems
  *     responses:
- *       '200':
- *         description: OK
+ *       '201':
+ *         description: Created
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 id:
+ *                   type: integer
+ *                 assignmentId:
+ *                   type: integer
+ *                 problemName:
+ *                   type: string
+ *                 metadata:
+ *                   type: string
+ *                   description: A json string containing additional problem metadata
+ *                 maxScore:
+ *                   type: integer
+ *       '400':
+ *         description: Bad Request
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
  *     requestBody:
  *       content:
  *         application/x-www-form-urlencoded:
@@ -75,14 +134,37 @@ Router.post('/', isAuthorized('assignmentEditAll'), validator, AssignmentProblem
 
 /**
  * @swagger
- * /course/:courseId/assignment/:assignmentId/assignment-problems:
+ * /course/:courseId/assignment/:assignmentId/assignment-problems/{id}:
  *   put:
  *     summary: Update an assignment problem
  *     tags:
  *       - AssignmentProblems
  *     responses:
  *       '200':
  *         description: OK
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *       '404':
+ *         description: Not Found
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *     parameters:
+ *       - name: id
+ *         description: Enter AssignmentProblem Id
+ *         in: path
+ *         required: true
+ *         schema:
+ *           type: integer
  *     requestBody:
  *       content:
  *         application/x-www-form-urlencoded:

devU-api/src/entities/assignmentProblem/assignmentProblem.serializer.ts

@@ -8,6 +8,7 @@ export function serialize(assignmentProblem: AssignmentProblemModel): Assignment
     assignmentId: assignmentProblem.assignmentId,
     problemName: assignmentProblem.problemName,
     maxScore: assignmentProblem.maxScore,
+    metadata: assignmentProblem.metadata,
     createdAt: assignmentProblem.createdAt.toISOString(),
     updatedAt: assignmentProblem.updatedAt.toISOString(),
   }