Add support for parsing YAML specs #198
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| version = '8.1.0' |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,10 @@ | |
| import contextlib | ||
| import logging | ||
| import os | ||
| import os.path | ||
| import yaml | ||
|
|
||
| from bravado_core.spec import is_yaml | ||
| from six.moves import urllib | ||
| from six.moves.urllib import parse as urlparse | ||
|
|
||
|
|
@@ -24,22 +27,25 @@ class FileEventual(object): | |
| class FileResponse(object): | ||
|
|
||
| def __init__(self, data): | ||
| self.text = data | ||
| self.headers = {} | ||
|
|
||
| def json(self): | ||
| return json.loads(self.text) | ||
|
|
||
| def __init__(self, path): | ||
| self.path = path | ||
| self.is_yaml = is_yaml(path) | ||
|
|
||
| def get_path(self): | ||
| if not self.path.endswith('.json') and not self.is_yaml: | ||
| return self.path + '.json' | ||
| return self.path | ||
|
|
||
| def wait(self, timeout=None): | ||
| with contextlib.closing(urllib.request.urlopen(self.get_path())) as fp: | ||
| content = fp.read() | ||
| return self.FileResponse(content) | ||
|
|
||
| def result(self, *args, **kwargs): | ||
| return self.wait(*args, **kwargs) | ||
|
|
@@ -86,12 +92,40 @@ def load_spec(self, spec_url, base_url=None): | |
| :param base_url: TODO: need this? | ||
| :returns: json spec in dict form | ||
| """ | ||
| response = request( | ||
| self.http_client, | ||
| spec_url, | ||
| self.request_headers, | ||
| ).result() | ||
|
|
||
| content_type = response.headers.get('content-type', '').lower() | ||
| if is_yaml(spec_url, content_type): | ||
| return self.load_yaml(response.text) | ||
| else: | ||
| return response.json() | ||
|
|
||
| def load_yaml(self, text): | ||
| """Load a YAML Swagger spec from the given string, transforming | ||
|
Contributor
There was a problem hiding this comment. This suggests to me that your YAML spec is incorrect, we shouldn't need to cast these to string. Need to wrap in quotes.
Contributor
There was a problem hiding this comment. Ahh, gotcha, sounds like specs out there aren't well formed in general and yaml might be inconsistent. Cool |
||
| integer response status codes to strings. This is to keep | ||
| compatibility with the existing YAML spec examples in | ||
| https://github.com/OAI/OpenAPI-Specification/tree/master/examples/v2.0/yaml | ||
| :param text: String from which to parse the YAML. | ||
| :type text: basestring | ||
| :return: Python dictionary representing the spec. | ||
| :raise: yaml.parser.ParserError: If the text is not valid YAML. | ||
| """ | ||
| data = yaml.load(text) | ||
| for path, methods in iter(data.get('paths', {}).items()): | ||
| for method, operation in iter(methods.items()): | ||
| if 'responses' in operation: | ||
| operation['responses'] = dict( | ||
| (str(code), response) | ||
| for code, response in iter( | ||
| operation['responses'].items() | ||
| ) | ||
| ) | ||
|
|
||
| return data | ||
|
|
||
|
|
||
| # TODO: Adding the file scheme here just adds complexity to request() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we just load them all as if they're yaml? Json is just a yaml subset
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes but YAML is not a JSON subset, we'd be potentially parsing/ingesting files that are not valid JSON.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm I guess that's fair.