Fix API blueprint documentation.

FabienChaynes · FabienChaynes · commit b57259d9b09e · 2018-02-08T15:06:03.000+01:00
- Remove Content-Type header from the Header sections
diff --git a/lib/rspec_api_documentation/views/api_blueprint_example.rb b/lib/rspec_api_documentation/views/api_blueprint_example.rb
@@ -20,14 +20,14 @@ def parameters
 
       def requests
         super.map do |request|
-          request[:request_headers_text]  = remove_utf8_for_json(request[:request_headers_text])
+          request[:request_headers_text]  = remove_utf8_for_json(remove_content_type(request[:request_headers_text]))
           request[:request_headers_text]  = indent(request[:request_headers_text])
           request[:request_content_type]  = content_type(request[:request_headers])
           request[:request_content_type]  = remove_utf8_for_json(request[:request_content_type])
           request[:request_body]          = body_to_json(request, :request)
           request[:request_body]          = indent(request[:request_body])
 
-          request[:response_headers_text] = remove_utf8_for_json(request[:response_headers_text])
+          request[:response_headers_text] = remove_utf8_for_json(remove_content_type(request[:response_headers_text]))
           request[:response_headers_text] = indent(request[:response_headers_text])
           request[:response_content_type] = content_type(request[:response_headers])
           request[:response_content_type] = remove_utf8_for_json(request[:response_content_type])
@@ -78,6 +78,18 @@ def body_to_json(http_call, message_direction)
         body
       end
 
+      # `Content-Type` header is removed because the information would be duplicated
+      # since it's already present in `request[:request_content_type]`.
+      def remove_content_type(headers)
+        return unless headers
+        headers
+          .split("\n")
+          .reject { |header|
+            header.start_with?('Content-Type:')
+          }
+          .join("\n")
+      end
+
       # JSON requests should use UTF-8 by default according to
       # http://www.ietf.org/rfc/rfc4627.txt, so we will remove `charset=utf-8`
       # when we find it to remove noise.
diff --git a/spec/views/api_blueprint_example_spec.rb b/spec/views/api_blueprint_example_spec.rb
@@ -57,17 +57,9 @@
     describe 'request_headers_text' do
       subject { view.requests[0][:request_headers_text] }
 
-      context 'when charset=utf-8 is present' do
-        it "just strips that because it's the default for json" do
-          expect(subject).to eq "Content-Type: application/json\n            Another: header; charset=utf-8"
-        end
-      end
-
-      context 'when charset=utf-16 is present' do
-        let(:content_type) { "application/json; charset=utf-16" }
-
-        it "keeps that because it's NOT the default for json" do
-          expect(subject).to eq "Content-Type: application/json; charset=utf-16\n            Another: header; charset=utf-8"
+      context 'when Content-Type is present' do
+        it "removes it" do
+          expect(subject).to eq "Another: header; charset=utf-8"
         end
       end
     end
@@ -93,17 +85,9 @@
     describe 'response_headers_text' do
       subject { view.requests[0][:response_headers_text] }
 
-      context 'when charset=utf-8 is present' do
-        it "just strips that because it's the default for json" do
-          expect(subject).to eq "Content-Type: application/json\n            Another: header; charset=utf-8"
-        end
-      end
-
-      context 'when charset=utf-16 is present' do
-        let(:content_type) { "application/json; charset=utf-16" }
-
-        it "keeps that because it's NOT the default for json" do
-          expect(subject).to eq "Content-Type: application/json; charset=utf-16\n            Another: header; charset=utf-8"
+      context 'when Content-Type is present' do
+        it "removes it" do
+          expect(subject).to eq "Another: header; charset=utf-8"
         end
       end
     end
