challenge data model updates

Author: ThomasKranitsas

README.md

@@ -76,7 +76,7 @@ You can find sample `.env` files inside the `/docs` directory.
 2. Creating tables: `npm run create-tables`
 3. Seed/Insert data to tables: `npm run seed-tables`
 4. Initialize/Clear database in default environment: `npm run init-db`
-5. View table data in default environment: `npm run view-data <ModelName>`, ModelName can be `Challenge`, `ChallengeType`, `ChallengeSetting`, `AuditLog`, `Phase`, `TimelineTemplate`or `Attachment`
+5. View table data in default environment: `npm run view-data <ModelName>`, ModelName can be `Challenge`, `ChallengeType`, `ChallengeMetadata`, `AuditLog`, `Phase`, `TimelineTemplate`or `Attachment`
 6. Create Elasticsearch index: `npm run init-db`, or to re-create index: `npm run init-db force`
 7. Synchronize ES data and DynamoDB data: `npm run sync-es`
 

Verification.md

@@ -7,7 +7,7 @@
 - You need to run command `npm run sync-es` before you run `Challenges/get challenge` and `Challenges/search challenge` test case.
 
 ## DynamoDB Verification
-Run command `npm run view-data <ModelName>` to view table data, ModelName can be `Challenge`, `ChallengeType`, `ChallengeSetting`, `AuditLog`, `Phase`, `TimelineTemplate`, `Attachment` or `ChallengeTypeTimelineTemplate`
+Run command `npm run view-data <ModelName>` to view table data, ModelName can be `Challenge`, `ChallengeType`, `ChallengeMetadata`, `AuditLog`, `Phase`, `TimelineTemplate`, `Attachment` or `ChallengeTypeTimelineTemplate`
 
 ## S3 Verification
 

app-constants.js

