goliath 1.0.5 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2657a958a80151a0eab64c006eb13a4905156cc3
-  data.tar.gz: b140e7bdc85173bb06adeef69b504d7ab39d5197
+SHA256:
+  metadata.gz: dfbb6334b545d1cb281c256ecc8d127158b28ec6d2f9fdb5f75480d34444dc9d
+  data.tar.gz: 5a755161caf7c6ef1877197066ac628cec01211e247f452e6bf5ff65eb6ca3a1
 SHA512:
-  metadata.gz: bdf5b587bcc2edefd5242b4c447e45787bd9affff51010c47484b9644ba005bc194d68b939c7117f78d375e3ebc16e05abc1292ff3b34626d9329fd140551957
-  data.tar.gz: 1cec64325f506e5838ec7893055c5e15cd52375c0e435b8cab69057d17424aa535f02537eab764a551064a161baeab27245d3a00a451ca0ca8215e720c3d0f1e
+  metadata.gz: a56de2b0212a2e749a822b796040ce36bc318adcb20d347c825e426acf9eb7958525b74447a9f4e9e5273fb0b58398a8f92aaf9bbf0c45c5886d97fea002e079
+  data.tar.gz: 56c4b36ebfceabff78951ef70f71807215cba80ee27e985969899005fc7a0e0397b3df52617079b2172ca74cf14416e90adfc652a8d12e81e8e1a6fabe2c90b4

data/examples/rasterize/rasterize.rb

@@ -17,7 +17,7 @@ class Rasterize < Goliath::API
     url = PostRank::URI.clean(params['url'])
     hash = PostRank::URI.hash(url, :clean => false)
 
-    if !File.exists? filename(hash)
+    if !File.exist? filename(hash)
       fiber = Fiber.current
       EM.system('phantomjs rasterize.js ' + url.to_s + ' ' + filename(hash)) do |output, status|
         env.logger.info "Phantom exit status: #{status}"

data/goliath.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'amqp', '>=0.7.1'
   s.add_development_dependency 'em-websocket-client'
   s.add_development_dependency 'em-eventsource'
+  s.add_development_dependency 'rack', '< 2'
 
   s.add_development_dependency 'tilt', '>=1.2.2'
   s.add_development_dependency 'haml', '>=3.0.25'

data/lib/goliath/connection.rb

@@ -23,12 +23,13 @@ module Goliath
       @parser = Http::Parser.new
       @parser.on_headers_complete = proc do |h|
         env = Goliath::Env.new
-        env[SERVER_PORT] = port.to_s
-        env[RACK_LOGGER] = logger
-        env[OPTIONS]     = options
-        env[STATUS]      = status
-        env[CONFIG]      = config
-        env[REMOTE_ADDR] = remote_address
+        env[SERVER_PORT]     = port.to_s
+        env[RACK_LOGGER]     = logger
+        env[OPTIONS]         = options
+        env[STATUS]          = status
+        env[CONFIG]          = config
+        env[REMOTE_ADDR]     = remote_address
+        env[RACK_URL_SCHEME] = options[:ssl] ? "https" : "http"
 
         r = Goliath::Request.new(@app, self, env)
         r.parse_header(h, @parser) do
@@ -41,7 +42,8 @@ module Goliath
       end
 
       @parser.on_body = proc do |data|
-        @requests.first.parse(data)
+        req = @requests.first
+        req.parse(data) unless req.env[:terminate_connection]
       end
 
       @parser.on_message_complete = proc do
@@ -71,7 +73,7 @@ module Goliath
           end
         end
 
-      rescue HTTP::Parser::Error => e
+      rescue HTTP::Parser::Error
         terminate_request(false)
       end
     end
@@ -83,15 +85,17 @@ module Goliath
     end
 
     def terminate_request(keep_alive)
-      if req = @pending.shift
-        @current = req
-        @current.succeed
-      elsif @current
+      if @current
         @current.close
         @current = nil
       end
 
       close_connection_after_writing rescue nil if !keep_alive
