goliath 1.0.2 → 1.0.3

data/examples/echo.rb

@@ -18,7 +18,7 @@ class Echo < Goliath::API
   # If you are using Golaith version <=0.9.1 you need to Goliath::Rack::ValidationError
   # to prevent the request from remaining open after an error occurs
   #use Goliath::Rack::ValidationError
-  use Goliath::Rack::Validation::RequestMethod, %w(GET POST)           # allow GET and POST requests only
+  use Goliath::Rack::Validation::RequestMethod, %w(GET POST PATCH) # allow GET, POST and PATCH requests only
   use Goliath::Rack::Validation::RequiredParam, {:key => 'echo'}  # must provide ?echo= query or body param
 
   plugin Goliath::Plugin::Latency       # output reactor latency every second

data/goliath.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   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.5.3'
+  s.add_dependency 'http_parser.rb', '0.6.0.beta.2'
   s.add_dependency 'log4r'
 
   s.add_dependency 'rack', '>=1.2.2'

data/lib/goliath/request.rb

@@ -4,6 +4,7 @@ require 'goliath/response'
 require 'goliath/validation'
 require 'async_rack'
 require 'stringio'
+require 'uri'
 
 module Goliath
   # Goliath::Request is responsible for processing a request and returning
@@ -86,14 +87,16 @@ module Goliath
         @env[SERVER_PORT] = port if port
       end
 
+      uri = URI(parser.request_url)
+
       @env[REQUEST_METHOD]  = parser.http_method
       @env[REQUEST_URI]     = parser.request_url
-      @env[QUERY_STRING]    = parser.query_string
+      @env[QUERY_STRING]    = uri.query
       @env[HTTP_VERSION]    = parser.http_version.join('.')
-      @env[SCRIPT_NAME]     = parser.request_path
-      @env[REQUEST_PATH]    = parser.request_path
-      @env[PATH_INFO]       = parser.request_path
-      @env[FRAGMENT]        = parser.fragment
+      @env[SCRIPT_NAME]     = uri.path
+      @env[REQUEST_PATH]    = uri.path
+      @env[PATH_INFO]       = uri.path
+      @env[FRAGMENT]        = uri.fragment
 
       yield if block_given?
 

data/lib/goliath/runner.rb

@@ -86,6 +86,9 @@ module Goliath
     # @return [Array] The list of plugins to be executed by the server
     attr_accessor :plugins
 
+    # Allow to inject a custom logger
+    attr_accessor :logger
+
     # Any additional server options
     # @return [Hash] Any options to be passed to the server
     attr_accessor :app_options
@@ -238,6 +241,10 @@ module Goliath
     # Sets up the logging for the runner
     # @return [Logger] The logger object
      def setup_logger
+       if logger
+         warn_on_custom_logger
+         return logger
+       end
        log = Log4r::Logger.new('goliath')
 
        log_format = Log4r::PatternFormatter.new(:pattern => "[#{Process.pid}:%l] %d :: %m")
@@ -312,5 +319,11 @@ module Goliath
      def remove_pid
        File.delete(@pid_file)
      end
+
+     def warn_on_custom_logger
+       warn "log_file option will not take effect with a custom logger" if @log_file
+       warn "log_stdout option will not take effect with a custom logger" if @log_stdout
+       warn "verbose option will not take effect with a custom logger" if @verbose
+     end
   end
 end

data/lib/goliath/server.rb

@@ -159,7 +159,15 @@ module Goliath
       @plugins.each do |(name, args)|
         logger.info("Loading #{name.to_s}")
 
-        plugin = name.new(port, config, status, logger)
+        if name.instance_method(:initialize).arity != 5 then
+          logger.warn( "Plugins now take 5 parameters (address, port, config, status, logger). " +
+              "You appear to be using the old style 4 parameter method (port, config, status, logger). " +
+              "Please update your plugins as the 4 parameter method is deprecated." );
+          plugin = name.new(port, config, status, logger)
+        else
+          plugin = name.new(address, port, config, status, logger)
+        end
+
         plugin.run(*args)
       end
     end

data/lib/goliath/test_helper.rb

