Merge branch 'develop' of https://github.com/topcoder-platform/challenge-api into new-readme

Author: ThomasKranitsas

app.js

@@ -13,10 +13,16 @@ const HttpStatus = require('http-status-codes')
 const logger = require('./src/common/logger')
 const interceptor = require('express-interceptor')
 const fileUpload = require('express-fileupload')
+const YAML = require('yamljs')
+const swaggerUi = require('swagger-ui-express')
+const challengeAPISwaggerDoc = YAML.load('./docs/swagger.yaml')
 
 // setup express app
 const app = express()
 
+// serve challenge V5 API swagger definition
+app.use('/v5/challenges/docs', swaggerUi.serve, swaggerUi.setup(challengeAPISwaggerDoc))
+
 app.use(cors({
   exposedHeaders: [
     'X-Prev-Page',

config/default.js

@@ -22,8 +22,9 @@ module.exports = {
   KAFKA_ERROR_TOPIC: process.env.KAFKA_ERROR_TOPIC || 'common.error.reporting',
 
   AMAZON: {
-    AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID || 'FAKE_ACCESS_KEY',
-    AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY || 'FAKE_SECRET_ACCESS_KEY',
+    // Uncomment for local deployment
+    // AWS_ACCESS_KEY_ID: process.env.AWS_ACCESS_KEY_ID || 'FAKE_ACCESS_KEY',
+    // AWS_SECRET_ACCESS_KEY: process.env.AWS_SECRET_ACCESS_KEY || 'FAKE_SECRET_ACCESS_KEY',
     AWS_REGION: process.env.AWS_REGION || 'ap-northeast-1',
     IS_LOCAL_DB: process.env.IS_LOCAL_DB ? process.env.IS_LOCAL_DB === 'true' : true,
     DYNAMODB_URL: process.env.DYNAMODB_URL || 'http://localhost:7777',
@@ -45,7 +46,7 @@ module.exports = {
     ? Number(process.env.FILE_UPLOAD_SIZE_LIMIT) : 50 * 1024 * 1024, // 50M
   RESOURCES_API_URL: process.env.RESOURCES_API_URL || 'http://localhost:4000/v5/resources',
   GROUPS_API_URL: process.env.GROUPS_API_URL || 'http://localhost:4000/v5/groups',
-  PROJECTS_API_URL: process.env.PROJECTS_API_URL || 'http://localhost:4000/v4/projects',
+  PROJECTS_API_URL: process.env.PROJECTS_API_URL || 'http://localhost:4000/v5/projects',
   // copilot resource role ids allowed to upload attachment
   COPILOT_RESOURCE_ROLE_IDS: process.env.COPILOT_RESOURCE_ROLE_IDS
     ? process.env.COPILOT_RESOURCE_ROLE_IDS.split(',') : ['10ba038e-48da-487b-96e8-8d3b99b6d18b'],

mock-api/app.js

@@ -64,7 +64,7 @@ app.get('/v5/resources/:memberId/challenges', (req, res) => {
 })
 
 // get project by id
-app.get('/v4/projects/:projectId', (req, res) => {
+app.get('/v5/projects/:projectId', (req, res) => {
   const projectId = req.params.projectId
   if (projectId === '111' || projectId === '123' || projectId === '112233') {
     res.end()

package-lock.json

@@ -49,10 +49,12 @@
     "jsonwebtoken": "^8.3.0",
     "lodash": "^4.17.11",
     "moment": "^2.24.0",
+    "swagger-ui-express": "^4.1.3",
     "tc-core-library-js": "appirio-tech/tc-core-library-js.git#v2.6.2",
     "topcoder-bus-api-wrapper": "topcoder-platform/tc-bus-api-wrapper.git",
     "uuid": "^3.3.2",
-    "winston": "^3.1.0"
+    "winston": "^3.1.0",
+    "yamljs": "^0.3.0"
   },
   "standard": {
     "ignore": [

package.json

@@ -96,7 +96,7 @@ const schema = new Schema({
   },
   // winners
   winners: {
-    type: [Object],
+    type: Array,
     required: false
   },
   created: {

src/models/Challenge.js

@@ -5,11 +5,15 @@
 const config = require('config')
 const dynamoose = require('dynamoose')
 
-dynamoose.AWS.config.update({
-  // accessKeyId: config.AMAZON.AWS_ACCESS_KEY_ID,
-  // secretAccessKey: config.AMAZON.AWS_SECRET_ACCESS_KEY,
+const awsConfigs = config.AMAZON.IS_LOCAL_DB ? {
+  accessKeyId: config.AMAZON.AWS_ACCESS_KEY_ID,
+  secretAccessKey: config.AMAZON.AWS_SECRET_ACCESS_KEY,
   region: config.AMAZON.AWS_REGION
-})
+} : {
+  region: config.AMAZON.AWS_REGION
+}
+
+dynamoose.AWS.config.update(awsConfigs)
 
 if (config.AMAZON.IS_LOCAL_DB) {
   dynamoose.local(config.AMAZON.DYNAMODB_URL)

src/models/index.js

@@ -92,10 +92,10 @@ module.exports = {
   '/challengeTimelines': {
     get: {
       controller: 'ChallengeTypeTimelineTemplateController',
-      method: 'searchChallengeTypeTimelineTemplates',
-      auth: 'jwt',
-      access: [constants.UserRoles.Admin, constants.UserRoles.Copilot],
-      scopes: [CHALLENGE_TYPE_TIMELINE_TEMPLATES.READ, CHALLENGE_TYPE_TIMELINE_TEMPLATES.ALL]
+      method: 'searchChallengeTypeTimelineTemplates'
+      // auth: 'jwt',
+      // access: [constants.UserRoles.Admin, constants.UserRoles.Copilot],
+      // scopes: [CHALLENGE_TYPE_TIMELINE_TEMPLATES.READ, CHALLENGE_TYPE_TIMELINE_TEMPLATES.ALL]
     },
     post: {
       controller: 'ChallengeTypeTimelineTemplateController',
@@ -108,10 +108,10 @@ module.exports = {
   '/challengeTimelines/:challengeTypeTimelineTemplateId': {
     get: {
       controller: 'ChallengeTypeTimelineTemplateController',
-      method: 'getChallengeTypeTimelineTemplate',
-      auth: 'jwt',
-      access: [constants.UserRoles.Admin, constants.UserRoles.Copilot],
-      scopes: [CHALLENGE_TYPE_TIMELINE_TEMPLATES.READ, CHALLENGE_TYPE_TIMELINE_TEMPLATES.ALL]
+      method: 'getChallengeTypeTimelineTemplate'
+      // auth: 'jwt',
+      // access: [constants.UserRoles.Admin, constants.UserRoles.Copilot],
+      // scopes: [CHALLENGE_TYPE_TIMELINE_TEMPLATES.READ, CHALLENGE_TYPE_TIMELINE_TEMPLATES.ALL]
     },
     put: {
       controller: 'ChallengeTypeTimelineTemplateController',