' + propertiesStr.join(',
') + '
' + classClose;
+ if (!modelsToIgnore)
+ modelsToIgnore = [];
+ modelsToIgnore.push(this.name);
+
+ for (var i = 0; i < this.properties.length; i++) {
+ var prop = this.properties[i];
+ if ((prop.refModel != null) && modelsToIgnore.indexOf(prop.refModel.name) === -1) {
+ returnVal = returnVal + ('' + prop.refModel.getMockSignature(modelsToIgnore)); + } + } + return returnVal; +}; + +SwaggerModel.prototype.createJSONSample = function (modelsToIgnore) { + if (sampleModels[this.name]) { + return sampleModels[this.name]; + } + else { + var result = {}; + var modelsToIgnore = (modelsToIgnore || []); + modelsToIgnore.push(this.name); + for (var i = 0; i < this.properties.length; i++) { + var prop = this.properties[i]; + result[prop.name] = prop.getSampleValue(modelsToIgnore); + } + modelsToIgnore.pop(this.name); + return result; + } +}; + +var SwaggerModelProperty = function (name, obj, model) { + this.name = name; + this.dataType = obj.type || obj.dataType || obj['$ref']; + this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set'); + this.descr = obj.description; + this.required = obj.required; + this.defaultValue = applyModelPropertyMacro(obj, model); + if (obj.items != null) { + if (obj.items.type != null) { + this.refDataType = obj.items.type; + } + if (obj.items.$ref != null) { + this.refDataType = obj.items.$ref; + } + } + this.dataTypeWithRef = this.refDataType != null ? (this.dataType + '[' + this.refDataType + ']') : this.dataType; + if (obj.allowableValues != null) { + this.valueType = obj.allowableValues.valueType; + this.values = obj.allowableValues.values; + if (this.values != null) { + this.valuesString = '\'' + this.values.join('\' or \'') + '\''; + } + } + if (obj['enum'] != null) { + this.valueType = 'string'; + this.values = obj['enum']; + if (this.values != null) { + this.valueString = '\'' + this.values.join('\' or \'') + '\''; + } + } +}; + +SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) { + var result; + if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) { + result = this.refModel.createJSONSample(modelsToIgnore); + } else { + if (this.isCollection) { + result = this.toSampleValue(this.refDataType); + } else { + result = this.toSampleValue(this.dataType); + } + } + if (this.isCollection) { + return [result]; + } else { + return result; + } +}; + +SwaggerModelProperty.prototype.toSampleValue = function (value) { + var result; + if ((typeof this.defaultValue !== 'undefined') && this.defaultValue !== null) { + result = this.defaultValue; + } else if (value === 'integer') { + result = 0; + } else if (value === 'boolean') { + result = false; + } else if (value === 'double' || value === 'number') { + result = 0.0; + } else if (value === 'string') { + result = ''; + } else { + result = value; + } + return result; +}; + +SwaggerModelProperty.prototype.toString = function () { + var req = this.required ? 'propReq' : 'propOpt'; + var str = '' + this.name + ' (' + this.dataTypeWithRef + ''; + if (!this.required) { + str += ', optional'; + } + str += ')'; + if (this.values != null) { + str += ' = ["' + this.values.join('\' or \'') + '\']'; + } + if (this.descr != null) { + str += ': ' + this.descr + ''; + } + return str; +}; + +var SwaggerOperation = function (nickname, path, method, parameters, summary, notes, type, responseMessages, resource, consumes, produces, authorizations, deprecated) { + var _this = this; + + var errors = []; + this.nickname = (nickname || errors.push('SwaggerOperations must have a nickname.')); + this.path = (path || errors.push('SwaggerOperation ' + nickname + ' is missing path.')); + this.method = (method || errors.push('SwaggerOperation ' + nickname + ' is missing method.')); + this.parameters = parameters != null ? parameters : []; + this.summary = summary; + this.notes = notes; + this.type = type; + this.responseMessages = (responseMessages || []); + this.resource = (resource || errors.push('Resource is required')); + this.consumes = consumes; + this.produces = produces; + this.authorizations = typeof authorizations !== 'undefined' ? authorizations : resource.authorizations; + this.deprecated = deprecated; + this['do'] = __bind(this['do'], this); + + if (errors.length > 0) { + console.error('SwaggerOperation errors', errors, arguments); + this.resource.api.fail(errors); + } + + this.path = this.path.replace('{format}', 'json'); + this.method = this.method.toLowerCase(); + this.isGetMethod = this.method === 'GET'; + + this.resourceName = this.resource.name; + if (typeof this.type !== 'undefined' && this.type === 'void') + this.type = null; + else { + this.responseClassSignature = this.getSignature(this.type, this.resource.models); + this.responseSampleJSON = this.getSampleJSON(this.type, this.resource.models); + } + + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + // might take this away + param.name = param.name || param.type || param.dataType; + + // for 1.1 compatibility + var type = param.type || param.dataType; + if (type === 'array') { + type = 'array[' + (param.items.$ref ? param.items.$ref : param.items.type) + ']'; + } + param.type = type; + + if (type && type.toLowerCase() === 'boolean') { + param.allowableValues = {}; + param.allowableValues.values = ['true', 'false']; + } + param.signature = this.getSignature(type, this.resource.models); + param.sampleJSON = this.getSampleJSON(type, this.resource.models); + + var enumValue = param['enum']; + if (enumValue != null) { + param.isList = true; + param.allowableValues = {}; + param.allowableValues.descriptiveValues = []; + + for (var j = 0; j < enumValue.length; j++) { + var v = enumValue[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + else if (param.allowableValues != null) { + if (param.allowableValues.valueType === 'RANGE') + param.isRange = true; + else + param.isList = true; + if (param.allowableValues != null) { + param.allowableValues.descriptiveValues = []; + if (param.allowableValues.values) { + for (var j = 0; j < param.allowableValues.values.length; j++) { + var v = param.allowableValues.values[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + } + } + param.defaultValue = applyParameterMacro(param, this); + } + var defaultSuccessCallback = this.resource.api.defaultSuccessCallback || null; + var defaultErrorCallback = this.resource.api.defaultErrorCallback || null; + + this.resource[this.nickname] = function (args, opts, callback, error) { + var arg1, arg2, arg3, arg4; + if(typeof args === 'function') // right shift 3 + arg1 = {}, arg2 = {}, arg3 = args, arg4 = opts; + else if(typeof args === 'object' && typeof opts === 'function') // right shift 2 + arg1 = args, arg2 = {}, arg3 = opts, arg4 = callback; + else + arg1 = args, arg2 = opts, arg3 = callback, arg4 = error; + + return _this['do'](arg1 || {}, arg2 || {}, arg3 || defaultSuccessCallback, arg4 || defaultErrorCallback); + }; + + this.resource[this.nickname].help = function () { + return _this.help(); + }; + this.resource[this.nickname].asCurl = function (args) { + return _this.asCurl(args); + }; +} + +SwaggerOperation.prototype.isListType = function (type) { + if (type && type.indexOf('[') >= 0) { + return type.substring(type.indexOf('[') + 1, type.indexOf(']')); + } else { + return void 0; + } +}; + +SwaggerOperation.prototype.getSignature = function (type, models) { + var isPrimitive, listType; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + if (isPrimitive) { + return type; + } else { + if (listType != null) { + return models[listType].getMockSignature(); + } else { + return models[type].getMockSignature(); + } + } +}; + +SwaggerOperation.prototype.getSampleJSON = function (type, models) { + var isPrimitive, listType, val; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + val = isPrimitive ? void 0 : (listType != null ? models[listType].createJSONSample() : models[type].createJSONSample()); + if (val) { + val = listType ? [val] : val; + if (typeof val == 'string') + return val; + else if (typeof val === 'object') { + var t = val; + if (val instanceof Array && val.length > 0) { + t = val[0]; + } + if (t.nodeName) { + var xmlString = new XMLSerializer().serializeToString(t); + return this.formatXml(xmlString); + } + else + return JSON.stringify(val, null, 2); + } + else + return val; + } +}; + +SwaggerOperation.prototype['do'] = function (args, opts, callback, error) { + var key, param, params, possibleParams, req, value; + + if (error == null) { + error = function (xhr, textStatus, error) { + return log(xhr, textStatus, error); + }; + } + + if (callback == null) { + callback = function (response) { + var content; + content = null; + if (response != null) { + content = response.data; + } else { + content = 'no data'; + } + return log('default callback: ' + content); + }; + } + params = {}; + params.headers = []; + if (args.headers != null) { + params.headers = args.headers; + delete args.headers; + } + // allow override from the opts + if(opts && opts.responseContentType) { + params.headers['Content-Type'] = opts.responseContentType; + } + if(opts && opts.requestContentType) { + params.headers['Accept'] = opts.requestContentType; + } + + var possibleParams = []; + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if (param.paramType === 'header') { + if (typeof args[param.name] !== 'undefined') + params.headers[param.name] = args[param.name]; + } + else if (param.paramType === 'form' || param.paramType.toLowerCase() === 'file') + possibleParams.push(param); + else if (param.paramType === 'body' && param.name !== 'body' && typeof args[param.name] !== 'undefined') { + if (args.body) { + throw new Error('Saw two body params in an API listing; expecting a max of one.'); + } + args.body = args[param.name]; + } + } + + if (args.body != null) { + params.body = args.body; + delete args.body; + } + + if (possibleParams) { + var key; + for (key in possibleParams) { + var value = possibleParams[key]; + if (args[value.name]) { + params[value.name] = args[value.name]; + } + } + } + req = new SwaggerRequest(this.method, this.urlify(args), params, opts, callback, error, this); + if (opts.mock != null) { + return req; + } else { + return true; + } +}; + +SwaggerOperation.prototype.pathJson = function () { + return this.path.replace('{format}', 'json'); +}; + +SwaggerOperation.prototype.pathXml = function () { + return this.path.replace('{format}', 'xml'); +}; + +SwaggerOperation.prototype.encodePathParam = function (pathParam) { + var encParts, part, parts, _i, _len; + pathParam = pathParam.toString(); + if (pathParam.indexOf('/') === -1) { + return encodeURIComponent(pathParam); + } else { + parts = pathParam.split('/'); + encParts = []; + for (_i = 0, _len = parts.length; _i < _len; _i++) { + part = parts[_i]; + encParts.push(encodeURIComponent(part)); + } + return encParts.join('/'); + } +}; + +SwaggerOperation.prototype.urlify = function (args) { + var url = this.resource.basePath + this.pathJson(); + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (param.paramType === 'path') { + if (typeof args[param.name] !== 'undefined') { + // apply path params and remove from args + var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/?|$))', 'gi'); + url = url.replace(reg, this.encodePathParam(args[param.name])); + delete args[param.name]; + } + else + throw '' + param.name + ' is a required path param.'; + } + } + + var queryParams = ''; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if(param.paramType === 'query') { + if (queryParams !== '') + queryParams += '&'; + if (Array.isArray(param)) { + var j; + var output = ''; + for(j = 0; j < param.length; j++) { + if(j > 0) + output += ','; + output += encodeURIComponent(param[j]); + } + queryParams += encodeURIComponent(param.name) + '=' + output; + } + else { + if (typeof args[param.name] !== 'undefined') { + queryParams += encodeURIComponent(param.name) + '=' + encodeURIComponent(args[param.name]); + } else { + if (param.required) + throw '' + param.name + ' is a required query param.'; + } + } + } + } + if ((queryParams != null) && queryParams.length > 0) + url += '?' + queryParams; + return url; +}; + +SwaggerOperation.prototype.supportHeaderParams = function () { + return this.resource.api.supportHeaderParams; +}; + +SwaggerOperation.prototype.supportedSubmitMethods = function () { + return this.resource.api.supportedSubmitMethods; +}; + +SwaggerOperation.prototype.getQueryParams = function (args) { + return this.getMatchingParams(['query'], args); +}; + +SwaggerOperation.prototype.getHeaderParams = function (args) { + return this.getMatchingParams(['header'], args); +}; + +SwaggerOperation.prototype.getMatchingParams = function (paramTypes, args) { + var matchingParams = {}; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + param = params[i]; + if (args && args[param.name]) + matchingParams[param.name] = args[param.name]; + } + var headers = this.resource.api.headers; + var name; + for (name in headers) { + var value = headers[name]; + matchingParams[name] = value; + } + return matchingParams; +}; + +SwaggerOperation.prototype.help = function () { + var msg = ''; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (msg !== '') + msg += '\n'; + msg += '* ' + param.name + (param.required ? ' (required)' : '') + " - " + param.description; + } + return msg; +}; + +SwaggerOperation.prototype.asCurl = function (args) { + var results = []; + var i; + + var headers = SwaggerRequest.prototype.setHeaders(args, {}, this); + for(i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if(param.paramType && param.paramType === 'header' && args[param.name]) { + headers[param.name] = args[param.name]; + } + } + + var key; + for (key in headers) { + results.push('--header "' + key + ': ' + headers[key] + '"'); + } + return 'curl ' + (results.join(' ')) + ' ' + this.urlify(args); +}; + +SwaggerOperation.prototype.formatXml = function (xml) { + var contexp, formatted, indent, lastType, lines, ln, pad, reg, transitions, wsexp, _fn, _i, _len; + reg = /(>)(<)(\/*)/g; + wsexp = /[ ]*(.*)[ ]+\n/g; + contexp = /(<.+>)(.+\n)/g; + xml = xml.replace(reg, '$1\n$2$3').replace(wsexp, '$1\n').replace(contexp, '$1\n$2'); + pad = 0; + formatted = ''; + lines = xml.split('\n'); + indent = 0; + lastType = 'other'; + transitions = { + 'single->single': 0, + 'single->closing': -1, + 'single->opening': 0, + 'single->other': 0, + 'closing->single': 0, + 'closing->closing': -1, + 'closing->opening': 0, + 'closing->other': 0, + 'opening->single': 1, + 'opening->closing': 0, + 'opening->opening': 1, + 'opening->other': 1, + 'other->single': 0, + 'other->closing': -1, + 'other->opening': 0, + 'other->other': 0 + }; + _fn = function (ln) { + var fromTo, j, key, padding, type, types, value; + types = { + single: Boolean(ln.match(/<.+\/>/)), + closing: Boolean(ln.match(/<\/.+>/)), + opening: Boolean(ln.match(/<[^!?].*>/)) + }; + type = ((function () { + var _results; + _results = []; + for (key in types) { + value = types[key]; + if (value) { + _results.push(key); + } + } + return _results; + })())[0]; + type = type === void 0 ? 'other' : type; + fromTo = lastType + '->' + type; + lastType = type; + padding = ''; + indent += transitions[fromTo]; + padding = ((function () { + var _j, _ref5, _results; + _results = []; + for (j = _j = 0, _ref5 = indent; 0 <= _ref5 ? _j < _ref5 : _j > _ref5; j = 0 <= _ref5 ? ++_j : --_j) { + _results.push(' '); + } + return _results; + })()).join(''); + if (fromTo === 'opening->closing') { + return formatted = formatted.substr(0, formatted.length - 1) + ln + '\n'; + } else { + return formatted += padding + ln + '\n'; + } + }; + for (_i = 0, _len = lines.length; _i < _len; _i++) { + ln = lines[_i]; + _fn(ln); + } + return formatted; +}; + +var SwaggerRequest = function (type, url, params, opts, successCallback, errorCallback, operation, execution) { + var _this = this; + var errors = []; + this.useJQuery = (typeof operation.resource.useJQuery !== 'undefined' ? operation.resource.useJQuery : null); + this.type = (type || errors.push('SwaggerRequest type is required (get/post/put/delete/patch/options).')); + this.url = (url || errors.push('SwaggerRequest url is required.')); + this.params = params; + this.opts = opts; + this.successCallback = (successCallback || errors.push('SwaggerRequest successCallback is required.')); + this.errorCallback = (errorCallback || errors.push('SwaggerRequest error callback is required.')); + this.operation = (operation || errors.push('SwaggerRequest operation is required.')); + this.execution = execution; + this.headers = (params.headers || {}); + + if (errors.length > 0) { + throw errors; + } + + this.type = this.type.toUpperCase(); + + // set request, response content type headers + var headers = this.setHeaders(params, opts, this.operation); + var body = params.body; + + // encode the body for form submits + if (headers['Content-Type']) { + var values = {}; + var i; + var operationParams = this.operation.parameters; + for (i = 0; i < operationParams.length; i++) { + var param = operationParams[i]; + if (param.paramType === 'form') + values[param.name] = param; + } + + if (headers['Content-Type'].indexOf('application/x-www-form-urlencoded') === 0) { + var encoded = ''; + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + if (encoded !== '') + encoded += '&'; + encoded += encodeURIComponent(key) + '=' + encodeURIComponent(value); + } + } + body = encoded; + } + else if (headers['Content-Type'].indexOf('multipart/form-data') === 0) { + // encode the body for form submits + var data = ''; + var boundary = '----SwaggerFormBoundary' + Date.now(); + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + data += '--' + boundary + '\n'; + data += 'Content-Disposition: form-data; name="' + key + '"'; + data += '\n\n'; + data += value + '\n'; + } + } + data += '--' + boundary + '--\n'; + headers['Content-Type'] = 'multipart/form-data; boundary=' + boundary; + body = data; + } + } + + var obj; + if (!((this.headers != null) && (this.headers.mock != null))) { + obj = { + url: this.url, + method: this.type, + headers: headers, + body: body, + useJQuery: this.useJQuery, + on: { + error: function (response) { + return _this.errorCallback(response, _this.opts.parent); + }, + redirect: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + 307: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + response: function (response) { + return _this.successCallback(response, _this.opts.parent); + } + } + }; + + var status = false; + if (this.operation.resource && this.operation.resource.api && this.operation.resource.api.clientAuthorizations) { + // Get the client authorizations from the resource declaration + status = this.operation.resource.api.clientAuthorizations.apply(obj, this.operation.authorizations); + } else { + // Get the client authorization from the default authorization declaration + var e; + if (typeof window !== 'undefined') { + e = window; + } else { + e = exports; + } + status = e.authorizations.apply(obj, this.operation.authorizations); + } + + if (opts.mock == null) { + if (status !== false) { + new SwaggerHttp().execute(obj); + } else { + obj.canceled = true; + } + } else { + return obj; + } + } + return obj; +}; + +SwaggerRequest.prototype.setHeaders = function (params, opts, operation) { + // default type + var accepts = opts.responseContentType || 'application/json'; + var consumes = opts.requestContentType || 'application/json'; + + var allDefinedParams = operation.parameters; + var definedFormParams = []; + var definedFileParams = []; + var body = params.body; + var headers = {}; + + // get params from the operation and set them in definedFileParams, definedFormParams, headers + var i; + for (i = 0; i < allDefinedParams.length; i++) { + var param = allDefinedParams[i]; + if (param.paramType === 'form') + definedFormParams.push(param); + else if (param.paramType === 'file') + definedFileParams.push(param); + else if (param.paramType === 'header' && this.params.headers) { + var key = param.name; + var headerValue = this.params.headers[param.name]; + if (typeof this.params.headers[param.name] !== 'undefined') + headers[key] = headerValue; + } + } + + // if there's a body, need to set the accepts header via requestContentType + if (body && (this.type === 'POST' || this.type === 'PUT' || this.type === 'PATCH' || this.type === 'DELETE')) { + if (this.opts.requestContentType) + consumes = this.opts.requestContentType; + } else { + // if any form params, content type must be set + if (definedFormParams.length > 0) { + if (definedFileParams.length > 0) + consumes = 'multipart/form-data'; + else + consumes = 'application/x-www-form-urlencoded'; + } + else if (this.type === 'DELETE') + body = '{}'; + else if (this.type != 'DELETE') + consumes = null; + } + + if (consumes && this.operation.consumes) { + if (this.operation.consumes.indexOf(consumes) === -1) { + log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.operation.consumes)); + } + } + + if (this.opts && this.opts.responseContentType) { + accepts = this.opts.responseContentType; + } else { + accepts = 'application/json'; + } + if (accepts && operation.produces) { + if (operation.produces.indexOf(accepts) === -1) { + log('server can\'t produce ' + accepts); + } + } + + if ((consumes && body !== '') || (consumes === 'application/x-www-form-urlencoded')) + headers['Content-Type'] = consumes; + if (accepts) + headers['Accept'] = accepts; + return headers; +} + +/** + * SwaggerHttp is a wrapper for executing requests + */ +var SwaggerHttp = function () { }; + +SwaggerHttp.prototype.execute = function (obj) { + if (obj && (typeof obj.useJQuery === 'boolean')) + this.useJQuery = obj.useJQuery; + else + this.useJQuery = this.isIE8(); + + if (this.useJQuery) + return new JQueryHttpClient().execute(obj); + else + return new ShredHttpClient().execute(obj); +} + +SwaggerHttp.prototype.isIE8 = function () { + var detectedIE = false; + if (typeof navigator !== 'undefined' && navigator.userAgent) { + nav = navigator.userAgent.toLowerCase(); + if (nav.indexOf('msie') !== -1) { + var version = parseInt(nav.split('msie')[1]); + if (version <= 8) { + detectedIE = true; + } + } + } + return detectedIE; +}; + +/* + * JQueryHttpClient lets a browser take advantage of JQuery's cross-browser magic. + * NOTE: when jQuery is available it will export both '$' and 'jQuery' to the global space. + * Since we are using closures here we need to alias it for internal use. + */ +var JQueryHttpClient = function (options) { + this.options = options || {}; + if (!jQuery) { + var jQuery = window.jQuery; + } +} + +JQueryHttpClient.prototype.execute = function (obj) { + var cb = obj.on; + var request = obj; + + obj.type = obj.method; + obj.cache = false; + + obj.beforeSend = function (xhr) { + var key, results; + if (obj.headers) { + results = []; + var key; + for (key in obj.headers) { + if (key.toLowerCase() === 'content-type') { + results.push(obj.contentType = obj.headers[key]); + } else if (key.toLowerCase() === 'accept') { + results.push(obj.accepts = obj.headers[key]); + } else { + results.push(xhr.setRequestHeader(key, obj.headers[key])); + } + } + return results; + } + }; + + obj.data = obj.body; + obj.complete = function (response) { + var headers = {}, + headerArray = response.getAllResponseHeaders().split('\n'); + + for (var i = 0; i < headerArray.length; i++) { + var toSplit = headerArray[i].trim(); + if (toSplit.length === 0) + continue; + var separator = toSplit.indexOf(':'); + if (separator === -1) { + // Name but no value in the header + headers[toSplit] = null; + continue; + } + var name = toSplit.substring(0, separator).trim(), + value = toSplit.substring(separator + 1).trim(); + headers[name] = value; + } + + var out = { + url: request.url, + method: request.method, + status: response.status, + data: response.responseText, + headers: headers + }; + + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.responseText && response.responseText !== '') + out.obj = JSON.parse(response.responseText); + else + out.obj = {} + } + } + + if (response.status >= 200 && response.status < 300) + cb.response(out); + else if (response.status === 0 || (response.status >= 400 && response.status < 599)) + cb.error(out); + else + return cb.response(out); + }; + + jQuery.support.cors = true; + return jQuery.ajax(obj); +} + +/* + * ShredHttpClient is a light-weight, node or browser HTTP client + */ +var ShredHttpClient = function (options) { + this.options = (options || {}); + this.isInitialized = false; + + if (typeof window !== 'undefined') { + this.Shred = require('./shred'); + this.content = require('./shred/content'); + } + else + this.Shred = require('shred'); + this.shred = new this.Shred(); +} + +ShredHttpClient.prototype.initShred = function () { + this.isInitialized = true; + this.registerProcessors(this.shred); +} + +ShredHttpClient.prototype.registerProcessors = function () { + var identity = function (x) { + return x; + }; + var toString = function (x) { + return x.toString(); + }; + + if (typeof window !== 'undefined') { + this.content.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } else { + this.Shred.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } +} + +ShredHttpClient.prototype.execute = function (obj) { + if (!this.isInitialized) + this.initShred(); + + var cb = obj.on, res; + + var transform = function (response) { + var out = { + headers: response._headers, + url: response.request.url, + method: response.request.method, + status: response.status, + data: response.content.data + }; + + var headers = response._headers.normalized || response._headers; + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.content.data && response.content.data !== '') + try { + out.obj = JSON.parse(response.content.data); + } + catch (ex) { + // do not set out.obj + log('unable to parse JSON content'); + } + else + out.obj = {} + } + } + return out; + }; + + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + + return out; + }; + + var res = { + error: function (response) { + if (obj) + return cb.error(transform(response)); + }, + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { + if (obj) + return cb.error(transformError(err)); + }, + response: function (response) { + if (obj) + return cb.response(transform(response)); + } + }; + if (obj) { + obj.on = res; + } + return this.shred.request(obj); +}; + +/** + * SwaggerAuthorizations applys the correct authorization to an operation being executed + */ +var SwaggerAuthorizations = function (name, auth) { + this.authz = {}; + if(name && auth) { + this.authz[name] = auth; + } +}; + +SwaggerAuthorizations.prototype.add = function (name, auth) { + this.authz[name] = auth; + return auth; +}; + +SwaggerAuthorizations.prototype.remove = function (name) { + return delete this.authz[name]; +}; + +SwaggerAuthorizations.prototype.apply = function (obj, authorizations) { + var status = null; + var key, value, result; + + // if the "authorizations" key is undefined, or has an empty array, add all keys + if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { + for (key in this.authz) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + else { + for (name in authorizations) { + for (key in this.authz) { + if (key == name) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + } + } + + return status; +}; + +/** + * ApiKeyAuthorization allows a query param or header to be injected + */ +var ApiKeyAuthorization = function (name, value, type, delimiter) { + this.name = name; + this.value = value; + this.type = type; + this.delimiter = delimiter; +}; + +ApiKeyAuthorization.prototype.apply = function (obj) { + if (this.type === 'query') { + if (obj.url.indexOf('?') > 0) + obj.url = obj.url + '&' + this.name + '=' + this.value; + else + obj.url = obj.url + '?' + this.name + '=' + this.value; + return true; + } else if (this.type === 'header') { + if (typeof obj.headers[this.name] !== 'undefined') { + if (typeof this.delimiter !== 'undefined') + obj.headers[this.name] = obj.headers[this.name] + this.delimiter + this.value; + } + else + obj.headers[this.name] = this.value; + return true; + } +}; + +/** + * Password Authorization is a basic auth implementation + */ +var PasswordAuthorization = function (name, username, password) { + this.name = name; + this.username = username; + this.password = password; + this._btoa = null; + if (typeof window !== 'undefined') + this._btoa = btoa; + else + this._btoa = require('btoa'); +}; + +PasswordAuthorization.prototype.apply = function (obj) { + var base64encoder = this._btoa; + obj.headers['Authorization'] = 'Basic ' + base64encoder(this.username + ':' + this.password); + return true; +}; + +var SwaggerClient = function(url, options) { this.isBuilt = false; this.url = null; this.debug = false; @@ -307,22 +1858,23 @@ PrimitiveModel.prototype.getMockSignature = function(modelsToIgnore) { else this.url = url; else options = url; - if (options.url != null) + if (options.url !== null) this.url = options.url; - if (options.success != null) + if (options.success !== null) this.success = options.success; if (typeof options.useJQuery === 'boolean') this.useJQuery = options.useJQuery; + this.supportedSubmitMethods = options.supportedSubmitMethods || []; this.failure = options.failure != null ? options.failure : function() {}; this.progress = options.progress != null ? options.progress : function() {}; this.spec = options.spec; - if (options.success != null) + if (options.success !== null) this.build(); -} +}; SwaggerClient.prototype.build = function() { var self = this; @@ -482,7 +2034,7 @@ SwaggerClient.prototype.buildFromSpec = function(response) { if (this.success) this.success(); return this; -} +}; SwaggerClient.prototype.parseUri = function(uri) { var urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/; @@ -493,7 +2045,7 @@ SwaggerClient.prototype.parseUri = function(uri) { port: parts[12], path: parts[15] }; -} +}; SwaggerClient.prototype.help = function() { var i; @@ -502,11 +2054,11 @@ SwaggerClient.prototype.help = function() { var api = this.apis[i]; log(' * ' + api.nickname + ': ' + api.operation.summary); } -} +}; SwaggerClient.prototype.tagFromLabel = function(label) { return label; -} +}; SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { if(typeof op.operationId !== 'undefined') { @@ -519,7 +2071,7 @@ SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { .replace(/\}/g, "") .replace(/\./g, "_") + "_" + httpMethod; } -} +}; SwaggerClient.prototype.fail = function(message) { this.failure(message); @@ -534,7 +2086,7 @@ var OperationGroup = function(tag, operation) { this.operationsArray = []; this.description = operation.description || ""; -} +}; var Operation = function(parent, operationId, httpMethod, path, args, definitions) { var errors = []; @@ -652,11 +2204,11 @@ var Operation = function(parent, operationId, httpMethod, path, args, definition } return this; -} +}; OperationGroup.prototype.sort = function(sorter) { -} +}; Operation.prototype.getType = function (param) { var type = param.type; @@ -668,7 +2220,7 @@ Operation.prototype.getType = function (param) { else if(type === 'integer' && format === 'int64') str = 'long'; else if(type === 'integer') - str = 'integer' + str = 'integer'; else if(type === 'string' && format === 'date-time') str = 'date-time'; else if(type === 'string' && format === 'date') @@ -708,7 +2260,7 @@ Operation.prototype.getType = function (param) { return [ str ]; else return str; -} +}; Operation.prototype.resolveModel = function (schema, definitions) { if(typeof schema['$ref'] !== 'undefined') { @@ -722,7 +2274,7 @@ Operation.prototype.resolveModel = function (schema, definitions) { return new ArrayModel(schema); else return null; -} +}; Operation.prototype.help = function(dontPrint) { var out = this.nickname + ': ' + this.summary + '\n'; @@ -734,7 +2286,7 @@ Operation.prototype.help = function(dontPrint) { if(typeof dontPrint === 'undefined') log(out); return out; -} +}; Operation.prototype.getSignature = function(type, models) { var isPrimitive, listType; @@ -745,13 +2297,13 @@ Operation.prototype.getSignature = function(type, models) { } if(type === 'string') - isPrimitive = true + isPrimitive = true; else - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + isPrimitive = ((listType !== null) && models[listType]) || (models[type] != null) ? false : true; if (isPrimitive) { return type; } else { - if (listType != null) + if (listType !== null) return models[type].getMockSignature(); else return models[type].getMockSignature(); @@ -763,7 +2315,7 @@ Operation.prototype.supportHeaderParams = function () { }; Operation.prototype.supportedSubmitMethods = function () { - return this.resource.api.supportedSubmitMethods; + return this.parent.supportedSubmitMethods; }; Operation.prototype.getHeaderParams = function (args) { @@ -782,7 +2334,7 @@ Operation.prototype.getHeaderParams = function (args) { } } return headers; -} +}; Operation.prototype.urlify = function (args) { var formParams = {}; @@ -827,7 +2379,7 @@ Operation.prototype.urlify = function (args) { url += this.basePath; return url + requestUrl + querystring; -} +}; Operation.prototype.getMissingParams = function(args) { var missingParams = []; @@ -841,7 +2393,7 @@ Operation.prototype.getMissingParams = function(args) { } } return missingParams; -} +}; Operation.prototype.getBody = function(headers, args) { var formParams = {}; @@ -871,7 +2423,7 @@ Operation.prototype.getBody = function(headers, args) { } return body; -} +}; /** * gets sample response for a single operation @@ -902,14 +2454,14 @@ Operation.prototype.getSampleJSON = function(type, models) { else return sampleJson; } -} +}; /** * legacy binding **/ Operation.prototype["do"] = function(args, opts, callback, error, parent) { return this.execute(args, opts, callback, error, parent); -} +}; /** @@ -929,8 +2481,8 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { error = arg3; } - success = (success||log) - error = (error||log) + success = (success||log); + error = (error||log); var missingParams = this.getMissingParams(args); if(missingParams.length > 0) { @@ -941,7 +2493,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { var headers = this.getHeaderParams(args); var body = this.getBody(headers, args); - var url = this.urlify(args) + var url = this.urlify(args); var obj = { url: url, @@ -960,7 +2512,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { }; var status = e.authorizations.apply(obj, this.operation.security); new SwaggerHttp().execute(obj); -} +}; Operation.prototype.setContentTypes = function(args, opts) { // default type @@ -1017,7 +2569,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (consumes && this.consumes) { if (this.consumes.indexOf(consumes) === -1) { log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.consumes)); - consumes = this.operation.consumes[0]; } } @@ -1029,7 +2580,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts && this.produces) { if (this.produces.indexOf(accepts) === -1) { log('server can\'t produce ' + accepts); - accepts = this.produces[0]; } } @@ -1038,7 +2588,7 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts) headers['Accept'] = accepts; return headers; -} +}; Operation.prototype.asCurl = function (args) { var results = []; @@ -1049,7 +2599,7 @@ Operation.prototype.asCurl = function (args) { results.push("--header \"" + key + ": " + headers[key] + "\""); } return "curl " + (results.join(" ")) + " " + this.urlify(args); -} +}; Operation.prototype.encodePathCollection = function(type, name, value) { var encoded = ''; @@ -1071,14 +2621,14 @@ Operation.prototype.encodePathCollection = function(type, name, value) { encoded += separator + this.encodeQueryParam(value[i]); } return encoded; -} +}; Operation.prototype.encodeQueryCollection = function(type, name, value) { var encoded = ''; var i; if(type === 'default' || type === 'multi') { for(i = 0; i < value.length; i++) { - if(i > 0) encoded += '&' + if(i > 0) encoded += '&'; encoded += this.encodeQueryParam(name) + '=' + this.encodeQueryParam(value[i]); } } @@ -1109,14 +2659,11 @@ Operation.prototype.encodeQueryCollection = function(type, name, value) { } } return encoded; -} +}; -/** - * TODO this encoding needs to be changed - **/ Operation.prototype.encodeQueryParam = function(arg) { - return escape(arg); -} + return encodeURIComponent(arg); +}; /** * TODO revisit, might not want to leave '/' @@ -1153,11 +2700,11 @@ var Model = function(name, definition) { this.properties.push(new Property(key, property, required)); } } -} +}; Model.prototype.createJSONSample = function(modelsToIgnore) { var result = {}; - modelsToIgnore = (modelsToIgnore||{}) + modelsToIgnore = (modelsToIgnore||{}); modelsToIgnore[this.name] = this; var i; for (i = 0; i < this.properties.length; i++) { @@ -1176,7 +2723,7 @@ Model.prototype.getSampleValue = function(modelsToIgnore) { obj[property.name] = property.sampleValue(false, modelsToIgnore); } return obj; -} +}; Model.prototype.getMockSignature = function(modelsToIgnore) { var propertiesStr = []; @@ -1225,11 +2772,11 @@ var Property = function(name, obj, required) { this.optional = true; this.default = obj.default || null; this.example = obj.example || null; -} +}; Property.prototype.getSampleValue = function (modelsToIgnore) { return this.sampleValue(false, modelsToIgnore); -} +}; Property.prototype.isArray = function () { var schema = this.schema; @@ -1237,7 +2784,7 @@ Property.prototype.isArray = function () { return true; else return false; -} +}; Property.prototype.sampleValue = function(isArray, ignoredModels) { isArray = (isArray || this.isArray()); @@ -1280,7 +2827,7 @@ Property.prototype.sampleValue = function(isArray, ignoredModels) { return [output]; else return output; -} +}; getStringSignature = function(obj) { var str = ''; @@ -1313,16 +2860,16 @@ getStringSignature = function(obj) { if(obj.type === 'array') str += ']'; return str; -} +}; simpleRef = function(name) { if(typeof name === 'undefined') return null; if(name.indexOf("#/definitions/") === 0) - return name.substring('#/definitions/'.length) + return name.substring('#/definitions/'.length); else return name; -} +}; Property.prototype.toString = function() { var str = getStringSignature(this.obj); @@ -1338,7 +2885,7 @@ Property.prototype.toString = function() { if(typeof this.description !== 'undefined') str += ': ' + this.description; return str; -} +}; typeFromJsonSchema = function(type, format) { var str; @@ -1364,20 +2911,11 @@ typeFromJsonSchema = function(type, format) { str = 'string'; return str; -} - -var e = (typeof window !== 'undefined' ? window : exports); +}; var sampleModels = {}; var cookies = {}; var models = {}; - -e.authorizations = new SwaggerAuthorizations(); -e.ApiKeyAuthorization = ApiKeyAuthorization; -e.PasswordAuthorization = PasswordAuthorization; -e.CookieAuthorization = CookieAuthorization; -e.SwaggerClient = SwaggerClient; -e.Operation = Operation; /** * SwaggerHttp is a wrapper for executing requests */ @@ -1389,11 +2927,15 @@ SwaggerHttp.prototype.execute = function(obj) { else this.useJQuery = this.isIE8(); + if(obj && typeof obj.body === 'object') { + obj.body = JSON.stringify(obj.body); + } + if(this.useJQuery) return new JQueryHttpClient().execute(obj); else return new ShredHttpClient().execute(obj); -} +}; SwaggerHttp.prototype.isIE8 = function() { var detectedIE = false; @@ -1419,7 +2961,7 @@ var JQueryHttpClient = function(options) { if(!jQuery){ var jQuery = window.jQuery; } -} +}; JQueryHttpClient.prototype.execute = function(obj) { var cb = obj.on; @@ -1474,8 +3016,7 @@ JQueryHttpClient.prototype.execute = function(obj) { headers: headers }; - var contentType = (headers["content-type"]||headers["Content-Type"]||null) - + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { if(response.responseText && response.responseText !== "") { @@ -1488,7 +3029,7 @@ JQueryHttpClient.prototype.execute = function(obj) { } } else - out.obj = {} + out.obj = {}; } } @@ -1502,7 +3043,7 @@ JQueryHttpClient.prototype.execute = function(obj) { jQuery.support.cors = true; return jQuery.ajax(obj); -} +}; /* * ShredHttpClient is a light-weight, node or browser HTTP client @@ -1520,12 +3061,12 @@ var ShredHttpClient = function(options) { else this.Shred = require("shred"); this.shred = new this.Shred(options); -} +}; ShredHttpClient.prototype.initShred = function () { this.isInitialized = true; this.registerProcessors(this.shred); -} +}; ShredHttpClient.prototype.registerProcessors = function(shred) { var identity = function(x) { @@ -1546,7 +3087,7 @@ ShredHttpClient.prototype.registerProcessors = function(shred) { stringify: toString }); } -} +}; ShredHttpClient.prototype.execute = function(obj) { if(!this.isInitialized) @@ -1563,7 +3104,8 @@ ShredHttpClient.prototype.execute = function(obj) { data: response.content.data }; - var contentType = (response._headers["content-type"]||response._headers["Content-Type"]||null) + var headers = response._headers.normalized || response._headers; + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { @@ -1575,26 +3117,42 @@ ShredHttpClient.prototype.execute = function(obj) { // unable to parse } else - out.obj = {} + out.obj = {}; } } return out; }; - res = { - error: function(response) { + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + return out; + }; + + var res = { + error: function (response) { if (obj) return cb.error(transform(response)); }, - redirect: function(response) { + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { if (obj) - return cb.redirect(transform(response)); + return cb.error(transformError(err)); }, - 307: function(response) { - if (obj) - return cb.redirect(transform(response)); - }, - response: function(response) { + response: function (response) { if (obj) return cb.response(transform(response)); } @@ -1603,4 +3161,31 @@ ShredHttpClient.prototype.execute = function(obj) { obj.on = res; } return this.shred.request(obj); -}; \ No newline at end of file +}; + +var e = (typeof window !== 'undefined' ? window : exports); + +e.authorizations = new SwaggerAuthorizations(); +e.ApiKeyAuthorization = ApiKeyAuthorization; +e.PasswordAuthorization = PasswordAuthorization; +e.CookieAuthorization = CookieAuthorization; +e.SwaggerClient = SwaggerClient; +e.Operation = Operation; + +// 1.x compat +// e.SampleModels = sampleModels; +// e.SwaggerHttp = SwaggerHttp; +// e.SwaggerRequest = SwaggerRequest; +// e.SwaggerAuthorizations = SwaggerAuthorizations; +// e.authorizations = new SwaggerAuthorizations(); +// e.ApiKeyAuthorization = ApiKeyAuthorization; +// e.PasswordAuthorization = PasswordAuthorization; +// e.CookieAuthorization = CookieAuthorization; +// e.JQueryHttpClient = JQueryHttpClient; +// e.ShredHttpClient = ShredHttpClient; +// e.SwaggerOperation = SwaggerOperation; +// e.SwaggerModel = SwaggerModel; +// e.SwaggerModelProperty = SwaggerModelProperty; +// e.SwaggerResource = SwaggerResource; +e.SwaggerApi = SwaggerApi; +})(); \ No newline at end of file diff --git a/dist/swagger-ui.js b/dist/swagger-ui.js index b052b435..cab168ca 100644 --- a/dist/swagger-ui.js +++ b/dist/swagger-ui.js @@ -271,7 +271,7 @@ function program1(depth0,data) { stack2 = ((stack1 = ((stack1 = depth0.info),stack1 == null || stack1 === false ? stack1 : stack1.description)),typeof stack1 === functionType ? stack1.apply(depth0) : stack1); if(stack2 || stack2 === 0) { buffer += stack2; } buffer += "\n "; - stack2 = helpers['if'].call(depth0, ((stack1 = depth0.info),stack1 == null || stack1 === false ? stack1 : stack1.termsOfServiceUrl), {hash:{},inverse:self.noop,fn:self.program(2, program2, data),data:data}); + stack2 = helpers['if'].call(depth0, ((stack1 = depth0.info),stack1 == null || stack1 === false ? stack1 : stack1.termsOfService), {hash:{},inverse:self.noop,fn:self.program(2, program2, data),data:data}); if(stack2 || stack2 === 0) { buffer += stack2; } buffer += "\n "; stack2 = helpers['if'].call(depth0, ((stack1 = depth0.info),stack1 == null || stack1 === false ? stack1 : stack1.contact), {hash:{},inverse:self.noop,fn:self.program(4, program4, data),data:data}); @@ -286,7 +286,7 @@ function program2(depth0,data) { var buffer = "", stack1; buffer += ""; return buffer; } diff --git a/dist/swagger-ui.min.js b/dist/swagger-ui.min.js index 330262f1..838d860f 100644 --- a/dist/swagger-ui.min.js +++ b/dist/swagger-ui.min.js @@ -1 +1 @@ -$(function(){$.fn.vAlign=function(){return this.each(function(c){var a=$(this).height();var d=$(this).parent().height();var b=(d-a)/2;$(this).css("margin-top",b)})};$.fn.stretchFormtasticInputWidthToParent=function(){return this.each(function(b){var d=$(this).closest("form").innerWidth();var c=parseInt($(this).closest("form").css("padding-left"),10)+parseInt($(this).closest("form").css("padding-right"),10);var a=parseInt($(this).css("padding-left"),10)+parseInt($(this).css("padding-right"),10);$(this).css("width",d-c-a)})};$("form.formtastic li.string input, form.formtastic textarea").stretchFormtasticInputWidthToParent();$("ul.downplayed li div.content p").vAlign();$("form.sandbox").submit(function(){var a=true;$(this).find("input.required").each(function(){$(this).removeClass("error");if($(this).val()==""){$(this).addClass("error");$(this).wiggle();a=false}});return a})});function clippyCopiedCallback(b){$("#api_key_copied").fadeIn().delay(1000).fadeOut()}log=function(){log.history=log.history||[];log.history.push(arguments);if(this.console){console.log(Array.prototype.slice.call(arguments)[0])}};if(Function.prototype.bind&&console&&typeof console.log=="object"){["log","info","warn","error","assert","dir","clear","profile","profileEnd"].forEach(function(a){console[a]=this.bind(console[a],console)},Function.prototype.call)}var Docs={shebang:function(){var b=$.param.fragment().split("/");b.shift();switch(b.length){case 1:var d="resource_"+b[0];Docs.expandEndpointListForResource(b[0]);$("#"+d).slideto({highlight:false});break;case 2:Docs.expandEndpointListForResource(b[0]);$("#"+d).slideto({highlight:false});var c=b.join("_");var a=c+"_content";Docs.expandOperation($("#"+a));$("#"+c).slideto({highlight:false});break}},toggleEndpointListForResource:function(b){var a=$("li#resource_"+Docs.escapeResourceName(b)+" ul.endpoints");if(a.is(":visible")){Docs.collapseEndpointListForResource(b)}else{Docs.expandEndpointListForResource(b)}},expandEndpointListForResource:function(b){var b=Docs.escapeResourceName(b);if(b==""){$(".resource ul.endpoints").slideDown();return}$("li#resource_"+b).addClass("active");var a=$("li#resource_"+b+" ul.endpoints");a.slideDown()},collapseEndpointListForResource:function(b){var b=Docs.escapeResourceName(b);$("li#resource_"+b).removeClass("active");var a=$("li#resource_"+b+" ul.endpoints");a.slideUp()},expandOperationsForResource:function(a){Docs.expandEndpointListForResource(a);if(a==""){$(".resource ul.endpoints li.operation div.content").slideDown();return}$("li#resource_"+Docs.escapeResourceName(a)+" li.operation div.content").each(function(){Docs.expandOperation($(this))})},collapseOperationsForResource:function(a){Docs.expandEndpointListForResource(a);$("li#resource_"+Docs.escapeResourceName(a)+" li.operation div.content").each(function(){Docs.collapseOperation($(this))})},escapeResourceName:function(a){return a.replace(/[!"#$%&'()*+,.\/:;<=>?@\[\\\]\^`{|}~]/g,"\\$&")},expandOperation:function(a){a.slideDown()},collapseOperation:function(a){a.slideUp()}};(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.apikey_button_view=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+="
\n
\n\n';return g})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.basic_auth_button_view=b(function(f,g,d,c,e){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,f.helpers);e=e||{};return'\n
\n";if(c=d.keyName){c=c.call(k,{hash:{},data:i})}else{c=k.keyName;c=typeof c===f?c.apply(k):c}g+=h(c)+'
\n \n \n 
\n \n
\n\n'})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.content_type=b(function(g,l,f,k,j){this.compilerInfo=[4,">= 1.0.0"];f=this.merge(f,g.helpers);j=j||{};var i="",c,h="function",m=this;function e(r,q){var o="",p;o+="\n ";p=f.each.call(r,r.produces,{hash:{},inverse:m.noop,fn:m.program(2,d,q),data:q});if(p||p===0){o+=p}o+="\n";return o}function d(r,q){var o="",p;o+='\n \n ";return o}function n(p,o){return'\n \n'}i+='\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.main=b(function(h,n,g,m,l){this.compilerInfo=[4,">= 1.0.0"];g=this.merge(g,h.helpers);l=l||{};var j="",c,s,i="function",k=this.escapeExpression,q=this;function f(x,w){var t="",v,u;t+='\n '+k(((v=((v=x.info),v==null||v===false?v:v.title)),typeof v===i?v.apply(x):v))+'
\n ';u=((v=((v=x.info),v==null||v===false?v:v.description)),typeof v===i?v.apply(x):v);if(u||u===0){t+=u}t+="
\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.termsOfServiceUrl),{hash:{},inverse:q.noop,fn:q.program(2,d,w),data:w});if(u||u===0){t+=u}t+="\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.contact),{hash:{},inverse:q.noop,fn:q.program(4,r,w),data:w});if(u||u===0){t+=u}t+="\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.license),{hash:{},inverse:q.noop,fn:q.program(6,p,w),data:w});if(u||u===0){t+=u}t+="\n ";return t}function d(w,v){var t="",u;t+='';return t}function r(w,v){var t="",u;t+="';return t}function p(w,v){var t="",u;t+="";return t}function o(w,v){var t="",u;t+='\n , api version: '+k(((u=((u=w.info),u==null||u===false?u:u.version)),typeof u===i?u.apply(w):u))+"\n ";return t}function e(w,v){var t="",u;t+='\n \n ";c=g["if"].call(n,n.info,{hash:{},inverse:q.noop,fn:q.program(1,f,l),data:l});if(c||c===0){j+=c}j+="\n
\n\n
\n";return j})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.operation=b(function(j,u,s,o,A){this.compilerInfo=[4,">= 1.0.0"];s=this.merge(s,j.helpers);A=A||{};var t="",k,f,e="function",d=this.escapeExpression,r=this,c=s.blockHelperMissing;function q(C,B){return"deprecated"}function p(C,B){return"\n Warning: Deprecated
\n "}function n(E,D){var B="",C;B+="\nImplementation Notes
\n";if(C=s.description){C=C.call(E,{hash:{},data:D})}else{C=E.description;C=typeof C===e?C.apply(E):C}if(C||C===0){B+=C}B+="
\n ";return B}function m(C,B){return'\n\n '}function i(E,D){var B="",C;B+='\n \n ";return B}function z(F,E){var B="",D,C;B+="\n
"}function x(C,B){return'\n "+d(((D=F.scope),typeof D===e?D.apply(F):D))+"
\n ";return B}function y(C,B){return"\n \n
\n '}function w(C,B){return'\n Response Class
\n\n
\n \n '}function v(C,B){return'\n
Parameters
\n| Parameter | \nValue | \nDescription | \nParameter Type | \nData Type | \n
|---|
Response Messages
\n| HTTP Status Code | \nReason | \nResponse Model | \n
|---|
\n \n \n \n
\n "}t+="\n - \n
- \n \n \n \n
\n \n ';return v}function e(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y.isFile,{hash:{},inverse:n.program(10,u,x),fn:n.program(2,l,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function u(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y["default"],{hash:{},inverse:n.program(13,r,x),fn:n.program(11,s,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function s(y,x){var v="",w;v+="\n \n ";return v}function r(y,x){var v="",w;v+="\n \n ";return v}p+="
\n \n ';return w}function e(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z.isFile,{hash:{},inverse:n.program(12,t,y),fn:n.program(10,v,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function v(z,y){var w="",x;w+="\n \n ";return w}function t(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z["default"],{hash:{},inverse:n.program(15,r,y),fn:n.program(13,s,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function s(z,y){var w="",x;w+="\n \n ";return w}function r(z,y){var w="",x;w+="\n \n ";return w}p+="
\n
\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.response_content_type=b(function(g,l,f,k,j){this.compilerInfo=[4,">= 1.0.0"];f=this.merge(f,g.helpers);j=j||{};var i="",c,h="function",m=this;function e(r,q){var o="",p;o+="\n ";p=f.each.call(r,r.produces,{hash:{},inverse:m.noop,fn:m.program(2,d,q),data:q});if(p||p===0){o+=p}o+="\n";return o}function d(r,q){var o="",p;o+='\n \n ";return o}function n(p,o){return'\n \n'}i+='\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.signature=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+='\n ';if(d=f.name){d=d.call(m,{hash:{},data:k})}else{d=m.name;d=typeof d===h?d.apply(m):d}i+=j(d)+" ";p={hash:{},inverse:o.noop,fn:o.program(1,e,k),data:k};if(d=f.summary){d=d.call(m,p)}else{d=m.summary;d=typeof d===h?d.apply(m):d}if(!f.summary){d=n.call(m,d,p)}if(d||d===0){i+=d}if(d=f.summary){d=d.call(m,{hash:{},data:k})}else{d=m.summary;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+="\n
\n \n\n
- \n
- Model \n
- Model Schema \n
\n\n";if(c=d.code){c=c.call(k,{hash:{},data:i})}else{c=k.code;c=typeof c===f?c.apply(k):c}g+=h(c)+" \n";if(c=d.message){c=c.call(k,{hash:{},data:i})}else{c=k.message;c=typeof c===f?c.apply(k):c}if(c||c===0){g+=c}g+=" \nF){O=F-G}if(OE){L=E-I}if(L0){H[M.name]=M.value}if(M.type==="file"){R=true}}I=K.find("textarea");for(P=0,J=I.length;P0){H[M.name]=M.value}}F=K.find("select");for(O=0,G=F.length;O0){H[M.name]=N}}E.responseContentType=$("div select[name=responseContentType]",$(this.el)).val();E.requestContentType=$("div select[name=parameterContentType]",$(this.el)).val();$(".response_throbber",$(this.el)).show();if(R){return this.handleFileUpload(H,K)}else{return this.model["do"](H,E,this.showCompleteStatus,this.showErrorStatus,this)}}};C.prototype.success=function(E,F){return F.showCompleteStatus(E)};C.prototype.handleFileUpload=function(V,M){var Q,L,G,R,P,O,T,N,K,J,H,U,Y,X,W,I,F,E,Z,S=this;I=M.serializeArray();for(N=0,U=I.length;N0){V[R.name]=R.value}}Q=new FormData();T=0;F=this.model.parameters;for(K=0,Y=F.length;K");$(".request_url pre",$(this.el)).text(this.invocationUrl);P={type:this.model.method,url:this.invocationUrl,headers:G,data:Q,dataType:"json",contentType:false,processData:false,error:function(ab,ac,aa){return S.showErrorStatus(S.wrap(ab),S)},success:function(aa){return S.showResponse(aa,S)},complete:function(aa){return S.showCompleteStatus(S.wrap(aa),S)}};if(window.authorizations){window.authorizations.apply(P)}if(T===0){P.data.append("fake","true")}jQuery.ajax(P);return false};C.prototype.wrap=function(I){var G,J,L,F,K,H,E;L={};J=I.getAllResponseHeaders().split("\r");for(H=0,E=J.length;H0){return G}else{return null}}};C.prototype.hideResponse=function(E){if(E!=null){E.preventDefault()}$(".response",$(this.el)).slideUp();return $(".response_hider",$(this.el)).fadeOut()};C.prototype.showResponse=function(E){var F;F=JSON.stringify(E,null,"\t").replace(/\n/g,"
");return $(".response_body",$(this.el)).html(escape(F))};C.prototype.showErrorStatus=function(F,E){return E.showStatus(F)};C.prototype.showCompleteStatus=function(F,E){return E.showStatus(F)};C.prototype.formatXml=function(L){var H,K,F,M,R,N,G,E,P,Q,J,I,O;E=/(>)(<)(\/*)/g;Q=/[ ]*(.*)[ ]+\n/g;H=/(<.+>)(.+\n)/g;L=L.replace(E,"$1\n$2$3").replace(Q,"$1\n").replace(H,"$1\n$2");G=0;K="";R=L.split("\n");F=0;M="other";P={"single->single":0,"single->closing":-1,"single->opening":0,"single->other":0,"closing->single":0,"closing->closing":-1,"closing->opening":0,"closing->other":0,"opening->single":1,"opening->closing":0,"opening->opening":1,"opening->other":1,"other->single":0,"other->closing":-1,"other->opening":0,"other->other":0};J=function(X){var T,S,V,Z,W,U,Y;U={single:Boolean(X.match(/<.+\/>/)),closing:Boolean(X.match(/<\/.+>/)),opening:Boolean(X.match(/<[^!?].*>/))};W=((function(){var aa;aa=[];for(V in U){Y=U[V];if(Y){aa.push(V)}}return aa})())[0];W=W===void 0?"other":W;T=M+"->"+W;M=W;Z="";F+=P[T];Z=((function(){var ab,ac,aa;aa=[];for(S=ab=0,ac=F;0<=ac?abac;S=0<=ac?++ab:--ab){aa.push(" ")}return aa})()).join("");if(T==="opening->closing"){return K=K.substr(0,K.length-1)+X+"\n"}else{return K+=Z+X+"\n"}};for(I=0,O=R.length;I![]()
").attr("src",F)}else{G=$("\n\n{u=u.call(w,{hash:{},data:v})}else{u=w.validatorUrl;u=typeof u===i?u.apply(w):u}t+=k(u)+)
\n \n ';return t}j+="
\n \n '}function v(C,B){return'\n\n \n
\n '}function l(C,B){return"\n \n \n \n
\n "}function h(C,B){return"\n "}function g(C,B){return"\n
\n \n ';return v}function e(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y.isFile,{hash:{},inverse:n.program(10,u,x),fn:n.program(2,l,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function u(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y["default"],{hash:{},inverse:n.program(13,r,x),fn:n.program(11,s,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function s(y,x){var v="",w;v+="\n \n ";return v}function r(y,x){var v="",w;v+="\n \n ";return v}p+="";if(g=o.name){g=g.call(q,{hash:{},data:t})}else{g=q.name;g=typeof g===d?g.apply(q):g}p+=c(g)+" \n\n\n ";g=o["if"].call(q,q.isBody,{hash:{},inverse:n.program(9,e,t),fn:n.program(1,m,t),data:t});if(g||g===0){p+=g}p+="\n\n \n";if(g=o.description){g=g.call(q,{hash:{},data:t})}else{g=q.description;g=typeof g===d?g.apply(q):g}if(g||g===0){p+=g}p+=" \n";if(g=o.paramType){g=g.call(q,{hash:{},data:t})}else{g=q.paramType;g=typeof g===d?g.apply(q):g}if(g||g===0){p+=g}p+=' \n\n \n \n';return p})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.param_list=b(function(h,t,r,m,y){this.compilerInfo=[4,">= 1.0.0"];r=this.merge(r,h.helpers);y=y||{};var s="",j,g,e,p=this,q=r.helperMissing,d="function",c=this.escapeExpression;function o(A,z){return" multiple='multiple'"}function n(A,z){return"\n "}function l(C,B){var z="",A;z+="\n ";A=r["if"].call(C,C["default"],{hash:{},inverse:p.program(8,i,B),fn:p.program(6,k,B),data:B});if(A||A===0){z+=A}z+="\n ";return z}function k(A,z){return"\n "}function i(E,D){var z="",C,B,A;z+="\n ";A={hash:{},inverse:p.program(11,x,D),fn:p.program(9,f,D),data:D};B=((C=r.isArray||E.isArray),C?C.call(E,E,A):q.call(E,"isArray",E,A));if(B||B===0){z+=B}z+="\n ";return z}function f(A,z){return"\n "}function x(A,z){return"\n \n "}function w(C,B){var z="",A;z+="\n ";A=r["if"].call(C,C.isDefault,{hash:{},inverse:p.program(16,u,B),fn:p.program(14,v,B),data:B});if(A||A===0){z+=A}z+="\n ";return z}function v(C,B){var z="",A;z+='\n \n ";return z}function u(C,B){var z="",A;z+="\n \n ";return z}s+="";if(j=r.name){j=j.call(t,{hash:{},data:y})}else{j=t.name;j=typeof j===d?j.apply(t):j}s+=c(j)+" \n\n \n \n";if(g=r.description){g=g.call(t,{hash:{},data:y})}else{g=t.description;g=typeof g===d?g.apply(t):g}if(g||g===0){s+=g}s+=" \n";if(g=r.paramType){g=g.call(t,{hash:{},data:y})}else{g=t.paramType;g=typeof g===d?g.apply(t):g}if(g||g===0){s+=g}s+=' \n";if(d=f.name){d=d.call(m,{hash:{},data:k})}else{d=m.name;d=typeof d===h?d.apply(m):d}i+=j(d)+" \n\n ";d=f["if"].call(m,m.isBody,{hash:{},inverse:o.program(3,c,k),fn:o.program(1,e,k),data:k});if(d||d===0){i+=d}i+="\n \n";if(d=f.description){d=d.call(m,{hash:{},data:k})}else{d=m.description;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+=" \n";if(d=f.paramType){d=d.call(m,{hash:{},data:k})}else{d=m.paramType;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+=' \n";if(d=f.name){d=d.call(m,{hash:{},data:k})}else{d=m.name;d=typeof d===h?d.apply(m):d}i+=j(d)+" \n\n ";d=f["if"].call(m,m.isBody,{hash:{},inverse:o.program(3,c,k),fn:o.program(1,e,k),data:k});if(d||d===0){i+=d}i+="\n \n";if(d=f.description){d=d.call(m,{hash:{},data:k})}else{d=m.description;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+=" \n";if(d=f.paramType){d=d.call(m,{hash:{},data:k})}else{d=m.paramType;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+=' \n
\n \n ';return w}function e(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z.isFile,{hash:{},inverse:n.program(12,t,y),fn:n.program(10,v,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function v(z,y){var w="",x;w+="\n \n ";return w}function t(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z["default"],{hash:{},inverse:n.program(15,r,y),fn:n.program(13,s,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function s(z,y){var w="",x;w+="\n \n ";return w}function r(z,y){var w="",x;w+="\n \n ";return w}p+="";if(g=o.name){g=g.call(q,{hash:{},data:u})}else{g=q.name;g=typeof g===d?g.apply(q):g}p+=c(g)+" \n\n ";g=o["if"].call(q,q.isBody,{hash:{},inverse:n.program(9,e,u),fn:n.program(1,m,u),data:u});if(g||g===0){p+=g}p+="\n \n\n ";if(g=o.description){g=g.call(q,{hash:{},data:u})}else{g=q.description;g=typeof g===d?g.apply(q):g}if(g||g===0){p+=g}p+="\n \n";if(g=o.paramType){g=g.call(q,{hash:{},data:u})}else{g=q.paramType;g=typeof g===d?g.apply(q):g}if(g||g===0){p+=g}p+=' \n\n Raw\n ";return q}i+="
\n
\n\n';return g})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.status_code=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+="\n ';if(c=d.signature){c=c.call(k,{hash:{},data:i})}else{c=k.signature;c=typeof c===f?c.apply(k):c}if(c||c===0){g+=c}g+='\n
\n\n \n
\n';if(c=d.sampleJSON){c=c.call(k,{hash:{},data:i})}else{c=k.sampleJSON;c=typeof c===f?c.apply(k):c}g+=h(c)+'");return $(".response_body",$(this.el)).html(escape(F))};C.prototype.showErrorStatus=function(F,E){return E.showStatus(F)};C.prototype.showCompleteStatus=function(F,E){return E.showStatus(F)};C.prototype.formatXml=function(L){var H,K,F,M,R,N,G,E,P,Q,J,I,O;E=/(>)(<)(\/*)/g;Q=/[ ]*(.*)[ ]+\n/g;H=/(<.+>)(.+\n)/g;L=L.replace(E,"$1\n$2$3").replace(Q,"$1\n").replace(H,"$1\n$2");G=0;K="";R=L.split("\n");F=0;M="other";P={"single->single":0,"single->closing":-1,"single->opening":0,"single->other":0,"closing->single":0,"closing->closing":-1,"closing->opening":0,"closing->other":0,"opening->single":1,"opening->closing":0,"opening->opening":1,"opening->other":1,"other->single":0,"other->closing":-1,"other->opening":0,"other->other":0};J=function(X){var T,S,V,Z,W,U,Y;U={single:Boolean(X.match(/<.+\/>/)),closing:Boolean(X.match(/<\/.+>/)),opening:Boolean(X.match(/<[^!?].*>/))};W=((function(){var aa;aa=[];for(V in U){Y=U[V];if(Y){aa.push(V)}}return aa})())[0];W=W===void 0?"other":W;T=M+"->"+W;M=W;Z="";F+=P[T];Z=((function(){var ab,ac,aa;aa=[];for(S=ab=0,ac=F;0<=ac?ab
"+J.status+"");$(".response_body",$(this.el)).html(L);$(".response_headers",$(this.el)).html("
"+_.escape(JSON.stringify(J.headers,null," ")).replace(/\n/g,"");$(".response",$(this.el)).slideDown();$(".response_hider",$(this.el)).show();$(".response_throbber",$(this.el)).hide();K=$(".response_body",$(this.el))[0];E=this.options.swaggerOptions;if(E.highlightSizeThreshold&&J.data.length>E.highlightSizeThreshold){return K}else{return hljs.highlightBlock(K)}};C.prototype.toggleOperationContent=function(){var E;E=$("#"+Docs.escapeResourceName(this.model.parentId+"_"+this.model.nickname+"_content"));if(E.is(":visible")){return Docs.collapseOperation(E)}else{return Docs.expandOperation(E)}};return C})(Backbone.View);r=(function(D){y(C,D);function C(){e=C.__super__.constructor.apply(this,arguments);return e}C.prototype.initialize=function(){};C.prototype.render=function(){var F,E,G;G=this.template();$(this.el).html(G(this.model));if(swaggerUi.api.models.hasOwnProperty(this.model.responseModel)){F={sampleJSON:JSON.stringify(swaggerUi.api.models[this.model.responseModel].createJSONSample(),null,2),isParam:false,signature:swaggerUi.api.models[this.model.responseModel].getMockSignature()};E=new j({model:F,tagName:"div"});$(".model-signature",this.$el).append(E.render().el)}else{$(".model-signature",this.$el).html("")}return this};C.prototype.template=function(){return Handlebars.templates.status_code};return C})(Backbone.View);m=(function(D){y(C,D);function C(){c=C.__super__.constructor.apply(this,arguments);return c}C.prototype.initialize=function(){return Handlebars.registerHelper("isArray",function(F,E){if(F.type.toLowerCase()==="array"||F.allowMultiple){return E.fn(this)}else{return E.inverse(this)}})};C.prototype.render=function(){var E,F,I,G,J,H,M,N,L,K;K=this.model.type||this.model.dataType;if(typeof K==="undefined"){H=this.model.schema;if(H&&H["$ref"]){G=H["$ref"];if(G.indexOf("#/definitions/")===0){K=G.substring("#/definitions/".length)}else{K=G}}}this.model.type=K;this.model.paramType=this.model["in"]||this.model.paramType;if(this.model.paramType==="body"){this.model.isBody=true}if(K&&K.toLowerCase()==="file"){this.model.isFile=true}this.model["default"]=this.model["default"]||this.model.defaultValue;if(this.model.allowableValues){this.model.isList=true}L=this.template();$(this.el).html(L(this.model));M={sampleJSON:this.model.sampleJSON,isParam:true,signature:this.model.signature};if(this.model.sampleJSON){N=new j({model:M,tagName:"div"});$(".model-signature",$(this.el)).append(N.render().el)}else{$(".model-signature",$(this.el)).html(this.model.signature)}F=false;if(this.model.isBody){F=true}E={isParam:F};E.consumes=this.model.consumes;if(F){I=new n({model:E});$(".parameter-content-type",$(this.el)).append(I.render().el)}else{J=new o({model:E});$(".response-content-type",$(this.el)).append(J.render().el)}return this};C.prototype.template=function(){if(this.model.isList){return Handlebars.templates.param_list}else{if(this.options.readOnly){if(this.model.required){return Handlebars.templates.param_readonly_required}else{return Handlebars.templates.param_readonly}}else{if(this.model.required){return Handlebars.templates.param_required}else{return Handlebars.templates.param}}}};return C})(Backbone.View);j=(function(D){y(C,D);function C(){a=C.__super__.constructor.apply(this,arguments);return a}C.prototype.events={"click a.description-link":"switchToDescription","click a.snippet-link":"switchToSnippet","mousedown .snippet":"snippetToTextArea"};C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));this.switchToSnippet();this.isParam=this.model.isParam;if(this.isParam){$(".notice",$(this.el)).text("Click to set as parameter value")}return this};C.prototype.template=function(){return Handlebars.templates.signature};C.prototype.switchToDescription=function(E){if(E!=null){E.preventDefault()}$(".snippet",$(this.el)).hide();$(".description",$(this.el)).show();$(".description-link",$(this.el)).addClass("selected");return $(".snippet-link",$(this.el)).removeClass("selected")};C.prototype.switchToSnippet=function(E){if(E!=null){E.preventDefault()}$(".description",$(this.el)).hide();$(".snippet",$(this.el)).show();$(".snippet-link",$(this.el)).addClass("selected");return $(".description-link",$(this.el)).removeClass("selected")};C.prototype.snippetToTextArea=function(E){var F;if(this.isParam){if(E!=null){E.preventDefault()}F=$("textarea",$(this.el.parentNode.parentNode.parentNode));if($.trim(F.val())===""){return F.val(this.model.sampleJSON)}}};return C})(Backbone.View);l=(function(C){y(D,C);function D(){A=D.__super__.constructor.apply(this,arguments);return A}D.prototype.initialize=function(){};D.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=contentType]",$(this.el)).text("Response Content Type");return this};D.prototype.template=function(){return Handlebars.templates.content_type};return D})(Backbone.View);o=(function(C){y(D,C);function D(){z=D.__super__.constructor.apply(this,arguments);return z}D.prototype.initialize=function(){};D.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=responseContentType]",$(this.el)).text("Response Content Type");return this};D.prototype.template=function(){return Handlebars.templates.response_content_type};return D})(Backbone.View);n=(function(D){y(C,D);function C(){d=C.__super__.constructor.apply(this,arguments);return d}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=parameterContentType]",$(this.el)).text("Parameter content type:");return this};C.prototype.template=function(){return Handlebars.templates.parameter_content_type};return C})(Backbone.View);t=(function(D){y(C,D);function C(){b=C.__super__.constructor.apply(this,arguments);return b}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));return this};C.prototype.events={"click #apikey_button":"toggleApiKeyContainer","click #apply_api_key":"applyApiKey"};C.prototype.applyApiKey=function(){var E;window.authorizations.add(this.model.name,new ApiKeyAuthorization(this.model.name,$("#input_apiKey_entry").val(),this.model["in"]));window.swaggerUi.load();return E=$("#apikey_container").show()};C.prototype.toggleApiKeyContainer=function(){var E;if($("#apikey_container").length>0){E=$("#apikey_container").first();if(E.is(":visible")){return E.hide()}else{$(".auth_container").hide();return E.show()}}};C.prototype.template=function(){return Handlebars.templates.apikey_button_view};return C})(Backbone.View);k=(function(D){y(C,D);function C(){B=C.__super__.constructor.apply(this,arguments);return B}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));return this};C.prototype.events={"click #basic_auth_button":"togglePasswordContainer","click #apply_basic_auth":"applyPassword"};C.prototype.applyPassword=function(){var F,E,G;console.log("applying password");G=$(".input_username").val();E=$(".input_password").val();window.authorizations.add(this.model.type,new PasswordAuthorization("basic",G,E));window.swaggerUi.load();return F=$("#basic_auth_container").hide()};C.prototype.togglePasswordContainer=function(){var E;if($("#basic_auth_container").length>0){E=$("#basic_auth_container").show();if(E.is(":visible")){return E.slideUp()}else{$(".auth_container").hide();return E.show()}}};C.prototype.template=function(){return Handlebars.templates.basic_auth_button_view};return C})(Backbone.View)}).call(this); \ No newline at end of file +$(function(){$.fn.vAlign=function(){return this.each(function(c){var a=$(this).height();var d=$(this).parent().height();var b=(d-a)/2;$(this).css("margin-top",b)})};$.fn.stretchFormtasticInputWidthToParent=function(){return this.each(function(b){var d=$(this).closest("form").innerWidth();var c=parseInt($(this).closest("form").css("padding-left"),10)+parseInt($(this).closest("form").css("padding-right"),10);var a=parseInt($(this).css("padding-left"),10)+parseInt($(this).css("padding-right"),10);$(this).css("width",d-c-a)})};$("form.formtastic li.string input, form.formtastic textarea").stretchFormtasticInputWidthToParent();$("ul.downplayed li div.content p").vAlign();$("form.sandbox").submit(function(){var a=true;$(this).find("input.required").each(function(){$(this).removeClass("error");if($(this).val()==""){$(this).addClass("error");$(this).wiggle();a=false}});return a})});function clippyCopiedCallback(b){$("#api_key_copied").fadeIn().delay(1000).fadeOut()}log=function(){log.history=log.history||[];log.history.push(arguments);if(this.console){console.log(Array.prototype.slice.call(arguments)[0])}};if(Function.prototype.bind&&console&&typeof console.log=="object"){["log","info","warn","error","assert","dir","clear","profile","profileEnd"].forEach(function(a){console[a]=this.bind(console[a],console)},Function.prototype.call)}var Docs={shebang:function(){var b=$.param.fragment().split("/");b.shift();switch(b.length){case 1:var d="resource_"+b[0];Docs.expandEndpointListForResource(b[0]);$("#"+d).slideto({highlight:false});break;case 2:Docs.expandEndpointListForResource(b[0]);$("#"+d).slideto({highlight:false});var c=b.join("_");var a=c+"_content";Docs.expandOperation($("#"+a));$("#"+c).slideto({highlight:false});break}},toggleEndpointListForResource:function(b){var a=$("li#resource_"+Docs.escapeResourceName(b)+" ul.endpoints");if(a.is(":visible")){Docs.collapseEndpointListForResource(b)}else{Docs.expandEndpointListForResource(b)}},expandEndpointListForResource:function(b){var b=Docs.escapeResourceName(b);if(b==""){$(".resource ul.endpoints").slideDown();return}$("li#resource_"+b).addClass("active");var a=$("li#resource_"+b+" ul.endpoints");a.slideDown()},collapseEndpointListForResource:function(b){var b=Docs.escapeResourceName(b);$("li#resource_"+b).removeClass("active");var a=$("li#resource_"+b+" ul.endpoints");a.slideUp()},expandOperationsForResource:function(a){Docs.expandEndpointListForResource(a);if(a==""){$(".resource ul.endpoints li.operation div.content").slideDown();return}$("li#resource_"+Docs.escapeResourceName(a)+" li.operation div.content").each(function(){Docs.expandOperation($(this))})},collapseOperationsForResource:function(a){Docs.expandEndpointListForResource(a);$("li#resource_"+Docs.escapeResourceName(a)+" li.operation div.content").each(function(){Docs.collapseOperation($(this))})},escapeResourceName:function(a){return a.replace(/[!"#$%&'()*+,.\/:;<=>?@\[\\\]\^`{|}~]/g,"\\$&")},expandOperation:function(a){a.slideDown()},collapseOperation:function(a){a.slideUp()}};(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.apikey_button_view=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+="
")+"
\n
\n\n';return g})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.basic_auth_button_view=b(function(f,g,d,c,e){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,f.helpers);e=e||{};return'\n
\n";if(c=d.keyName){c=c.call(k,{hash:{},data:i})}else{c=k.keyName;c=typeof c===f?c.apply(k):c}g+=h(c)+'
\n \n \n \n \n
\n\n'})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.content_type=b(function(g,l,f,k,j){this.compilerInfo=[4,">= 1.0.0"];f=this.merge(f,g.helpers);j=j||{};var i="",c,h="function",m=this;function e(r,q){var o="",p;o+="\n ";p=f.each.call(r,r.produces,{hash:{},inverse:m.noop,fn:m.program(2,d,q),data:q});if(p||p===0){o+=p}o+="\n";return o}function d(r,q){var o="",p;o+='\n \n ";return o}function n(p,o){return'\n \n'}i+='\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.main=b(function(h,n,g,m,l){this.compilerInfo=[4,">= 1.0.0"];g=this.merge(g,h.helpers);l=l||{};var j="",c,s,i="function",k=this.escapeExpression,q=this;function f(x,w){var t="",v,u;t+='\n '+k(((v=((v=x.info),v==null||v===false?v:v.title)),typeof v===i?v.apply(x):v))+'
\n ';u=((v=((v=x.info),v==null||v===false?v:v.description)),typeof v===i?v.apply(x):v);if(u||u===0){t+=u}t+="
\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.termsOfService),{hash:{},inverse:q.noop,fn:q.program(2,d,w),data:w});if(u||u===0){t+=u}t+="\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.contact),{hash:{},inverse:q.noop,fn:q.program(4,r,w),data:w});if(u||u===0){t+=u}t+="\n ";u=g["if"].call(x,((v=x.info),v==null||v===false?v:v.license),{hash:{},inverse:q.noop,fn:q.program(6,p,w),data:w});if(u||u===0){t+=u}t+="\n ";return t}function d(w,v){var t="",u;t+='';return t}function r(w,v){var t="",u;t+="';return t}function p(w,v){var t="",u;t+="";return t}function o(w,v){var t="",u;t+='\n , api version: '+k(((u=((u=w.info),u==null||u===false?u:u.version)),typeof u===i?u.apply(w):u))+"\n ";return t}function e(w,v){var t="",u;t+='\n \n ";c=g["if"].call(n,n.info,{hash:{},inverse:q.noop,fn:q.program(1,f,l),data:l});if(c||c===0){j+=c}j+="\n
\n\n
\n";return j})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.operation=b(function(j,u,s,o,A){this.compilerInfo=[4,">= 1.0.0"];s=this.merge(s,j.helpers);A=A||{};var t="",k,f,e="function",d=this.escapeExpression,r=this,c=s.blockHelperMissing;function q(C,B){return"deprecated"}function p(C,B){return"\n Warning: Deprecated
\n "}function n(E,D){var B="",C;B+="\nImplementation Notes
\n";if(C=s.description){C=C.call(E,{hash:{},data:D})}else{C=E.description;C=typeof C===e?C.apply(E):C}if(C||C===0){B+=C}B+="
\n ";return B}function m(C,B){return'\n\n '}function i(E,D){var B="",C;B+='\n \n ";return B}function z(F,E){var B="",D,C;B+="\n
"}function x(C,B){return'\n "+d(((D=F.scope),typeof D===e?D.apply(F):D))+"
\n ";return B}function y(C,B){return"\n \n
\n '}function w(C,B){return'\n Response Class
\n\n
\n \n '}function v(C,B){return'\n
Parameters
\n| Parameter | \nValue | \nDescription | \nParameter Type | \nData Type | \n
|---|
Response Messages
\n| HTTP Status Code | \nReason | \nResponse Model | \n
|---|
\n \n \n \n
\n "}t+="\n - \n
- \n \n \n \n
\n \n ';return v}function e(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y.isFile,{hash:{},inverse:n.program(10,u,x),fn:n.program(2,l,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function u(y,x){var v="",w;v+="\n ";w=o["if"].call(y,y["default"],{hash:{},inverse:n.program(13,r,x),fn:n.program(11,s,x),data:x});if(w||w===0){v+=w}v+="\n ";return v}function s(y,x){var v="",w;v+="\n \n ";return v}function r(y,x){var v="",w;v+="\n \n ";return v}p+="
\n \n ';return w}function e(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z.isFile,{hash:{},inverse:n.program(12,t,y),fn:n.program(10,v,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function v(z,y){var w="",x;w+="\n \n ";return w}function t(z,y){var w="",x;w+="\n ";x=o["if"].call(z,z["default"],{hash:{},inverse:n.program(15,r,y),fn:n.program(13,s,y),data:y});if(x||x===0){w+=x}w+="\n ";return w}function s(z,y){var w="",x;w+="\n \n ";return w}function r(z,y){var w="",x;w+="\n \n ";return w}p+="
\n
\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.response_content_type=b(function(g,l,f,k,j){this.compilerInfo=[4,">= 1.0.0"];f=this.merge(f,g.helpers);j=j||{};var i="",c,h="function",m=this;function e(r,q){var o="",p;o+="\n ";p=f.each.call(r,r.produces,{hash:{},inverse:m.noop,fn:m.program(2,d,q),data:q});if(p||p===0){o+=p}o+="\n";return o}function d(r,q){var o="",p;o+='\n \n ";return o}function n(p,o){return'\n \n'}i+='\n\n";return i})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.signature=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+='\n ';if(d=f.name){d=d.call(m,{hash:{},data:k})}else{d=m.name;d=typeof d===h?d.apply(m):d}i+=j(d)+" ";p={hash:{},inverse:o.noop,fn:o.program(1,e,k),data:k};if(d=f.summary){d=d.call(m,p)}else{d=m.summary;d=typeof d===h?d.apply(m):d}if(!f.summary){d=n.call(m,d,p)}if(d||d===0){i+=d}if(d=f.summary){d=d.call(m,{hash:{},data:k})}else{d=m.summary;d=typeof d===h?d.apply(m):d}if(d||d===0){i+=d}i+="\n
\n \n\n
- \n
- Model \n
- Model Schema \n
\n\n";if(c=d.code){c=c.call(k,{hash:{},data:i})}else{c=k.code;c=typeof c===f?c.apply(k):c}g+=h(c)+" \n";if(c=d.message){c=c.call(k,{hash:{},data:i})}else{c=k.message;c=typeof c===f?c.apply(k):c}if(c||c===0){g+=c}g+=" \nF){O=F-G}if(OE){L=E-I}if(L0){H[M.name]=M.value}if(M.type==="file"){R=true}}I=K.find("textarea");for(P=0,J=I.length;P0){H[M.name]=M.value}}F=K.find("select");for(O=0,G=F.length;O0){H[M.name]=N}}E.responseContentType=$("div select[name=responseContentType]",$(this.el)).val();E.requestContentType=$("div select[name=parameterContentType]",$(this.el)).val();$(".response_throbber",$(this.el)).show();if(R){return this.handleFileUpload(H,K)}else{return this.model["do"](H,E,this.showCompleteStatus,this.showErrorStatus,this)}}};C.prototype.success=function(E,F){return F.showCompleteStatus(E)};C.prototype.handleFileUpload=function(V,M){var Q,L,G,R,P,O,T,N,K,J,H,U,Y,X,W,I,F,E,Z,S=this;I=M.serializeArray();for(N=0,U=I.length;N0){V[R.name]=R.value}}Q=new FormData();T=0;F=this.model.parameters;for(K=0,Y=F.length;K");$(".request_url pre",$(this.el)).text(this.invocationUrl);P={type:this.model.method,url:this.invocationUrl,headers:G,data:Q,dataType:"json",contentType:false,processData:false,error:function(ab,ac,aa){return S.showErrorStatus(S.wrap(ab),S)},success:function(aa){return S.showResponse(aa,S)},complete:function(aa){return S.showCompleteStatus(S.wrap(aa),S)}};if(window.authorizations){window.authorizations.apply(P)}if(T===0){P.data.append("fake","true")}jQuery.ajax(P);return false};C.prototype.wrap=function(I){var G,J,L,F,K,H,E;L={};J=I.getAllResponseHeaders().split("\r");for(H=0,E=J.length;H0){return G}else{return null}}};C.prototype.hideResponse=function(E){if(E!=null){E.preventDefault()}$(".response",$(this.el)).slideUp();return $(".response_hider",$(this.el)).fadeOut()};C.prototype.showResponse=function(E){var F;F=JSON.stringify(E,null,"\t").replace(/\n/g,"
");return $(".response_body",$(this.el)).html(escape(F))};C.prototype.showErrorStatus=function(F,E){return E.showStatus(F)};C.prototype.showCompleteStatus=function(F,E){return E.showStatus(F)};C.prototype.formatXml=function(L){var H,K,F,M,R,N,G,E,P,Q,J,I,O;E=/(>)(<)(\/*)/g;Q=/[ ]*(.*)[ ]+\n/g;H=/(<.+>)(.+\n)/g;L=L.replace(E,"$1\n$2$3").replace(Q,"$1\n").replace(H,"$1\n$2");G=0;K="";R=L.split("\n");F=0;M="other";P={"single->single":0,"single->closing":-1,"single->opening":0,"single->other":0,"closing->single":0,"closing->closing":-1,"closing->opening":0,"closing->other":0,"opening->single":1,"opening->closing":0,"opening->opening":1,"opening->other":1,"other->single":0,"other->closing":-1,"other->opening":0,"other->other":0};J=function(X){var T,S,V,Z,W,U,Y;U={single:Boolean(X.match(/<.+\/>/)),closing:Boolean(X.match(/<\/.+>/)),opening:Boolean(X.match(/<[^!?].*>/))};W=((function(){var aa;aa=[];for(V in U){Y=U[V];if(Y){aa.push(V)}}return aa})())[0];W=W===void 0?"other":W;T=M+"->"+W;M=W;Z="";F+=P[T];Z=((function(){var ab,ac,aa;aa=[];for(S=ab=0,ac=F;0<=ac?abac;S=0<=ac?++ab:--ab){aa.push(" ")}return aa})()).join("");if(T==="opening->closing"){return K=K.substr(0,K.length-1)+X+"\n"}else{return K+=Z+X+"\n"}};for(I=0,O=R.length;I![]()
").attr("src",F)}else{G=$(" 0)
+ this.basePath = this.url.substring(0, this.url.lastIndexOf('?'));
+ else
+ this.basePath = this.url;
+
+ if (isApi) {
+ var newName = response.resourcePath.replace(/\//g, '');
+ this.resourcePath = response.resourcePath;
+ var res = new SwaggerResource(response, this);
+ this.apis[newName] = res;
+ this.apisArray.push(res);
+ } else {
+ var k;
+ for (k = 0; k < response.apis.length; k++) {
+ var resource = response.apis[k];
+ var res = new SwaggerResource(resource, this);
+ this.apis[res.name] = res;
+ this.apisArray.push(res);
+ }
+ }
+ this.isValid = true;
+ if (this.success) {
+ this.success();
+ }
+ return this;
+};
+
+SwaggerApi.prototype.buildFrom1_1Spec = function (response) {
+ log('This API is using a deprecated version of Swagger! Please see http://github.com/wordnik/swagger-core/wiki for more info');
+ if (response.apiVersion != null)
+ this.apiVersion = response.apiVersion;
+ this.apis = {};
+ this.apisArray = [];
+ this.produces = response.produces;
+ if (response.info != null) {
+ this.info = response.info;
+ }
+ var isApi = false;
+ for (var i = 0; i < response.apis.length; i++) {
+ var api = response.apis[i];
+ if (api.operations) {
+ for (var j = 0; j < api.operations.length; j++) {
+ operation = api.operations[j];
+ isApi = true;
+ }
+ }
+ }
+ if (response.basePath) {
+ this.basePath = response.basePath;
+ } else if (this.url.indexOf('?') > 0) {
+ this.basePath = this.url.substring(0, this.url.lastIndexOf('?'));
+ } else {
+ this.basePath = this.url;
+ }
+ if (isApi) {
+ var newName = response.resourcePath.replace(/\//g, '');
+ this.resourcePath = response.resourcePath;
+ var res = new SwaggerResource(response, this);
+ this.apis[newName] = res;
+ this.apisArray.push(res);
+ } else {
+ for (k = 0; k < response.apis.length; k++) {
+ resource = response.apis[k];
+ var res = new SwaggerResource(resource, this);
+ this.apis[res.name] = res;
+ this.apisArray.push(res);
+ }
+ }
+ this.isValid = true;
+ if (this.success) {
+ this.success();
+ }
+ return this;
+};
+
+SwaggerApi.prototype.selfReflect = function () {
+ var resource, resource_name, ref;
+ if (this.apis == null) {
+ return false;
+ }
+ ref = this.apis;
+ for (resource_name in ref) {
+ resource = ref[resource_name];
+ if (resource.ready == null) {
+ return false;
+ }
+ }
+ this.setConsolidatedModels();
+ this.ready = true;
+ if (this.success != null) {
+ return this.success();
+ }
+};
+
+SwaggerApi.prototype.fail = function (message) {
+ this.failure(message);
+ throw message;
+};
+
+SwaggerApi.prototype.setConsolidatedModels = function () {
+ var model, modelName, resource, resource_name, _i, _len, _ref, _ref1, _results;
+ this.models = {};
+ _ref = this.apis;
+ for (resource_name in _ref) {
+ resource = _ref[resource_name];
+ for (modelName in resource.models) {
+ if (this.models[modelName] == null) {
+ this.models[modelName] = resource.models[modelName];
+ this.modelsArray.push(resource.models[modelName]);
+ }
+ }
+ }
+ _ref1 = this.modelsArray;
+ _results = [];
+ for (_i = 0, _len = _ref1.length; _i < _len; _i++) {
+ model = _ref1[_i];
+ _results.push(model.setReferencedModels(this.models));
+ }
+ return _results;
+};
+
+SwaggerApi.prototype.help = function () {
+ var operation, operation_name, parameter, resource, resource_name, _i, _len, _ref, _ref1, _ref2;
+ _ref = this.apis;
+ for (resource_name in _ref) {
+ resource = _ref[resource_name];
+ log(resource_name);
+ _ref1 = resource.operations;
+ for (operation_name in _ref1) {
+ operation = _ref1[operation_name];
+ log(' ' + operation.nickname);
+ _ref2 = operation.parameters;
+ for (_i = 0, _len = _ref2.length; _i < _len; _i++) {
+ parameter = _ref2[_i];
+ log(' ' + parameter.name + (parameter.required ? ' (required)' : '') + ' - ' + parameter.description);
+ }
+ }
+ }
+ return this;
+};
+
+var SwaggerResource = function (resourceObj, api) {
+ var _this = this;
+ this.api = api;
+ this.swaggerRequstHeaders = api.swaggerRequstHeaders;
+ this.path = this.api.resourcePath != null ? this.api.resourcePath : resourceObj.path;
+ this.description = resourceObj.description;
+ this.authorizations = (resourceObj.authorizations || {});
+
+ var parts = this.path.split('/');
+ this.name = parts[parts.length - 1].replace('.{format}', '');
+ this.basePath = this.api.basePath;
+ this.operations = {};
+ this.operationsArray = [];
+ this.modelsArray = [];
+ this.models = {};
+ this.rawModels = {};
+ this.useJQuery = (typeof api.useJQuery !== 'undefined' ? api.useJQuery : null);
+
+ if ((resourceObj.apis != null) && (this.api.resourcePath != null)) {
+ this.addApiDeclaration(resourceObj);
+ } else {
+ if (this.path == null) {
+ this.api.fail('SwaggerResources must have a path.');
+ }
+ if (this.path.substring(0, 4) === 'http') {
+ this.url = this.path.replace('{format}', 'json');
+ } else {
+ this.url = this.api.basePath + this.path.replace('{format}', 'json');
+ }
+ this.api.progress('fetching resource ' + this.name + ': ' + this.url);
+ var obj = {
+ url: this.url,
+ method: 'GET',
+ useJQuery: this.useJQuery,
+ headers: {
+ accept: this.swaggerRequstHeaders
+ },
+ on: {
+ response: function (resp) {
+ var responseObj = resp.obj || JSON.parse(resp.data);
+ return _this.addApiDeclaration(responseObj);
+ },
+ error: function (response) {
+ return _this.api.fail('Unable to read api \'' +
+ _this.name + '\' from path ' + _this.url + ' (server returned ' + response.statusText + ')');
+ }
+ }
+ };
+ var e = typeof window !== 'undefined' ? window : exports;
+ e.authorizations.apply(obj);
+ new SwaggerHttp().execute(obj);
+ }
+};
+
+SwaggerResource.prototype.getAbsoluteBasePath = function (relativeBasePath) {
+ var pos, url;
+ url = this.api.basePath;
+ pos = url.lastIndexOf(relativeBasePath);
+ var parts = url.split('/');
+ var rootUrl = parts[0] + '//' + parts[2];
+
+ if (relativeBasePath.indexOf('http') === 0)
+ return relativeBasePath;
+ if (relativeBasePath === '/')
+ return rootUrl;
+ if (relativeBasePath.substring(0, 1) == '/') {
+ // use root + relative
+ return rootUrl + relativeBasePath;
+ }
+ else {
+ var pos = this.basePath.lastIndexOf('/');
+ var base = this.basePath.substring(0, pos);
+ if (base.substring(base.length - 1) == '/')
+ return base + relativeBasePath;
+ else
+ return base + '/' + relativeBasePath;
+ }
+};
+
+SwaggerResource.prototype.addApiDeclaration = function (response) {
+ if (response.produces != null)
+ this.produces = response.produces;
+ if (response.consumes != null)
+ this.consumes = response.consumes;
+ if ((response.basePath != null) && response.basePath.replace(/\s/g, '').length > 0)
+ this.basePath = response.basePath.indexOf('http') === -1 ? this.getAbsoluteBasePath(response.basePath) : response.basePath;
+
+ this.addModels(response.models);
+ if (response.apis) {
+ for (var i = 0 ; i < response.apis.length; i++) {
+ var endpoint = response.apis[i];
+ this.addOperations(endpoint.path, endpoint.operations, response.consumes, response.produces);
+ }
+ }
+ this.api[this.name] = this;
+ this.ready = true;
+ return this.api.selfReflect();
+};
+
+SwaggerResource.prototype.addModels = function (models) {
+ if (models != null) {
+ var modelName;
+ for (modelName in models) {
+ if (this.models[modelName] == null) {
+ var swaggerModel = new SwaggerModel(modelName, models[modelName]);
+ this.modelsArray.push(swaggerModel);
+ this.models[modelName] = swaggerModel;
+ this.rawModels[modelName] = models[modelName];
+ }
+ }
+ var output = [];
+ for (var i = 0; i < this.modelsArray.length; i++) {
+ var model = this.modelsArray[i];
+ output.push(model.setReferencedModels(this.models));
+ }
+ return output;
+ }
+};
+
+SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes, produces) {
+ if (ops) {
+ var output = [];
+ for (var i = 0; i < ops.length; i++) {
+ var o = ops[i];
+ consumes = this.consumes;
+ produces = this.produces;
+ if (o.consumes != null)
+ consumes = o.consumes;
+ else
+ consumes = this.consumes;
+
+ if (o.produces != null)
+ produces = o.produces;
+ else
+ produces = this.produces;
+ var type = (o.type || o.responseClass);
+
+ if (type === 'array') {
+ ref = null;
+ if (o.items)
+ ref = o.items['type'] || o.items['$ref'];
+ type = 'array[' + ref + ']';
+ }
+ var responseMessages = o.responseMessages;
+ var method = o.method;
+ if (o.httpMethod) {
+ method = o.httpMethod;
+ }
+ if (o.supportedContentTypes) {
+ consumes = o.supportedContentTypes;
+ }
+ if (o.errorResponses) {
+ responseMessages = o.errorResponses;
+ for (var j = 0; j < responseMessages.length; j++) {
+ r = responseMessages[j];
+ r.message = r.reason;
+ r.reason = null;
+ }
+ }
+ o.nickname = this.sanitize(o.nickname);
+ var op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations, o.deprecated);
+ this.operations[op.nickname] = op;
+ output.push(this.operationsArray.push(op));
+ }
+ return output;
+ }
+};
+
+SwaggerResource.prototype.sanitize = function (nickname) {
+ var op;
+ op = nickname.replace(/[\s!@#$%^&*()_+=\[{\]};:<>|.\/?,\\'""-]/g, '_');
+ op = op.replace(/((_){2,})/g, '_');
+ op = op.replace(/^(_)*/g, '');
+ op = op.replace(/([_])*$/g, '');
+ return op;
+};
+
+var SwaggerModel = function (modelName, obj) {
+ this.name = obj.id != null ? obj.id : modelName;
+ this.properties = [];
+ var propertyName;
+ for (propertyName in obj.properties) {
+ if (obj.required != null) {
+ var value;
+ for (value in obj.required) {
+ if (propertyName === obj.required[value]) {
+ obj.properties[propertyName].required = true;
+ }
+ }
+ }
+ var prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName], this);
+ this.properties.push(prop);
+ }
+};
+
+SwaggerModel.prototype.setReferencedModels = function (allModels) {
+ var results = [];
+ for (var i = 0; i < this.properties.length; i++) {
+ var property = this.properties[i];
+ var type = property.type || property.dataType;
+ if (allModels[type] != null)
+ results.push(property.refModel = allModels[type]);
+ else if ((property.refDataType != null) && (allModels[property.refDataType] != null))
+ results.push(property.refModel = allModels[property.refDataType]);
+ else
+ results.push(void 0);
+ }
+ return results;
+};
+
+SwaggerModel.prototype.getMockSignature = function (modelsToIgnore) {
+ var propertiesStr = [];
+ for (var i = 0; i < this.properties.length; i++) {
+ var prop = this.properties[i];
+ propertiesStr.push(prop.toString());
+ }
+
+ var strong = '';
+ var strongClose = '';
+ var classOpen = strong + this.name + ' {' + strongClose;
+ var classClose = strong + '}' + strongClose;
+ var returnVal = classOpen + '
' + prop.refModel.getMockSignature(modelsToIgnore)); + } + } + return returnVal; +}; + +SwaggerModel.prototype.createJSONSample = function (modelsToIgnore) { + if (sampleModels[this.name]) { + return sampleModels[this.name]; + } + else { + var result = {}; + var modelsToIgnore = (modelsToIgnore || []); + modelsToIgnore.push(this.name); + for (var i = 0; i < this.properties.length; i++) { + var prop = this.properties[i]; + result[prop.name] = prop.getSampleValue(modelsToIgnore); + } + modelsToIgnore.pop(this.name); + return result; + } +}; + +var SwaggerModelProperty = function (name, obj, model) { + this.name = name; + this.dataType = obj.type || obj.dataType || obj['$ref']; + this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set'); + this.descr = obj.description; + this.required = obj.required; + this.defaultValue = applyModelPropertyMacro(obj, model); + if (obj.items != null) { + if (obj.items.type != null) { + this.refDataType = obj.items.type; + } + if (obj.items.$ref != null) { + this.refDataType = obj.items.$ref; + } + } + this.dataTypeWithRef = this.refDataType != null ? (this.dataType + '[' + this.refDataType + ']') : this.dataType; + if (obj.allowableValues != null) { + this.valueType = obj.allowableValues.valueType; + this.values = obj.allowableValues.values; + if (this.values != null) { + this.valuesString = '\'' + this.values.join('\' or \'') + '\''; + } + } + if (obj['enum'] != null) { + this.valueType = 'string'; + this.values = obj['enum']; + if (this.values != null) { + this.valueString = '\'' + this.values.join('\' or \'') + '\''; + } + } +}; + +SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) { + var result; + if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) { + result = this.refModel.createJSONSample(modelsToIgnore); + } else { + if (this.isCollection) { + result = this.toSampleValue(this.refDataType); + } else { + result = this.toSampleValue(this.dataType); + } + } + if (this.isCollection) { + return [result]; + } else { + return result; + } +}; + +SwaggerModelProperty.prototype.toSampleValue = function (value) { + var result; + if ((typeof this.defaultValue !== 'undefined') && this.defaultValue !== null) { + result = this.defaultValue; + } else if (value === 'integer') { + result = 0; + } else if (value === 'boolean') { + result = false; + } else if (value === 'double' || value === 'number') { + result = 0.0; + } else if (value === 'string') { + result = ''; + } else { + result = value; + } + return result; +}; + +SwaggerModelProperty.prototype.toString = function () { + var req = this.required ? 'propReq' : 'propOpt'; + var str = '' + this.name + ' (' + this.dataTypeWithRef + ''; + if (!this.required) { + str += ', optional'; + } + str += ')'; + if (this.values != null) { + str += ' = ["' + this.values.join('\' or \'') + '\']'; + } + if (this.descr != null) { + str += ': ' + this.descr + ''; + } + return str; +}; + +var SwaggerOperation = function (nickname, path, method, parameters, summary, notes, type, responseMessages, resource, consumes, produces, authorizations, deprecated) { + var _this = this; + + var errors = []; + this.nickname = (nickname || errors.push('SwaggerOperations must have a nickname.')); + this.path = (path || errors.push('SwaggerOperation ' + nickname + ' is missing path.')); + this.method = (method || errors.push('SwaggerOperation ' + nickname + ' is missing method.')); + this.parameters = parameters != null ? parameters : []; + this.summary = summary; + this.notes = notes; + this.type = type; + this.responseMessages = (responseMessages || []); + this.resource = (resource || errors.push('Resource is required')); + this.consumes = consumes; + this.produces = produces; + this.authorizations = typeof authorizations !== 'undefined' ? authorizations : resource.authorizations; + this.deprecated = deprecated; + this['do'] = __bind(this['do'], this); + + if (errors.length > 0) { + console.error('SwaggerOperation errors', errors, arguments); + this.resource.api.fail(errors); + } + + this.path = this.path.replace('{format}', 'json'); + this.method = this.method.toLowerCase(); + this.isGetMethod = this.method === 'GET'; + + this.resourceName = this.resource.name; + if (typeof this.type !== 'undefined' && this.type === 'void') + this.type = null; + else { + this.responseClassSignature = this.getSignature(this.type, this.resource.models); + this.responseSampleJSON = this.getSampleJSON(this.type, this.resource.models); + } + + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + // might take this away + param.name = param.name || param.type || param.dataType; + + // for 1.1 compatibility + var type = param.type || param.dataType; + if (type === 'array') { + type = 'array[' + (param.items.$ref ? param.items.$ref : param.items.type) + ']'; + } + param.type = type; + + if (type && type.toLowerCase() === 'boolean') { + param.allowableValues = {}; + param.allowableValues.values = ['true', 'false']; + } + param.signature = this.getSignature(type, this.resource.models); + param.sampleJSON = this.getSampleJSON(type, this.resource.models); + + var enumValue = param['enum']; + if (enumValue != null) { + param.isList = true; + param.allowableValues = {}; + param.allowableValues.descriptiveValues = []; + + for (var j = 0; j < enumValue.length; j++) { + var v = enumValue[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + else if (param.allowableValues != null) { + if (param.allowableValues.valueType === 'RANGE') + param.isRange = true; + else + param.isList = true; + if (param.allowableValues != null) { + param.allowableValues.descriptiveValues = []; + if (param.allowableValues.values) { + for (var j = 0; j < param.allowableValues.values.length; j++) { + var v = param.allowableValues.values[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + } + } + param.defaultValue = applyParameterMacro(param, this); + } + var defaultSuccessCallback = this.resource.api.defaultSuccessCallback || null; + var defaultErrorCallback = this.resource.api.defaultErrorCallback || null; + + this.resource[this.nickname] = function (args, opts, callback, error) { + var arg1, arg2, arg3, arg4; + if(typeof args === 'function') // right shift 3 + arg1 = {}, arg2 = {}, arg3 = args, arg4 = opts; + else if(typeof args === 'object' && typeof opts === 'function') // right shift 2 + arg1 = args, arg2 = {}, arg3 = opts, arg4 = callback; + else + arg1 = args, arg2 = opts, arg3 = callback, arg4 = error; + + return _this['do'](arg1 || {}, arg2 || {}, arg3 || defaultSuccessCallback, arg4 || defaultErrorCallback); + }; + + this.resource[this.nickname].help = function () { + return _this.help(); + }; + this.resource[this.nickname].asCurl = function (args) { + return _this.asCurl(args); + }; +} + +SwaggerOperation.prototype.isListType = function (type) { + if (type && type.indexOf('[') >= 0) { + return type.substring(type.indexOf('[') + 1, type.indexOf(']')); + } else { + return void 0; + } +}; + +SwaggerOperation.prototype.getSignature = function (type, models) { + var isPrimitive, listType; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + if (isPrimitive) { + return type; + } else { + if (listType != null) { + return models[listType].getMockSignature(); + } else { + return models[type].getMockSignature(); + } + } +}; + +SwaggerOperation.prototype.getSampleJSON = function (type, models) { + var isPrimitive, listType, val; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + val = isPrimitive ? void 0 : (listType != null ? models[listType].createJSONSample() : models[type].createJSONSample()); + if (val) { + val = listType ? [val] : val; + if (typeof val == 'string') + return val; + else if (typeof val === 'object') { + var t = val; + if (val instanceof Array && val.length > 0) { + t = val[0]; + } + if (t.nodeName) { + var xmlString = new XMLSerializer().serializeToString(t); + return this.formatXml(xmlString); + } + else + return JSON.stringify(val, null, 2); + } + else + return val; + } +}; + +SwaggerOperation.prototype['do'] = function (args, opts, callback, error) { + var key, param, params, possibleParams, req, value; + + if (error == null) { + error = function (xhr, textStatus, error) { + return log(xhr, textStatus, error); + }; + } + + if (callback == null) { + callback = function (response) { + var content; + content = null; + if (response != null) { + content = response.data; + } else { + content = 'no data'; + } + return log('default callback: ' + content); + }; + } + params = {}; + params.headers = []; + if (args.headers != null) { + params.headers = args.headers; + delete args.headers; + } + // allow override from the opts + if(opts && opts.responseContentType) { + params.headers['Content-Type'] = opts.responseContentType; + } + if(opts && opts.requestContentType) { + params.headers['Accept'] = opts.requestContentType; + } + + var possibleParams = []; + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if (param.paramType === 'header') { + if (typeof args[param.name] !== 'undefined') + params.headers[param.name] = args[param.name]; + } + else if (param.paramType === 'form' || param.paramType.toLowerCase() === 'file') + possibleParams.push(param); + else if (param.paramType === 'body' && param.name !== 'body' && typeof args[param.name] !== 'undefined') { + if (args.body) { + throw new Error('Saw two body params in an API listing; expecting a max of one.'); + } + args.body = args[param.name]; + } + } + + if (args.body != null) { + params.body = args.body; + delete args.body; + } + + if (possibleParams) { + var key; + for (key in possibleParams) { + var value = possibleParams[key]; + if (args[value.name]) { + params[value.name] = args[value.name]; + } + } + } + req = new SwaggerRequest(this.method, this.urlify(args), params, opts, callback, error, this); + if (opts.mock != null) { + return req; + } else { + return true; + } +}; + +SwaggerOperation.prototype.pathJson = function () { + return this.path.replace('{format}', 'json'); +}; + +SwaggerOperation.prototype.pathXml = function () { + return this.path.replace('{format}', 'xml'); +}; + +SwaggerOperation.prototype.encodePathParam = function (pathParam) { + var encParts, part, parts, _i, _len; + pathParam = pathParam.toString(); + if (pathParam.indexOf('/') === -1) { + return encodeURIComponent(pathParam); + } else { + parts = pathParam.split('/'); + encParts = []; + for (_i = 0, _len = parts.length; _i < _len; _i++) { + part = parts[_i]; + encParts.push(encodeURIComponent(part)); + } + return encParts.join('/'); + } +}; + +SwaggerOperation.prototype.urlify = function (args) { + var url = this.resource.basePath + this.pathJson(); + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (param.paramType === 'path') { + if (typeof args[param.name] !== 'undefined') { + // apply path params and remove from args + var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/?|$))', 'gi'); + url = url.replace(reg, this.encodePathParam(args[param.name])); + delete args[param.name]; + } + else + throw '' + param.name + ' is a required path param.'; + } + } + + var queryParams = ''; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if(param.paramType === 'query') { + if (queryParams !== '') + queryParams += '&'; + if (Array.isArray(param)) { + var j; + var output = ''; + for(j = 0; j < param.length; j++) { + if(j > 0) + output += ','; + output += encodeURIComponent(param[j]); + } + queryParams += encodeURIComponent(param.name) + '=' + output; + } + else { + if (typeof args[param.name] !== 'undefined') { + queryParams += encodeURIComponent(param.name) + '=' + encodeURIComponent(args[param.name]); + } else { + if (param.required) + throw '' + param.name + ' is a required query param.'; + } + } + } + } + if ((queryParams != null) && queryParams.length > 0) + url += '?' + queryParams; + return url; +}; + +SwaggerOperation.prototype.supportHeaderParams = function () { + return this.resource.api.supportHeaderParams; +}; + +SwaggerOperation.prototype.supportedSubmitMethods = function () { + return this.resource.api.supportedSubmitMethods; +}; + +SwaggerOperation.prototype.getQueryParams = function (args) { + return this.getMatchingParams(['query'], args); +}; + +SwaggerOperation.prototype.getHeaderParams = function (args) { + return this.getMatchingParams(['header'], args); +}; + +SwaggerOperation.prototype.getMatchingParams = function (paramTypes, args) { + var matchingParams = {}; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + param = params[i]; + if (args && args[param.name]) + matchingParams[param.name] = args[param.name]; + } + var headers = this.resource.api.headers; + var name; + for (name in headers) { + var value = headers[name]; + matchingParams[name] = value; + } + return matchingParams; +}; + +SwaggerOperation.prototype.help = function () { + var msg = ''; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (msg !== '') + msg += '\n'; + msg += '* ' + param.name + (param.required ? ' (required)' : '') + " - " + param.description; + } + return msg; +}; + +SwaggerOperation.prototype.asCurl = function (args) { + var results = []; + var i; + + var headers = SwaggerRequest.prototype.setHeaders(args, {}, this); + for(i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if(param.paramType && param.paramType === 'header' && args[param.name]) { + headers[param.name] = args[param.name]; + } + } + + var key; + for (key in headers) { + results.push('--header "' + key + ': ' + headers[key] + '"'); + } + return 'curl ' + (results.join(' ')) + ' ' + this.urlify(args); +}; + +SwaggerOperation.prototype.formatXml = function (xml) { + var contexp, formatted, indent, lastType, lines, ln, pad, reg, transitions, wsexp, _fn, _i, _len; + reg = /(>)(<)(\/*)/g; + wsexp = /[ ]*(.*)[ ]+\n/g; + contexp = /(<.+>)(.+\n)/g; + xml = xml.replace(reg, '$1\n$2$3').replace(wsexp, '$1\n').replace(contexp, '$1\n$2'); + pad = 0; + formatted = ''; + lines = xml.split('\n'); + indent = 0; + lastType = 'other'; + transitions = { + 'single->single': 0, + 'single->closing': -1, + 'single->opening': 0, + 'single->other': 0, + 'closing->single': 0, + 'closing->closing': -1, + 'closing->opening': 0, + 'closing->other': 0, + 'opening->single': 1, + 'opening->closing': 0, + 'opening->opening': 1, + 'opening->other': 1, + 'other->single': 0, + 'other->closing': -1, + 'other->opening': 0, + 'other->other': 0 + }; + _fn = function (ln) { + var fromTo, j, key, padding, type, types, value; + types = { + single: Boolean(ln.match(/<.+\/>/)), + closing: Boolean(ln.match(/<\/.+>/)), + opening: Boolean(ln.match(/<[^!?].*>/)) + }; + type = ((function () { + var _results; + _results = []; + for (key in types) { + value = types[key]; + if (value) { + _results.push(key); + } + } + return _results; + })())[0]; + type = type === void 0 ? 'other' : type; + fromTo = lastType + '->' + type; + lastType = type; + padding = ''; + indent += transitions[fromTo]; + padding = ((function () { + var _j, _ref5, _results; + _results = []; + for (j = _j = 0, _ref5 = indent; 0 <= _ref5 ? _j < _ref5 : _j > _ref5; j = 0 <= _ref5 ? ++_j : --_j) { + _results.push(' '); + } + return _results; + })()).join(''); + if (fromTo === 'opening->closing') { + return formatted = formatted.substr(0, formatted.length - 1) + ln + '\n'; + } else { + return formatted += padding + ln + '\n'; + } + }; + for (_i = 0, _len = lines.length; _i < _len; _i++) { + ln = lines[_i]; + _fn(ln); + } + return formatted; +}; + +var SwaggerRequest = function (type, url, params, opts, successCallback, errorCallback, operation, execution) { + var _this = this; + var errors = []; + this.useJQuery = (typeof operation.resource.useJQuery !== 'undefined' ? operation.resource.useJQuery : null); + this.type = (type || errors.push('SwaggerRequest type is required (get/post/put/delete/patch/options).')); + this.url = (url || errors.push('SwaggerRequest url is required.')); + this.params = params; + this.opts = opts; + this.successCallback = (successCallback || errors.push('SwaggerRequest successCallback is required.')); + this.errorCallback = (errorCallback || errors.push('SwaggerRequest error callback is required.')); + this.operation = (operation || errors.push('SwaggerRequest operation is required.')); + this.execution = execution; + this.headers = (params.headers || {}); + + if (errors.length > 0) { + throw errors; + } + + this.type = this.type.toUpperCase(); + + // set request, response content type headers + var headers = this.setHeaders(params, opts, this.operation); + var body = params.body; + + // encode the body for form submits + if (headers['Content-Type']) { + var values = {}; + var i; + var operationParams = this.operation.parameters; + for (i = 0; i < operationParams.length; i++) { + var param = operationParams[i]; + if (param.paramType === 'form') + values[param.name] = param; + } + + if (headers['Content-Type'].indexOf('application/x-www-form-urlencoded') === 0) { + var encoded = ''; + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + if (encoded !== '') + encoded += '&'; + encoded += encodeURIComponent(key) + '=' + encodeURIComponent(value); + } + } + body = encoded; + } + else if (headers['Content-Type'].indexOf('multipart/form-data') === 0) { + // encode the body for form submits + var data = ''; + var boundary = '----SwaggerFormBoundary' + Date.now(); + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + data += '--' + boundary + '\n'; + data += 'Content-Disposition: form-data; name="' + key + '"'; + data += '\n\n'; + data += value + '\n'; + } + } + data += '--' + boundary + '--\n'; + headers['Content-Type'] = 'multipart/form-data; boundary=' + boundary; + body = data; + } + } + + var obj; + if (!((this.headers != null) && (this.headers.mock != null))) { + obj = { + url: this.url, + method: this.type, + headers: headers, + body: body, + useJQuery: this.useJQuery, + on: { + error: function (response) { + return _this.errorCallback(response, _this.opts.parent); + }, + redirect: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + 307: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + response: function (response) { + return _this.successCallback(response, _this.opts.parent); + } + } + }; + + var status = false; + if (this.operation.resource && this.operation.resource.api && this.operation.resource.api.clientAuthorizations) { + // Get the client authorizations from the resource declaration + status = this.operation.resource.api.clientAuthorizations.apply(obj, this.operation.authorizations); + } else { + // Get the client authorization from the default authorization declaration + var e; + if (typeof window !== 'undefined') { + e = window; + } else { + e = exports; + } + status = e.authorizations.apply(obj, this.operation.authorizations); + } + + if (opts.mock == null) { + if (status !== false) { + new SwaggerHttp().execute(obj); + } else { + obj.canceled = true; + } + } else { + return obj; + } + } + return obj; +}; + +SwaggerRequest.prototype.setHeaders = function (params, opts, operation) { + // default type + var accepts = opts.responseContentType || 'application/json'; + var consumes = opts.requestContentType || 'application/json'; + + var allDefinedParams = operation.parameters; + var definedFormParams = []; + var definedFileParams = []; + var body = params.body; + var headers = {}; + + // get params from the operation and set them in definedFileParams, definedFormParams, headers + var i; + for (i = 0; i < allDefinedParams.length; i++) { + var param = allDefinedParams[i]; + if (param.paramType === 'form') + definedFormParams.push(param); + else if (param.paramType === 'file') + definedFileParams.push(param); + else if (param.paramType === 'header' && this.params.headers) { + var key = param.name; + var headerValue = this.params.headers[param.name]; + if (typeof this.params.headers[param.name] !== 'undefined') + headers[key] = headerValue; + } + } + + // if there's a body, need to set the accepts header via requestContentType + if (body && (this.type === 'POST' || this.type === 'PUT' || this.type === 'PATCH' || this.type === 'DELETE')) { + if (this.opts.requestContentType) + consumes = this.opts.requestContentType; + } else { + // if any form params, content type must be set + if (definedFormParams.length > 0) { + if (definedFileParams.length > 0) + consumes = 'multipart/form-data'; + else + consumes = 'application/x-www-form-urlencoded'; + } + else if (this.type === 'DELETE') + body = '{}'; + else if (this.type != 'DELETE') + consumes = null; + } + + if (consumes && this.operation.consumes) { + if (this.operation.consumes.indexOf(consumes) === -1) { + log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.operation.consumes)); + } + } + + if (this.opts && this.opts.responseContentType) { + accepts = this.opts.responseContentType; + } else { + accepts = 'application/json'; + } + if (accepts && operation.produces) { + if (operation.produces.indexOf(accepts) === -1) { + log('server can\'t produce ' + accepts); + } + } + + if ((consumes && body !== '') || (consumes === 'application/x-www-form-urlencoded')) + headers['Content-Type'] = consumes; + if (accepts) + headers['Accept'] = accepts; + return headers; +} + +/** + * SwaggerHttp is a wrapper for executing requests + */ +var SwaggerHttp = function () { }; + +SwaggerHttp.prototype.execute = function (obj) { + if (obj && (typeof obj.useJQuery === 'boolean')) + this.useJQuery = obj.useJQuery; + else + this.useJQuery = this.isIE8(); + + if (this.useJQuery) + return new JQueryHttpClient().execute(obj); + else + return new ShredHttpClient().execute(obj); +} + +SwaggerHttp.prototype.isIE8 = function () { + var detectedIE = false; + if (typeof navigator !== 'undefined' && navigator.userAgent) { + nav = navigator.userAgent.toLowerCase(); + if (nav.indexOf('msie') !== -1) { + var version = parseInt(nav.split('msie')[1]); + if (version <= 8) { + detectedIE = true; + } + } + } + return detectedIE; +}; + +/* + * JQueryHttpClient lets a browser take advantage of JQuery's cross-browser magic. + * NOTE: when jQuery is available it will export both '$' and 'jQuery' to the global space. + * Since we are using closures here we need to alias it for internal use. + */ +var JQueryHttpClient = function (options) { + this.options = options || {}; + if (!jQuery) { + var jQuery = window.jQuery; + } +} + +JQueryHttpClient.prototype.execute = function (obj) { + var cb = obj.on; + var request = obj; + + obj.type = obj.method; + obj.cache = false; + + obj.beforeSend = function (xhr) { + var key, results; + if (obj.headers) { + results = []; + var key; + for (key in obj.headers) { + if (key.toLowerCase() === 'content-type') { + results.push(obj.contentType = obj.headers[key]); + } else if (key.toLowerCase() === 'accept') { + results.push(obj.accepts = obj.headers[key]); + } else { + results.push(xhr.setRequestHeader(key, obj.headers[key])); + } + } + return results; + } + }; + + obj.data = obj.body; + obj.complete = function (response) { + var headers = {}, + headerArray = response.getAllResponseHeaders().split('\n'); + + for (var i = 0; i < headerArray.length; i++) { + var toSplit = headerArray[i].trim(); + if (toSplit.length === 0) + continue; + var separator = toSplit.indexOf(':'); + if (separator === -1) { + // Name but no value in the header + headers[toSplit] = null; + continue; + } + var name = toSplit.substring(0, separator).trim(), + value = toSplit.substring(separator + 1).trim(); + headers[name] = value; + } + + var out = { + url: request.url, + method: request.method, + status: response.status, + data: response.responseText, + headers: headers + }; + + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.responseText && response.responseText !== '') + out.obj = JSON.parse(response.responseText); + else + out.obj = {} + } + } + + if (response.status >= 200 && response.status < 300) + cb.response(out); + else if (response.status === 0 || (response.status >= 400 && response.status < 599)) + cb.error(out); + else + return cb.response(out); + }; + + jQuery.support.cors = true; + return jQuery.ajax(obj); +} + +/* + * ShredHttpClient is a light-weight, node or browser HTTP client + */ +var ShredHttpClient = function (options) { + this.options = (options || {}); + this.isInitialized = false; + + if (typeof window !== 'undefined') { + this.Shred = require('./shred'); + this.content = require('./shred/content'); + } + else + this.Shred = require('shred'); + this.shred = new this.Shred(); +} + +ShredHttpClient.prototype.initShred = function () { + this.isInitialized = true; + this.registerProcessors(this.shred); +} + +ShredHttpClient.prototype.registerProcessors = function () { + var identity = function (x) { + return x; + }; + var toString = function (x) { + return x.toString(); + }; + + if (typeof window !== 'undefined') { + this.content.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } else { + this.Shred.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } +} + +ShredHttpClient.prototype.execute = function (obj) { + if (!this.isInitialized) + this.initShred(); + + var cb = obj.on, res; + + var transform = function (response) { + var out = { + headers: response._headers, + url: response.request.url, + method: response.request.method, + status: response.status, + data: response.content.data + }; + + var headers = response._headers.normalized || response._headers; + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.content.data && response.content.data !== '') + try { + out.obj = JSON.parse(response.content.data); + } + catch (ex) { + // do not set out.obj + log('unable to parse JSON content'); + } + else + out.obj = {} + } + } + return out; + }; + + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + + return out; + }; + + var res = { + error: function (response) { + if (obj) + return cb.error(transform(response)); + }, + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { + if (obj) + return cb.error(transformError(err)); + }, + response: function (response) { + if (obj) + return cb.response(transform(response)); + } + }; + if (obj) { + obj.on = res; + } + return this.shred.request(obj); +}; + +/** + * SwaggerAuthorizations applys the correct authorization to an operation being executed + */ +var SwaggerAuthorizations = function (name, auth) { + this.authz = {}; + if(name && auth) { + this.authz[name] = auth; + } +}; + +SwaggerAuthorizations.prototype.add = function (name, auth) { + this.authz[name] = auth; + return auth; +}; + +SwaggerAuthorizations.prototype.remove = function (name) { + return delete this.authz[name]; +}; + +SwaggerAuthorizations.prototype.apply = function (obj, authorizations) { + var status = null; + var key, value, result; + + // if the "authorizations" key is undefined, or has an empty array, add all keys + if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { + for (key in this.authz) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + else { + for (name in authorizations) { + for (key in this.authz) { + if (key == name) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + } + } + + return status; +}; + +/** + * ApiKeyAuthorization allows a query param or header to be injected + */ +var ApiKeyAuthorization = function (name, value, type, delimiter) { + this.name = name; + this.value = value; + this.type = type; + this.delimiter = delimiter; +}; + +ApiKeyAuthorization.prototype.apply = function (obj) { + if (this.type === 'query') { + if (obj.url.indexOf('?') > 0) + obj.url = obj.url + '&' + this.name + '=' + this.value; + else + obj.url = obj.url + '?' + this.name + '=' + this.value; + return true; + } else if (this.type === 'header') { + if (typeof obj.headers[this.name] !== 'undefined') { + if (typeof this.delimiter !== 'undefined') + obj.headers[this.name] = obj.headers[this.name] + this.delimiter + this.value; + } + else + obj.headers[this.name] = this.value; + return true; + } +}; + +/** + * Password Authorization is a basic auth implementation + */ +var PasswordAuthorization = function (name, username, password) { + this.name = name; + this.username = username; + this.password = password; + this._btoa = null; + if (typeof window !== 'undefined') + this._btoa = btoa; + else + this._btoa = require('btoa'); +}; + +PasswordAuthorization.prototype.apply = function (obj) { + var base64encoder = this._btoa; + obj.headers['Authorization'] = 'Basic ' + base64encoder(this.username + ':' + this.password); + return true; +}; + +var SwaggerClient = function(url, options) { this.isBuilt = false; this.url = null; this.debug = false; @@ -307,22 +1858,23 @@ PrimitiveModel.prototype.getMockSignature = function(modelsToIgnore) { else this.url = url; else options = url; - if (options.url != null) + if (options.url !== null) this.url = options.url; - if (options.success != null) + if (options.success !== null) this.success = options.success; if (typeof options.useJQuery === 'boolean') this.useJQuery = options.useJQuery; + this.supportedSubmitMethods = options.supportedSubmitMethods || []; this.failure = options.failure != null ? options.failure : function() {}; this.progress = options.progress != null ? options.progress : function() {}; this.spec = options.spec; - if (options.success != null) + if (options.success !== null) this.build(); -} +}; SwaggerClient.prototype.build = function() { var self = this; @@ -482,7 +2034,7 @@ SwaggerClient.prototype.buildFromSpec = function(response) { if (this.success) this.success(); return this; -} +}; SwaggerClient.prototype.parseUri = function(uri) { var urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/; @@ -493,7 +2045,7 @@ SwaggerClient.prototype.parseUri = function(uri) { port: parts[12], path: parts[15] }; -} +}; SwaggerClient.prototype.help = function() { var i; @@ -502,11 +2054,11 @@ SwaggerClient.prototype.help = function() { var api = this.apis[i]; log(' * ' + api.nickname + ': ' + api.operation.summary); } -} +}; SwaggerClient.prototype.tagFromLabel = function(label) { return label; -} +}; SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { if(typeof op.operationId !== 'undefined') { @@ -519,7 +2071,7 @@ SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { .replace(/\}/g, "") .replace(/\./g, "_") + "_" + httpMethod; } -} +}; SwaggerClient.prototype.fail = function(message) { this.failure(message); @@ -534,7 +2086,7 @@ var OperationGroup = function(tag, operation) { this.operationsArray = []; this.description = operation.description || ""; -} +}; var Operation = function(parent, operationId, httpMethod, path, args, definitions) { var errors = []; @@ -652,11 +2204,11 @@ var Operation = function(parent, operationId, httpMethod, path, args, definition } return this; -} +}; OperationGroup.prototype.sort = function(sorter) { -} +}; Operation.prototype.getType = function (param) { var type = param.type; @@ -668,7 +2220,7 @@ Operation.prototype.getType = function (param) { else if(type === 'integer' && format === 'int64') str = 'long'; else if(type === 'integer') - str = 'integer' + str = 'integer'; else if(type === 'string' && format === 'date-time') str = 'date-time'; else if(type === 'string' && format === 'date') @@ -708,7 +2260,7 @@ Operation.prototype.getType = function (param) { return [ str ]; else return str; -} +}; Operation.prototype.resolveModel = function (schema, definitions) { if(typeof schema['$ref'] !== 'undefined') { @@ -722,7 +2274,7 @@ Operation.prototype.resolveModel = function (schema, definitions) { return new ArrayModel(schema); else return null; -} +}; Operation.prototype.help = function(dontPrint) { var out = this.nickname + ': ' + this.summary + '\n'; @@ -734,7 +2286,7 @@ Operation.prototype.help = function(dontPrint) { if(typeof dontPrint === 'undefined') log(out); return out; -} +}; Operation.prototype.getSignature = function(type, models) { var isPrimitive, listType; @@ -745,13 +2297,13 @@ Operation.prototype.getSignature = function(type, models) { } if(type === 'string') - isPrimitive = true + isPrimitive = true; else - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + isPrimitive = ((listType !== null) && models[listType]) || (models[type] != null) ? false : true; if (isPrimitive) { return type; } else { - if (listType != null) + if (listType !== null) return models[type].getMockSignature(); else return models[type].getMockSignature(); @@ -763,7 +2315,7 @@ Operation.prototype.supportHeaderParams = function () { }; Operation.prototype.supportedSubmitMethods = function () { - return this.resource.api.supportedSubmitMethods; + return this.parent.supportedSubmitMethods; }; Operation.prototype.getHeaderParams = function (args) { @@ -782,7 +2334,7 @@ Operation.prototype.getHeaderParams = function (args) { } } return headers; -} +}; Operation.prototype.urlify = function (args) { var formParams = {}; @@ -827,7 +2379,7 @@ Operation.prototype.urlify = function (args) { url += this.basePath; return url + requestUrl + querystring; -} +}; Operation.prototype.getMissingParams = function(args) { var missingParams = []; @@ -841,7 +2393,7 @@ Operation.prototype.getMissingParams = function(args) { } } return missingParams; -} +}; Operation.prototype.getBody = function(headers, args) { var formParams = {}; @@ -871,7 +2423,7 @@ Operation.prototype.getBody = function(headers, args) { } return body; -} +}; /** * gets sample response for a single operation @@ -902,14 +2454,14 @@ Operation.prototype.getSampleJSON = function(type, models) { else return sampleJson; } -} +}; /** * legacy binding **/ Operation.prototype["do"] = function(args, opts, callback, error, parent) { return this.execute(args, opts, callback, error, parent); -} +}; /** @@ -929,8 +2481,8 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { error = arg3; } - success = (success||log) - error = (error||log) + success = (success||log); + error = (error||log); var missingParams = this.getMissingParams(args); if(missingParams.length > 0) { @@ -941,7 +2493,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { var headers = this.getHeaderParams(args); var body = this.getBody(headers, args); - var url = this.urlify(args) + var url = this.urlify(args); var obj = { url: url, @@ -960,7 +2512,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { }; var status = e.authorizations.apply(obj, this.operation.security); new SwaggerHttp().execute(obj); -} +}; Operation.prototype.setContentTypes = function(args, opts) { // default type @@ -1017,7 +2569,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (consumes && this.consumes) { if (this.consumes.indexOf(consumes) === -1) { log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.consumes)); - consumes = this.operation.consumes[0]; } } @@ -1029,7 +2580,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts && this.produces) { if (this.produces.indexOf(accepts) === -1) { log('server can\'t produce ' + accepts); - accepts = this.produces[0]; } } @@ -1038,7 +2588,7 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts) headers['Accept'] = accepts; return headers; -} +}; Operation.prototype.asCurl = function (args) { var results = []; @@ -1049,7 +2599,7 @@ Operation.prototype.asCurl = function (args) { results.push("--header \"" + key + ": " + headers[key] + "\""); } return "curl " + (results.join(" ")) + " " + this.urlify(args); -} +}; Operation.prototype.encodePathCollection = function(type, name, value) { var encoded = ''; @@ -1071,14 +2621,14 @@ Operation.prototype.encodePathCollection = function(type, name, value) { encoded += separator + this.encodeQueryParam(value[i]); } return encoded; -} +}; Operation.prototype.encodeQueryCollection = function(type, name, value) { var encoded = ''; var i; if(type === 'default' || type === 'multi') { for(i = 0; i < value.length; i++) { - if(i > 0) encoded += '&' + if(i > 0) encoded += '&'; encoded += this.encodeQueryParam(name) + '=' + this.encodeQueryParam(value[i]); } } @@ -1109,14 +2659,11 @@ Operation.prototype.encodeQueryCollection = function(type, name, value) { } } return encoded; -} +}; -/** - * TODO this encoding needs to be changed - **/ Operation.prototype.encodeQueryParam = function(arg) { - return escape(arg); -} + return encodeURIComponent(arg); +}; /** * TODO revisit, might not want to leave '/' @@ -1153,11 +2700,11 @@ var Model = function(name, definition) { this.properties.push(new Property(key, property, required)); } } -} +}; Model.prototype.createJSONSample = function(modelsToIgnore) { var result = {}; - modelsToIgnore = (modelsToIgnore||{}) + modelsToIgnore = (modelsToIgnore||{}); modelsToIgnore[this.name] = this; var i; for (i = 0; i < this.properties.length; i++) { @@ -1176,7 +2723,7 @@ Model.prototype.getSampleValue = function(modelsToIgnore) { obj[property.name] = property.sampleValue(false, modelsToIgnore); } return obj; -} +}; Model.prototype.getMockSignature = function(modelsToIgnore) { var propertiesStr = []; @@ -1225,11 +2772,11 @@ var Property = function(name, obj, required) { this.optional = true; this.default = obj.default || null; this.example = obj.example || null; -} +}; Property.prototype.getSampleValue = function (modelsToIgnore) { return this.sampleValue(false, modelsToIgnore); -} +}; Property.prototype.isArray = function () { var schema = this.schema; @@ -1237,7 +2784,7 @@ Property.prototype.isArray = function () { return true; else return false; -} +}; Property.prototype.sampleValue = function(isArray, ignoredModels) { isArray = (isArray || this.isArray()); @@ -1280,7 +2827,7 @@ Property.prototype.sampleValue = function(isArray, ignoredModels) { return [output]; else return output; -} +}; getStringSignature = function(obj) { var str = ''; @@ -1313,16 +2860,16 @@ getStringSignature = function(obj) { if(obj.type === 'array') str += ']'; return str; -} +}; simpleRef = function(name) { if(typeof name === 'undefined') return null; if(name.indexOf("#/definitions/") === 0) - return name.substring('#/definitions/'.length) + return name.substring('#/definitions/'.length); else return name; -} +}; Property.prototype.toString = function() { var str = getStringSignature(this.obj); @@ -1338,7 +2885,7 @@ Property.prototype.toString = function() { if(typeof this.description !== 'undefined') str += ': ' + this.description; return str; -} +}; typeFromJsonSchema = function(type, format) { var str; @@ -1364,20 +2911,11 @@ typeFromJsonSchema = function(type, format) { str = 'string'; return str; -} - -var e = (typeof window !== 'undefined' ? window : exports); +}; var sampleModels = {}; var cookies = {}; var models = {}; - -e.authorizations = new SwaggerAuthorizations(); -e.ApiKeyAuthorization = ApiKeyAuthorization; -e.PasswordAuthorization = PasswordAuthorization; -e.CookieAuthorization = CookieAuthorization; -e.SwaggerClient = SwaggerClient; -e.Operation = Operation; /** * SwaggerHttp is a wrapper for executing requests */ @@ -1389,11 +2927,15 @@ SwaggerHttp.prototype.execute = function(obj) { else this.useJQuery = this.isIE8(); + if(obj && typeof obj.body === 'object') { + obj.body = JSON.stringify(obj.body); + } + if(this.useJQuery) return new JQueryHttpClient().execute(obj); else return new ShredHttpClient().execute(obj); -} +}; SwaggerHttp.prototype.isIE8 = function() { var detectedIE = false; @@ -1419,7 +2961,7 @@ var JQueryHttpClient = function(options) { if(!jQuery){ var jQuery = window.jQuery; } -} +}; JQueryHttpClient.prototype.execute = function(obj) { var cb = obj.on; @@ -1474,8 +3016,7 @@ JQueryHttpClient.prototype.execute = function(obj) { headers: headers }; - var contentType = (headers["content-type"]||headers["Content-Type"]||null) - + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { if(response.responseText && response.responseText !== "") { @@ -1488,7 +3029,7 @@ JQueryHttpClient.prototype.execute = function(obj) { } } else - out.obj = {} + out.obj = {}; } } @@ -1502,7 +3043,7 @@ JQueryHttpClient.prototype.execute = function(obj) { jQuery.support.cors = true; return jQuery.ajax(obj); -} +}; /* * ShredHttpClient is a light-weight, node or browser HTTP client @@ -1520,12 +3061,12 @@ var ShredHttpClient = function(options) { else this.Shred = require("shred"); this.shred = new this.Shred(options); -} +}; ShredHttpClient.prototype.initShred = function () { this.isInitialized = true; this.registerProcessors(this.shred); -} +}; ShredHttpClient.prototype.registerProcessors = function(shred) { var identity = function(x) { @@ -1546,7 +3087,7 @@ ShredHttpClient.prototype.registerProcessors = function(shred) { stringify: toString }); } -} +}; ShredHttpClient.prototype.execute = function(obj) { if(!this.isInitialized) @@ -1563,7 +3104,8 @@ ShredHttpClient.prototype.execute = function(obj) { data: response.content.data }; - var contentType = (response._headers["content-type"]||response._headers["Content-Type"]||null) + var headers = response._headers.normalized || response._headers; + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { @@ -1575,26 +3117,42 @@ ShredHttpClient.prototype.execute = function(obj) { // unable to parse } else - out.obj = {} + out.obj = {}; } } return out; }; - res = { - error: function(response) { + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + return out; + }; + + var res = { + error: function (response) { if (obj) return cb.error(transform(response)); }, - redirect: function(response) { + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { if (obj) - return cb.redirect(transform(response)); + return cb.error(transformError(err)); }, - 307: function(response) { - if (obj) - return cb.redirect(transform(response)); - }, - response: function(response) { + response: function (response) { if (obj) return cb.response(transform(response)); } @@ -1603,4 +3161,31 @@ ShredHttpClient.prototype.execute = function(obj) { obj.on = res; } return this.shred.request(obj); -}; \ No newline at end of file +}; + +var e = (typeof window !== 'undefined' ? window : exports); + +e.authorizations = new SwaggerAuthorizations(); +e.ApiKeyAuthorization = ApiKeyAuthorization; +e.PasswordAuthorization = PasswordAuthorization; +e.CookieAuthorization = CookieAuthorization; +e.SwaggerClient = SwaggerClient; +e.Operation = Operation; + +// 1.x compat +// e.SampleModels = sampleModels; +// e.SwaggerHttp = SwaggerHttp; +// e.SwaggerRequest = SwaggerRequest; +// e.SwaggerAuthorizations = SwaggerAuthorizations; +// e.authorizations = new SwaggerAuthorizations(); +// e.ApiKeyAuthorization = ApiKeyAuthorization; +// e.PasswordAuthorization = PasswordAuthorization; +// e.CookieAuthorization = CookieAuthorization; +// e.JQueryHttpClient = JQueryHttpClient; +// e.ShredHttpClient = ShredHttpClient; +// e.SwaggerOperation = SwaggerOperation; +// e.SwaggerModel = SwaggerModel; +// e.SwaggerModelProperty = SwaggerModelProperty; +// e.SwaggerResource = SwaggerResource; +e.SwaggerApi = SwaggerApi; +})(); \ No newline at end of file diff --git a/lib/swagger.js b/lib/swagger.js deleted file mode 100644 index 37854cda..00000000 --- a/lib/swagger.js +++ /dev/null @@ -1,1695 +0,0 @@ -// swagger.js -// version 2.0.47 - -(function () { - - var __bind = function (fn, me) { - return function () { - return fn.apply(me, arguments); - }; - }; - - var log = function () { - log.history = log.history || []; - log.history.push(arguments); - if (this.console) { - console.log(Array.prototype.slice.call(arguments)[0]); - } - }; - - // if you want to apply conditional formatting of parameter values - var parameterMacro = function (value) { - return value; - } - - // if you want to apply conditional formatting of model property values - var modelPropertyMacro = function (value) { - return value; - } - - if (!Array.prototype.indexOf) { - Array.prototype.indexOf = function (obj, start) { - for (var i = (start || 0), j = this.length; i < j; i++) { - if (this[i] === obj) { return i; } - } - return -1; - } - } - - if (!('filter' in Array.prototype)) { - Array.prototype.filter = function (filter, that /*opt*/) { - var other = [], v; - for (var i = 0, n = this.length; i < n; i++) - if (i in this && filter.call(that, v = this[i], i, this)) - other.push(v); - return other; - }; - } - - if (!('map' in Array.prototype)) { - Array.prototype.map = function (mapper, that /*opt*/) { - var other = new Array(this.length); - for (var i = 0, n = this.length; i < n; i++) - if (i in this) - other[i] = mapper.call(that, this[i], i, this); - return other; - }; - } - - Object.keys = Object.keys || (function () { - var hasOwnProperty = Object.prototype.hasOwnProperty, - hasDontEnumBug = !{ toString: null }.propertyIsEnumerable("toString"), - DontEnums = [ - 'toString', - 'toLocaleString', - 'valueOf', - 'hasOwnProperty', - 'isPrototypeOf', - 'propertyIsEnumerable', - 'constructor' - ], - DontEnumsLength = DontEnums.length; - - return function (o) { - if (typeof o != "object" && typeof o != "function" || o === null) - throw new TypeError("Object.keys called on a non-object"); - - var result = []; - for (var name in o) { - if (hasOwnProperty.call(o, name)) - result.push(name); - } - - if (hasDontEnumBug) { - for (var i = 0; i < DontEnumsLength; i++) { - if (hasOwnProperty.call(o, DontEnums[i])) - result.push(DontEnums[i]); - } - } - - return result; - }; - })(); - - var SwaggerApi = function (url, options) { - this.isBuilt = false; - this.url = null; - this.debug = false; - this.basePath = null; - this.authorizations = null; - this.authorizationScheme = null; - this.info = null; - this.useJQuery = false; - this.modelsArray = []; - this.isValid; - - options = (options || {}); - if (url) - if (url.url) - options = url; - else - this.url = url; - else - options = url; - - if (options.url != null) - this.url = options.url; - - if (options.success != null) - this.success = options.success; - - if (typeof options.useJQuery === 'boolean') - this.useJQuery = options.useJQuery; - - this.failure = options.failure != null ? options.failure : function () { }; - this.progress = options.progress != null ? options.progress : function () { }; - if (options.success != null) { - this.build(); - this.isBuilt = true; - } - } - - SwaggerApi.prototype.build = function () { - if (this.isBuilt) - return this; - var _this = this; - this.progress('fetching resource list: ' + this.url); - var obj = { - useJQuery: this.useJQuery, - url: this.url, - method: "get", - headers: { - accept: "application/json,application/json;charset=utf-8,*/*" - }, - on: { - error: function (response) { - if (_this.url.substring(0, 4) !== 'http') { - return _this.fail('Please specify the protocol for ' + _this.url); - } else if (response.status === 0) { - return _this.fail('Can\'t read from server. It may not have the appropriate access-control-origin settings.'); - } else if (response.status === 404) { - return _this.fail('Can\'t read swagger JSON from ' + _this.url); - } else { - return _this.fail(response.status + ' : ' + response.statusText + ' ' + _this.url); - } - }, - response: function (resp) { - var responseObj = resp.obj || JSON.parse(resp.data); - _this.swaggerVersion = responseObj.swaggerVersion; - if (_this.swaggerVersion === "1.2") { - return _this.buildFromSpec(responseObj); - } else { - return _this.buildFrom1_1Spec(responseObj); - } - } - } - }; - var e = (typeof window !== 'undefined' ? window : exports); - e.authorizations.apply(obj); - new SwaggerHttp().execute(obj); - return this; - }; - - SwaggerApi.prototype.buildFromSpec = function (response) { - if (response.apiVersion != null) { - this.apiVersion = response.apiVersion; - } - this.apis = {}; - this.apisArray = []; - this.consumes = response.consumes; - this.produces = response.produces; - this.authSchemes = response.authorizations; - if (response.info != null) { - this.info = response.info; - } - var isApi = false; - var i; - for (i = 0; i < response.apis.length; i++) { - var api = response.apis[i]; - if (api.operations) { - var j; - for (j = 0; j < api.operations.length; j++) { - operation = api.operations[j]; - isApi = true; - } - } - } - if (response.basePath) - this.basePath = response.basePath; - else if (this.url.indexOf('?') > 0) - this.basePath = this.url.substring(0, this.url.lastIndexOf('?')); - else - this.basePath = this.url; - - if (isApi) { - var newName = response.resourcePath.replace(/\//g, ''); - this.resourcePath = response.resourcePath; - var res = new SwaggerResource(response, this); - this.apis[newName] = res; - this.apisArray.push(res); - } else { - var k; - for (k = 0; k < response.apis.length; k++) { - var resource = response.apis[k]; - var res = new SwaggerResource(resource, this); - this.apis[res.name] = res; - this.apisArray.push(res); - } - } - this.isValid = true; - if (this.success) { - this.success(); - } - return this; - }; - - SwaggerApi.prototype.buildFrom1_1Spec = function (response) { - log("This API is using a deprecated version of Swagger! Please see http://github.com/wordnik/swagger-core/wiki for more info"); - if (response.apiVersion != null) - this.apiVersion = response.apiVersion; - this.apis = {}; - this.apisArray = []; - this.produces = response.produces; - if (response.info != null) { - this.info = response.info; - } - var isApi = false; - for (var i = 0; i < response.apis.length; i++) { - var api = response.apis[i]; - if (api.operations) { - for (var j = 0; j < api.operations.length; j++) { - operation = api.operations[j]; - isApi = true; - } - } - } - if (response.basePath) { - this.basePath = response.basePath; - } else if (this.url.indexOf('?') > 0) { - this.basePath = this.url.substring(0, this.url.lastIndexOf('?')); - } else { - this.basePath = this.url; - } - if (isApi) { - var newName = response.resourcePath.replace(/\//g, ''); - this.resourcePath = response.resourcePath; - var res = new SwaggerResource(response, this); - this.apis[newName] = res; - this.apisArray.push(res); - } else { - for (k = 0; k < response.apis.length; k++) { - resource = response.apis[k]; - var res = new SwaggerResource(resource, this); - this.apis[res.name] = res; - this.apisArray.push(res); - } - } - this.isValid = true; - if (this.success) { - this.success(); - } - return this; - }; - - SwaggerApi.prototype.selfReflect = function () { - var resource, resource_name, _ref; - if (this.apis == null) { - return false; - } - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - if (resource.ready == null) { - return false; - } - } - this.setConsolidatedModels(); - this.ready = true; - if (this.success != null) { - return this.success(); - } - }; - - SwaggerApi.prototype.fail = function (message) { - this.failure(message); - throw message; - }; - - SwaggerApi.prototype.setConsolidatedModels = function () { - var model, modelName, resource, resource_name, _i, _len, _ref, _ref1, _results; - this.models = {}; - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - for (modelName in resource.models) { - if (this.models[modelName] == null) { - this.models[modelName] = resource.models[modelName]; - this.modelsArray.push(resource.models[modelName]); - } - } - } - _ref1 = this.modelsArray; - _results = []; - for (_i = 0, _len = _ref1.length; _i < _len; _i++) { - model = _ref1[_i]; - _results.push(model.setReferencedModels(this.models)); - } - return _results; - }; - - SwaggerApi.prototype.help = function () { - var operation, operation_name, parameter, resource, resource_name, _i, _len, _ref, _ref1, _ref2; - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - log(resource_name); - _ref1 = resource.operations; - for (operation_name in _ref1) { - operation = _ref1[operation_name]; - log(" " + operation.nickname); - _ref2 = operation.parameters; - for (_i = 0, _len = _ref2.length; _i < _len; _i++) { - parameter = _ref2[_i]; - log(" " + parameter.name + (parameter.required ? ' (required)' : '') + " - " + parameter.description); - } - } - } - return this; - }; - - var SwaggerResource = function (resourceObj, api) { - var _this = this; - this.api = api; - this.api = this.api; - var consumes = (this.consumes | []); - var produces = (this.produces | []); - this.path = this.api.resourcePath != null ? this.api.resourcePath : resourceObj.path; - this.description = resourceObj.description; - - var parts = this.path.split("/"); - this.name = parts[parts.length - 1].replace('.{format}', ''); - this.basePath = this.api.basePath; - this.operations = {}; - this.operationsArray = []; - this.modelsArray = []; - this.models = {}; - this.rawModels = {}; - this.useJQuery = (typeof api.useJQuery !== 'undefined' ? api.useJQuery : null); - - if ((resourceObj.apis != null) && (this.api.resourcePath != null)) { - this.addApiDeclaration(resourceObj); - } else { - if (this.path == null) { - this.api.fail("SwaggerResources must have a path."); - } - if (this.path.substring(0, 4) === 'http') { - this.url = this.path.replace('{format}', 'json'); - } else { - this.url = this.api.basePath + this.path.replace('{format}', 'json'); - } - this.api.progress('fetching resource ' + this.name + ': ' + this.url); - var obj = { - url: this.url, - method: "get", - useJQuery: this.useJQuery, - headers: { - accept: "application/json,application/json;charset=utf-8,*/*" - }, - on: { - response: function (resp) { - var responseObj = resp.obj || JSON.parse(resp.data); - return _this.addApiDeclaration(responseObj); - }, - error: function (response) { - return _this.api.fail("Unable to read api '" + - _this.name + "' from path " + _this.url + " (server returned " + response.statusText + ")"); - } - } - }; - var e = typeof window !== 'undefined' ? window : exports; - e.authorizations.apply(obj); - new SwaggerHttp().execute(obj); - } - } - - SwaggerResource.prototype.getAbsoluteBasePath = function (relativeBasePath) { - var pos, url; - url = this.api.basePath; - pos = url.lastIndexOf(relativeBasePath); - var parts = url.split("/"); - var rootUrl = parts[0] + "//" + parts[2]; - - if (relativeBasePath.indexOf("http") === 0) - return relativeBasePath; - if (relativeBasePath === "/") - return rootUrl; - if (relativeBasePath.substring(0, 1) == "/") { - // use root + relative - return rootUrl + relativeBasePath; - } - else { - var pos = this.basePath.lastIndexOf("/"); - var base = this.basePath.substring(0, pos); - if (base.substring(base.length - 1) == "/") - return base + relativeBasePath; - else - return base + "/" + relativeBasePath; - } - }; - - SwaggerResource.prototype.addApiDeclaration = function (response) { - if (response.produces != null) - this.produces = response.produces; - if (response.consumes != null) - this.consumes = response.consumes; - if ((response.basePath != null) && response.basePath.replace(/\s/g, '').length > 0) - this.basePath = response.basePath.indexOf("http") === -1 ? this.getAbsoluteBasePath(response.basePath) : response.basePath; - - this.addModels(response.models); - if (response.apis) { - for (var i = 0 ; i < response.apis.length; i++) { - var endpoint = response.apis[i]; - this.addOperations(endpoint.path, endpoint.operations, response.consumes, response.produces); - } - } - this.api[this.name] = this; - this.ready = true; - return this.api.selfReflect(); - }; - - SwaggerResource.prototype.addModels = function (models) { - if (models != null) { - var modelName; - for (modelName in models) { - if (this.models[modelName] == null) { - var swaggerModel = new SwaggerModel(modelName, models[modelName]); - this.modelsArray.push(swaggerModel); - this.models[modelName] = swaggerModel; - this.rawModels[modelName] = models[modelName]; - } - } - var output = []; - for (var i = 0; i < this.modelsArray.length; i++) { - var model = this.modelsArray[i]; - output.push(model.setReferencedModels(this.models)); - } - return output; - } - }; - - SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes, produces) { - if (ops) { - var output = []; - for (var i = 0; i < ops.length; i++) { - var o = ops[i]; - consumes = this.consumes; - produces = this.produces; - if (o.consumes != null) - consumes = o.consumes; - else - consumes = this.consumes; - - if (o.produces != null) - produces = o.produces; - else - produces = this.produces; - var type = (o.type || o.responseClass); - - if (type === "array") { - ref = null; - if (o.items) - ref = o.items["type"] || o.items["$ref"]; - type = "array[" + ref + "]"; - } - var responseMessages = o.responseMessages; - var method = o.method; - if (o.httpMethod) { - method = o.httpMethod; - } - if (o.supportedContentTypes) { - consumes = o.supportedContentTypes; - } - if (o.errorResponses) { - responseMessages = o.errorResponses; - for (var j = 0; j < responseMessages.length; j++) { - r = responseMessages[j]; - r.message = r.reason; - r.reason = null; - } - } - o.nickname = this.sanitize(o.nickname); - var op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations, o.deprecated); - this.operations[op.nickname] = op; - output.push(this.operationsArray.push(op)); - } - return output; - } - }; - - SwaggerResource.prototype.sanitize = function (nickname) { - var op; - op = nickname.replace(/[\s!@#$%^&*()_+=\[{\]};:<>|.\/?,\\'""-]/g, '_'); - op = op.replace(/((_){2,})/g, '_'); - op = op.replace(/^(_)*/g, ''); - op = op.replace(/([_])*$/g, ''); - return op; - }; - - SwaggerResource.prototype.help = function () { - var op = this.operations; - var output = []; - var operation_name; - for (operation_name in op) { - operation = op[operation_name]; - var msg = " " + operation.nickname; - for (var i = 0; i < operation.parameters; i++) { - parameter = operation.parameters[i]; - msg.concat(" " + parameter.name + (parameter.required ? ' (required)' : '') + " - " + parameter.description); - } - output.push(msg); - } - return output; - }; - - var SwaggerModel = function (modelName, obj) { - this.name = obj.id != null ? obj.id : modelName; - this.properties = []; - var propertyName; - for (propertyName in obj.properties) { - if (obj.required != null) { - var value; - for (value in obj.required) { - if (propertyName === obj.required[value]) { - obj.properties[propertyName].required = true; - } - } - } - var prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]); - this.properties.push(prop); - } - } - - SwaggerModel.prototype.setReferencedModels = function (allModels) { - var results = []; - for (var i = 0; i < this.properties.length; i++) { - var property = this.properties[i]; - var type = property.type || property.dataType; - if (allModels[type] != null) - results.push(property.refModel = allModels[type]); - else if ((property.refDataType != null) && (allModels[property.refDataType] != null)) - results.push(property.refModel = allModels[property.refDataType]); - else - results.push(void 0); - } - return results; - }; - - SwaggerModel.prototype.getMockSignature = function (modelsToIgnore) { - var propertiesStr = []; - for (var i = 0; i < this.properties.length; i++) { - var prop = this.properties[i]; - propertiesStr.push(prop.toString()); - } - - var strong = ''; - var stronger = ''; - var strongClose = ''; - var classOpen = strong + this.name + ' {' + strongClose; - var classClose = strong + '}' + strongClose; - var returnVal = classOpen + '
' + prop.refModel.getMockSignature(modelsToIgnore)); - } - } - return returnVal; - }; - - SwaggerModel.prototype.createJSONSample = function (modelsToIgnore) { - if (sampleModels[this.name]) { - return sampleModels[this.name]; - } - else { - var result = {}; - var modelsToIgnore = (modelsToIgnore || []) - modelsToIgnore.push(this.name); - for (var i = 0; i < this.properties.length; i++) { - var prop = this.properties[i]; - result[prop.name] = prop.getSampleValue(modelsToIgnore); - } - modelsToIgnore.pop(this.name); - return result; - } - }; - - var SwaggerModelProperty = function (name, obj) { - this.name = name; - this.dataType = obj.type || obj.dataType || obj["$ref"]; - this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set'); - this.descr = obj.description; - this.required = obj.required; - this.defaultValue = modelPropertyMacro(obj.defaultValue); - if (obj.items != null) { - if (obj.items.type != null) { - this.refDataType = obj.items.type; - } - if (obj.items.$ref != null) { - this.refDataType = obj.items.$ref; - } - } - this.dataTypeWithRef = this.refDataType != null ? (this.dataType + '[' + this.refDataType + ']') : this.dataType; - if (obj.allowableValues != null) { - this.valueType = obj.allowableValues.valueType; - this.values = obj.allowableValues.values; - if (this.values != null) { - this.valuesString = "'" + this.values.join("' or '") + "'"; - } - } - if (obj["enum"] != null) { - this.valueType = "string"; - this.values = obj["enum"]; - if (this.values != null) { - this.valueString = "'" + this.values.join("' or '") + "'"; - } - } - } - - SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) { - var result; - if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) { - result = this.refModel.createJSONSample(modelsToIgnore); - } else { - if (this.isCollection) { - result = this.toSampleValue(this.refDataType); - } else { - result = this.toSampleValue(this.dataType); - } - } - if (this.isCollection) { - return [result]; - } else { - return result; - } - }; - - SwaggerModelProperty.prototype.toSampleValue = function (value) { - var result; - if ((typeof this.defaultValue !== 'undefined') && this.defaultValue !== null) { - result = this.defaultValue; - } else if (value === "integer") { - result = 0; - } else if (value === "boolean") { - result = false; - } else if (value === "double" || value === "number") { - result = 0.0; - } else if (value === "string") { - result = ""; - } else { - result = value; - } - return result; - }; - - SwaggerModelProperty.prototype.toString = function () { - var req = this.required ? 'propReq' : 'propOpt'; - var str = '' + this.name + ' (' + this.dataTypeWithRef + ''; - if (!this.required) { - str += ', optional'; - } - str += ')'; - if (this.values != null) { - str += " = ['" + this.values.join("' or '") + "']"; - } - if (this.descr != null) { - str += ': ' + this.descr + ''; - } - return str; - }; - - var SwaggerOperation = function (nickname, path, method, parameters, summary, notes, type, responseMessages, resource, consumes, produces, authorizations, deprecated) { - var _this = this; - - var errors = []; - this.nickname = (nickname || errors.push("SwaggerOperations must have a nickname.")); - this.path = (path || errors.push("SwaggerOperation " + nickname + " is missing path.")); - this.method = (method || errors.push("SwaggerOperation " + nickname + " is missing method.")); - this.parameters = parameters != null ? parameters : []; - this.summary = summary; - this.notes = notes; - this.type = type; - this.responseMessages = (responseMessages || []); - this.resource = (resource || errors.push("Resource is required")); - this.consumes = consumes; - this.produces = produces; - this.authorizations = authorizations; - this.deprecated = deprecated; - this["do"] = __bind(this["do"], this); - - if (errors.length > 0) { - console.error('SwaggerOperation errors', errors, arguments); - this.resource.api.fail(errors); - } - - this.path = this.path.replace('{format}', 'json'); - this.method = this.method.toLowerCase(); - this.isGetMethod = this.method === "get"; - - this.resourceName = this.resource.name; - if (typeof this.type !== 'undefined' && this.type === 'void') - this.type = null; - else { - this.responseClassSignature = this.getSignature(this.type, this.resource.models); - this.responseSampleJSON = this.getSampleJSON(this.type, this.resource.models); - } - - for (var i = 0; i < this.parameters.length; i++) { - var param = this.parameters[i]; - // might take this away - param.name = param.name || param.type || param.dataType; - - // for 1.1 compatibility - var type = param.type || param.dataType; - if (type === 'array') { - type = 'array[' + (param.items.$ref ? param.items.$ref : param.items.type) + ']'; - } - param.type = type; - - if (type && type.toLowerCase() === 'boolean') { - param.allowableValues = {}; - param.allowableValues.values = ["true", "false"]; - } - param.signature = this.getSignature(type, this.resource.models); - param.sampleJSON = this.getSampleJSON(type, this.resource.models); - - var enumValue = param["enum"]; - if (enumValue != null) { - param.isList = true; - param.allowableValues = {}; - param.allowableValues.descriptiveValues = []; - - for (var j = 0; j < enumValue.length; j++) { - var v = enumValue[j]; - if (param.defaultValue != null) { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: (v === param.defaultValue) - }); - } - else { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: false - }); - } - } - } - else if (param.allowableValues != null) { - if (param.allowableValues.valueType === "RANGE") - param.isRange = true; - else - param.isList = true; - if (param.allowableValues != null) { - param.allowableValues.descriptiveValues = []; - if (param.allowableValues.values) { - for (var j = 0; j < param.allowableValues.values.length; j++) { - var v = param.allowableValues.values[j]; - if (param.defaultValue != null) { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: (v === param.defaultValue) - }); - } - else { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: false - }); - } - } - } - } - } - param.defaultValue = parameterMacro(param.defaultValue); - } - this.resource[this.nickname] = function (args, callback, error) { - return _this["do"](args, callback, error); - }; - this.resource[this.nickname].help = function () { - return _this.help(); - }; - } - - SwaggerOperation.prototype.isListType = function (type) { - if (type && type.indexOf('[') >= 0) { - return type.substring(type.indexOf('[') + 1, type.indexOf(']')); - } else { - return void 0; - } - }; - - SwaggerOperation.prototype.getSignature = function (type, models) { - var isPrimitive, listType; - listType = this.isListType(type); - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; - if (isPrimitive) { - return type; - } else { - if (listType != null) { - return models[listType].getMockSignature(); - } else { - return models[type].getMockSignature(); - } - } - }; - - SwaggerOperation.prototype.getSampleJSON = function (type, models) { - var isPrimitive, listType, val; - listType = this.isListType(type); - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; - val = isPrimitive ? void 0 : (listType != null ? models[listType].createJSONSample() : models[type].createJSONSample()); - if (val) { - val = listType ? [val] : val; - if (typeof val == "string") - return val; - else if (typeof val === "object") { - var t = val; - if (val instanceof Array && val.length > 0) { - t = val[0]; - } - if (t.nodeName) { - var xmlString = new XMLSerializer().serializeToString(t); - return this.formatXml(xmlString); - } - else - return JSON.stringify(val, null, 2); - } - else - return val; - } - }; - - SwaggerOperation.prototype["do"] = function (args, opts, callback, error) { - var key, param, params, possibleParams, req, requestContentType, responseContentType, value, _i, _len, _ref; - if (args == null) { - args = {}; - } - if (opts == null) { - opts = {}; - } - requestContentType = null; - responseContentType = null; - if ((typeof args) === "function") { - error = opts; - callback = args; - args = {}; - } - if ((typeof opts) === "function") { - error = callback; - callback = opts; - } - if (error == null) { - error = function (xhr, textStatus, error) { - return log(xhr, textStatus, error); - }; - } - if (callback == null) { - callback = function (response) { - var content; - content = null; - if (response != null) { - content = response.data; - } else { - content = "no data"; - } - return log("default callback: " + content); - }; - } - params = {}; - params.headers = []; - if (args.headers != null) { - params.headers = args.headers; - delete args.headers; - } - - var possibleParams = []; - for (var i = 0; i < this.parameters.length; i++) { - var param = this.parameters[i]; - if (param.paramType === 'header') { - if (args[param.name]) - params.headers[param.name] = args[param.name]; - } - else if (param.paramType === 'form' || param.paramType.toLowerCase() === 'file') - possibleParams.push(param); - else if (param.paramType === 'body' && param.name !== 'body') { - if (args.body) { - throw new Error("Saw two body params in an API listing; expecting a max of one."); - } - args.body = args[param.name]; - } - } - - if (args.body != null) { - params.body = args.body; - delete args.body; - } - - if (possibleParams) { - var key; - for (key in possibleParams) { - var value = possibleParams[key]; - if (args[value.name]) { - params[value.name] = args[value.name]; - } - } - } - - req = new SwaggerRequest(this.method, this.urlify(args), params, opts, callback, error, this); - if (opts.mock != null) { - return req; - } else { - return true; - } - }; - - SwaggerOperation.prototype.pathJson = function () { - return this.path.replace("{format}", "json"); - }; - - SwaggerOperation.prototype.pathXml = function () { - return this.path.replace("{format}", "xml"); - }; - - SwaggerOperation.prototype.encodePathParam = function (pathParam) { - var encParts, part, parts, _i, _len; - pathParam = pathParam.toString(); - if (pathParam.indexOf("/") === -1) { - return encodeURIComponent(pathParam); - } else { - parts = pathParam.split("/"); - encParts = []; - for (_i = 0, _len = parts.length; _i < _len; _i++) { - part = parts[_i]; - encParts.push(encodeURIComponent(part)); - } - return encParts.join("/"); - } - }; - - SwaggerOperation.prototype.urlify = function (args) { - var url = this.resource.basePath + this.pathJson(); - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if (param.paramType === 'path') { - if (args[param.name]) { - // apply path params and remove from args - var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/?|$))', 'gi'); - url = url.replace(reg, this.encodePathParam(args[param.name])); - delete args[param.name]; - } - else - throw "" + param.name + " is a required path param."; - } - } - - var queryParams = ""; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if(param.paramType === 'query') { - if (queryParams !== '') - queryParams += '&'; - if (Array.isArray(param)) { - var j; - var output = ''; - for(j = 0; j < param.length; j++) { - if(j > 0) - output += ','; - output += encodeURIComponent(param[j]); - } - queryParams += encodeURIComponent(param.name) + '=' + output; - } - else { - if (args[param.name]) { - queryParams += encodeURIComponent(param.name) + '=' + encodeURIComponent(args[param.name]); - } else { - if (param.required) - throw "" + param.name + " is a required query param."; - } - } - } - } - if ((queryParams != null) && queryParams.length > 0) - url += '?' + queryParams; - return url; - }; - - SwaggerOperation.prototype.supportHeaderParams = function () { - return this.resource.api.supportHeaderParams; - }; - - SwaggerOperation.prototype.supportedSubmitMethods = function () { - return this.resource.api.supportedSubmitMethods; - }; - - SwaggerOperation.prototype.getQueryParams = function (args) { - return this.getMatchingParams(['query'], args); - }; - - SwaggerOperation.prototype.getHeaderParams = function (args) { - return this.getMatchingParams(['header'], args); - }; - - SwaggerOperation.prototype.getMatchingParams = function (paramTypes, args) { - var matchingParams = {}; - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - param = params[i]; - if (args && args[param.name]) - matchingParams[param.name] = args[param.name]; - } - var headers = this.resource.api.headers; - var name; - for (name in headers) { - var value = headers[name]; - matchingParams[name] = value; - } - return matchingParams; - }; - - SwaggerOperation.prototype.help = function () { - var msg = ""; - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if (msg !== "") - msg += "\n"; - msg += "* " + param.name + (param.required ? ' (required)' : '') + " - " + param.description; - } - return msg; - }; - - - SwaggerOperation.prototype.formatXml = function (xml) { - var contexp, formatted, indent, lastType, lines, ln, pad, reg, transitions, wsexp, _fn, _i, _len; - reg = /(>)(<)(\/*)/g; - wsexp = /[ ]*(.*)[ ]+\n/g; - contexp = /(<.+>)(.+\n)/g; - xml = xml.replace(reg, '$1\n$2$3').replace(wsexp, '$1\n').replace(contexp, '$1\n$2'); - pad = 0; - formatted = ''; - lines = xml.split('\n'); - indent = 0; - lastType = 'other'; - transitions = { - 'single->single': 0, - 'single->closing': -1, - 'single->opening': 0, - 'single->other': 0, - 'closing->single': 0, - 'closing->closing': -1, - 'closing->opening': 0, - 'closing->other': 0, - 'opening->single': 1, - 'opening->closing': 0, - 'opening->opening': 1, - 'opening->other': 1, - 'other->single': 0, - 'other->closing': -1, - 'other->opening': 0, - 'other->other': 0 - }; - _fn = function (ln) { - var fromTo, j, key, padding, type, types, value; - types = { - single: Boolean(ln.match(/<.+\/>/)), - closing: Boolean(ln.match(/<\/.+>/)), - opening: Boolean(ln.match(/<[^!?].*>/)) - }; - type = ((function () { - var _results; - _results = []; - for (key in types) { - value = types[key]; - if (value) { - _results.push(key); - } - } - return _results; - })())[0]; - type = type === void 0 ? 'other' : type; - fromTo = lastType + '->' + type; - lastType = type; - padding = ''; - indent += transitions[fromTo]; - padding = ((function () { - var _j, _ref5, _results; - _results = []; - for (j = _j = 0, _ref5 = indent; 0 <= _ref5 ? _j < _ref5 : _j > _ref5; j = 0 <= _ref5 ? ++_j : --_j) { - _results.push(' '); - } - return _results; - })()).join(''); - if (fromTo === 'opening->closing') { - return formatted = formatted.substr(0, formatted.length - 1) + ln + '\n'; - } else { - return formatted += padding + ln + '\n'; - } - }; - for (_i = 0, _len = lines.length; _i < _len; _i++) { - ln = lines[_i]; - _fn(ln); - } - return formatted; - }; - - var SwaggerRequest = function (type, url, params, opts, successCallback, errorCallback, operation, execution) { - var _this = this; - var errors = []; - this.useJQuery = (typeof operation.resource.useJQuery !== 'undefined' ? operation.resource.useJQuery : null); - this.type = (type || errors.push("SwaggerRequest type is required (get/post/put/delete/patch/options).")); - this.url = (url || errors.push("SwaggerRequest url is required.")); - this.params = params; - this.opts = opts; - this.successCallback = (successCallback || errors.push("SwaggerRequest successCallback is required.")); - this.errorCallback = (errorCallback || errors.push("SwaggerRequest error callback is required.")); - this.operation = (operation || errors.push("SwaggerRequest operation is required.")); - this.execution = execution; - this.headers = (params.headers || {}); - - if (errors.length > 0) { - throw errors; - } - - this.type = this.type.toUpperCase(); - - // set request, response content type headers - var headers = this.setHeaders(params, this.operation); - var body = params.body; - - // encode the body for form submits - if (headers["Content-Type"]) { - var values = {}; - var i; - var operationParams = this.operation.parameters; - for (i = 0; i < operationParams.length; i++) { - var param = operationParams[i]; - if (param.paramType === "form") - values[param.name] = param; - } - - if (headers["Content-Type"].indexOf("application/x-www-form-urlencoded") === 0) { - var encoded = ""; - var key, value; - for (key in values) { - value = this.params[key]; - if (typeof value !== 'undefined') { - if (encoded !== "") - encoded += "&"; - encoded += encodeURIComponent(key) + '=' + encodeURIComponent(value); - } - } - body = encoded; - } - else if (headers["Content-Type"].indexOf("multipart/form-data") === 0) { - // encode the body for form submits - var data = ""; - var boundary = "----SwaggerFormBoundary" + Date.now(); - var key, value; - for (key in values) { - value = this.params[key]; - if (typeof value !== 'undefined') { - data += '--' + boundary + '\n'; - data += 'Content-Disposition: form-data; name="' + key + '"'; - data += '\n\n'; - data += value + "\n"; - } - } - data += "--" + boundary + "--\n"; - headers["Content-Type"] = "multipart/form-data; boundary=" + boundary; - body = data; - } - } - - var obj; - if (!((this.headers != null) && (this.headers.mock != null))) { - obj = { - url: this.url, - method: this.type, - headers: headers, - body: body, - useJQuery: this.useJQuery, - on: { - error: function (response) { - return _this.errorCallback(response, _this.opts.parent); - }, - redirect: function (response) { - return _this.successCallback(response, _this.opts.parent); - }, - 307: function (response) { - return _this.successCallback(response, _this.opts.parent); - }, - response: function (response) { - return _this.successCallback(response, _this.opts.parent); - } - } - }; - var e; - if (typeof window !== 'undefined') { - e = window; - } else { - e = exports; - } - var status = e.authorizations.apply(obj, this.operation.authorizations); - if (opts.mock == null) { - if (status !== false) { - new SwaggerHttp().execute(obj); - } else { - obj.canceled = true; - } - } else { - return obj; - } - } - return obj; - }; - - SwaggerRequest.prototype.setHeaders = function (params, operation) { - // default type - var accepts = "application/json"; - var consumes = "application/json"; - - var allDefinedParams = this.operation.parameters; - var definedFormParams = []; - var definedFileParams = []; - var body = params.body; - var headers = {}; - - // get params from the operation and set them in definedFileParams, definedFormParams, headers - var i; - for (i = 0; i < allDefinedParams.length; i++) { - var param = allDefinedParams[i]; - if (param.paramType === "form") - definedFormParams.push(param); - else if (param.paramType === "file") - definedFileParams.push(param); - else if (param.paramType === "header" && this.params.headers) { - var key = param.name; - var headerValue = this.params.headers[param.name]; - if (typeof this.params.headers[param.name] !== 'undefined') - headers[key] = headerValue; - } - } - - // if there's a body, need to set the accepts header via requestContentType - if (body && (this.type === "POST" || this.type === "PUT" || this.type === "PATCH" || this.type === "DELETE")) { - if (this.opts.requestContentType) - consumes = this.opts.requestContentType; - } else { - // if any form params, content type must be set - if (definedFormParams.length > 0) { - if (definedFileParams.length > 0) - consumes = "multipart/form-data"; - else - consumes = "application/x-www-form-urlencoded"; - } - else if (this.type === "DELETE") - body = "{}"; - else if (this.type != "DELETE") - consumes = null; - } - - if (consumes && this.operation.consumes) { - if (this.operation.consumes.indexOf(consumes) === -1) { - log("server doesn't consume " + consumes + ", try " + JSON.stringify(this.operation.consumes)); - consumes = this.operation.consumes[0]; - } - } - - if (this.opts.responseContentType) { - accepts = this.opts.responseContentType; - } else { - accepts = "application/json"; - } - if (accepts && this.operation.produces) { - if (this.operation.produces.indexOf(accepts) === -1) { - log("server can't produce " + accepts); - accepts = this.operation.produces[0]; - } - } - - if ((consumes && body !== "") || (consumes === "application/x-www-form-urlencoded")) - headers["Content-Type"] = consumes; - if (accepts) - headers["Accept"] = accepts; - return headers; - } - - SwaggerRequest.prototype.asCurl = function () { - var results = []; - if (this.headers) { - var key; - for (key in this.headers) { - results.push("--header \"" + key + ": " + this.headers[v] + "\""); - } - } - return "curl " + (results.join(" ")) + " " + this.url; - }; - - /** - * SwaggerHttp is a wrapper for executing requests - */ - var SwaggerHttp = function () { }; - - SwaggerHttp.prototype.execute = function (obj) { - if (obj && (typeof obj.useJQuery === 'boolean')) - this.useJQuery = obj.useJQuery; - else - this.useJQuery = this.isIE8(); - - if (this.useJQuery) - return new JQueryHttpClient().execute(obj); - else - return new ShredHttpClient().execute(obj); - } - - SwaggerHttp.prototype.isIE8 = function () { - var detectedIE = false; - if (typeof navigator !== 'undefined' && navigator.userAgent) { - nav = navigator.userAgent.toLowerCase(); - if (nav.indexOf('msie') !== -1) { - var version = parseInt(nav.split('msie')[1]); - if (version <= 8) { - detectedIE = true; - } - } - } - return detectedIE; - }; - - /* - * JQueryHttpClient lets a browser take advantage of JQuery's cross-browser magic. - * NOTE: when jQuery is available it will export both '$' and 'jQuery' to the global space. - * Since we are using closures here we need to alias it for internal use. - */ - var JQueryHttpClient = function (options) { - "use strict"; - if (!jQuery) { - var jQuery = window.jQuery; - } - } - - JQueryHttpClient.prototype.execute = function (obj) { - var cb = obj.on; - var request = obj; - - obj.type = obj.method; - obj.cache = false; - - obj.beforeSend = function (xhr) { - var key, results; - if (obj.headers) { - results = []; - var key; - for (key in obj.headers) { - if (key.toLowerCase() === "content-type") { - results.push(obj.contentType = obj.headers[key]); - } else if (key.toLowerCase() === "accept") { - results.push(obj.accepts = obj.headers[key]); - } else { - results.push(xhr.setRequestHeader(key, obj.headers[key])); - } - } - return results; - } - }; - - obj.data = obj.body; - obj.complete = function (response, textStatus, opts) { - var headers = {}, - headerArray = response.getAllResponseHeaders().split("\n"); - - for (var i = 0; i < headerArray.length; i++) { - var toSplit = headerArray[i].trim(); - if (toSplit.length === 0) - continue; - var separator = toSplit.indexOf(":"); - if (separator === -1) { - // Name but no value in the header - headers[toSplit] = null; - continue; - } - var name = toSplit.substring(0, separator).trim(), - value = toSplit.substring(separator + 1).trim(); - headers[name] = value; - } - - var out = { - url: request.url, - method: request.method, - status: response.status, - data: response.responseText, - headers: headers - }; - - var contentType = (headers["content-type"] || headers["Content-Type"] || null) - - if (contentType != null) { - if (contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { - if (response.responseText && response.responseText !== "") - out.obj = JSON.parse(response.responseText); - else - out.obj = {} - } - } - - if (response.status >= 200 && response.status < 300) - cb.response(out); - else if (response.status === 0 || (response.status >= 400 && response.status < 599)) - cb.error(out); - else - return cb.response(out); - }; - - jQuery.support.cors = true; - return jQuery.ajax(obj); - } - - /* - * ShredHttpClient is a light-weight, node or browser HTTP client - */ - var ShredHttpClient = function (options) { - this.options = (options || {}); - this.isInitialized = false; - - var identity, toString; - - if (typeof window !== 'undefined') { - this.Shred = require("./shred"); - this.content = require("./shred/content"); - } - else - this.Shred = require("shred"); - this.shred = new this.Shred(); - } - - ShredHttpClient.prototype.initShred = function () { - this.isInitialized = true; - this.registerProcessors(this.shred); - } - - ShredHttpClient.prototype.registerProcessors = function (shred) { - var identity = function (x) { - return x; - }; - var toString = function (x) { - return x.toString(); - }; - - if (typeof window !== 'undefined') { - this.content.registerProcessor(["application/json; charset=utf-8", "application/json", "json"], { - parser: identity, - stringify: toString - }); - } else { - this.Shred.registerProcessor(["application/json; charset=utf-8", "application/json", "json"], { - parser: identity, - stringify: toString - }); - } - } - - ShredHttpClient.prototype.execute = function (obj) { - if (!this.isInitialized) - this.initShred(); - - var cb = obj.on, res; - - var transform = function (response) { - var out = { - headers: response._headers, - url: response.request.url, - method: response.request.method, - status: response.status, - data: response.content.data - }; - - var headers = response._headers.normalized || response._headers; - var contentType = (headers["content-type"] || headers["Content-Type"] || null) - if (contentType != null) { - if (contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { - if (response.content.data && response.content.data !== "") - try { - out.obj = JSON.parse(response.content.data); - } - catch (ex) { - // do not set out.obj - log ("unable to parse JSON content"); - } - else - out.obj = {} - } - } - return out; - }; - - // Transform an error into a usable response-like object - var transformError = function (error) { - var out = { - // Default to a status of 0 - The client will treat this as a generic permissions sort of error - status: 0, - data: error.message || error - }; - - if (error.code) { - out.obj = error; - - if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { - // We can tell the client that this should be treated as a missing resource and not as a permissions thing - out.status = 404; - } - } - - return out; - }; - - var res = { - error: function (response) { - if (obj) - return cb.error(transform(response)); - }, - // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) - request_error: function (err) { - if (obj) - return cb.error(transformError(err)); - }, - redirect: function (response) { - if (obj) - return cb.redirect(transform(response)); - }, - 307: function (response) { - if (obj) - return cb.redirect(transform(response)); - }, - response: function (response) { - if (obj) - return cb.response(transform(response)); - } - }; - if (obj) { - obj.on = res; - } - return this.shred.request(obj); - }; - - /** - * SwaggerAuthorizations applys the correct authorization to an operation being executed - */ - var SwaggerAuthorizations = function () { - this.authz = {}; - }; - - SwaggerAuthorizations.prototype.add = function (name, auth) { - this.authz[name] = auth; - return auth; - }; - - SwaggerAuthorizations.prototype.remove = function (name) { - return delete this.authz[name]; - }; - - SwaggerAuthorizations.prototype.apply = function (obj, authorizations) { - var status = null; - var key, value, result; - - // if the "authorizations" key is undefined, or has an empty array, add all keys - if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { - for (key in this.authz) { - value = this.authz[key]; - result = value.apply(obj, authorizations); - if (result === true) - status = true; - } - } - else { - for (name in authorizations) { - for (key in this.authz) { - if (key == name) { - value = this.authz[key]; - result = value.apply(obj, authorizations); - if (result === true) - status = true; - } - } - } - } - - return status; - }; - - /** - * ApiKeyAuthorization allows a query param or header to be injected - */ - var ApiKeyAuthorization = function (name, value, type, delimiter) { - this.name = name; - this.value = value; - this.type = type; - this.delimiter = delimiter; - }; - - ApiKeyAuthorization.prototype.apply = function (obj, authorizations) { - if (this.type === "query") { - if (obj.url.indexOf('?') > 0) - obj.url = obj.url + "&" + this.name + "=" + this.value; - else - obj.url = obj.url + "?" + this.name + "=" + this.value; - return true; - } else if (this.type === "header") { - if (typeof obj.headers[this.name] !== 'undefined') { - if (typeof this.delimiter !== 'undefined') - obj.headers[this.name] = obj.headers[this.name] + this.delimiter + this.value; - } - else - obj.headers[this.name] = this.value; - return true; - } - }; - - var CookieAuthorization = function (cookie) { - this.cookie = cookie; - } - - CookieAuthorization.prototype.apply = function (obj, authorizations) { - obj.cookieJar = obj.cookieJar || CookieJar(); - obj.cookieJar.setCookie(this.cookie); - return true; - } - - /** - * Password Authorization is a basic auth implementation - */ - var PasswordAuthorization = function (name, username, password) { - this.name = name; - this.username = username; - this.password = password; - this._btoa = null; - if (typeof window !== 'undefined') - this._btoa = btoa; - else - this._btoa = require("btoa"); - }; - - PasswordAuthorization.prototype.apply = function (obj, authorizations) { - var base64encoder = this._btoa; - obj.headers["Authorization"] = "Basic " + base64encoder(this.username + ":" + this.password); - return true; - }; - - var e = (typeof window !== 'undefined' ? window : exports); - - var sampleModels = {}; - var cookies = {}; - - e.parameterMacro = parameterMacro; - e.modelPropertyMacro = modelPropertyMacro; - e.SampleModels = sampleModels; - e.SwaggerHttp = SwaggerHttp; - e.SwaggerRequest = SwaggerRequest; - e.authorizations = new SwaggerAuthorizations(); - e.ApiKeyAuthorization = ApiKeyAuthorization; - e.PasswordAuthorization = PasswordAuthorization; - e.CookieAuthorization = CookieAuthorization; - e.JQueryHttpClient = JQueryHttpClient; - e.ShredHttpClient = ShredHttpClient; - e.SwaggerOperation = SwaggerOperation; - e.SwaggerModel = SwaggerModel; - e.SwaggerModelProperty = SwaggerModelProperty; - e.SwaggerResource = SwaggerResource; - e.SwaggerApi = SwaggerApi; - e.log = log; - -})(); diff --git a/package.json b/package.json index 48dac1de..56529725 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "readmeFilename": "README.md", "dependencies": { "coffee-script": "~1.6.3", - "swagger-client": "2.0.48", + "swagger-client": "2.1.0-alpha.5", "handlebars": "~1.0.10", "less": "~1.4.2" },
\n
\n\n';return g})})();(function(){var b=Handlebars.template,a=Handlebars.templates=Handlebars.templates||{};a.status_code=b(function(e,k,d,j,i){this.compilerInfo=[4,">= 1.0.0"];d=this.merge(d,e.helpers);i=i||{};var g="",c,f="function",h=this.escapeExpression;g+="\n ';if(c=d.signature){c=c.call(k,{hash:{},data:i})}else{c=k.signature;c=typeof c===f?c.apply(k):c}if(c||c===0){g+=c}g+='\n
\n\n \n
\n';if(c=d.sampleJSON){c=c.call(k,{hash:{},data:i})}else{c=k.sampleJSON;c=typeof c===f?c.apply(k):c}g+=h(c)+'");return $(".response_body",$(this.el)).html(escape(F))};C.prototype.showErrorStatus=function(F,E){return E.showStatus(F)};C.prototype.showCompleteStatus=function(F,E){return E.showStatus(F)};C.prototype.formatXml=function(L){var H,K,F,M,R,N,G,E,P,Q,J,I,O;E=/(>)(<)(\/*)/g;Q=/[ ]*(.*)[ ]+\n/g;H=/(<.+>)(.+\n)/g;L=L.replace(E,"$1\n$2$3").replace(Q,"$1\n").replace(H,"$1\n$2");G=0;K="";R=L.split("\n");F=0;M="other";P={"single->single":0,"single->closing":-1,"single->opening":0,"single->other":0,"closing->single":0,"closing->closing":-1,"closing->opening":0,"closing->other":0,"opening->single":1,"opening->closing":0,"opening->opening":1,"opening->other":1,"other->single":0,"other->closing":-1,"other->opening":0,"other->other":0};J=function(X){var T,S,V,Z,W,U,Y;U={single:Boolean(X.match(/<.+\/>/)),closing:Boolean(X.match(/<\/.+>/)),opening:Boolean(X.match(/<[^!?].*>/))};W=((function(){var aa;aa=[];for(V in U){Y=U[V];if(Y){aa.push(V)}}return aa})())[0];W=W===void 0?"other":W;T=M+"->"+W;M=W;Z="";F+=P[T];Z=((function(){var ab,ac,aa;aa=[];for(S=ab=0,ac=F;0<=ac?ab
"+J.status+"");$(".response_body",$(this.el)).html(L);$(".response_headers",$(this.el)).html("
"+_.escape(JSON.stringify(J.headers,null," ")).replace(/\n/g,"");$(".response",$(this.el)).slideDown();$(".response_hider",$(this.el)).show();$(".response_throbber",$(this.el)).hide();K=$(".response_body",$(this.el))[0];E=this.options.swaggerOptions;if(E.highlightSizeThreshold&&J.data.length>E.highlightSizeThreshold){return K}else{return hljs.highlightBlock(K)}};C.prototype.toggleOperationContent=function(){var E;E=$("#"+Docs.escapeResourceName(this.model.parentId+"_"+this.model.nickname+"_content"));if(E.is(":visible")){return Docs.collapseOperation(E)}else{return Docs.expandOperation(E)}};return C})(Backbone.View);r=(function(D){y(C,D);function C(){e=C.__super__.constructor.apply(this,arguments);return e}C.prototype.initialize=function(){};C.prototype.render=function(){var F,E,G;G=this.template();$(this.el).html(G(this.model));if(swaggerUi.api.models.hasOwnProperty(this.model.responseModel)){F={sampleJSON:JSON.stringify(swaggerUi.api.models[this.model.responseModel].createJSONSample(),null,2),isParam:false,signature:swaggerUi.api.models[this.model.responseModel].getMockSignature()};E=new j({model:F,tagName:"div"});$(".model-signature",this.$el).append(E.render().el)}else{$(".model-signature",this.$el).html("")}return this};C.prototype.template=function(){return Handlebars.templates.status_code};return C})(Backbone.View);m=(function(D){y(C,D);function C(){c=C.__super__.constructor.apply(this,arguments);return c}C.prototype.initialize=function(){return Handlebars.registerHelper("isArray",function(F,E){if(F.type.toLowerCase()==="array"||F.allowMultiple){return E.fn(this)}else{return E.inverse(this)}})};C.prototype.render=function(){var E,F,I,G,J,H,M,N,L,K;K=this.model.type||this.model.dataType;if(typeof K==="undefined"){H=this.model.schema;if(H&&H["$ref"]){G=H["$ref"];if(G.indexOf("#/definitions/")===0){K=G.substring("#/definitions/".length)}else{K=G}}}this.model.type=K;this.model.paramType=this.model["in"]||this.model.paramType;if(this.model.paramType==="body"){this.model.isBody=true}if(K&&K.toLowerCase()==="file"){this.model.isFile=true}this.model["default"]=this.model["default"]||this.model.defaultValue;if(this.model.allowableValues){this.model.isList=true}L=this.template();$(this.el).html(L(this.model));M={sampleJSON:this.model.sampleJSON,isParam:true,signature:this.model.signature};if(this.model.sampleJSON){N=new j({model:M,tagName:"div"});$(".model-signature",$(this.el)).append(N.render().el)}else{$(".model-signature",$(this.el)).html(this.model.signature)}F=false;if(this.model.isBody){F=true}E={isParam:F};E.consumes=this.model.consumes;if(F){I=new n({model:E});$(".parameter-content-type",$(this.el)).append(I.render().el)}else{J=new o({model:E});$(".response-content-type",$(this.el)).append(J.render().el)}return this};C.prototype.template=function(){if(this.model.isList){return Handlebars.templates.param_list}else{if(this.options.readOnly){if(this.model.required){return Handlebars.templates.param_readonly_required}else{return Handlebars.templates.param_readonly}}else{if(this.model.required){return Handlebars.templates.param_required}else{return Handlebars.templates.param}}}};return C})(Backbone.View);j=(function(D){y(C,D);function C(){a=C.__super__.constructor.apply(this,arguments);return a}C.prototype.events={"click a.description-link":"switchToDescription","click a.snippet-link":"switchToSnippet","mousedown .snippet":"snippetToTextArea"};C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));this.switchToSnippet();this.isParam=this.model.isParam;if(this.isParam){$(".notice",$(this.el)).text("Click to set as parameter value")}return this};C.prototype.template=function(){return Handlebars.templates.signature};C.prototype.switchToDescription=function(E){if(E!=null){E.preventDefault()}$(".snippet",$(this.el)).hide();$(".description",$(this.el)).show();$(".description-link",$(this.el)).addClass("selected");return $(".snippet-link",$(this.el)).removeClass("selected")};C.prototype.switchToSnippet=function(E){if(E!=null){E.preventDefault()}$(".description",$(this.el)).hide();$(".snippet",$(this.el)).show();$(".snippet-link",$(this.el)).addClass("selected");return $(".description-link",$(this.el)).removeClass("selected")};C.prototype.snippetToTextArea=function(E){var F;if(this.isParam){if(E!=null){E.preventDefault()}F=$("textarea",$(this.el.parentNode.parentNode.parentNode));if($.trim(F.val())===""){return F.val(this.model.sampleJSON)}}};return C})(Backbone.View);l=(function(C){y(D,C);function D(){A=D.__super__.constructor.apply(this,arguments);return A}D.prototype.initialize=function(){};D.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=contentType]",$(this.el)).text("Response Content Type");return this};D.prototype.template=function(){return Handlebars.templates.content_type};return D})(Backbone.View);o=(function(C){y(D,C);function D(){z=D.__super__.constructor.apply(this,arguments);return z}D.prototype.initialize=function(){};D.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=responseContentType]",$(this.el)).text("Response Content Type");return this};D.prototype.template=function(){return Handlebars.templates.response_content_type};return D})(Backbone.View);n=(function(D){y(C,D);function C(){d=C.__super__.constructor.apply(this,arguments);return d}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));$("label[for=parameterContentType]",$(this.el)).text("Parameter content type:");return this};C.prototype.template=function(){return Handlebars.templates.parameter_content_type};return C})(Backbone.View);t=(function(D){y(C,D);function C(){b=C.__super__.constructor.apply(this,arguments);return b}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));return this};C.prototype.events={"click #apikey_button":"toggleApiKeyContainer","click #apply_api_key":"applyApiKey"};C.prototype.applyApiKey=function(){var E;window.authorizations.add(this.model.name,new ApiKeyAuthorization(this.model.name,$("#input_apiKey_entry").val(),this.model["in"]));window.swaggerUi.load();return E=$("#apikey_container").show()};C.prototype.toggleApiKeyContainer=function(){var E;if($("#apikey_container").length>0){E=$("#apikey_container").first();if(E.is(":visible")){return E.hide()}else{$(".auth_container").hide();return E.show()}}};C.prototype.template=function(){return Handlebars.templates.apikey_button_view};return C})(Backbone.View);k=(function(D){y(C,D);function C(){B=C.__super__.constructor.apply(this,arguments);return B}C.prototype.initialize=function(){};C.prototype.render=function(){var E;E=this.template();$(this.el).html(E(this.model));return this};C.prototype.events={"click #basic_auth_button":"togglePasswordContainer","click #apply_basic_auth":"applyPassword"};C.prototype.applyPassword=function(){var F,E,G;console.log("applying password");G=$(".input_username").val();E=$(".input_password").val();window.authorizations.add(this.model.type,new PasswordAuthorization("basic",G,E));window.swaggerUi.load();return F=$("#basic_auth_container").hide()};C.prototype.togglePasswordContainer=function(){var E;if($("#basic_auth_container").length>0){E=$("#basic_auth_container").show();if(E.is(":visible")){return E.slideUp()}else{$(".auth_container").hide();return E.show()}}};C.prototype.template=function(){return Handlebars.templates.basic_auth_button_view};return C})(Backbone.View)}).call(this); \ No newline at end of file diff --git a/lib/swagger-client.js b/lib/swagger-client.js index cd40c01c..6c46b98d 100644 --- a/lib/swagger-client.js +++ b/lib/swagger-client.js @@ -1,8 +1,10 @@ -// swagger-client.js -// version 2.1.0-alpha.5 /** - * Array Model - **/ + * swagger-client - swagger.js is a javascript client for use with swaggering APIs. + * @version v2.1.0-alpha.5 + * @link http://swagger.io + * @license apache 2.0 + */ +(function(){ var ArrayModel = function(definition) { this.name = "name"; this.definition = definition || {}; @@ -21,11 +23,11 @@ var ArrayModel = function(definition) { this.ref = items['$ref']; } } -} +}; ArrayModel.prototype.createJSONSample = function(modelsToIgnore) { var result; - modelsToIgnore = (modelsToIgnore||{}) + modelsToIgnore = (modelsToIgnore||{}); if(this.type) { result = type; } @@ -38,7 +40,7 @@ ArrayModel.prototype.createJSONSample = function(modelsToIgnore) { ArrayModel.prototype.getSampleValue = function(modelsToIgnore) { var result; - modelsToIgnore = (modelsToIgnore || {}) + modelsToIgnore = (modelsToIgnore || {}); if(this.type) { result = type; } @@ -47,7 +49,7 @@ ArrayModel.prototype.getSampleValue = function(modelsToIgnore) { result = models[name].getSampleValue(modelsToIgnore); } return [ result ]; -} +}; ArrayModel.prototype.getMockSignature = function(modelsToIgnore) { var propertiesStr = []; @@ -57,6 +59,7 @@ ArrayModel.prototype.getMockSignature = function(modelsToIgnore) { } }; + /** * SwaggerAuthorizations applys the correct authorization to an operation being executed */ @@ -78,7 +81,7 @@ SwaggerAuthorizations.prototype.apply = function(obj, authorizations) { var key; // if the "authorizations" key is undefined, or has an empty array, add all keys - if(typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { + if(typeof authorizations === 'undefined' || Object.keys(authorizations).length === 0) { for (key in this.authz) { value = this.authz[key]; result = value.apply(obj, authorizations); @@ -91,7 +94,6 @@ SwaggerAuthorizations.prototype.apply = function(obj, authorizations) { var i; for(i = 0; i < authorizations.length; i++) { var auth = authorizations[i]; - log(auth); for (key in this.authz) { var value = this.authz[key]; if(typeof value !== 'undefined') { @@ -131,13 +133,13 @@ ApiKeyAuthorization.prototype.apply = function(obj, authorizations) { var CookieAuthorization = function(cookie) { this.cookie = cookie; -} +}; CookieAuthorization.prototype.apply = function(obj, authorizations) { obj.cookieJar = obj.cookieJar || CookieJar(); obj.cookieJar.setCookie(this.cookie); return true; -} +}; /** * Password Authorization is a basic auth implementation @@ -157,7 +159,8 @@ PasswordAuthorization.prototype.apply = function(obj, authorizations) { var base64encoder = this._btoa; obj.headers["Authorization"] = "Basic " + base64encoder(this.username + ":" + this.password); return true; -};var __bind = function(fn, me){ +}; +var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; @@ -165,7 +168,7 @@ PasswordAuthorization.prototype.apply = function(obj, authorizations) { fail = function(message) { log(message); -} +}; log = function(){ log.history = log.history || []; @@ -181,63 +184,32 @@ if (!Array.prototype.indexOf) { if (this[i] === obj) { return i; } } return -1; - } -} - -if (!('filter' in Array.prototype)) { - Array.prototype.filter= function(filter, that /*opt*/) { - var other= [], v; - for (var i=0, n= this.length; i
")+"
' + propertiesStr.join(',
') + '
' + classClose;
+ if (!modelsToIgnore)
+ modelsToIgnore = [];
+ modelsToIgnore.push(this.name);
+
+ for (var i = 0; i < this.properties.length; i++) {
+ var prop = this.properties[i];
+ if ((prop.refModel != null) && modelsToIgnore.indexOf(prop.refModel.name) === -1) {
+ returnVal = returnVal + ('' + prop.refModel.getMockSignature(modelsToIgnore)); + } + } + return returnVal; +}; + +SwaggerModel.prototype.createJSONSample = function (modelsToIgnore) { + if (sampleModels[this.name]) { + return sampleModels[this.name]; + } + else { + var result = {}; + var modelsToIgnore = (modelsToIgnore || []); + modelsToIgnore.push(this.name); + for (var i = 0; i < this.properties.length; i++) { + var prop = this.properties[i]; + result[prop.name] = prop.getSampleValue(modelsToIgnore); + } + modelsToIgnore.pop(this.name); + return result; + } +}; + +var SwaggerModelProperty = function (name, obj, model) { + this.name = name; + this.dataType = obj.type || obj.dataType || obj['$ref']; + this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set'); + this.descr = obj.description; + this.required = obj.required; + this.defaultValue = applyModelPropertyMacro(obj, model); + if (obj.items != null) { + if (obj.items.type != null) { + this.refDataType = obj.items.type; + } + if (obj.items.$ref != null) { + this.refDataType = obj.items.$ref; + } + } + this.dataTypeWithRef = this.refDataType != null ? (this.dataType + '[' + this.refDataType + ']') : this.dataType; + if (obj.allowableValues != null) { + this.valueType = obj.allowableValues.valueType; + this.values = obj.allowableValues.values; + if (this.values != null) { + this.valuesString = '\'' + this.values.join('\' or \'') + '\''; + } + } + if (obj['enum'] != null) { + this.valueType = 'string'; + this.values = obj['enum']; + if (this.values != null) { + this.valueString = '\'' + this.values.join('\' or \'') + '\''; + } + } +}; + +SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) { + var result; + if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) { + result = this.refModel.createJSONSample(modelsToIgnore); + } else { + if (this.isCollection) { + result = this.toSampleValue(this.refDataType); + } else { + result = this.toSampleValue(this.dataType); + } + } + if (this.isCollection) { + return [result]; + } else { + return result; + } +}; + +SwaggerModelProperty.prototype.toSampleValue = function (value) { + var result; + if ((typeof this.defaultValue !== 'undefined') && this.defaultValue !== null) { + result = this.defaultValue; + } else if (value === 'integer') { + result = 0; + } else if (value === 'boolean') { + result = false; + } else if (value === 'double' || value === 'number') { + result = 0.0; + } else if (value === 'string') { + result = ''; + } else { + result = value; + } + return result; +}; + +SwaggerModelProperty.prototype.toString = function () { + var req = this.required ? 'propReq' : 'propOpt'; + var str = '' + this.name + ' (' + this.dataTypeWithRef + ''; + if (!this.required) { + str += ', optional'; + } + str += ')'; + if (this.values != null) { + str += ' = ["' + this.values.join('\' or \'') + '\']'; + } + if (this.descr != null) { + str += ': ' + this.descr + ''; + } + return str; +}; + +var SwaggerOperation = function (nickname, path, method, parameters, summary, notes, type, responseMessages, resource, consumes, produces, authorizations, deprecated) { + var _this = this; + + var errors = []; + this.nickname = (nickname || errors.push('SwaggerOperations must have a nickname.')); + this.path = (path || errors.push('SwaggerOperation ' + nickname + ' is missing path.')); + this.method = (method || errors.push('SwaggerOperation ' + nickname + ' is missing method.')); + this.parameters = parameters != null ? parameters : []; + this.summary = summary; + this.notes = notes; + this.type = type; + this.responseMessages = (responseMessages || []); + this.resource = (resource || errors.push('Resource is required')); + this.consumes = consumes; + this.produces = produces; + this.authorizations = typeof authorizations !== 'undefined' ? authorizations : resource.authorizations; + this.deprecated = deprecated; + this['do'] = __bind(this['do'], this); + + if (errors.length > 0) { + console.error('SwaggerOperation errors', errors, arguments); + this.resource.api.fail(errors); + } + + this.path = this.path.replace('{format}', 'json'); + this.method = this.method.toLowerCase(); + this.isGetMethod = this.method === 'GET'; + + this.resourceName = this.resource.name; + if (typeof this.type !== 'undefined' && this.type === 'void') + this.type = null; + else { + this.responseClassSignature = this.getSignature(this.type, this.resource.models); + this.responseSampleJSON = this.getSampleJSON(this.type, this.resource.models); + } + + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + // might take this away + param.name = param.name || param.type || param.dataType; + + // for 1.1 compatibility + var type = param.type || param.dataType; + if (type === 'array') { + type = 'array[' + (param.items.$ref ? param.items.$ref : param.items.type) + ']'; + } + param.type = type; + + if (type && type.toLowerCase() === 'boolean') { + param.allowableValues = {}; + param.allowableValues.values = ['true', 'false']; + } + param.signature = this.getSignature(type, this.resource.models); + param.sampleJSON = this.getSampleJSON(type, this.resource.models); + + var enumValue = param['enum']; + if (enumValue != null) { + param.isList = true; + param.allowableValues = {}; + param.allowableValues.descriptiveValues = []; + + for (var j = 0; j < enumValue.length; j++) { + var v = enumValue[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + else if (param.allowableValues != null) { + if (param.allowableValues.valueType === 'RANGE') + param.isRange = true; + else + param.isList = true; + if (param.allowableValues != null) { + param.allowableValues.descriptiveValues = []; + if (param.allowableValues.values) { + for (var j = 0; j < param.allowableValues.values.length; j++) { + var v = param.allowableValues.values[j]; + if (param.defaultValue != null) { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: (v === param.defaultValue) + }); + } + else { + param.allowableValues.descriptiveValues.push({ + value: String(v), + isDefault: false + }); + } + } + } + } + } + param.defaultValue = applyParameterMacro(param, this); + } + var defaultSuccessCallback = this.resource.api.defaultSuccessCallback || null; + var defaultErrorCallback = this.resource.api.defaultErrorCallback || null; + + this.resource[this.nickname] = function (args, opts, callback, error) { + var arg1, arg2, arg3, arg4; + if(typeof args === 'function') // right shift 3 + arg1 = {}, arg2 = {}, arg3 = args, arg4 = opts; + else if(typeof args === 'object' && typeof opts === 'function') // right shift 2 + arg1 = args, arg2 = {}, arg3 = opts, arg4 = callback; + else + arg1 = args, arg2 = opts, arg3 = callback, arg4 = error; + + return _this['do'](arg1 || {}, arg2 || {}, arg3 || defaultSuccessCallback, arg4 || defaultErrorCallback); + }; + + this.resource[this.nickname].help = function () { + return _this.help(); + }; + this.resource[this.nickname].asCurl = function (args) { + return _this.asCurl(args); + }; +} + +SwaggerOperation.prototype.isListType = function (type) { + if (type && type.indexOf('[') >= 0) { + return type.substring(type.indexOf('[') + 1, type.indexOf(']')); + } else { + return void 0; + } +}; + +SwaggerOperation.prototype.getSignature = function (type, models) { + var isPrimitive, listType; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + if (isPrimitive) { + return type; + } else { + if (listType != null) { + return models[listType].getMockSignature(); + } else { + return models[type].getMockSignature(); + } + } +}; + +SwaggerOperation.prototype.getSampleJSON = function (type, models) { + var isPrimitive, listType, val; + listType = this.isListType(type); + isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + val = isPrimitive ? void 0 : (listType != null ? models[listType].createJSONSample() : models[type].createJSONSample()); + if (val) { + val = listType ? [val] : val; + if (typeof val == 'string') + return val; + else if (typeof val === 'object') { + var t = val; + if (val instanceof Array && val.length > 0) { + t = val[0]; + } + if (t.nodeName) { + var xmlString = new XMLSerializer().serializeToString(t); + return this.formatXml(xmlString); + } + else + return JSON.stringify(val, null, 2); + } + else + return val; + } +}; + +SwaggerOperation.prototype['do'] = function (args, opts, callback, error) { + var key, param, params, possibleParams, req, value; + + if (error == null) { + error = function (xhr, textStatus, error) { + return log(xhr, textStatus, error); + }; + } + + if (callback == null) { + callback = function (response) { + var content; + content = null; + if (response != null) { + content = response.data; + } else { + content = 'no data'; + } + return log('default callback: ' + content); + }; + } + params = {}; + params.headers = []; + if (args.headers != null) { + params.headers = args.headers; + delete args.headers; + } + // allow override from the opts + if(opts && opts.responseContentType) { + params.headers['Content-Type'] = opts.responseContentType; + } + if(opts && opts.requestContentType) { + params.headers['Accept'] = opts.requestContentType; + } + + var possibleParams = []; + for (var i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if (param.paramType === 'header') { + if (typeof args[param.name] !== 'undefined') + params.headers[param.name] = args[param.name]; + } + else if (param.paramType === 'form' || param.paramType.toLowerCase() === 'file') + possibleParams.push(param); + else if (param.paramType === 'body' && param.name !== 'body' && typeof args[param.name] !== 'undefined') { + if (args.body) { + throw new Error('Saw two body params in an API listing; expecting a max of one.'); + } + args.body = args[param.name]; + } + } + + if (args.body != null) { + params.body = args.body; + delete args.body; + } + + if (possibleParams) { + var key; + for (key in possibleParams) { + var value = possibleParams[key]; + if (args[value.name]) { + params[value.name] = args[value.name]; + } + } + } + req = new SwaggerRequest(this.method, this.urlify(args), params, opts, callback, error, this); + if (opts.mock != null) { + return req; + } else { + return true; + } +}; + +SwaggerOperation.prototype.pathJson = function () { + return this.path.replace('{format}', 'json'); +}; + +SwaggerOperation.prototype.pathXml = function () { + return this.path.replace('{format}', 'xml'); +}; + +SwaggerOperation.prototype.encodePathParam = function (pathParam) { + var encParts, part, parts, _i, _len; + pathParam = pathParam.toString(); + if (pathParam.indexOf('/') === -1) { + return encodeURIComponent(pathParam); + } else { + parts = pathParam.split('/'); + encParts = []; + for (_i = 0, _len = parts.length; _i < _len; _i++) { + part = parts[_i]; + encParts.push(encodeURIComponent(part)); + } + return encParts.join('/'); + } +}; + +SwaggerOperation.prototype.urlify = function (args) { + var url = this.resource.basePath + this.pathJson(); + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (param.paramType === 'path') { + if (typeof args[param.name] !== 'undefined') { + // apply path params and remove from args + var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/?|$))', 'gi'); + url = url.replace(reg, this.encodePathParam(args[param.name])); + delete args[param.name]; + } + else + throw '' + param.name + ' is a required path param.'; + } + } + + var queryParams = ''; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if(param.paramType === 'query') { + if (queryParams !== '') + queryParams += '&'; + if (Array.isArray(param)) { + var j; + var output = ''; + for(j = 0; j < param.length; j++) { + if(j > 0) + output += ','; + output += encodeURIComponent(param[j]); + } + queryParams += encodeURIComponent(param.name) + '=' + output; + } + else { + if (typeof args[param.name] !== 'undefined') { + queryParams += encodeURIComponent(param.name) + '=' + encodeURIComponent(args[param.name]); + } else { + if (param.required) + throw '' + param.name + ' is a required query param.'; + } + } + } + } + if ((queryParams != null) && queryParams.length > 0) + url += '?' + queryParams; + return url; +}; + +SwaggerOperation.prototype.supportHeaderParams = function () { + return this.resource.api.supportHeaderParams; +}; + +SwaggerOperation.prototype.supportedSubmitMethods = function () { + return this.resource.api.supportedSubmitMethods; +}; + +SwaggerOperation.prototype.getQueryParams = function (args) { + return this.getMatchingParams(['query'], args); +}; + +SwaggerOperation.prototype.getHeaderParams = function (args) { + return this.getMatchingParams(['header'], args); +}; + +SwaggerOperation.prototype.getMatchingParams = function (paramTypes, args) { + var matchingParams = {}; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + param = params[i]; + if (args && args[param.name]) + matchingParams[param.name] = args[param.name]; + } + var headers = this.resource.api.headers; + var name; + for (name in headers) { + var value = headers[name]; + matchingParams[name] = value; + } + return matchingParams; +}; + +SwaggerOperation.prototype.help = function () { + var msg = ''; + var params = this.parameters; + for (var i = 0; i < params.length; i++) { + var param = params[i]; + if (msg !== '') + msg += '\n'; + msg += '* ' + param.name + (param.required ? ' (required)' : '') + " - " + param.description; + } + return msg; +}; + +SwaggerOperation.prototype.asCurl = function (args) { + var results = []; + var i; + + var headers = SwaggerRequest.prototype.setHeaders(args, {}, this); + for(i = 0; i < this.parameters.length; i++) { + var param = this.parameters[i]; + if(param.paramType && param.paramType === 'header' && args[param.name]) { + headers[param.name] = args[param.name]; + } + } + + var key; + for (key in headers) { + results.push('--header "' + key + ': ' + headers[key] + '"'); + } + return 'curl ' + (results.join(' ')) + ' ' + this.urlify(args); +}; + +SwaggerOperation.prototype.formatXml = function (xml) { + var contexp, formatted, indent, lastType, lines, ln, pad, reg, transitions, wsexp, _fn, _i, _len; + reg = /(>)(<)(\/*)/g; + wsexp = /[ ]*(.*)[ ]+\n/g; + contexp = /(<.+>)(.+\n)/g; + xml = xml.replace(reg, '$1\n$2$3').replace(wsexp, '$1\n').replace(contexp, '$1\n$2'); + pad = 0; + formatted = ''; + lines = xml.split('\n'); + indent = 0; + lastType = 'other'; + transitions = { + 'single->single': 0, + 'single->closing': -1, + 'single->opening': 0, + 'single->other': 0, + 'closing->single': 0, + 'closing->closing': -1, + 'closing->opening': 0, + 'closing->other': 0, + 'opening->single': 1, + 'opening->closing': 0, + 'opening->opening': 1, + 'opening->other': 1, + 'other->single': 0, + 'other->closing': -1, + 'other->opening': 0, + 'other->other': 0 + }; + _fn = function (ln) { + var fromTo, j, key, padding, type, types, value; + types = { + single: Boolean(ln.match(/<.+\/>/)), + closing: Boolean(ln.match(/<\/.+>/)), + opening: Boolean(ln.match(/<[^!?].*>/)) + }; + type = ((function () { + var _results; + _results = []; + for (key in types) { + value = types[key]; + if (value) { + _results.push(key); + } + } + return _results; + })())[0]; + type = type === void 0 ? 'other' : type; + fromTo = lastType + '->' + type; + lastType = type; + padding = ''; + indent += transitions[fromTo]; + padding = ((function () { + var _j, _ref5, _results; + _results = []; + for (j = _j = 0, _ref5 = indent; 0 <= _ref5 ? _j < _ref5 : _j > _ref5; j = 0 <= _ref5 ? ++_j : --_j) { + _results.push(' '); + } + return _results; + })()).join(''); + if (fromTo === 'opening->closing') { + return formatted = formatted.substr(0, formatted.length - 1) + ln + '\n'; + } else { + return formatted += padding + ln + '\n'; + } + }; + for (_i = 0, _len = lines.length; _i < _len; _i++) { + ln = lines[_i]; + _fn(ln); + } + return formatted; +}; + +var SwaggerRequest = function (type, url, params, opts, successCallback, errorCallback, operation, execution) { + var _this = this; + var errors = []; + this.useJQuery = (typeof operation.resource.useJQuery !== 'undefined' ? operation.resource.useJQuery : null); + this.type = (type || errors.push('SwaggerRequest type is required (get/post/put/delete/patch/options).')); + this.url = (url || errors.push('SwaggerRequest url is required.')); + this.params = params; + this.opts = opts; + this.successCallback = (successCallback || errors.push('SwaggerRequest successCallback is required.')); + this.errorCallback = (errorCallback || errors.push('SwaggerRequest error callback is required.')); + this.operation = (operation || errors.push('SwaggerRequest operation is required.')); + this.execution = execution; + this.headers = (params.headers || {}); + + if (errors.length > 0) { + throw errors; + } + + this.type = this.type.toUpperCase(); + + // set request, response content type headers + var headers = this.setHeaders(params, opts, this.operation); + var body = params.body; + + // encode the body for form submits + if (headers['Content-Type']) { + var values = {}; + var i; + var operationParams = this.operation.parameters; + for (i = 0; i < operationParams.length; i++) { + var param = operationParams[i]; + if (param.paramType === 'form') + values[param.name] = param; + } + + if (headers['Content-Type'].indexOf('application/x-www-form-urlencoded') === 0) { + var encoded = ''; + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + if (encoded !== '') + encoded += '&'; + encoded += encodeURIComponent(key) + '=' + encodeURIComponent(value); + } + } + body = encoded; + } + else if (headers['Content-Type'].indexOf('multipart/form-data') === 0) { + // encode the body for form submits + var data = ''; + var boundary = '----SwaggerFormBoundary' + Date.now(); + var key, value; + for (key in values) { + value = this.params[key]; + if (typeof value !== 'undefined') { + data += '--' + boundary + '\n'; + data += 'Content-Disposition: form-data; name="' + key + '"'; + data += '\n\n'; + data += value + '\n'; + } + } + data += '--' + boundary + '--\n'; + headers['Content-Type'] = 'multipart/form-data; boundary=' + boundary; + body = data; + } + } + + var obj; + if (!((this.headers != null) && (this.headers.mock != null))) { + obj = { + url: this.url, + method: this.type, + headers: headers, + body: body, + useJQuery: this.useJQuery, + on: { + error: function (response) { + return _this.errorCallback(response, _this.opts.parent); + }, + redirect: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + 307: function (response) { + return _this.successCallback(response, _this.opts.parent); + }, + response: function (response) { + return _this.successCallback(response, _this.opts.parent); + } + } + }; + + var status = false; + if (this.operation.resource && this.operation.resource.api && this.operation.resource.api.clientAuthorizations) { + // Get the client authorizations from the resource declaration + status = this.operation.resource.api.clientAuthorizations.apply(obj, this.operation.authorizations); + } else { + // Get the client authorization from the default authorization declaration + var e; + if (typeof window !== 'undefined') { + e = window; + } else { + e = exports; + } + status = e.authorizations.apply(obj, this.operation.authorizations); + } + + if (opts.mock == null) { + if (status !== false) { + new SwaggerHttp().execute(obj); + } else { + obj.canceled = true; + } + } else { + return obj; + } + } + return obj; +}; + +SwaggerRequest.prototype.setHeaders = function (params, opts, operation) { + // default type + var accepts = opts.responseContentType || 'application/json'; + var consumes = opts.requestContentType || 'application/json'; + + var allDefinedParams = operation.parameters; + var definedFormParams = []; + var definedFileParams = []; + var body = params.body; + var headers = {}; + + // get params from the operation and set them in definedFileParams, definedFormParams, headers + var i; + for (i = 0; i < allDefinedParams.length; i++) { + var param = allDefinedParams[i]; + if (param.paramType === 'form') + definedFormParams.push(param); + else if (param.paramType === 'file') + definedFileParams.push(param); + else if (param.paramType === 'header' && this.params.headers) { + var key = param.name; + var headerValue = this.params.headers[param.name]; + if (typeof this.params.headers[param.name] !== 'undefined') + headers[key] = headerValue; + } + } + + // if there's a body, need to set the accepts header via requestContentType + if (body && (this.type === 'POST' || this.type === 'PUT' || this.type === 'PATCH' || this.type === 'DELETE')) { + if (this.opts.requestContentType) + consumes = this.opts.requestContentType; + } else { + // if any form params, content type must be set + if (definedFormParams.length > 0) { + if (definedFileParams.length > 0) + consumes = 'multipart/form-data'; + else + consumes = 'application/x-www-form-urlencoded'; + } + else if (this.type === 'DELETE') + body = '{}'; + else if (this.type != 'DELETE') + consumes = null; + } + + if (consumes && this.operation.consumes) { + if (this.operation.consumes.indexOf(consumes) === -1) { + log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.operation.consumes)); + } + } + + if (this.opts && this.opts.responseContentType) { + accepts = this.opts.responseContentType; + } else { + accepts = 'application/json'; + } + if (accepts && operation.produces) { + if (operation.produces.indexOf(accepts) === -1) { + log('server can\'t produce ' + accepts); + } + } + + if ((consumes && body !== '') || (consumes === 'application/x-www-form-urlencoded')) + headers['Content-Type'] = consumes; + if (accepts) + headers['Accept'] = accepts; + return headers; +} + +/** + * SwaggerHttp is a wrapper for executing requests + */ +var SwaggerHttp = function () { }; + +SwaggerHttp.prototype.execute = function (obj) { + if (obj && (typeof obj.useJQuery === 'boolean')) + this.useJQuery = obj.useJQuery; + else + this.useJQuery = this.isIE8(); + + if (this.useJQuery) + return new JQueryHttpClient().execute(obj); + else + return new ShredHttpClient().execute(obj); +} + +SwaggerHttp.prototype.isIE8 = function () { + var detectedIE = false; + if (typeof navigator !== 'undefined' && navigator.userAgent) { + nav = navigator.userAgent.toLowerCase(); + if (nav.indexOf('msie') !== -1) { + var version = parseInt(nav.split('msie')[1]); + if (version <= 8) { + detectedIE = true; + } + } + } + return detectedIE; +}; + +/* + * JQueryHttpClient lets a browser take advantage of JQuery's cross-browser magic. + * NOTE: when jQuery is available it will export both '$' and 'jQuery' to the global space. + * Since we are using closures here we need to alias it for internal use. + */ +var JQueryHttpClient = function (options) { + this.options = options || {}; + if (!jQuery) { + var jQuery = window.jQuery; + } +} + +JQueryHttpClient.prototype.execute = function (obj) { + var cb = obj.on; + var request = obj; + + obj.type = obj.method; + obj.cache = false; + + obj.beforeSend = function (xhr) { + var key, results; + if (obj.headers) { + results = []; + var key; + for (key in obj.headers) { + if (key.toLowerCase() === 'content-type') { + results.push(obj.contentType = obj.headers[key]); + } else if (key.toLowerCase() === 'accept') { + results.push(obj.accepts = obj.headers[key]); + } else { + results.push(xhr.setRequestHeader(key, obj.headers[key])); + } + } + return results; + } + }; + + obj.data = obj.body; + obj.complete = function (response) { + var headers = {}, + headerArray = response.getAllResponseHeaders().split('\n'); + + for (var i = 0; i < headerArray.length; i++) { + var toSplit = headerArray[i].trim(); + if (toSplit.length === 0) + continue; + var separator = toSplit.indexOf(':'); + if (separator === -1) { + // Name but no value in the header + headers[toSplit] = null; + continue; + } + var name = toSplit.substring(0, separator).trim(), + value = toSplit.substring(separator + 1).trim(); + headers[name] = value; + } + + var out = { + url: request.url, + method: request.method, + status: response.status, + data: response.responseText, + headers: headers + }; + + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.responseText && response.responseText !== '') + out.obj = JSON.parse(response.responseText); + else + out.obj = {} + } + } + + if (response.status >= 200 && response.status < 300) + cb.response(out); + else if (response.status === 0 || (response.status >= 400 && response.status < 599)) + cb.error(out); + else + return cb.response(out); + }; + + jQuery.support.cors = true; + return jQuery.ajax(obj); +} + +/* + * ShredHttpClient is a light-weight, node or browser HTTP client + */ +var ShredHttpClient = function (options) { + this.options = (options || {}); + this.isInitialized = false; + + if (typeof window !== 'undefined') { + this.Shred = require('./shred'); + this.content = require('./shred/content'); + } + else + this.Shred = require('shred'); + this.shred = new this.Shred(); +} + +ShredHttpClient.prototype.initShred = function () { + this.isInitialized = true; + this.registerProcessors(this.shred); +} + +ShredHttpClient.prototype.registerProcessors = function () { + var identity = function (x) { + return x; + }; + var toString = function (x) { + return x.toString(); + }; + + if (typeof window !== 'undefined') { + this.content.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } else { + this.Shred.registerProcessor(['application/json; charset=utf-8', 'application/json', 'json'], { + parser: identity, + stringify: toString + }); + } +} + +ShredHttpClient.prototype.execute = function (obj) { + if (!this.isInitialized) + this.initShred(); + + var cb = obj.on, res; + + var transform = function (response) { + var out = { + headers: response._headers, + url: response.request.url, + method: response.request.method, + status: response.status, + data: response.content.data + }; + + var headers = response._headers.normalized || response._headers; + var contentType = (headers['content-type'] || headers['Content-Type'] || null) + if (contentType != null) { + if (contentType.indexOf('application/json') == 0 || contentType.indexOf('+json') > 0) { + if (response.content.data && response.content.data !== '') + try { + out.obj = JSON.parse(response.content.data); + } + catch (ex) { + // do not set out.obj + log('unable to parse JSON content'); + } + else + out.obj = {} + } + } + return out; + }; + + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + + return out; + }; + + var res = { + error: function (response) { + if (obj) + return cb.error(transform(response)); + }, + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { + if (obj) + return cb.error(transformError(err)); + }, + response: function (response) { + if (obj) + return cb.response(transform(response)); + } + }; + if (obj) { + obj.on = res; + } + return this.shred.request(obj); +}; + +/** + * SwaggerAuthorizations applys the correct authorization to an operation being executed + */ +var SwaggerAuthorizations = function (name, auth) { + this.authz = {}; + if(name && auth) { + this.authz[name] = auth; + } +}; + +SwaggerAuthorizations.prototype.add = function (name, auth) { + this.authz[name] = auth; + return auth; +}; + +SwaggerAuthorizations.prototype.remove = function (name) { + return delete this.authz[name]; +}; + +SwaggerAuthorizations.prototype.apply = function (obj, authorizations) { + var status = null; + var key, value, result; + + // if the "authorizations" key is undefined, or has an empty array, add all keys + if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { + for (key in this.authz) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + else { + for (name in authorizations) { + for (key in this.authz) { + if (key == name) { + value = this.authz[key]; + result = value.apply(obj, authorizations); + if (result === true) + status = true; + } + } + } + } + + return status; +}; + +/** + * ApiKeyAuthorization allows a query param or header to be injected + */ +var ApiKeyAuthorization = function (name, value, type, delimiter) { + this.name = name; + this.value = value; + this.type = type; + this.delimiter = delimiter; +}; + +ApiKeyAuthorization.prototype.apply = function (obj) { + if (this.type === 'query') { + if (obj.url.indexOf('?') > 0) + obj.url = obj.url + '&' + this.name + '=' + this.value; + else + obj.url = obj.url + '?' + this.name + '=' + this.value; + return true; + } else if (this.type === 'header') { + if (typeof obj.headers[this.name] !== 'undefined') { + if (typeof this.delimiter !== 'undefined') + obj.headers[this.name] = obj.headers[this.name] + this.delimiter + this.value; + } + else + obj.headers[this.name] = this.value; + return true; + } +}; + +/** + * Password Authorization is a basic auth implementation + */ +var PasswordAuthorization = function (name, username, password) { + this.name = name; + this.username = username; + this.password = password; + this._btoa = null; + if (typeof window !== 'undefined') + this._btoa = btoa; + else + this._btoa = require('btoa'); +}; + +PasswordAuthorization.prototype.apply = function (obj) { + var base64encoder = this._btoa; + obj.headers['Authorization'] = 'Basic ' + base64encoder(this.username + ':' + this.password); + return true; +}; + +var SwaggerClient = function(url, options) { this.isBuilt = false; this.url = null; this.debug = false; @@ -307,22 +1858,23 @@ PrimitiveModel.prototype.getMockSignature = function(modelsToIgnore) { else this.url = url; else options = url; - if (options.url != null) + if (options.url !== null) this.url = options.url; - if (options.success != null) + if (options.success !== null) this.success = options.success; if (typeof options.useJQuery === 'boolean') this.useJQuery = options.useJQuery; + this.supportedSubmitMethods = options.supportedSubmitMethods || []; this.failure = options.failure != null ? options.failure : function() {}; this.progress = options.progress != null ? options.progress : function() {}; this.spec = options.spec; - if (options.success != null) + if (options.success !== null) this.build(); -} +}; SwaggerClient.prototype.build = function() { var self = this; @@ -482,7 +2034,7 @@ SwaggerClient.prototype.buildFromSpec = function(response) { if (this.success) this.success(); return this; -} +}; SwaggerClient.prototype.parseUri = function(uri) { var urlParseRE = /^(((([^:\/#\?]+:)?(?:(\/\/)((?:(([^:@\/#\?]+)(?:\:([^:@\/#\?]+))?)@)?(([^:\/#\?\]\[]+|\[[^\/\]@#?]+\])(?:\:([0-9]+))?))?)?)?((\/?(?:[^\/\?#]+\/+)*)([^\?#]*)))?(\?[^#]+)?)(#.*)?/; @@ -493,7 +2045,7 @@ SwaggerClient.prototype.parseUri = function(uri) { port: parts[12], path: parts[15] }; -} +}; SwaggerClient.prototype.help = function() { var i; @@ -502,11 +2054,11 @@ SwaggerClient.prototype.help = function() { var api = this.apis[i]; log(' * ' + api.nickname + ': ' + api.operation.summary); } -} +}; SwaggerClient.prototype.tagFromLabel = function(label) { return label; -} +}; SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { if(typeof op.operationId !== 'undefined') { @@ -519,7 +2071,7 @@ SwaggerClient.prototype.idFromOp = function(path, httpMethod, op) { .replace(/\}/g, "") .replace(/\./g, "_") + "_" + httpMethod; } -} +}; SwaggerClient.prototype.fail = function(message) { this.failure(message); @@ -534,7 +2086,7 @@ var OperationGroup = function(tag, operation) { this.operationsArray = []; this.description = operation.description || ""; -} +}; var Operation = function(parent, operationId, httpMethod, path, args, definitions) { var errors = []; @@ -652,11 +2204,11 @@ var Operation = function(parent, operationId, httpMethod, path, args, definition } return this; -} +}; OperationGroup.prototype.sort = function(sorter) { -} +}; Operation.prototype.getType = function (param) { var type = param.type; @@ -668,7 +2220,7 @@ Operation.prototype.getType = function (param) { else if(type === 'integer' && format === 'int64') str = 'long'; else if(type === 'integer') - str = 'integer' + str = 'integer'; else if(type === 'string' && format === 'date-time') str = 'date-time'; else if(type === 'string' && format === 'date') @@ -708,7 +2260,7 @@ Operation.prototype.getType = function (param) { return [ str ]; else return str; -} +}; Operation.prototype.resolveModel = function (schema, definitions) { if(typeof schema['$ref'] !== 'undefined') { @@ -722,7 +2274,7 @@ Operation.prototype.resolveModel = function (schema, definitions) { return new ArrayModel(schema); else return null; -} +}; Operation.prototype.help = function(dontPrint) { var out = this.nickname + ': ' + this.summary + '\n'; @@ -734,7 +2286,7 @@ Operation.prototype.help = function(dontPrint) { if(typeof dontPrint === 'undefined') log(out); return out; -} +}; Operation.prototype.getSignature = function(type, models) { var isPrimitive, listType; @@ -745,13 +2297,13 @@ Operation.prototype.getSignature = function(type, models) { } if(type === 'string') - isPrimitive = true + isPrimitive = true; else - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; + isPrimitive = ((listType !== null) && models[listType]) || (models[type] != null) ? false : true; if (isPrimitive) { return type; } else { - if (listType != null) + if (listType !== null) return models[type].getMockSignature(); else return models[type].getMockSignature(); @@ -763,7 +2315,7 @@ Operation.prototype.supportHeaderParams = function () { }; Operation.prototype.supportedSubmitMethods = function () { - return this.resource.api.supportedSubmitMethods; + return this.parent.supportedSubmitMethods; }; Operation.prototype.getHeaderParams = function (args) { @@ -782,7 +2334,7 @@ Operation.prototype.getHeaderParams = function (args) { } } return headers; -} +}; Operation.prototype.urlify = function (args) { var formParams = {}; @@ -827,7 +2379,7 @@ Operation.prototype.urlify = function (args) { url += this.basePath; return url + requestUrl + querystring; -} +}; Operation.prototype.getMissingParams = function(args) { var missingParams = []; @@ -841,7 +2393,7 @@ Operation.prototype.getMissingParams = function(args) { } } return missingParams; -} +}; Operation.prototype.getBody = function(headers, args) { var formParams = {}; @@ -871,7 +2423,7 @@ Operation.prototype.getBody = function(headers, args) { } return body; -} +}; /** * gets sample response for a single operation @@ -902,14 +2454,14 @@ Operation.prototype.getSampleJSON = function(type, models) { else return sampleJson; } -} +}; /** * legacy binding **/ Operation.prototype["do"] = function(args, opts, callback, error, parent) { return this.execute(args, opts, callback, error, parent); -} +}; /** @@ -929,8 +2481,8 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { error = arg3; } - success = (success||log) - error = (error||log) + success = (success||log); + error = (error||log); var missingParams = this.getMissingParams(args); if(missingParams.length > 0) { @@ -941,7 +2493,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { var headers = this.getHeaderParams(args); var body = this.getBody(headers, args); - var url = this.urlify(args) + var url = this.urlify(args); var obj = { url: url, @@ -960,7 +2512,7 @@ Operation.prototype.execute = function(arg1, arg2, arg3, arg4, parent) { }; var status = e.authorizations.apply(obj, this.operation.security); new SwaggerHttp().execute(obj); -} +}; Operation.prototype.setContentTypes = function(args, opts) { // default type @@ -1017,7 +2569,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (consumes && this.consumes) { if (this.consumes.indexOf(consumes) === -1) { log('server doesn\'t consume ' + consumes + ', try ' + JSON.stringify(this.consumes)); - consumes = this.operation.consumes[0]; } } @@ -1029,7 +2580,6 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts && this.produces) { if (this.produces.indexOf(accepts) === -1) { log('server can\'t produce ' + accepts); - accepts = this.produces[0]; } } @@ -1038,7 +2588,7 @@ Operation.prototype.setContentTypes = function(args, opts) { if (accepts) headers['Accept'] = accepts; return headers; -} +}; Operation.prototype.asCurl = function (args) { var results = []; @@ -1049,7 +2599,7 @@ Operation.prototype.asCurl = function (args) { results.push("--header \"" + key + ": " + headers[key] + "\""); } return "curl " + (results.join(" ")) + " " + this.urlify(args); -} +}; Operation.prototype.encodePathCollection = function(type, name, value) { var encoded = ''; @@ -1071,14 +2621,14 @@ Operation.prototype.encodePathCollection = function(type, name, value) { encoded += separator + this.encodeQueryParam(value[i]); } return encoded; -} +}; Operation.prototype.encodeQueryCollection = function(type, name, value) { var encoded = ''; var i; if(type === 'default' || type === 'multi') { for(i = 0; i < value.length; i++) { - if(i > 0) encoded += '&' + if(i > 0) encoded += '&'; encoded += this.encodeQueryParam(name) + '=' + this.encodeQueryParam(value[i]); } } @@ -1109,14 +2659,11 @@ Operation.prototype.encodeQueryCollection = function(type, name, value) { } } return encoded; -} +}; -/** - * TODO this encoding needs to be changed - **/ Operation.prototype.encodeQueryParam = function(arg) { - return escape(arg); -} + return encodeURIComponent(arg); +}; /** * TODO revisit, might not want to leave '/' @@ -1153,11 +2700,11 @@ var Model = function(name, definition) { this.properties.push(new Property(key, property, required)); } } -} +}; Model.prototype.createJSONSample = function(modelsToIgnore) { var result = {}; - modelsToIgnore = (modelsToIgnore||{}) + modelsToIgnore = (modelsToIgnore||{}); modelsToIgnore[this.name] = this; var i; for (i = 0; i < this.properties.length; i++) { @@ -1176,7 +2723,7 @@ Model.prototype.getSampleValue = function(modelsToIgnore) { obj[property.name] = property.sampleValue(false, modelsToIgnore); } return obj; -} +}; Model.prototype.getMockSignature = function(modelsToIgnore) { var propertiesStr = []; @@ -1225,11 +2772,11 @@ var Property = function(name, obj, required) { this.optional = true; this.default = obj.default || null; this.example = obj.example || null; -} +}; Property.prototype.getSampleValue = function (modelsToIgnore) { return this.sampleValue(false, modelsToIgnore); -} +}; Property.prototype.isArray = function () { var schema = this.schema; @@ -1237,7 +2784,7 @@ Property.prototype.isArray = function () { return true; else return false; -} +}; Property.prototype.sampleValue = function(isArray, ignoredModels) { isArray = (isArray || this.isArray()); @@ -1280,7 +2827,7 @@ Property.prototype.sampleValue = function(isArray, ignoredModels) { return [output]; else return output; -} +}; getStringSignature = function(obj) { var str = ''; @@ -1313,16 +2860,16 @@ getStringSignature = function(obj) { if(obj.type === 'array') str += ']'; return str; -} +}; simpleRef = function(name) { if(typeof name === 'undefined') return null; if(name.indexOf("#/definitions/") === 0) - return name.substring('#/definitions/'.length) + return name.substring('#/definitions/'.length); else return name; -} +}; Property.prototype.toString = function() { var str = getStringSignature(this.obj); @@ -1338,7 +2885,7 @@ Property.prototype.toString = function() { if(typeof this.description !== 'undefined') str += ': ' + this.description; return str; -} +}; typeFromJsonSchema = function(type, format) { var str; @@ -1364,20 +2911,11 @@ typeFromJsonSchema = function(type, format) { str = 'string'; return str; -} - -var e = (typeof window !== 'undefined' ? window : exports); +}; var sampleModels = {}; var cookies = {}; var models = {}; - -e.authorizations = new SwaggerAuthorizations(); -e.ApiKeyAuthorization = ApiKeyAuthorization; -e.PasswordAuthorization = PasswordAuthorization; -e.CookieAuthorization = CookieAuthorization; -e.SwaggerClient = SwaggerClient; -e.Operation = Operation; /** * SwaggerHttp is a wrapper for executing requests */ @@ -1389,11 +2927,15 @@ SwaggerHttp.prototype.execute = function(obj) { else this.useJQuery = this.isIE8(); + if(obj && typeof obj.body === 'object') { + obj.body = JSON.stringify(obj.body); + } + if(this.useJQuery) return new JQueryHttpClient().execute(obj); else return new ShredHttpClient().execute(obj); -} +}; SwaggerHttp.prototype.isIE8 = function() { var detectedIE = false; @@ -1419,7 +2961,7 @@ var JQueryHttpClient = function(options) { if(!jQuery){ var jQuery = window.jQuery; } -} +}; JQueryHttpClient.prototype.execute = function(obj) { var cb = obj.on; @@ -1474,8 +3016,7 @@ JQueryHttpClient.prototype.execute = function(obj) { headers: headers }; - var contentType = (headers["content-type"]||headers["Content-Type"]||null) - + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { if(response.responseText && response.responseText !== "") { @@ -1488,7 +3029,7 @@ JQueryHttpClient.prototype.execute = function(obj) { } } else - out.obj = {} + out.obj = {}; } } @@ -1502,7 +3043,7 @@ JQueryHttpClient.prototype.execute = function(obj) { jQuery.support.cors = true; return jQuery.ajax(obj); -} +}; /* * ShredHttpClient is a light-weight, node or browser HTTP client @@ -1520,12 +3061,12 @@ var ShredHttpClient = function(options) { else this.Shred = require("shred"); this.shred = new this.Shred(options); -} +}; ShredHttpClient.prototype.initShred = function () { this.isInitialized = true; this.registerProcessors(this.shred); -} +}; ShredHttpClient.prototype.registerProcessors = function(shred) { var identity = function(x) { @@ -1546,7 +3087,7 @@ ShredHttpClient.prototype.registerProcessors = function(shred) { stringify: toString }); } -} +}; ShredHttpClient.prototype.execute = function(obj) { if(!this.isInitialized) @@ -1563,7 +3104,8 @@ ShredHttpClient.prototype.execute = function(obj) { data: response.content.data }; - var contentType = (response._headers["content-type"]||response._headers["Content-Type"]||null) + var headers = response._headers.normalized || response._headers; + var contentType = (headers["content-type"]||headers["Content-Type"]||null); if(contentType != null) { if(contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { @@ -1575,26 +3117,42 @@ ShredHttpClient.prototype.execute = function(obj) { // unable to parse } else - out.obj = {} + out.obj = {}; } } return out; }; - res = { - error: function(response) { + // Transform an error into a usable response-like object + var transformError = function (error) { + var out = { + // Default to a status of 0 - The client will treat this as a generic permissions sort of error + status: 0, + data: error.message || error + }; + + if (error.code) { + out.obj = error; + + if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { + // We can tell the client that this should be treated as a missing resource and not as a permissions thing + out.status = 404; + } + } + return out; + }; + + var res = { + error: function (response) { if (obj) return cb.error(transform(response)); }, - redirect: function(response) { + // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) + request_error: function (err) { if (obj) - return cb.redirect(transform(response)); + return cb.error(transformError(err)); }, - 307: function(response) { - if (obj) - return cb.redirect(transform(response)); - }, - response: function(response) { + response: function (response) { if (obj) return cb.response(transform(response)); } @@ -1603,4 +3161,31 @@ ShredHttpClient.prototype.execute = function(obj) { obj.on = res; } return this.shred.request(obj); -}; \ No newline at end of file +}; + +var e = (typeof window !== 'undefined' ? window : exports); + +e.authorizations = new SwaggerAuthorizations(); +e.ApiKeyAuthorization = ApiKeyAuthorization; +e.PasswordAuthorization = PasswordAuthorization; +e.CookieAuthorization = CookieAuthorization; +e.SwaggerClient = SwaggerClient; +e.Operation = Operation; + +// 1.x compat +// e.SampleModels = sampleModels; +// e.SwaggerHttp = SwaggerHttp; +// e.SwaggerRequest = SwaggerRequest; +// e.SwaggerAuthorizations = SwaggerAuthorizations; +// e.authorizations = new SwaggerAuthorizations(); +// e.ApiKeyAuthorization = ApiKeyAuthorization; +// e.PasswordAuthorization = PasswordAuthorization; +// e.CookieAuthorization = CookieAuthorization; +// e.JQueryHttpClient = JQueryHttpClient; +// e.ShredHttpClient = ShredHttpClient; +// e.SwaggerOperation = SwaggerOperation; +// e.SwaggerModel = SwaggerModel; +// e.SwaggerModelProperty = SwaggerModelProperty; +// e.SwaggerResource = SwaggerResource; +e.SwaggerApi = SwaggerApi; +})(); \ No newline at end of file diff --git a/lib/swagger.js b/lib/swagger.js deleted file mode 100644 index 37854cda..00000000 --- a/lib/swagger.js +++ /dev/null @@ -1,1695 +0,0 @@ -// swagger.js -// version 2.0.47 - -(function () { - - var __bind = function (fn, me) { - return function () { - return fn.apply(me, arguments); - }; - }; - - var log = function () { - log.history = log.history || []; - log.history.push(arguments); - if (this.console) { - console.log(Array.prototype.slice.call(arguments)[0]); - } - }; - - // if you want to apply conditional formatting of parameter values - var parameterMacro = function (value) { - return value; - } - - // if you want to apply conditional formatting of model property values - var modelPropertyMacro = function (value) { - return value; - } - - if (!Array.prototype.indexOf) { - Array.prototype.indexOf = function (obj, start) { - for (var i = (start || 0), j = this.length; i < j; i++) { - if (this[i] === obj) { return i; } - } - return -1; - } - } - - if (!('filter' in Array.prototype)) { - Array.prototype.filter = function (filter, that /*opt*/) { - var other = [], v; - for (var i = 0, n = this.length; i < n; i++) - if (i in this && filter.call(that, v = this[i], i, this)) - other.push(v); - return other; - }; - } - - if (!('map' in Array.prototype)) { - Array.prototype.map = function (mapper, that /*opt*/) { - var other = new Array(this.length); - for (var i = 0, n = this.length; i < n; i++) - if (i in this) - other[i] = mapper.call(that, this[i], i, this); - return other; - }; - } - - Object.keys = Object.keys || (function () { - var hasOwnProperty = Object.prototype.hasOwnProperty, - hasDontEnumBug = !{ toString: null }.propertyIsEnumerable("toString"), - DontEnums = [ - 'toString', - 'toLocaleString', - 'valueOf', - 'hasOwnProperty', - 'isPrototypeOf', - 'propertyIsEnumerable', - 'constructor' - ], - DontEnumsLength = DontEnums.length; - - return function (o) { - if (typeof o != "object" && typeof o != "function" || o === null) - throw new TypeError("Object.keys called on a non-object"); - - var result = []; - for (var name in o) { - if (hasOwnProperty.call(o, name)) - result.push(name); - } - - if (hasDontEnumBug) { - for (var i = 0; i < DontEnumsLength; i++) { - if (hasOwnProperty.call(o, DontEnums[i])) - result.push(DontEnums[i]); - } - } - - return result; - }; - })(); - - var SwaggerApi = function (url, options) { - this.isBuilt = false; - this.url = null; - this.debug = false; - this.basePath = null; - this.authorizations = null; - this.authorizationScheme = null; - this.info = null; - this.useJQuery = false; - this.modelsArray = []; - this.isValid; - - options = (options || {}); - if (url) - if (url.url) - options = url; - else - this.url = url; - else - options = url; - - if (options.url != null) - this.url = options.url; - - if (options.success != null) - this.success = options.success; - - if (typeof options.useJQuery === 'boolean') - this.useJQuery = options.useJQuery; - - this.failure = options.failure != null ? options.failure : function () { }; - this.progress = options.progress != null ? options.progress : function () { }; - if (options.success != null) { - this.build(); - this.isBuilt = true; - } - } - - SwaggerApi.prototype.build = function () { - if (this.isBuilt) - return this; - var _this = this; - this.progress('fetching resource list: ' + this.url); - var obj = { - useJQuery: this.useJQuery, - url: this.url, - method: "get", - headers: { - accept: "application/json,application/json;charset=utf-8,*/*" - }, - on: { - error: function (response) { - if (_this.url.substring(0, 4) !== 'http') { - return _this.fail('Please specify the protocol for ' + _this.url); - } else if (response.status === 0) { - return _this.fail('Can\'t read from server. It may not have the appropriate access-control-origin settings.'); - } else if (response.status === 404) { - return _this.fail('Can\'t read swagger JSON from ' + _this.url); - } else { - return _this.fail(response.status + ' : ' + response.statusText + ' ' + _this.url); - } - }, - response: function (resp) { - var responseObj = resp.obj || JSON.parse(resp.data); - _this.swaggerVersion = responseObj.swaggerVersion; - if (_this.swaggerVersion === "1.2") { - return _this.buildFromSpec(responseObj); - } else { - return _this.buildFrom1_1Spec(responseObj); - } - } - } - }; - var e = (typeof window !== 'undefined' ? window : exports); - e.authorizations.apply(obj); - new SwaggerHttp().execute(obj); - return this; - }; - - SwaggerApi.prototype.buildFromSpec = function (response) { - if (response.apiVersion != null) { - this.apiVersion = response.apiVersion; - } - this.apis = {}; - this.apisArray = []; - this.consumes = response.consumes; - this.produces = response.produces; - this.authSchemes = response.authorizations; - if (response.info != null) { - this.info = response.info; - } - var isApi = false; - var i; - for (i = 0; i < response.apis.length; i++) { - var api = response.apis[i]; - if (api.operations) { - var j; - for (j = 0; j < api.operations.length; j++) { - operation = api.operations[j]; - isApi = true; - } - } - } - if (response.basePath) - this.basePath = response.basePath; - else if (this.url.indexOf('?') > 0) - this.basePath = this.url.substring(0, this.url.lastIndexOf('?')); - else - this.basePath = this.url; - - if (isApi) { - var newName = response.resourcePath.replace(/\//g, ''); - this.resourcePath = response.resourcePath; - var res = new SwaggerResource(response, this); - this.apis[newName] = res; - this.apisArray.push(res); - } else { - var k; - for (k = 0; k < response.apis.length; k++) { - var resource = response.apis[k]; - var res = new SwaggerResource(resource, this); - this.apis[res.name] = res; - this.apisArray.push(res); - } - } - this.isValid = true; - if (this.success) { - this.success(); - } - return this; - }; - - SwaggerApi.prototype.buildFrom1_1Spec = function (response) { - log("This API is using a deprecated version of Swagger! Please see http://github.com/wordnik/swagger-core/wiki for more info"); - if (response.apiVersion != null) - this.apiVersion = response.apiVersion; - this.apis = {}; - this.apisArray = []; - this.produces = response.produces; - if (response.info != null) { - this.info = response.info; - } - var isApi = false; - for (var i = 0; i < response.apis.length; i++) { - var api = response.apis[i]; - if (api.operations) { - for (var j = 0; j < api.operations.length; j++) { - operation = api.operations[j]; - isApi = true; - } - } - } - if (response.basePath) { - this.basePath = response.basePath; - } else if (this.url.indexOf('?') > 0) { - this.basePath = this.url.substring(0, this.url.lastIndexOf('?')); - } else { - this.basePath = this.url; - } - if (isApi) { - var newName = response.resourcePath.replace(/\//g, ''); - this.resourcePath = response.resourcePath; - var res = new SwaggerResource(response, this); - this.apis[newName] = res; - this.apisArray.push(res); - } else { - for (k = 0; k < response.apis.length; k++) { - resource = response.apis[k]; - var res = new SwaggerResource(resource, this); - this.apis[res.name] = res; - this.apisArray.push(res); - } - } - this.isValid = true; - if (this.success) { - this.success(); - } - return this; - }; - - SwaggerApi.prototype.selfReflect = function () { - var resource, resource_name, _ref; - if (this.apis == null) { - return false; - } - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - if (resource.ready == null) { - return false; - } - } - this.setConsolidatedModels(); - this.ready = true; - if (this.success != null) { - return this.success(); - } - }; - - SwaggerApi.prototype.fail = function (message) { - this.failure(message); - throw message; - }; - - SwaggerApi.prototype.setConsolidatedModels = function () { - var model, modelName, resource, resource_name, _i, _len, _ref, _ref1, _results; - this.models = {}; - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - for (modelName in resource.models) { - if (this.models[modelName] == null) { - this.models[modelName] = resource.models[modelName]; - this.modelsArray.push(resource.models[modelName]); - } - } - } - _ref1 = this.modelsArray; - _results = []; - for (_i = 0, _len = _ref1.length; _i < _len; _i++) { - model = _ref1[_i]; - _results.push(model.setReferencedModels(this.models)); - } - return _results; - }; - - SwaggerApi.prototype.help = function () { - var operation, operation_name, parameter, resource, resource_name, _i, _len, _ref, _ref1, _ref2; - _ref = this.apis; - for (resource_name in _ref) { - resource = _ref[resource_name]; - log(resource_name); - _ref1 = resource.operations; - for (operation_name in _ref1) { - operation = _ref1[operation_name]; - log(" " + operation.nickname); - _ref2 = operation.parameters; - for (_i = 0, _len = _ref2.length; _i < _len; _i++) { - parameter = _ref2[_i]; - log(" " + parameter.name + (parameter.required ? ' (required)' : '') + " - " + parameter.description); - } - } - } - return this; - }; - - var SwaggerResource = function (resourceObj, api) { - var _this = this; - this.api = api; - this.api = this.api; - var consumes = (this.consumes | []); - var produces = (this.produces | []); - this.path = this.api.resourcePath != null ? this.api.resourcePath : resourceObj.path; - this.description = resourceObj.description; - - var parts = this.path.split("/"); - this.name = parts[parts.length - 1].replace('.{format}', ''); - this.basePath = this.api.basePath; - this.operations = {}; - this.operationsArray = []; - this.modelsArray = []; - this.models = {}; - this.rawModels = {}; - this.useJQuery = (typeof api.useJQuery !== 'undefined' ? api.useJQuery : null); - - if ((resourceObj.apis != null) && (this.api.resourcePath != null)) { - this.addApiDeclaration(resourceObj); - } else { - if (this.path == null) { - this.api.fail("SwaggerResources must have a path."); - } - if (this.path.substring(0, 4) === 'http') { - this.url = this.path.replace('{format}', 'json'); - } else { - this.url = this.api.basePath + this.path.replace('{format}', 'json'); - } - this.api.progress('fetching resource ' + this.name + ': ' + this.url); - var obj = { - url: this.url, - method: "get", - useJQuery: this.useJQuery, - headers: { - accept: "application/json,application/json;charset=utf-8,*/*" - }, - on: { - response: function (resp) { - var responseObj = resp.obj || JSON.parse(resp.data); - return _this.addApiDeclaration(responseObj); - }, - error: function (response) { - return _this.api.fail("Unable to read api '" + - _this.name + "' from path " + _this.url + " (server returned " + response.statusText + ")"); - } - } - }; - var e = typeof window !== 'undefined' ? window : exports; - e.authorizations.apply(obj); - new SwaggerHttp().execute(obj); - } - } - - SwaggerResource.prototype.getAbsoluteBasePath = function (relativeBasePath) { - var pos, url; - url = this.api.basePath; - pos = url.lastIndexOf(relativeBasePath); - var parts = url.split("/"); - var rootUrl = parts[0] + "//" + parts[2]; - - if (relativeBasePath.indexOf("http") === 0) - return relativeBasePath; - if (relativeBasePath === "/") - return rootUrl; - if (relativeBasePath.substring(0, 1) == "/") { - // use root + relative - return rootUrl + relativeBasePath; - } - else { - var pos = this.basePath.lastIndexOf("/"); - var base = this.basePath.substring(0, pos); - if (base.substring(base.length - 1) == "/") - return base + relativeBasePath; - else - return base + "/" + relativeBasePath; - } - }; - - SwaggerResource.prototype.addApiDeclaration = function (response) { - if (response.produces != null) - this.produces = response.produces; - if (response.consumes != null) - this.consumes = response.consumes; - if ((response.basePath != null) && response.basePath.replace(/\s/g, '').length > 0) - this.basePath = response.basePath.indexOf("http") === -1 ? this.getAbsoluteBasePath(response.basePath) : response.basePath; - - this.addModels(response.models); - if (response.apis) { - for (var i = 0 ; i < response.apis.length; i++) { - var endpoint = response.apis[i]; - this.addOperations(endpoint.path, endpoint.operations, response.consumes, response.produces); - } - } - this.api[this.name] = this; - this.ready = true; - return this.api.selfReflect(); - }; - - SwaggerResource.prototype.addModels = function (models) { - if (models != null) { - var modelName; - for (modelName in models) { - if (this.models[modelName] == null) { - var swaggerModel = new SwaggerModel(modelName, models[modelName]); - this.modelsArray.push(swaggerModel); - this.models[modelName] = swaggerModel; - this.rawModels[modelName] = models[modelName]; - } - } - var output = []; - for (var i = 0; i < this.modelsArray.length; i++) { - var model = this.modelsArray[i]; - output.push(model.setReferencedModels(this.models)); - } - return output; - } - }; - - SwaggerResource.prototype.addOperations = function (resource_path, ops, consumes, produces) { - if (ops) { - var output = []; - for (var i = 0; i < ops.length; i++) { - var o = ops[i]; - consumes = this.consumes; - produces = this.produces; - if (o.consumes != null) - consumes = o.consumes; - else - consumes = this.consumes; - - if (o.produces != null) - produces = o.produces; - else - produces = this.produces; - var type = (o.type || o.responseClass); - - if (type === "array") { - ref = null; - if (o.items) - ref = o.items["type"] || o.items["$ref"]; - type = "array[" + ref + "]"; - } - var responseMessages = o.responseMessages; - var method = o.method; - if (o.httpMethod) { - method = o.httpMethod; - } - if (o.supportedContentTypes) { - consumes = o.supportedContentTypes; - } - if (o.errorResponses) { - responseMessages = o.errorResponses; - for (var j = 0; j < responseMessages.length; j++) { - r = responseMessages[j]; - r.message = r.reason; - r.reason = null; - } - } - o.nickname = this.sanitize(o.nickname); - var op = new SwaggerOperation(o.nickname, resource_path, method, o.parameters, o.summary, o.notes, type, responseMessages, this, consumes, produces, o.authorizations, o.deprecated); - this.operations[op.nickname] = op; - output.push(this.operationsArray.push(op)); - } - return output; - } - }; - - SwaggerResource.prototype.sanitize = function (nickname) { - var op; - op = nickname.replace(/[\s!@#$%^&*()_+=\[{\]};:<>|.\/?,\\'""-]/g, '_'); - op = op.replace(/((_){2,})/g, '_'); - op = op.replace(/^(_)*/g, ''); - op = op.replace(/([_])*$/g, ''); - return op; - }; - - SwaggerResource.prototype.help = function () { - var op = this.operations; - var output = []; - var operation_name; - for (operation_name in op) { - operation = op[operation_name]; - var msg = " " + operation.nickname; - for (var i = 0; i < operation.parameters; i++) { - parameter = operation.parameters[i]; - msg.concat(" " + parameter.name + (parameter.required ? ' (required)' : '') + " - " + parameter.description); - } - output.push(msg); - } - return output; - }; - - var SwaggerModel = function (modelName, obj) { - this.name = obj.id != null ? obj.id : modelName; - this.properties = []; - var propertyName; - for (propertyName in obj.properties) { - if (obj.required != null) { - var value; - for (value in obj.required) { - if (propertyName === obj.required[value]) { - obj.properties[propertyName].required = true; - } - } - } - var prop = new SwaggerModelProperty(propertyName, obj.properties[propertyName]); - this.properties.push(prop); - } - } - - SwaggerModel.prototype.setReferencedModels = function (allModels) { - var results = []; - for (var i = 0; i < this.properties.length; i++) { - var property = this.properties[i]; - var type = property.type || property.dataType; - if (allModels[type] != null) - results.push(property.refModel = allModels[type]); - else if ((property.refDataType != null) && (allModels[property.refDataType] != null)) - results.push(property.refModel = allModels[property.refDataType]); - else - results.push(void 0); - } - return results; - }; - - SwaggerModel.prototype.getMockSignature = function (modelsToIgnore) { - var propertiesStr = []; - for (var i = 0; i < this.properties.length; i++) { - var prop = this.properties[i]; - propertiesStr.push(prop.toString()); - } - - var strong = ''; - var stronger = ''; - var strongClose = ''; - var classOpen = strong + this.name + ' {' + strongClose; - var classClose = strong + '}' + strongClose; - var returnVal = classOpen + '
' + propertiesStr.join(',
') + '
' + classClose;
- if (!modelsToIgnore)
- modelsToIgnore = [];
- modelsToIgnore.push(this.name);
-
- for (var i = 0; i < this.properties.length; i++) {
- var prop = this.properties[i];
- if ((prop.refModel != null) && modelsToIgnore.indexOf(prop.refModel.name) === -1) {
- returnVal = returnVal + ('' + prop.refModel.getMockSignature(modelsToIgnore)); - } - } - return returnVal; - }; - - SwaggerModel.prototype.createJSONSample = function (modelsToIgnore) { - if (sampleModels[this.name]) { - return sampleModels[this.name]; - } - else { - var result = {}; - var modelsToIgnore = (modelsToIgnore || []) - modelsToIgnore.push(this.name); - for (var i = 0; i < this.properties.length; i++) { - var prop = this.properties[i]; - result[prop.name] = prop.getSampleValue(modelsToIgnore); - } - modelsToIgnore.pop(this.name); - return result; - } - }; - - var SwaggerModelProperty = function (name, obj) { - this.name = name; - this.dataType = obj.type || obj.dataType || obj["$ref"]; - this.isCollection = this.dataType && (this.dataType.toLowerCase() === 'array' || this.dataType.toLowerCase() === 'list' || this.dataType.toLowerCase() === 'set'); - this.descr = obj.description; - this.required = obj.required; - this.defaultValue = modelPropertyMacro(obj.defaultValue); - if (obj.items != null) { - if (obj.items.type != null) { - this.refDataType = obj.items.type; - } - if (obj.items.$ref != null) { - this.refDataType = obj.items.$ref; - } - } - this.dataTypeWithRef = this.refDataType != null ? (this.dataType + '[' + this.refDataType + ']') : this.dataType; - if (obj.allowableValues != null) { - this.valueType = obj.allowableValues.valueType; - this.values = obj.allowableValues.values; - if (this.values != null) { - this.valuesString = "'" + this.values.join("' or '") + "'"; - } - } - if (obj["enum"] != null) { - this.valueType = "string"; - this.values = obj["enum"]; - if (this.values != null) { - this.valueString = "'" + this.values.join("' or '") + "'"; - } - } - } - - SwaggerModelProperty.prototype.getSampleValue = function (modelsToIgnore) { - var result; - if ((this.refModel != null) && (modelsToIgnore.indexOf(this.refModel.name) === -1)) { - result = this.refModel.createJSONSample(modelsToIgnore); - } else { - if (this.isCollection) { - result = this.toSampleValue(this.refDataType); - } else { - result = this.toSampleValue(this.dataType); - } - } - if (this.isCollection) { - return [result]; - } else { - return result; - } - }; - - SwaggerModelProperty.prototype.toSampleValue = function (value) { - var result; - if ((typeof this.defaultValue !== 'undefined') && this.defaultValue !== null) { - result = this.defaultValue; - } else if (value === "integer") { - result = 0; - } else if (value === "boolean") { - result = false; - } else if (value === "double" || value === "number") { - result = 0.0; - } else if (value === "string") { - result = ""; - } else { - result = value; - } - return result; - }; - - SwaggerModelProperty.prototype.toString = function () { - var req = this.required ? 'propReq' : 'propOpt'; - var str = '' + this.name + ' (' + this.dataTypeWithRef + ''; - if (!this.required) { - str += ', optional'; - } - str += ')'; - if (this.values != null) { - str += " = ['" + this.values.join("' or '") + "']"; - } - if (this.descr != null) { - str += ': ' + this.descr + ''; - } - return str; - }; - - var SwaggerOperation = function (nickname, path, method, parameters, summary, notes, type, responseMessages, resource, consumes, produces, authorizations, deprecated) { - var _this = this; - - var errors = []; - this.nickname = (nickname || errors.push("SwaggerOperations must have a nickname.")); - this.path = (path || errors.push("SwaggerOperation " + nickname + " is missing path.")); - this.method = (method || errors.push("SwaggerOperation " + nickname + " is missing method.")); - this.parameters = parameters != null ? parameters : []; - this.summary = summary; - this.notes = notes; - this.type = type; - this.responseMessages = (responseMessages || []); - this.resource = (resource || errors.push("Resource is required")); - this.consumes = consumes; - this.produces = produces; - this.authorizations = authorizations; - this.deprecated = deprecated; - this["do"] = __bind(this["do"], this); - - if (errors.length > 0) { - console.error('SwaggerOperation errors', errors, arguments); - this.resource.api.fail(errors); - } - - this.path = this.path.replace('{format}', 'json'); - this.method = this.method.toLowerCase(); - this.isGetMethod = this.method === "get"; - - this.resourceName = this.resource.name; - if (typeof this.type !== 'undefined' && this.type === 'void') - this.type = null; - else { - this.responseClassSignature = this.getSignature(this.type, this.resource.models); - this.responseSampleJSON = this.getSampleJSON(this.type, this.resource.models); - } - - for (var i = 0; i < this.parameters.length; i++) { - var param = this.parameters[i]; - // might take this away - param.name = param.name || param.type || param.dataType; - - // for 1.1 compatibility - var type = param.type || param.dataType; - if (type === 'array') { - type = 'array[' + (param.items.$ref ? param.items.$ref : param.items.type) + ']'; - } - param.type = type; - - if (type && type.toLowerCase() === 'boolean') { - param.allowableValues = {}; - param.allowableValues.values = ["true", "false"]; - } - param.signature = this.getSignature(type, this.resource.models); - param.sampleJSON = this.getSampleJSON(type, this.resource.models); - - var enumValue = param["enum"]; - if (enumValue != null) { - param.isList = true; - param.allowableValues = {}; - param.allowableValues.descriptiveValues = []; - - for (var j = 0; j < enumValue.length; j++) { - var v = enumValue[j]; - if (param.defaultValue != null) { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: (v === param.defaultValue) - }); - } - else { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: false - }); - } - } - } - else if (param.allowableValues != null) { - if (param.allowableValues.valueType === "RANGE") - param.isRange = true; - else - param.isList = true; - if (param.allowableValues != null) { - param.allowableValues.descriptiveValues = []; - if (param.allowableValues.values) { - for (var j = 0; j < param.allowableValues.values.length; j++) { - var v = param.allowableValues.values[j]; - if (param.defaultValue != null) { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: (v === param.defaultValue) - }); - } - else { - param.allowableValues.descriptiveValues.push({ - value: String(v), - isDefault: false - }); - } - } - } - } - } - param.defaultValue = parameterMacro(param.defaultValue); - } - this.resource[this.nickname] = function (args, callback, error) { - return _this["do"](args, callback, error); - }; - this.resource[this.nickname].help = function () { - return _this.help(); - }; - } - - SwaggerOperation.prototype.isListType = function (type) { - if (type && type.indexOf('[') >= 0) { - return type.substring(type.indexOf('[') + 1, type.indexOf(']')); - } else { - return void 0; - } - }; - - SwaggerOperation.prototype.getSignature = function (type, models) { - var isPrimitive, listType; - listType = this.isListType(type); - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; - if (isPrimitive) { - return type; - } else { - if (listType != null) { - return models[listType].getMockSignature(); - } else { - return models[type].getMockSignature(); - } - } - }; - - SwaggerOperation.prototype.getSampleJSON = function (type, models) { - var isPrimitive, listType, val; - listType = this.isListType(type); - isPrimitive = ((listType != null) && models[listType]) || (models[type] != null) ? false : true; - val = isPrimitive ? void 0 : (listType != null ? models[listType].createJSONSample() : models[type].createJSONSample()); - if (val) { - val = listType ? [val] : val; - if (typeof val == "string") - return val; - else if (typeof val === "object") { - var t = val; - if (val instanceof Array && val.length > 0) { - t = val[0]; - } - if (t.nodeName) { - var xmlString = new XMLSerializer().serializeToString(t); - return this.formatXml(xmlString); - } - else - return JSON.stringify(val, null, 2); - } - else - return val; - } - }; - - SwaggerOperation.prototype["do"] = function (args, opts, callback, error) { - var key, param, params, possibleParams, req, requestContentType, responseContentType, value, _i, _len, _ref; - if (args == null) { - args = {}; - } - if (opts == null) { - opts = {}; - } - requestContentType = null; - responseContentType = null; - if ((typeof args) === "function") { - error = opts; - callback = args; - args = {}; - } - if ((typeof opts) === "function") { - error = callback; - callback = opts; - } - if (error == null) { - error = function (xhr, textStatus, error) { - return log(xhr, textStatus, error); - }; - } - if (callback == null) { - callback = function (response) { - var content; - content = null; - if (response != null) { - content = response.data; - } else { - content = "no data"; - } - return log("default callback: " + content); - }; - } - params = {}; - params.headers = []; - if (args.headers != null) { - params.headers = args.headers; - delete args.headers; - } - - var possibleParams = []; - for (var i = 0; i < this.parameters.length; i++) { - var param = this.parameters[i]; - if (param.paramType === 'header') { - if (args[param.name]) - params.headers[param.name] = args[param.name]; - } - else if (param.paramType === 'form' || param.paramType.toLowerCase() === 'file') - possibleParams.push(param); - else if (param.paramType === 'body' && param.name !== 'body') { - if (args.body) { - throw new Error("Saw two body params in an API listing; expecting a max of one."); - } - args.body = args[param.name]; - } - } - - if (args.body != null) { - params.body = args.body; - delete args.body; - } - - if (possibleParams) { - var key; - for (key in possibleParams) { - var value = possibleParams[key]; - if (args[value.name]) { - params[value.name] = args[value.name]; - } - } - } - - req = new SwaggerRequest(this.method, this.urlify(args), params, opts, callback, error, this); - if (opts.mock != null) { - return req; - } else { - return true; - } - }; - - SwaggerOperation.prototype.pathJson = function () { - return this.path.replace("{format}", "json"); - }; - - SwaggerOperation.prototype.pathXml = function () { - return this.path.replace("{format}", "xml"); - }; - - SwaggerOperation.prototype.encodePathParam = function (pathParam) { - var encParts, part, parts, _i, _len; - pathParam = pathParam.toString(); - if (pathParam.indexOf("/") === -1) { - return encodeURIComponent(pathParam); - } else { - parts = pathParam.split("/"); - encParts = []; - for (_i = 0, _len = parts.length; _i < _len; _i++) { - part = parts[_i]; - encParts.push(encodeURIComponent(part)); - } - return encParts.join("/"); - } - }; - - SwaggerOperation.prototype.urlify = function (args) { - var url = this.resource.basePath + this.pathJson(); - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if (param.paramType === 'path') { - if (args[param.name]) { - // apply path params and remove from args - var reg = new RegExp('\\{\\s*?' + param.name + '.*?\\}(?=\\s*?(\\/?|$))', 'gi'); - url = url.replace(reg, this.encodePathParam(args[param.name])); - delete args[param.name]; - } - else - throw "" + param.name + " is a required path param."; - } - } - - var queryParams = ""; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if(param.paramType === 'query') { - if (queryParams !== '') - queryParams += '&'; - if (Array.isArray(param)) { - var j; - var output = ''; - for(j = 0; j < param.length; j++) { - if(j > 0) - output += ','; - output += encodeURIComponent(param[j]); - } - queryParams += encodeURIComponent(param.name) + '=' + output; - } - else { - if (args[param.name]) { - queryParams += encodeURIComponent(param.name) + '=' + encodeURIComponent(args[param.name]); - } else { - if (param.required) - throw "" + param.name + " is a required query param."; - } - } - } - } - if ((queryParams != null) && queryParams.length > 0) - url += '?' + queryParams; - return url; - }; - - SwaggerOperation.prototype.supportHeaderParams = function () { - return this.resource.api.supportHeaderParams; - }; - - SwaggerOperation.prototype.supportedSubmitMethods = function () { - return this.resource.api.supportedSubmitMethods; - }; - - SwaggerOperation.prototype.getQueryParams = function (args) { - return this.getMatchingParams(['query'], args); - }; - - SwaggerOperation.prototype.getHeaderParams = function (args) { - return this.getMatchingParams(['header'], args); - }; - - SwaggerOperation.prototype.getMatchingParams = function (paramTypes, args) { - var matchingParams = {}; - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - param = params[i]; - if (args && args[param.name]) - matchingParams[param.name] = args[param.name]; - } - var headers = this.resource.api.headers; - var name; - for (name in headers) { - var value = headers[name]; - matchingParams[name] = value; - } - return matchingParams; - }; - - SwaggerOperation.prototype.help = function () { - var msg = ""; - var params = this.parameters; - for (var i = 0; i < params.length; i++) { - var param = params[i]; - if (msg !== "") - msg += "\n"; - msg += "* " + param.name + (param.required ? ' (required)' : '') + " - " + param.description; - } - return msg; - }; - - - SwaggerOperation.prototype.formatXml = function (xml) { - var contexp, formatted, indent, lastType, lines, ln, pad, reg, transitions, wsexp, _fn, _i, _len; - reg = /(>)(<)(\/*)/g; - wsexp = /[ ]*(.*)[ ]+\n/g; - contexp = /(<.+>)(.+\n)/g; - xml = xml.replace(reg, '$1\n$2$3').replace(wsexp, '$1\n').replace(contexp, '$1\n$2'); - pad = 0; - formatted = ''; - lines = xml.split('\n'); - indent = 0; - lastType = 'other'; - transitions = { - 'single->single': 0, - 'single->closing': -1, - 'single->opening': 0, - 'single->other': 0, - 'closing->single': 0, - 'closing->closing': -1, - 'closing->opening': 0, - 'closing->other': 0, - 'opening->single': 1, - 'opening->closing': 0, - 'opening->opening': 1, - 'opening->other': 1, - 'other->single': 0, - 'other->closing': -1, - 'other->opening': 0, - 'other->other': 0 - }; - _fn = function (ln) { - var fromTo, j, key, padding, type, types, value; - types = { - single: Boolean(ln.match(/<.+\/>/)), - closing: Boolean(ln.match(/<\/.+>/)), - opening: Boolean(ln.match(/<[^!?].*>/)) - }; - type = ((function () { - var _results; - _results = []; - for (key in types) { - value = types[key]; - if (value) { - _results.push(key); - } - } - return _results; - })())[0]; - type = type === void 0 ? 'other' : type; - fromTo = lastType + '->' + type; - lastType = type; - padding = ''; - indent += transitions[fromTo]; - padding = ((function () { - var _j, _ref5, _results; - _results = []; - for (j = _j = 0, _ref5 = indent; 0 <= _ref5 ? _j < _ref5 : _j > _ref5; j = 0 <= _ref5 ? ++_j : --_j) { - _results.push(' '); - } - return _results; - })()).join(''); - if (fromTo === 'opening->closing') { - return formatted = formatted.substr(0, formatted.length - 1) + ln + '\n'; - } else { - return formatted += padding + ln + '\n'; - } - }; - for (_i = 0, _len = lines.length; _i < _len; _i++) { - ln = lines[_i]; - _fn(ln); - } - return formatted; - }; - - var SwaggerRequest = function (type, url, params, opts, successCallback, errorCallback, operation, execution) { - var _this = this; - var errors = []; - this.useJQuery = (typeof operation.resource.useJQuery !== 'undefined' ? operation.resource.useJQuery : null); - this.type = (type || errors.push("SwaggerRequest type is required (get/post/put/delete/patch/options).")); - this.url = (url || errors.push("SwaggerRequest url is required.")); - this.params = params; - this.opts = opts; - this.successCallback = (successCallback || errors.push("SwaggerRequest successCallback is required.")); - this.errorCallback = (errorCallback || errors.push("SwaggerRequest error callback is required.")); - this.operation = (operation || errors.push("SwaggerRequest operation is required.")); - this.execution = execution; - this.headers = (params.headers || {}); - - if (errors.length > 0) { - throw errors; - } - - this.type = this.type.toUpperCase(); - - // set request, response content type headers - var headers = this.setHeaders(params, this.operation); - var body = params.body; - - // encode the body for form submits - if (headers["Content-Type"]) { - var values = {}; - var i; - var operationParams = this.operation.parameters; - for (i = 0; i < operationParams.length; i++) { - var param = operationParams[i]; - if (param.paramType === "form") - values[param.name] = param; - } - - if (headers["Content-Type"].indexOf("application/x-www-form-urlencoded") === 0) { - var encoded = ""; - var key, value; - for (key in values) { - value = this.params[key]; - if (typeof value !== 'undefined') { - if (encoded !== "") - encoded += "&"; - encoded += encodeURIComponent(key) + '=' + encodeURIComponent(value); - } - } - body = encoded; - } - else if (headers["Content-Type"].indexOf("multipart/form-data") === 0) { - // encode the body for form submits - var data = ""; - var boundary = "----SwaggerFormBoundary" + Date.now(); - var key, value; - for (key in values) { - value = this.params[key]; - if (typeof value !== 'undefined') { - data += '--' + boundary + '\n'; - data += 'Content-Disposition: form-data; name="' + key + '"'; - data += '\n\n'; - data += value + "\n"; - } - } - data += "--" + boundary + "--\n"; - headers["Content-Type"] = "multipart/form-data; boundary=" + boundary; - body = data; - } - } - - var obj; - if (!((this.headers != null) && (this.headers.mock != null))) { - obj = { - url: this.url, - method: this.type, - headers: headers, - body: body, - useJQuery: this.useJQuery, - on: { - error: function (response) { - return _this.errorCallback(response, _this.opts.parent); - }, - redirect: function (response) { - return _this.successCallback(response, _this.opts.parent); - }, - 307: function (response) { - return _this.successCallback(response, _this.opts.parent); - }, - response: function (response) { - return _this.successCallback(response, _this.opts.parent); - } - } - }; - var e; - if (typeof window !== 'undefined') { - e = window; - } else { - e = exports; - } - var status = e.authorizations.apply(obj, this.operation.authorizations); - if (opts.mock == null) { - if (status !== false) { - new SwaggerHttp().execute(obj); - } else { - obj.canceled = true; - } - } else { - return obj; - } - } - return obj; - }; - - SwaggerRequest.prototype.setHeaders = function (params, operation) { - // default type - var accepts = "application/json"; - var consumes = "application/json"; - - var allDefinedParams = this.operation.parameters; - var definedFormParams = []; - var definedFileParams = []; - var body = params.body; - var headers = {}; - - // get params from the operation and set them in definedFileParams, definedFormParams, headers - var i; - for (i = 0; i < allDefinedParams.length; i++) { - var param = allDefinedParams[i]; - if (param.paramType === "form") - definedFormParams.push(param); - else if (param.paramType === "file") - definedFileParams.push(param); - else if (param.paramType === "header" && this.params.headers) { - var key = param.name; - var headerValue = this.params.headers[param.name]; - if (typeof this.params.headers[param.name] !== 'undefined') - headers[key] = headerValue; - } - } - - // if there's a body, need to set the accepts header via requestContentType - if (body && (this.type === "POST" || this.type === "PUT" || this.type === "PATCH" || this.type === "DELETE")) { - if (this.opts.requestContentType) - consumes = this.opts.requestContentType; - } else { - // if any form params, content type must be set - if (definedFormParams.length > 0) { - if (definedFileParams.length > 0) - consumes = "multipart/form-data"; - else - consumes = "application/x-www-form-urlencoded"; - } - else if (this.type === "DELETE") - body = "{}"; - else if (this.type != "DELETE") - consumes = null; - } - - if (consumes && this.operation.consumes) { - if (this.operation.consumes.indexOf(consumes) === -1) { - log("server doesn't consume " + consumes + ", try " + JSON.stringify(this.operation.consumes)); - consumes = this.operation.consumes[0]; - } - } - - if (this.opts.responseContentType) { - accepts = this.opts.responseContentType; - } else { - accepts = "application/json"; - } - if (accepts && this.operation.produces) { - if (this.operation.produces.indexOf(accepts) === -1) { - log("server can't produce " + accepts); - accepts = this.operation.produces[0]; - } - } - - if ((consumes && body !== "") || (consumes === "application/x-www-form-urlencoded")) - headers["Content-Type"] = consumes; - if (accepts) - headers["Accept"] = accepts; - return headers; - } - - SwaggerRequest.prototype.asCurl = function () { - var results = []; - if (this.headers) { - var key; - for (key in this.headers) { - results.push("--header \"" + key + ": " + this.headers[v] + "\""); - } - } - return "curl " + (results.join(" ")) + " " + this.url; - }; - - /** - * SwaggerHttp is a wrapper for executing requests - */ - var SwaggerHttp = function () { }; - - SwaggerHttp.prototype.execute = function (obj) { - if (obj && (typeof obj.useJQuery === 'boolean')) - this.useJQuery = obj.useJQuery; - else - this.useJQuery = this.isIE8(); - - if (this.useJQuery) - return new JQueryHttpClient().execute(obj); - else - return new ShredHttpClient().execute(obj); - } - - SwaggerHttp.prototype.isIE8 = function () { - var detectedIE = false; - if (typeof navigator !== 'undefined' && navigator.userAgent) { - nav = navigator.userAgent.toLowerCase(); - if (nav.indexOf('msie') !== -1) { - var version = parseInt(nav.split('msie')[1]); - if (version <= 8) { - detectedIE = true; - } - } - } - return detectedIE; - }; - - /* - * JQueryHttpClient lets a browser take advantage of JQuery's cross-browser magic. - * NOTE: when jQuery is available it will export both '$' and 'jQuery' to the global space. - * Since we are using closures here we need to alias it for internal use. - */ - var JQueryHttpClient = function (options) { - "use strict"; - if (!jQuery) { - var jQuery = window.jQuery; - } - } - - JQueryHttpClient.prototype.execute = function (obj) { - var cb = obj.on; - var request = obj; - - obj.type = obj.method; - obj.cache = false; - - obj.beforeSend = function (xhr) { - var key, results; - if (obj.headers) { - results = []; - var key; - for (key in obj.headers) { - if (key.toLowerCase() === "content-type") { - results.push(obj.contentType = obj.headers[key]); - } else if (key.toLowerCase() === "accept") { - results.push(obj.accepts = obj.headers[key]); - } else { - results.push(xhr.setRequestHeader(key, obj.headers[key])); - } - } - return results; - } - }; - - obj.data = obj.body; - obj.complete = function (response, textStatus, opts) { - var headers = {}, - headerArray = response.getAllResponseHeaders().split("\n"); - - for (var i = 0; i < headerArray.length; i++) { - var toSplit = headerArray[i].trim(); - if (toSplit.length === 0) - continue; - var separator = toSplit.indexOf(":"); - if (separator === -1) { - // Name but no value in the header - headers[toSplit] = null; - continue; - } - var name = toSplit.substring(0, separator).trim(), - value = toSplit.substring(separator + 1).trim(); - headers[name] = value; - } - - var out = { - url: request.url, - method: request.method, - status: response.status, - data: response.responseText, - headers: headers - }; - - var contentType = (headers["content-type"] || headers["Content-Type"] || null) - - if (contentType != null) { - if (contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { - if (response.responseText && response.responseText !== "") - out.obj = JSON.parse(response.responseText); - else - out.obj = {} - } - } - - if (response.status >= 200 && response.status < 300) - cb.response(out); - else if (response.status === 0 || (response.status >= 400 && response.status < 599)) - cb.error(out); - else - return cb.response(out); - }; - - jQuery.support.cors = true; - return jQuery.ajax(obj); - } - - /* - * ShredHttpClient is a light-weight, node or browser HTTP client - */ - var ShredHttpClient = function (options) { - this.options = (options || {}); - this.isInitialized = false; - - var identity, toString; - - if (typeof window !== 'undefined') { - this.Shred = require("./shred"); - this.content = require("./shred/content"); - } - else - this.Shred = require("shred"); - this.shred = new this.Shred(); - } - - ShredHttpClient.prototype.initShred = function () { - this.isInitialized = true; - this.registerProcessors(this.shred); - } - - ShredHttpClient.prototype.registerProcessors = function (shred) { - var identity = function (x) { - return x; - }; - var toString = function (x) { - return x.toString(); - }; - - if (typeof window !== 'undefined') { - this.content.registerProcessor(["application/json; charset=utf-8", "application/json", "json"], { - parser: identity, - stringify: toString - }); - } else { - this.Shred.registerProcessor(["application/json; charset=utf-8", "application/json", "json"], { - parser: identity, - stringify: toString - }); - } - } - - ShredHttpClient.prototype.execute = function (obj) { - if (!this.isInitialized) - this.initShred(); - - var cb = obj.on, res; - - var transform = function (response) { - var out = { - headers: response._headers, - url: response.request.url, - method: response.request.method, - status: response.status, - data: response.content.data - }; - - var headers = response._headers.normalized || response._headers; - var contentType = (headers["content-type"] || headers["Content-Type"] || null) - if (contentType != null) { - if (contentType.indexOf("application/json") == 0 || contentType.indexOf("+json") > 0) { - if (response.content.data && response.content.data !== "") - try { - out.obj = JSON.parse(response.content.data); - } - catch (ex) { - // do not set out.obj - log ("unable to parse JSON content"); - } - else - out.obj = {} - } - } - return out; - }; - - // Transform an error into a usable response-like object - var transformError = function (error) { - var out = { - // Default to a status of 0 - The client will treat this as a generic permissions sort of error - status: 0, - data: error.message || error - }; - - if (error.code) { - out.obj = error; - - if (error.code === 'ENOTFOUND' || error.code === 'ECONNREFUSED') { - // We can tell the client that this should be treated as a missing resource and not as a permissions thing - out.status = 404; - } - } - - return out; - }; - - var res = { - error: function (response) { - if (obj) - return cb.error(transform(response)); - }, - // Catch the Shred error raised when the request errors as it is made (i.e. No Response is coming) - request_error: function (err) { - if (obj) - return cb.error(transformError(err)); - }, - redirect: function (response) { - if (obj) - return cb.redirect(transform(response)); - }, - 307: function (response) { - if (obj) - return cb.redirect(transform(response)); - }, - response: function (response) { - if (obj) - return cb.response(transform(response)); - } - }; - if (obj) { - obj.on = res; - } - return this.shred.request(obj); - }; - - /** - * SwaggerAuthorizations applys the correct authorization to an operation being executed - */ - var SwaggerAuthorizations = function () { - this.authz = {}; - }; - - SwaggerAuthorizations.prototype.add = function (name, auth) { - this.authz[name] = auth; - return auth; - }; - - SwaggerAuthorizations.prototype.remove = function (name) { - return delete this.authz[name]; - }; - - SwaggerAuthorizations.prototype.apply = function (obj, authorizations) { - var status = null; - var key, value, result; - - // if the "authorizations" key is undefined, or has an empty array, add all keys - if (typeof authorizations === 'undefined' || Object.keys(authorizations).length == 0) { - for (key in this.authz) { - value = this.authz[key]; - result = value.apply(obj, authorizations); - if (result === true) - status = true; - } - } - else { - for (name in authorizations) { - for (key in this.authz) { - if (key == name) { - value = this.authz[key]; - result = value.apply(obj, authorizations); - if (result === true) - status = true; - } - } - } - } - - return status; - }; - - /** - * ApiKeyAuthorization allows a query param or header to be injected - */ - var ApiKeyAuthorization = function (name, value, type, delimiter) { - this.name = name; - this.value = value; - this.type = type; - this.delimiter = delimiter; - }; - - ApiKeyAuthorization.prototype.apply = function (obj, authorizations) { - if (this.type === "query") { - if (obj.url.indexOf('?') > 0) - obj.url = obj.url + "&" + this.name + "=" + this.value; - else - obj.url = obj.url + "?" + this.name + "=" + this.value; - return true; - } else if (this.type === "header") { - if (typeof obj.headers[this.name] !== 'undefined') { - if (typeof this.delimiter !== 'undefined') - obj.headers[this.name] = obj.headers[this.name] + this.delimiter + this.value; - } - else - obj.headers[this.name] = this.value; - return true; - } - }; - - var CookieAuthorization = function (cookie) { - this.cookie = cookie; - } - - CookieAuthorization.prototype.apply = function (obj, authorizations) { - obj.cookieJar = obj.cookieJar || CookieJar(); - obj.cookieJar.setCookie(this.cookie); - return true; - } - - /** - * Password Authorization is a basic auth implementation - */ - var PasswordAuthorization = function (name, username, password) { - this.name = name; - this.username = username; - this.password = password; - this._btoa = null; - if (typeof window !== 'undefined') - this._btoa = btoa; - else - this._btoa = require("btoa"); - }; - - PasswordAuthorization.prototype.apply = function (obj, authorizations) { - var base64encoder = this._btoa; - obj.headers["Authorization"] = "Basic " + base64encoder(this.username + ":" + this.password); - return true; - }; - - var e = (typeof window !== 'undefined' ? window : exports); - - var sampleModels = {}; - var cookies = {}; - - e.parameterMacro = parameterMacro; - e.modelPropertyMacro = modelPropertyMacro; - e.SampleModels = sampleModels; - e.SwaggerHttp = SwaggerHttp; - e.SwaggerRequest = SwaggerRequest; - e.authorizations = new SwaggerAuthorizations(); - e.ApiKeyAuthorization = ApiKeyAuthorization; - e.PasswordAuthorization = PasswordAuthorization; - e.CookieAuthorization = CookieAuthorization; - e.JQueryHttpClient = JQueryHttpClient; - e.ShredHttpClient = ShredHttpClient; - e.SwaggerOperation = SwaggerOperation; - e.SwaggerModel = SwaggerModel; - e.SwaggerModelProperty = SwaggerModelProperty; - e.SwaggerResource = SwaggerResource; - e.SwaggerApi = SwaggerApi; - e.log = log; - -})(); diff --git a/package.json b/package.json index 48dac1de..56529725 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "readmeFilename": "README.md", "dependencies": { "coffee-script": "~1.6.3", - "swagger-client": "2.0.48", + "swagger-client": "2.1.0-alpha.5", "handlebars": "~1.0.10", "less": "~1.4.2" },