goliath 1.0.0 → 1.0.1

data/HISTORY.md

@@ -1,5 +1,10 @@
 # HISTORY
 
+# v1.0.1 (November 8, 2012)
+
+  - integrated console (CLI flag)
+  - log shutdown sequence
+
 ## v1.0.0 (August 11, 2012)
 
   - Improved WebSocket handling

data/examples/async_upload.rb

@@ -5,7 +5,6 @@ require 'goliath'
 require 'yajl' if RUBY_PLATFORM != 'java'
 
 class AsyncUpload < Goliath::API
-  use Goliath::Rack::Params             # parse & merge query and body parameters
   use Goliath::Rack::DefaultMimeType    # cleanup accepted media types
   use Goliath::Rack::Render, 'json'     # auto-negotiate response format
 

data/examples/stream.rb

@@ -2,9 +2,9 @@
 $:<< '../lib' << 'lib'
 
 #
-# A simple HTTP streaming API which returns a 200 response for any GET request
-# and then emits numbers 1 through 10 in 1 second intervals, and then closes the
-# connection.
+# A simple HTTP streaming API which returns a 202 (Accepted) response for any
+# GET request and then emits numbers 1 through 10 in 1 second intervals, and
+# then closes the connection.
 #
 # A good use case for this pattern would be to provide a stream of updates or a
 # 'firehose' like API to stream data back to the clients. Simply hook up to your

data/examples/template.rb

@@ -40,8 +40,7 @@ class Template < Goliath::API
 
   def response(env)
     case env['PATH_INFO']
-    # TODO(dj2): change /root -> / when rack > 1.4.0 is released
-    when '/root'         then [200, {}, haml(:root)]
+    when '/'         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

data/goliath.gemspec

@@ -57,7 +57,7 @@ Gem::Specification.new do |s|
     s.add_development_dependency 'rb-fsevent'
   end
 
-  ignores = File.readlines(".gitignore").grep(/\S+/).map {|i| i.chomp }
+  ignores = File.readlines(".gitignore").grep(/\S+/).map {|i| i.chomp }.map {|i| File.directory?(i) ? i.sub(/\/?$/, '/*') : i }
   dotfiles = [".gemtest", ".gitignore", ".rspec", ".yardopts"]
 
   s.files = Dir["**/*"].reject {|f| File.directory?(f) || ignores.any? {|i| File.fnmatch(i, f) } } + dotfiles

data/lib/goliath/application.rb

@@ -7,7 +7,7 @@ module Goliath
   # handler to run the server.
   #
   # @private
-  class Application
+  module Application
     # Most of this stuff is straight out of sinatra.
 
     # Set of caller regex's to be skipped when looking for our API file
@@ -22,15 +22,17 @@ module Goliath
     # @todo add rubinius (and hopefully other VM impls) ignore patterns ...
     CALLERS_TO_IGNORE.concat(RUBY_IGNORE_CALLERS) if defined?(RUBY_IGNORE_CALLERS)
 
+    module_function
+
     # Like Kernel#caller but excluding certain magic entries and without
     # line / method information; the resulting array contains filenames only.
-    def self.caller_files
+    def caller_files
       caller_locations.map { |file, line| file }
     end
 
     # Like caller_files, but containing Arrays rather than strings with the
     # first element being the file, and the second being the line.
-    def self.caller_locations
+    def caller_locations
       caller(1).
         map    { |line| line.split(/:(?=\d|in )/)[0,2] }.
         reject { |file, line| CALLERS_TO_IGNORE.any? { |pattern| file =~ pattern } }
@@ -39,7 +41,7 @@ module Goliath
     # Find the app_file that was used to execute the application
     #
     # @return [String] The app file
-    def self.app_file
+    def app_file
       c = caller_files.first
       c = $0 if !c || c.empty?
       c
@@ -48,7 +50,7 @@ module Goliath
     # Returns the userland class which inherits the Goliath API
     #
     # @return [String] The app class
-    def self.app_class
+    def app_class
       @app_class
     end
 
@@ -56,7 +58,7 @@ module Goliath
     #
     # @param app_class [String|Symbol|Constant] The new app class
     # @return [String] app_class The new app class
-    def self.app_class=(app_class)
+    def app_class=(app_class)
       @app_class = app_class.to_s
     end
 
@@ -68,7 +70,7 @@ module Goliath
     #
     # @param args [Array] Any arguments to append to the path
     # @return [String] path for the given arguments
-    def self.app_path(*args)
+    def app_path(*args)
       @app_path ||= File.expand_path(File.dirname(app_file))
       File.join(@app_path, *args)
     end
@@ -77,7 +79,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)
+    def root_path(*args)
       return app_path(args) if Goliath.env?(:test)
 
       @root_path ||= File.expand_path("./")
@@ -87,7 +89,7 @@ module Goliath
     # Execute the application
     #
     # @return [Nil]
-    def self.run!
+    def run!
       unless @app_class
         file = File.basename(app_file, '.rb')
         @app_class = camel_case(file)
@@ -115,7 +117,7 @@ module Goliath
     #
     # @param str [String] The string to convert
     # @return [String] The camel cased string
-    def self.camel_case(str)
+    def camel_case(str)
       return str if str !~ /_/ && str =~ /[A-Z]+.*/
 
       str.split('_').map { |e| e.capitalize }.join

data/lib/goliath/console.rb

@@ -0,0 +1,20 @@
+module Goliath
+  # The console execution class for Goliath. This will load a REPL inside of a
+  # running reactor with the associated Goliath config loaded.
+  #
+  # @private
+  class Console
+    # Starts the reactor and the REPL.
+    #
+    # @return [Nil]
+    def self.run!(server)
+      require 'irb'
+      EM.synchrony do
+        server.load_config
+        Object.send(:define_method, :goliath_server) { server }
+        IRB.start
+        EM.stop
+      end
+    end
+  end
+end

data/lib/goliath/request.rb

@@ -69,7 +69,7 @@ module Goliath
     # This method is invoked only once per request.
     #
     # @param h [Hash] Request headers
-    # @param parser [Http::Parser] The parsed used to parse the request
+    # @param parser [Http::Parser] The parser used to parse the request
     # @return [Nil]
     def parse_header(h, parser)
       h.each do |k, v|
@@ -174,7 +174,7 @@ module Goliath
     # Sending of the data is deferred until the request
     # is marked as ready to push data by the connection.
     # Hence, two pipelined requests can come in via same
-    # connection, first can take take 1s to render, while
+    # connection, first can take 1s to render, while
     # second may take 0.5. Because HTTP spec does not
     # allow for interleaved data exchange, we block the
     # second request until the first one is done and the

data/lib/goliath/runner.rb

@@ -1,5 +1,6 @@
 require 'goliath/goliath'
 require 'goliath/server'
+require 'goliath/console'
 require 'optparse'
 require 'log4r'
 
@@ -19,7 +20,7 @@ module Goliath
   # For more detail, see: https://github.com/postrank-labs/goliath/issues/18
   class EnvironmentParser
 
-    # Work out the current runtime environemnt.
+    # Work out the current runtime environment.
     #
     # The sources of environment, in increasing precedence, are:
     #
@@ -29,7 +30,7 @@ module Goliath
     #   4. Hard-coded call to Goliath#env=
     #
     # @param argv [Array] The command line arguments
-    # @return [Symbol] The current environemnt
+    # @return [Symbol] The current environment
     def self.parse(argv = [])
       env = ENV["RACK_ENV"] || Goliath::DEFAULT_ENV
       if (i = argv.index('-e')) || (i = argv.index('--environment'))
@@ -102,7 +103,7 @@ module Goliath
       api.options_parser(options_parser, options) if api
       options_parser.parse!(argv)
 
-      # We've already dealt with the environemnt, so just discard it.
+      # We've already dealt with the environment, so just discard it.
       options.delete(:env)
 
       @api = api
@@ -167,6 +168,7 @@ module Goliath
         opts.separator ""
         opts.separator "Common options:"
 
+        opts.on('-C', '--console', 'Start a console') { @options[:console] = true }
         opts.on('-v', '--verbose', "Enable verbose logging (default: #{@options[:verbose]})") { |v| @options[:verbose] = v }
         opts.on('-h', '--help', 'Display help message') { show_options(opts) }
       end
@@ -185,6 +187,11 @@ module Goliath
     #
     # @return [Nil]
     def run
+      if options[:console]
+        Goliath::Console.run!(setup_server)
+        return
+      end
+
       unless Goliath.env?(:test)
         $LOADED_FEATURES.unshift(File.basename($0))
         Dir.chdir(File.expand_path(File.dirname($0)))
@@ -241,6 +248,20 @@ module Goliath
        log
      end
 
+     # Sets up the Goliath server
+     #
+     # @param log [Logger] The logger to configure the server to log to
+     # @return [Server] an instance of a Goliath server
+     def setup_server(log = setup_logger)
+       server = Goliath::Server.new(@address, @port)
+       server.logger = log
+       server.app = @app
+       server.api = @api
+       server.plugins = @plugins || []
+       server.options = @server_options
+       server
+     end
+
      # Setup file logging
      #
      # @param log [Logger] The logger to add file logging too
@@ -271,12 +292,7 @@ module Goliath
 
        log.info("Starting server on #{@address}:#{@port} in #{Goliath.env} mode. Watch out for stones.")
 
-       server = Goliath::Server.new(@address, @port)
-       server.logger = log
-       server.app = @app
-       server.api = @api
-       server.plugins = @plugins || []
-       server.options = @server_options
+       server = setup_server(log)
        server.start
      end
 

data/lib/goliath/server.rb

@@ -71,8 +71,8 @@ module Goliath
     def start(&blk)
       EM.epoll
       EM.synchrony do
-        trap("INT")  { EM.stop }
-        trap("TERM") { EM.stop }
+        trap("INT")  { stop }
+        trap("TERM") { stop }
 
         if RUBY_PLATFORM !~ /mswin|mingw/
           trap("HUP")  { load_config(options[:config]) }
@@ -105,6 +105,12 @@ module Goliath
       end
     end
 
+    # Stops the server running.
+    def stop
+      logger.info('Stopping server...')
+      EM.stop
+    end
+
     # Loads a configuration file
     #
     # @param file [String] The file to load, if not set will use the basename of $0

data/lib/goliath/test_helper_streaming.rb

@@ -0,0 +1,42 @@
+require 'em-http-request'
+
+module Goliath
+  module TestHelper
+    class StreamingHelper
+      attr_reader :connection
+      def initialize(url)
+        @queue = EM::Queue.new
+
+        fiber = Fiber.current
+        @connection = EventMachine::HttpRequest.new(url).get
+        @connection.errback do |e|
+          puts "Error encountered during connection: #{e}"
+          EM::stop_event_loop
+        end
+
+        @connection.callback { EM::stop_event_loop }
+
+        @connection.stream { |m| @queue.push(m) }
+
+        Fiber.yield
+      end
+
+      def send(m)
+        @connection.send_msg(m)
+      end
+
+      def receive
+        fiber = Fiber.current
+        @queue.pop {|m| fiber.resume(m) }
+        Fiber.yield
+      end
+    end
+
+    def streaming_client_connect(path, &blk)
+      url = "http://localhost:#{@test_server_port}#{path}"
+      client = StreamingHelper.new(url)
+      blk.call(client) if blk
+      stop
+    end
+  end
+end

data/lib/goliath/version.rb

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

data/spec/integration/chunked_streaming_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require File.join(File.dirname(__FILE__), '../../', 'lib/goliath/test_helper_streaming')
+require File.join(File.dirname(__FILE__), '../../', 'lib/goliath')
+
+class ChunkedStreaming < Goliath::API
+
+  def response(env)
+
+    EM.next_tick do
+      env.chunked_stream_send("chunked")
+      env.chunked_stream_close
+    end
+
+    headers = { 'Content-Type' => 'text/plain', 'X-Stream' => 'Goliath' }
+    chunked_streaming_response(200, headers)
+  end
+
+  def on_close(env)
+  end
+end
+
+describe "ChunkedStreaming" do
+  include Goliath::TestHelper
+
+  let(:err) { Proc.new { |c| fail "HTTP Request failed #{c.response}" } }
+
+  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"
+      end
+    end
+  end
+end
+
+

data/spec/integration/template_spec.rb

@@ -10,7 +10,7 @@ describe Template do
 
   it 'renders haml template with default haml layout' do
     with_api(Template, api_options) do
-      get_request(:path => '/root') do |c|
+      get_request(:path => '/') do |c|
         c.response.should =~ %r{<li><a href="/joke">Tell me a joke</a></li>}
       end
     end

data/spec/unit/console_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'goliath/runner'
+require 'irb'
+
+describe Goliath::Console do
+  before(:each) do
+    @server = Goliath::Server.new
+  end
+
+  describe 'run!' do
+    it "starts a irb session" do
+      Object.should_receive(:send).with(:define_method, :goliath_server)
+      IRB.should_receive(:start)
+      @server.should_receive(:load_config)
+      Goliath::Console.run!(@server)
+    end
+  end
+end

data/spec/unit/server_spec.rb

@@ -103,6 +103,18 @@ describe Goliath::Server do
     end
   end
 
+  describe 'stop' do
+    it 'logs when receives TERM signal' do
+      EM.run do
+        logger = mock('logger')
+        logger.should_receive(:info).with('Stopping server...')
+        @s.logger = logger
+        @s.start
+        @s.stop
+      end
+    end
+  end
+
   context 'config parsing' do
     context 'environment' do
       after(:all) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: goliath
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2012-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -540,6 +540,7 @@ files:
 - lib/goliath/api.rb
 - lib/goliath/application.rb
 - lib/goliath/connection.rb
+- lib/goliath/console.rb
 - lib/goliath/constants.rb
 - lib/goliath/env.rb
 - lib/goliath/goliath.rb
@@ -589,6 +590,7 @@ files:
 - lib/goliath/runner.rb
 - lib/goliath/server.rb
 - lib/goliath/test_helper.rb
+- lib/goliath/test_helper_streaming.rb
 - lib/goliath/test_helper_ws.rb
 - lib/goliath/validation/error.rb
 - lib/goliath/validation/standard_http_errors.rb
@@ -597,14 +599,10 @@ files:
 - lib/goliath/websocket.rb
 - lib/goliath.rb
 - LICENSE
-- pkg/data.tar.gz
-- pkg/goliath-0.9.3.gem
-- pkg/goliath-0.9.4.gem
-- pkg/goliath-1.0.0.beta.1.gem
-- pkg/metadata
 - Rakefile
 - README.md
 - spec/integration/async_request_processing.rb
+- spec/integration/chunked_streaming_spec.rb
 - spec/integration/early_abort_spec.rb
 - spec/integration/echo_spec.rb
 - spec/integration/empty_body_spec.rb
@@ -621,6 +619,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
 - spec/unit/connection_spec.rb
+- spec/unit/console_spec.rb
 - spec/unit/env_spec.rb
 - spec/unit/headers_spec.rb
 - spec/unit/rack/default_mime_type_spec.rb
@@ -645,7 +644,6 @@ files:
 - spec/unit/validation/standard_http_errors_spec.rb
 - test/echo_test.rb
 - test/test_helper.rb
-- test.rb
 - .gemtest
 - .gitignore
 - .rspec
@@ -668,6 +666,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -356739448572304908
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -676,6 +677,7 @@ specification_version: 3
 summary: Async framework for writing API servers
 test_files:
 - spec/integration/async_request_processing.rb
+- spec/integration/chunked_streaming_spec.rb
 - spec/integration/early_abort_spec.rb
 - spec/integration/echo_spec.rb
 - spec/integration/empty_body_spec.rb
@@ -692,6 +694,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/api_spec.rb
 - spec/unit/connection_spec.rb
+- spec/unit/console_spec.rb
 - spec/unit/env_spec.rb
 - spec/unit/headers_spec.rb
 - spec/unit/rack/default_mime_type_spec.rb

data/test.rb

@@ -1,6 +0,0 @@
-class ValidationErrorInJson < Goliath::API
-  use Goliath::Rack::Render, 'json'
-  def response(env)
-    raise Goliath::Validation::Error.new(420, 'You Must Chill')
-  end
-end