puma 2.16.0 → 3.11.4

data/lib/rack/handler/puma.rb

@@ -1,52 +1,78 @@
 require 'rack/handler'
-require 'puma'
 
 module Rack
   module Handler
     module Puma
       DEFAULT_OPTIONS = {
-        :Host => '0.0.0.0',
-        :Port => 8080,
-        :Threads => '0:16',
         :Verbose => false,
-        :Silent => false
+        :Silent  => false
       }
 
-      def self.run(app, options = {})
-        options  = DEFAULT_OPTIONS.merge(options)
+      def self.config(app, options = {})
+        require 'puma'
+        require 'puma/configuration'
+        require 'puma/events'
+        require 'puma/launcher'
+
+        default_options = DEFAULT_OPTIONS.dup
 
-        if options[:Verbose]
-          app = Rack::CommonLogger.new(app, STDOUT)
+        # Libraries pass in values such as :Port and there is no way to determine
+        # if it is a default provided by the library or a special value provided
+        # by the user. A special key `user_supplied_options` can be passed. This
+        # contains an array of all explicitly defined user options. We then
+        # know that all other values are defaults
+        if user_supplied_options = options.delete(:user_supplied_options)
+          (options.keys - user_supplied_options).each do |k|
+            default_options[k] = options.delete(k)
+          end
         end
 
-        if options[:environment]
-          ENV['RACK_ENV'] = options[:environment].to_s
+        conf = ::Puma::Configuration.new(options, default_options) do |user_config, file_config, default_config|
+          user_config.quiet
+
+          if options.delete(:Verbose)
+            app = Rack::CommonLogger.new(app, STDOUT)
+          end
+
+          if options[:environment]
+            user_config.environment options[:environment]
+          end
+
+          if options[:Threads]
+            min, max = options.delete(:Threads).split(':', 2)
+            user_config.threads min, max
+          end
+
+          if options[:Host] || options[:Port]
+            host = options[:Host] || default_options[:Host]
+            port = options[:Port] || default_options[:Port]
+            self.set_host_port_to_config(host, port, user_config)
+          end
+
+          self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+
+          user_config.app app
         end
+        conf
+      end
 
-        events_hander = options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
-        server   = ::Puma::Server.new(app, events_hander)
-        min, max = options[:Threads].split(':', 2)
 
-        log = events_hander.stdout
 
-        log.puts "Puma #{::Puma::Const::PUMA_VERSION} starting..."
-        log.puts "* Min threads: #{min}, max threads: #{max}"
-        log.puts "* Environment: #{ENV['RACK_ENV']}"
-        log.puts "* Listening on tcp://#{options[:Host]}:#{options[:Port]}"
+      def self.run(app, options = {})
+        conf   = self.config(app, options)
+
+        events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
 
-        server.add_tcp_listener options[:Host], options[:Port]
-        server.min_threads = min
-        server.max_threads = max
-        yield server if block_given?
+        launcher = ::Puma::Launcher.new(conf, :events => events)
 
+        yield launcher if block_given?
         begin
-          server.run.join
+          launcher.run
         rescue Interrupt
-          log.puts "* Gracefully stopping, waiting for requests to finish"
-          server.stop(true)
-          log.puts "* Goodbye!"
+          puts "* Gracefully stopping, waiting for requests to finish"
+          launcher.stop
+          puts "* Goodbye!"
         end
-
       end
 
       def self.valid_options
@@ -57,9 +83,30 @@ module Rack
           "Verbose"         => "Don't report each request (default: false)"
         }
       end
+    private
+      def self.set_host_port_to_config(host, port, config)
+        config.clear_binds! if host || port
+
+        if host && (host[0,1] == '.' || host[0,1] == '/')
+          config.bind "unix://#{host}"
+        elsif host && host =~ /^ssl:\/\//
+          uri = URI.parse(host)
+          uri.port ||= port || ::Puma::Configuration::DefaultTCPPort
+          config.bind uri.to_s
+        else
+
+          if host
+            port ||= ::Puma::Configuration::DefaultTCPPort
+          end
+
+          if port
+            host ||= ::Puma::Configuration::DefaultTCPHost
+            config.port port, host
+          end
+        end
+      end
     end
 
     register :puma, Puma
   end
 end
-

data/tools/jungle/README.md

