Add Delete Question API

fireice.topcoder · fireice.topcoder · commit 8631a5dbc6f7 · 2014-10-30T01:38:19.000Z
diff --git a/actions/srmRoundQuestions.js b/actions/srmRoundQuestions.js
@@ -599,6 +599,38 @@ var modifyRoundQuestion = function (api, connection, dbConnectionMap, next) {
     });
 };
 
+/**
+ * Delete Round Question.
+ *
+ * @param api the api instance.
+ * @param connection the connection instance
+ * @param dbConnectionMap the database connection map
+ * @param next the callback method
+ */
+var deleteRoundQuestion = function (api, connection, dbConnectionMap, next) {
+    var helper = api.helper,
+      sqlParams = {},
+      questionId = Number(connection.params.questionId);
+
+    async.waterfall([
+        function (cb) {
+            cb(helper.checkAdmin(connection, 'Authorized information needed.', 'Admin access only.'));
+        }, function (cb) {
+            checkQuestionId(api, dbConnectionMap, questionId, cb);
+        }, function (error, cb) {
+            sqlParams.question_id = questionId;
+            api.dataAccess.executeQuery("delete_round_question", sqlParams, dbConnectionMap, cb);
+        }
+    ], function (err) {
+        if (err) {
+            helper.handleError(api, connection, err);
+        } else {
+            connection.response = {"success": true};
+        }
+        next(connection, true);
+    });
+};
+
 /**
  * The API for get Round Questions API.
  */
@@ -748,3 +780,25 @@ exports.modifyRoundQuestion = {
         }
     }
 };
+
+exports.deleteRoundQuestion = {
+    name: "deleteRoundQuestion",
+    description: "Delete Round Question",
+    inputs: {
+        required: ['questionId'],
+        optional: []
+    },
+    blockedConnectionTypes: [],
+    outputExample: {},
+    version: 'v2',
+    transaction: 'write',
+    databases: ["informixoltp"],
+    run: function (api, connection, next) {
+        if (connection.dbConnectionMap) {
+            api.log("Execute deleteRoundQuestion#run", 'debug');
+            deleteRoundQuestion(api, connection, connection.dbConnectionMap, next);
+        } else {
+            api.helper.handleNoConnection(api, connection, next);
+        }
+    }
+};
diff --git a/apiary.apib b/apiary.apib
@@ -12008,6 +12008,111 @@ Managing SRM Contests APIs
         }
 }
 
+## Delete Round Question API [/data/srm/rounds/:questionId/question]
+
+### Delete Round Question API [DELETE]
+
++ Parameters
+  + questionId (required, number, `1000001`) ... The id of the question to delete.
+
++ Request
+
+    + Headers
+
+            Authorization : Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZHwxMzI0NTYiLCJleHAiOjEzOTI4MTc4ODQsImF1ZCI6InRvcGNvZGVyIiwiaWF0IjoxMzkyNzU3ODg0fQ.7X2IKkiyyI1ExSM5GNpdhJ8fGGK5-oAjzccX6YL_BKY
+
++ Response 200 (application/json)
+
+{
+    "success": true
+}
+
++ Response 400 (application/json)
+
+{
+    "error": {
+        "name": "Bad Request",
+        "value": 400,
+        "description": "The request was invalid. An accompanying message will explain why.",
+        "details": "questionId should be number."
+    }
+}
+
+
++ Response 400 (application/json)
+
+{
+    "error": {
+        "name": "Bad Request",
+        "value": 400,
+        "description": "The request was invalid. An accompanying message will explain why.",
+        "details": "questionId should be Integer."
+    }
+}
+
++ Response 400 (application/json)
+
+{
+    "error": {
+        "name": "Bad Request",
+        "value": 400,
+        "description": "The request was invalid. An accompanying message will explain why.",
+        "details": "questionId should be positive."
+    }
+}
+
++ Response 400 (application/json)
+
+{
+    "error": {
+        "name": "Bad Request",
+        "value": 400,
+        "description": "The request was invalid. An accompanying message will explain why.",
+        "details": "questionId should be less or equal to 2147483647."
+    }
+}
+
++ Response 401 (application/json)
+
+{
+ "error": {
+                 "name": "Unauthorized",
+                 "value": 401,
+                 "description": "The request is understood, but it has been refused or access is not allowed.",
+                 "details": "Authorized information needed."
+          }
+}
+
++ Response 403 (application/json)
+
+{
+ "error": {
+                 "name": "Forbidden",
+                 "value": 403,
+                 "description": "The request is understood, but it has been refused or access is not allowed.",
+                 "details": "Admin access only."
+          }
+}
+
++ Response 500 (application/json)
+
+{
+ "error": {
+            "name":"Internal Server Error",
+            "value":"500",
+            "description":"Unknown server error. Please contact support."
+        }
+}
+
++ Response 503 (application/json)
+{
+ "error": {
+            "name":"Service Unavailable",
+            "value":"503",
+            "description":"Servers are up but overloaded. Try again later."
+        }
+}
+
 ## Get Round Question Answers API [/data/srm/rounds/:questionId/answers]
 
 ### Get Round Question Answers API [GET]