+
+      if req = @pending.shift
+        @current = req
+        @current.succeed
+      end
     end
 
     def remote_address

data/lib/goliath/constants.rb

@@ -23,6 +23,7 @@ module Goliath
     RACK_VERSION_NUM = [1, 0]
     RACK_LOGGER     = 'rack.logger'
     RACK_EXCEPTION  = 'rack.exception'
+    RACK_URL_SCHEME = 'rack.url_scheme'
 
     ASYNC_CALLBACK  = 'async.callback'
     ASYNC_HEADERS   = 'async.headers'

data/lib/goliath/rack/default_response_format.rb

@@ -4,17 +4,11 @@ module Goliath
       include Goliath::Rack::AsyncMiddleware
 
       def post_process(env, status, headers, body)
-        return [status, headers, body] if body.respond_to?(:to_ary)
-
-        new_body = []
-        if body.respond_to?(:each)
-          body.each { |chunk| new_body << chunk }
+        if body.is_a?(String)
+          [status, headers, [body]]
         else
-          new_body << body
+          [status, headers, body]
         end
-        new_body.collect! { |item| item.to_s }
-
-        [status, headers, new_body.flatten]
       end
     end
   end

data/lib/goliath/rack/formatters/json.rb

@@ -19,7 +19,7 @@ module Goliath
         end
 
         def json_response?(headers)
-          headers['Content-Type'] =~ %r{^application/(json|javascript)}
+          headers['Content-Type'] =~ %r{^application/((vnd\.api\+)?json|javascript)}
         end
       end
     end

data/lib/goliath/rack/params.rb

@@ -4,7 +4,7 @@ require 'rack/utils'
 module Goliath
   module Rack
     URL_ENCODED = %r{^application/x-www-form-urlencoded}
-    JSON_ENCODED = %r{^application/json}
+    JSON_ENCODED = %r{^application/((vnd\.api\+)?json|javascript)}
 
     # A middle ware to parse params. This will parse both the
     # query string parameters and the body and place them into

data/lib/goliath/rack/templates.rb

@@ -251,7 +251,7 @@ module Goliath
       # @return [String | nil] Template file or nil if it doesn't exist.
       def find_template(views, name, engine)
         filename = ::File.join(views, "#{name}.#{engine}")
-        File.exists?(filename) ? filename : nil
+        File.exist?(filename) ? filename : nil
       end
 
       # Renders a template with the given engine. Don't call this directly --

data/lib/goliath/request.rb

@@ -197,22 +197,14 @@ module Goliath
         callback do
           begin
             @response.status, @response.headers, @response.body = status, headers, body
-            @response.each { |chunk| @conn.send_data(chunk) }
-
-            elapsed_time = (Time.now.to_f - @env[:start_time]) * 1000
-            begin
-              Goliath::Request.log_block.call(@env, @response, elapsed_time)
-            rescue => err
-              # prevent an infinite loop if the block raised an error
-              @env[RACK_LOGGER].error("log block raised #{err}")
-            end
 
-            @conn.terminate_request(keep_alive)
+            stream_data(@response.each) do
+              terminate_request
+            end
           rescue Exception => e
             server_exception(e)
           end
         end
-
       rescue Exception => e
         server_exception(e)
       end
@@ -220,6 +212,31 @@ module Goliath
 
     private
 
+    # Writes each chunk of the response data in a new tick. This achieves
+    # streaming, because EventMachine flushes the sent data to the socket at
+    # the end of each tick.
+    def stream_data(chunks, &block)
+      @conn.send_data(chunks.next)
+      EM.next_tick { stream_data(chunks, &block) }
+    rescue StopIteration
+      block.call
+    rescue Exception => e
+      server_exception(e)
+    end
+
+    # Logs the response time and terminates the request.
+    def terminate_request
+      elapsed_time = (Time.now.to_f - @env[:start_time]) * 1000
+      begin
+        Goliath::Request.log_block.call(@env, @response, elapsed_time)
+      rescue => err
+        # prevent an infinite loop if the block raised an error
+        @env[RACK_LOGGER].error("log block raised #{err}")
+      end
+
+      @conn.terminate_request(keep_alive)
+    end
+
     # Handles logging server exceptions
     #
     # @param e [Exception] The exception to log
