external document with partial swagger.json

swagger.json with PathItem and Schema is allowed.

Author: mission-liao

pyswagger/core.py

@@ -142,22 +142,25 @@ def _load_json(self, url, getter=None, parser=None):
         # get root document to check its swagger version.
         obj, _ = six.advance_iterator(getter)
         tmp = {'_tmp_': {}}
-        if not parser:
-            if utils.get_swagger_version(obj) == '1.2':
-                # swagger 1.2
-                with ResourceListContext(tmp, '_tmp_') as ctx:
-                    ctx.parse(getter, obj)
-            else:
-                # swagger 2.0
-                with SwaggerContext(tmp, '_tmp_') as ctx:
-                    ctx.parse(obj)
-        else:
-            raise NotImplementedError()
+        version = utils.get_swagger_version(obj)
+        if version == '1.2':
+            # swagger 1.2
+            with ResourceListContext(tmp, '_tmp_') as ctx:
+                ctx.parse(getter, obj)
+        elif version == '2.0':
+            # swagger 2.0
+            with SwaggerContext(tmp, '_tmp_') as ctx:
+                ctx.parse(obj)
+        elif version == None and parser:
             with parser(tmp, '_tmp_') as ctx:
                 ctx.parse(obj)
 
+            version = tmp['_tmp_'].__swagger_version__ if hasattr(tmp['_tmp_'], '__swagger_version__') else version
+        else:
+            raise NotImplementedError('Unsupported Swagger Version: {0} from {1}'.format(version, url))
+
         self.__app_cache[url] = weakref.proxy(self) # avoid circular reference
-        self.__version = utils.get_swagger_version(tmp['_tmp_'])
+        self.__version = version
         self.__raw = tmp['_tmp_']
 
     def _validate(self):
@@ -211,14 +214,15 @@ def _prepare_obj(self, strict=True):
             # TODO: partial object would go to this place.
             raise NotImplementedError('Unsupported Version: {0}'.format(self.__version))
 
-        if self.__root.schemes and len(self.__root.schemes) > 0:
-            self.__schemes = self.__root.schemes
+        if hasattr(self.__root, 'schemes') and self.__root.schemes:
+            if len(self.__root.schemes) > 0:
+                self.__schemes = self.__root.schemes
 
         s.scan(root=self.__root, route=[Resolve()])
         s.scan(root=self.__root, route=[PatchObject()])
 
     @classmethod
-    def load(kls, url, getter=None, app_cache=None, url_load_hook=None):
+    def load(kls, url, getter=None, parser=None, app_cache=None, url_load_hook=None):
         """ load json as a raw SwaggerApp
 
         :param str url: url of path of Swagger API definition
@@ -233,7 +237,7 @@ def load(kls, url, getter=None, app_cache=None, url_load_hook=None):
         url = utils.normalize_url(url)
         app = kls(url, app_cache, url_load_hook)
 
-        app._load_json(url, getter)
+        app._load_json(url, getter, parser)
 
         # update schem if any
         p = six.moves.urllib.parse.urlparse(url)
@@ -271,7 +275,10 @@ def prepare(self, strict=True):
         # 'op' -- shortcut for Operation with tag and operaionId
         self.__op = utils.ScopeDict(tr.op)
         # 'm' -- shortcut for model in Swagger 1.2
-        self.__m = utils.ScopeDict(self.__root.definitions)
+        if hasattr(self.__root, 'definitions'):
+            self.__m = utils.ScopeDict(self.__root.definitions)
+        else:
+            self.__m = utils.ScopeDict({})
 
         # cycle detection
         if len(cy.cycles['schema']) > 0 and strict:
@@ -299,7 +306,7 @@ def create(kls, url, strict=True):
     """
     _create_ = create
 
