Added middleware for Django developer toolbar to be print JSON as HTM…

…L, which enables the toolbar for API calls. Append an empty query parameter to an API call like so: http://192.168.50.50:8000/api/v1/data_sets/?format=json&debug
refinery-platform · Jun 25, 2015 · b57277e · b57277e · hackdna · Jun 25, 2015
1 parent 0c44885
commit b57277e
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 1 deletion.
diff --git a/refinery/middleware.py b/refinery/middleware.py
@@ -0,0 +1,33 @@
+class JsonAsHTML(object):
+    """
+    View a JSON response in your browser as HTML if the request has a `debug`
+    query parameter
+    E.g. http://192.168.50.50:8000/api/v1/data_sets/?format=json&debug
+
+    Useful for viewing stats using Django Debug Toolbar
+
+    This middleware should be place AFTER Django Debug Toolbar middleware
+    """
+
+    def process_response(self, request, response):
+
+        # not for production or production like environment
+        if request.GET.get('debug') != '':
+            return response
+
+        # do nothing for actual ajax requests
+        if request.is_ajax():
+            return response
+
+        # only do something if this is a json response
+        if "application/json" in response['Content-Type'].lower():
+            title = "JSON as HTML Middleware for: %s" % request.get_full_path()
+            response.content = (
+                "<html><head><title>{title}</title></head><body><pre>{body}"
+                "</pre></body></html>".format(
+                    title=title,
+                    body=response.content
+                )
+            )
+            response['Content-Type'] = 'text/html'
+        return response
diff --git a/refinery/settings.py b/refinery/settings.py
@@ -214,8 +214,9 @@ def get_setting(name, settings=local_settings):
     )
     MIDDLEWARE_CLASSES += (
         'debug_toolbar.middleware.DebugToolbarMiddleware',
+        'middleware.JsonAsHTML',
     )
-    INTERNAL_IPS = ('192.168.50.1' )
+    INTERNAL_IPS = ('192.168.50.1')
 
 
 # NG: added for django-guardian