goliath 1.0.4 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c49ef49ca7b81daf949084e54013fe33751d9461
-  data.tar.gz: c9bd1ae49086f0fa8ff01dd8617994156ff1b448
+  metadata.gz: 2bfab8c9906a1737abc3e7cdf163a52e13e516c7
+  data.tar.gz: a1ac6184a35dbfe56a04d117872d31b7c3647c71
 SHA512:
-  metadata.gz: 4d9e9698db573be7495f89394bae42ad613397489a5e979994b29ee1518238c73884444f8be2bdef7b7bea936a1bced59b07e7d85eb5cec5dc1e2fb75758de8a
-  data.tar.gz: 4a800250911ccb181214f88c43442539b18cb96676b960ffa8e7a3acddc1aa3413d83c58bab1b389280d09f4822ac97f815be9db80cd8dde52483a006e991062
+  metadata.gz: 833e67c341fde76ca1e5d69430f0f0c2d70186de0474979421fbbeeac78d5755eb79bfde0495e606105fb71f0291a6e8fa6be4c3e55ea6da2d663b8aa6c20937
+  data.tar.gz: 15de365fe175166182ead10d6c397971d33391e190f994552216433ebf121be35732805cd56cc364c3f9f0a5361589cd4205954014288fd52ab995d6807ccc93

data/README.md