-    def resolve(self, jref):
+    def resolve(self, jref, parser=None):
         """ reference resolver
 
         :param str jref: a JSON Reference, refer to http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03 for details.
@@ -315,7 +322,7 @@ def resolve(self, jref):
         if url:
             if url not in self.__app_cache:
                 # This loaded SwaggerApp would be kept in app_cache.
-                app = SwaggerApp.load(url, app_cache=self.__app_cache, url_load_hook=self.__url_load_hook)
+                app = SwaggerApp.load(url, parser=parser, app_cache=self.__app_cache, url_load_hook=self.__url_load_hook)
                 app.prepare()
 
                 # nothing but only keeping a strong reference of

pyswagger/scanner/v2_0/patch_obj.py

@@ -1,6 +1,6 @@
 from __future__ import absolute_import
 from ...scan import Dispatcher
-from ...spec.v2_0.objects import PathItem, Operation, Schema
+from ...spec.v2_0.objects import PathItem, Operation, Schema, Swagger
 from ...spec.v2_0.parser import PathItemContext
 from ...utils import jp_split, scope_split
 
@@ -18,17 +18,19 @@ class Disp(Dispatcher): pass
     def _operation(self, path, obj, app):
         """
         """
-        # produces/consumes
-        obj.update_field('produces', app.root.produces if len(obj.produces) == 0 else obj.produces)
-        obj.update_field('consumes', app.root.consumes if len(obj.consumes) == 0 else obj.consumes)
+        if isinstance(app.root, Swagger):
+            # produces/consumes
+            obj.update_field('produces', app.root.produces if len(obj.produces) == 0 else obj.produces)
+            obj.update_field('consumes', app.root.consumes if len(obj.consumes) == 0 else obj.consumes)
 
         # combine parameters from PathItem
-        for p in obj._parent_.parameters:
-            for pp in obj.parameters:
-                if p.name == pp.name:
-                    break
-            else:
-                obj.parameters.append(p)
+        if obj._parent_:
+            for p in obj._parent_.parameters:
+                for pp in obj.parameters:
+                    if p.name == pp.name:
+                        break
+                else:
+                    obj.parameters.append(p)
 
         # schemes
         obj.update_field('schemes', app.schemes if len(obj.schemes) == 0 else obj.schemes)
@@ -37,7 +39,11 @@ def _operation(self, path, obj, app):
     def _path_item(self, path, obj, app):
         """
         """
-        url = app.root.host + (app.root.basePath or '') + jp_split(path)[-1]
+        if isinstance(app.root, Swagger):
+            url = app.root.host + (app.root.basePath or '') + jp_split(path)[-1]
+        else:
+            url = None
+
         for c in PathItemContext.__swagger_child__:
             o = getattr(obj, c[0])
             if isinstance(o, Operation):

pyswagger/scanner/v2_0/resolve.py

@@ -1,6 +1,9 @@
 from __future__ import absolute_import
 from ...scan import Dispatcher
 from ...spec.v2_0.parser import (
+    SchemaContext,
+    ParameterContext,
+    ResponseContext,
     PathItemContext
     )
 from ...spec.v2_0.objects import (
@@ -15,12 +18,12 @@
 def is_resolved(obj):
     return getattr(obj, '$ref') == None or obj.ref_obj != None
 
-def _resolve(obj, app, prefix):
+def _resolve(obj, app, prefix, parser):
     if is_resolved(obj):
         return
 
     r = getattr(obj, '$ref')
-    ro = app.resolve(normalize_jr(r, prefix))
+    ro = app.resolve(normalize_jr(r, prefix), parser)
 
     if not ro:
         raise ReferenceError('Unable to resolve: {0}'.format(r))
@@ -38,7 +41,7 @@ def _merge(obj, app, prefix, ctx):
     cur = obj
     to_resolve = []
     while not is_resolved(cur):
-        _resolve(cur, app, prefix)
+        _resolve(cur, app, prefix, ctx)
 
         to_resolve.append(cur)
         cur = cur.ref_obj if cur.ref_obj else cur
@@ -56,15 +59,15 @@ class Disp(Dispatcher): pass
 
     @Disp.register([Schema])
     def _schema(self, _, obj, app):
-        _resolve(obj, app, '#/definitions')
+        _resolve(obj, app, '#/definitions', SchemaContext)
 
     @Disp.register([Parameter])
     def _parameter(self, _, obj, app):
-        _resolve(obj, app, '#/parameters')
+        _resolve(obj, app, '#/parameters', ParameterContext)
 
     @Disp.register([Response])
     def _response(self, _, obj, app):
-        _resolve(obj, app, '#/responses')
+        _resolve(obj, app, '#/responses', ResponseContext)
 
     @Disp.register([PathItem])
     def _path_item(self, _, obj, app):

pyswagger/tests/data/v2_0/ex/partial/path_item/swagger.json

@@ -0,0 +1,12 @@
+{
+   "get":{
+      "response":{
+         "description":"path_item, get, response"
+      }
+   },
+   "put":{
+      "response":{
+         "description":"path_item, put, response"
+      }
+   }
+}

pyswagger/tests/data/v2_0/ex/partial/schema/swagger.json

@@ -0,0 +1,6 @@
+{
+   "type":"array",
+   "items":{
+      "$ref":"file:///root/swagger.json#/definitions/s3"
+   }
+}

pyswagger/tests/data/v2_0/ex/root/swagger.json

@@ -15,6 +15,9 @@
    "paths":{
       "/full":{
          "$ref":"file:///full/swagger.json#/paths/~1user"
+      },
+      "/partial":{
+         "$ref":"file:///partial/path_item/swagger.json"
       }
    },
    "definitions":{
@@ -23,6 +26,15 @@
       },
       "s2":{
          "$ref":"file:///full/swagger.json#/definitions/fs2"
+      },
+      "s3":{
+         "type":"string"
+      },
+      "s4":{
+         "type":"array",
+         "items":{
+            "$ref":"file:///partial/schema/swagger.json"
+         }
       }
    }
-}
+}

pyswagger/tests/test_utils.py

@@ -117,6 +117,9 @@ def test_jr_split(self):
         self.assertEqual(utils.jr_split(
             '#'), (
             '', '#'))
+        self.assertEqual(utils.jr_split(
+            '//'), (
+            '', '#'))
 
 
 class WalkTestCase(unittest.TestCase):

pyswagger/tests/v1_2/test_app.py

@@ -125,7 +125,6 @@ def test_ref(self):
         """ test ref function """
         self.assertRaises(ValueError, self.app.resolve, None)
         self.assertRaises(ValueError, self.app.resolve, '')
-        self.assertRaises(ValueError, self.app.resolve, '//')
 
         self.assertTrue(isinstance(self.app.resolve('#/definitions/user!##!User'), Schema))
         self.assertTrue(isinstance(self.app.resolve('#/paths/~1api~1user~1{username}/put'), Operation))

pyswagger/tests/v2_0/test_ex.py

@@ -3,7 +3,6 @@
 import unittest
 import os
 import six
-import weakref
 
 
 folder = get_test_data_folder(version='2.0', which='ex')
@@ -28,7 +27,7 @@ def setUpClass(kls):
         global folder
 
         kls.app = SwaggerApp.load(
-            url='root',
+            url='file:///root/swagger.json',
             url_load_hook=_hook
         )
         kls.app.prepare()
@@ -38,13 +37,13 @@ def test_resolve(self):
         is the same as resolve with JSON pointer.
         """
         p = self.app.resolve('#/paths/~1full')
