fix

- deprecate implicit dereference
- support relative file reference
- #53

Author: mission-liao

CHANGES.md

@@ -0,0 +1,22 @@
+##Changes
+
+###0.8.17
+
+- (deprecated) implicit dereferencing
+  ```json
+  "definitions":{
+    "User":{
+    },
+    "AuthorizedUser":{
+      "$ref": "User"   --> deferenced to "#/definitions/User"
+    }
+  }
+  ```
+- __NEW__ relative file reference
+  ```
+  "definitions":{
+    "User": {
+      "$ref": "other_folder/User.json"
+    }
+  }
+  ```

README.md

@@ -24,6 +24,7 @@ Read the [Document](http://pyswagger.readthedocs.org/en/latest/), or just go thr
 - [Contributors](README.md#contributors)
 - [Contribution Guideline](README.md#contribution-guildeline)
 - [FAQ](README.md#faq)
+- [Changes](CHANGES.md)
 
 ---------
 

pyswagger/scanner/cycle_detector.py

@@ -10,8 +10,8 @@
 import functools
 import six
 
-def _out(app, prefix, path):
-    obj = app.resolve(normalize_jr(path, prefix, app.url))
+def _out(app, path):
+    obj = app.resolve(normalize_jr(path, app.url))
     r = getattr(obj, 'norm_ref')
     return [r] if r else []
 
@@ -37,7 +37,7 @@ def _schema_out_obj(obj, out=None):
     return out
 
 def _schema_out(app, path):
-    obj = app.resolve(normalize_jr(path, '#/definitions'))
+    obj = app.resolve(normalize_jr(path, app.url))
     return [] if obj == None else _schema_out_obj(obj)
 
 
@@ -66,23 +66,23 @@ def _schema(self, path, _, app):
     def _parameter(self, path, _, app):
          self.cycles['parameter'] = walk(
             path,
-            functools.partial(_out, app, '#/parameters'),
+            functools.partial(_out, app),
             self.cycles['parameter']
         )
 
     @Disp.register([Response])
     def _response(self, path, _, app):
         self.cycles['response'] = walk(
             path,
-            functools.partial(_out, app, '#/responses'),
+            functools.partial(_out, app),
             self.cycles['response']
         )
 
     @Disp.register([PathItem])
     def _path_item(self, path, _, app):
         self.cycles['path_item'] = walk(
             path,
-            functools.partial(_out, app, '#/paths'),
+            functools.partial(_out, app),
             self.cycles['path_item']
         )
 

pyswagger/scanner/v2_0/resolve.py

@@ -18,30 +18,30 @@
 def is_resolved(obj):
     return getattr(obj, '$ref') == None or obj.ref_obj != None
 
-def _resolve(obj, app, prefix, parser):
+def _resolve(obj, app, parser):
     if is_resolved(obj):
         return
 
     r = getattr(obj, '$ref')
-    ro = app.resolve(normalize_jr(r, prefix, app.url), parser)
+    ro = app.resolve(normalize_jr(r, app.url), parser)
 
     if not ro:
         raise ReferenceError('Unable to resolve: {0}'.format(r))
     if ro.__class__ != obj.__class__:
         raise TypeError('Referenced Type mismatch: {0}'.format(r))
 
     obj.update_field('ref_obj', ro)
-    obj.update_field('norm_ref', normalize_jr(r, prefix, app.url))
+    obj.update_field('norm_ref', normalize_jr(r, app.url))
 
-def _merge(obj, app, prefix, ctx):
+def _merge(obj, app, ctx):
     """ resolve $ref as ref_obj, and merge ref_obj to self.
     This operation should be carried in a cascade manner.
     """
 
     cur = obj
     to_resolve = []
     while not is_resolved(cur):
-        _resolve(cur, app, prefix, ctx)
+        _resolve(cur, app, ctx)
 
         to_resolve.append(cur)
         cur = cur.ref_obj if cur.ref_obj else cur
@@ -59,21 +59,21 @@ class Disp(Dispatcher): pass
 
     @Disp.register([Schema])
     def _schema(self, _, obj, app):
-        _resolve(obj, app, '#/definitions', SchemaContext)
+        _resolve(obj, app, SchemaContext)
 
     @Disp.register([Parameter])
     def _parameter(self, _, obj, app):
-        _resolve(obj, app, '#/parameters', ParameterContext)
+        _resolve(obj, app, ParameterContext)
 
     @Disp.register([Response])
     def _response(self, _, obj, app):
-        _resolve(obj, app, '#/responses', ResponseContext)
+        _resolve(obj, app, ResponseContext)
 
     @Disp.register([PathItem])
     def _path_item(self, _, obj, app):
 
         # $ref in PathItem is 'merge', not 'replace'
         # we need to merge properties of others if missing
         # in current object.
-        _merge(obj, app, '#/paths', PathItemContext)
+        _merge(obj, app, PathItemContext)
 

pyswagger/spec/base.py

@@ -304,7 +304,10 @@ def _produce_new_obj(x, ct, v):
                 # since everything under SwaggerApp should be
                 # readonly.
                 if isinstance(v, list):
-                    self.update_field(name, list(set((getattr(self, name) or []) + v)))
+                    try:
+                        self.update_field(name, list(set((getattr(self, name) or []) + v)))
+                    except TypeError:
+                        self.update_field(name, list((getattr(self, name) or []) + v))
                 elif isinstance(v, dict):
                     d = copy.copy(v)
                     d.update(getattr(self, name) or {})

pyswagger/tests/data/v2_0/ex/relative/definitions/Login.yaml

@@ -0,0 +1,5 @@
+description: test
+type: object
+properties:
+  id:
+    type: integer

pyswagger/tests/data/v2_0/ex/relative/definitions/LoginResults.yaml

@@ -0,0 +1,5 @@
+description: test
+type: object
+properties:
+  id:
+    type: integer

pyswagger/tests/data/v2_0/ex/relative/definitions/Stuff.yaml

@@ -0,0 +1,5 @@
+description: test
+type: object
+properties:
+  id:
+    type: integer

pyswagger/tests/data/v2_0/ex/relative/definitions/StuffResults.yaml

@@ -0,0 +1,5 @@
+description: test
+type: object
+properties:
+  id:
+    type: integer

pyswagger/tests/data/v2_0/ex/relative/internal.yaml

@@ -0,0 +1,16 @@
+swagger: '2.0'
+info:
+  title: Acme Internal API
+  description: Docs for working with secret stuff
+  version: 0.0.1
+host: api.acme.com
+basePath: /v1
+schemes:
+  - https
+produces:
+  - application/json
+paths:
+  '/login':
+    $ref: 'login.yaml'
+  '/secret_stuff':
+    $ref: 'secret_stuff.yaml'

pyswagger/tests/data/v2_0/ex/relative/login.yaml

@@ -0,0 +1,17 @@
+post:
+  operationId: post_login
+  summary: Log a user in
+  description: Insert username and password, receive token
+  parameters:
+    - name: login_form
+      in: body
+      required: true
+      schema:
+        $ref: 'definitions/Login.yaml'
+  responses:
+    '200':
+      description: Login result containing a session token
+      schema:
+        $ref: 'definitions/LoginResults.yaml'
+    '403':
+      description: Returned when credentials are incorrect

pyswagger/tests/data/v2_0/ex/relative/public.yaml

@@ -0,0 +1,16 @@
+swagger: '2.0'
+info:
+  title: Acme Public API
+  description: Docs for working with normal stuff
+  version: 0.0.1
+host: api.acme.com
+basePath: /v1
+schemes:
+  - https
+produces:
+  - application/json
+paths:
+  '/login':
+    $ref: 'login.yaml'
+  '/stuff':
+    $ref: 'stuff.yaml'

pyswagger/tests/data/v2_0/ex/relative/secret_stuff.yaml

@@ -0,0 +1,18 @@
+post:
+  operationId: post_secret_stuff
+  security:
+    - session_token: []
+  description: does some secret stuff
+  parameters:
+    - name: secret_stuff_form
+      in: body
+      required: true
+      schema:
+        $ref: 'definitions/Stuff.yaml'
+  responses:
+    '200':
+      description: Results of doing the stuff
+      schema:
+        $ref: 'definitions/StuffResults.yaml'
+    '403':
+      description: Returned when token is incorrect

pyswagger/tests/data/v2_0/ex/relative/stuff.yaml

@@ -0,0 +1,18 @@
+post:
+  operationId: post_stuff
+  security:
+    - session_token: []
+  description: does some stuff
+  parameters:
+    - name: stuff_form
+      in: body
+      required: true
+      schema:
+        $ref: 'definitions/Stuff.yaml'
+  responses:
+    '200':
+      description: Results of doing the stuff
+      schema:
+        $ref: 'definitions/StuffResults.yaml'
+    '403':
+      description: Returned when token is incorrect

pyswagger/tests/data/v2_0/schema/model/swagger.json

@@ -127,7 +127,7 @@
                "xml":{
                   "name":"category"
                },
-               "$ref":"Category"
+               "$ref":"#/definitions/Category"
             },
             "name":{
                "type":"string",
@@ -153,7 +153,7 @@
                   "wrapped":true
                },
                "items":{
-                  "$ref":"Tag"
+                  "$ref":"#/definitions/Tag"
                }
             },
             "status":{
@@ -217,10 +217,10 @@
       "Employee":{
          "allOf":[
             {
-               "$ref":"User"
+               "$ref":"#/definitions/User"
             },
             {
-               "$ref":"Skill"
+               "$ref":"#/definitions/Skill"
             }
          ]
       },
@@ -232,10 +232,10 @@
          },
          "allOf":[
             {
-               "$ref":"User"
+               "$ref":"#/definitions/User"
             },
             {
-               "$ref":"Skill"
+               "$ref":"#/definitions/Skill"
             }
          ]
       },

pyswagger/tests/test_utils.py

@@ -140,14 +140,12 @@ def test_normalize_url(self):
         self.assertEqual(utils.normalize_url('/tmp/local/test in space.txt'), 'file:///tmp/local/test%20in%20space.txt')
 
     def test_normalize_jr(self):
-        self.assertEqual(utils.normalize_jr(None, ''), None)
-        self.assertEqual(utils.normalize_jr('User', '#/definitions'), '#/definitions/User')
-        self.assertEqual(utils.normalize_jr('User', '#/definitions', 'http://test.com/api'), 'http://test.com/api#/definitions/User')
-        self.assertEqual(utils.normalize_jr('#/definitions/User', '#/definitions', 'http://test.com/api'), 'http://test.com/api#/definitions/User')
-        self.assertEqual(utils.normalize_jr(
-            'http://test.com/api#/definitions/User', ''),
-            'http://test.com/api#/definitions/User'
-        )
+        self.assertEqual(utils.normalize_jr(None), None)
+        self.assertEqual(utils.normalize_jr(None, 'http://test.com/api/swagger.json'), None)
+        self.assertEqual(utils.normalize_jr('User.json', 'http://test.com/api/swagger.json'), 'http://test.com/api/User.json')
+        self.assertEqual(utils.normalize_jr('definitions/User.json', 'http://test.com/api/swagger.json'), 'http://test.com/api/definitions/User.json')
+        self.assertEqual(utils.normalize_jr('#/definitions/User', 'http://test.com/api/swagger.json'), 'http://test.com/api/swagger.json#/definitions/User')
+        self.assertEqual(utils.normalize_jr('#/definitions/User'), '#/definitions/User')
 
     def test_get_swagger_version(self):
         self.assertEqual(utils.get_swagger_version({'swaggerVersion': '1.2'}), '1.2')

pyswagger/tests/v2_0/test_ex.py

@@ -5,30 +5,26 @@
 import six
 
 
-folder = get_test_data_folder(version='2.0', which='ex')
+def _gen_hook(folder):
+    def _hook(url):
+        p = six.moves.urllib.parse.urlparse(url)
+        if p.scheme != 'file':
+            return url
 
+        path = os.path.join(folder, p.path if not p.path.startswith('/') else p.path[1:])
+        return six.moves.urllib.parse.urlunparse(p[:2]+(path,)+p[3:])
 
-def _hook(url):
-    global folder
-
-    p = six.moves.urllib.parse.urlparse(url)
-    if p.scheme != 'file':
-        return url
-
-    path = os.path.join(folder, p.path if not p.path.startswith('/') else p.path[1:])
-    return six.moves.urllib.parse.urlunparse(p[:2]+(path,)+p[3:])
+    return _hook
 
 
 class ExternalDocumentTestCase(unittest.TestCase):
     """ test case for external document """
 
     @classmethod
     def setUpClass(kls):
-        global folder
-
         kls.app = SwaggerApp.load(
             url='file:///root/swagger.json',
-            url_load_hook=_hook
+            url_load_hook=_gen_hook(get_test_data_folder(version='2.0', which='ex'))
         )
         kls.app.prepare()
 
@@ -101,3 +97,13 @@ def chk(obj):
         chk(self.app.s('relative'))
         chk(self.app.resolve('file:///root/path_item.json'))
 
+    def test_relative_schema(self):
+        """ test case for issue#53,
+        relative file, which root is a Schema Object
+        """
+        app = SwaggerApp.load(
+            url='file:///relative/internal.yaml',
+            url_load_hook=_gen_hook(get_test_data_folder(version='2.0', which='ex'))
+        )
+        app.prepare()
+