If test client encounters JSON in the body, pretty print it.

Closes #212

Author: oestrich

features/html_documentation.feature

@@ -97,5 +97,5 @@ Feature: Generate HTML documentation from test examples
       | Content-Length | 35               |
     And   I should see the following response body:
       """
-      {"hello":"rspec_api_documentation"}
+      { "hello": "rspec_api_documentation" }
       """

features/markdown_documentation.feature

@@ -199,7 +199,21 @@ Feature: Generate Markdown documentation from test examples
 
     #### Body
 
-    <pre>{"page":1,"orders":[{"name":"Order 1","amount":9.99,"description":null},{"name":"Order 2","amount":100.0,"description":"A great order"}]}</pre>
+    <pre>{
+      "page": 1,
+      "orders": [
+        {
+          "name": "Order 1",
+          "amount": 9.99,
+          "description": null
+        },
+        {
+          "name": "Order 2",
+          "amount": 100.0,
+          "description": "A great order"
+        }
+      ]
+    }</pre>
 
     """
 

features/textile_documentation.feature

@@ -199,7 +199,21 @@ Feature: Generate Textile documentation from test examples
 
     h4. Body
 
-    <pre>{"page":1,"orders":[{"name":"Order 1","amount":9.99,"description":null},{"name":"Order 2","amount":100.0,"description":"A great order"}]}</pre>
+    <pre>{
+      "page": 1,
+      "orders": [
+        {
+          "name": "Order 1",
+          "amount": 9.99,
+          "description": null
+        },
+        {
+          "name": "Order 2",
+          "amount": 100.0,
+          "description": "A great order"
+        }
+      ]
+    }</pre>
 
 
     """

lib/rspec_api_documentation/client_base.rb

@@ -68,7 +68,7 @@ def document_example(method, path)
       request_metadata[:request_content_type] = request_content_type
       request_metadata[:response_status] = status
       request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[status]
-      request_metadata[:response_body] = record_response_body(response_body)
+      request_metadata[:response_body] = record_response_body(response_content_type, response_body)
       request_metadata[:response_headers] = response_headers
       request_metadata[:response_content_type] = response_content_type
       request_metadata[:curl] = Curl.new(method, path, request_body, request_headers)
@@ -85,10 +85,12 @@ def headers(method, path, params, request_headers)
       request_headers || {}
     end
 
-    def record_response_body(response_body)
+    def record_response_body(response_content_type, response_body)
       return nil if response_body.empty?
       if response_body.encoding == Encoding::ASCII_8BIT
         "[binary data]"
+      elsif response_content_type =~ /application\/json/
+        JSON.pretty_generate(JSON.parse(response_body))
       else
         response_body
       end

spec/rack_test_client_spec.rb

@@ -99,6 +99,13 @@
         expect(metadata[:response_body]).to eq("[binary data]")
       end
 
+      specify "fetching json data" do |example|
+        metadata = example.metadata[:requests].first
+        expect(metadata[:response_body]).to eq(JSON.pretty_generate({
+          :hello => "nurse",
+        }))
+      end
+
       context "when post data is not json" do
         let(:post_data) { { :target => "nurse", :email => "email@example.com" } }