@@ -1,9 +1,19 @@
 # Puma as a service
 
+## Upstart
+
+See `/tools/jungle/upstart` for Ubuntu's upstart scripts.
+
+## Systemd
+
+See [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md).
+
 ## Init.d
 
+Deprecatation Warning : `init.d` was replaced by `systemd` since Debian 8 and Ubuntu 16.04, you should look into [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md) unless you are on an older OS.
+
 See `/tools/jungle/init.d` for tools to use with init.d and start-stop-daemon.
 
-## Upstart
+## rc.d
 
-See `/tools/jungle/upstart` for Ubuntu's upstart scripts.
+See `/tools/jungle/rc.d` for FreeBSD's rc.d scripts

data/tools/jungle/init.d/README.md

@@ -1,5 +1,7 @@
 # Puma daemon service
 
+Deprecatation Warning : `init.d` was replaced by `systemd` since Debian 8 and Ubuntu 16.04, you should look into [/docs/systemd](https://github.com/puma/puma/blob/master/docs/systemd.md) unless you are on an older OS. 
+
 Init script to manage multiple Puma servers on the same box using start-stop-daemon.
 
 ## Installation 
@@ -22,16 +24,21 @@ Init script to manage multiple Puma servers on the same box using start-stop-dae
 
 Puma apps are held in /etc/puma.conf by default. It's mainly a CSV file and every line represents one app. Here's the syntax:
 
-    app-path,user,config-file-path,log-file-path
+    app-path,user,config-file-path,log-file-path,environment-variables
 
 You can add an instance by editing the file or running the following command:
 
     sudo /etc/init.d/puma add /path/to/app user /path/to/app/config/puma.rb /path/to/app/log/puma.log
 
-The config and log paths are optional parameters and default to:
+The config and log paths, as well as the environment variables, are optional parameters and default to:
 
 * config: /path/to/app/*config/puma.rb*
 * log: /path/to/app/*log/puma.log*
+* environment: (empty)
+
+Multiple environment variables need to be separated by a semicolon, e.g.
+
+    FOO=1;BAR=2
 
 To remove an app, simply delete the line from the config file or run:
 

data/tools/jungle/init.d/puma

@@ -5,9 +5,9 @@
 # Required-Stop:     $remote_fs $syslog
 # Default-Start:     2 3 4 5
 # Default-Stop:      0 1 6
-# Short-Description: Example initscript
-# Description:       This file should be used to construct scripts to be
-#                    placed in /etc/init.d.
+# Short-Description: Puma web server
+# Description:       A ruby web server built for concurrency http://puma.io
+#                    initscript to be placed in /etc/init.d.
 ### END INIT INFO
 
 # Author: Darío Javier Cravero <dario@exordo.com>
@@ -39,17 +39,7 @@ do_start() {
   log_daemon_msg "=> Running the jungle..."
   for i in $JUNGLE; do
     dir=`echo $i | cut -d , -f 1`
-    user=`echo $i | cut -d , -f 2`
-    config_file=`echo $i | cut -d , -f 3`
-    if [ "$config_file" = "" ]; then
-      config_file="$dir/config/puma.rb"
-    fi
-    log_file=`echo $i | cut -d , -f 4`
-    if [ "$log_file" = "" ]; then
-      log_file="$dir/log/puma.log"
-    fi
-    environment=`echo $i | cut -d , -f 5`
-    do_start_one $dir $user $config_file $log_file $environment
+    do_start_one $dir
   done
 }
 
@@ -58,29 +48,42 @@ do_start_one() {
   if [ -e $PIDFILE ]; then
     PID=`cat $PIDFILE`
     # If the puma isn't running, run it, otherwise restart it.
-    if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
-      do_start_one_do $1 $2 $3 $4 $5
+    if ps -p $PID > /dev/null; then
+      do_start_one_do $1
     else
       do_restart_one $1
     fi
   else
-    do_start_one_do $1 $2 $3 $4 $5
+    do_start_one_do $1
   fi
 }
 
 do_start_one_do() {
-  log_daemon_msg "--> Woke up puma $1"
-  log_daemon_msg "user $2"
-  log_daemon_msg "log to $4"
+  i=`grep $1 $CONFIG`
+  dir=`echo $i | cut -d , -f 1`
+  user=`echo $i | cut -d , -f 2`
+  config_file=`echo $i | cut -d , -f 3`
+  if [ "$config_file" = "" ]; then
+    config_file="$dir/config/puma.rb"
+  fi
+  log_file=`echo $i | cut -d , -f 4`
+  if [ "$log_file" = "" ]; then
+    log_file="$dir/log/puma.log"
+  fi
+  environment=`echo $i | cut -d , -f 5`
+
+  log_daemon_msg "--> Woke up puma $dir"
+  log_daemon_msg "user $user"
+  log_daemon_msg "log to $log_file"
 
-  if [ ! -z "$5" ]; then
-    for e in $(echo "$5" | tr ';' '\n'); do
+  if [ ! -z "$environment" ]; then
+    for e in $(echo "$environment" | tr ';' '\n'); do
         log_daemon_msg "environment $e"
         v=${e%%\=*} ;  eval "$e" ; export $v
     done
   fi
 
-  start-stop-daemon --verbose --start --chdir $1 --chuid $2 --background --exec $RUNPUMA -- $1 $3 $4
+  start-stop-daemon --verbose --start --chdir $dir --chuid $user --background --exec $RUNPUMA -- $dir $config_file $log_file
 }
 
 #
@@ -102,7 +105,7 @@ do_stop_one() {
   STATEFILE=$1/tmp/puma/state
   if [ -e $PIDFILE ]; then
     PID=`cat $PIDFILE`
-    if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
+    if ps -p $PID > /dev/null; then
       log_daemon_msg "---> Puma $1 isn't running."
     else
       log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
@@ -135,31 +138,41 @@ do_restart() {
 #
 do_restart_one() {
   PIDFILE=$1/tmp/puma/pid
-  i=`grep $1 $CONFIG`
-  dir=`echo $i | cut -d , -f 1`
-  
+
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to restart puma $1"
-    if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
-      cd $1 && bundle exec pumactl --state $dir/tmp/puma/state restart
-    else
-      pumactl --state $dir/tmp/puma/state restart
-    fi
-    # kill -s USR2 `cat $PIDFILE`
+    kill -s USR2 `cat $PIDFILE`
     # TODO Check if process exist
   else
-    log_daemon_msg "--> Your puma was never playing... Let's get it out there first" 
-    user=`echo $i | cut -d , -f 2`
-    config_file=`echo $i | cut -d , -f 3`
-    if [ "$config_file" = "" ]; then
-      config_file="$dir/config/puma.rb"
-    fi
-    log_file=`echo $i | cut -d , -f 4`
-    if [ "$log_file" = "" ]; then
-      log_file="$dir/log/puma.log"
-    fi
-    environment=`echo $i | cut -d , -f 5`
-    do_start_one $dir $user $config_file $log_file $environment
+    log_daemon_msg "--> Your puma was never playing... Let's get it out there first"
+    do_start_one $1
+  fi
+	return 0
+}
+
+#
+# Function that phased restarts the jungle
+#
+do_phased_restart() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_phased_restart_one $dir
+  done
+}
+
+#
+# Function that sends a SIGUSR1 to the daemon/service
+#
+do_phased_restart_one() {
+  PIDFILE=$1/tmp/puma/pid
+
+  if [ -e $PIDFILE ]; then
+    log_daemon_msg "--> About to restart puma $1"
+    kill -s USR1 `cat $PIDFILE`
+    # TODO Check if process exist
+  else
+    log_daemon_msg "--> Your puma was never playing... Let's get it out there first"
+    do_start_one $1
   fi
 	return 0
 }
@@ -256,16 +269,25 @@ do_remove() {
 
 config_bundler() {
   HOME="$(eval echo ~$(id -un))"
-  if [ -d "/usr/local/rbenv/bin" ]; then
+
+  if [ -d "$1/.rbenv/bin" ]; then
+    PATH="$1/.rbenv/bin:$1/.rbenv/shims:$1"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+
+  elif [ -d "/usr/local/rbenv/bin" ]; then
     PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
     eval "$(rbenv init -)"
     USE_LOCAL_BUNDLE=1
     return 0
+
   elif [ -d "$HOME/.rbenv/bin" ]; then
     PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
     eval "$(rbenv init -)"
     USE_LOCAL_BUNDLE=1
     return 0
+
   # TODO: test rvm
   # elif [ -f  /etc/profile.d/rvm.sh ]; then
   #   source /etc/profile.d/rvm.sh
@@ -296,16 +318,7 @@ case "$1" in
     else
       i=`grep $2 $CONFIG`
       dir=`echo $i | cut -d , -f 1`
-      user=`echo $i | cut -d , -f 2`
-      config_file=`echo $i | cut -d , -f 3`
-      if [ "$config_file" = "" ]; then
-        config_file="$dir/config/puma.rb"
-      fi
-      log_file=`echo $i | cut -d , -f 4`
-      if [ "$log_file" = "" ]; then
-        log_file="$dir/log/puma.log"
-      fi
-      do_start_one $dir $user $config_file $log_file
+      do_start_one $dir
     fi
     case "$?" in
       0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
@@ -355,9 +368,23 @@ case "$1" in
       2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
     esac
   ;;
+  phased-restart)
+    log_daemon_msg "Restarting (phased) $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_phased_restart
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_phased_restart_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
   add)
     if [ "$#" -lt 3 ]; then
-      echo "Please, specifiy the app's directory and the user that will run it at least."
+      echo "Please, specify the app's directory and the user that will run it at least."
       echo "  Usage: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
       echo "    config and log are optionals."
       exit 1
@@ -383,11 +410,11 @@ case "$1" in
   ;;
   *)
     echo "Usage:" >&2
-    echo "  Run the jungle: $SCRIPTNAME {start|stop|status|restart}" >&2
+    echo "  Run the jungle: $SCRIPTNAME {start|stop|status|restart|phased-restart}" >&2
     echo "  Add a Puma: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
     echo "    config and log are optionals."
     echo "  Remove a Puma: $SCRIPTNAME remove /path/to/app"
-    echo "  On a Puma: $SCRIPTNAME {start|stop|status|restart} PUMA-NAME" >&2
+    echo "  On a Puma: $SCRIPTNAME {start|stop|status|restart|phased-restart} PUMA-NAME" >&2
     exit 3
   ;;
 esac

data/tools/jungle/init.d/run-puma

@@ -1,3 +1,18 @@
 #!/bin/bash
+
+# on system boot, and root have no rbenv installed,
+#   after start-stop-daemon switched to current user, we have to init rbenv
+if [ -d "$HOME/.rbenv/bin" ]; then
+  PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
+  eval "$(rbenv init -)"
+elif [ -d "/usr/local/rbenv/bin" ]; then
+  PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
+  eval "$(rbenv init -)"
+elif [ -f /usr/local/rvm/scripts/rvm ]; then
+  source /etc/profile.d/rvm.sh
+elif [ -f "$HOME/.rvm/scripts/rvm" ]; then
+  source "$HOME/.rvm/scripts/rvm"
+fi
+
 app=$1; config=$2; log=$3;
-cd $app && exec bundle exec puma -C $config 2>&1 >> $log
+cd $app && exec bundle exec puma -C $config >> $log 2>&1

data/tools/jungle/rc.d/README.md

@@ -0,0 +1,74 @@
+# Puma as a service using rc.d
+
+Manage multilpe Puma servers as services on one box using FreeBSD's rc.d service.
+
+## Dependencies
+
+* `jq` - a command-line json parser is needed to parse the json in the config file
+
+## Installation
+
+    # Copy the puma script to the rc.d directory (make sure everyone has read/execute perms)
+    sudo cp puma /usr/local/etc/rc.d/
+
+    # Create an empty configuration file
+    sudo touch /usr/local/etc/puma.conf
+
+    # Enable the puma service
+    sudo echo 'puma_enable="YES"' >> /etc/rc.conf
+
+## Managing the jungle
+
+Puma apps are referenced in /usr/local/etc/puma.conf by default.
+
+Start the jungle running:
+
+`service puma start`
+
+This script will run at boot time.
+
+
+You can also stop the jungle (stops ALL puma instances) by running:
+
+`service puma stop`
+
+
+To restart the jungle:
+
+`service puma restart`
+
+## Conventions
+
+* The script expects:
+  * a config file to exist under `config/puma.rb` in your app. E.g.: `/home/apps/my-app/config/puma.rb`.
+
+You can always change those defaults by editing the scripts.
+
+## Here's what a minimal app's config file should have
+
+```
+{
+	"servers" : [
+		{
+			"dir": "/path/to/rails/project",
+			"user": "deploy-user",
+			"ruby_version": "ruby.version",
+			"ruby_env": "rbenv"
+		}
+	]
+}
+```
+
+## Before starting...
+
+You need to customise `puma.conf` to:
+
+* Set the right user your app should be running on unless you want root to execute it!
+* Set the directory of the app
+* Set the ruby version to execute
+* Set the ruby environment (currently set to rbenv, since that is the only ruby environment currently supported)
+* Add additional server instances following the scheme in the example
+
+## Notes:
+
+Only rbenv is currently supported.

data/tools/jungle/rc.d/puma

@@ -0,0 +1,61 @@
+#!/bin/sh
+#
+
+# PROVIDE: puma
+
+. /etc/rc.subr
+
+name="puma"
+start_cmd="puma_start"
+stop_cmd="puma_stop"
+restart_cmd="puma_restart"
+rcvar=puma_enable
+required_files=/usr/local/etc/puma.conf
+
+puma_start()
+{
+	server_count=$(/usr/local/bin/jq ".servers[] .ruby_env" /usr/local/etc/puma.conf | wc -l)
+	i=0	
+	while [ "$i" -lt "$server_count" ]; do
+		rb_env=$(/usr/local/bin/jq -r ".servers[$i].ruby_env" /usr/local/etc/puma.conf)
+		dir=$(/usr/local/bin/jq -r ".servers[$i].dir" /usr/local/etc/puma.conf)
+		user=$(/usr/local/bin/jq -r ".servers[$i].user" /usr/local/etc/puma.conf)
+		rb_ver=$(/usr/local/bin/jq -r ".servers[$i].ruby_version" /usr/local/etc/puma.conf)
+		case $rb_env in
+			"rbenv")
+				su - $user -c "cd $dir && rbenv shell $rb_ver && bundle exec puma -C $dir/config/puma.rb -d"
+				;;
+			*)
+				;;
+		esac
+		i=$(( i + 1 ))
+	done
+}
+
+puma_stop()
+{
+    pkill ruby
+}
+
+puma_restart()
+{
+	server_count=$(/usr/local/bin/jq ".servers[] .ruby_env" /usr/local/etc/puma.conf | wc -l)
+	i=0	
+	while [ "$i" -lt "$server_count" ]; do
+		rb_env=$(/usr/local/bin/jq -r ".servers[$i].ruby_env" /usr/local/etc/puma.conf)
+		dir=$(/usr/local/bin/jq -r ".servers[$i].dir" /usr/local/etc/puma.conf)
+		user=$(/usr/local/bin/jq -r ".servers[$i].user" /usr/local/etc/puma.conf)
+		rb_ver=$(/usr/local/bin/jq -r ".servers[$i].ruby_version" /usr/local/etc/puma.conf)
+		case $rb_env in
+			"rbenv")
+				su - $user -c "cd $dir && pkill ruby && rbenv shell $ruby_version && bundle exec puma -C $dir/config/puma.rb -d"
+				;;
+			*)
+				;;
+		esac
+		i=$(( i + 1 ))
+	done
+}
+
+load_rc_config $name
+run_rc_command "$1"

data/tools/jungle/rc.d/puma.conf

@@ -0,0 +1,10 @@
+{
+	"servers" : [
+		{
+			"dir": "/path/to/rails/project",
+			"user": "deploy-user",
+			"ruby_version": "ruby.version",
+			"ruby_env": "rbenv"
+		}
+	]
+}

data/tools/jungle/upstart/puma.conf

@@ -4,7 +4,7 @@
 # allows you to manage multiple Puma instances with
 # Upstart, Ubuntu's native service management tool.
 #
-# See workers.conf for how to manage all Puma instances at once.
+# See puma-manager.conf for how to manage all Puma instances at once.
 #
 # Save this config as /etc/init/puma.conf then manage puma with:
 #   sudo start puma app=PATH_TO_APP

data/tools/trickletest.rb

@@ -31,7 +31,7 @@ st = "GET / HTTP/1.1\r\nHost: www.zedshaw.com\r\nContent-Type: text/plain\r\nCon
 puts "length: #{content.length}"
 
 threads = []
-ARGV[1].to_i.times do 
+ARGV[1].to_i.times do
   t = Thread.new do
     size = 100
     puts ">>>> #{size} sized chunks"