Filter request and/or response headers by configuration

New configuration variables:
- response_headers_to_include
- request_headers_to_include

Author: Ken Mayer

features/combined_json.feature

@@ -24,6 +24,8 @@ Feature: Combined text
       RspecApiDocumentation.configure do |config|
         config.app = App
         config.format = :combined_json
+        config.request_headers_to_include = %w[Host]
+        config.response_headers_to_include = %w[Content-Type]
       end
 
       resource "Greetings" do
@@ -84,8 +86,7 @@ Feature: Combined text
             "request_path": "/greetings?target=rspec_api_documentation",
             "request_body": null,
             "request_headers": {
-              "Host": "example.org",
-              "Cookie": ""
+              "Host": "example.org"
             },
             "request_query_parameters": {
               "target": "rspec_api_documentation"
@@ -95,8 +96,7 @@ Feature: Combined text
             "response_status_text": "OK",
             "response_body": "Hello, rspec_api_documentation!",
             "response_headers": {
-              "Content-Type": "text/plain",
-              "Content-Length": "31"
+              "Content-Type": "text/plain"
             },
             "response_content_type": "text/plain",
             "curl": null
@@ -121,8 +121,7 @@ Feature: Combined text
             "request_path": "/greetings?target=Sam+%26+Eric",
             "request_body": null,
             "request_headers": {
-              "Host": "example.org",
-              "Cookie": ""
+              "Host": "example.org"
             },
             "request_query_parameters": {
               "target": "Sam & Eric"
@@ -132,8 +131,7 @@ Feature: Combined text
             "response_status_text": "OK",
             "response_body": "Hello, Sam & Eric!",
             "response_headers": {
-              "Content-Type": "text/plain",
-              "Content-Length": "18"
+              "Content-Type": "text/plain"
             },
             "response_content_type": "text/plain",
             "curl": null

features/textile_documentation.feature

@@ -45,6 +45,8 @@ Feature: Generate Textile documentation from test examples
         config.app = App
         config.api_name = "Example API"
         config.format = :textile
+        config.request_headers_to_include = %w[Content-Type Host]
+        config.response_headers_to_include = %w[Content-Type Content-Length]
       end
 
       resource 'Orders' do
@@ -180,8 +182,7 @@ Feature: Generate Textile documentation from test examples
     h4. Headers
 
     <pre>Host: example.org
-    Content-Type: application/x-www-form-urlencoded
-    Cookie: </pre>
+    Content-Type: application/x-www-form-urlencoded</pre>
 
     h4. Route
 
@@ -198,10 +199,7 @@ Feature: Generate Textile documentation from test examples
     h4. Headers
 
     <pre>Content-Type: text/html;charset=utf-8
-    Content-Length: 0
-    X-XSS-Protection: 1; mode=block
-    X-Content-Type-Options: nosniff
-    X-Frame-Options: SAMEORIGIN</pre>
+    Content-Length: 0</pre>
 
     h4. Status
 

lib/rspec_api_documentation/example.rb

@@ -43,7 +43,29 @@ def explanation
     end
 
     def requests
-      metadata[:requests] || []
+      filter_headers(metadata[:requests]) || []
+    end
+
+    private
+
+    def filter_headers(requests)
+      requests = remap_headers(requests, :request_headers, configuration.request_headers_to_include)
+      requests = remap_headers(requests, :response_headers, configuration.response_headers_to_include)
+      requests
+    end
+
+    def remap_headers(requests, key, headers_to_include)
+      requests.each.with_index do |request_hash, index|
+        next unless request_hash.key?(key)
+        headers = request_hash[key]
+        request_hash[key] = filter_hash(headers, headers_to_include)
+        requests[index] = request_hash
+      end
+    end
+
+    def filter_hash(hash = {}, selection_set = nil)
+      return hash unless selection_set
+      hash.select{ |key, _| selection_set.include?(key) }
     end
   end
 end

lib/rspec_api_documentation/views/markup_example.rb

@@ -7,8 +7,6 @@ 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
 
@@ -32,9 +30,9 @@ def filename
 
       def requests
         super.map do |hash|
-          hash[:request_headers_text] = format_hash(filter_hash(hash[:request_headers], @request_headers_to_include))
+          hash[:request_headers_text] = format_hash(hash[:request_headers])
           hash[:request_query_parameters_text] = format_hash(hash[:request_query_parameters])
-          hash[:response_headers_text] = format_hash(filter_hash(hash[:response_headers], @response_headers_to_include))
+          hash[:response_headers_text] = format_hash(hash[:response_headers])
           if @host
             if hash[:curl].is_a? RspecApiDocumentation::Curl
               hash[:curl] = hash[:curl].output(@host, @filter_headers)
@@ -58,11 +56,6 @@ 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/example_spec.rb

@@ -159,4 +159,82 @@
       example.explanation.should == nil
     end
   end
+
+  describe "request headers can be filtered" do
+    before do
+      configuration.request_headers_to_include = %w[Included]
+      metadata[:requests] = [
+          {
+              :request_headers => {
+                  "Included" => "data",
+                  "Filtered" => "not seen"
+              },
+              :request_method => "GET"
+          },
+          {
+              :request_headers => {
+                  "Included" => "data",
+                  "Other" => "not seen"
+              },
+              :request_method => "GET"
+          }
+      ]
+    end
+
+    it "should filter out anything not explicitly mentioned" do
+      subject.requests.should == [
+          {
+              :request_headers => {
+                  "Included" => "data",
+              },
+              :request_method => "GET"
+          },
+          {
+              :request_headers => {
+                  "Included" => "data",
+              },
+              :request_method => "GET"
+          }
+      ]
+    end
+  end
+
+  describe "response headers can be filtered" do
+    before do
+      configuration.response_headers_to_include = %w[Included]
+      metadata[:requests] = [
+          {
+              :response_headers => {
+                  "Included" => "data",
+                  "Filtered" => "not seen"
+              },
+              :request_method => "GET"
+          },
+          {
+              :response_headers => {
+                  "Included" => "data",
+                  "Other" => "not seen"
+              },
+              :request_method => "GET"
+          }
+      ]
+    end
+
+    it "should filter out anything not explicitly mentioned" do
+      subject.requests.should == [
+          {
+              :response_headers => {
+                  "Included" => "data",
+              },
+              :request_method => "GET"
+          },
+          {
+              :response_headers => {
+                  "Included" => "data",
+              },
+              :request_method => "GET"
+          }
+      ]
+    end
+  end
 end