Better name for swagger schema setting key, and fix tween.load_settin…

…gs()
Yelp · Feb 20, 2015 · bb38a7f · bb38a7f
1 parent a72a1f4
commit bb38a7f
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 43 deletions.
diff --git a/pyramid_swagger/__init__.py b/pyramid_swagger/__init__.py
@@ -4,19 +4,26 @@
 """
 import pyramid
 from .api import register_api_doc_endpoints
-from .ingest import add_swagger_schema
+from .ingest import (
+    compile_swagger_schema,
+    validate_swagger_schema,
+)
 
 
 def includeme(config):
-    add_swagger_schema(config.registry)
+    settings = config.registry.settings
+    schema_dir = settings.get('pyramid_swagger.schema_directory', 'api_docs/')
+
+    if settings.get('pyramid_swagger.enable_swagger_spec_validation', True):
+        validate_swagger_schema(schema_dir)
+
+    if 'pyramid_swagger.schema' not in settings:
+        settings['pyramid_swagger.schema'] = compile_swagger_schema(schema_dir)
 
     config.add_tween(
         "pyramid_swagger.tween.validation_tween_factory",
         under=pyramid.tweens.EXCVIEW
     )
 
-    if config.registry.settings.get(
-        'pyramid_swagger.enable_api_doc_views',
-        True
-    ):
+    if settings.get('pyramid_swagger.enable_api_doc_views', True):
         register_api_doc_endpoints(config)
diff --git a/pyramid_swagger/api.py b/pyramid_swagger/api.py
@@ -7,7 +7,7 @@
 
 def register_api_doc_endpoints(config):
     """Create and register pyramid endpoints for /api-docs*."""
-    swagger_schema = config.registry.settings['swagger_schema']
+    swagger_schema = config.registry.settings['pyramid_swagger.schema']
     with open(swagger_schema.resource_listing) as input_file:
         register_resource_listing(config, simplejson.load(input_file))
 

diff --git a/pyramid_swagger/ingest.py b/pyramid_swagger/ingest.py
@@ -77,31 +77,14 @@ def compile_swagger_schema(schema_dir):
 
 
 # TODO: more test cases
-def add_swagger_schema(registry):
-    """Add the swagger_schema to the registry.settings
-    """
-    schema_dir = registry.settings.get(
-        'pyramid_swagger.schema_directory',
-        'api_docs/'
-    )
-    if registry.settings.get(
-        'pyramid_swagger.enable_swagger_spec_validation',
-        True
-    ):
-        listing_filename = os.path.join(schema_dir, API_DOCS_FILENAME)
-        # TODO: this will be replaced by ssv shortly
-        listing_json = _load_resource_listing(listing_filename)
-        mapping = build_schema_mapping(schema_dir, listing_json)
-        validate_swagger_schemas(listing_filename, mapping.values())
-
-    # TODO: docs for this
-    if registry.settings.get(
-        'pyramid_swagger.enable_build_swagger_schema_model',
-        True
-    ):
-        registry.settings['swagger_schema'] = (
-            compile_swagger_schema(schema_dir)
-        )
+def validate_swagger_schema(schema_dir):
+    """Add the swagger_schema to the registry.settings """
+    listing_filename = os.path.join(schema_dir, API_DOCS_FILENAME)
+    # TODO: this will be replaced by ssv shortly
+    listing_json = _load_resource_listing(listing_filename)
+    mapping = build_schema_mapping(schema_dir, listing_json)
+    validate_swagger_schemas(listing_filename, mapping.values())
+
 
 
 def ingest_resources(mapping, schema_dir):

diff --git a/pyramid_swagger/tween.py b/pyramid_swagger/tween.py
@@ -28,8 +28,7 @@
 class Settings(namedtuple(
     'Settings',
     [
-        'schema_dir',
-        'validate_swagger_spec',
+        'schema',
         'validate_request',
         'validate_response',
         'validate_path',
@@ -84,7 +83,6 @@ def validation_tween_factory(handler, registry):
     while delegating to the relevant matching view.
     """
     settings = load_settings(registry)
-    schema = registry.settings['swagger_schema']
     route_mapper = registry.queryUtility(IRoutesMapper)
     disable_all_validation = not any((
         settings.validate_request,
@@ -100,8 +98,10 @@ def validator_tween(request):
         validation_context = _get_validation_context(registry)
 
         try:
-            schema_data, resolver = schema.schema_and_resolver_for_request(
-                request)
+            (
+                schema_data,
+                resolver
+            ) = settings.schema.schema_and_resolver_for_request(request)
         except PathNotMatchedError as exc:
             if settings.validate_path:
                 with validation_context(request):
@@ -134,10 +134,8 @@ def validator_tween(request):
 
 
 def load_settings(registry):
-    # TODO: remove these unused settings
     return Settings(
-        None,
-        None,
+        schema=registry.settings['pyramid_swagger.schema'],
         validate_request=registry.settings.get(
             'pyramid_swagger.enable_request_validation',
             True

diff --git a/tests/acceptance/response_test.py b/tests/acceptance/response_test.py
@@ -50,7 +50,7 @@ def handler(request):
         return response or Response()
 
     settings = dict({
-        'swagger_schema': compile_swagger_schema(
+        'pyramid_swagger.schema': compile_swagger_schema(
             'tests/sample_schemas/good_app/'),
         'pyramid_swagger.enable_swagger_spec_validation': False},
         **overrides

diff --git a/tests/includeme_test.py b/tests/includeme_test.py
@@ -6,11 +6,12 @@
 
 
 @mock.patch('pyramid_swagger.register_api_doc_endpoints')
-def test_disable_api_doc_views(mock_register):
+@mock.patch('pyramid_swagger.ingest.compile_swagger_schema')
+def test_disable_api_doc_views(_ ,mock_register):
     settings = {
         'pyramid_swagger.enable_api_doc_views': False,
         'pyramid_swagger.enable_swagger_spec_validation': False,
-        'pyramid_swagger.enable_build_swagger_schema_model': False,
+        'pyramid_swagger.schema': None,
     }
     mock_config = mock.Mock(registry=mock.Mock(settings=settings))
     pyramid_swagger.includeme(mock_config)