puma 2.7.0 → 3.1.1

data/Manifest.txt

@@ -1,15 +1,16 @@
-COPYING
+DEPLOYMENT.md
 Gemfile
 History.txt
 LICENSE
 Manifest.txt
 README.md
 Rakefile
-TODO
 bin/puma
+bin/puma-wild
 bin/pumactl
 docs/config.md
 docs/nginx.md
+docs/signals.md
 ext/puma_http11/PumaHttp11Service.java
 ext/puma_http11/ext_help.h
 ext/puma_http11/extconf.rb
@@ -32,25 +33,36 @@ lib/puma/capistrano.rb
 lib/puma/cli.rb
 lib/puma/client.rb
 lib/puma/cluster.rb
+lib/puma/commonlogger.rb
 lib/puma/compat.rb
 lib/puma/configuration.rb
 lib/puma/const.rb
 lib/puma/control_cli.rb
+lib/puma/convenient.rb
 lib/puma/daemon_ext.rb
 lib/puma/delegation.rb
 lib/puma/detect.rb
+lib/puma/dsl.rb
 lib/puma/events.rb
 lib/puma/io_buffer.rb
 lib/puma/java_io_buffer.rb
 lib/puma/jruby_restart.rb
+lib/puma/launcher.rb
 lib/puma/minissl.rb
 lib/puma/null_io.rb
+lib/puma/plugin.rb
+lib/puma/plugin/tmp_restart.rb
+lib/puma/rack/backports/uri/common_18.rb
+lib/puma/rack/backports/uri/common_192.rb
+lib/puma/rack/backports/uri/common_193.rb
+lib/puma/rack/builder.rb
+lib/puma/rack/urlmap.rb
 lib/puma/rack_default.rb
-lib/puma/rack_patch.rb
 lib/puma/reactor.rb
 lib/puma/runner.rb
 lib/puma/server.rb
 lib/puma/single.rb
+lib/puma/state_file.rb
 lib/puma/tcp_logger.rb
 lib/puma/thread_pool.rb
 lib/puma/util.rb

data/README.md

@@ -1,6 +1,9 @@
 # Puma: A Ruby Web Server Built For Concurrency
 