@@ -64,13 +64,14 @@ Goliath has been used in production environments for 2+ years, across many diffe
 * [Middleware](https://github.com/postrank-labs/goliath/wiki/Middleware)
 * [Configuration](https://github.com/postrank-labs/goliath/wiki/Configuration)
 * [Plugins](https://github.com/postrank-labs/goliath/wiki/Plugins)
+* [Zero Downtime Restart](https://github.com/postrank-labs/goliath/wiki/Zero-downtime-restart)
+
 
 ### Hands-on applications:
 
-If you are you new to EventMachine, or want a detailed walk-through of building a Goliath powered API? You're in luck, we have two super-awesome Peepcode screencasts which will teach you all you need to know:
+If you are you new to EventMachine, or want a detailed walk-through of building a Goliath powered API? You're in luck, a super-awesome Pluralsight screencast which will teach you all you need to know:
 
-* [Meet EventMachine: Part 1](http://peepcode.com/products/eventmachine) - introduction to EM, Fibers, etc.
-* [Meet EventMachine: Part 2](http://peepcode.com/products/eventmachine-ii) - building an API with Goliath
+* [Meet EventMachine](http://www.pluralsight.com/courses/meet-eventmachine) - introduction to EM, Fibers, building an API with Goliath
 
 Additionally, you can also watch this presentation from GoGaRuCo 2011, which describes the design and motivation behind Goliath:
 
@@ -90,4 +91,4 @@ Other resources:
 
 ## License & Acknowledgments
 
-Goliath is distributed under the MIT license, for full details please see the LICENSE file.
+Goliath is distributed under the MIT license, for full details please see the LICENSE file.

data/goliath.gemspec

@@ -12,13 +12,14 @@ Gem::Specification.new do |s|
   s.summary = 'Async framework for writing API servers'
   s.description = s.summary
 
-  s.required_ruby_version = '>=1.9.2'
+  s.required_ruby_version = '>=2.1.0'
 
   s.add_dependency 'eventmachine', '>= 1.0.0.beta.4'
   s.add_dependency 'em-synchrony', '>= 1.0.0'
-  s.add_dependency 'em-websocket', "0.3.8"
-  s.add_dependency 'http_parser.rb', '0.6.0'
+  s.add_dependency 'em-websocket', '0.3.8'
+  s.add_dependency 'http_parser.rb', '>= 0.6.0'
   s.add_dependency 'log4r'
+  s.add_dependency 'einhorn'
 
   s.add_dependency 'rack', '>=1.2.2'
   s.add_dependency 'rack-contrib'
@@ -27,7 +28,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'multi_json'
 
   s.add_development_dependency 'rake', '>=0.8.7'
-  s.add_development_dependency 'rspec', '>2.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'test-unit'
   s.add_development_dependency 'nokogiri'
   s.add_development_dependency 'em-http-request', '>=1.0.0'
   s.add_development_dependency 'em-mongo', '~> 0.4.0'
@@ -35,14 +37,16 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'multipart_body'
   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'
   s.add_development_dependency 'yard'
 
-  s.add_development_dependency 'guard', '~> 1.8.3'
-  s.add_development_dependency 'guard-rspec', '~> 3.1.0'
-  s.add_development_dependency 'listen', '~> 1.3.1'
+  s.add_development_dependency 'guard', '~> 2.0'
+  s.add_development_dependency 'guard-rspec', '~> 4.0'
+  s.add_development_dependency 'listen', '~> 2.0'
 
   if RUBY_PLATFORM != 'java'
     s.add_development_dependency 'yajl-ruby'

data/lib/goliath/api.rb

@@ -172,7 +172,7 @@ module Goliath
 
       rescue Goliath::Validation::Error => e
         env[RACK_EXCEPTION] = e
-        env[ASYNC_CALLBACK].call(validation_error(e.status_code, e.message))
+        env[ASYNC_CALLBACK].call(validation_error(e.status_code, e.message, e.headers))
 
       rescue Exception => e
         logthis = "#{e.backtrace[0]}: #{e.message} (#{e.class})\n"

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
@@ -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/jsonp.rb

@@ -18,10 +18,15 @@ module Goliath
           response = body
         end
 
+        response = "#{env.params['callback']}(#{response})"
+
         headers[Goliath::Constants::CONTENT_TYPE] = 'application/javascript'
-        [status, headers, ["#{env.params['callback']}(#{response})"]]
+        if headers['Content-Length']
+          headers['Content-Length'] = response.bytesize.to_s
+        end
+
+        [status, headers, [response]]
       end
     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
@@ -60,10 +60,11 @@ module Goliath
       end
 
       def call(env)
-        Goliath::Rack::Validator.safely(env) do
+        error_response = Goliath::Rack::Validator.safely(env) do
           env['params'] = retrieve_params(env)
-          @app.call(env)
+          nil
         end
+        error_response || @app.call(env)
       end
     end
   end

data/lib/goliath/rack/validator.rb

@@ -39,7 +39,7 @@ module Goliath
         begin
           yield
         rescue Goliath::Validation::Error => e
-          validation_error(e.status_code, e.message, headers)
+          validation_error(e.status_code, e.message, e.headers.merge(headers))
         rescue Exception => e
           env.logger.error(e.message)
           env.logger.error(e.backtrace.join("\n"))

data/lib/goliath/request.rb

@@ -92,7 +92,7 @@ module Goliath
 
         @env[REQUEST_METHOD]  = parser.http_method
         @env[REQUEST_URI]     = parser.request_url
-        @env[QUERY_STRING]    = uri.query
+        @env[QUERY_STRING]    = uri.query || ''.freeze
         @env[HTTP_VERSION]    = parser.http_version.join('.')
         @env[SCRIPT_NAME]     = ""
         @env[REQUEST_PATH]    = uri.path
@@ -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,28 +212,53 @@ 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
     # @return [Nil]
     def server_exception(e)
       if e.is_a?(Goliath::Validation::Error)
-        status, headers, body = [e.status_code, {}, ('{"error":"%s"}' % e.message)]
+        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

@@ -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/runner.rb

@@ -150,6 +150,7 @@ module Goliath
         opts.on('-a', '--address HOST', "Bind to HOST address (default: #{@options[:address]})") { |addr| @options[:address] = addr }
         opts.on('-p', '--port PORT', "Use PORT (default: #{@options[:port]})") { |port| @options[:port] = port.to_i }
         opts.on('-S', '--socket FILE', "Bind to unix domain socket") { |v| @options[:address] = v; @options[:port] = nil }
+        opts.on('-E', '--einhorn', "Use Einhorn socket manager") { |v| @options[:einhorn] = true }
 
         opts.separator ""
         opts.separator "Daemon options:"
@@ -211,7 +212,8 @@ module Goliath
 
           File.umask(0000)
 
-          stdout_log_file = "#{File.dirname(@log_file)}/#{File.basename(@log_file)}_stdout.log"
+          log_extension = File.extname(@log_file)
+          stdout_log_file = "#{File.dirname(@log_file)}/#{File.basename(@log_file, log_extension)}_stdout#{log_extension}"
 
           STDIN.reopen("/dev/null")
           STDOUT.reopen(stdout_log_file, "a")
@@ -296,8 +298,7 @@ module Goliath
      # @return [Nil]
      def run_server
        log = setup_logger
-
-       log.info("Starting server on #{@address}:#{@port} in #{Goliath.env} mode. Watch out for stones.")
+       log.info("Starting server on http#{ @server_options[:ssl] ? 's' : nil }://#{@address}:#{@port} in #{Goliath.env} mode. Watch out for stones.")
 
        server = setup_server(log)
        server.api.setup if server.api.respond_to?(:setup)

data/lib/goliath/server.rb

@@ -1,4 +1,5 @@
 require 'em-synchrony'
+require 'einhorn'
 require 'goliath/connection'
 require 'goliath/goliath'
 
@@ -83,7 +84,7 @@ module Goliath
 
         EM.set_effective_user(options[:user]) if options[:user]
 
-        config[Goliath::Constants::GOLIATH_SIGNATURE] = EM.start_server(address, port, Goliath::Connection) do |conn|
+        config[Goliath::Constants::GOLIATH_SIGNATURE] = start_server(options) do |conn|
           if options[:ssl]
             conn.start_tls(
               :private_key_file => options[:ssl_key],
@@ -105,9 +106,23 @@ module Goliath
       end
     end
 
+    def start_server(options, &blk)
+      if options[:einhorn]
+        fd_num = Einhorn::Worker.socket!
+        socket = Socket.for_fd(fd_num)
+
+        EM.attach_server(socket, Goliath::Connection, &blk)
+      else
+        EM.start_server(address, port, Goliath::Connection, &blk)
+      end
+    end
+
     # Stops the server running.
     def stop
-      EM.stop
+      EM.add_timer(0) do
+        logger.info('Stopping server...')
+        EM.stop
+      end
     end
 
     # Loads a configuration file

data/lib/goliath/test_helper_sse.rb

@@ -0,0 +1,76 @@
+require 'em-eventsource'
+
+module Goliath
+  module TestHelper
+    class SSEHelper
+      attr_reader :connection
+      def initialize(url)
+        @message_queue = EM::Queue.new
+        @named_queues = {}
+        @connection = EM::EventSource.new(url)
+      end
+
+      def listen
+        @connection.message do |message|
+          @message_queue.push(message)
+        end
+      end
+
+      def listen_to(name)
+        queue = (@named_queues[name] ||= [])
+        @connection.on(name) do |message|
+          queue.push(message)
+        end
+      end
+
+      def receive
+        pop_queue(@message_queue)
+      end
+
+      def receive_on(name)
+        queue = @named_queues.fetch(name) do
+          raise ArgumentError, "You have to call listen_to('#{name}') first"
+        end
+
+        pop_queue(queue)
+      end
+
+      def with_async_http
+        klass = EM::HttpConnection
+        if klass.instance_methods.include?(:aget)
+          begin
+            klass.send(:class_eval) do
+              alias :sget :get
+              alias :get :aget
+            end
+            yield if block_given?
+          ensure
+            klass.send(:class_eval) do
+              alias :get :sget
+              remove_method :sget
+            end
+          end
+        else
+          yield if block_given?
+        end
+      end
+
+      protected
+
+      def pop_queue(queue)
+        fiber = Fiber.current
+        queue.pop { |m| fiber.resume(m) }
+        Fiber.yield
+      end
+    end
+
+    def sse_client_connect(path,&blk)
+      url = "http://localhost:#{@test_server_port}#{path}"
+      client = SSEHelper.new(url)
+      client.with_async_http { client.connection.start }
+      client.listen
+      Fiber.new { blk.call(client) }.resume if blk
+      stop
+    end
+  end
+end

data/lib/goliath/validation/error.rb

@@ -4,6 +4,8 @@ module Goliath
     class Error < StandardError
       # The status code to return from the error handler
       attr_accessor :status_code
+      # The headers to return from the error handler
+      attr_accessor :headers
 
       # Create a new Goliath::Validation::Error.
       #
@@ -13,9 +15,10 @@ module Goliath
       # @param status_code [Integer] The status code to return
       # @param message [String] The error message to return
       # @return [Goliath::Validation::Error] The Goliath::Validation::Error
-      def initialize(status_code, message)
+      def initialize(status_code, message, headers = {})
         super(message)
         @status_code = status_code
+        @headers = headers
       end
     end
   end

data/lib/goliath/version.rb

@@ -1,4 +1,4 @@
 module Goliath
   # The current version of Goliath
-  VERSION = '1.0.4'
+  VERSION = '1.0.6'
 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,9 +35,9 @@ 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
-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