If test client encounters ASCII_8BIT data, mark it as binary

Do not display binary data in generated documentation. Closes #199.

Author: oestrich

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] = response_body.empty? ? nil : response_body
+      request_metadata[:response_body] = record_response_body(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,6 +85,15 @@ def headers(method, path, params, request_headers)
       request_headers || {}
     end
 
+    def record_response_body(response_body)
+      return nil if response_body.empty?
+      if response_body.encoding == Encoding::ASCII_8BIT
+        "[binary data]"
+      else
+        response_body
+      end
+    end
+
     def clean_out_uploaded_data(params, request_body)
       params.each do |_, value|
         if value.is_a?(Hash)

spec/rack_test_client_spec.rb

@@ -93,6 +93,12 @@
         expect(metadata[:curl]).to eq(RspecApiDocumentation::Curl.new("POST", "/greet?query=test+query", post_data, {"Content-Type" => "application/json;charset=utf-8", "X-Custom-Header" => "custom header value", "Host" => "example.org", "Cookie" => ""}))
       end
 
+      specify "fetching binary data" do |example|
+        test_client.get "/binary"
+        metadata = example.metadata[:requests].last
+        expect(metadata[:response_body]).to eq("[binary data]")
+      end
+
       context "when post data is not json" do
         let(:post_data) { { :target => "nurse", :email => "[email protected]" } }
 

spec/support/stub_app.rb

@@ -23,4 +23,9 @@ class StubApp < Sinatra::Base
 
     "<hello>World</hello>"
   end
+
+  get '/binary' do
+    content_type 'application/octet-stream'
+    "\x01\x02\x03".force_encoding(Encoding::ASCII_8BIT)
+  end
 end