Filter request and/or response headers by configuration

New configuration variables:
- response_headers_to_include
- request_headers_to_include

Author: Ken Mayer

README.md

@@ -102,7 +102,13 @@ RspecApiDocumentation.configure do |config|
   # Allows you to filter out headers that are not needed in the cURL request,
   # such as "Host" and "Cookie". Set as an array.
   config.curl_headers_to_filter = nil
-  
+
+  # By default, when these settings are nil, all headers are shown,
+  # which is sometimes too chatty. Setting the parameters to an
+  # array of headers will render *only* those headers.
+  config.request_headers_to_include = nil
+  config.response_headers_to_include = nil
+
   # By default examples and resources are ordered by description. Set to true keep
   # the source order.
   config.keep_source_order = false

features/html_documentation.feature

@@ -21,6 +21,8 @@ Feature: Generate HTML documentation from test examples
       RspecApiDocumentation.configure do |config|
         config.app = App
         config.api_name = "Example API"
+        config.request_headers_to_include = %w[Cookie]
+        config.response_headers_to_include = %w[Content-Type]
       end
 
       resource "Greetings" do
@@ -70,8 +72,9 @@ Feature: Generate HTML documentation from test examples
     And   I navigate to "Greeting your favorite gem"
     Then  I should see the route is "GET /greetings?target=rspec_api_documentation"
     And   I should see the following request headers:
-      | Host   | example.org |
       | Cookie |             |
+    And   I should not see the following request headers:
+      | Host   | example.org |
     And   I should see the following query parameters:
       | target | rspec_api_documentation |
 
@@ -81,6 +84,7 @@ Feature: Generate HTML documentation from test examples
     Then  I should see the response status is "200 OK"
     And   I should see the following response headers:
       | Content-Type   | application/json |
+    And   I should not see the following response headers:
       | Content-Length | 35               |
     And   I should see the following response body:
       """

features/step_definitions/html_steps.rb

@@ -26,6 +26,15 @@
   end
 end
 
+Then /^I should not see the following (request|response) headers:$/ do |part, table|
+  actual_headers = page.find("pre.#{part}.headers").text
+  expected_headers = table.raw.map { |row| row.join(": ") }
+
+  expected_headers.each do |row|
+    actual_headers.should_not include(row.strip)
+  end
+end
+
 Then /^I should see the route is "([^"]*)"$/ do |route|
   page.should have_css(".request.route", :text => route)
 end

lib/rspec_api_documentation/configuration.rb

@@ -59,6 +59,8 @@ def self.add_setting(name, opts = {})
     add_setting :keep_source_order, :default => false
     add_setting :api_name, :default => "API Documentation"
     add_setting :io_docs_protocol, :default => "http"
+    add_setting :request_headers_to_include, :default => nil
+    add_setting :response_headers_to_include, :default => nil
 
     def client_method=(new_client_method)
       RspecApiDocumentation::DSL::Resource.module_eval <<-RUBY

lib/rspec_api_documentation/views/markup_example.rb

@@ -7,6 +7,8 @@ def initialize(example, configuration)
         @example = example
         @host = configuration.curl_host
         @filter_headers = configuration.curl_headers_to_filter
+        @request_headers_to_include = configuration.request_headers_to_include
+        @response_headers_to_include = configuration.response_headers_to_include
         self.template_path = configuration.template_path
       end
 
@@ -30,9 +32,9 @@ def filename
 
       def requests
         super.map do |hash|
-          hash[:request_headers_text] = format_hash(hash[:request_headers])
+          hash[:request_headers_text] = format_hash(filter_hash(hash[:request_headers], @request_headers_to_include))
           hash[:request_query_parameters_text] = format_hash(hash[:request_query_parameters])
-          hash[:response_headers_text] = format_hash(hash[:response_headers])
+          hash[:response_headers_text] = format_hash(filter_hash(hash[:response_headers], @response_headers_to_include))
           if @host
             if hash[:curl].is_a? RspecApiDocumentation::Curl
               hash[:curl] = hash[:curl].output(@host, @filter_headers)
@@ -56,6 +58,11 @@ def format_hash(hash = {})
           "#{k}: #{v}"
         end.join("\n")
       end
+
+      def filter_hash(hash = {}, selection_set = nil)
+        return hash unless selection_set
+        hash.select{ |key, value| selection_set.include?(key) }
+      end
     end
   end
 end

spec/configuration_spec.rb

@@ -54,6 +54,8 @@
     its(:api_name) { should == "API Documentation" }
     its(:client_method) { should == :client }
     its(:io_docs_protocol) { should == "http" }
+    its(:request_headers_to_include) { should be_nil }
+    its(:response_headers_to_include) { should be_nil }
   end
 
   describe "#define_groups" do