Merge branch 'develop' into feature/561/add-category-field-to-lesson,…

…attachment,quiz-models

consts/errors.js

@@ -56,6 +56,10 @@ const errors = {
     code: 'FORBIDDEN',
     message: 'You do not have permission to perform this action.'
   },
+  BAD_REQUEST: {
+    code: 'BAD_REQUEST',
+    message: 'The request could not be processed due to invalid or missing parameters.'
+  },
   BAD_CONFIRM_TOKEN: {
     code: 'BAD_CONFIRM_TOKEN',
     message: 'The confirm token is either invalid or has expired.'

consts/models.js

@@ -15,7 +15,8 @@ const refs = {
   COURSE: 'Course',
   QUIZ: 'Quiz',
   FINISHED_QUIZ: 'FinishedQuiz',
-  ATTACHMENT: 'Attachment'
+  ATTACHMENT: 'Attachment',
+  QUESTION: 'Question'
 }
 
 module.exports = refs

controllers/attachment.js

@@ -16,6 +16,26 @@ const getAttachments = async (req, res) => {
   res.status(200).json(attachments)
 }
 
+const createAttachments = async (req, res) => {
+  const { id: author } = req.user
+  const { description } = req.body
+  const files = req.files
+
+  const attachments = await attachmentService.createAttachments({ author, files, description })
+
+  res.status(201).json(attachments)
+}
+
+const updateAttachment = async (req, res) => {
+  const { id } = req.params
+  const { id: currentUser } = req.user
+  const { fileName } = req.body
+
+  await attachmentService.updateAttachment(id, currentUser, fileName)
+
+  res.status(204).end()
+}
+
 const deleteAttachment = async (req, res) => {
   const { id } = req.params
   const { id: currentUser } = req.user
@@ -27,5 +47,7 @@ const deleteAttachment = async (req, res) => {
 
 module.exports = {
   getAttachments,
+  createAttachments,
+  updateAttachment,
   deleteAttachment
 }

controllers/quiz.js

@@ -31,8 +31,19 @@ const createQuiz = async (req, res) => {
   res.status(201).send(newQuiz)
 }
 
+const updateQuiz = async (req, res) => {
+  const { id } = req.params
+  const { id: currentUserId } = req.user
+  const updateData = req.body
+
+  await quizService.updateQuiz(id, currentUserId, updateData)
+
+  res.status(204).end()
+}
+
 module.exports = {
   getQuizzes,
   getQuizById,
-  createQuiz
+  createQuiz,
+  updateQuiz
 }

docs/attachments/attachment.yaml

@@ -44,7 +44,6 @@ paths:
                     author: 648afee884936e09a37deaaa
                     fileName: EnglishB2Level
                     link: 'https://english-b2-test.com'
-                    description: This is basic B2 level English test.
                     size: 230
                     category: [3da8767c9ad4c9a0b0eacd3]
                     createdAt: 2023-02-14T23:44:21.334Z
@@ -69,7 +68,132 @@ paths:
                 status: 403
                 code: FORBIDDEN
                 message: You do not have permission to perform this action.
+    post:
+      security:
+        - bearerAuth: []
+      tags:
+        - Attachments
+      summary: Create new attachments.
+      description: Saves new attachments to the database.
+      consumes:
+        - multipart/form-data
+      parameters:
+        - in: formData
+          name: files
+          type: file
+          description: Array of files to upload
+          required: true
+        - in: formData
+          name: description
+          type: string
+          description: Description for the attachment
+          required: false
+      responses:
+        201:
+          description: Created
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/definitions/attachment'
+              example:
+                - _id: 8755bc080a00adr9243df104
+                  author: 6255bc080a75adf9223df100
+                  fileName: attachment1.pdf
+                  link: '154867-attachment1.pdf'
+                  description: This is an example attachment description.
+                  size: 1024
+                  createdAt: '2023-08-13T12:34:56.789Z'
+                  updatedAt: '2023-08-13T12:34:56.789Z'
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 400
+                code: INVALID_REQUEST
+                message: Invalid request parameters.
+        401:
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 401
+                code: UNAUTHORIZED
+                message: The requested URL requires user authorization.
   /attachments/{id}:
+    patch:
+      security:
+        - bearerAuth: []
+      tags:
+        - Attachments
+      summary: Finds and updates an attachment.
+      description: Updates an attachment by ID which is restricted only to the tutor
+      produces:
+        - application/json
+      requestBody:
+        required: true
+        description: Data for update the attachment.
+        content:
+          application/json:
+            schema:
+              $ref: '#/definitions/attachmentBody'
+            example:
+              fileName: File1
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: ID of the attachment that needs to be updated
+          type: string
+      responses:
+        204:
+          description: No Content
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 400
+                code: INVALID_ID
+                message: ID is invalid.
+        401:
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 401
+                code: UNAUTHORIZED
+                message: The requested URL requires user authorization.
+        403:
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 403
+                code: FORBIDDEN
+                message: You do not have permission to perform this action.
+        404:
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/Error'
+              example:
+                status: 404
+                code: DOCUMENT_NOT_FOUND
+                message: Attachment with the specified id was not found.
     delete:
       security:
         - bearerAuth: []

docs/attachments/attachments-schema.yaml

@@ -10,8 +10,6 @@ definitions:
           type: string
         link:
           type: string
-        description:
-          type: string
         size:
           type: number
         category:
@@ -46,8 +44,6 @@ definitions:
         type: string
       link:
         type: string
-      description:
-        type: string
       size:
         type: number
       category:

docs/finishedQuiz/finishedQuiz.yaml

@@ -1,6 +1,10 @@
 paths:
   /finished-quizzes:
     get:
+      security:
+        - bearerAuth: []
+      tags:
+        - Finished quizzes
       summary: Find all finished quizzes.
       description: Finds and returns an array with a list of all user finishedQuizzes.
       produces:

docs/lesson/lesson-schema.yaml

@@ -6,6 +6,9 @@ definitions:
         type: string
         minLength: 1
         maxLength: 100
+      content:
+        type: string
+        minLength: 50
       description:
         type: string
         minLength: 1

docs/lesson/lesson.yaml

@@ -40,6 +40,7 @@ paths:
               example:
                 title: Colors in English
                 description: With this lesson you will learn all about colors in English.
+                content: <h1>Title</h1>
                 author: 63da8767c9ad4c9a0b0eacd3
                 attachments: [63ed1cd25e9d781cdb6a6b15]
                 category: [3da8767c9ad4c9a0b0eacd3]
@@ -84,6 +85,7 @@ paths:
             example:
               title: Colors in English
               description: With this lesson you will learn all about colors in English.
+              content: <h1>Title</h1>
               author: 63da8767c9ad4c9a0b0eacd3
               attachments: [63ed1cd25e9d781cdb6a6b15]
               category: [3da8767c9ad4c9a0b0eacd3]
@@ -97,6 +99,7 @@ paths:
               example:
                 title: Colors in English
                 description: With this lesson you will learn all about colors in English.
+                content: <h1>Title</h1>
                 author: 63da8767c9ad4c9a0b0eacd3
                 attachments: [63ed1cd25e9d781cdb6a6b15]
                 category: [3da8767c9ad4c9a0b0eacd3]
@@ -149,8 +152,16 @@ paths:
               example:
                 title: Title of the lesson
                 description: Some information about this lesson
+                content: <h1>Title</h1>
                 author: 64a33e71eea95284f397a6ee
-                attachments: [63ed1cd25e9d781cdb6a6b15]
+                attachments:
+                  - _id: 63ec1cd51e9d781cdb6f4b14
+                    author: 648afee884936e09a37deaaa
+                    fileName: EnglishB2Level.pdf
+                    link: 3302931_EnglishB2Level.pdf
+                    size: 230
+                    createdAt: 2023-02-14T23:44:21.334Z
+                    updatedAt: 2023-02-14T23:44:21.334Z
                 _id: 93ec1cd51e9d781cdb6f5b56
                 createdAt: 2023-02-14T23:44:21.334Z
                 updatedAt: 2023-02-14T23:44:21.334Z

docs/questions/questions.schema.yaml

@@ -0,0 +1,58 @@
+definitions:
+  questions:
+    type: array
+    items:
+      type: object
+      properties:
+        _id:
+          type: string
+        title:
+          type: string
+        answers:
+          type: array
+          items:
+            type: object
+            text: string
+            isCorrect: boolean
+        author:
+          type: string
+          ref: '#/components/user'
+        createdAt:
+          type: string
+          format: date-time
+        updatedAt:
+          type: string
+          format: date-time
+  questionsBody:
+    type: object
+    properties:
+      title:
+        type: string
+        answers:
+          type: array
+          items:
+            type: object
+            text: string
+            isCorrect: boolean
+  question:
+    type: object
+    properties:
+      _id:
+        type: string
+      title:
+        type: string
+      answers:
+        type: array
+        items:
+          type: object
+          text: string
+          isCorrect: boolean
+      author:
+        type: string
+        ref: '#/components/user'
+      createdAt:
+        type: string
+        format: date-time
+      updatedAt:
+        type: string
+        format: date-time