Merge pull request #137 from rafaelcaricio/fix_api_returns_flask_resp…

…onse

Fix when API returns flask response

connexion/decorators/decorator.py

@@ -12,6 +12,7 @@
 """
 import logging
 import flask
+from ..utils import is_flask_response
 
 logger = logging.getLogger('connexion.decorators.decorator')
 
@@ -32,7 +33,7 @@ def get_full_response(data):
         url = flask.request.url
         logger.debug('Getting data and status code', extra={'data': data, 'data_type': type(data), 'url': url})
         status_code, headers = 200, {}
-        if isinstance(data, flask.Response):
+        if is_flask_response(data):
             data = data
             status_code = data.status_code
             headers = data.headers

connexion/decorators/produces.py

@@ -18,6 +18,7 @@
 import json
 import logging
 from .decorator import BaseDecorator
+from ..utils import is_flask_response
 
 logger = logging.getLogger('connexion.decorators.produces')
 
@@ -83,7 +84,7 @@ def wrapper(*args, **kwargs):
             url = flask.request.url
             data, status_code, headers = self.get_full_response(function(*args, **kwargs))
             logger.debug('Returning %s', url, extra={'url': url, 'mimetype': self.mimetype})
-            if isinstance(data, flask.Response):  # if the function returns a Response object don't change it
+            if is_flask_response(data):
                 logger.debug('Endpoint returned a Flask Response', extra={'url': url, 'mimetype': data.mimetype})
                 return data
 
@@ -114,7 +115,7 @@ def wrapper(*args, **kwargs):
             url = flask.request.url
             logger.debug('Jsonifing %s', url, extra={'url': url, 'mimetype': self.mimetype})
             data, status_code, headers = self.get_full_response(function(*args, **kwargs))
-            if isinstance(data, flask.Response):  # if the function returns a Response object don't change it
+            if is_flask_response(data):
                 logger.debug('Endpoint returned a Flask Response', extra={'url': url, 'mimetype': data.mimetype})
                 return data
             elif data is NoContent:

connexion/utils.py

@@ -14,6 +14,8 @@
 import functools
 import importlib
 import re
+import flask
+import werkzeug.wrappers
 
 PATH_PARAMETER = re.compile(r'\{([^}]*)\}')
 
@@ -59,6 +61,21 @@ def flaskify_path(swagger_path, types={}):
     return PATH_PARAMETER.sub(convert_match, swagger_path)
 
 
+def is_flask_response(obj):
+    """
+    Verifies if obj is a default Flask response instance.
+
+    :type obj: object
+    :rtype bool
+
+    >>> is_flask_response(redirect('http://example.com/'))
+    True
+    >>> is_flask_response(flask.Response())
+    True
+    """
+    return isinstance(obj, flask.Response) or isinstance(obj, werkzeug.wrappers.Response)
+
+
 def deep_getattr(obj, attr):
     """
     Recurses through an attribute chain to get the ultimate value.

tests/fakeapi/api.yaml

@@ -656,6 +656,22 @@ paths:
           in: query
           required: true
 
+  /test-redirect-endpoint:
+    get:
+      summary: Tests handlers returning flask.Response objects
+      operationId: fakeapi.hello.test_redirect_endpoint
+      responses:
+        302:
+          description: 302 Found
+
+  /test-redirect-response-endpoint:
+    get:
+      summary: Tests handlers returning flask.Response objects
+      operationId: fakeapi.hello.test_redirect_response_endpoint
+      responses:
+        302:
+          description: 302 Found
+
 definitions:
   new_stack:
     type: object

tests/fakeapi/hello.py

@@ -2,6 +2,7 @@
 
 from connexion import problem, request
 from connexion import NoContent
+from flask import redirect
 
 
 class DummyClass:
@@ -234,3 +235,12 @@ def test_bool_default_param(thruthiness):
 
 def test_required_param(simple):
     return simple
+
+
+def test_redirect_endpoint():
+    headers = {'Location': 'http://www.google.com/'}
+    return '', 302, headers
+
+
+def test_redirect_response_endpoint():
+    return redirect('http://www.google.com/')

tests/test_app.py

@@ -613,3 +613,15 @@ def test_required_param_miss_config(app):
 
     resp = app_client.get('/v1.0/test-required-param')
     assert resp.status_code == 400
+
+
+def test_redirect_endpoint(app):
+    app_client = app.app.test_client()
+    resp = app_client.get('/v1.0/test-redirect-endpoint')
+    assert resp.status_code == 302
+
+
+def test_redirect_response_endpoint(app):
+    app_client = app.app.test_client()
+    resp = app_client.get('/v1.0/test-redirect-response-endpoint')
+    assert resp.status_code == 302