puma 2.12.3 → 2.16.0

data/lib/puma/dsl.rb

@@ -42,6 +42,7 @@ module Puma
         @options[:control_auth_token] = auth_token if auth_token
 
         @options[:control_auth_token] = :none if opts[:no_token]
+        @options[:control_url_umask] = opts[:umask] if opts[:umask]
       end
     end
 
@@ -132,7 +133,7 @@ module Puma
       min = Integer(min)
       max = Integer(max)
       if min > max
-        raise "The minimum (#{min}) number of threads must be less than the max (#{max})"
+        raise "The minimum (#{min}) number of threads must be less than or equal to the max (#{max})"
       end
 
       @options[:min_threads] = min
@@ -140,7 +141,12 @@ module Puma
     end
 
     def ssl_bind(host, port, opts)
-      @options[:binds] << "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}"
+      if defined?(JRUBY_VERSION)
+        keystore_additions = "keystore=#{opts[:keystore]}&keystore-pass=#{opts[:keystore_pass]}"
+        @options[:binds] << "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}&#{keystore_additions}"
+      else
+        @options[:binds] << "ssl://#{host}:#{port}?cert=#{opts[:cert]}&key=#{opts[:key]}"
+      end
     end
 
     # Use +path+ as the file to store the server info state. This is
@@ -156,6 +162,19 @@ module Puma
       @options[:workers] = count.to_i
     end
 
+    # *Cluster mode only* Code to run immediately before master process
+    # forks workers (once on boot). These hooks can block if necessary
+    # to wait for background operations unknown to puma to finish before
+    # the process terminates.
+    # This can be used to close any connections to remote servers (database, redis, ...)
+    # that were opened when preloading the code
+    #
+    # This can be called multiple times to add hooks.
+    #
+    def before_fork(&block)
+      @options[:before_fork] << block
+    end
+
     # *Cluster mode only* Code to run immediately before a worker shuts
     # down (after it has finished processing HTTP requests). These hooks
     # can block if necessary to wait for background operations unknown
@@ -243,11 +262,19 @@ module Puma
       @options[:tag] = string
     end
 
-    # *Cluster mode only* Set the timeout for workers
+    # *Cluster mode only* Set the timeout for workers in seconds
+    # When set the master process will terminate any workers
+    # that have not checked in within the given +timeout+.
+    # This mitigates hung processes. Default value is 60 seconds.
     def worker_timeout(timeout)
       @options[:worker_timeout] = timeout
     end
 
+    # *Cluster mode only* Set the timeout for workers to boot
+    def worker_boot_timeout(timeout)
+      @options[:worker_boot_timeout] = timeout
+    end
+
     # *Cluster mode only* Set the timeout for worker shutdown
     def worker_shutdown_timeout(timeout)
       @options[:worker_shutdown_timeout] = timeout
@@ -276,5 +303,46 @@ module Puma
     def shutdown_debug(val=true)
       @options[:shutdown_debug] = val
     end
+
+    # Control how the remote address of the connection is set. This
+    # is configurable because to calculate the true socket peer address
+    # a kernel syscall is required which for very fast rack handlers
+    # slows down the handling significantly.
+    #
+    # There are 4 possible values:
+    #
+    # * :socket (the default) - read the peername from the socket using the
+    #           syscall. This is the normal behavior.
+    # * :localhost - set the remote address to "127.0.0.1"
+    # * header: http_header - set the remote address to the value of the
+    #                          provided http header. For instance:
+    #                          `set_remote_address header: "X-Real-IP"`.
+    #                          Only the first word (as separated by spaces or comma)
+    #                          is used, allowing headers such as X-Forwarded-For
+    #                          to be used as well.
+    # * Any string - this allows you to hardcode remote address to any value
+    #                you wish. Because puma never uses this field anyway, it's
+    #                format is entirely in your hands.
+    def set_remote_address(val=:socket)
+      case val
+      when :socket
+        @options[:remote_address] = val
+      when :localhost
+        @options[:remote_address] = :value
+        @options[:remote_address_value] = "127.0.0.1".freeze
+      when String
+        @options[:remote_address] = :value
+        @options[:remote_address_value] = val
+      when Hash
+        if hdr = val[:header]
+          @options[:remote_address] = :header
+          @options[:remote_address_header] = "HTTP_" + hdr.upcase.gsub("-", "_")
+        else
+          raise "Invalid value for set_remote_address - #{val.inspect}"
+        end
+      else
+        raise "Invalid value for set_remote_address - #{val}"
+      end
+    end
   end
 end

data/lib/puma/events.rb

@@ -128,7 +128,7 @@ module Puma
 
     DEFAULT = new(STDOUT, STDERR)
 
-    # Returns an Events object which writes it's status to 2 StringIO
+    # Returns an Events object which writes its status to 2 StringIO
     # objects.
     #
     def self.strings

data/lib/puma/minissl.rb

@@ -102,6 +102,8 @@ module Puma
       class SSLError < StandardError
         # Define this for jruby even though it isn't used.
       end
+
+      def self.check; end
     end
 
     class Context

data/lib/puma/runner.rb

@@ -52,8 +52,9 @@ module Puma
       when "unix"
         log "* Starting control server on #{str}"
         path = "#{uri.host}#{uri.path}"
+        mask = @options[:control_url_umask]
 
-        control.add_unix_listener path
+        control.add_unix_listener path, mask
       else
         error "Invalid control URI: #{str}"
       end

data/lib/puma/server.rb

@@ -45,7 +45,7 @@ module Puma
     # to be handled. See Puma::Events for the list of current methods to implement.
     #
     # Server#run returns a thread that you can join on to wait for the server
-    # to do it's work.
+    # to do its work.
     #
     def initialize(app, events=Events.stdio, options={})
       @app = app
@@ -307,6 +307,16 @@ module Puma
         pool = @thread_pool
         queue_requests = @queue_requests
 
+        remote_addr_value = nil
+        remote_addr_header = nil
+
+        case @options[:remote_address]
+        when :value
+          remote_addr_value = @options[:remote_address_value]
+        when :header
+          remote_addr_header = @options[:remote_address_header]
+        end
+
         while @status == :run
           begin
             ios = IO.select sockets
@@ -317,6 +327,12 @@ module Puma
                 begin
                   if io = sock.accept_nonblock
                     client = Client.new io, @binder.env(sock)
+                    if remote_addr_value
+                      client.peerip = remote_addr_value
+                    elsif remote_addr_header
+                      client.remote_addr_header = remote_addr_header
+                    end
+
                     pool << client
                     pool.wait_until_not_full unless queue_requests
                   end
@@ -481,7 +497,7 @@ module Puma
 
       unless env.key?(REMOTE_ADDR)
         begin
-          addr = client.peeraddr.last
+          addr = client.peerip
         rescue Errno::ENOTCONN
           # Client disconnects can result in an inability to get the
           # peeraddr from the socket; default to localhost.
@@ -513,7 +529,7 @@ module Puma
       env = req.env
       client = req.io
 
-      normalize_env env, client
+      normalize_env env, req
 
       env[PUMA_SOCKET] = client
 
@@ -571,7 +587,7 @@ module Puma
 
         http_11 = if env[HTTP_VERSION] == HTTP_11
           allow_chunked = true
-          keep_alive = env[HTTP_CONNECTION] != CLOSE
+          keep_alive = env.fetch(HTTP_CONNECTION, "").downcase != CLOSE
           include_keepalive_header = false
 
           # An optimization. The most common response is 200, so we can
@@ -589,7 +605,7 @@ module Puma
           true
         else
           allow_chunked = false
-          keep_alive = env[HTTP_CONNECTION] == KEEP_ALIVE
+          keep_alive = env.fetch(HTTP_CONNECTION, "").downcase == KEEP_ALIVE
           include_keepalive_header = keep_alive
 
           # Same optimization as above for HTTP/1.1
@@ -608,7 +624,7 @@ module Puma
         response_hijack = nil
 
         headers.each do |k, vs|
-          case k
+          case k.downcase
           when CONTENT_LENGTH2
             content_length = vs
             next
@@ -644,7 +660,7 @@ module Puma
           fast_write client, lines.to_s
           return keep_alive
         end
-        
+
         if content_length
           lines.append CONTENT_LENGTH_S, content_length.to_s, line_ending
           chunked = false

