Allow users to define a proc that formats their response body. Similar to the post_body_formatter configuration.

Maintains backwards compatibility with pretty formatting content-types of `application/json`

the JSON API spec uses `application/vnd.api+json`
http://jsonapi.org/extensions/#extension-negotiation

Author: galiat

README.md

@@ -138,7 +138,12 @@ RspecApiDocumentation.configure do |config|
 
   # Change how the post body is formatted by default, you can still override by `raw_post`
   # Can be :json, :xml, or a proc that will be passed the params
-  config.post_body_formatter = Proc.new { |params| params }
+  config.response_body_formatter = Proc.new { |params| params }
+
+  # Change how the response body is formatted by default
+  # Is proc that will be called with the response_content_type & response_body
+  # by default response_content_type of `application/json` are pretty formated.
+  config.post_body_formatter = Proc.new { |response_content_type, response_body| response_body }
 
   # Change the embedded style for HTML output. This file will not be processed by
   # RspecApiDocumentation and should be plain CSS.

lib/rspec_api_documentation/client_base.rb

@@ -89,10 +89,9 @@ 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
+        formatter = RspecApiDocumentation.configuration.response_body_formatter
+        return formatter.call(response_content_type, response_body)
       end
     end
 

lib/rspec_api_documentation/configuration.rb

@@ -93,6 +93,27 @@ def self.add_setting(name, opts = {})
     # See RspecApiDocumentation::DSL::Endpoint#do_request
     add_setting :post_body_formatter, :default => Proc.new { |_| Proc.new { |params| params } }
 
+    # Change how the response body is formatted
+    # Can be a proc that will be passed the response body
+    #
+    #   RspecApiDocumentation.configure do |config|
+    #     config.response_body_formatter = Proc.new do |content_type, response_body|
+    #       # convert to whatever you want
+    #       response_body
+    #     end
+    #   end
+    #
+    # See RspecApiDocumentation::DSL::Endpoint#do_request
+    add_setting :response_body_formatter, default: Proc.new { |_, _|
+      Proc.new do |content_type, response_body|
+        if content_type =~ /application\/json/
+          JSON.pretty_generate(JSON.parse(response_body))
+        else
+          response_body
+        end
+      end
+    }
+
     def client_method=(new_client_method)
       RspecApiDocumentation::DSL::Resource.module_eval <<-RUBY
         alias :#{new_client_method} #{client_method}

spec/http_test_client_spec.rb

@@ -133,4 +133,29 @@
       end
     end
   end
+
+  context "formating response body", :document => true do
+    after do
+      RspecApiDocumentation.instance_variable_set(:@configuration, RspecApiDocumentation::Configuration.new)
+    end
+
+    before do
+      RspecApiDocumentation.configure do |config|
+        config.response_body_formatter =
+          Proc.new do |_, response_body|
+            response_body.upcase
+          end
+      end
+      test_client.post "/greet?query=test+query", post_data, headers
+    end
+
+    let(:post_data) { { :target => "nurse" }.to_json }
+    let(:headers) { { "Content-Type" => "application/json;charset=utf-8", "X-Custom-Header" => "custom header value" } }
+
+    it "it formats the response_body based on the defined proc" do |example|
+      metadata = example.metadata[:requests].first
+      expect(metadata[:response_body]).to be_present
+      expect(metadata[:response_body]).to eq '{"HELLO":"NURSE"}'
+    end
+  end
 end

spec/rack_test_client_spec.rb

@@ -106,6 +106,17 @@
         }))
       end
 
+      context "when request uses jsonapi spec" do
+        let(:headers) { { "Content-Type" => "application/vnd.api+json; supported-ext='bulk,jsonpatch'", "X-Custom-Header" => "custom header value" } }
+
+        it "fetching json data" do |example|
+          metadata = example.metadata[:requests].first
+          expect(metadata[:response_body]).to eq(JSON.pretty_generate({
+            :hello => "nurse",
+          }))
+        end
+      end
+
       context "when post data is not json" do
         let(:post_data) { { :target => "nurse", :email => "[email protected]" } }