puma 4.3.0

data/lib/puma/util.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'uri/common'
+
+module Puma
+  module Util
+    module_function
+
+    def pipe
+      IO.pipe
+    end
+
+    # Unescapes a URI escaped string with +encoding+. +encoding+ will be the
+    # target encoding of the string returned, and it defaults to UTF-8
+    if defined?(::Encoding)
+      def unescape(s, encoding = Encoding::UTF_8)
+        URI.decode_www_form_component(s, encoding)
+      end
+    else
+      def unescape(s, encoding = nil)
+        URI.decode_www_form_component(s, encoding)
+      end
+    end
+    module_function :unescape
+
+    DEFAULT_SEP = /[&;] */n
+
+    # Stolen from Mongrel, with some small modifications:
+    # Parses a query string by breaking it up at the '&'
+    # and ';' characters.  You can also use this to parse
+    # cookies by changing the characters used in the second
+    # parameter (which defaults to '&;').
+    def parse_query(qs, d = nil, &unescaper)
+      unescaper ||= method(:unescape)
+
+      params = {}
+
+      (qs || '').split(d ? /[#{d}] */n : DEFAULT_SEP).each do |p|
+        next if p.empty?
+        k, v = p.split('=', 2).map(&unescaper)
+
+        if cur = params[k]
+          if cur.class == Array
+            params[k] << v
+          else
+            params[k] = [cur, v]
+          end
+        else
+          params[k] = v
+        end
+      end
+
+      return params
+    end
+
+    # A case-insensitive Hash that preserves the original case of a
+    # header when set.
+    class HeaderHash < Hash
+      def self.new(hash={})
+        HeaderHash === hash ? hash : super(hash)
+      end
+
+      def initialize(hash={})
+        super()
+        @names = {}
+        hash.each { |k, v| self[k] = v }
+      end
+
+      def each
+        super do |k, v|
+          yield(k, v.respond_to?(:to_ary) ? v.to_ary.join("\n") : v)
+        end
+      end
+
+      def to_hash
+        hash = {}
+        each { |k,v| hash[k] = v }
+        hash
+      end
+
+      def [](k)
+        super(k) || super(@names[k.downcase])
+      end
+
+      def []=(k, v)
+        canonical = k.downcase
+        delete k if @names[canonical] && @names[canonical] != k # .delete is expensive, don't invoke it unless necessary
+        @names[k] = @names[canonical] = k
+        super k, v
+      end
+
+      def delete(k)
+        canonical = k.downcase
+        result = super @names.delete(canonical)
+        @names.delete_if { |name,| name.downcase == canonical }
+        result
+      end
+
+      def include?(k)
+        @names.include?(k) || @names.include?(k.downcase)
+      end
+
+      alias_method :has_key?, :include?
+      alias_method :member?, :include?
+      alias_method :key?, :include?
+
+      def merge!(other)
+        other.each { |k, v| self[k] = v }
+        self
+      end
+
+      def merge(other)
+        hash = dup
+        hash.merge! other
+      end
+
+      def replace(other)
+        clear
+        other.each { |k, v| self[k] = v }
+        self
+      end
+    end
+  end
+end

data/lib/rack/handler/puma.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'rack/handler'
+
+module Rack
+  module Handler
+    module Puma
+      DEFAULT_OPTIONS = {
+        :Verbose => false,
+        :Silent  => false
+      }
+
+      def self.config(app, options = {})
+        require 'puma'
+        require 'puma/configuration'
+        require 'puma/events'
+        require 'puma/launcher'
+
+        default_options = DEFAULT_OPTIONS.dup
+
+        # 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
+
+        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
+
+          if default_options[:Host]
+            file_config.set_default_host(default_options[:Host])
+          end
+          self.set_host_port_to_config(default_options[:Host], default_options[:Port], default_config)
+
+          user_config.app app
+        end
+        conf
+      end
+
+      def self.run(app, options = {})
+        conf   = self.config(app, options)
+
+        events = options.delete(:Silent) ? ::Puma::Events.strings : ::Puma::Events.stdio
+
+        launcher = ::Puma::Launcher.new(conf, :events => events)
+
+        yield launcher if block_given?
+        begin
+          launcher.run
+        rescue Interrupt
+          puts "* Gracefully stopping, waiting for requests to finish"
+          launcher.stop
+          puts "* Goodbye!"
+        end
+      end
+
+      def self.valid_options
+        {
+          "Host=HOST"       => "Hostname to listen on (default: localhost)",
+          "Port=PORT"       => "Port to listen on (default: 8080)",
+          "Threads=MIN:MAX" => "min:max threads to use (default 0:16)",
+          "Verbose"         => "Don't report each request (default: false)"
+        }
+      end
+
+      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/docker/Dockerfile

@@ -0,0 +1,16 @@
+# Use this Dockerfile to create minimal reproductions of issues
+
+FROM ruby:2.6
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/app
+
+COPY . .
+RUN gem install bundler
+RUN bundle install
+RUN bundle exec rake compile
+
+EXPOSE 9292
+CMD bundle exec bin/puma test/rackup/hello.ru

data/tools/jungle/README.md

@@ -0,0 +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.
+
+## rc.d
+
+See `/tools/jungle/rc.d` for FreeBSD's rc.d scripts

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

@@ -0,0 +1,61 @@
+# 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 
+
+    # Copy the init script to services directory 
+    sudo cp puma /etc/init.d
+    sudo chmod +x /etc/init.d/puma
+    
+    # Make it start at boot time. 
+    sudo update-rc.d -f puma defaults
+
+    # Copy the Puma runner to an accessible location
+    sudo cp run-puma /usr/local/bin
+    sudo chmod +x /usr/local/bin/run-puma
+
+    # Create an empty configuration file
+    sudo touch /etc/puma.conf
+
+## Managing the jungle 
+
+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,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, 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:
+
+    sudo /etc/init.d/puma remove /path/to/app
+
+The command will make sure the Puma instance stops before removing it from the jungle.
+
+## Assumptions 
+
+* The script expects a temporary folder named /path/to/app/*tmp/puma* to exist. Create it if it's not there by default.
+The pid and state files should live there and must be called: *tmp/puma/pid* and *tmp/puma/state*.
+You can change those if you want but you'll have to adapt the script for it to work.
+
+* Here's what a minimal app's config file should have:
+
+```
+pidfile "/path/to/app/tmp/puma/pid"
+state_path "/path/to/app/tmp/puma/state"
+activate_control_app
+```

data/tools/jungle/init.d/puma

@@ -0,0 +1,421 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          puma 
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# 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>
+#
+# Do NOT "set -e"
+
+# PATH should only include /usr/* if it runs after the mountnfs.sh script
+PATH=/usr/local/bin:/usr/local/sbin/:/sbin:/usr/sbin:/bin:/usr/bin
+DESC="Puma rack web server"
+NAME=puma
+DAEMON=$NAME
+SCRIPTNAME=/etc/init.d/$NAME
+CONFIG=/etc/puma.conf
+JUNGLE=`cat $CONFIG`
+RUNPUMA=/usr/local/bin/run-puma
+USE_LOCAL_BUNDLE=0
+
+# Load the VERBOSE setting and other rcS variables
+. /lib/init/vars.sh
+
+# Define LSB log_* functions.
+# Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
+. /lib/lsb/init-functions
+
+#
+# Function that starts the jungle 
+#
+do_start() {
+  log_daemon_msg "=> Running the jungle..."
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_start_one $dir
+  done
+}
+
+do_start_one() {
+  PIDFILE=$1/tmp/puma/pid
+  if [ -e $PIDFILE ]; then
+    PID=`cat $PIDFILE`
+    # If the puma is running, restart it, otherwise run it.
+    if ps -p $PID > /dev/null; then
+      do_restart_one $1
+    else
+      do_start_one_do $1
+    fi
+  else
+    do_start_one_do $1
+  fi
+}
+
+do_start_one_do() {
+  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 "$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 $dir --chuid $user --background --exec $RUNPUMA -- $dir $config_file $log_file
+}
+
+#
+# Function that stops the jungle
+#
+do_stop() {
+  log_daemon_msg "=> Putting all the beasts to bed..."
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_stop_one $dir
+  done
+}
+#
+# Function that stops the daemon/service
+#
+do_stop_one() {
+  log_daemon_msg "--> Stopping $1"
+  PIDFILE=$1/tmp/puma/pid
+  STATEFILE=$1/tmp/puma/state
+  if [ -e $PIDFILE ]; then
+    PID=`cat $PIDFILE`
+    if ps -p $PID > /dev/null; then
+      log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
+      if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+        cd $1 && bundle exec pumactl --state $STATEFILE stop
+      else
+        pumactl --state $STATEFILE stop
+      fi
+      # Many daemons don't delete their pidfiles when they exit.
+      rm -f $PIDFILE $STATEFILE
+    else
+      log_daemon_msg "---> Puma $1 isn't running."
+    fi
+  else
+    log_daemon_msg "---> No puma here..."
+  fi
+  return 0
+}
+
+#
+# Function that restarts the jungle 
+#
+do_restart() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_restart_one $dir
+  done
+}
+
+#
+# Function that sends a SIGUSR2 to the daemon/service
+#
+do_restart_one() {
+  PIDFILE=$1/tmp/puma/pid
+
+  if [ -e $PIDFILE ]; then
+    log_daemon_msg "--> About to restart puma $1"
+    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"
+    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
+}
+
+#
+# Function that statuss the jungle 
+#
+do_status() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_status_one $dir
+  done
+}
+
+#
+# Function that sends a SIGUSR2 to the daemon/service
+#
+do_status_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 status puma $1"
+    if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+      cd $1 && bundle exec pumactl --state $dir/tmp/puma/state stats
+    else
+      pumactl --state $dir/tmp/puma/state stats
+    fi
+    # kill -s USR2 `cat $PIDFILE`
+    # TODO Check if process exist
+  else
+    log_daemon_msg "--> $1 isn't there :(..." 
+  fi
+	return 0
+}
+
+do_add() {
+  str=""
+  # App's directory
+  if [ -d "$1" ]; then
+    if [ "`grep -c "^$1" $CONFIG`" -eq 0 ]; then
+      str=$1
+    else
+      echo "The app is already being managed. Remove it if you want to update its config."
+      exit 1 
+    fi
+  else
+    echo "The directory $1 doesn't exist."
+    exit 1
+  fi
+  # User to run it as
+  if [ "`grep -c "^$2:" /etc/passwd`" -eq 0 ]; then
+    echo "The user $2 doesn't exist."
+    exit 1
+  else
+    str="$str,$2"
+  fi
+  # Config file
+  if [ "$3" != "" ]; then
+    if [ -e $3 ]; then
+      str="$str,$3"
+    else
+      echo "The config file $3 doesn't exist."
+      exit 1
+    fi
+  fi
+  # Log file
+  if [ "$4" != "" ]; then
+    str="$str,$4"
+  fi
+
+  # Environment variables
+  if [ "$5" != "" ]; then
+    str="$str,$5"
+  fi
+
+  # Add it to the jungle 
+  echo $str >> $CONFIG
+  log_daemon_msg "Added a Puma to the jungle: $str. You still have to start it though."
+}
+
+do_remove() {
+  if [ "`grep -c "^$1" $CONFIG`" -eq 0 ]; then
+    echo "There's no app $1 to remove."
+  else
+    # Stop it first.
+    do_stop_one $1
+    # Remove it from the config.
+    sed -i "\\:^$1:d" $CONFIG
+    log_daemon_msg "Removed a Puma from the jungle: $1."
+  fi
+}
+
+config_bundler() {
+  HOME="$(eval echo ~$(id -un))"
+
+  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
+  # 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"
+  # TODO: don't know what to do with chruby
+  # elif [ -f /usr/local/share/chruby/chruby.sh ]; then
+  #   source /usr/local/share/chruby/chruby.sh
+  #   if [ -f /usr/local/share/chruby/auto.sh ]; then
+  #     source /usr/local/share/chruby/auto.sh
+  #   fi
+  # if you aren't using auto, set your version here
+  # chruby 2.0.0
+  fi
+
+  return 1
+}
+
+config_bundler
+
+case "$1" in
+  start)
+    [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_start
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_start_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  stop)
+    [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_stop
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_stop_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  status)
+    # TODO Implement.
+    log_daemon_msg "Status $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_status
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_status_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  restart)
+    log_daemon_msg "Restarting $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_restart
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_restart_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      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, 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
+    else
+      do_add $2 $3 $4 $5
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  remove)
+    if [ "$#" -lt 2 ]; then
+      echo "Please, specify the app's directory to remove."
+      exit 1
+    else
+      do_remove $2
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
+  *)
+    echo "Usage:" >&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|phased-restart} PUMA-NAME" >&2
+    exit 3
+  ;;
+esac
+: