Conform request metadata keys

Author: oestrich

lib/rspec_api_documentation/test_client.rb

@@ -70,8 +70,8 @@ def document_example(method, action, params)
 
       request_metadata = {}
 
-      request_metadata[:method] = method.to_s.upcase
-      request_metadata[:route] = action
+      request_metadata[:request_method] = method.to_s.upcase
+      request_metadata[:request_path] = action
       request_metadata[:request_body] = highlight_syntax(request_body, last_request.content_type, true)
       request_metadata[:request_headers] = format_headers(last_headers)
       request_metadata[:request_query_parameters] = format_query_hash(last_query_hash)

lib/rspec_api_documentation/test_server.rb

@@ -8,8 +8,8 @@ def call(env)
 
       request_metadata = {}
 
-      request_metadata[:method] = env["REQUEST_METHOD"]
-      request_metadata[:route] = env["PATH_INFO"]
+      request_metadata[:request_method] = env["REQUEST_METHOD"]
+      request_metadata[:request_path] = env["PATH_INFO"]
       request_metadata[:request_body] = prettify_json(env["rack.input"].read)
       request_metadata[:request_headers] = headers(env)
 

spec/test_client_spec.rb

@@ -147,8 +147,8 @@ class StubApp < Sinatra::Base
     context "when examples should be documented", :document => true do
       it "should augment the metadata with information about the request" do
         metadata = example.metadata[:requests].first
-        metadata[:method].should eq("POST")
-        metadata[:route].should eq("/greet?query=test+query")
+        metadata[:request_method].should eq("POST")
+        metadata[:request_path].should eq("/greet?query=test+query")
         metadata[:request_body].should be_present
         metadata[:request_headers].should match(/^Content-Type: application\/json/)
         metadata[:request_headers].should match(/^X-Custom-Header: custom header value$/)

spec/test_server_spec.rb

@@ -42,8 +42,8 @@
     context "when examples should be documentated", :document => true do
       it "should augment the metadata with information about the request" do
         metadata = example.metadata[:requests].first
-        metadata[:method].should eq("POST")
-        metadata[:route].should eq(path)
+        metadata[:request_method].should eq("POST")
+        metadata[:request_path].should eq(path)
         metadata[:request_body].should eq(JSON.pretty_generate(JSON.parse(body)))
         metadata[:request_headers].split("\n").sort.should eq("Content-Type: application/json\nX-Custom-Header: custom header value\nHost: example.org\nCookie: ".split("\n").sort)
       end

templates/rspec_api_documentation/html_example.mustache

@@ -58,7 +58,7 @@
           <h4>Headers</h4>
           <pre class="request headers">{{ request_headers }}</pre>
           <h4>Route</h4>
-          <pre class="request route highlight">{{ method }} {{ route }}</pre>
+          <pre class="request route highlight">{{ request_method }} {{ request_path }}</pre>
           {{# request_query_parameters }}
             <h4>Query Parameters</h4>
             <pre class="request query_parameters highlight">{{ request_query_parameters }}</pre>