data/lib/puma/single.rb

@@ -62,7 +62,7 @@ module Puma
           end
 
           Signal.trap "SIGCHLD" do
-            log "! Error starting new process as daemon, exitting"
+            log "! Error starting new process as daemon, exiting"
             exit 1
           end
 

data/lib/puma/thread_pool.rb

@@ -160,7 +160,7 @@ module Puma
     end
 
     # If there are dead threads in the pool make them go away while decreasing
-    # spwaned counter so that new healty threads could be created again.
+    # spawned counter so that new healthy threads could be created again.
     def reap
       @mutex.synchronize do
         dead_workers = @workers.reject(&:alive?)
@@ -235,20 +235,18 @@ module Puma
     # Tell all threads in the pool to exit and wait for them to finish.
     #
     def shutdown
-      @mutex.synchronize do
+      threads = @mutex.synchronize do
         @shutdown = true
         @not_empty.broadcast
         @not_full.broadcast
 
         @auto_trim.stop if @auto_trim
         @reaper.stop if @reaper
+        # dup workers so that we join them all safely
+        @workers.dup
       end
 
-      # Use this instead of #each so that we don't stop in the middle
-      # of each and see a mutated object mid #each
-      if !@workers.empty?
-          @workers.first.join until @workers.empty?
-      end
+      threads.each(&:join)
 
       @spawned = 0
       @workers = []

data/lib/rack/handler/puma.rb

@@ -8,7 +8,8 @@ module Rack
         :Host => '0.0.0.0',
         :Port => 8080,
         :Threads => '0:16',
-        :Verbose => false
+        :Verbose => false,
+        :Silent => false
       }
 
       def self.run(app, options = {})
@@ -22,13 +23,16 @@ module Rack
           ENV['RACK_ENV'] = options[:environment].to_s
         end
 
-        server   = ::Puma::Server.new(app)
+        events_hander = options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
+        server   = ::Puma::Server.new(app, events_hander)
         min, max = options[:Threads].split(':', 2)
 
-        puts "Puma #{::Puma::Const::PUMA_VERSION} starting..."
-        puts "* Min threads: #{min}, max threads: #{max}"
-        puts "* Environment: #{ENV['RACK_ENV']}"
-        puts "* Listening on tcp://#{options[:Host]}:#{options[:Port]}"
+        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]}"
 
         server.add_tcp_listener options[:Host], options[:Port]
         server.min_threads = min
@@ -38,9 +42,9 @@ module Rack
         begin
           server.run.join
         rescue Interrupt
-          puts "* Gracefully stopping, waiting for requests to finish"
+          log.puts "* Gracefully stopping, waiting for requests to finish"
           server.stop(true)
-          puts "* Goodbye!"
+          log.puts "* Goodbye!"
         end
 
       end
@@ -50,7 +54,7 @@ module Rack
           "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)",
-          "Quiet"           => "Don't report each request"
+          "Verbose"         => "Don't report each request (default: false)"
         }
       end
     end

data/tools/jungle/init.d/puma

@@ -23,6 +23,7 @@ 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
@@ -105,7 +106,11 @@ do_stop_one() {
       log_daemon_msg "---> Puma $1 isn't running."
     else
       log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
-      pumactl --state $STATEFILE stop
+      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
     fi
@@ -135,7 +140,11 @@ do_restart_one() {
   
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to restart puma $1"
-    pumactl --state $dir/tmp/puma/state restart
+    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`
     # TODO Check if process exist
   else
@@ -175,7 +184,11 @@ do_status_one() {
   
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to status puma $1"
-    pumactl --state $dir/tmp/puma/state stats
+    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
@@ -241,6 +254,40 @@ do_remove() {
   fi
 }
 
+config_bundler() {
+  HOME="$(eval echo ~$(id -un))"
+  if [ -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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 2.12.3
+  version: 2.16.0
 platform: ruby
 authors:
 - Evan Phoenix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2016-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.13'
+        version: '3.14'
 description: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server
   for Ruby/Rack applications. Puma is intended for use in both development and production
   environments. In order to get the best throughput, it is highly recommended that
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Puma is a simple, fast, threaded, and highly concurrent HTTP 1.1 server for