-[![Build Status](https://secure.travis-ci.org/puma/puma.png)](http://travis-ci.org/puma/puma) [![Dependency Status](https://gemnasium.com/puma/puma.png)](https://gemnasium.com/puma/puma)
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/puma/puma?utm\_source=badge&utm\_medium=badge&utm\_campaign=pr-badge)
+[![Build Status](https://secure.travis-ci.org/puma/puma.svg)](http://travis-ci.org/puma/puma)
+[![Dependency Status](https://gemnasium.com/puma/puma.svg)](https://gemnasium.com/puma/puma)
+[![Code Climate](https://codeclimate.com/github/puma/puma.svg)](https://codeclimate.com/github/puma/puma)
 
 ## Description
 
@@ -26,6 +29,36 @@ Now you should have the `puma` command available in your PATH, so just do the fo
 
     $ puma app.ru
 
+## Plugins
+
+Puma 3.0 added support for plugins that can augment configuration and service operations.
+
+2 canonical plugins to look to aid in development of further plugins:
+
+* [tmp\_restart](https://github.com/puma/puma/blob/master/lib/puma/plugin/tmp_restart.rb): Restarts the server if the file `tmp/restart.txt` is touched
+* [heroku](https://github.com/puma/puma-heroku/blob/master/lib/puma/plugin/heroku.rb): Packages up the default configuration used by puma on Heroku
+
+Plugins are activated in a puma configuration file (such as `config/puma.rb'`) by adding `plugin "name"`, such as `plugin "heroku"`.
+
+Plugins are activated based simply on path requirements so, activating the `heroku` plugin will simply be doing `require "puma/plugin/heroku"`. This allows gems to provide multiple plugins (as well as unrelated gems to provide puma plugins).
+
+The `tmp_restart` plugin is bundled with puma, so it can always be used.
+
+To use the `heroku` plugin, add `puma-heroku` to your Gemfile or install it.
+
+### API
+
+At present, there are 2 hooks that plugins can use: `start` and `config`.
+
+`start` runs when the server has started and allows the plugin to start other functionality to augment puma.
+
+`config` runs when the server is being configured and is passed a `Puma::DSL` object that can be used to add additional configuration.
+
+Any public methods in `Puma::Plugin` are the public API that any plugin may use.
+
+In the future, more hooks and APIs will be added.
+
+
 ## Advanced Setup
 
 ### Sinatra
@@ -71,7 +104,7 @@ Puma utilizes a dynamic thread pool which you can modify. You can set the minimu
 
     $ puma -t 8:32
 
-Puma will automatically scale the number of threads based on how much traffic is present. The current default is `0:16`. Feel free to experiment, but be careful not to set the number of maximum threads to a very large number, as you may exhaust resources on the system (or hit resource limits).
+Puma will automatically scale the number of threads, from the minimum until it caps out at the maximum, based on how much traffic is present. The current default is `0:16`. Feel free to experiment, but be careful not to set the number of maximum threads to a very large number, as you may exhaust resources on the system (or hit resource limits).
 
 ### Clustered mode
 
@@ -82,7 +115,7 @@ Puma 2 offers clustered mode, allowing you to use forked processes to handle mul
 On a ruby implementation that offers native threads, you should tune this number to match the number of cores available.
 Note that threads are still used in clustered mode, and the `-t` thread flag setting is per worker, so `-w 2 -t 16:16` will be 32 threads.
 
-If you're running in Clustered Mode you can optionally choose to preload your application before starting up the workers. This is necessary in order to take advantate of the [Copy on Write](http://en.wikipedia.org/wiki/Copy-on-write) feature introduced in [MRI Ruby 2.0](https://blog.heroku.com/archives/2013/3/6/matz_highlights_ruby_2_0_at_waza). To do this simply specify the `--preload` flag in invocation:
+If you're running in Clustered Mode you can optionally choose to preload your application before starting up the workers. This is necessary in order to take advantage of the [Copy on Write](http://en.wikipedia.org/wiki/Copy-on-write) feature introduced in [MRI Ruby 2.0](https://blog.heroku.com/archives/2013/3/6/matz_highlights_ruby_2_0_at_waza). To do this simply specify the `--preload` flag in invocation:
 
     # CLI invocation
     $ puma -t 8:32 -w 3 --preload
@@ -108,7 +141,7 @@ you to do some Puma-specific things that you don't want to embed in your applica
 For instance, you could fire a log notification that a worker booted or send something to statsd.
 This can be called multiple times to add hooks.
 
-If you're preloading your application and using ActiveRecord, it's recommend you setup your connection pool here:
+If you're preloading your application and using ActiveRecord, it's recommended that you setup your connection pool here:
 
     # config/puma.rb
     on_worker_boot do
@@ -117,6 +150,43 @@ If you're preloading your application and using ActiveRecord, it's recommend you
       end
     end
 
+On top of that, you can specify a block in your configuration file that will be run before workers are forked
+
+    # config/puma.rb
+    before_fork do
+      # configuration here
+    end
+
+This code can be used to clean up before forking to clients, allowing
+you to do some Puma-specific things that you don't want to embed in your application.
+
+If you're preloading your application and using ActiveRecord, it's recommended that you close any connections to the database here to prevent connection leakage:
+
+    # config/puma.rb
+    before_fork do
+      ActiveRecord::Base.connection_pool.disconnect!
+    end
+
+This rule applies to any connections to external services (Redis, databases, memcache, ...) that might be started automatically by the framework.
+
+When you use preload_app, all of your new code goes into the master process, and is then copied into the workers (meaning it’s only compatible with cluster mode). General rule is to use preload_app when your workers die often and need fast starts. If you don’t have many workers, you probably should not use preload_app.
+
+Note that preload_app can’t be used with phased restart, since phased restart kills and restarts workers one-by-one, and preload_app is all about copying the code of master into the workers.
+
+### Error handler for low-level errors
+
+If puma encounters an error outside of the context of your application, it will respond with a 500 and a simple
+textual error message (see `lowlevel_error` in [this file](https://github.com/puma/puma/blob/master/lib/puma/server.rb)).
+You can specify custom behavior for this scenario. For example, you can report the error to your third-party
+error-tracking service (in this example, [rollbar](http://rollbar.com)):
+
+```ruby
+lowlevel_error_handler do |e|
+  Rollbar.critical(e)
+  [500, {}, ["An error has occurred, and engineers have been informed. Please reload the page. If you continue to have problems, contact support@example.com\n"]]
+end
+```
+
 ### Binding TCP / Sockets
 
 In contrast to many other server configs which require multiple flags, Puma simply uses one URI parameter with the `-b` (or `--bind`) flag:
@@ -129,7 +199,7 @@ Want to use UNIX Sockets instead of TCP (which can provide a 5-10% performance b
 
 If you need to change the permissions of the UNIX socket, just add a umask parameter:
 
-    $ puma -b 'unix:///var/run/puma.sock?umask=0777'
+    $ puma -b 'unix:///var/run/puma.sock?umask=0111'
 
 Need a bit of security? Use SSL sockets!
 
@@ -137,7 +207,7 @@ Need a bit of security? Use SSL sockets!
 
 ### Control/Status Server
 
-Puma comes with a builtin status/control app that can be used query and control Puma itself. Here is an example of starting Puma with the control server:
+Puma comes with a builtin status/control app that can be used to query and control Puma itself. Here is an example of starting Puma with the control server:
 
     $ puma --control tcp://127.0.0.1:9293 --control-token foo
 
@@ -149,6 +219,12 @@ You can also provide a configuration file which Puma will use with the `-C` (or
 
     $ puma -C /path/to/config
 
+By default, if no configuration file is specified, Puma will look for a configuration file at config/puma.rb. If an environment is specified, either via the `-e` and `--environment` flags, or through the `RACK_ENV` environment variable, the default file location will be config/puma/environment_name.rb.
+
+If you want to prevent Puma from looking for a configuration file in those locations, provide a dash as the argument to the `-C` (or `--config`) flag:
+
+    $ puma -C "-"
+
 Take the following [sample configuration](https://github.com/puma/puma/blob/master/examples/config.rb) as inspiration or check out [configuration.rb](https://github.com/puma/puma/blob/master/lib/puma/configuration.rb) to see all available options.
 
 ## Restart
@@ -164,15 +240,37 @@ No code is shared between the current and restarted process, so it should be saf
 
 If the new process is unable to load, it will simply exit. You should therefore run Puma under a supervisor when using it in production.
 
+### Normal vs Hot vs Phased Restart
+
+A hot restart means that no requests will be lost while deploying your new code, since the server socket is kept open between restarts.
+
+But beware, hot restart does not mean that the incoming requests won’t hang for multiple seconds while your new code has not fully deployed. If you need a zero downtime and zero hanging requests deploy, you must use phased restart.
+
+When you run pumactl phased-restart, Puma kills workers one-by-one, meaning that at least another worker is still available to serve requests, which lead to zero hanging requests (yay!).
+
+But again beware, upgrading an application sometimes involves upgrading the database schema. With phased restart, there may be a moment during the deployment where processes belonging to the previous version and processes belonging to the new version both exist at the same time. Any database schema upgrades you perform must therefore be backwards-compatible with the old application version.
+
+If you perform a lot of database migrations, you probably should not use phased restart and use a normal/hot restart instead (pumactl restart). That way, no code is shared while deploying (in that case, preload_app might help for quicker deployment, see below).
+
+### Release Directory
+
+If you symlink releases into a common working directory (i.e., `/current` from Capistrano), Puma won't pick up your new changes when running phased restarts without additional configuration. You should set your working directory within Puma's config to specify the directory it should use. This is a change from earlier versions of Puma (< 2.15) that would infer the directory for you.
+
+```ruby
+# config/puma.rb
+
+directory '/var/www/current'
+```
+
 ### Cleanup Code
 
 Puma isn't able to understand all the resources that your app may use, so it provides a hook in the configuration file you pass to `-C` called `on_restart`. The block passed to `on_restart` will be called, unsurprisingly, just before Puma restarts itself.
 
-You should place code to close global log files, redis connections, etc in this block so that their file descriptors don't leak into the restarted process. Failure to do so will result in slowly running out of descriptors and eventually obscure crashes as the server is restart many times.
+You should place code to close global log files, redis connections, etc in this block so that their file descriptors don't leak into the restarted process. Failure to do so will result in slowly running out of descriptors and eventually obscure crashes as the server is restarted many times.
 
 ### Platform Constraints
 
-Because of various platforms not being implement certain things, the following differences occur when Puma is used on different platforms:
+Because of various platforms not being able to implement certain things, the following differences occur when Puma is used on different platforms:
 
   * **JRuby**, **Windows**: server sockets are not seamless on restart, they must be closed and reopened. These platforms have no way to pass descriptors into a new process that is exposed to ruby
   * **JRuby**, **Windows**: cluster mode is not supported due to a lack of  fork(2)
@@ -184,16 +282,25 @@ Because of various platforms not being implement certain things, the following d
 
 ## Managing multiple Pumas / init.d / upstart scripts
 
-If you want an easy way to manage multiple scripts at once check [tools/jungle](https://github.com/puma/puma/tree/master/tools/jungle) for init.d and upstart scripts.
+If you want an easy way to manage multiple scripts at once, check [tools/jungle](https://github.com/puma/puma/tree/master/tools/jungle) for init.d and upstart scripts.
 
 ## Capistrano deployment
 
-Puma has included Capistrano [deploy script](https://github.com/puma/puma/blob/master/lib/puma/capistrano.rb), you just need require that:
+Puma has support for Capistrano3 with an [external gem](https://github.com/seuros/capistrano-puma), you just need require that in Gemfile:
+
+```ruby
+gem 'capistrano3-puma'
+```
+And then execute:
+
+```bash
+bundle
+```
 
-config/deploy.rb
+Then add to Capfile
 
 ```ruby
-require 'puma/capistrano'
+require 'capistrano/puma'
 ```
 
 and then
@@ -202,10 +309,18 @@ and then
 $ bundle exec cap puma:start
 $ bundle exec cap puma:restart
 $ bundle exec cap puma:stop
-$ bundle exec cap puma:phased_restart
+$ bundle exec cap puma:phased-restart
 ```
 
+## Contributing
+
+To run the test suite:
+
+```bash
+$ bundle install
+$ bundle exec rake
+```
 
 ## License
 
-Puma is copyright 2013 Evan Phoenix and contributors. It is licensed under the BSD license. See the include LICENSE file for details.
+Puma is copyright 2014 Evan Phoenix and contributors. It is licensed under the BSD 3-Clause license. See the included LICENSE file for details.

data/Rakefile

@@ -8,10 +8,10 @@ Hoe.plugin :git
 Hoe.plugin :ignore
 
 HOE = Hoe.spec "puma" do
-  self.rubyforge_name = 'puma'
   self.readme_file    = "README.md"
   self.urls = %w!http://puma.io https://github.com/puma/puma!
 
+  license "BSD-3-Clause"
   developer 'Evan Phoenix', 'evan@phx.io'
 
   spec_extras[:extensions]  = ["ext/puma_http11/extconf.rb"]
@@ -20,9 +20,9 @@ HOE = Hoe.spec "puma" do
 
   require_ruby_version ">= 1.8.7"
 
-  dependency "rack", [">= 1.1", "< 2.0"]
+  dependency "rack", [">= 1.1", "< 2.0"], :development
 
-  extra_dev_deps << ["rake-compiler", "~> 0.8.0"]
+  extra_dev_deps << ["rake-compiler", "~> 0.8"]
 end
 
 task :prerelease => [:clobber, :check_manifest, :test]

data/bin/puma-wild

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2014 Evan Phoenix
+#
+
+require 'rubygems'
+
+gems = ARGV.shift
+
+inc = ""
+
+if gems == "-I"
+  inc = ARGV.shift
+  $LOAD_PATH.concat inc.split(":")
+  gems = ARGV.shift
+end
+
+gems.split(",").each do |s|
+  name, ver = s.split(":",2)
+  gem name, ver
+end
+
+module Puma; end
+
+Puma.const_set("WILD_ARGS", ["-I", inc, gems])
+
+require 'puma/cli'
+
+cli = Puma::CLI.new ARGV
+
+cli.run

data/bin/pumactl

@@ -2,7 +2,7 @@
 
 require 'puma/control_cli'
 
-cli = Puma::ControlCLI.new ARGV
+cli = Puma::ControlCLI.new ARGV.dup
 
 begin
   cli.run

data/docs/nginx.md

@@ -40,7 +40,7 @@ server {
     }
 
     # check for index.html for directory index
-    # if its there on the filesystem then rewite
+    # if it's there on the filesystem then rewrite
     # the url to add /index.html to the end of it
     # and then break to send it to the next config rules.
     if (-f $request_filename/index.html) {

data/docs/signals.md

@@ -0,0 +1,43 @@
+The [unix signal](http://en.wikipedia.org/wiki/Unix_signal) is a method of sending messages between [processes](http://en.wikipedia.org/wiki/Process_(computing)). When a signal is sent, the operating system interrupts the target process's normal flow of execution. There are standard signals that are used to stop a process but there are also custom signals that can be used for other purposes. This document is an attempt to list all supported signals that Puma will respond to. In general, signals need only be sent to the master process of a cluster.
+
+## Sending Signals
+
+If you are new to signals it can be useful to see how they can be used. When a process is created in a *nix like operating system it will have a [PID - or process identifier](http://en.wikipedia.org/wiki/Process_identifier) that can be used to send signals to the process. For demonstration we will create an infinitely running process by tailing a file:
+
+```sh
+$ echo "foo" >> my.log
+$ irb
+> pid = Process.spawn 'tail -f my.log'
+```
+
+From here we can see that the tail process is running by using the `ps` command:
+
+```sh
+$ ps aux | grep tail
+schneems        87152   0.0  0.0  2432772    492 s032  S+   12:46PM   0:00.00 tail -f my.log
+```
+
+You can send a signal in Ruby using the [Process module](http://www.ruby-doc.org/core-2.1.1/Process.html#kill-method):
+
+```
+$ irb
+> puts pid
+=> 87152
+Process.detach(pid) # http://ruby-doc.org/core-2.1.1/Process.html#method-c-detach
+Process.kill("TERM", pid)
+```
+
+Now you will see via `ps` that there is no more `tail` process. Sometimes when referring to signals the `SIG` prefix will be used for instance `SIGTERM` is equivalent to sending `TERM` via `Process.kill`.
+
+## Puma Signals
+
+Puma cluster responds to these signals:
+
+- `TTIN` increment the worker count by 1
+- `TTOU` decrement the worker count by 1
+- `TERM` send `TERM` to worker. Worker will attempt to finish then exit.
+- `USR2` restart workers
+- `USR1` restart workers in phases, a rolling restart.
+- `HUP`  reopen log files defined in stdout_redirect configuration parameter
+- `INT` equivalent of sending Ctrl-C to cluster. Will attempt to finish then exit.
+- `CHLD`

data/ext/puma_http11/extconf.rb

@@ -2,7 +2,12 @@ require 'mkmf'
 
 dir_config("puma_http11")
 
-$defs.push "-Wno-deprecated-declarations"
-$libs += " -lssl -lcrypto "
+unless ENV["DISABLE_SSL"]
+  if %w'crypto libeay32'.find {|crypto| have_library(crypto, 'BIO_read')} and
+      %w'ssl ssleay32'.find {|ssl| have_library(ssl, 'SSL_CTX_new')}
+
+    have_header "openssl/bio.h"
+  end
+end
 
 create_makefile("puma/puma_http11")

data/ext/puma_http11/http11_parser.java.rl

@@ -7,8 +7,8 @@ public class Http11Parser {
 /** Machine **/
 
 %%{
-  
-  machine http_parser;
+
+  machine puma_parser;
 
   action mark {parser.mark = fpc; }
 
@@ -60,7 +60,7 @@ public class Http11Parser {
     fbreak;
   }
 
-  include http_parser_common "http11_parser_common.rl";
+  include puma_parser_common "http11_parser_common.rl";
 
 }%%
 
@@ -152,10 +152,10 @@ public class Http11Parser {
   }
 
   public boolean has_error() {
-    return parser.cs == http_parser_error;
+    return parser.cs == puma_parser_error;
   }
 
   public boolean is_finished() {
-    return parser.cs == http_parser_first_final;
+    return parser.cs == puma_parser_first_final;
   }
 }