swagger-client 2.1.21 → 2.1.25

package/lib/http.js

@@ -38,6 +38,10 @@ SwaggerHttp.prototype.execute = function (obj, opts) {
   }
   client.opts = opts || {};
 
+  if (opts && opts.requestAgent) {
+    request = opts.requestAgent;
+  }
+
   // legacy support
   var hasJQuery = false;
   if(typeof window !== 'undefined') {
@@ -207,6 +211,7 @@ JQueryHttpClient.prototype.execute = function (obj) {
 };
 
 SuperagentHttpClient.prototype.execute = function (obj) {
+  var connectionAgent = obj.connectionAgent;
   var method = obj.method.toLowerCase();
   var timeout = obj.timeout;
 
@@ -214,6 +219,11 @@ SuperagentHttpClient.prototype.execute = function (obj) {
     method = 'del';
   }
   var headers = obj.headers || {};
+
+  if (connectionAgent) {
+      request = request.agent(connectionAgent);
+  }
+
   var r = request[method](obj.url);
 
   if (timeout) {
@@ -240,33 +250,7 @@ SuperagentHttpClient.prototype.execute = function (obj) {
       if (contentType.indexOf('multipart/form-data') === 0) {
         delete headers['Content-Type'];
         if({}.toString.apply(obj.body) === '[object FormData]') {
-          var itr = obj.body.keys();
-          var p = [];
-          while(true) {
-            var v = itr.next();
-            if(v.done) {
-              break;
-            }
-            var key = v.value;
-            // only once
-            if(p.indexOf(key) === -1) {
-              p.push(key);
-              var value = obj.body.getAll(key);
-              if({}.toString.apply(value) === '[object File]') {
-                r.attach(key, value);
-              }
-              else {
-                if (Array.isArray(value)) {
-                  for (var t in value) {
-                    r.field(key, value[t]);
-                  }
-                }
-                else {
-                  r.field(key, value);
-                }
-              }
-            }
-          }
+          r.send(obj.body);
         }
         else {
           var keyname, value, v;
@@ -284,6 +268,7 @@ SuperagentHttpClient.prototype.execute = function (obj) {
         }
       }
       else if (_.isObject(obj.body)) {
+        // non multipart/form-data
         obj.body = JSON.stringify(obj.body);
         r.send(obj.body);
       }
@@ -378,5 +363,7 @@ SuperagentHttpClient.prototype. binaryRequest = function (accept) {
   if(!accept) {
     return false;
   }
-  return (/^image/i).test(accept) || (/^application\/pdf/).test(accept);
+  return (/^image/i).test(accept)
+    || (/^application\/pdf/).test(accept)
+    || (/^application\/octet-stream/).test(accept);
 };

package/lib/resolver.js

@@ -44,7 +44,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
     callback = arg1;
     scope = arg2;
   }
-  var _root = root;
+  var _root = root, modelName;
   this.scope = (scope || this);
   this.iteration = this.iteration || 0;
 
@@ -56,7 +56,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
     opts.responseInterceptor = this.scope.options.responseInterceptor;
   }
 
-  var name, path, property, propertyName;
+  var name, path, property, propertyName, parameter, done, counter;
   var processedCalls = 0, resolvedRefs = {}, unresolvedRefs = {};
   var resolutionTable = []; // store objects for dereferencing
 
@@ -64,7 +64,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
   // definitions
   for (name in spec.definitions) {
     var definition = spec.definitions[name];
-    if(definition['$ref']) {
+    if(definition.$ref) {
       this.resolveInline(root, spec, definition, resolutionTable, unresolvedRefs, definition);
     }
     else {
@@ -87,25 +87,25 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
   // shared parameters
   spec.parameters = spec.parameters || {};
   for(name in spec.parameters) {
-    var parameter = spec.parameters[name];
+    parameter = spec.parameters[name];
     if (parameter.in === 'body' && parameter.schema) {
       if(_.isArray(parameter.schema.allOf)) {
         // move to a definition
-        var modelName = 'inline_model';
-        var name = modelName;
-        var done = false; var counter = 0;
+        modelName = 'inline_model';
+        var _name = modelName;
+        done = false; counter = 0;
         while(!done) {
-          if(typeof spec.definitions[name] === 'undefined') {
+          if(typeof spec.definitions[_name] === 'undefined') {
             done = true;
             break;
           }
-          name = modelName + '_' + counter;
+          _name = modelName + '_' + counter;
           counter ++;
         }
-        spec.definitions[name] = { allOf: parameter.schema.allOf };
+        spec.definitions[_name] = { allOf: parameter.schema.allOf };
         delete parameter.schema.allOf;
-        parameter.schema.$ref = '#/definitions/' + name;
-        this.processAllOf(root, name, spec.definitions[name], resolutionTable, unresolvedRefs, spec);
+        parameter.schema.$ref = '#/definitions/' + _name;
+        this.processAllOf(root, _name, spec.definitions[_name], resolutionTable, unresolvedRefs, spec);
       }
       else {
         this.resolveTo(root, parameter.schema, resolutionTable, location);
@@ -123,106 +123,110 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
     var method, operation, responseCode;
     path = spec.paths[name];
 
-    for (method in path) {
-      // operation reference
-      if(method === '$ref') {
-        // location = path[method];
-        location = '/paths' + name;
-        this.resolveInline(root, spec, path, resolutionTable, unresolvedRefs, location);
-      }
-      else {
-        operation = path[method];
-        var sharedParameters = path.parameters || [];
-        var parameters = operation.parameters || [];
-
-        for (i in sharedParameters) {
-          var parameter = sharedParameters[i];
-          parameters.unshift(parameter);
-        }
-        if(method !== 'parameters' && _.isObject(operation)) {
-          operation.parameters = operation.parameters || parameters;
+    if(typeof path === 'object') {
+      for (method in path) {
+        // operation reference
+        if (method === '$ref') {
+          // location = path[method];
+          location = '/paths' + name;
+          this.resolveInline(root, spec, path, resolutionTable, unresolvedRefs, location);
         }
+        else {
+          operation = path[method];
+          var sharedParameters = path.parameters || [];
+          var parameters = operation.parameters || [];
 
-        for (i in parameters) {
-          var parameter = parameters[i];
-          location = '/paths' + name + '/' + method + '/parameters';
-
-          if (parameter.in === 'body' && parameter.schema) {
-            if(_.isArray(parameter.schema.allOf)) {
-              // move to a definition
-              var modelName = 'inline_model';
-              var name = modelName;
-              var done = false; var counter = 0;
-              while(!done) {
-                if(typeof spec.definitions[name] === 'undefined') {
-                  done = true;
-                  break;
-                }
-                name = modelName + '_' + counter;
-                counter ++;
-              }
-              spec.definitions[name] = { allOf: parameter.schema.allOf };
-              delete parameter.schema.allOf;
-              parameter.schema.$ref = '#/definitions/' + name;
-              this.processAllOf(root, name, spec.definitions[name], resolutionTable, unresolvedRefs, spec);
-            }
-            else {
-              this.resolveTo(root, parameter.schema, resolutionTable, location);
-            }
-          }
+          sharedParameters.forEach(function(parameter) {
+            parameters.unshift(parameter);
+          });
 
-          if (parameter.$ref) {
-            // parameter reference
-            this.resolveInline(root, spec, parameter, resolutionTable, unresolvedRefs, parameter.$ref);
+          if (method !== 'parameters' && _.isObject(operation)) {
+            operation.parameters = operation.parameters || parameters;
           }
-        }
 
-        for (responseCode in operation.responses) {
-          var response = operation.responses[responseCode];
-          location = '/paths' + name + '/' + method + '/responses/' + responseCode;
+          for (i in parameters) {
+            parameter = parameters[i];
+            location = '/paths' + name + '/' + method + '/parameters';
 
-          if(_.isObject(response)) {
-            if(response.$ref) {
-              // response reference
-              this.resolveInline(root, spec, response, resolutionTable, unresolvedRefs, location);
-            }
-            if (response.schema) {
-              var responseObj = response;
-              if(_.isArray(responseObj.schema.allOf)) {
+            if (parameter.in === 'body' && parameter.schema) {
+              if (_.isArray(parameter.schema.allOf)) {
                 // move to a definition
-                var modelName = 'inline_model';
-                var name = modelName;
-                var done = false; var counter = 0;
-                while(!done) {
-                  if(typeof spec.definitions[name] === 'undefined') {
+                modelName = 'inline_model';
+                name = modelName;
+                done = false;
+                counter = 0;
+                while (!done) {
+                  if (typeof spec.definitions[name] === 'undefined') {
                     done = true;
                     break;
                   }
                   name = modelName + '_' + counter;
-                  counter ++;
+                  counter++;
                 }
-                spec.definitions[name] = { allOf: responseObj.schema.allOf };
-                delete responseObj.schema.allOf;
-                delete responseObj.schema.type;
-                responseObj.schema.$ref = '#/definitions/' + name;
+                spec.definitions[name] = {allOf: parameter.schema.allOf};
+                delete parameter.schema.allOf;
+                parameter.schema.$ref = '#/definitions/' + name;
                 this.processAllOf(root, name, spec.definitions[name], resolutionTable, unresolvedRefs, spec);
               }
-              else if('array' === responseObj.schema.type) {
-                if(responseObj.schema.items && responseObj.schema.items.$ref) {
-                  // response reference
-                  this.resolveInline(root, spec, responseObj.schema.items, resolutionTable, unresolvedRefs, location);
-                }
-              }
               else {
-                this.resolveTo(root, response.schema, resolutionTable, location);
+                this.resolveTo(root, parameter.schema, resolutionTable, location);
+              }
+            }
+
+            if (parameter.$ref) {
+              // parameter reference
+              this.resolveInline(root, spec, parameter, resolutionTable, unresolvedRefs, parameter.$ref);
+            }
+          }
+
+          for (responseCode in operation.responses) {
+            var response = operation.responses[responseCode];
+            location = '/paths' + name + '/' + method + '/responses/' + responseCode;
+
+            if (_.isObject(response)) {
+              if (response.$ref) {
+                // response reference
+                this.resolveInline(root, spec, response, resolutionTable, unresolvedRefs, location);
+              }
+              if (response.schema) {
+                var responseObj = response;
+                if (_.isArray(responseObj.schema.allOf)) {
+                  // move to a definition
+                  modelName = 'inline_model';
+                  name = modelName;
+                  done = false;
+                  counter = 0;
+                  while (!done) {
+                    if (typeof spec.definitions[name] === 'undefined') {
+                      done = true;
+                      break;
+                    }
+                    name = modelName + '_' + counter;
+                    counter++;
+                  }
+                  spec.definitions[name] = {allOf: responseObj.schema.allOf};
+                  delete responseObj.schema.allOf;
+                  delete responseObj.schema.type;
+                  responseObj.schema.$ref = '#/definitions/' + name;
+                  this.processAllOf(root, name, spec.definitions[name], resolutionTable, unresolvedRefs, spec);
+                }
+                else if ('array' === responseObj.schema.type) {
+                  if (responseObj.schema.items && responseObj.schema.items.$ref) {
+                    // response reference
+                    this.resolveInline(root, spec, responseObj.schema.items, resolutionTable, unresolvedRefs, location);
+                  }
+                }
+                else {
+                  this.resolveTo(root, response.schema, resolutionTable, location);
+                }
               }
             }
           }
         }
       }
+      // clear them out to avoid multiple resolutions
+      path.parameters = [];
     }
-    // clear them out to avoid multiple resolutions
-    path.parameters = [];
   }
 
   var expectedCalls = 0, toResolve = [];
@@ -385,7 +389,7 @@ Resolver.prototype.resolve = function (spec, arg1, arg2, arg3) {
             else {
               var cached = self.resolverCache[obj.url];
               if (_.isObject(cached)) {
-                obj.on.response({obj: cached}), 1;
+                obj.on.response({obj: cached});
               }
               else {
                 lock[obj.url] = true;
@@ -463,7 +467,7 @@ Resolver.prototype.resolveItem = function(spec, root, resolutionTable, resolvedR
 
 Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs, unresolvedRefs, callback, localResolve) {
   // walk resolution table and replace with resolved refs
-  var ref;
+  var ref, abs;
   for (ref in resolutionTable) {
     var item = resolutionTable[ref];
 
@@ -475,7 +479,7 @@ Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs,
         if (localResolve !== true) {
           // don't retain root for local definitions
           for (key in resolvedTo.obj) {
-            var abs = this.retainRoot(key, resolvedTo.obj[key], item.root);
+            abs = this.retainRoot(key, resolvedTo.obj[key], item.root);
             resolvedTo.obj[key] = abs;
           }
         }
@@ -487,7 +491,7 @@ Resolver.prototype.finish = function (spec, root, resolutionTable, resolvedRefs,
         delete targetObj.$ref;
 
         for (key in resolvedTo.obj) {
-          var abs = resolvedTo.obj[key];
+          abs = resolvedTo.obj[key];
 
           if (localResolve !== true) {
             // don't retain root for local definitions
@@ -666,7 +670,7 @@ Resolver.prototype.resolveInline = function (root, spec, property, resolutionTab
   var key = property.$ref, ref = property.$ref, i, p, p2, rs;
   var rootTrimmed = false;
 
-  root = root || '' // Guard against .split. @fehguy, you'll need to check if this logic fits
+  root = root || ''; // Guard against .split. @fehguy, you'll need to check if this logic fits
   // More imporantly is how do we gracefully handle relative urls, when provided just a 'spec', not a 'url' ?
 
   if (ref) {
@@ -806,7 +810,7 @@ Resolver.prototype.resolveTo = function (root, property, resolutionTable, locati
       }
       delete property.title;
       this.spec.definitions[name] = _.cloneDeep(property);
-      property['$ref'] = '#/definitions/' + name;
+      property.$ref = '#/definitions/' + name;
       delete property.type;
       delete property.properties;
     }

package/lib/schema-markup.js

@@ -15,17 +15,11 @@ var _ = {
   forEach: require('lodash-compat/collection/forEach')
 };
 
-module.exports.optionHtml = optionHtml;
-module.exports.typeFromJsonSchema = typeFromJsonSchema;
-module.exports.getStringSignature = getStringSignature;
-module.exports.schemaToHTML = schemaToHTML;
-module.exports.schemaToJSON = schemaToJSON;
-
-function optionHtml(label, value) {
+var optionHtml = module.exports.optionHtml = function  (label, value) {
   return '<tr><td class="optionName">' + label + ':</td><td>' + value + '</td></tr>';
-}
+};
 
-function typeFromJsonSchema(type, format) {
+module.exports.typeFromJsonSchema = function (type, format) {
   var str;
 
   if (type === 'integer' && format === 'int32') {
@@ -51,9 +45,9 @@ function typeFromJsonSchema(type, format) {
   }
 
   return str;
-}
+};
 
-function getStringSignature(obj, baseComponent) {
+var getStringSignature = module.exports.getStringSignature = function (obj, baseComponent) {
   var str = '';
 
   if (typeof obj.$ref !== 'undefined') {
@@ -95,9 +89,9 @@ function getStringSignature(obj, baseComponent) {
   }
 
   return str;
-}
+};
 
-function schemaToJSON(schema, models, modelsToIgnore, modelPropertyMacro) {
+var schemaToJSON = module.exports.schemaToJSON = function (schema, models, modelsToIgnore, modelPropertyMacro) {
   // Resolve the schema (Handle nested schemas)
   schema = Helpers.resolveSchema(schema);
 
@@ -182,10 +176,9 @@ function schemaToJSON(schema, models, modelsToIgnore, modelPropertyMacro) {
   }
 
   return output;
-}
-
-function schemaToHTML(name, schema, models, modelPropertyMacro) {
+};
 
+module.exports.schemaToHTML =function (name, schema, models, modelPropertyMacro) {
   var strongOpen = '<span class="strong">';
   var strongClose = '</span>';
 
@@ -530,4 +523,4 @@ function schemaToHTML(name, schema, models, modelPropertyMacro) {
 
     return html + strongOpen + (isArray ? ']' : '}') + strongClose;
   }
-}
+};

package/lib/spec-converter.js

@@ -557,7 +557,9 @@ SwaggerSpecConverter.prototype.securityDefinitions = function(obj, swagger) {
     var name;
     for(name in obj.authorizations) {
       var isValid = false;
-      var securityDefinition = {};
+      var securityDefinition = {
+        vendorExtensions: {}
+      };
       var definition = obj.authorizations[name];
       if(definition.type === 'apiKey') {
         securityDefinition.type = 'apiKey';

package/lib/types/operation.js

@@ -21,6 +21,7 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
     this.client = parent.options.client || null;
     this.requestInterceptor = parent.options.requestInterceptor || null;
     this.responseInterceptor = parent.options.responseInterceptor || null;
+    this.requestAgent = parent.options.requestAgent;
   }
   this.authorizations = args.security;
   this.basePath = parent.basePath || '/';
@@ -49,6 +50,8 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
   this.jqueryAjaxCache = parent.jqueryAjaxCache;
   this.enableCookies = parent.enableCookies;
 
+  var key;
+
   if(!this.host) {
     if(typeof window !== 'undefined') {
       this.host = window.location.host;
@@ -87,8 +90,6 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
 
   if (definitions) {
     // add to global models
-    var key;
-
     for (key in definitions) {
       model = new Model(key, definitions[key], this.models, parent.modelPropertyMacro);
 
@@ -102,7 +103,7 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
   }
 
   for (i = 0; i < this.parameters.length; i++) {
-    var param = this.parameters[i];
+    var d, param = this.parameters[i];
 
     // Allow macro to set the default value
     param.default = this.parameterMacro(this, param);
@@ -110,10 +111,6 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
     if (param.type === 'array') {
       param.isList = true;
       param.allowMultiple = true;
-      // the enum can be defined at the items level
-      //if (param.items && param.items.enum) {
-      //  param['enum'] = param.items.enum;
-      //}
     }
 
     var innerType = this.getType(param);
@@ -124,12 +121,15 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
       param['enum'] = [true, false]; // use actual primitives
     }
 
+    for(key in param) {
+      helpers.extractExtensions(key, param);
+    }
     if(typeof param['x-example'] !== 'undefined') {
-      var d = param['x-example'];
+      d = param['x-example'];
       param.default = d;
     }
     if(param['x-examples']) {
-      var d = param['x-examples'].default;
+      d = param['x-examples'].default;
       if(typeof d !== 'undefined') {
         param.default = d;
       }
@@ -170,7 +170,7 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
     param.responseClassSignature = param.signature;
   }
 
-  var defaultResponseCode, response, responses = this.responses;
+  var keyname, defaultResponseCode, response, responses = this.responses;
 
   if (responses['200']) {
     response = responses['200'];
@@ -198,6 +198,30 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
     defaultResponseCode = 'default';
   }
 
+  for(keyname in responses) {
+    helpers.extractExtensions(keyname, responses);
+    if(typeof keyname === 'string' && keyname.indexOf('x-') === -1) {
+      var responseObject = responses[keyname];
+      if(typeof responseObject === 'object' && typeof responseObject.headers === 'object') {
+        var headers = responseObject.headers;
+        for(var headerName in headers) {
+          var header = headers[headerName];
+          if(typeof header === 'object') {
+            for(var headerKey in header) {
+              helpers.extractExtensions(headerKey, header);
+            }
+          }
+        }
+      }
+    }
+  }
+
+  if (response) {
+    for(keyname in response) {
+      helpers.extractExtensions(keyname, response);
+    }
+  }
+
   if (response && response.schema) {
     var resolvedModel = this.resolveModel(response.schema, definitions);
     var successResponse;
@@ -218,6 +242,7 @@ var Operation = module.exports = function (parent, scheme, operationId, httpMeth
     }
 
     if (successResponse) {
+      successResponse.vendorExtensions = response.vendorExtensions;
       // Attach response properties
       if (response.description) {
         successResponse.description = response.description;
@@ -534,12 +559,12 @@ Operation.prototype.getMissingParams = function (args) {
   return missingParams;
 };
 
-Operation.prototype.getBody = function (headers, args, opts) {
-  var formParams = {}, hasFormParams, body, key, value, hasBody = false;
+Operation.prototype.getBody = function (headers, args) {
+  var formParams = {}, hasFormParams, param, body, key, value, hasBody = false;
 
   // look at each param and put form params in an object
   for (var i = 0; i < this.parameters.length; i++) {
-    var param = this.parameters[i];
+    param = this.parameters[i];
     if (typeof args[param.name] !== 'undefined') {
       if (param.in === 'body') {
         body = args[param.name];
@@ -576,7 +601,7 @@ Operation.prototype.getBody = function (headers, args, opts) {
     var encoded = '';
 
     for (key in formParams) {
-      var param = formParams[key].param;
+      param = formParams[key].param;
       value = formParams[key].value;
 
       if (typeof value !== 'undefined') {
@@ -605,7 +630,7 @@ Operation.prototype.getBody = function (headers, args, opts) {
       bodyParam.type = 'formData';
 
       for (key in formParams) {
-        var param = formParams[key].param;
+        param = formParams[key].param;
         value = args[key];
 
         if (typeof value !== 'undefined') {
@@ -743,14 +768,16 @@ Operation.prototype.execute = function (arg1, arg2, arg3, arg4, parent) {
     error = arg4;
   }
 
-  timeout = typeof opts.timeout !== 'undefined'
-    ? opts.timeout
-    : this.timeout;
+  timeout = typeof opts.timeout !== 'undefined' ? opts.timeout : this.timeout;
 
   if(this.client) {
     opts.client = this.client;
   }
 
+  if(this.requestAgent) {
+    opts.requestAgent = this.requestAgent;
+  }
+
   // add the request interceptor from parent, if none sent from client
   if(!opts.requestInterceptor && this.requestInterceptor ) {
     opts.requestInterceptor = this.requestInterceptor ;

package/package.json

@@ -8,7 +8,7 @@
     }
   ],
   "description": "swagger-client is a javascript client for use with swaggering APIs.",
-  "version": "2.1.21",
+  "version": "2.1.25",
   "homepage": "http://swagger.io",
   "repository": {
     "type": "git",
@@ -55,6 +55,7 @@
     "gulp-istanbul": "^0.5.0",
     "gulp-jshint": "^1.9.0",
     "gulp-mocha": "^2.0.0",
+    "gulp-sourcemaps": "^1.0.0",
     "http-server": "^0.8.0",
     "jshint-stylish": "^1.0.1",
     "karma": "^0.13.0",