Refactor RackTestClient. Introduce ClientBase for new, awesome clients.

Author: samwgoldman

features/html_documentation.feature

@@ -69,9 +69,7 @@ Feature: Generate HTML documentation from test examples
       | Host   | example.org |
       | Cookie |             |
     And   I should see the following query parameters:
-      """
-      target: rspec_api_documentation
-      """
+      | target | rspec_api_documentation |
 
   Scenario: Example HTML documentation includes the response information
     When  I open the index

features/step_definitions/html_steps.rb

@@ -27,8 +27,11 @@
   page.should have_css(".request.route", :text => route)
 end
 
-Then /^I should see the following query parameters:$/ do |query_parameters|
-  page.should have_css("pre.request.query_parameters"), :text => query_parameters
+Then /^I should see the following query parameters:$/ do |table|
+  text = page.find("pre.request.query_parameters").text
+  actual = text.split("\n")
+  expected = table.raw.map { |row| row.join(": ") }
+  actual.should =~ expected
 end
 
 Then /^I should see the response status is "([^"]*)"$/ do |status|

lib/rspec_api_documentation.rb

@@ -16,7 +16,8 @@ module RspecApiDocumentation
     autoload :Example
     autoload :ExampleGroup
     autoload :Index
-    autoload :TestClient
+    autoload :ClientBase
+    autoload :RackTestClient
     autoload :Headers
     autoload :Syntax
   end

lib/rspec_api_documentation/test_client.rb renamed to lib/rspec_api_documentation/client_base.rb

@@ -1,24 +1,10 @@
-require "coderay"
-
 module RspecApiDocumentation
-  class TestClient < Struct.new(:context, :options)
+  class ClientBase < Struct.new(:context, :options)
     include Headers
     include Syntax
 
     delegate :example, :app, :to => :context
     delegate :metadata, :to => :example
-    delegate :last_request, :last_response, :to => :rack_test_session
-    private :last_request, :last_response
-
-    def rack_test_session
-      @rack_test_session ||= Struct.new(:app) do
-        begin
-          include Rack::Test::Methods
-        rescue LoadError
-          raise "#{self.class.name} requires Rack::Test >= 0.5.5. Please add it to your test dependencies."
-        end
-      end.new(app)
-    end
 
     def get(*args)
       process :get, *args
@@ -36,50 +22,14 @@ def delete(*args)
       process :delete, *args
     end
 
-    def request_headers
-      env_to_headers(last_request.env)
-    end
-
-    def response_headers
-      last_response.headers
-    end
-
-    def query_string
-      last_request.env["QUERY_STRING"]
-    end
-
-    def query_hash
-      strings = query_string.split("&")
-      arrays = strings.map do |segment|
-        segment.split("=")
-      end
-      Hash[arrays]
-    end
-
-    def headers(method, action, params)
-      if options && options[:headers]
-        options[:headers]
-      else
-        {}
-      end
-    end
-
-    def status
-      last_response.status
-    end
-
-    def response_body
-      last_response.body
-    end
-
     private
-    def process(method, action, params = {})
-      rack_test_session.send(method, action, params, headers(method, action, params))
 
-      document_example(method, action, params)
+    def process(method, path, params = {})
+      do_request(method, path, params)
+      document_example(method.to_s.upcase, path, params)
     end
 
-    def document_example(method, action, params)
+    def document_example(method, path, params)
       return unless metadata[:document]
 
       input = last_request.env["rack.input"]
@@ -88,21 +38,29 @@ def document_example(method, action, params)
 
       request_metadata = {}
 
-      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_method] = method
+      request_metadata[:request_path] = path
+      request_metadata[:request_body] = highlight_syntax(request_body, content_type, true)
       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)
+      request_metadata[:curl] = Curl.new(method, path, request_body, request_headers)
 
       metadata[:requests] ||= []
       metadata[:requests] << request_metadata
     end
 
+    def query_hash
+      strings = query_string.split("&")
+      arrays = strings.map do |segment|
+        segment.split("=")
+      end
+      Hash[arrays]
+    end
+
     def format_query_hash(query_hash)
       return if query_hash.blank?
       query_hash.map do |key, value|