@@ -228,20 +245,20 @@ module Goliath
       if e.is_a?(Goliath::Validation::Error)
         status, headers, body = [e.status_code, e.headers, ('{"error":"%s"}' % e.message)]
       else
-        @env[RACK_LOGGER].error("#{e.message}\n#{e.backtrace.join("\n")}")
-        message = Goliath.env?(:production) ? 'An error happened' : e.message
+        logthis = "#{e.backtrace[0]}: #{e.message} (#{e.class})\n"
+        e.backtrace[1..-1].each do |bt|
+          logthis += "    from #{bt}\n"
+        end
+        @env.logger.error(logthis)
+        @env[RACK_EXCEPTION] = e
 
+        message = Goliath.env?(:production) ? 'An error happened' : e.message
         status, headers, body = [500, {}, message]
       end
 
       headers['Content-Length'] = body.bytesize.to_s
       @env[:terminate_connection] = true
       post_process([status, headers, body])
-
-      # 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
 
     # Used to determine if the connection should  be kept open

data/lib/goliath/response.rb

@@ -13,7 +13,7 @@ module Goliath
     attr_accessor :status
 
     # The headers to send
-    attr_accessor :headers
+    attr_reader :headers
 
     # The body to send
     attr_accessor :body
@@ -79,6 +79,8 @@ module Goliath
     # @yield [String] The header line, headers and body content
     # @return [Nil]
     def each
+      return enum_for(__method__) unless block_given?
+
       yield head
       yield headers_output
 

data/lib/goliath/server.rb

@@ -132,7 +132,7 @@ module Goliath
     def load_config(file = nil)
       api_name = api.class.to_s.gsub('::', '_').gsub(/([^_A-Z])([A-Z])/,'\1_\2').downcase!
       file ||= "#{config_dir}/#{api_name}.rb"
-      return unless File.exists?(file)
+      return unless File.exist?(file)
 
       proc = Proc.new {} # create proc to grab binding
       eval(IO.read(file), proc.binding, file)

data/lib/goliath/version.rb

@@ -1,4 +1,4 @@
 module Goliath
   # The current version of Goliath
-  VERSION = '1.0.5'
+  VERSION = '1.0.7'
 end

data/spec/integration/async_request_processing.rb

@@ -13,8 +13,8 @@ describe 'Async Request processing' do
 
       post_request(request_data, err) do |c|
         resp = MultiJson.load(c.response)
-        resp['body'].should match('some=data')
-        resp['head'].should include('X-Upload')
+        expect(resp['body']).to match('some=data')
+        expect(resp['head']).to include('X-Upload')
       end
     end
   end

data/spec/integration/chunked_streaming_spec.rb

@@ -27,7 +27,7 @@ describe "ChunkedStreaming" do
   it "should stream content" do
     with_api(ChunkedStreaming, {:verbose => true, :log_stdout => true}) do |server|
       streaming_client_connect('/streaming') do |client|
-        client.receive.should == "chunked"
+        expect(client.receive).to eq("chunked")
       end
     end
   end

data/spec/integration/early_abort_spec.rb

@@ -11,7 +11,7 @@ describe EarlyAbort do
   it "should return OK" do
     with_api(EarlyAbort) do
       get_request({}, err) do |c|
-        c.response.should == "OK"
+        expect(c.response).to eq("OK")
       end
     end
   end
@@ -24,8 +24,8 @@ describe EarlyAbort do
       }
 
       post_request(request_data, err) do |c|
-        c.response.should == "{\"error\":\"Can't handle requests with X-Crash: true.\"}"
-        File.exist?("/tmp/goliath-test-error.log").should be false
+        expect(c.response).to eq("{\"error\":\"Can't handle requests with X-Crash: true.\"}")
+        expect(File.exist?("/tmp/goliath-test-error.log")).to be false
       end
     end
   end
