goliath 0.9.1 → 0.9.2

data/lib/goliath/test_helper.rb

@@ -2,6 +2,7 @@ require 'em-synchrony'
 require 'em-synchrony/em-http'
 
 require 'goliath/server'
+require 'goliath/rack/builder'
 require 'rack'
 
 module Goliath
@@ -24,20 +25,7 @@ module Goliath
   #
   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
+      Goliath.env = :test
     end
 
     # Launches an instance of a given API server. The server
@@ -47,17 +35,17 @@ module Goliath
     # @param port [Integer] The port to run the server on
     # @param options [Hash] The options hash to provide to the server
     # @return [Goliath::Server] The executed server
-    def server(api, port = 9000, options = {})
+    def server(api, port = 9000, options = {}, &blk)
       op = OptionParser.new
 
       s = Goliath::Server.new
       s.logger = mock('log').as_null_object
       s.api = api.new
-      s.app = build_app(api)
+      s.app = Goliath::Rack::Builder.build(api, s.api)
       s.api.options_parser(op, options)
       s.options = options
       s.port = port
-      s.start
+      s.start(&blk)
       s
     end
 
@@ -76,10 +64,7 @@ module Goliath
     # @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, options = {}, &blk)
-      EM.synchrony do
-        @api_server = server(api, 9000, options)
-        blk.call
-      end
+      server(api, 9000, options, &blk)
     end
 
     # Helper method to setup common callbacks for various request methods.
@@ -99,6 +84,17 @@ module Goliath
       req.errback { stop }
     end
 
+    # Make a HEAD request the currently launched API.
+    #
+    # @param request_data [Hash] Any data to pass to the HEAD request.
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback block to execute
+    def head_request(request_data = {}, errback = nil, &blk)
+      path = request_data.delete(:path) || ''
+      req = EM::HttpRequest.new("http://localhost:9000#{path}").head(request_data)
+      hookup_request_callbacks(req, errback, &blk)
+    end
+
     # Make a GET request the currently launched API.
     #
     # @param request_data [Hash] Any data to pass to the GET request.
@@ -120,5 +116,27 @@ module Goliath
       req = EM::HttpRequest.new("http://localhost:9000#{path}").post(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
+
+    # Make a PUT request the currently launched API.
+    #
+    # @param request_data [Hash] Any data to pass to the PUT request.
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback block to execute
+    def put_request(request_data = {}, errback = nil, &blk)
+      path = request_data.delete(:path) || ''
+      req = EM::HttpRequest.new("http://localhost:9000#{path}").put(request_data)
+      hookup_request_callbacks(req, errback, &blk)
+    end
+
+    # Make a DELETE request the currently launched API.
+    #
+    # @param request_data [Hash] Any data to pass to the DELETE request.
+    # @param errback [Proc] An error handler to attach
+    # @param blk [Proc] The callback block to execute
+    def delete_request(request_data = {}, errback = nil, &blk)
+      path = request_data.delete(:path) || ''
+      req = EM::HttpRequest.new("http://localhost:9000#{path}").delete(request_data)
+      hookup_request_callbacks(req, errback, &blk)
+    end
   end
 end

data/lib/goliath/validation.rb

@@ -0,0 +1,2 @@
+require 'goliath/validation/error'
+require 'goliath/validation/standard_http_errors'

data/lib/goliath/{rack/validation_error.rb → validation/error.rb}

@@ -19,20 +19,4 @@ module Goliath
       end
     end
   end
-
-  module Rack
-    # Middleware to catch {Goliath::Validation::Error} exceptions
-    # and returns the [status code, no headers, :error => exception message]
-    class ValidationError
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        @app.call(env)
-      rescue Goliath::Validation::Error => e
-        [e.status_code, {}, {:error => e.message}]
-      end
-    end
-  end
 end

data/lib/goliath/validation/standard_http_errors.rb

@@ -0,0 +1,31 @@
+require 'goliath/validation/error'
+require 'goliath/http_status_codes'
+
+module Goliath
+  #
+  # Make a subclass of Goliath::Validation::Error for each standard HTTP error
+  # code (4xx and 5xx). Error will have a default status_code and message
+  # correct for that response:
+  #
+  #     err = Goliath::Validation::NotFoundError.new
+  #     p [err.status_code, err.to_s]
+  #     # => [400, "Not Found"]
+  #
+  # Each class is named for the standard HTTP message, so 504 'Gateway Time-out'
+  # becomes a Goliath::Validation::GatewayTimeoutError (except 'Internal Server
+  # Error', which becomes InternalServerError not InternalServerErrorError). All non-alphanumeric
+  # characters are smushed together, with no upcasing or
+  # downcasing.
+  HTTP_ERROR_CODES = HTTP_STATUS_CODES.select { |code,msg| code >= 400 && code <= 599 }
+
+  HTTP_ERROR_CODES.each do |code, msg|
+    klass_name = "#{msg.gsub(/\W+/, '')}Error".gsub(/ErrorError$/, "Error")
+    klass = Class.new(Goliath::Validation::Error)
+    klass.class_eval(%Q{
+      def initialize(message='#{msg}')
+        super('#{code}', message)
+      end }, __FILE__, __LINE__)
+
+    Goliath::Validation.const_set(klass_name, klass)
+  end
+end

data/lib/goliath/version.rb

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

data/spec/integration/http_log_spec.rb

@@ -32,14 +32,14 @@ describe HttpLog do
 
   let(:api_options) { { :config => config_file } }
 
-  def mock_mongo
-    @api_server.config['mongo'] = mock('mongo').as_null_object
+  def mock_mongo(api)
+    api.config['mongo'] = mock('mongo').as_null_object
   end
 
   it 'responds to requests' do
-    with_api(HttpLog, api_options) do
+    with_api(HttpLog, api_options) do |api|
       server(Responder, 8080)
-      mock_mongo
+      mock_mongo(api)
 
       get_request({}, err) do |c|
         c.response_header.status.should == 200
@@ -48,9 +48,9 @@ describe HttpLog do
   end
 
   it 'forwards to our API server' do
-    with_api(HttpLog, api_options) do
+    with_api(HttpLog, api_options) do |api|
       server(Responder, 8080)
-      mock_mongo
+      mock_mongo(api)
 
       get_request({}, err) do |c|
         c.response_header.status.should == 200
@@ -70,9 +70,9 @@ describe HttpLog do
 
   context 'query parameters' do
     it 'forwards the query parameters' do
-      with_api(HttpLog, api_options) do
+      with_api(HttpLog, api_options) do |api|
         server(Responder, 8080)
-        mock_mongo
+        mock_mongo(api)
 
         get_request({:query => {:first => :foo, :second => :bar, :third => :baz}}, err) do |c|
           c.response_header.status.should == 200
@@ -84,9 +84,9 @@ describe HttpLog do
 
   context 'request path' do
     it 'forwards the request path' do
-      with_api(HttpLog, api_options) do
+      with_api(HttpLog, api_options) do |api|
         server(Responder, 8080)
-        mock_mongo
+        mock_mongo(api)
 
         get_request({:path => '/my/request/path'}, err) do |c|
           c.response_header.status.should == 200
@@ -98,9 +98,9 @@ describe HttpLog do
 
   context 'headers' do
     it 'forwards the headers' do
-      with_api(HttpLog, api_options) do
+      with_api(HttpLog, api_options) do |api|
         server(Responder, 8080)
-        mock_mongo
+        mock_mongo(api)
 
         get_request({:head => {:first => :foo, :second => :bar}}, err) do |c|
           c.response_header.status.should == 200
@@ -112,9 +112,9 @@ describe HttpLog do
 
   context 'request method' do
     it 'forwards GET requests' do
-      with_api(HttpLog, api_options) do
+      with_api(HttpLog, api_options) do |api|
         server(Responder, 8080)
-        mock_mongo
+        mock_mongo(api)
 
         get_request({}, err) do |c|
           c.response_header.status.should == 200
@@ -124,9 +124,9 @@ describe HttpLog do
     end
 
     it 'forwards POST requests' do
-      with_api(HttpLog, api_options) do
+      with_api(HttpLog, api_options) do |api|
         server(Responder, 8080)
-        mock_mongo
+        mock_mongo(api)
 
         post_request({}, err) do |c|
           c.response_header.status.should == 200

data/spec/integration/rack_routes_spec.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/rack_routes')
+
+describe RackRoutes do
+  let(:err) { Proc.new { fail "API request failed" } }
+
+  context "when using maps" do
+
+    it "ignores #response" do
+      expect {
+        with_api(RackRoutes) do
+          get_request({:path => '/'}, err) {}
+        end
+      }.to_not raise_error
+    end
+
+    it 'fallback not found to missing' do
+      with_api(RackRoutes) do
+        get_request({:path => '/donkey'}, err) do |cb|
+          cb.response_header.status.should == 404
+          cb.response.should == 'Try /version /hello_world, /bonjour, or /hola'
+        end
+      end
+      with_api(RackRoutes) do
+        get_request({:path => '/'}, err) do |cb|
+          cb.response_header.status.should == 404
+          cb.response.should == 'Try /version /hello_world, /bonjour, or /hola'
+        end
+      end
+    end
+
+    it 'fallback not found to /' do
+      with_api(RackRoutes) do
+        get_request({:path => '/donkey'}, err) do |cb|
+          cb.response_header.status.should == 404
+          cb.response.should == 'Try /version /hello_world, /bonjour, or /hola'
+        end
+      end
+    end
+
+    it 'routes to the correct API' do
+      with_api(RackRoutes) do
+        get_request({:path => '/bonjour'}, err) do |c|
+          c.response_header.status.should == 200
+          c.response.should == 'bonjour!'
+        end
+      end
+    end
+
+    it 'routes to the correct API using regex filters' do
+      with_api(RackRoutes) do
+        get_request({:path => '/98'}, err) do |c|
+          c.response_header.status.should == 200
+          c.response.should == 'number 98!'
+        end
+      end
+    end
+
+    it 'routes to the correct API referencing params in the body of the buidler' do
+      with_api(RackRoutes) do
+        get_request({:path => '/123123'}, err) do |c|
+          c.response_header.status.should == 200
+          c.response.should == 'big number 123123!'
+        end
+      end
+    end
+
+    context 'sinatra style route definition' do
+      it 'should honor the request method' do
+        with_api(RackRoutes) do
+          post_request({:path => '/hello_world'}, err) do |c|
+            c.response_header.status.should == 200
+            c.response.should == 'hello post world!'
+          end
+        end
+      end
+      it 'should reject other request methods' do
+        with_api(RackRoutes) do
+          put_request({:path => '/hello_world'}, err) do |c|
+            c.response_header.status.should == 405
+            c.response_header['ALLOW'].split(/, /).should == %w(GET HEAD POST)
+          end
+        end
+      end
+    end
+
+    context 'routes defined with get' do
+      it 'should allow get' do
+        with_api(RackRoutes) do
+          get_request({:path => '/hello_world'}, err) do |c|
+            c.response_header.status.should == 200
+            c.response.should == 'hello world!'
+          end
+        end
+      end
+      it 'should allow head' do
+        with_api(RackRoutes) do
+          head_request({:path => '/hello_world'}, err) do |c|
+            c.response_header.status.should == 200
+            c.response.should == 'hello world!'
+          end
+        end
+      end
+    end
+
+    context "defined in blocks" do
+      it 'uses middleware defined in the block' do
+        with_api(RackRoutes) do
+          post_request({:path => '/hola'}, err) do |c|
+            # the /hola route only supports GET requests
+            c.response_header.status.should == 405
+            c.response.should == '[:error, "Invalid request method"]'
+            c.response_header['ALLOW'].should == 'GET'
+          end
+        end
+      end
+
+      it "doesn't use middleware defined in the API" do
+        with_api(RackRoutes) do
+          get_request({:path => '/hola'}, err) do |cb|
+            # it doesn't raise required param error
+            cb.response_header.status.should == 200
+            cb.response.should == "hola!"
+          end
+        end
+      end
+    end
+
+    context "defined in classes" do
+      it 'uses API middleware' do
+        with_api(RackRoutes) do
+          post_request({:path => '/aloha'}, err) do |c|
+            # the /hola route only supports GET requests
+            c.response_header.status.should == 405
+            c.response.should == '[:error, "Invalid request method"]'
+            c.response_header['ALLOW'].should == 'GET'
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/integration/reloader_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-Goliath.env = 'dev'
+Goliath.env = :development
 
 class ReloaderDev < Goliath::API
   use Goliath::Rack::Params
@@ -17,8 +17,8 @@ end
 describe "Reloader" do
   let(:err) { Proc.new { fail "API request failed" } }
 
-  before(:each) { Goliath.env = "dev" }
-  after(:each) { Goliath.env = "test" }
+  before(:each) { Goliath.env = :development }
+  after(:each) { Goliath.env = :test }
 
   def count(klass)
     cnt = 0
@@ -37,7 +37,7 @@ describe "Reloader" do
   end
 
   it "doesn't add in prod mode" do
-    Goliath.env = "prod"
+    Goliath.env = :production
     count(ReloaderProd).should == 0
   end
 end

data/spec/integration/template_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'examples/template')
+
+describe Template do
+
+  def config_file
+    File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'examples', 'config', 'template.rb'))
+  end
+
+  let(:api_options) { { :config => config_file } }
+
+  it 'renders haml template with default haml layout' do
+    with_api(Template, api_options) do
+      get_request do |c|
+        c.response.should =~ %r{<li><a href="/joke">Tell me a joke</a></li>}
+      end
+    end
+  end
+
+  it 'renders a markdown template with default haml layout' do
+    with_api(Template, api_options) do
+      get_request(:path => '/joke') do |c|
+        c.response.should =~ %r{<code>"Arr, I dunno matey -- but it's drivin' me nuts!"\s*</code>}m
+      end
+    end
+  end
+
+  it 'lets me specify an alternate layout engine' do
+    with_api(Template, api_options) do
+      get_request(:path => '/erb_me') do |c|
+        c.response.should =~ %r{I AM ERB</h1>}m
+      end
+    end
+  end
+
+  it 'accepts local variables' do
+    with_api(Template, api_options) do
+      get_request(:path => '/erb_me') do |c|
+        c.response.should =~ %r{<title>HERE IS A JOKE</title>}m
+      end
+    end
+  end
+
+  describe 'On a missing template' do
+    it 'raises an explanatory 500 error' do
+      with_api(Template, api_options) do
+        get_request(:path => '/oops') do |c|
+          c.response.should =~ %r{^\[:error, "Template no_such_template not found in .*examples/views for haml"\]$}
+          c.response_header.status.should == 500
+        end
+      end
+    end
+  end
+end