goliath 0.9.0

data/lib/goliath/test_helper.rb

@@ -0,0 +1,118 @@
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+
+require 'goliath/server'
+require 'rack'
+
+module Goliath
+  # Methods to help with testing Goliath APIs
+  #
+  # @example
+  #   describe Echo do
+  #     include Goliath::TestHelper
+  #
+  #     let(:err) { Proc.new { fail "API request failed" } }
+  #     it 'returns the echo param' do
+  #       with_api(Echo) do
+  #         get_request({:query => {:echo => 'test'}}, err) do |c|
+  #           b = Yajl::Parser.parse(c.response)
+  #           b['response'].should == 'test'
+  #         end
+  #       end
+  #     end
+  #   end
+  #
+  module TestHelper
+    def self.included(mod)
+      Goliath.env = 'test'
+    end
+
+    # Builds the rack middleware chain for the given API
+    #
+    # @param klass [Class] The API class to build the middlewares for
+    # @return [Object] The Rack middleware chain
+    def build_app(klass)
+      ::Rack::Builder.new do
+        klass.middlewares.each do |mw|
+          use(*(mw[0..1].compact), &mw[2])
+        end
+        run klass.new
+      end
+    end
+
+    # Launches an instance of a given API server. The server
+    # will launch on the default settings of localhost port 9000.
+    #
+    # @param api [Class] The API class to launch
+    # @param port [Integer] The port to run the server on
+    # @return [Nil]
+    def server(api, port = 9000)
+      s = Goliath::Server.new
+      s.logger = mock('log').as_null_object
+      s.api = api.new
+      s.app = build_app(api)
+      s.port = port
+      s.start
+      s
+    end
+
+    # Stops the launched API
+    #
+    # @return [Nil]
+    def stop
+      EM.stop
+    end
+
+    # Wrapper for launching API and executing given code block. This
+    # will start the EventMachine reactor running.
+    #
+    # @param api [Class] The API class to launch
+    # @param blk [Proc] The code to execute after the server is launched.
+    # @note This will not return until stop is called.
+    def with_api(api, &blk)
+      EM.synchrony do
+        @api_server = server(api)
+        blk.call
+      end
+    end
+
+    # Helper method to setup common callbacks for various request methods.
+    # The given err and callback handlers will be attached and a callback
+    # to stop the reactor will be added.
+    #
+    # @param req [EM::HttpRequest] The HTTP request to augment
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback handler to attach
+    # @return [Nil]
+    # @api private
+    def hookup_request_callbacks(req, errback, &blk)
+      req.callback &blk
+      req.callback { stop }
+
+      req.errback &errback if errback
+      req.errback { stop }
+    end
+
+    # Make a GET request the currently launched API.
+    #
+    # @param request_data [Hash] Any data to pass to the GET request.
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback block to execute
+    def get_request(request_data = {}, errback = nil, &blk)
+      path = request_data.delete(:path) || ''
+      req = EM::HttpRequest.new("http://localhost:9000#{path}").get(request_data)
+      hookup_request_callbacks(req, errback, &blk)
+    end
+
+    # Make a POST request the currently launched API.
+    #
+    # @param request_data [Hash] Any data to pass to the POST request.
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback block to execute
+    def post_request(request_data = {}, errback = nil, &blk)
+      path = request_data.delete(:path) || ''
+      req = EM::HttpRequest.new("http://localhost:9000#{path}").post(request_data)
+      hookup_request_callbacks(req, errback, &blk)
+    end
+  end
+end

data/lib/goliath/version.rb

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

data/spec/integration/async_request_processing.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/async_upload')
+
+describe 'Async Request processing' do
+  include Goliath::TestHelper
+
+  it 'asynchronously processes the incoming request' do
+    with_api(AsyncUpload) do
+      request_data = {
+        :body => {:some => :data},
+        :head => {'X-Upload' => 'custom'}
+      }
+
+      err = Proc.new { fail "API request failed" }
+
+      post_request(request_data, err) do |c|
+        resp = Yajl::Parser.parse(c.response)
+        resp['body'].should match('some=data')
+        resp['head'].should include('X-Upload')
+      end
+    end
+  end
+end

