mirror of https://gitee.com/bigwinds/arangodb
Merge pull request #939 from triAGENS/foxx-joiful-params
Foxx: use joi in queryParam and pathParam (fixes #936)
This commit is contained in:
Alan Plum
commit
f5d35c053a
|
|
@ -14,6 +14,8 @@ migrations will also be detailed here.
|
|||
* Foxx: The usage of `controller.collection` is no longer suggested, it will be deprecated in the next version. Please use `appContext.collection` instead.
|
||||
* Foxx: The usage of `Model.extend({}, {attributes: {}})` is no longer suggested, it will be deprecated in the next version. Please use `Model.extend({schema: {}})` instead.
|
||||
* Foxx: The usage of `requestContext.bodyParam(paramName, description, Model)` is no longer suggested, it will be deprecated in the next version. Please use `requestContext.bodyParam(paramName, options)` instead.
|
||||
* Foxx: The usage of `requestContext.queryParam({type: string})` is no longer suggested, it will be deprecated in the next version. Please use `requestContext.queryParam({type: joi})` instead.
|
||||
* Foxx: The usage of `requestContext.pathParam({type: string})` is no longer suggested, it will be deprecated in the next version. Please use `requestContext.pathParam({type: joi})` instead.
|
||||
* Foxx: The usage of `apps` in manifest files is no longer possible, please use `controllers` instead.
|
||||
* Graph: The usage of the modules `org/arangodb/graph` and `org/arangodb/graph-blueprint` is no longer suggested, it will be deprecated in the next version. Please use module `org/arangodb/general-graph` instead.
|
||||
* Graph: The module `org/arangodb/graph` will now load the module `org/arangodb/graph-blueprint`.
|
||||
|
|
@ -34,6 +36,8 @@ migrations will also be detailed here.
|
|||
* Foxx: `controller.collection` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `appContext.collection` instead.
|
||||
* Foxx: `Model.extend({}, {attributes: {}})` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `Model.extend({schema: {}})` instead.
|
||||
* Foxx: `requestContext.bodyParam(paramName, description, Model)` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.bodyParam(paramName, options)` instead.
|
||||
* Foxx: `requestContext.queryParam({type: string})` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.queryParam({type: joi})` instead.
|
||||
* Foxx: `requestContext.pathParam({type: string})` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.pathParam({type: joi})` instead.
|
||||
* Graph: The modules `org/arangodb/graph` and `org/arangodb/graph-blueprint` are now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use module `org/arangodb/general-graph` instead.
|
||||
* AQL: The function `PATHS` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `GRAPH_PATHS` instead.
|
||||
* AQL: The function `SHORTEST_PATH` is now deprecated, it will raise a warning if you use it. To suppress the warning, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `GRAPH_SHORTEST_PATH` instead.
|
||||
|
|
@ -51,6 +55,8 @@ migrations will also be detailed here.
|
|||
* Foxx: `controller.collection` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `appContext.collection` instead.
|
||||
* Foxx: `Model.extend({}, {attributes: {}})` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `Model.extend({schema: {}})` instead.
|
||||
* Foxx: `requestContext.bodyParam(paramName, description, Model)` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.bodyParam(paramName, options)` instead.
|
||||
* Foxx: `requestContext.queryParam({type: string})` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.queryParam({type: joi})` instead.
|
||||
* Foxx: `requestContext.pathParam({type: string})` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `requestContext.pathParam({type: joi})` instead.
|
||||
* Graph: The modules `org/arangodb/graph` and `org/arangodb/graph-blueprint` are no longer available by default. If you still want to use them, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use module `org/arangodb/general-graph` instead.
|
||||
* AQL: The function `PATHS` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `GRAPH_PATHS` instead.
|
||||
* AQL: The function `SHORTEST_PATH` is no longer available by default. If you still want to use it, please start `arangod` with the option `--server.default-api-compatibility 20200`. Please use `GRAPH_SHORTEST_PATH` instead.
|
||||
|
|
@ -68,6 +74,8 @@ migrations will also be detailed here.
|
|||
* Foxx: `controller.collection` has been removed entirely. Please use `appContext.collection` instead.
|
||||
* Foxx: `Model.extend({}, {attributes: {}})` has been removed entirely. Please use `Model.extend({schema: {}})` instead.
|
||||
* Foxx: `requestContext.bodyParam(paramName, description, Model)` has been removed entirely. Please use `requestContext.bodyParam(paramName, options)` instead.
|
||||
* Foxx: `requestContext.queryParam({type: string})` has been removed entirely. Please use `requestContext.queryParam({type: joi})` instead.
|
||||
* Foxx: `requestContext.pathParam({type: string})` has been removed entirely. Please use `requestContext.pathParam({type: joi})` instead.
|
||||
* Graph: The modules `org/arangodb/graph` and `org/arangodb/graph-blueprint` have been removed entirely. Please use module `org/arangodb/general-graph` instead.
|
||||
* AQL: The function `PATHS` has been removed entirely. Please use `GRAPH_PATHS` instead.
|
||||
* AQL: The function `SHORTEST_PATH` has been removed entirely. Please use `GRAPH_SHORTEST_PATH` instead.
|
||||
|
|
|
|||
|
|
@ -61,7 +61,7 @@ var ALL_METHODS = [ "DELETE", "GET", "HEAD", "OPTIONS", "POST", "PUT", "PATCH" ]
|
|||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief function that's returned for non-implemented actions
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
function notImplementedFunction (route, message) {
|
||||
'use strict';
|
||||
|
||||
|
|
@ -259,7 +259,7 @@ function lookupCallbackActionCallbackString (route, action, context) {
|
|||
catch (err) {
|
||||
func = errorFunction(
|
||||
route,
|
||||
"an error occurred while loading function '"
|
||||
"an error occurred while loading function '"
|
||||
+ action.callback + "': " + String(err.stack || err));
|
||||
}
|
||||
|
||||
|
|
@ -292,7 +292,7 @@ function lookupCallbackActionCallback (route, action, context) {
|
|||
return {
|
||||
controller: errorFunction(
|
||||
route,
|
||||
"an error occurred while loading function '"
|
||||
"an error occurred while loading function '"
|
||||
+ action.callback + "': unknown type '" + String(typeof action.callback) + "'"),
|
||||
options: action.options || {},
|
||||
methods: action.methods || ALL_METHODS
|
||||
|
|
@ -331,22 +331,22 @@ function lookupCallbackActionDo (route, action) {
|
|||
catch (err) {
|
||||
if (err.hasOwnProperty("moduleNotFound") && err.moduleNotFound) {
|
||||
func = notImplementedFunction(
|
||||
route,
|
||||
"an error occurred while loading action named '" + name
|
||||
route,
|
||||
"an error occurred while loading action named '" + name
|
||||
+ "' in module '" + joined + "': " + String(err.stack || err));
|
||||
}
|
||||
else {
|
||||
func = errorFunction(
|
||||
route,
|
||||
"an error occurred while loading action named '" + name
|
||||
"an error occurred while loading action named '" + name
|
||||
+ "' in module '" + joined + "': " + String(err.stack || err));
|
||||
}
|
||||
}
|
||||
|
||||
if (func === null || typeof func !== 'function') {
|
||||
func = errorFunction(
|
||||
route,
|
||||
"invalid definition for the action named '" + name
|
||||
route,
|
||||
"invalid definition for the action named '" + name
|
||||
+ "' in module '" + joined + "'");
|
||||
}
|
||||
|
||||
|
|
@ -366,7 +366,7 @@ function lookupCallbackActionController (route, action) {
|
|||
|
||||
var func;
|
||||
var mdl;
|
||||
var httpMethods = {
|
||||
var httpMethods = {
|
||||
'get': exports.GET,
|
||||
'head': exports.HEAD,
|
||||
'put': exports.PUT,
|
||||
|
|
@ -389,12 +389,12 @@ function lookupCallbackActionController (route, action) {
|
|||
if (req.requestType === httpMethods[m] && mdl.hasOwnProperty(m)) {
|
||||
func = mdl[m]
|
||||
|| errorFunction(
|
||||
route,
|
||||
"invalid definition for " + m
|
||||
+ " action in action controller module '"
|
||||
route,
|
||||
"invalid definition for " + m
|
||||
+ " action in action controller module '"
|
||||
+ action.controller + "'");
|
||||
|
||||
return func(req, res, options, next);
|
||||
return func(req, res, options, next);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -418,14 +418,14 @@ function lookupCallbackActionController (route, action) {
|
|||
catch (err) {
|
||||
if (err.hasOwnProperty("moduleNotFound") && err.moduleNotFound) {
|
||||
return notImplementedFunction(
|
||||
route,
|
||||
"cannot load/execute action controller module '"
|
||||
route,
|
||||
"cannot load/execute action controller module '"
|
||||
+ action.controller + ": " + String(err.stack || err));
|
||||
}
|
||||
|
||||
return errorFunction(
|
||||
route,
|
||||
"cannot load/execute action controller module '"
|
||||
route,
|
||||
"cannot load/execute action controller module '"
|
||||
+ action.controller + ": " + String(err.stack || err));
|
||||
}
|
||||
}
|
||||
|
|
@ -438,7 +438,7 @@ function lookupCallbackActionPrefixController (route, action) {
|
|||
'use strict';
|
||||
|
||||
var prefixController = action.prefixController;
|
||||
var httpMethods = {
|
||||
var httpMethods = {
|
||||
'get': exports.GET,
|
||||
'head': exports.HEAD,
|
||||
'put': exports.PUT,
|
||||
|
|
@ -496,11 +496,11 @@ function lookupCallbackActionPrefixController (route, action) {
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
if (mdl.hasOwnProperty('do')) {
|
||||
func = mdl['do']
|
||||
|| errorFunction(
|
||||
route,
|
||||
route,
|
||||
"Invalid definition for do action in prefix controller '"
|
||||
+ action.prefixController + "'");
|
||||
|
||||
|
|
@ -509,7 +509,7 @@ function lookupCallbackActionPrefixController (route, action) {
|
|||
}
|
||||
catch (err2) {
|
||||
return errorFunction(
|
||||
route,
|
||||
route,
|
||||
"Cannot load/execute prefix controller '"
|
||||
+ action.prefixController + "': " + String(err2.stack || err2))(
|
||||
req, res, options, next);
|
||||
|
|
@ -592,7 +592,7 @@ function lookupCallback (route, context) {
|
|||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief intersect methods
|
||||
/// @brief intersect methods
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
function intersectMethods (a, b) {
|
||||
|
|
@ -611,7 +611,7 @@ function intersectMethods (a, b) {
|
|||
}
|
||||
|
||||
for (j = 0; j < a.length; j++) {
|
||||
var name = a[j].toUpperCase();
|
||||
var name = a[j].toUpperCase();
|
||||
|
||||
if (d[name]) {
|
||||
results.push(name);
|
||||
|
|
@ -697,7 +697,7 @@ function defineRoutePart (route, subwhere, parts, pos, constraint, callback) {
|
|||
for (i = 0; i < part.parameters.length; ++i) {
|
||||
p = part.parameters[i];
|
||||
subsub = { parameter: p, match: {} };
|
||||
subwhere.parameters.push(subsub);
|
||||
subwhere.parameters.push(subsub);
|
||||
|
||||
if (constraint.hasOwnProperty(p)) {
|
||||
subsub.constraint = constraint[p];
|
||||
|
|
@ -858,13 +858,13 @@ function flattenRouting (routes, path, urlParameters, depth, prefix) {
|
|||
|
||||
for (i = 0; i < sorted.length; ++i) {
|
||||
sorted[i] = {
|
||||
path: path,
|
||||
path: path,
|
||||
regexp: new RegExp("^" + path + "$"),
|
||||
prefix: prefix,
|
||||
depth: depth,
|
||||
urlParameters: urlParameters,
|
||||
callback: sorted[i].callback,
|
||||
route: sorted[i].route
|
||||
route: sorted[i].route
|
||||
};
|
||||
}
|
||||
|
||||
|
|
@ -905,7 +905,7 @@ function routeRequest (req, res) {
|
|||
|
||||
execute = function () {
|
||||
if (action.route === undefined) {
|
||||
exports.resultNotFound(req, res, arangodb.ERROR_HTTP_NOT_FOUND,
|
||||
exports.resultNotFound(req, res, arangodb.ERROR_HTTP_NOT_FOUND,
|
||||
"unknown path '" + path + "'");
|
||||
return;
|
||||
}
|
||||
|
|
@ -942,7 +942,7 @@ function routeRequest (req, res) {
|
|||
|
||||
if (func === null || typeof func !== 'function') {
|
||||
func = exports.errorFunction(action.route,
|
||||
'Invalid callback definition found for route '
|
||||
'Invalid callback definition found for route '
|
||||
+ JSON.stringify(action.route));
|
||||
}
|
||||
|
||||
|
|
@ -1125,7 +1125,7 @@ function getJsonBody (req, res, code) {
|
|||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
function resultError (req, res, httpReturnCode, errorNum, errorMessage, headers, keyvals) {
|
||||
function resultError (req, res, httpReturnCode, errorNum, errorMessage, headers, keyvals) {
|
||||
'use strict';
|
||||
|
||||
var i;
|
||||
|
|
@ -1140,7 +1140,7 @@ function resultError (req, res, httpReturnCode, errorNum, errorMessage, headers,
|
|||
errorMessage = errorNum;
|
||||
errorNum = httpReturnCode;
|
||||
}
|
||||
|
||||
|
||||
if (errorMessage === undefined || errorMessage === null) {
|
||||
msg = getErrorMessage(errorNum);
|
||||
}
|
||||
|
|
@ -1162,11 +1162,11 @@ function resultError (req, res, httpReturnCode, errorNum, errorMessage, headers,
|
|||
result.code = httpReturnCode;
|
||||
result.errorNum = errorNum;
|
||||
result.errorMessage = msg;
|
||||
|
||||
|
||||
res.body = JSON.stringify(result);
|
||||
|
||||
if (headers !== undefined && headers !== null) {
|
||||
res.headers = headers;
|
||||
res.headers = headers;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1184,10 +1184,10 @@ function reloadRouting () {
|
|||
// .............................................................................
|
||||
// clear the routing cache
|
||||
// .............................................................................
|
||||
|
||||
// work with a local variable first
|
||||
|
||||
// work with a local variable first
|
||||
var routingCache = { };
|
||||
|
||||
|
||||
routingCache.flat = {};
|
||||
routingCache.routes = {};
|
||||
routingCache.middleware = {};
|
||||
|
|
@ -1250,7 +1250,7 @@ function reloadRouting () {
|
|||
|
||||
defineRoute(route, storage, url, callback);
|
||||
};
|
||||
|
||||
|
||||
// .............................................................................
|
||||
// analyses a new route
|
||||
// .............................................................................
|
||||
|
|
@ -1290,10 +1290,10 @@ function reloadRouting () {
|
|||
for (i = 0; i < r.length; ++i) {
|
||||
var context = { appModule: appModule };
|
||||
|
||||
installRoute(routingCache[key],
|
||||
urlPrefix,
|
||||
modulePrefix,
|
||||
context,
|
||||
installRoute(routingCache[key],
|
||||
urlPrefix,
|
||||
modulePrefix,
|
||||
context,
|
||||
r[i]);
|
||||
}
|
||||
}
|
||||
|
|
@ -1341,7 +1341,7 @@ function reloadRouting () {
|
|||
|
||||
routingCache.flat[method] = b.concat(a);
|
||||
}
|
||||
|
||||
|
||||
// once we're done, we can set the complete routing cache for database
|
||||
// doing this here instead of above ensures we don't have a half-updated routing
|
||||
// cache if this function fails somewhere in the middle
|
||||
|
|
@ -1405,11 +1405,11 @@ function firstRouting (type, parts) {
|
|||
'use strict';
|
||||
|
||||
var url = parts;
|
||||
|
||||
|
||||
if (undefined === RoutingCache[arangodb.db._name()]) {
|
||||
reloadRouting();
|
||||
}
|
||||
|
||||
|
||||
var routingCache = RoutingCache[arangodb.db._name()];
|
||||
|
||||
if (typeof url === 'string') {
|
||||
|
|
@ -1452,7 +1452,7 @@ function firstRouting (type, parts) {
|
|||
function badParameter (req, res, name) {
|
||||
'use strict';
|
||||
|
||||
resultError(req, res, exports.HTTP_BAD, exports.HTTP_BAD,
|
||||
resultError(req, res, exports.HTTP_BAD, exports.HTTP_BAD,
|
||||
"invalid value for parameter '" + name + "'");
|
||||
}
|
||||
|
||||
|
|
@ -1469,24 +1469,24 @@ function badParameter (req, res, name) {
|
|||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
function resultOk (req, res, httpReturnCode, result, headers) {
|
||||
function resultOk (req, res, httpReturnCode, result, headers) {
|
||||
'use strict';
|
||||
|
||||
res.responseCode = httpReturnCode;
|
||||
res.contentType = "application/json; charset=utf-8";
|
||||
|
||||
|
||||
// add some default attributes to result
|
||||
if (result === undefined) {
|
||||
result = {};
|
||||
}
|
||||
|
||||
result.error = false;
|
||||
result.error = false;
|
||||
result.code = httpReturnCode;
|
||||
|
||||
|
||||
res.body = JSON.stringify(result);
|
||||
|
||||
|
||||
if (headers !== undefined) {
|
||||
res.headers = headers;
|
||||
res.headers = headers;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1532,7 +1532,7 @@ function resultNotFound (req, res, code, msg, headers) {
|
|||
function resultNotImplemented (req, res, msg, headers) {
|
||||
'use strict';
|
||||
|
||||
resultError(req,
|
||||
resultError(req,
|
||||
res,
|
||||
exports.HTTP_NOT_IMPLEMENTED,
|
||||
arangodb.ERROR_NOT_IMPLEMENTED,
|
||||
|
|
@ -1556,11 +1556,11 @@ function resultUnsupported (req, res, headers) {
|
|||
exports.HTTP_METHOD_NOT_ALLOWED,
|
||||
arangodb.ERROR_HTTP_METHOD_NOT_ALLOWED,
|
||||
"Unsupported method",
|
||||
headers);
|
||||
headers);
|
||||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief internal function for handling redirects
|
||||
/// @brief internal function for handling redirects
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
function handleRedirect (req, res, options, headers) {
|
||||
|
|
@ -1582,7 +1582,7 @@ function handleRedirect (req, res, options, headers) {
|
|||
else {
|
||||
url += req.server.address + ":" + req.server.port;
|
||||
}
|
||||
|
||||
|
||||
if (options.relative) {
|
||||
var u = req.url;
|
||||
|
||||
|
|
@ -1637,7 +1637,7 @@ function resultPermanentRedirect (req, res, options, headers) {
|
|||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @startDocuBlock actionsResultTemporaryRedirect
|
||||
/// @startDocuBlock actionsResultTemporaryRedirect
|
||||
///
|
||||
/// `actions.resultTemporaryRedirect(req, res, options, headers)`
|
||||
///
|
||||
|
|
@ -1649,7 +1649,7 @@ function resultTemporaryRedirect (req, res, options, headers) {
|
|||
'use strict';
|
||||
|
||||
res.responseCode = exports.HTTP_TEMPORARY_REDIRECT;
|
||||
|
||||
|
||||
handleRedirect(req, res, options, headers);
|
||||
}
|
||||
|
||||
|
|
@ -1693,7 +1693,7 @@ function resultCursor (req, res, cursor, code, options) {
|
|||
|
||||
if (hasNext) {
|
||||
cursor.persist();
|
||||
cursorId = cursor.id();
|
||||
cursorId = cursor.id();
|
||||
}
|
||||
else {
|
||||
cursorId = null;
|
||||
|
|
@ -1713,7 +1713,7 @@ function resultCursor (req, res, cursor, code, options) {
|
|||
|
||||
// do not use cursor after this
|
||||
|
||||
var result = {
|
||||
var result = {
|
||||
result : rows,
|
||||
hasMore : hasNext
|
||||
};
|
||||
|
|
@ -1721,7 +1721,7 @@ function resultCursor (req, res, cursor, code, options) {
|
|||
if (cursorId) {
|
||||
result.id = cursorId;
|
||||
}
|
||||
|
||||
|
||||
if (hasCount) {
|
||||
result.count = count;
|
||||
}
|
||||
|
|
@ -1798,8 +1798,8 @@ function indexNotFound (req, res, collection, index, headers) {
|
|||
///
|
||||
/// `actions.resultException(req, res, err, headers, verbose)`
|
||||
///
|
||||
/// The function generates an error response. If @FA{verbose} is set to
|
||||
/// *true* or not specified (the default), then the error stack trace will
|
||||
/// The function generates an error response. If @FA{verbose} is set to
|
||||
/// *true* or not specified (the default), then the error stack trace will
|
||||
/// be included in the error message if available.
|
||||
/// @endDocuBlock
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
|
@ -1827,44 +1827,44 @@ function resultException (req, res, err, headers, verbose) {
|
|||
}
|
||||
|
||||
if (err.errorMessage !== "" && ! verbose) {
|
||||
msg = err.errorMessage;
|
||||
msg = err.errorMessage;
|
||||
}
|
||||
|
||||
switch (num) {
|
||||
case arangodb.ERROR_INTERNAL:
|
||||
case arangodb.ERROR_OUT_OF_MEMORY:
|
||||
case arangodb.ERROR_GRAPH_TOO_MANY_ITERATIONS:
|
||||
code = exports.HTTP_SERVER_ERROR;
|
||||
case arangodb.ERROR_INTERNAL:
|
||||
case arangodb.ERROR_OUT_OF_MEMORY:
|
||||
case arangodb.ERROR_GRAPH_TOO_MANY_ITERATIONS:
|
||||
code = exports.HTTP_SERVER_ERROR;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_FORBIDDEN:
|
||||
case arangodb.ERROR_ARANGO_USE_SYSTEM_DATABASE:
|
||||
code = exports.HTTP_FORBIDDEN;
|
||||
|
||||
case arangodb.ERROR_FORBIDDEN:
|
||||
case arangodb.ERROR_ARANGO_USE_SYSTEM_DATABASE:
|
||||
code = exports.HTTP_FORBIDDEN;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_ARANGO_COLLECTION_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_DOCUMENT_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_DATABASE_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_ENDPOINT_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_NO_INDEX:
|
||||
case arangodb.ERROR_ARANGO_INDEX_NOT_FOUND:
|
||||
case arangodb.ERROR_CURSOR_NOT_FOUND:
|
||||
case arangodb.ERROR_USER_NOT_FOUND:
|
||||
|
||||
case arangodb.ERROR_ARANGO_COLLECTION_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_DOCUMENT_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_DATABASE_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_ENDPOINT_NOT_FOUND:
|
||||
case arangodb.ERROR_ARANGO_NO_INDEX:
|
||||
case arangodb.ERROR_ARANGO_INDEX_NOT_FOUND:
|
||||
case arangodb.ERROR_CURSOR_NOT_FOUND:
|
||||
case arangodb.ERROR_USER_NOT_FOUND:
|
||||
code = exports.HTTP_NOT_FOUND;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_REQUEST_CANCELED:
|
||||
code = exports.HTTP_REQUEST_TIMEOUT;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_ARANGO_DUPLICATE_NAME:
|
||||
case arangodb.ERROR_ARANGO_DUPLICATE_IDENTIFIER:
|
||||
code = exports.HTTP_CONFLICT;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_CLUSTER_UNSUPPORTED:
|
||||
case arangodb.ERROR_REQUEST_CANCELED:
|
||||
code = exports.HTTP_REQUEST_TIMEOUT;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_ARANGO_DUPLICATE_NAME:
|
||||
case arangodb.ERROR_ARANGO_DUPLICATE_IDENTIFIER:
|
||||
code = exports.HTTP_CONFLICT;
|
||||
break;
|
||||
|
||||
case arangodb.ERROR_CLUSTER_UNSUPPORTED:
|
||||
code = exports.HTTP_NOT_IMPLEMENTED;
|
||||
break;
|
||||
break;
|
||||
}
|
||||
}
|
||||
else if (err instanceof TypeError) {
|
||||
|
|
@ -1875,7 +1875,7 @@ function resultException (req, res, err, headers, verbose) {
|
|||
num = arangodb.ERROR_HTTP_SERVER_ERROR;
|
||||
code = exports.HTTP_SERVER_ERROR;
|
||||
}
|
||||
|
||||
|
||||
resultError(req, res, code, num, msg, headers);
|
||||
}
|
||||
|
||||
|
|
@ -2052,12 +2052,12 @@ function addCookie (res, name, value, lifeTime, path, domain, secure, httpOnly)
|
|||
if (value === undefined) {
|
||||
return;
|
||||
}
|
||||
|
||||
|
||||
var cookie = {
|
||||
'name' : name,
|
||||
'value' : value
|
||||
};
|
||||
|
||||
|
||||
if (lifeTime !== undefined && lifeTime !== null) {
|
||||
cookie.lifeTime = parseInt(lifeTime, 10);
|
||||
}
|
||||
|
|
@ -2073,11 +2073,11 @@ function addCookie (res, name, value, lifeTime, path, domain, secure, httpOnly)
|
|||
if (httpOnly !== undefined && httpOnly !== null) {
|
||||
cookie.httpOnly = (httpOnly) ? true : false;
|
||||
}
|
||||
|
||||
|
||||
if (res.cookies === undefined || res.cookies === null) {
|
||||
res.cookies = [];
|
||||
}
|
||||
|
||||
|
||||
res.cookies.push(cookie);
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -156,8 +156,9 @@ extend(Controller.prototype, {
|
|||
|
||||
handleRequest: function (method, route, callback) {
|
||||
'use strict';
|
||||
var newRoute = internal.constructRoute(method, route, callback, this),
|
||||
requestContext = new RequestContext(this.allRoutes, this.models, newRoute, this.rootElement),
|
||||
var constraints = {queryParams: {}, urlParams: {}},
|
||||
newRoute = internal.constructRoute(method, route, callback, this, constraints),
|
||||
requestContext = new RequestContext(this.allRoutes, this.models, newRoute, this.rootElement, constraints),
|
||||
summary,
|
||||
undocumentedBody;
|
||||
|
||||
|
|
@ -482,7 +483,7 @@ extend(Controller.prototype, {
|
|||
/// work. This includes sending a response to the user. This defaults to a function
|
||||
/// that sets the response to 401 and returns a JSON with *error* set to
|
||||
/// "Username or Password was wrong".
|
||||
///
|
||||
///
|
||||
/// Both *onSuccess* and *onError* should take request and result as arguments.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
|
|
@ -510,7 +511,7 @@ extend(Controller.prototype, {
|
|||
/// This works pretty similar to the logout function and adds a path to your
|
||||
/// app for the logout functionality. You can customize it with a custom *onSuccess*
|
||||
/// and *onError* function:
|
||||
///
|
||||
///
|
||||
/// * *onSuccess* is a function that you can define to do something if the logout was
|
||||
/// successful. This includes sending a response to the user. This defaults to a
|
||||
/// function that returns a JSON with *message* set to "logged out".
|
||||
|
|
@ -518,7 +519,7 @@ extend(Controller.prototype, {
|
|||
/// work. This includes sending a response to the user. This defaults to a function
|
||||
/// that sets the response to 401 and returns a JSON with *error* set to
|
||||
/// "No session was found".
|
||||
///
|
||||
///
|
||||
/// Both *onSuccess* and *onError* should take request and result as arguments.
|
||||
///
|
||||
///
|
||||
|
|
@ -555,9 +556,9 @@ extend(Controller.prototype, {
|
|||
/// work. This includes sending a response to the user. This defaults to a function
|
||||
/// that sets the response to 401 and returns a JSON with *error* set to
|
||||
/// "Registration failed".
|
||||
///
|
||||
///
|
||||
/// Both *onSuccess* and *onError* should take request and result as arguments.
|
||||
///
|
||||
///
|
||||
/// You can also set the fields containing the username and password via *usernameField*
|
||||
/// (defaults to *username*) and *passwordField* (defaults to *password*).
|
||||
/// If you want to accept additional attributes for the user document, use the option
|
||||
|
|
@ -608,7 +609,7 @@ extend(Controller.prototype, {
|
|||
/// work. This includes sending a response to the user. This defaults to a function
|
||||
/// that sets the response to 401 and returns a JSON with *error* set to
|
||||
/// "No session was found".
|
||||
///
|
||||
///
|
||||
/// Both *onSuccess* and *onError* should take request and result as arguments.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
|
|
|
|||
|
|
@ -28,7 +28,9 @@
|
|||
/// @author Copyright 2013, triAGENS GmbH, Cologne, Germany
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
var is = require("org/arangodb/is"),
|
||||
var _ = require("underscore"),
|
||||
is = require("org/arangodb/is"),
|
||||
actions = require("org/arangodb/actions"),
|
||||
constructUrlObject,
|
||||
constructNickname,
|
||||
constructRoute,
|
||||
|
|
@ -84,17 +86,37 @@ constructNickname = function (httpMethod, url) {
|
|||
.toLowerCase();
|
||||
};
|
||||
|
||||
constructRoute = function (method, route, callback, controller) {
|
||||
constructRoute = function (method, route, callback, controller, constraints) {
|
||||
'use strict';
|
||||
return {
|
||||
url: constructUrlObject(route, undefined, method),
|
||||
action: {
|
||||
callback: function (req, res) {
|
||||
Object.keys(controller.injectors).forEach(function (key) {
|
||||
if (Object.prototype.hasOwnProperty.call(controller.injected, key)) {
|
||||
if (constraints) {
|
||||
try {
|
||||
_.each({
|
||||
urlParameters: constraints.urlParams,
|
||||
parameters: constraints.queryParams
|
||||
}, function (paramConstraints, paramsPropertyName) {
|
||||
var params = req[paramsPropertyName];
|
||||
_.each(paramConstraints, function (constraint, paramName) {
|
||||
var result = constraint.validate(params[paramName]);
|
||||
params[paramName] = result.value;
|
||||
if (result.error) {
|
||||
result.error.message = 'Invalid value for "' + paramName + '": ' + result.error.message;
|
||||
throw result.error;
|
||||
}
|
||||
});
|
||||
});
|
||||
} catch (err) {
|
||||
actions.resultBad(req, res, actions.HTTP_BAD, err.message);
|
||||
return;
|
||||
}
|
||||
}
|
||||
_.each(controller.injectors, function (injector, key) {
|
||||
if (_.has(controller.injected, key)) {
|
||||
return;
|
||||
}
|
||||
var injector = controller.injectors[key];
|
||||
if (typeof injector === 'function') {
|
||||
controller.injected[key] = injector();
|
||||
} else {
|
||||
|
|
|
|||
|
|
@ -180,7 +180,7 @@ extend(SwaggerDocs.prototype, {
|
|||
/// Used for documenting and constraining the routes.
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
RequestContext = function (executionBuffer, models, route, rootElement) {
|
||||
RequestContext = function (executionBuffer, models, route, rootElement, constraints) {
|
||||
'use strict';
|
||||
this.route = route;
|
||||
this.typeToRegex = {
|
||||
|
|
@ -189,6 +189,7 @@ RequestContext = function (executionBuffer, models, route, rootElement) {
|
|||
"string": "/[^/]+/"
|
||||
};
|
||||
this.rootElement = rootElement;
|
||||
this.constraints = constraints;
|
||||
|
||||
this.docs = new SwaggerDocs(this.route.docs, models);
|
||||
this.docs.addNickname(route.docs.httpMethod, route.url.match);
|
||||
|
|
@ -202,11 +203,9 @@ extend(RequestContext.prototype, {
|
|||
/// @startDocuBlock JSF_foxx_RequestContext_pathParam
|
||||
///
|
||||
/// If you defined a route "/foxx/:id", you can constrain which format a path
|
||||
/// parameter (*/foxx/12*) can have by giving it a type. We currently support
|
||||
/// the following types:
|
||||
/// parameter (*/foxx/12*) can have by giving it a *joi* type.
|
||||
///
|
||||
/// * int
|
||||
/// * string
|
||||
/// For more information on *joi* see [the official Joi documentation](https://github.com/spumko/joi).
|
||||
///
|
||||
/// You can also provide a description of this parameter.
|
||||
///
|
||||
|
|
@ -216,8 +215,7 @@ extend(RequestContext.prototype, {
|
|||
/// app.get("/foxx/:id", function {
|
||||
/// // Do something
|
||||
/// }).pathParam("id", {
|
||||
/// description: "Id of the Foxx",
|
||||
/// type: "int"
|
||||
/// type: joi.number().integer().required().description("Id of the Foxx")
|
||||
/// });
|
||||
/// ```
|
||||
/// @endDocuBlock
|
||||
|
|
@ -226,14 +224,49 @@ extend(RequestContext.prototype, {
|
|||
pathParam: function (paramName, attributes) {
|
||||
'use strict';
|
||||
var url = this.route.url,
|
||||
constraint = url.constraint || {};
|
||||
urlConstraint = url.constraint || {},
|
||||
type = attributes.type,
|
||||
required = attributes.required,
|
||||
description = attributes.description,
|
||||
constraint = type,
|
||||
regexType = type,
|
||||
cfg;
|
||||
|
||||
constraint[paramName] = this.typeToRegex[attributes.type];
|
||||
if (!constraint[paramName]) {
|
||||
throw new Error("Illegal attribute type: " + attributes.type);
|
||||
// deprecated: assume type.describe is always a function
|
||||
if (type && typeof type.describe === 'function') {
|
||||
if (typeof required === 'boolean') {
|
||||
constraint = required ? constraint.required() : constraint.optional();
|
||||
}
|
||||
if (typeof description === 'string') {
|
||||
constraint = constraint.description(description);
|
||||
}
|
||||
this.constraints.urlParams[paramName] = constraint;
|
||||
cfg = constraint.describe();
|
||||
required = Boolean(cfg.flags && cfg.flags.presense === 'required');
|
||||
description = cfg.description;
|
||||
type = cfg.type;
|
||||
if (
|
||||
type === 'number' &&
|
||||
_.isArray(cfg.rules) &&
|
||||
_.some(cfg.rules, function (rule) {
|
||||
return rule.name === 'integer';
|
||||
})
|
||||
) {
|
||||
type = 'integer';
|
||||
}
|
||||
if (_.has(this.typeToRegex, type)) {
|
||||
regexType = type;
|
||||
} else {
|
||||
regexType = 'string';
|
||||
}
|
||||
}
|
||||
this.route.url = internal.constructUrlObject(url.match, constraint, url.methods[0]);
|
||||
this.docs.addPathParam(paramName, attributes.description, attributes.type);
|
||||
|
||||
urlConstraint[paramName] = this.typeToRegex[regexType];
|
||||
if (!urlConstraint[paramName]) {
|
||||
throw new Error("Illegal attribute type: " + regexType);
|
||||
}
|
||||
this.route.url = internal.constructUrlObject(url.match, urlConstraint, url.methods[0]);
|
||||
this.docs.addPathParam(paramName, description, type);
|
||||
return this;
|
||||
},
|
||||
|
||||
|
|
@ -245,14 +278,12 @@ extend(RequestContext.prototype, {
|
|||
/// Describe a query parameter:
|
||||
///
|
||||
/// If you defined a route "/foxx", you can constrain which format a query
|
||||
/// parameter (*/foxx?a=12*) can have by giving it a type. We currently support
|
||||
/// the following types:
|
||||
/// parameter (*/foxx?a=12*) can have by giving it a *joi* type.
|
||||
///
|
||||
/// * int
|
||||
/// * string
|
||||
/// For more information on *joi* see [the official Joi documentation](https://github.com/spumko/joi).
|
||||
///
|
||||
/// You can also provide a description of this parameter, if it is required and
|
||||
/// if you can provide the parameter multiple times.
|
||||
/// You can also provide a description of this parameter and
|
||||
/// whether you can provide the parameter multiple times.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
///
|
||||
|
|
@ -260,9 +291,7 @@ extend(RequestContext.prototype, {
|
|||
/// app.get("/foxx", function {
|
||||
/// // Do something
|
||||
/// }).queryParam("id", {
|
||||
/// description: "Id of the Foxx",
|
||||
/// type: "int",
|
||||
/// required: true,
|
||||
/// type: joi.number().integer().required().description("Id of the Foxx"),
|
||||
/// allowMultiple: false
|
||||
/// });
|
||||
/// ```
|
||||
|
|
@ -271,11 +300,41 @@ extend(RequestContext.prototype, {
|
|||
|
||||
queryParam: function (paramName, attributes) {
|
||||
'use strict';
|
||||
var type = attributes.type,
|
||||
required = attributes.required,
|
||||
description = attributes.description,
|
||||
constraint = type,
|
||||
cfg;
|
||||
|
||||
// deprecated: assume type.describe is always a function
|
||||
if (type && typeof type.describe === 'function') {
|
||||
if (typeof required === 'boolean') {
|
||||
constraint = required ? constraint.required() : constraint.optional();
|
||||
}
|
||||
if (typeof description === 'string') {
|
||||
constraint = constraint.description(description);
|
||||
}
|
||||
this.constraints.queryParams[paramName] = constraint;
|
||||
cfg = constraint.describe();
|
||||
required = Boolean(cfg.flags && cfg.flags.presense === 'required');
|
||||
description = cfg.description;
|
||||
type = cfg.type;
|
||||
if (
|
||||
type === 'number' &&
|
||||
_.isArray(cfg.rules) &&
|
||||
_.some(cfg.rules, function (rule) {
|
||||
return rule.name === 'integer';
|
||||
})
|
||||
) {
|
||||
type = 'integer';
|
||||
}
|
||||
}
|
||||
|
||||
this.docs.addQueryParam(
|
||||
paramName,
|
||||
attributes.description,
|
||||
attributes.type,
|
||||
attributes.required,
|
||||
description,
|
||||
type,
|
||||
required,
|
||||
attributes.allowMultiple
|
||||
);
|
||||
return this;
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ var stub,
|
|||
allow,
|
||||
FunctionStub,
|
||||
mockConstructor,
|
||||
joi = require("joi"),
|
||||
_ = require("underscore");
|
||||
|
||||
// Sorry for Yak Shaving. But I can't take it anymore.
|
||||
|
|
@ -464,47 +465,49 @@ function DocumentationAndConstraintsSpec () {
|
|||
},
|
||||
|
||||
testDefinePathParam: function () {
|
||||
app.get('/foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("id", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
var constraint = joi.number().integer().description("Id of the Foxx"),
|
||||
context = app.get('/foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("id", {
|
||||
type: constraint
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].url.constraint.id, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "id");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "integer");
|
||||
assertEqual(context.constraints.urlParams, {id: constraint});
|
||||
},
|
||||
|
||||
testDefinePathCaseParam: function () {
|
||||
app.get('/foxx/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("idParam", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
var constraint = joi.number().integer().description("Id of the Foxx"),
|
||||
context = app.get('/foxx/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("idParam", {
|
||||
type: constraint
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].url.constraint.idParam, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "idParam");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "integer");
|
||||
assertEqual(context.constraints.urlParams, {idParam: constraint});
|
||||
},
|
||||
|
||||
testDefineMultiplePathParams: function () {
|
||||
app.get('/:foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("foxx", {
|
||||
description: "Kind of Foxx",
|
||||
type: "string"
|
||||
}).pathParam("id", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
var foxxConstraint = joi.string().description("Kind of Foxx"),
|
||||
idConstraint = joi.number().integer().description("Id of the Foxx"),
|
||||
context = app.get('/:foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("foxx", {
|
||||
type: foxxConstraint
|
||||
}).pathParam("id", {
|
||||
type: idConstraint
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
|
||||
|
|
@ -518,19 +521,21 @@ function DocumentationAndConstraintsSpec () {
|
|||
assertEqual(routes[0].docs.parameters[1].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[1].name, "id");
|
||||
assertEqual(routes[0].docs.parameters[1].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "integer");
|
||||
|
||||
assertEqual(context.constraints.urlParams, {foxx: foxxConstraint, id: idConstraint});
|
||||
},
|
||||
|
||||
testDefineMultiplePathCaseParams: function () {
|
||||
app.get('/:foxxParam/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("foxxParam", {
|
||||
description: "Kind of Foxx",
|
||||
type: "string"
|
||||
}).pathParam("idParam", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
var foxxConstraint = joi.string().description("Kind of Foxx"),
|
||||
idConstraint = joi.number().integer().description("Id of the Foxx"),
|
||||
context = app.get('/:foxxParam/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("foxxParam", {
|
||||
type: foxxConstraint
|
||||
}).pathParam("idParam", {
|
||||
type: idConstraint
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
|
||||
|
|
@ -544,26 +549,28 @@ function DocumentationAndConstraintsSpec () {
|
|||
assertEqual(routes[0].docs.parameters[1].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[1].name, "idParam");
|
||||
assertEqual(routes[0].docs.parameters[1].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "integer");
|
||||
|
||||
assertEqual(context.constraints.urlParams, {foxxParam: foxxConstraint, idParam: idConstraint});
|
||||
},
|
||||
|
||||
testDefineQueryParam: function () {
|
||||
app.get('/foxx', function () {
|
||||
//nothing
|
||||
}).queryParam("a", {
|
||||
description: "The value of an a",
|
||||
type: "int",
|
||||
required: false,
|
||||
allowMultiple: true
|
||||
});
|
||||
var constraint = joi.number().integer().description("The value of an a"),
|
||||
context = app.get('/foxx', function () {
|
||||
//nothing
|
||||
}).queryParam("a", {
|
||||
type: constraint,
|
||||
allowMultiple: true
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "query");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "a");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "The value of an a");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "integer");
|
||||
assertEqual(routes[0].docs.parameters[0].required, false);
|
||||
assertEqual(routes[0].docs.parameters[0].allowMultiple, true);
|
||||
assertEqual(context.constraints.queryParams, {a: constraint});
|
||||
},
|
||||
|
||||
testAddBodyParam: function () {
|
||||
|
|
@ -912,6 +919,160 @@ function LegacyDocumentationAndConstraintsSpec () {
|
|||
};
|
||||
}
|
||||
|
||||
function LegacyDocumentationAndConstraintsSpec () {
|
||||
var app, routes, models;
|
||||
|
||||
return {
|
||||
setUp: function () {
|
||||
app = new FoxxController(fakeContext);
|
||||
routes = app.routingInfo.routes;
|
||||
models = app.models;
|
||||
},
|
||||
|
||||
testDefinePathParamOverride: function () {
|
||||
var constraint = joi.number().integer().description("no text"),
|
||||
context = app.get('/foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("id", {
|
||||
type: constraint,
|
||||
description: "Id of the Foxx"
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].url.constraint.id, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "id");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "integer");
|
||||
assertEqual(context.constraints.urlParams, {id: constraint});
|
||||
},
|
||||
|
||||
testDefinePathParam: function () {
|
||||
app.get('/foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("id", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].url.constraint.id, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "id");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
},
|
||||
|
||||
testDefinePathCaseParam: function () {
|
||||
app.get('/foxx/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("idParam", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].url.constraint.idParam, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "idParam");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
},
|
||||
|
||||
testDefineMultiplePathParams: function () {
|
||||
app.get('/:foxx/:id', function () {
|
||||
//nothing
|
||||
}).pathParam("foxx", {
|
||||
description: "Kind of Foxx",
|
||||
type: "string"
|
||||
}).pathParam("id", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
|
||||
assertEqual(routes[0].url.constraint.foxx, "/[^/]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Kind of Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "string");
|
||||
|
||||
assertEqual(routes[0].url.constraint.id, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[1].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[1].name, "id");
|
||||
assertEqual(routes[0].docs.parameters[1].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "int");
|
||||
},
|
||||
|
||||
testDefineMultiplePathCaseParams: function () {
|
||||
app.get('/:foxxParam/:idParam', function () {
|
||||
//nothing
|
||||
}).pathParam("foxxParam", {
|
||||
description: "Kind of Foxx",
|
||||
type: "string"
|
||||
}).pathParam("idParam", {
|
||||
description: "Id of the Foxx",
|
||||
type: "int"
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
|
||||
assertEqual(routes[0].url.constraint.foxxParam, "/[^/]+/");
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "foxxParam");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "Kind of Foxx");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "string");
|
||||
|
||||
assertEqual(routes[0].url.constraint.idParam, "/[0-9]+/");
|
||||
assertEqual(routes[0].docs.parameters[1].paramType, "path");
|
||||
assertEqual(routes[0].docs.parameters[1].name, "idParam");
|
||||
assertEqual(routes[0].docs.parameters[1].description, "Id of the Foxx");
|
||||
assertEqual(routes[0].docs.parameters[1].dataType, "int");
|
||||
},
|
||||
|
||||
testDefineQueryParamOverride: function () {
|
||||
var constraint = joi.number().integer().description("no text"),
|
||||
context = app.get('/foxx', function () {
|
||||
//nothing
|
||||
}).queryParam("a", {
|
||||
type: constraint,
|
||||
required: true,
|
||||
description: "The value of an a",
|
||||
allowMultiple: true
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "query");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "a");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "The value of an a");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "integer");
|
||||
assertEqual(routes[0].docs.parameters[0].required, false);
|
||||
assertEqual(routes[0].docs.parameters[0].allowMultiple, true);
|
||||
assertEqual(context.constraints.queryParams, {a: constraint});
|
||||
},
|
||||
|
||||
testDefineQueryParam: function () {
|
||||
app.get('/foxx', function () {
|
||||
//nothing
|
||||
}).queryParam("a", {
|
||||
description: "The value of an a",
|
||||
type: "int",
|
||||
required: false,
|
||||
allowMultiple: true
|
||||
});
|
||||
|
||||
assertEqual(routes.length, 1);
|
||||
assertEqual(routes[0].docs.parameters[0].paramType, "query");
|
||||
assertEqual(routes[0].docs.parameters[0].name, "a");
|
||||
assertEqual(routes[0].docs.parameters[0].description, "The value of an a");
|
||||
assertEqual(routes[0].docs.parameters[0].dataType, "int");
|
||||
assertEqual(routes[0].docs.parameters[0].required, false);
|
||||
assertEqual(routes[0].docs.parameters[0].allowMultiple, true);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function AddMiddlewareFoxxControllerSpec () {
|
||||
var app;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue