goliath 0.9.4 → 1.0.0.beta.1

data/examples/rasterize/rasterize.rb

@@ -2,7 +2,6 @@
 $: << File.dirname(__FILE__)+'/../../lib'
 require 'goliath'
 require 'postrank-uri'
-require File.dirname(__FILE__)+'/../favicon'
 
 # Install phantomjs: http://code.google.com/p/phantomjs/wiki/QuickStart
 # $> ruby rasterize.rb -sv
@@ -10,7 +9,7 @@ require File.dirname(__FILE__)+'/../favicon'
 
 class Rasterize < Goliath::API
   use Goliath::Rack::Params
-  use Favicon, File.expand_path(File.dirname(__FILE__)+"/../public/favicon.ico")
+  use Goliath::Rack::Favicon, File.expand_path(File.dirname(__FILE__)+"/../public/favicon.ico")
   use Goliath::Rack::Validation::RequestMethod, %w(GET)
   use Goliath::Rack::Validation::RequiredParam, {:key => 'url'}
 

data/examples/router.rb

@@ -0,0 +1,15 @@
+#!/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/template.rb

@@ -11,10 +11,15 @@ $:<< '../lib' << 'lib'
 # your template's extension must match the engine (foo.markdown, not foo.md)
 
 require 'tilt'
-# use bluecloth as default markdown renderer
-require 'bluecloth'
-Tilt.register 'markdown', Tilt::BlueClothTemplate
-require 'yajl/json_gem'
+
+if RUBY_PLATFORM != 'java'
+  require 'yajl/json_gem'
+  require 'bluecloth' # use bluecloth as default markdown renderer
+  Tilt.register 'markdown', Tilt::BlueClothTemplate
+else
+  require 'maruku'
+  Tilt.register 'markdown', Tilt::MarukuTemplate
+end
 
 require 'goliath'
 require 'goliath/rack/templates'
@@ -24,8 +29,8 @@ class Template < Goliath::API
   include Goliath::Rack::Templates      # render templated files from ./views
 
   use(Rack::Static,                     # render static files from ./public
-            :root => Goliath::Application.app_path("public"),
-            :urls => ["/favicon.ico", '/stylesheets', '/javascripts', '/images'])
+      :root => Goliath::Application.app_path("public"),
+      :urls => ["/favicon.ico", '/stylesheets', '/javascripts', '/images'])
 
   plugin Goliath::Plugin::Latency       # ask eventmachine reactor to track its latency
 
@@ -35,7 +40,9 @@ class Template < Goliath::API
 
   def response(env)
     case env['PATH_INFO']
-    when '/'         then [200, {}, haml(:root)]
+    # TODO(dj2): change /root -> / when rack > 1.4.0 is released
+    when '/root'         then [200, {}, haml(:root)]
+    when '/haml_str' then [200, {}, haml("%h1 Header")]
     when '/debug'    then [200, {}, haml(:debug)]
     when '/oops'     then [200, {}, haml(:no_such_template)] # will 500
     when '/joke'     then

data/examples/test.rb

@@ -0,0 +1,31 @@
+#!/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

@@ -0,0 +1,17 @@
+#!/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

data/examples/views/joke.markdown

@@ -3,11 +3,11 @@
 Pirate walks into a bar with a steering wheel half-in, half-out of his pants.
 
 
-Bartender says 
+Bartender says
 
-    "Hey Pirate, What's With The Steering Wheel?"
+    Hey Pirate, What's With The Steering Wheel?
 
 
-Pirate says 
+Pirate says
 
-    "Arr, I dunno matey -- but it's drivin' me nuts!"
+    Arr, I dunno matey -- but it is driving me nuts!

data/examples/websocket.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+$:<< '../lib' << 'lib'
+
+require 'goliath'
+require 'goliath/websocket'
+require 'goliath/rack/templates'
+
+class Websocket < Goliath::WebSocket
+  include Goliath::Rack::Templates
+
+  use Goliath::Rack::Favicon, File.expand_path(File.dirname(__FILE__) + '/ws/favicon.ico')
+
+  def on_open(env)
+    env.logger.info("WS OPEN")
+    env['subscription'] = env.channel.subscribe { |m| env.stream_send(m) }
+  end
+
+  def on_message(env, msg)
+    env.logger.info("WS MESSAGE: #{msg}")
+    env.channel << msg
+  end
+
+  def on_close(env)
+    env.logger.info("WS CLOSED")
+    env.channel.unsubscribe(env['subscription'])
+  end
+
+  def on_error(env, error)
+    env.logger.error error
+  end
+
+  def response(env)
+    if env['REQUEST_PATH'] == '/ws'
+      super(env)
+    else
+      [200, {}, erb(:index, :views => Goliath::Application.root_path('ws'))]
+    end
+  end
+end

data/examples/ws/index.erb

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>WebSocket ...</title>
+    <script src='http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js'></script>
+    <script>
+      function debug(str)
+      {
+        $("#debug").append("<p>" + str + "</p>");
+      };
+
+      $(document).ready(function()
+      {
+        if (!("WebSocket" in window))
+        {
+          alert("Sorry, WebSockets unavailable.");
+          return;
+        }
+
+        var ws = new WebSocket("ws://localhost:9000/ws");
+        ws.onmessage = function(evt) { $("#msg").append("<p>" + evt.data + "</p>"); };
+        ws.onclose = function() { debug("socket closed"); };
+        ws.onopen = function() { debug("connected..."); };
+
+        $('#submit').click(function()
+        {
+          var nick = $('#nick').val();
+          var msg = $('#message').val();
+
+          ws.send(nick + ": " + msg);
+          return false;
+        });
+
+      });
+    </script>
+  </head>
+  <body>
+    <form>
+      <label>Nick</label>
+      <input type='text' autofocus='true' id='nick' name='nick' value='anon' size='20' /><br />
+
+      <label>Message</label>
+      <input type='text' autofocus='true' id='message' name='message' value='' size='80' />&nbsp;
+      <input type='submit' id='submit' />
+    </form>
+
+    <div id="debug"></div>
+    <div id="msg"></div>
+  </body>
+</html>

data/goliath.gemspec

@@ -12,9 +12,12 @@ Gem::Specification.new do |s|
   s.summary = 'Async framework for writing API servers'
   s.description = s.summary
 
-  s.add_dependency 'eventmachine', '>= 1.0.0.beta.3'
+  s.required_ruby_version = '>=1.9.2'
+
+  s.add_dependency 'eventmachine', '>= 1.0.0.beta.4'
   s.add_dependency 'em-synchrony', '>= 1.0.0'
-  s.add_dependency 'http_parser.rb'
+  s.add_dependency 'em-websocket'
+  s.add_dependency 'http_parser.rb', '0.5.3'
   s.add_dependency 'log4r'
 
   s.add_dependency 'rack', '>=1.2.2'
@@ -22,24 +25,39 @@ Gem::Specification.new do |s|
   s.add_dependency 'rack-respond_to'
   s.add_dependency 'async-rack'
   s.add_dependency 'multi_json'
-  s.add_dependency 'http_router', '~> 0.9.0'
 
   s.add_development_dependency 'rake', '>=0.8.7'
   s.add_development_dependency 'rspec', '>2.0'
   s.add_development_dependency 'nokogiri'
   s.add_development_dependency 'em-http-request', '>=1.0.0'
   s.add_development_dependency 'em-mongo', '~> 0.4.0'
-  s.add_development_dependency 'yajl-ruby'
   s.add_development_dependency 'rack-rewrite'
   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 'tilt', '>=1.2.2'
   s.add_development_dependency 'haml', '>=3.0.25'
   s.add_development_dependency 'yard'
-  s.add_development_dependency 'bluecloth'
 
-  ignores = File.readlines(".gitignore").grep(/\S+/).map {|s| s.chomp }
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-rspec'
+
+  if RUBY_PLATFORM != 'java'
+    s.add_development_dependency 'yajl-ruby'
+    s.add_development_dependency 'bluecloth'
+    s.add_development_dependency 'bson_ext'
+  else
+    s.add_development_dependency 'json-jruby'
+    s.add_development_dependency 'maruku'
+  end
+
+  if RUBY_PLATFORM.include?('darwin')
+    s.add_development_dependency 'growl', '~> 1.0.3'
+    s.add_development_dependency 'rb-fsevent'
+  end
+
+  ignores = File.readlines(".gitignore").grep(/\S+/).map {|i| i.chomp }
   dotfiles = [".gemtest", ".gitignore", ".rspec", ".yardopts"]
 
   s.files = Dir["**/*"].reject {|f| File.directory?(f) || ignores.any? {|i| File.fnmatch(i, f) } } + dotfiles

data/lib/goliath/api.rb

@@ -1,4 +1,3 @@
-require 'http_router'
 require 'goliath/goliath'
 require 'goliath/response'
 require 'goliath/request'
@@ -38,9 +37,9 @@ module Goliath
 
         unless @loaded_default_middlewares
           @middlewares.unshift([::Goliath::Rack::DefaultResponseFormat, nil, nil])
-          @middlewares.unshift([::Rack::ContentLength, nil, nil])
+          @middlewares.unshift([::AsyncRack::ContentLength, nil, nil])
 
-          if Goliath.dev? && !@middlewares.detect {|mw| mw.first == ::Rack::Reloader}
+          if Goliath.env?(:development) && !@middlewares.detect {|mw| mw.first == ::Rack::Reloader}
             @middlewares.unshift([::Rack::Reloader, 0, nil])
           end
 
@@ -73,6 +72,7 @@ module Goliath
         end
 
         @middlewares << [name, args, block]
+        @middlewares = @middlewares.uniq
       end
 
       # Returns the plugins configured for this API
@@ -92,70 +92,16 @@ module Goliath
       def plugin(name, *args)
         plugins.push([name, args])
       end
+    end
 
-      # Returns the router maps configured for the API
-      #
-      # @return [Array] array contains [path, klass, block]
-      def maps
-        @maps ||= []
-      end
-
-      def maps?
-        !maps.empty?
-      end
-
-      # Specify a router map to be used by the API
-      #
-      # @example
-      #  map '/version' do
-      #    run Proc.new {|env| [200, {"Content-Type" => "text/html"}, ["Version 0.1"]] }
-      #  end
-      #
-      # @example
-      #  map '/user/:id', :id => /\d+/ do
-      #    # params[:id] will be a number
-      #    run Proc.new {|env| [200, {"Content-Type" => "text/html"}, ["Loading user #{params[:id]}"]] }
-      #  end
-      #
-      # @param name [String] The URL path to map.
-      #   Optional parts are supported via <tt>(.:format)</tt>, variables as <tt>:var</tt> and globs via <tt>*remaining_path</tt>.
-      #   Variables can be validated by supplying a Regexp.
-      # @param klass [Class] The class to retrieve the middlewares from
-      # @param block The code to execute
-      def map(name, *args, &block)
-        opts = args.last.is_a?(Hash) ? args.pop : {}
-        klass = args.first
-        maps.push([name, klass, opts, block])
-      end
-
-      [:get, :post, :head, :put, :delete].each do |http_method|
-        class_eval <<-EOT, __FILE__, __LINE__ + 1
-        def #{http_method}(name, *args, &block)
-          opts = args.last.is_a?(Hash) ? args.pop : {}
-          klass = args.first
-          opts[:conditions] ||= {}
-          opts[:conditions][:request_method] = [#{http_method.to_s.upcase.inspect}]
-          map(name, klass, opts, &block)
-        end
-        EOT
-      end
-
-      def router
-        unless @router
-          @router = HttpRouter.new
-          @router.default(proc{ |env|
-            @router.routes.last.dest.call(env)
-          })
-        end
-        @router
-      end
-
-      # Use to define the 404 routing logic. As well, define any number of other paths to also run the not_found block.
-      def not_found(*other_paths, &block)
-        app = ::Rack::Builder.new(&block).to_app
-        router.default(app)
-        other_paths.each {|path| router.add(path).to(app) }
-      end
+    ##
+    # The default constructor does nothing with the options
+    # passed, redefine your own to use them.
+    #
+    # @param [Hash] opts options passed to a map call if any
+    #
+    def initialize(opts = {})
+      @opts = opts
     end
 
     # Default stub method to add options into the option parser.
@@ -232,7 +178,9 @@ module Goliath
         env.logger.error(e.message)
         env.logger.error(e.backtrace.join("\n"))
         env[RACK_EXCEPTION] = e
-        env[ASYNC_CALLBACK].call(validation_error(500, e.message))
+
+        message = Goliath.env?(:production) ? 'An error happened' : e.message
+        env[ASYNC_CALLBACK].call(validation_error(500, message))
       end
 
       Goliath::Connection::AsyncResponse
@@ -278,20 +226,5 @@ module Goliath
     def chunked_streaming_response(status_code = 200, headers = {})
       streaming_response(status_code, headers.merge(Goliath::Response::CHUNKED_STREAM_HEADERS))
     end
-
-    # Helper method to initialize the approriate API handler
-    #
-    # Called by the parser once headers are available to detect
-    # which API class should be handling the incoming request
-    def set_event_handler!(env)
-      if self.class.maps?
-        response = self.class.router.recognize(env)
-        if response = self.class.router.recognize(env) and response.respond_to?(:path) and response.path.route.api_class
-          env.event_handler = response.path.route.api_class.new
-        end
-      end
-      env.event_handler ||= self
-    end
-
   end
 end

data/lib/goliath/application.rb

@@ -2,19 +2,6 @@ require 'goliath/goliath'
 require 'goliath/runner'
 require 'goliath/rack'
 
-# Pre-load the goliath environment so it's available as we try to parse the class.
-# This means we can use Goliath.dev? or Goliath.prod? in the use statements.
-#
-# Note, as implmented, you have to have -e as it's own flag, you can't do -sve dev
-# as it won't pickup the e flag.
-env = ENV['RACK_ENV']
-env ||= begin
-          if ((i = ARGV.index('-e')) || (i = ARGV.index('--environment')))
-            ARGV[i + 1]
-          end
-        end
-Goliath.env = env if env
-
 module Goliath
   # The main execution class for Goliath. This will execute in the at_exit
   # handler to run the server.
@@ -91,7 +78,7 @@ module Goliath
     # @param args [Array] Any arguments to append to the path
     # @return [String] path for the given arguments
     def self.root_path(*args)
-      return app_path(args) if Goliath.test?
+      return app_path(args) if Goliath.env?(:test)
 
       @root_path ||= File.expand_path("./")
       File.join(@root_path, *args)
@@ -108,12 +95,11 @@ module Goliath
 
       begin
         klass = Kernel
-        @app_class.split('::').each do |con|
-          klass = klass.const_get(con)
-        end
+        @app_class.split('::').each { |con| klass = klass.const_get(con) }
       rescue NameError
         raise NameError, "Class #{@app_class} not found."
       end
+
       api = klass.new
 
       runner = Goliath::Runner.new(ARGV, api)

data/lib/goliath/connection.rb

@@ -22,7 +22,6 @@ module Goliath
 
       @parser = Http::Parser.new
       @parser.on_headers_complete = proc do |h|
-
         env = Thread.current[GOLIATH_ENV] = Goliath::Env.new
         env[SERVER_PORT] = port.to_s
         env[RACK_LOGGER] = logger
@@ -33,11 +32,9 @@ module Goliath
 
         r = Goliath::Request.new(@app, self, env)
         r.parse_header(h, @parser) do
-          @api.set_event_handler!(env) if @api
-
-          env[ASYNC_HEADERS] = env.event_handler.method(:on_headers) if env.event_handler.respond_to? :on_headers
-          env[ASYNC_BODY]    = env.event_handler.method(:on_body)    if env.event_handler.respond_to? :on_body
-          env[ASYNC_CLOSE]   = env.event_handler.method(:on_close)   if env.event_handler.respond_to? :on_close
+          env[ASYNC_HEADERS] = api.method(:on_headers) if api.respond_to?(:on_headers)
+          env[ASYNC_BODY]    = api.method(:on_body)    if api.respond_to?(:on_body)
+          env[ASYNC_CLOSE]   = api.method(:on_close)   if api.respond_to?(:on_close)
         end
 
         @requests.push(r)
@@ -57,21 +54,31 @@ module Goliath
           @pending.push(req)
         end
 
-        req.process
+        req.process if !@parser.upgrade? && !req.env[:terminate_connection]
       end
     end
 
     def receive_data(data)
       begin
         @parser << data
+
+        if @parser.upgrade?
+          if !@current.env[UPGRADE_DATA]
+            @current.env[UPGRADE_DATA] = @parser.upgrade_data
+            @current.process
+          else
+            @current.parse(data)
+          end
+        end
+
       rescue HTTP::Parser::Error => e
         terminate_request(false)
       end
     end
 
     def unbind
-      @requests.map {|r| r.close }
-      @pending.map  {|r| r.close }
+      @requests.map { |r| r.close }
+      @pending.map  { |r| r.close }
       @current.close if @current
     end
 

data/lib/goliath/constants.rb

@@ -47,7 +47,9 @@ module Goliath
     PATH_INFO       = 'PATH_INFO'
     FRAGMENT        = 'FRAGMENT'
     CONNECTION      = 'CONNECTION'
+    UPGRADE_DATA    = 'UPGRADE_DATA'
 
     GOLIATH_ENV     = 'goliath.env'
+    GOLIATH_SIGNATURE = 'goliath.signature'
   end
 end

data/lib/goliath/env.rb

@@ -6,7 +6,6 @@ module Goliath
   # Goliath::Env also provides access to the logger, configuration information
   # and anything else set into the config data during initialization.
   class Env < Hash
-    attr_accessor :event_handler
     include Constants
 
     # Create a new Goliath::Env object
@@ -64,8 +63,8 @@ module Goliath
 
     # If the API is a streaming API this will be executed by the API to signal that
     # the stream is complete. This will close the connection with the client.
-    def stream_close
-      self[STREAM_CLOSE].call
+    def stream_close(*args)
+      self[STREAM_CLOSE].call(args)
     end
 
     # Sends a chunk in a Chunked transfer encoding stream.

data/lib/goliath/goliath.rb

@@ -10,55 +10,45 @@ module Goliath
 
   ENVIRONMENTS = [:development, :production, :test, :staging]
 
+  # for example:
+  #
+  #   def development?
+  #     env? :development
+  #   end
+  class << self
+    ENVIRONMENTS.each do |e|
+      define_method "#{e}?" do
+        warn "[DEPRECATION] `Goliath.#{e}?` is deprecated.  Please use `Goliath.env?(#{e})` instead."
+        env? e
+      end
+    end
+
+    alias :prod? :production?
+    alias :dev? :development?
+  end
+
   # Retrieves the current goliath environment
   #
   # @return [String] the current environment
   def env
-    @env or fail "environment has not been set"
+    @env
   end
 
   # Sets the current goliath environment
   #
-  # @param [String|Symbol] env the environment symbol of [dev | development | prod | production | test]
+  # @param [String|Symbol] env the environment symbol
   def env=(e)
-    es = case(e.to_sym)
+    @env = case(e.to_sym)
     when :dev  then :development
     when :prod then :production
     else e.to_sym
     end
-
-    if ENVIRONMENTS.include?(es)
-      @env = es
-    else
-      fail "did not recognize environment: #{e}, expected one of: #{ENVIRONMENTS.join(', ')}"
-    end
-  end
-
-  # Determines if we are in the production environment
-  #
-  # @return [Boolean] true if current environment is production, false otherwise
-  def prod?
-    env == :production
-  end
-
-  # Determines if we are in the development environment
-  #
-  # @return [Boolean] true if current environment is development, false otherwise
-  def dev?
-    env == :development
-  end
-
-  # Determines if we are in the test environment
-  #
-  # @return [Boolean] true if current environment is test, false otherwise
-  def test?
-    env == :test
   end
 
-  # Determines if we are in the staging environment
+  # Determines if we are in a particular environment
   #
-  # @return [Boolean] true if current environment is staging.
-  def staging?
-    env == :staging
+  # @return [Boolean] true if current environment matches, false otherwise
+  def env?(e)
+    env == e.to_sym
   end
 end

data/lib/goliath/plugins/latency.rb

@@ -6,6 +6,10 @@ module Goliath
     #  plugin Goliath::Plugin::Latency
     #
     class Latency
+      
+      # Number of seconds to wait before logging latency
+      LATENCY_TIMING = 1
+      
       # Called by the framework to initialize the plugin
       #
       # @param port [Integer] Unused
@@ -28,9 +32,9 @@ module Goliath
 
       # Called automatically to start the plugin
       def run
-        EM.add_periodic_timer(1) do
-          @@recent_latency = (Time.now.to_f - @last)
-          @logger.info "LATENCY: #{@@recent_latency}"
+        EM.add_periodic_timer(LATENCY_TIMING) do
+          @@recent_latency = ((Time.now.to_f - @last) - LATENCY_TIMING)
+          @logger.info "LATENCY: #{(@@recent_latency * 1000)} ms"
           @last = Time.now.to_f
         end
       end