data/spec/integration/echo_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/echo')
+
+describe Echo do
+  include Goliath::TestHelper
+
+  let(:err) { Proc.new { fail "API request failed" } }
+
+  it 'returns the echo param' do
+    with_api(Echo) do
+      get_request({:query => {:echo => 'test'}}, err) do |c|
+        b = Yajl::Parser.parse(c.response)
+        b['response'].should == 'test'
+      end
+    end
+  end
+
+  it 'returns error without echo' do
+    with_api(Echo) do
+      get_request({}, err) do |c|
+        b = Yajl::Parser.parse(c.response)
+        b['error'].should_not be_nil
+        b['error'].should == 'Echo identifier missing'
+      end
+    end
+  end
+end

data/spec/integration/keepalive_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/echo')
+
+describe 'HTTP Keep-Alive support' do
+  include Goliath::TestHelper
+
+  it 'serves multiple requests via single connection' do
+    with_api(Echo) do
+      conn = EM::HttpRequest.new('http://localhost:9000')
+      r1 = conn.get(:query => {:echo => 'test'}, :keepalive => true)
+
+      r1.errback { fail }
+      r1.callback do |c|
+        b = Yajl::Parser.parse(c.response)
+        b['response'].should == 'test'
+
+        r2 = conn.get(:query => {:echo => 'test2'})
+        r2.errback { fail }
+        r2.callback do |c|
+          b = Yajl::Parser.parse(c.response)
+          b['response'].should == 'test2'
+
+          stop
+        end
+      end
+    end
+  end
+end

data/spec/integration/pipelining_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+class Interleaving < Goliath::API
+  use Goliath::Rack::Params
+
+  def response(env)
+    delay = env.params['delay']
+    EM::Synchrony.sleep(delay.to_f)
+
+    [200, {}, delay]
+  end
+end
+
+describe 'HTTP Pipelining support' do
+  include Goliath::TestHelper
+
+  it 'serves multiple requests via single connection' do
+    with_api(Interleaving) do
+      start = Time.now.to_f
+      res = []
+
+      conn = EM::HttpRequest.new('http://localhost:9000')
+      r1 = conn.aget :query => {:delay => 0.3}, :keepalive => true
+      r2 = conn.aget :query => {:delay => 0.2}
+
+      r1.errback { fail }
+      r1.callback do |c|
+        res << c.response
+        c.response.should match('0.3')
+      end
+
+      r2.errback { fail }
+      r2.callback do |c|
+        res << c.response
+
+        res.should == ['0.3', '0.2']
+        (Time.now.to_f - start).should be_within(0.1).of(0.3)
+
+        stop
+      end
+    end
+  end
+end

data/spec/integration/valid_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/valid')
+
+describe Valid do
+  include Goliath::TestHelper
+
+  let(:err) { Proc.new { fail "API request failed" } }
+
+  it 'returns OK with param' do
+    with_api(Valid) do
+      get_request({:query => {:test => 'test'}}, err) do |c|
+        c.response.should == 'OK'
+      end
+    end
+  end
+
+  it 'returns error without param' do
+    with_api(Valid) do
+      get_request({}, err) do |c|
+        c.response.should == '[:error, "Test identifier missing"]'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler'
+
+Bundler.setup
+Bundler.require
+
+require 'goliath/test_helper'