diff --git a/queries/delete_round_question b/queries/delete_round_question
@@ -0,0 +1,4 @@
+DELETE FROM survey_question WHERE question_id=@question_id@;
+DELETE FROM round_question WHERE question_id=@question_id@;
+DELETE FROM answer WHERE question_id=@question_id@;
+DELETE FROM question WHERE question_id=@question_id@;
diff --git a/queries/delete_round_question.json b/queries/delete_round_question.json
@@ -0,0 +1,5 @@
+{
+  "name"    : "delete_round_question",
+  "db"      : "informixoltp",
+  "sqlfile" : "delete_round_question"
+}
diff --git a/routes.js b/routes.js
@@ -386,6 +386,7 @@ exports.routes = {
         { path: "/:apiVersion/data/srm/rounds/:oldRoundId", action: "modifySRMContestRound" }
     ],
     delete: [
+        { path: "/:apiVersion/data/srm/rounds/:questionId/question", action: "deleteRoundQuestion" },
         { path: "/:apiVersion/data/srm/rounds/:roundId", action: "deleteSRMContestRound" }
     ]
 };
diff --git a/test/test.srmRoundQuestions.js b/test/test.srmRoundQuestions.js
@@ -79,6 +79,25 @@ function createPostRequest(queryString, user) {
     return req;
 }
 
