Merge pull request #146 from N3X15/develop

Fixes some issues on Windows

Author: mission-liao

pyswagger/consts/private.py

@@ -3,15 +3,18 @@
 
 FILE_EXT_JSON = 'json'
 FILE_EXT_YAML = 'yaml'
+FILE_EXT_YML = 'yml'
 
 VALID_FILE_EXT = [
     '.'+FILE_EXT_JSON,
     '.'+FILE_EXT_YAML,
+    '.'+FILE_EXT_YML,
 ]
 SWAGGER_FILE_NAMES = [
     'resource_list' + '.' + FILE_EXT_JSON,
     'swagger' + '.' + FILE_EXT_JSON,
     'swagger' + '.' + FILE_EXT_YAML,
+    'swagger' + '.' + FILE_EXT_YML,
 ]
 
 SCOPE_SEPARATOR = '!##!'

pyswagger/getter.py

@@ -6,6 +6,7 @@
 import six
 import os
 import logging
+import re
 
 
 logger = logging.getLogger(__name__)
@@ -64,6 +65,12 @@ class LocalGetter(Getter):
     def __init__(self, path):
         super(LocalGetter, self).__init__(path)
 
+        if path.startswith('file://'):
+            parsed = six.moves.urllib.parse.urlparse(path)
+            path = parsed.path
+        if re.match('^/[A-Z]+:', path) is not None:
+            path = os.path.abspath(path[1:])
+
         for n in private.SWAGGER_FILE_NAMES:
             if self.base_path.endswith(n):
                 self.base_path = os.path.dirname(self.base_path)
@@ -82,13 +89,14 @@ def __init__(self, path):
             # - when 'path' points to a specific file, and its
             #   extension is either 'json' or 'yaml'.
             _, ext = os.path.splitext(path)
-            for e in [private.FILE_EXT_JSON, private.FILE_EXT_YAML]:
+            for e in [private.FILE_EXT_JSON, private.FILE_EXT_YAML, private.FILE_EXT_YML]:
                 if ext.endswith(e):
                     self.base_path = os.path.dirname(path)
                     self.urls = [path]
                     break
             else:
-                for e in [private.FILE_EXT_JSON, private.FILE_EXT_YAML]:
+                for e in [private.FILE_EXT_JSON, private.FILE_EXT_YAML, private.FILE_EXT_YML]:
+                    #print(path + '.' + e)
                     if os.path.isfile(path + '.' + e):
                         self.urls = [path + '.' + e]
                         break
@@ -163,4 +171,3 @@ def load(self, path):
         logger.info('to load: [{0}]'.format(path))
 
         return self._path2dict.get(path, {})
-

pyswagger/primitives/_model.py

@@ -46,7 +46,7 @@ def apply_with(self, obj, val, ctx):
 
         not_found = set(obj.required) - set(six.iterkeys(self))
         if len(not_found):
-            raise ValueError('requirement not meet: {0}'.format(not_found))
+            raise ValueError('Model missing required key(s): {0}'.format(', '.join(not_found)))
 
         # remove assigned properties to avoid duplicated
         # primitive creation
@@ -75,7 +75,7 @@ def cleanup(self, val, ctx):
         return {}
 
     def __eq__(self, other):
-        """ equality operater, 
+        """ equality operater,
         will skip checking when both value are None or no attribute.
 
         :param other: another model
@@ -97,4 +97,3 @@ def __eq__(self, other):
 
     def __ne__(self, other):
         return not self.__eq__(other)
-

pyswagger/tests/test_utils.py

@@ -47,6 +47,12 @@ def test_json_pointer(self):
         self.assertEqual(utils.jp_split(None), [])
         self.assertEqual(utils.jp_split('/~1~0test/qq/~0test/~1test/'), ['', '/~test', 'qq', '~test', '/test', ''])
 
+
+    def test_derelativize_url(self):
+        self.assertEquals(utils.derelativise_url('https://localhost/hurf/durf.json'), 'https://localhost/hurf/durf.json')
+        self.assertEquals(utils.derelativise_url('https://localhost/hurf/./durf.json'), 'https://localhost/hurf/durf.json')
+        self.assertEquals(utils.derelativise_url('https://localhost/hurf/../durf.json'), 'https://localhost/durf.json')
+        self.assertEquals(utils.derelativise_url('https://localhost/hurf/.../durf.json'), 'https://localhost/durf.json')
     def test_scope_dict(self):
         """ ScopeDict """
         obj = {
@@ -386,4 +392,3 @@ def test_multiple_cycles_2(self):
             [2, 3, 5, 4, 2],
             [2, 3 ,4, 2]
             ]))
-

pyswagger/utils.py

@@ -297,9 +297,14 @@ def nv_tuple_list_replace(l, v):
 def path2url(p):
     """ Return file:// URL from a filename.
     """
-    return six.moves.urllib.parse.urljoin(
-        'file:', six.moves.urllib.request.pathname2url(p)
-    )
+    # Python 3 is a bit different and does a better job.
+    if sys.version_info[0] >= 3:
+        import pathlib
+        return pathlib.Path(p).as_uri()
+    else:
+        return six.moves.urllib.parse.urljoin(
+            'file:', six.moves.urllib.request.pathname2url(p)
+        )
 
 def normalize_url(url):
     """ Normalize url
@@ -334,9 +339,10 @@ def url_join(url, path):
     """ url version of os.path.join
     """
     p = six.moves.urllib.parse.urlparse(url)
+    t = ('/'.join([p.path, path]),)
     return six.moves.urllib.parse.urlunparse(
         p[:2]+
-        (os.path.join(p.path, path),)+
+        t+ # os.sep is different on windows, don't use it here.
         p[3:]
     )
 
@@ -366,7 +372,8 @@ def normalize_jr(jr, url=None):
         if p.scheme == '' and url:
             p = six.moves.urllib.parse.urlparse(url)
             # it's the path of relative file
-            path = six.moves.urllib.parse.urlunparse(p[:2]+(os.path.join(os.path.dirname(p.path), path),)+p[3:])
+            path = six.moves.urllib.parse.urlunparse(p[:2]+('/'.join([os.path.dirname(p.path), path]),)+p[3:])
+            path = derelativise_url(path)
     else:
         path = url
 
@@ -375,6 +382,26 @@ def normalize_jr(jr, url=None):
     else:
         return '#' + jp
 
+def derelativise_url(url):
+    '''
+    Normalizes URLs, gets rid of .. and .
+    '''
+    parsed = six.moves.urllib.parse.urlparse(url)
+    newpath=[]
+    for chunk in parsed.path[1:].split('/'):
+        if chunk == '.':
+            continue
+        elif chunk == '..':
+            # parent dir.
+            newpath=newpath[:-1]
+            continue
+        # TODO: Verify this behaviour.
+        elif re.fullmatch(r'\.{3,}', chunk) is not None:
+            # parent dir.
+            newpath=newpath[:-1]
+            continue
+        newpath += [chunk]
+    return six.moves.urllib.parse.urlunparse(parsed[:2]+('/'+('/'.join(newpath)),)+parsed[3:])
 def is_file_url(url):
     return url.startswith('file://')
 
@@ -549,4 +576,3 @@ def patch_path(base_path, path):
         path = path[1:]
 
     return path
-