-        p_ = self.app.resolve('file:///root#/paths/~1full')
+        p_ = self.app.resolve('file:///root/swagger.json#/paths/~1full')
         # refer to 
         #      http://stackoverflow.com/questions/10246116/python-dereferencing-weakproxy 
         # for how to dereferencing weakref
         self.assertEqual(p.__repr__(), p_.__repr__())
 
-    def test_path_item(self):
+    def test_full_path_item(self):
         """ make sure PathItem is correctly merged
         """
         p = self.app.resolve('#/paths/~1full')
@@ -57,12 +56,37 @@ def test_path_item(self):
         self.assertTrue('default' in another_p.get.responses)
         self.assertTrue('404' in another_p.get.responses)
 
-    def test_path_item_url(self):
+    def test_full_path_item_url(self):
         """ make sure url is correctly patched
         """
         p = self.app.resolve('#/paths/~1full')
         self.assertEqual(p.get.url, 'test.com/v1/full')
 
-        another_p = self.app.resolve('file:///full/swagger.json#/paths/~1user')
-        self.assertEqual(another_p.get.url, 'test1.com/v2/user')
+        original_p = self.app.resolve('file:///full/swagger.json#/paths/~1user')
+        self.assertEqual(original_p.get.url, 'test1.com/v2/user')
+
+    def test_partial_path_item(self):
+        """ make sure partial swagger.json with PathItem
+        loaded correctly.
+        """
+        p = self.app.resolve('#/paths/~1partial')
+        self.assertEqual(p.get.url, 'test.com/v1/partial')
+
+        original_p = self.app.resolve('file:///partial/path_item/swagger.json')        
+        self.assertEqual(original_p.get.url, None)
+
+    def test_partial_schema(self):
+        """  make sure partial swagger.json with Schema
+        loaded correctly.
+        """
+        p = self.app.resolve('#/definitions/s4')
+        original_p = self.app.resolve('file:///partial/schema/swagger.json')
+
+        # refer to 
+        #      http://stackoverflow.com/questions/10246116/python-dereferencing-weakproxy 
+        # for how to dereferencing weakref
+        self.assertEqual(p.items.ref_obj.__repr__(), original_p.__repr__())
+
+        p_ = self.app.resolve('#/definitions/s3')
+        self.assertEqual(p_.__repr__(), original_p.items.ref_obj.__repr__())