+/**
+ * Create delete request and return it.
+ *
+ * @param queryString - the query string
+ * @param user - the user handle
+ * @returns {*} request
+ */
+function createDeleteRequest(queryString, user) {
+    var req = request(API_ENDPOINT)
+      .del(queryString)
+      .set("Accept", "application/json")
+      .expect("Content-Type", /json/);
+    if (user) {
+        req.set('Authorization', generateAuthHeader(user));
+    }
+
+    return req;
+}
+
 /**
  * Assert error request.
  *
@@ -127,6 +146,30 @@ function assertPostError(queryString, user, obj, statusCode, errorDetail, done)
     });
 }
 
+/**
+ * Assert delete response detail.
+ *
+ * @param queryString - the query string
+ * @param user - the user handle
+ * @param statusCode - the expected status code
+ * @param errorDetail - the error detail.
+ * @param done the callback function
+ */
+function assertDeleteError(queryString, user, statusCode, errorDetail, done) {
+    createDeleteRequest(queryString, user).expect(statusCode).end(function (err, res) {
+        if (err) {
+            done(err);
+            return;
+        }
+        if (statusCode === 200) {
+            assert.equal(res.body.error, errorDetail, "Invalid error detail");
+        } else {
+            assert.equal(res.body.error.details, errorDetail, "Invalid error detail");
+        }
+        done();
+    });
+}
+
 /**
  * Create a long text.
  *
@@ -635,6 +678,34 @@ describe('SRM Round Questions APIs', function () {
         });
     });
 
+    describe('Delete Round Question API invalid test', function () {
+
+        it("No anonymous access.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/306/question", null, 401, "Authorized information needed.", done);
+        });
+
+        it("Admin access only.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/306/question", 'user', 403, "Admin access only.", done);
+        });
+
+        it("questionId should be number.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/aaa/question", 'heffan', 400, "questionId should be number.", done);
+        });
+
+        it("questionId should be Integer.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/30.6/question", 'heffan', 400, "questionId should be Integer.", done);
+        });
+
+        it("questionId should be positive.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/-306/question", 'heffan', 400, "questionId should be positive.", done);
+        });
+
+        it("questionId should be less or equal to 2147483647.", function (done) {
+            assertDeleteError("/v2/data/srm/rounds/111111111111111111111111111/question", 'heffan', 400,
+              "questionId should be less or equal to 2147483647.", done);
+        });
+    });
+
     describe('Valid test', function () {
 
         it("Valid set survey.", function (done) {
@@ -754,6 +825,65 @@ describe('SRM Round Questions APIs', function () {
             ], done);
         });
 
+        it("Valid test for delete question.", function (done) {
+
+            var validRequest = {"contest_id": 123, "text": "text2", "styleId": 1, "typeId": 1, "statusId": 1, "keyword": "keyword1", "isRequired": true};
+
+            async.waterfall([
+                function (cb) {
+                    var req = request(API_ENDPOINT)
+                      .post("/v2/data/srm/rounds/13673/questions")
+                      .set("Accept", "application/json")
+                      .expect("Content-Type", /json/);
+                    req.set('Authorization', generateAuthHeader('heffan'));
+                    req.expect(200).send(validRequest).end(function (err, res) {
+                        if (err) {
+                            cb(err);
+                            return;
+                        }
+                        assert.equal(res.body.success, true, "Invalid response detail");
+                        cb();
+                    });
+                }, function (cb) {
+                    var sql = "question_id from survey_question where survey_id = 13673";
+                    testHelper.runSqlSelectQuery(sql, "informixoltp", function (err, result) {
+                        if (err) {
+                            cb(err);
+                            return;
+                        }
+                        assert.ok(result.length >= 1);
+                        cb(null, result[0].question_id);
+                    });
+                }, function (questionId, cb) {
+                    createDeleteRequest("/v2/data/srm/rounds/" + questionId + "/question", 'heffan').expect(200).end(function (err, res) {
+                        if (err) {
+                            cb(err);
+                            return;
+                        }
+                        assert.equal(res.body.success, true, "Invalid response detail");
+                        cb(null, questionId);
+                    });
+                }, function (questionId, cb) {
+                    var sqlQueries = [
+                        "question_id from survey_question where question_id = " + questionId,
+                        "question_id from round_question where question_id = " + questionId,
+                        "question_id from answer where question_id = " + questionId,
+                        "question_id from question where question_id = " + questionId
+                    ];
+                    async.forEach(sqlQueries, function (sqlQuery, callback) {
+                        testHelper.runSqlSelectQuery(sqlQuery, "informixoltp", function (err, result) {
+                            if (err) {
+                                callback(err);
+                                return;
+                            }
+                            assert(!result || (Array.isArray(result) && !result.length), "Found question that was supposed to be deleted");
+                            callback();
+                        });
+                    }, cb);
+                }
+            ], done);
+        });
+
         it("Valid test for add question answer and list question answer.", function (done) {
             var validRequest = {"text": "text2", "styleId": 1, "typeId": 1, "statusId": 1, "keyword": "keyword1", "isRequired": true},
                 questionId;

Original file line number	Diff line number	Diff line change
`@@ -386,6 +386,7 @@ exports.routes = {`
`386`	`386`	`{ path: "/:apiVersion/data/srm/rounds/:oldRoundId", action: "modifySRMContestRound" }`
`387`	`387`	`],`
`388`	`388`	`delete: [`
	`389`	`+ { path: "/:apiVersion/data/srm/rounds/:questionId/question", action: "deleteRoundQuestion" },`
`389`	`390`	`{ path: "/:apiVersion/data/srm/rounds/:roundId", action: "deleteSRMContestRound" }`
`390`	`391`	`]`
`391`	`392`	`};`