@@ -35,8 +35,8 @@ describe EarlyAbort do
       request_data = { :body => "a" * 20 }
 
       post_request(request_data, err) do |c|
-        c.response.should =~ /Payload size can't exceed 10 bytes/
-        File.exist?("/tmp/goliath-test-error.log").should be false
+        expect(c.response).to match(/Payload size can't exceed 10 bytes/)
+        expect(File.exist?("/tmp/goliath-test-error.log")).to be false
       end
     end
   end

data/spec/integration/echo_spec.rb

@@ -10,7 +10,7 @@ describe Echo do
     with_api(Echo) do
       get_request({:query => {:echo => 'test'}}, err) do |c|
         b = MultiJson.load(c.response)
-        b['response'].should == 'test'
+        expect(b['response']).to eq('test')
       end
     end
   end
@@ -19,8 +19,8 @@ describe Echo do
     with_api(Echo) do
       get_request({}, err) do |c|
         b = MultiJson.load(c.response)
-        b['error'].should_not be_nil
-        b['error'].should == 'echo identifier missing'
+        expect(b['error']).not_to be_nil
+        expect(b['error']).to eq('echo identifier missing')
       end
     end
   end
@@ -29,7 +29,7 @@ describe Echo do
     with_api(Echo) do
       post_request({:body => {'echo' => 'test'}}, err) do |c|
         b = MultiJson.load(c.response)
-        b['response'].should == 'test'
+        expect(b['response']).to eq('test')
       end
     end
   end
@@ -42,7 +42,7 @@ describe Echo do
       post_request({:body => body.to_s,
                     :head => head}, err) do |c|
         b = MultiJson.load(c.response)
-        b['response'].should == 'test'
+        expect(b['response']).to eq('test')
       end
     end
   end
@@ -55,7 +55,7 @@ describe Echo do
       post_request({:body => body.to_s,
                     :head => head}, err) do |c|
         b = MultiJson.load(c.response)
-        b['response'].should == 'My Echo'
+        expect(b['response']).to eq('My Echo')
       end
     end
   end
@@ -64,7 +64,7 @@ describe Echo do
     with_api(Echo) do
       patch_request({:body => {'echo' => 'test'}}, err) do |c|
         b = MultiJson.load(c.response)
-        b['response'].should == 'test'
+        expect(b['response']).to eq('test')
       end
     end
   end

data/spec/integration/empty_body_spec.rb

@@ -12,8 +12,8 @@ describe 'Empty body API' do
   it 'serves a 201 with no body' do
     with_api(Empty) do
       get_request({}, err) do |c|
-        c.response_header.status.should == 201
-        c.response_header['CONTENT_LENGTH'].should == '0'
+        expect(c.response_header.status).to eq(201)
+        expect(c.response_header['CONTENT_LENGTH']).to eq('0')
       end
     end
   end

data/spec/integration/event_stream_spec.rb

@@ -30,8 +30,8 @@ describe 'EventStream' do
         sse_client_connect('/stream') do |client|
           client.listen_to('custom_event')
           EventStreamEndpoint.events.push(name: 'custom_event', data: 'content')
-          client.receive_on('custom_event').should == ['content']
-          client.receive.should == []
+          expect(client.receive_on('custom_event')).to eq(['content'])
+          expect(client.receive).to eq([])
         end
       end
     end
@@ -42,7 +42,7 @@ describe 'EventStream' do
       with_api(EventStreamEndpoint, {:verbose => true, :log_stdout => true}) do |server|
         sse_client_connect('/stream') do |client|
           EventStreamEndpoint.events.push(data: 'content')
-          client.receive.should == ['content']
+          expect(client.receive).to eq(['content'])
         end
       end
     end

data/spec/integration/exception_handling_spec.rb

@@ -83,8 +83,8 @@ describe ExceptionHandlingAPI do
     it 'returns a normal response' do
       with_api(ExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 200
-          c.response.should == 'No exceptions raised'
+          expect(c.response_header.status).to eq(200)
+          expect(c.response).to eq('No exceptions raised')
         end
       end
     end
@@ -96,8 +96,8 @@ describe ExceptionHandlingAPI do
     it 'handles the exception using ExceptionHandlingMiddleware' do
       with_api(ExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 200
-          c.response.should == 'Exception raised: zoinks'
+          expect(c.response_header.status).to eq(200)
+          expect(c.response).to eq('Exception raised: zoinks')
         end
       end
     end
@@ -109,8 +109,8 @@ describe ExceptionHandlingAPI do
     it 'handles the exception using ExceptionHandlingMiddleware' do
       with_api(ExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 200
-          c.response.should == 'Exception raised: jinkies'
+          expect(c.response_header.status).to eq(200)
+          expect(c.response).to eq('Exception raised: jinkies')
         end
       end
     end
@@ -122,8 +122,8 @@ describe ExceptionHandlingAPI do
     it 'returns a validation error generated by Goliath::Rack::Params' do
       with_api(ExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 400
-          c.response.should == "[:error, \"Invalid parameters: Rack::Utils::ParameterTypeError\"]"
+          expect(c.response_header.status).to eq(400)
+          expect(c.response).to eq("[:error, \"Invalid parameters: Rack::Utils::ParameterTypeError\"]")
         end
       end
     end
@@ -154,8 +154,8 @@ describe PassiveExceptionHandlingAPI do
     it 'returns a normal response' do
       with_api(PassiveExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 200
-          c.response.should == 'No exceptions raised'
+          expect(c.response_header.status).to eq(200)
+          expect(c.response).to eq('No exceptions raised')
         end
       end
     end
@@ -167,8 +167,8 @@ describe PassiveExceptionHandlingAPI do
     it 'returns the server error generated by Goliath::Request#process' do
       with_api(PassiveExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 500
-          c.response.should == 'ruh-roh'
+          expect(c.response_header.status).to eq(500)
+          expect(c.response).to eq('ruh-roh')
         end
       end
     end
@@ -180,8 +180,8 @@ describe PassiveExceptionHandlingAPI do
     it 'returns the validation error generated by Goliath::API#call' do
       with_api(PassiveExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 500
-          c.response.should == '[:error, "puppy-power"]'
+          expect(c.response_header.status).to eq(500)
+          expect(c.response).to eq('[:error, "puppy-power"]')
         end
       end
     end
@@ -193,8 +193,8 @@ describe PassiveExceptionHandlingAPI do
     it 'returns a validation error generated by Goliath::Rack::Params' do
       with_api(PassiveExceptionHandlingAPI) do
         get_request({ query: query }, err) do |c|
-          c.response_header.status.should == 400
-          c.response.should == '[:error, "Invalid parameters: Rack::Utils::ParameterTypeError"]'
+          expect(c.response_header.status).to eq(400)
+          expect(c.response).to eq('[:error, "Invalid parameters: Rack::Utils::ParameterTypeError"]')
         end
       end
     end

data/spec/integration/http_log_spec.rb

@@ -42,7 +42,7 @@ describe HttpLog do
       mock_mongo(api)
 
       get_request({}, err) do |c|
-        c.response_header.status.should == 200
+        expect(c.response_header.status).to eq(200)
       end
     end
   end
@@ -53,9 +53,9 @@ describe HttpLog do
       mock_mongo(api)
 
       get_request({}, err) do |c|
-        c.response_header.status.should == 200
-        c.response_header['SPECIAL'].should == 'Header'
-        c.response.should == 'Hello from Responder'
+        expect(c.response_header.status).to eq(200)
+        expect(c.response_header['SPECIAL']).to eq('Header')
+        expect(c.response).to eq('Hello from Responder')
       end
     end
   end
@@ -63,8 +63,8 @@ describe HttpLog do
   context 'HTTP header handling' do
     it 'transforms back properly' do
       hl = HttpLog.new
-      hl.to_http_header("SPECIAL").should == 'Special'
-      hl.to_http_header("CONTENT_TYPE").should == 'Content-Type'
+      expect(hl.to_http_header("SPECIAL")).to eq('Special')
+      expect(hl.to_http_header("CONTENT_TYPE")).to eq('Content-Type')
     end
   end
 
@@ -75,8 +75,8 @@ describe HttpLog do
         mock_mongo(api)
 
         get_request({:query => {:first => :foo, :second => :bar, :third => :baz}}, err) do |c|
-          c.response_header.status.should == 200
-          c.response_header["PARAMS"].should == "first: foo|second: bar|third: baz"
+          expect(c.response_header.status).to eq(200)
+          expect(c.response_header["PARAMS"]).to eq("first: foo|second: bar|third: baz")
         end
       end
     end
@@ -89,8 +89,8 @@ describe HttpLog do
         mock_mongo(api)
 
         get_request({:path => '/my/request/path'}, err) do |c|
-          c.response_header.status.should == 200
-          c.response_header['PATH'].should == '/my/request/path'
+          expect(c.response_header.status).to eq(200)
+          expect(c.response_header['PATH']).to eq('/my/request/path')
         end
       end
     end
@@ -103,8 +103,8 @@ describe HttpLog do
         mock_mongo(api)
 
         get_request({:head => {:first => :foo, :second => :bar}}, err) do |c|
-          c.response_header.status.should == 200
-          c.response_header["HEADERS"].should =~ /First: foo\|Second: bar/
+          expect(c.response_header.status).to eq(200)
+          expect(c.response_header["HEADERS"]).to match(/First: foo\|Second: bar/)
         end
       end
     end
@@ -117,8 +117,8 @@ describe HttpLog do
         mock_mongo(api)
 
         get_request({}, err) do |c|
-          c.response_header.status.should == 200
-          c.response_header["METHOD"].should == "GET"
+          expect(c.response_header.status).to eq(200)
+          expect(c.response_header["METHOD"]).to eq("GET")
         end
       end
     end
@@ -129,8 +129,8 @@ describe HttpLog do
         mock_mongo(api)
 
         post_request({}, err) do |c|
-          c.response_header.status.should == 200
-          c.response_header["METHOD"].should == "POST"
+          expect(c.response_header.status).to eq(200)
+          expect(c.response_header["METHOD"]).to eq("POST")
         end
       end
     end

data/spec/integration/jsonp_spec.rb

@@ -30,7 +30,7 @@ describe 'JSONP' do
     it 'does not alter the content type' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response_header['CONTENT_TYPE'].should =~ %r{^application/json}
+          expect(c.response_header['CONTENT_TYPE']).to match(%r{^application/json})
         end
       end
     end
@@ -38,7 +38,7 @@ describe 'JSONP' do
     it 'does not alter the content length' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response_header['CONTENT_LENGTH'].to_i.should == 2
+          expect(c.response_header['CONTENT_LENGTH'].to_i).to eq(2)
         end
       end
     end
@@ -46,7 +46,7 @@ describe 'JSONP' do
     it 'does not wrap the response with anything' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response.should == 'OK'
+          expect(c.response).to eq('OK')
         end
       end
     end
@@ -58,7 +58,7 @@ describe 'JSONP' do
     it 'adjusts the content type' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response_header['CONTENT_TYPE'].should =~ %r{^application/javascript}
+          expect(c.response_header['CONTENT_TYPE']).to match(%r{^application/javascript})
         end
       end
     end
@@ -66,7 +66,7 @@ describe 'JSONP' do
     it 'adjusts the content length' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response_header['CONTENT_LENGTH'].to_i.should == 8
+          expect(c.response_header['CONTENT_LENGTH'].to_i).to eq(8)
         end
       end
     end
@@ -74,7 +74,7 @@ describe 'JSONP' do
     it 'wraps response with callback' do
       with_api(JSON_API) do
         get_request({ query: query }, err) do |c|
-          c.response.should =~ /^test\(.*\)$/
+          expect(c.response).to match(/^test\(.*\)$/)
         end
       end
     end