lib/rspec_api_documentation/dsl.rb

@@ -92,7 +92,7 @@ def parameter_keys
     end
 
     def client
-      @client ||= TestClient.new(self)
+      @client ||= RackTestClient.new(self)
     end
 
     def destination

lib/rspec_api_documentation/rack_test_client.rb

@@ -0,0 +1,59 @@
+require "coderay"
+
+module RspecApiDocumentation
+  class RackTestClient < ClientBase
+
+    delegate :last_request, :last_response, :to => :rack_test_session
+    private :last_request, :last_response
+
+    def request_headers
+      env_to_headers(last_request.env)
+    end
+
+    def response_headers
+      last_response.headers
+    end
+
+    def query_string
+      last_request.env["QUERY_STRING"]
+    end
+
+    def status
+      last_response.status
+    end
+
+    def response_body
+      last_response.body
+    end
+
+    def content_type
+      last_request.content_type
+    end
+
+    protected
+
+    def do_request(method, path, params)
+      rack_test_session.send(method, path, params, headers(method, path, params))
+    end
+
+    private
+
+    def rack_test_session
+      @rack_test_session ||= Struct.new(:app) do
+        begin
+          include Rack::Test::Methods
+        rescue LoadError
+          raise "#{self.class.name} requires Rack::Test >= 0.5.5. Please add it to your test dependencies."
+        end
+      end.new(app)
+    end
+
+    def headers(method, path, params)
+      if options && options[:headers]
+        options[:headers]
+      else
+        {}
+      end
+    end
+  end
+end

spec/dsl_spec.rb

@@ -18,7 +18,7 @@
 
   describe "example context" do
     it "should provide a client" do
-      client.should be_a(RspecApiDocumentation::TestClient)
+      client.should be_a(RspecApiDocumentation::RackTestClient)
     end
 
     it "should return the same client every time" do

spec/test_client_spec.rb renamed to spec/rack_test_client_spec.rb

@@ -29,13 +29,13 @@ class StubApp < Sinatra::Base
   end
 end
 
-describe RspecApiDocumentation::TestClient do
+describe RspecApiDocumentation::RackTestClient do
   let(:context) { stub(:app => StubApp, :example => example) }
-  let(:test_client) { RspecApiDocumentation::TestClient.new(context, {}) }
+  let(:test_client) { RspecApiDocumentation::RackTestClient.new(context, {}) }
 
   subject { test_client }
 
-  it { should be_a(RspecApiDocumentation::TestClient) }
+  it { should be_a(RspecApiDocumentation::RackTestClient) }
 
   its(:context) { should equal(context) }
   its(:example) { should equal(example) }
@@ -65,16 +65,6 @@ class StubApp < Sinatra::Base
     end
   end
 
-  describe "#query_hash" do
-    before do
-      test_client.get "/?query_hash=true"
-    end
-
-    it 'should contain the query_hash' do
-      test_client.query_hash.should == { "query_hash" => "true" }
-    end
-  end
-
   describe "#request_headers" do
     before do
       test_client.options[:headers] = {
@@ -106,15 +96,15 @@ class StubApp < Sinatra::Base
   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" })
+    it "should let you set default headers when creating a new RackTestClient" do
+      test_client = RspecApiDocumentation::RackTestClient.new(context, :headers => { "HTTP_MY_HEADER" => "hello" })
       test_client.get "/"
       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 = RspecApiDocumentation::RackTestClient.new(context)
       test_client.get "/"
       test_client.request_headers.should have(2).headers
     end
@@ -145,7 +135,7 @@ class StubApp < Sinatra::Base
         metadata[:response_body].should be_present
         metadata[:response_headers].should match(/^Content-Type: application\/json/)
         metadata[:response_headers].should match(/^Content-Length: 17$/)
-        metadata[:curl].should 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" => ""}))
+        metadata[:curl].should 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
 
       context "when post data is not json" do