@@ -30,8 +30,8 @@ const Topics = {
   ChallengeUpdated: 'challenge.notification.update',
   ChallengeTypeCreated: 'test.new.bus.events', // 'challenge.action.type.created',
   ChallengeTypeUpdated: 'test.new.bus.events', // 'challenge.action.type.updated',
-  ChallengeSettingCreated: 'test.new.bus.events', // 'challenge.action.setting.created',
-  ChallengeSettingUpdated: 'test.new.bus.events', // 'challenge.action.setting.updated',
+  ChallengeMetadataCreated: 'test.new.bus.events', // 'challenge.action.metdata.created',
+  ChallengeMetadataUpdated: 'test.new.bus.events', // 'challenge.action.metadata.updated',
   ChallengePhaseCreated: 'test.new.bus.events', // 'challenge.action.phase.created',
   ChallengePhaseUpdated: 'test.new.bus.events', // 'challenge.action.phase.updated',
   ChallengePhaseDeleted: 'test.new.bus.events', // 'challenge.action.phase.deleted',

config/default.js

@@ -75,11 +75,11 @@ module.exports = {
       DELETE: process.env.SCOPE_CHALLENGE_TYPE_TIMELINE_TEMPLATES_DELETE || 'delete:challenge_type_timeline_templates',
       ALL: process.env.SCOPE_CHALLENGE_TYPE_TIMELINE_TEMPLATES_ALL || 'all:challenge_type_timeline_templates'
     },
-    CHALLENGE_SETTINGS: {
-      READ: process.env.SCOPE_CHALLENGE_SETTINGS_READ || 'read:challenge_settings',
-      CREATE: process.env.SCOPE_CHALLENGE_SETTINGS_CREATE || 'create:challenge_settings',
-      UPDATE: process.env.SCOPE_CHALLENGE_SETTINGS_UPDATE || 'update:challenge_settings',
-      ALL: process.env.SCOPE_CHALLENGE_SETTINGS_ALL || 'all:challenge_settings'
+    CHALLENGE_METADATA: {
+      READ: process.env.SCOPE_CHALLENGE_METADATA_READ || 'read:challenge_metadata',
+      CREATE: process.env.SCOPE_CHALLENGE_METADATA_CREATE || 'create:challenge_metadata',
+      UPDATE: process.env.SCOPE_CHALLENGE_METADATA_UPDATE || 'update:challenge_metadata',
+      ALL: process.env.SCOPE_CHALLENGE_METADATA_ALL || 'all:challenge_metadata'
     },
     CHALLENGE_AUDIT_LOGS: {
       READ: process.env.SCOPE_CHALLENGE_AUDIT_LOGS_READ || 'read:challenge_audit_logs'

docs/swagger.yaml

@@ -650,10 +650,10 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  /challenge-settings:
+  /challenge-metadata:
     get:
       tags:
-        - ChallengeSettings
+        - ChallengeMetadata
       description: |
         Retrieve challenge settings in the system.
       security:
@@ -674,7 +674,7 @@ paths:
           schema:
             type: array
             items:
-              $ref: '#/definitions/ChallengeSettings'
+              $ref: '#/definitions/ChallengeMetadata'
           headers:
             X-Next-Page:
               type: integer
@@ -717,7 +717,7 @@ paths:
             $ref: '#/definitions/ErrorModel'
     post:
       tags:
-        - ChallengeSettings
+        - ChallengeChallengeMetadataSettings
       description: |
         Create a new challenge setting in the system.
       security:
@@ -729,12 +729,12 @@ paths:
           name: body
           required: true
           schema:
-            $ref: '#/definitions/ChallengeSettingsData'
+            $ref: '#/definitions/ChallengeMetadataData'
       responses:
         '201':
           description: Created - The request was successful and the resource is returned.
           schema:
-            $ref: '#/definitions/ChallengeSettings'
+            $ref: '#/definitions/ChallengeMetadata'
         '400':
           description: Bad request.  Request parameters were invalid.
           schema:
@@ -758,17 +758,17 @@ paths:
           description: Server error
           schema:
             $ref: '#/definitions/ErrorModel'
-  '/challenge-settings/:challengeSettingId':
+  '/challenge-metadata/:challengeMetadataId':
     get:
       tags:
-        - ChallengeSettings
+        - ChallengeMetadata
       description: Retrieve the Challenge settings with provided challenge settings id.
       security:
         - bearer: []
       produces:
         - application/json
       parameters:
-        - name: challengeSettingId
+        - name: challengeMetadataId
           in: path
           required: true
           type: string
@@ -778,7 +778,7 @@ paths:
         '200':
           description: OK
           schema:
-            $ref: '#/definitions/ChallengeSettings'
+            $ref: '#/definitions/ChallengeMetadata'
         '400':
           description: Bad request.  Request parameters were invalid.
           schema:
@@ -803,29 +803,29 @@ paths:
             $ref: '#/definitions/ErrorModel'
     put:
       tags:
-        - ChallengeSettings
+        - ChallengeMetadata
       description: Update the challenge settings with the specified id.
       security:
         - bearer: []
       produces:
         - application/json
       parameters:
-        - name: challengeSettingId
+        - name: challengeMetadataId
           in: path
           required: true
           type: string
           format: UUID
-          description: The id of challengeSettings to update
+          description: The id of ChallengeMetadata to update
         - in: body
           name: body
           required: true
           schema:
-            $ref: '#/definitions/ChallengeSettingsData'
+            $ref: '#/definitions/ChallengeMetadataData'
       responses:
         '200':
           description: Updated - The request was successful and the resource is returned.
           schema:
-            $ref: '#/definitions/ChallengeSettings'
+            $ref: '#/definitions/ChallengeMetadata'
         '400':
           description: Bad request.  Request parameters were invalid.
           schema:
@@ -1915,7 +1915,7 @@ definitions:
       - $ref: '#/definitions/ChallengeTypeData'
     required:
       - id
-  ChallengeSettings:
+  ChallengeMetadata:
     type: object
     allOf:
       - type: object
@@ -1924,7 +1924,7 @@ definitions:
             type: string
             description: The challenge settings id.
             format: UUID
-      - $ref: '#/definitions/ChallengeSettingsData'
+      - $ref: '#/definitions/ChallengeMetadataData'
     required:
       - id
   Phase:
@@ -1982,7 +1982,7 @@ definitions:
       privateDescription:
         type: string
         description: returned only if the user is registered on the challenge.
-      challengeSettings:
+      ChallengeMetadata:
         type: array
         items:
           properties:
@@ -2068,22 +2068,8 @@ definitions:
       terms:
         type: array
         items:
-          properties:
-            id:
-              type: integer
-              description: The terms of use id
-            agreeabilityType:
-              type: string
-              description: the terms of use agreeability type
-            title:
-              type: string
-              description: the terms of use title
-            url:
-              type: string
-              description: the terms of use url
-            templateId:
-              type: string
-              description: the template id of the terms of use (only valid when the terms agreeability type is 'Docusignable')
+          type: string
+          description: The terms of use id
       numOfSubmissions:
         type: integer
         description: number of submissions
@@ -2154,7 +2140,7 @@ definitions:
       - name
       - isActive
       - abbreviation
-  ChallengeSettingsData:
+  ChallengeMetadataData:
     type: object
     properties:
       name:
@@ -2273,17 +2259,17 @@ definitions:
         type: string
       privateDescription:
         type: string
-      termsIds:
+      terms:
         type : array
         description: The ids of the terms of use to add for the challenge
         items:
          type: string
          format: UUID
-      challengeSettings:
+      metadata:
         type: array
         items:
           properties:
-            type:
+            name:
               type: string
               description: The challenge setting type
               format: UUID
@@ -2391,7 +2377,7 @@ definitions:
         type: string
       privateDescription:
         type: string
-      challengeSettings:
+      metadata:
         type: array
         items:
           properties:
@@ -2478,22 +2464,9 @@ definitions:
       terms:
         type: array
         items:
-          properties:
-            id:
-              type: integer
-              description: The terms of use id
-            agreeabilityType:
-              type: string
-              description: the terms of use agreeability type
-            title:
-              type: string
-              description: the terms of use title
-            url:
-              type: string
-              description: the terms of use url
-            templateId:
-              type: string
-              description: the template id of the terms of use (only valid when the terms agreeability type is 'Docusignable')
+          type: string
+          description: The terms of use id
+          format: UUID
       numOfSubmissions:
         type: integer
         description: number of submissions

package-lock.json

@@ -607,12 +607,7 @@ async function getChallengeTerms (termsIds) {
     // Get the terms details from the API
     try {
       const res = await axios.get(`${config.TERMS_API_URL}/${id}?noauth=true`, { headers: { Authorization: `Bearer ${token}` } })
-      terms.push(_.assign({
-        id: res.data.id,
-        agreeabilityType: res.data.agreeabilityType,
-        title: res.data.title,
-        url: res.data.url
-      }, _.isNil(res.data.docusignTemplateId) ? null : { templateId: res.data.docusignTemplateId }))
+      terms.push(res.data.id)
     } catch (e) {
       if (_.get(e, 'response.status') === HttpStatus.NOT_FOUND) {
         throw new errors.BadRequestError(`Terms of use identified by the id ${id} does not exist`)

src/common/helper.js

@@ -0,0 +1,54 @@
+/**
+ * Controller for challenge type endpoints
+ */
+const HttpStatus = require('http-status-codes')
+const service = require('../services/ChallengeMetadataService')
+const helper = require('../common/helper')
+
+/**
+ * Search challenge metadata
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function searchChallengeMetadata (req, res) {
+  const result = await service.searchChallengeMetadata(req.query)
+  helper.setResHeaders(req, res, result)
+  res.send(result.result)
+}
+
+/**
+ * Create challenge metadata
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function createChallengeMetadata (req, res) {
+  const result = await service.createChallengeMetadata(req.body)
+  res.status(HttpStatus.CREATED).send(result)
+}
+
+/**
+ * Get challenge metadata
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function getChallengeMetadata (req, res) {
+  const result = await service.getChallengeMetadata(req.params.challengeMetadataId)
+  res.send(result)
+}
+
+/**
+ * Update challenge metadata
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function updateChallengeMetadata (req, res) {
+  const result = await service.updateChallengeMetadata(req.params.challengeMetadataId, req.body)
+  res.send(result)
+}
+
+module.exports = {
+  searchChallengeMetadata,
+  createChallengeMetadata,
+  getChallengeMetadata,
+  updateChallengeMetadata
+}