Merge pull request #947 from swagger-api/develop_2.0

updated client for remote ref support

Author: fehguy

dist/lib/swagger-client.js

@@ -1,6 +1,6 @@
 /**
  * swagger-client - swagger.js is a javascript client for use with swaggering APIs.
- * @version v2.1.8-M1
+ * @version v2.1.9-M1
  * @link http://swagger.io
  * @license apache 2.0
  */
@@ -301,6 +301,206 @@ PrimitiveModel.prototype.getMockSignature = function(modelsToIgnore) {
   }
   return returnVal;
 };
+/** 
+ * Resolves a spec's remote references
+ */
+var Resolver = function (){};
+
+Resolver.prototype.resolve = function(spec, callback, scope) {
+  this.scope = (scope || this);
+  var host, name, path, property, propertyName, type;
+  var processedCalls = 0, resolvedRefs = {}, unresolvedRefs = {};
+
+  // store objects for dereferencing
+  var resolutionTable = {};
+
+  // models
+  for(name in spec.definitions) {
+    var model = spec.definitions[name];
+    for(propertyName in model.properties) {
+      property = model.properties[propertyName];
+      this.resolveTo(property, resolutionTable);
+    }
+  }
+  // operations
+  for(name in spec.paths) {
+    var method, operation, responseCode;
+    path = spec.paths[name];
+    for(method in path) {
+      operation = path[method];
+      var i, parameters = operation.parameters;
+      for(i in parameters) {
+        var parameter = parameters[i];
+        if(parameter.in === 'body' && parameter.schema) {
+          this.resolveTo(parameter.schema, resolutionTable);
+        }
+        if(parameter.$ref) {
+          this.resolveInline(spec, parameter, resolutionTable, unresolvedRefs);
+        }
+      }
+      for(responseCode in operation.responses) {
+        var response = operation.responses[responseCode];
+        if(response.schema) {
+          this.resolveTo(response.schema, resolutionTable);
+        }
+      }
+    }
+  }
+  // get hosts
+  var opts = {}, expectedCalls = 0;
+  for(name in resolutionTable) {
+    var parts = name.split('#');
+    if(parts.length == 2) {
+      host = parts[0]; path = parts[1];
+      if(!Array.isArray(opts[host])) {
+        opts[host] = [];
+        expectedCalls += 1;
+      }
+      opts[host].push(path);
+    }
+  }
+
+  for(name in opts) {
+    var self = this, opt = opts[name];
+    host = name;
+
+    var obj = {
+      useJQuery: false,  // TODO
+      url: host,
+      method: "get",
+      headers: {
+        accept: this.scope.swaggerRequestHeaders || 'application/json'
+      },
+      on: {
+        error: function(response) {
+          processedCalls += 1;
+          var i;
+          for(i = 0; i < opt.length; i++) {
+            // fail all of these
+            var resolved = host + '#' + opt[i];
+            unresolvedRefs[resolved] = null;
+          }
+          if(processedCalls === expectedCalls)
+            self.finish(spec, resolutionTable, resolvedRefs, unresolvedRefs, callback);
+        },
+        response: function(response) {
+          var i, j, swagger = response.obj;
+          processedCalls += 1;
+          for(i = 0; i < opt.length; i++) {
+            var location = swagger, path = opt[i], parts = path.split('/');
+            for(j = 0; j < parts.length; j++) {
+              var segment = parts[j];
+              if(typeof location === 'undefined')
+                break;
+              if(segment.length > 0)
+                location = location[segment];
+            }
+            var resolved = host + '#' + path, resolvedName = parts[j-1];
+            if(typeof location !== 'undefined') {
+              resolvedRefs[resolved] = {
+                name: resolvedName,
+                obj: location
+              };
+            }
+            else unresolvedRefs[resolved] = null;
+          }
+          if(processedCalls === expectedCalls)
+            self.finish(spec, resolutionTable, resolvedRefs, unresolvedRefs, callback);
+        }
+      }
+    };
+    authorizations.apply(obj);
+    new SwaggerHttp().execute(obj);
+  }
+  if(Object.keys(opts).length === 0)
+    callback.call(this.scope, spec, unresolvedRefs);
+};
+
+Resolver.prototype.finish = function(spec, resolutionTable, resolvedRefs, unresolvedRefs, callback) {
+  // walk resolution table and replace with resolved refs
+  var ref;
+  for(ref in resolutionTable) {
+    var i, locations = resolutionTable[ref];
+    for(i = 0; i < locations.length; i++) {
+      var resolvedTo = resolvedRefs[locations[i].obj.$ref];
+      if(resolvedTo) {
+        if(!spec.definitions)
+          spec.definitions = {};
+        if(locations[i].resolveAs === '$ref') {
+          spec.definitions[resolvedTo.name] = resolvedTo.obj;
+          locations[i].obj.$ref = '#/definitions/' + resolvedTo.name;
+        }
+        else if (locations[i].resolveAs === 'inline') {
+          var key;
+          var targetObj = locations[i].obj;
+          delete targetObj.$ref;
+          for(key in resolvedTo.obj) {
+            targetObj[key] = resolvedTo.obj[key];
+          }
+        }
+      }
+    }
+  }
+  callback.call(this.scope, spec, unresolvedRefs);
+};
+
+/**
+ * immediately in-lines local refs, queues remote refs
+ * for inline resolution
+ */
+Resolver.prototype.resolveInline = function (spec, property, objs, unresolvedRefs) {
+  var ref = property.$ref;
+  if(ref) {
+    if(ref.indexOf('http') === 0) {
+      if(Array.isArray(objs[ref])) {
+        objs[ref].push({obj: property, resolveAs: 'inline'});
+      }
+      else {
+        objs[ref] = [{obj: property, resolveAs: 'inline'}];
+      }
+    }
+    else if (ref.indexOf('#') === 0) {
+      // local resolve
+      var shortenedRef = ref.substring(1);
+      var i, parts = shortenedRef.split('/'), location = spec;
+      for(i = 0; i < parts.length; i++) {
+        var part = parts[i];
+        if(part.length > 0) {
+          location = location[part];
+        }
+      }
+      if(location) {
+        delete property.$ref;
+        var key;
+        for(key in location) {
+          property[key] = location[key];
+        }
+      }
+      else unresolvedRefs[ref] = null;
+    }
+  }
+  else if(property.type === 'array') {
+    this.resolveTo(property.items, objs);
+  }
+};
+
+Resolver.prototype.resolveTo = function (property, objs) {
+  var ref = property.$ref;
+  if(ref) {
+    if(ref.indexOf('http') === 0) {
+      if(Array.isArray(objs[ref])) {
+        objs[ref].push({obj: property, resolveAs: '$ref'});
+      }
+      else {
+        objs[ref] = [{obj: property, resolveAs: '$ref'}];
+      }
+    }
+  }
+  else if(property.type === 'array') {
+    var items = property.items;
+    this.resolveTo(items, objs);
+  }
+};
 var addModel = function(name, model) {
   models[name] = model;
 };
@@ -389,7 +589,7 @@ SwaggerClient.prototype.build = function(mock) {
 
         if(responseObj.swagger && parseInt(responseObj.swagger) === 2) {
           self.swaggerVersion = responseObj.swagger;
-          self.buildFromSpec(responseObj);
+          new Resolver().resolve(responseObj, self.buildFromSpec, self);
           self.isValid = true;
         }
         else {
@@ -403,7 +603,9 @@ SwaggerClient.prototype.build = function(mock) {
     }
   };
   if(this.spec) {
-    setTimeout(function() { self.buildFromSpec(self.spec); }, 10);
+    setTimeout(function() {
+      new Resolver().resolve(self.spec, self.buildFromSpec, self);
+   }, 10);
   }
   else {
     authorizations.apply(obj);
@@ -3088,5 +3290,5 @@ e.SwaggerApi = SwaggerClient;
 e.Operation = Operation;
 e.Model = Model;
 e.addModel = addModel;
-
+e.Resolver = Resolver;
 })();