@@ -27,6 +27,8 @@ module Goliath
   #   end
   #
   module TestHelper
+    DEFAULT_ERROR = Proc.new { fail "API request failed" }
+
     def self.included(mod)
       Goliath.env = :test
     end
@@ -114,7 +116,7 @@ module Goliath
     # @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)
+    def head_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).head(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -124,7 +126,7 @@ module Goliath
     # @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)
+    def get_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).get(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -134,7 +136,7 @@ module Goliath
     # @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)
+    def post_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).post(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -144,7 +146,7 @@ module Goliath
     # @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)
+    def put_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).put(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -154,7 +156,7 @@ module Goliath
     # @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 patch_request(request_data = {}, errback = nil, &blk)
+    def patch_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).patch(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -164,7 +166,7 @@ module Goliath
     # @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)
+    def delete_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).delete(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end
@@ -174,7 +176,7 @@ module Goliath
     # @param request_data [Hash] Any data to pass to the OPTIONS request.
     # @param errback [Proc] An error handler to attach
     # @param blk [Proc] The callback block to execute
-    def options_request(request_data = {}, errback = nil, &blk)
+    def options_request(request_data = {}, errback = DEFAULT_ERROR, &blk)
       req = create_test_request(request_data).options(request_data)
       hookup_request_callbacks(req, errback, &blk)
     end

data/lib/goliath/version.rb

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

data/spec/integration/echo_spec.rb

@@ -59,4 +59,13 @@ describe Echo do
       end
     end
   end
+
+  it 'echos PATCH data' do
+    with_api(Echo) do
+      patch_request({:body => {'echo' => 'test'}}, err) do |c|
+        b = MultiJson.load(c.response)
+        b['response'].should == 'test'
+      end
+    end
+  end
 end

data/spec/unit/request_spec.rb

@@ -55,6 +55,7 @@ describe Goliath::Request do
   describe 'parse_headers' do
     it 'sets content_type correctly' do
       parser = mock('parser').as_null_object
+      parser.stub(:request_url).and_return('')
 
       @r.parse_header({'Content-Type' => 'text/plain'}, parser)
       @r.env['CONTENT_TYPE'].should == 'text/plain'
@@ -62,6 +63,7 @@ describe Goliath::Request do
 
     it 'sets content_length correctly' do
       parser = mock('parser').as_null_object
+      parser.stub(:request_url).and_return('')
 
       @r.parse_header({'Content-Length' => 42}, parser)
       @r.env['CONTENT_LENGTH'].should == 42
@@ -69,6 +71,7 @@ describe Goliath::Request do
 
     it 'sets server_name and server_port correctly' do
       parser = mock('parser').as_null_object
+      parser.stub(:request_url).and_return('')
 
       @r.parse_header({'Host' => 'myhost.com:3000'}, parser)
       @r.env['SERVER_NAME'].should == 'myhost.com'

data/spec/unit/runner_spec.rb

@@ -95,6 +95,17 @@ describe Goliath::Runner do
             log = @r.send(:setup_logger)
           end
         end
+
+        describe "custom logger" do
+
+          it "doesn't configure Log4r" do
+            CustomLogger = Struct.new(:info, :debug, :error, :fatal)
+            Log4r::Logger.should_not_receive(:new)
+            @r.logger = CustomLogger.new
+            log = @r.send(:setup_logger)
+          end
+
+        end
       end
 
       it 'creates the log dir if neeed' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goliath
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0.beta.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: 0.6.0.beta.2
 - !ruby/object:Gem::Dependency
   name: log4r
   requirement: !ruby/object:Gem::Requirement
@@ -487,12 +487,10 @@ files:
 - examples/activerecord/config/srv.rb
 - examples/activerecord/srv.rb
 - examples/api_proxy.rb
-- examples/around.rb
 - examples/async_aroundware_demo.rb
 - examples/async_upload.rb
 - examples/auth_and_rate_limit.rb
 - examples/chunked_streaming.rb
-- examples/clone.rb
 - examples/conf_test.rb
 - examples/config/auth_and_rate_limit.rb
 - examples/config/conf_test.rb
@@ -519,12 +517,9 @@ files:
 - examples/rasterize/rasterize.js
 - examples/rasterize/rasterize.rb
 - examples/rasterize/rasterize_and_shorten.rb
-- examples/router.rb
 - examples/stream.rb
 - examples/template.rb
-- examples/test.rb
 - examples/test_rig.rb
-- examples/upload.rb
 - examples/views/debug.haml
 - examples/views/joke.markdown
 - examples/views/layout.erb

data/examples/around.rb

@@ -1,38 +0,0 @@
-#!/usr/bin/env ruby
-$:<< '../lib' << 'lib'
-
-require 'goliath'
-
-class ApiValidationAroundware
-  include Goliath::Rack::SimpleAroundware
-  class InvalidApiKeyError < Goliath::Validation::BadRequestError; end
-  
-  def pre_process
-    validate_api_key!
-    env.logger.info "past api_key validation" #<-- this is output, then an empty response header & body as if it is just hanging...
-    Goliath::Connection::AsyncResponse
-  end 
-  
-  def post_process
-    [status, headers, body]
-  end
-  
-  def validate_api_key!
-    server_api_key = env['config']['server_api_key'].to_s
-    if api_key != server_api_key
-      raise InvalidApiKeyError
-    end
-  end
-
-  # retreive the client's api_key  
-  def api_key
-    env['HTTP_API_KEY'].to_s
-  end
-end
-
-class AwesomeApiWithLogging < Goliath::API
-  use Goliath::Rack::SimpleAroundwareFactory, ApiValidationAroundware
-  def response(env)
-    [200, {}, "Hello"]
-  end
-end

data/examples/clone.rb

@@ -1,26 +0,0 @@
-#!/usr/bin/env ruby
-$:<< '../lib' << 'lib'
-
-require 'goliath'
-
-class RandomAPI2 < Goliath::API
-  use Goliath::Rack::Params
-  use Goliath::Rack::Validation::Param, :key => 'user'
-
-  def response(env)
-    [200, {}, "Hello 2!"]
-  end
-end
-
-class Router < Goliath::API
-  map '/', RandomAPI2
-end
-
-# class PlainApi < Goliath::API
-#   use Goliath::Rack::Params
-#   use Goliath::Rack::Validation::Param, :key => 'user'
-
-#   def response(env)
-#     [200, {}, "Hello 2!"]
-#   end
-# end

data/examples/router.rb

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-$:<< '../lib' << 'lib'
-
-require 'goliath'
-require 'test'
-
-
-class Router < Goliath::API
-  get '/v1/app/:appid/binary/:key', RawFileApp
-  put '/v1/app/:appid/binary/:key', RawFileApp
-
-  not_found do
-    run Proc.new { |env| [404, {"Content-Type" => "text/html"}, "not found"] }
-  end
-end

data/examples/test.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-$:<< '../lib' << 'lib'
-
-require 'goliath'
-
-class RawFileApp < Goliath::API
-  use Goliath::Rack::Params                 # parse & merge query and body parameters
-  use Goliath::Rack::DefaultMimeType        # cleanup accepted media types
-  use Goliath::Rack::Formatters::JSON       # JSON output formatter
-  use Goliath::Rack::Render                 # auto-negotiate response format
-
-  def response(env)
-    p params
-    p params['key2']
-    p params[:key2]
-    obj = {
-      somekey: 'val',
-      otherkey: 42
-    }
-    [200, { 'Content-Type' => 'application/json' }, obj]
-  end
-end
-
-class Router < Goliath::API
-  get '/v1/app/:appid/binary/:key', RawFileApp
-  put '/v1/app/:appid/binary/:key', RawFileApp
-
-  not_found do
-    run Proc.new { |env| [404, {"Content-Type" => "text/html"}, "not found"] }
-  end
-end

data/examples/upload.rb

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-$:<< '../lib' << 'lib'
-
-require 'goliath'
-
-class Upload < Goliath::API
-  
-  def on_headers(env, h)
-    if h['Expect'] == '100-continue'
-      env.stream_send "HTTP/1.1 100 Continue\r\n"
-    end
-  end
-
-  def response(env)
-    [200, {}, "oh hai"]
-  end
-end