cleanup docs + example api

Author: igrigorik

examples/error.rb examples/early_abort.rbexamples/error.rb renamed to examples/early_abort.rb

@@ -1,32 +1,37 @@
 #!/usr/bin/env ruby
 $:<< '../lib' << 'lib'
-
 require'goliath'
 
-classError < Goliath::API
+classEarlyAbort < Goliath::API
 includeGoliath::Validation
 MAX_SIZE=10
 TEST_FILE="/tmp/goliath-test-error.log"
-
+
 defon_headers(env,headers)
 env.logger.info'received headers: ' + headers.inspect
 env['async-headers']=headers
-raiseGoliath::Validation::NotImplementedError.new("Can't handle requests with X-Crash: true.")ifenv['HTTP_X_CRASH'] && env['HTTP_X_CRASH'] == 'true'
+
+ifenv['HTTP_X_CRASH'] && env['HTTP_X_CRASH'] == 'true'
+raiseGoliath::Validation::NotImplementedError.new("Can't handle requests with X-Crash: true.")
+end
 end
 
 defon_body(env,data)
 env.logger.info'received data: ' + data
 (env['async-body'] ||= '') << data
 size=env['async-body'].size
-raiseGoliath::Validation::BadRequestError.new("Payload size can't exceed #{MAX_SIZE} bytes. Received #{size.inspect} bytes.")ifsize >= MAX_SIZE
+
+ifsize >= MAX_SIZE
+raiseGoliath::Validation::BadRequestError.new("Payload size can't exceed #{MAX_SIZE} bytes. Received #{size.inspect} bytes.")
+end
 end
 
 defon_close(env)
 env.logger.info'closing connection'
 end
 
-defresponse(env)
+defresponse(env)
 File.open(TEST_FILE,"w+"){ |f| f << "response that should not be here"}
 [200,{},"OK"]
 end
-end
+end

lib/goliath/request.rb

@@ -202,16 +202,10 @@ def server_exception(e)
 headers['Content-Length']=body.bytesize.to_s
 @env[:terminate_connection]=true
 post_process([status,headers,body])
-# Pass the request status to succeeded, so that the callback declared in
-# #post_process is executed as soon as possible, and not after the whole
-# response has been generated. For example, if you wanted to abort the
-# request in a #on_headers or #on_body hook (through exception raising),
-# the previous behaviour still went through all the hooks and the
-# #response method before returning the error. Now the error fires as
-# soon as possible. Note that #on_body and #response hooks may still be
-# executed if your machine is very fast or the request is very small,
-# but at least for long requests you don't get stuck until the full
-# request has been received.
+
+# Mark the request as complete to force a flush on the response.
+# Note: #on_body and #response hooks may still fire if the data
+# is already in the parser buffer.
 succeed
 end
 

spec/integration/error_spec.rb spec/integration/early_abort_spec.rbspec/integration/error_spec.rb renamed to spec/integration/early_abort_spec.rb

@@ -1,27 +1,27 @@
 require'spec_helper'
-requireFile.join(File.dirname(__FILE__),'../../','examples/error')
+requireFile.join(File.dirname(__FILE__),'../../','examples/early_abort')
 
-describeErrordo
+describeEarlyAbortdo
 let(:err){Proc.new{fail"API request failed"}}
 
 afterdo
-File.unlink(Error::TEST_FILE)ifFile.exist?(Error::TEST_FILE)
+File.unlink(EarlyAbort::TEST_FILE)ifFile.exist?(EarlyAbort::TEST_FILE)
 end
 
 it"should return OK"do
-with_api(Error)do
+with_api(EarlyAbort)do
 get_request({},err)do |c|
 c.response.should == "OK"
 end
 end
 end
-
+
 # The following two tests are very brittle, since they depend on the speed
 # of the machine executing the test and the size of the incoming data
 # packets. I hope someone more knowledgeable will be able to refactor these
 # ;-)
 it'fails without going in the response method if exception is raised in on_header hook'do
-with_api(Error)do
+with_api(EarlyAbort)do
 request_data={
 :body=>(["abcd"] * 200_000).join,
 :head=>{'X-Crash'=>'true'}
@@ -33,9 +33,9 @@
 end
 end
 end
-
+
 it'fails without going in the response method if exception is raised in on_body hook'do
-with_api(Error)do
+with_api(EarlyAbort)do
 request_data={
 :body=>(["abcd"] * 200_000).join
 }