data/spec/unit/connection_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Goliath::Connection do
+  before(:each) do
+    @c = Goliath::Connection.new('blah')
+  end
+
+  describe 'configuration' do
+    it 'accepts an app' do
+      app = mock('app')
+      @c.app = app
+      @c.app.should == app
+    end
+
+    it 'accepts a logger' do
+      logger = mock('logger')
+      @c.logger = logger
+      @c.logger.should == logger
+    end
+
+    it 'accepts a status object' do
+      status = mock('status')
+      @c.status = status
+      @c.status.should == status
+    end
+
+    it 'accepts config' do
+      config = mock('config')
+      @c.config = config
+      @c.config.should == config
+    end
+  end
+
+  describe 'post_init' do
+    it 'sets up the parser' do
+      @c.post_init
+      @c.instance_variable_get("@parser").should_not be_nil
+    end
+  end
+
+  describe 'receive_data' do
+    it 'passes data to the http parser' do
+      request_mock = mock("parser").as_null_object
+      request_mock.should_receive(:<<)
+
+      @c.instance_variable_set("@parser", request_mock)
+      @c.receive_data('more_data')
+    end
+
+    it "closes the connection when a parse error is received" do
+      current_mock = mock("current").as_null_object
+      current_mock.should_receive(:close)
+
+      @c.instance_variable_set("@current", current_mock)
+      lambda { @c.receive_data("bad data") }.should_not raise_error
+    end
+  end
+
+end

data/spec/unit/env_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'goliath/env'
+
+describe Goliath::Env do
+  before(:each) do
+    @env = Goliath::Env.new
+  end
+
+  it 'responds to []=' do
+    lambda { @env['test'] = 'blah' }.should_not raise_error(Exception)
+  end
+
+  it 'responds to []' do
+    @env['test'] = 'blah'
+    lambda { @env['test'].should == 'blah' }.should_not raise_error(Exception)
+  end
+
+  context '#method_missing' do
+    it 'allows access to items as methods' do
+      @env['db'] = 'test'
+      @env.db.should == 'test'
+    end
+
+    it 'allows access to config items as methods' do
+      @env['config'] = {}
+      @env['config']['db'] = 'test'
+      @env.db.should == 'test'
+    end
+  end
+
+  context '#respond_to?' do
+    it 'returns true for items in the hash' do
+      @env['test'] = 'true'
+      @env.respond_to?(:test).should be_true
+    end
+
+    it 'returns false for items not in hash' do
+      @env.respond_to?(:test).should be_false
+    end
+
+    it 'returns true for items in the config hash' do
+      @env['config'] = {'test' => true}
+      @env.respond_to?(:test).should be_true
+    end
+
+    it 'returns false for items not in the config hash' do
+      @env['config'] = {}
+      @env.respond_to?(:test).should be_false
+    end
+
+    it 'delegates if not found' do
+      @env.respond_to?(:[]).should be_true
+    end
+  end
+end

data/spec/unit/headers_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'goliath/headers'
+
+describe Goliath::Headers do
+  before(:each) do
+    @h = Goliath::Headers.new
+  end
+
+  it 'outputs in the correct format' do
+    @h['my_header'] = 'my_value'
+    @h.to_s.should == "my_header: my_value\r\n"
+  end
+
+  it 'suppresses duplicate keys' do
+    @h['my_header'] = 'my_value1'
+    @h['my_header'] = 'my_value2'
+    @h.to_s.should == "my_header: my_value1\r\n"
+  end
+
+  it 'returns true if a key has been set' do
+    @h['my_header'] = 'my_value'
+    @h.has_key?('my_header').should be_true
+  end
+
+  it 'returns false if the key has not been set' do
+    @h.has_key?('my_header').should be_false
+  end
+
+  it 'ignores nil values' do
+    @h['my_header'] = nil
+    @h.to_s.should == ''
+  end
+
+  it 'allows a value after setting nil' do
+    @h['my_header'] = nil
+    @h['my_header'] = 'my_value'
+    @h.to_s.should == "my_header: my_value\r\n"
+  end
+
+  it 'formats time as an http time' do
+    time = Time.now
+    @h['my_time'] = time
+    @h.to_s.should == "my_time: #{time.httpdate}\r\n"
+  end
+
+  %w(Set-Cookie Set-Cookie2 Warning WWW-Authenticate).each do |key|
+    it "allows #{key} as to be duplicate" do
+      @h[key] = 'value1'
+      @h[key] = 'value2'
+      @h.to_s.should == "#{key}: value1\r\n#{key}: value2\r\n"
+    end
+  end
+end