Rename last_response_headers to response_headers. Change internal TestClient methods to match.

Author: samwgoldman

features/html_documentation.feature

@@ -29,6 +29,7 @@ Feature: Generate HTML documentation from test examples
           example "Greeting your favorite gem" do
             do_request :target => "rspec_api_documentation"
 
+            response_headers["Content-Type"].should eq("application/json")
             status.should eq(200)
             response_body.should eq('{"hello":"rspec_api_documentation"}')
           end

lib/rspec_api_documentation/dsl.rb

@@ -6,7 +6,7 @@ module RspecApiDocumentation
   module DSL
     extend ActiveSupport::Concern
 
-    delegate :last_response_headers, :status, :response_body, :to => :client
+    delegate :response_headers, :status, :response_body, :to => :client
     delegate :request_method, :request_headers, :request_body, :to => :destination
 
     module ClassMethods

lib/rspec_api_documentation/test_client.rb

@@ -1,3 +1,5 @@
+require "coderay"
+
 module RspecApiDocumentation
   class TestClient < Struct.new(:context, :options)
     include Headers
@@ -34,20 +36,20 @@ def delete(*args)
       process :delete, *args
     end
 
-    def last_request_headers
+    def request_headers
       env_to_headers(last_request.env)
     end
 
-    def last_response_headers
+    def response_headers
       last_response.headers
     end
 
-    def last_query_string
+    def query_string
       last_request.env["QUERY_STRING"]
     end
 
-    def last_query_hash
-      strings = last_query_string.split("&")
+    def query_hash
+      strings = query_string.split("&")
       arrays = strings.map do |segment|
         segment.split("=")
       end
@@ -89,13 +91,13 @@ def document_example(method, action, params)
       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_request_headers)
-      request_metadata[:request_query_parameters] = format_query_hash(last_query_hash)
-      request_metadata[:response_status] = last_response.status
-      request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[last_response.status]
-      request_metadata[:response_body] = highlight_syntax(response_body, last_response_headers['Content-Type'])
-      request_metadata[:response_headers] = format_headers(last_response_headers)
-      request_metadata[:curl] = Curl.new(method.to_s, action, request_body, last_request_headers)
+      request_metadata[:request_headers] = format_headers(request_headers)
+      request_metadata[:request_query_parameters] = format_query_hash(query_hash)
+      request_metadata[:response_status] = status
+      request_metadata[:response_status_text] = Rack::Utils::HTTP_STATUS_CODES[status]
+      request_metadata[:response_body] = highlight_syntax(response_body, response_headers['Content-Type'])
+      request_metadata[:response_headers] = format_headers(response_headers)
+      request_metadata[:curl] = Curl.new(method.to_s, action, request_body, request_headers)
 
       metadata[:requests] ||= []
       metadata[:requests] << request_metadata

spec/test_client_spec.rb

@@ -47,35 +47,35 @@ class StubApp < Sinatra::Base
     end
 
     it "should handle xml data" do
-      test_client.last_response_headers["Content-Type"].should =~ /application\/xml/
+      test_client.response_headers["Content-Type"].should =~ /application\/xml/
     end
 
     it "should log the request" do
       example.metadata[:requests].first[:response_body].should be_present
     end
   end
 
-  describe "#last_query_string" do
+  describe "#query_string" do
     before do
       test_client.get "/?query_string=true"
     end
 
     it 'should contain the query_string' do
-      test_client.last_query_string.should == "query_string=true"
+      test_client.query_string.should == "query_string=true"
     end
   end
 
-  describe "#last_query_hash" do
+  describe "#query_hash" do
     before do
       test_client.get "/?query_hash=true"
     end
 
     it 'should contain the query_hash' do
-      test_client.last_query_hash.should == { "query_hash" => "true" }
+      test_client.query_hash.should == { "query_hash" => "true" }
     end
   end
 
-  describe "#last_request_headers" do
+  describe "#request_headers" do
     before do
       test_client.options[:headers] = {
         "HTTP_ACCEPT" => "application/json",
@@ -85,7 +85,7 @@ class StubApp < Sinatra::Base
     end
 
     it "should contain all the headers" do
-      test_client.last_request_headers.should eq({
+      test_client.request_headers.should eq({
         "Accept" => "application/json",
         "Content-Type" => "application/json",
         "Host" => "example.org",
@@ -101,22 +101,22 @@ class StubApp < Sinatra::Base
     end
 
     it "can be overridden to add headers to the request" do
-      test_client.last_request_headers["X-Custom-Header"].should eq("custom header value")
+      test_client.request_headers["X-Custom-Header"].should eq("custom header value")
     end
   end
 
   describe "setup default headers" do
     it "should let you set default headers when creating a new TestClient" do
       test_client = RspecApiDocumentation::TestClient.new(context, :headers => { "HTTP_MY_HEADER" => "hello" })
       test_client.get "/"
-      test_client.last_request_headers["My-Header"].should == "hello"
-      test_client.last_request_headers.should have(3).headers
+      test_client.request_headers["My-Header"].should == "hello"
+      test_client.request_headers.should have(3).headers
     end
 
     it "should be blank if not set" do
       test_client = RspecApiDocumentation::TestClient.new(context)
       test_client.get "/"
-      test_client.last_request_headers.should have(2).headers
+      test_client.request_headers.should have(2).headers
     end
   end