puma 2.7.0 → 3.1.1

data/lib/puma/minissl.rb

@@ -4,6 +4,7 @@ module Puma
       def initialize(socket, engine)
         @socket = socket
         @engine = engine
+        @peercert = nil
       end
 
       def to_io
@@ -69,7 +70,7 @@ module Puma
 
           return data.bytesize if need == 0
 
-          data = data[need..-1]
+          data = data[wrote..-1]
         end
       end
 
@@ -86,35 +87,63 @@ module Puma
       def peeraddr
         @socket.peeraddr
       end
+
+      def peercert
+        return @peercert if @peercert
+
+        raw = @engine.peercert
+        return nil unless raw
+
+        @peercert = OpenSSL::X509::Certificate.new raw
+      end
+    end
+
+    if defined?(JRUBY_VERSION)
+      class SSLError < StandardError
+        # Define this for jruby even though it isn't used.
+      end
+
+      def self.check; end
     end
 
     class Context
       attr_accessor :verify_mode
 
-      attr_reader :key
-      attr_reader :cert
+      if defined?(JRUBY_VERSION)
+        # jruby-specific Context properties: java uses a keystore and password pair rather than a cert/key pair
+        attr_reader :keystore
+        attr_accessor :keystore_pass
 
-      def key=(key)
-        raise ArgumentError, "No such key file '#{key}'" unless File.exist? key
-        @key = key
-      end
+        def keystore=(keystore)
+          raise ArgumentError, "No such keystore file '#{keystore}'" unless File.exist? keystore
+          @keystore = keystore
+        end
+      else
+        # non-jruby Context properties
+        attr_reader :key
+        attr_reader :cert
+        attr_reader :ca
+
+        def key=(key)
+          raise ArgumentError, "No such key file '#{key}'" unless File.exist? key
+          @key = key
+        end
 
-      def cert=(cert)
-        raise ArgumentError, "No such cert file '#{cert}'" unless File.exist? cert
-        @cert = cert
+        def cert=(cert)
+          raise ArgumentError, "No such cert file '#{cert}'" unless File.exist? cert
+          @cert = cert
+        end
+
+        def ca=(ca)
+          raise ArgumentError, "No such ca file '#{ca}'" unless File.exist? ca
+          @ca = ca
+        end
       end
     end
 
     VERIFY_NONE = 0
     VERIFY_PEER = 1
-
-    #if defined?(JRUBY_VERSION)
-    #class Engine
-    #def self.server(key, cert)
-    #new(key, cert)
-    #end
-    #end
-    #end
+    VERIFY_FAIL_IF_NO_PEER_CERT = 2
 
     class Server
       def initialize(socket, ctx)
@@ -128,14 +157,14 @@ module Puma
 
       def accept
         io = @socket.accept
-        engine = Engine.server @ctx.key, @ctx.cert
+        engine = Engine.server @ctx
 
         Socket.new io, engine
       end
 
       def accept_nonblock
         io = @socket.accept_nonblock
-        engine = Engine.server @ctx.key, @ctx.cert
+        engine = Engine.server @ctx
 
         Socket.new io, engine
       end

data/lib/puma/null_io.rb

@@ -30,5 +30,20 @@ module Puma
     #
     def close
     end
+
+    # Always zero
+    #
+    def size
+      0
+    end
+
+    def sync=(v)
+    end
+
+    def puts(*ary)
+    end
+
+    def write(*ary)
+    end
   end
 end

data/lib/puma/plugin.rb

@@ -0,0 +1,104 @@
+module Puma
+  class UnknownPlugin < RuntimeError; end
+
+  class PluginLoader
+    def initialize
+      @instances = []
+    end
+
+    def create(name)
+      if cls = Plugins.find(name)
+        plugin = cls.new(Plugin)
+        @instances << plugin
+        return plugin
+      end
+
+      raise UnknownPlugin, "File failed to register properly named plugin"
+    end
+
+    def fire_starts(launcher)
+      @instances.each do |i|
+        if i.respond_to? :start
+          i.start(launcher)
+        end
+      end
+    end
+  end
+
+  class PluginRegistry
+    def initialize
+      @plugins = {}
+    end
+
+    def register(name, cls)
+      @plugins[name] = cls
+    end
+
+    def find(name)
+      name = name.to_s
+
+      if cls = @plugins[name]
+        return cls
+      end
+
+      begin
+        require "puma/plugin/#{name}"
+      rescue LoadError
+        raise UnknownPlugin, "Unable to find plugin: #{name}"
+      end
+
+      if cls = @plugins[name]
+        return cls
+      end
+
+      raise UnknownPlugin, "file failed to register a plugin"
+    end
+  end
+
+  Plugins = PluginRegistry.new
+
+  class Plugin
+    # Matches
+    #  "C:/Ruby22/lib/ruby/gems/2.2.0/gems/puma-3.0.1/lib/puma/plugin/tmp_restart.rb:3:in `<top (required)>'"
+    #  AS
+    #  C:/Ruby22/lib/ruby/gems/2.2.0/gems/puma-3.0.1/lib/puma/plugin/tmp_restart.rb
+    CALLER_FILE = /
+      \A       # start of string
+      .+       # file path (one or more characters)
+      (?=      # stop previous match when
+        :\d+     # a colon is followed by one or more digits
+        :in      # followed by a colon followed by in
+      )
+    /x
+
+    def self.extract_name(ary)
+      path = ary.first[CALLER_FILE]
+
+      m = %r!puma/plugin/([^/]*)\.rb$!.match(path)
+      return m[1]
+    end
+
+    def self.create(&blk)
+      name = extract_name(caller)
+
+      cls = Class.new(self)
+
+      cls.class_eval(&blk)
+
+      Plugins.register name, cls
+    end
+
+    def initialize(loader)
+      @loader = loader
+    end
+
+    def in_background(&blk)
+      Thread.new(&blk)
+    end
+
+    def workers_supported?
+      return false if Puma.jruby? || Puma.windows?
+      true
+    end
+  end
+end

data/lib/puma/plugin/tmp_restart.rb

@@ -0,0 +1,35 @@
+require 'puma/plugin'
+
+Puma::Plugin.create do
+  def start(launcher)
+    path = File.join("tmp", "restart.txt")
+
+    orig = nil
+
+    # If we can't write to the path, then just don't bother with this plugin
+    begin
+      File.write path, ""
+      orig = File.stat(path).mtime
+    rescue SystemCallError
+      return
+    end
+
+    in_background do
+      while true
+        sleep 2
+
+        begin
+          mtime = File.stat(path).mtime
+        rescue SystemCallError
+          # If the file has disappeared, assume that means don't restart
+        else
+          if mtime > orig
+            launcher.restart
+            break
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/puma/rack/backports/uri/common_18.rb

@@ -0,0 +1,56 @@
+# :stopdoc:
+
+# Stolen from ruby core's uri/common.rb, with modifications to support 1.8.x
+#
+# https://github.com/ruby/ruby/blob/trunk/lib/uri/common.rb
+#
+#
+
+module URI
+  TBLENCWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+  end
+  TBLENCWWWCOMP_[' '] = '+'
+  TBLENCWWWCOMP_.freeze
+  TBLDECWWWCOMP_ = {} # :nodoc:
+  256.times do |i|
+    h, l = i>>4, i&15
+    TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+  end
+  TBLDECWWWCOMP_['+'] = ' '
+  TBLDECWWWCOMP_.freeze
+
+  # Encode given +s+ to URL-encoded form data.
+  #
+  # This method doesn't convert *, -, ., 0-9, A-Z, _, a-z, but does convert SP
+  # (ASCII space) to + and converts others to %XX.
+  #
+  # This is an implementation of
+  # http://www.w3.org/TR/html5/forms.html#url-encoded-form-data
+  #
+  # See URI.decode_www_form_component, URI.encode_www_form
+  def self.encode_www_form_component(s)
+    str = s.to_s
+    if RUBY_VERSION < "1.9" && $KCODE =~ /u/i
+      str.gsub(/([^ a-zA-Z0-9_.-]+)/) do
+        '%' + $1.unpack('H2' * Rack::Utils.bytesize($1)).join('%').upcase
+      end.tr(' ', '+')
+    else
+      str.gsub(/[^*\-.0-9A-Z_a-z]/) {|m| TBLENCWWWCOMP_[m]}
+    end
+  end
+
+  # Decode given +str+ of URL-encoded form data.
+  #
+  # This decodes + to SP.
+  #
+  # See URI.encode_www_form_component, URI.decode_www_form
+  def self.decode_www_form_component(str, enc=nil)
+    raise ArgumentError, "invalid %-encoding (#{str})" unless /\A(?:%[0-9a-fA-F]{2}|[^%])*\z/ =~ str
+    str.gsub(/\+|%[0-9a-fA-F]{2}/) {|m| TBLDECWWWCOMP_[m]}
+  end
+end

data/lib/puma/rack/backports/uri/common_192.rb

@@ -0,0 +1,52 @@
+# :stopdoc:
+
+# Stolen from ruby core's uri/common.rb @32618ba to fix DoS issues in 1.9.2
+#
+# https://github.com/ruby/ruby/blob/32618ba7438a2247042bba9b5d85b5d49070f5e5/lib/uri/common.rb
+#
+# Issue:
+# http://redmine.ruby-lang.org/issues/5149
+#
+# Relevant Fixes:
+# https://github.com/ruby/ruby/commit/b5f91deee04aa6ccbe07c23c8222b937c22a799b
+# https://github.com/ruby/ruby/commit/93177c1e5c3906abf14472ae0b905d8b5c72ce1b
+#
+# This should probably be removed once there is a Ruby 1.9.2 patch level that
+# includes this fix.
+
+require 'uri/common'
+
+module URI
+  TBLDECWWWCOMP_ = {} unless const_defined?(:TBLDECWWWCOMP_)  #:nodoc:
+  if TBLDECWWWCOMP_.empty?
+    256.times do |i|
+      h, l = i>>4, i&15
+      TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+      TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+      TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+      TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+    end
+    TBLDECWWWCOMP_['+'] = ' '
+    TBLDECWWWCOMP_.freeze
+  end
+
+  def self.decode_www_form(str, enc=Encoding::UTF_8)
+    return [] if str.empty?
+    unless /\A#{WFKV_}=#{WFKV_}(?:[;&]#{WFKV_}=#{WFKV_})*\z/o =~ str
+      raise ArgumentError, "invalid data of application/x-www-form-urlencoded (#{str})"
+    end
+    ary = []
+    $&.scan(/([^=;&]+)=([^;&]*)/) do
+      ary << [decode_www_form_component($1, enc), decode_www_form_component($2, enc)]
+    end
+    ary
+  end
+
+  def self.decode_www_form_component(str, enc=Encoding::UTF_8)
+    raise ArgumentError, "invalid %-encoding (#{str})" unless /\A[^%]*(?:%\h\h[^%]*)*\z/ =~ str
+    str.gsub(/\+|%\h\h/, TBLDECWWWCOMP_).force_encoding(enc)
+  end
+
+  remove_const :WFKV_ if const_defined?(:WFKV_)
+  WFKV_ = '(?:[^%#=;&]*(?:%\h\h[^%#=;&]*)*)' # :nodoc:
+end

data/lib/puma/rack/backports/uri/common_193.rb

@@ -0,0 +1,29 @@
+# :stopdoc:
+
+require 'uri/common'
+
+# Issue:
+# http://bugs.ruby-lang.org/issues/5925
+#
+# Relevant commit:
+# https://github.com/ruby/ruby/commit/edb7cdf1eabaff78dfa5ffedfbc2e91b29fa9ca1
+
+module URI
+  256.times do |i|
+    TBLENCWWWCOMP_[i.chr] = '%%%02X' % i
+  end
+  TBLENCWWWCOMP_[' '] = '+'
+  TBLENCWWWCOMP_.freeze
+
+  256.times do |i|
+    h, l = i>>4, i&15
+    TBLDECWWWCOMP_['%%%X%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%X' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%X%x' % [h, l]] = i.chr
+    TBLDECWWWCOMP_['%%%x%x' % [h, l]] = i.chr
+  end
+  TBLDECWWWCOMP_['+'] = ' '
+  TBLDECWWWCOMP_.freeze
+end
+
+# :startdoc:

data/lib/puma/rack/builder.rb

@@ -0,0 +1,295 @@
+module Puma::Rack
+  class Options
+    def parse!(args)
+      options = {}
+      opt_parser = OptionParser.new("", 24, '  ') do |opts|
+        opts.banner = "Usage: rackup [ruby options] [rack options] [rackup config]"
+
+        opts.separator ""
+        opts.separator "Ruby options:"
+
+        lineno = 1
+        opts.on("-e", "--eval LINE", "evaluate a LINE of code") { |line|
+          eval line, TOPLEVEL_BINDING, "-e", lineno
+          lineno += 1
+        }
+
+        opts.on("-b", "--builder BUILDER_LINE", "evaluate a BUILDER_LINE of code as a builder script") { |line|
+          options[:builder] = line
+        }
+
+        opts.on("-d", "--debug", "set debugging flags (set $DEBUG to true)") {
+          options[:debug] = true
+        }
+        opts.on("-w", "--warn", "turn warnings on for your script") {
+          options[:warn] = true
+        }
+        opts.on("-q", "--quiet", "turn off logging") {
+          options[:quiet] = true
+        }
+
+        opts.on("-I", "--include PATH",
+                "specify $LOAD_PATH (may be used more than once)") { |path|
+          (options[:include] ||= []).concat(path.split(":"))
+        }
+
+        opts.on("-r", "--require LIBRARY",
+                "require the library, before executing your script") { |library|
+          options[:require] = library
+        }
+
+        opts.separator ""
+        opts.separator "Rack options:"
+        opts.on("-s", "--server SERVER", "serve using SERVER (thin/puma/webrick/mongrel)") { |s|
+          options[:server] = s
+        }
+
+        opts.on("-o", "--host HOST", "listen on HOST (default: localhost)") { |host|
+          options[:Host] = host
+        }
+
+        opts.on("-p", "--port PORT", "use PORT (default: 9292)") { |port|
+          options[:Port] = port
+        }
+
+        opts.on("-O", "--option NAME[=VALUE]", "pass VALUE to the server as option NAME. If no VALUE, sets it to true. Run '#{$0} -s SERVER -h' to get a list of options for SERVER") { |name|
+          name, value = name.split('=', 2)
+          value = true if value.nil?
+          options[name.to_sym] = value
+        }
+
+        opts.on("-E", "--env ENVIRONMENT", "use ENVIRONMENT for defaults (default: development)") { |e|
+          options[:environment] = e
+        }
+
+        opts.on("-D", "--daemonize", "run daemonized in the background") { |d|
+          options[:daemonize] = d ? true : false
+        }
+
+        opts.on("-P", "--pid FILE", "file to store PID") { |f|
+          options[:pid] = ::File.expand_path(f)
+        }
+
+        opts.separator ""
+        opts.separator "Common options:"
+
+        opts.on_tail("-h", "-?", "--help", "Show this message") do
+          puts opts
+          puts handler_opts(options)
+
+          exit
+        end
+
+        opts.on_tail("--version", "Show version") do
+          puts "Rack #{Rack.version} (Release: #{Rack.release})"
+          exit
+        end
+      end
+
+      begin
+        opt_parser.parse! args
+      rescue OptionParser::InvalidOption => e
+        warn e.message
+        abort opt_parser.to_s
+      end
+
+      options[:config] = args.last if args.last
+      options
+    end
+
+    def handler_opts(options)
+      begin
+        info = []
+        server = Rack::Handler.get(options[:server]) || Rack::Handler.default(options)
+        if server && server.respond_to?(:valid_options)
+          info << ""
+          info << "Server-specific options for #{server.name}:"
+
+          has_options = false
+          server.valid_options.each do |name, description|
+            next if name.to_s.match(/^(Host|Port)[^a-zA-Z]/) # ignore handler's host and port options, we do our own.
+            info << "  -O %-21s %s" % [name, description]
+            has_options = true
+          end
+          return "" if !has_options
+        end
+        info.join("\n")
+      rescue NameError
+        return "Warning: Could not find handler specified (#{options[:server] || 'default'}) to determine handler-specific options"
+      end
+    end
+  end
+
+  # Rack::Builder implements a small DSL to iteratively construct Rack
+  # applications.
+  #
+  # Example:
+  #
+  #  require 'rack/lobster'
+  #  app = Rack::Builder.new do
+  #    use Rack::CommonLogger
+  #    use Rack::ShowExceptions
+  #    map "/lobster" do
+  #      use Rack::Lint
+  #      run Rack::Lobster.new
+  #    end
+  #  end
+  #
+  #  run app
+  #
+  # Or
+  #
+  #  app = Rack::Builder.app do
+  #    use Rack::CommonLogger
+  #    run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ['OK']] }
+  #  end
+  #
+  #  run app
+  #
+  # +use+ adds middleware to the stack, +run+ dispatches to an application.
+  # You can use +map+ to construct a Rack::URLMap in a convenient way.
+
+  class Builder
+    def self.parse_file(config, opts = Options.new)
+      options = {}
+      if config =~ /\.ru$/
+        cfgfile = ::File.read(config)
+        if cfgfile[/^#\\(.*)/] && opts
+          options = opts.parse! $1.split(/\s+/)
+        end
+        cfgfile.sub!(/^__END__\n.*\Z/m, '')
+        app = new_from_string cfgfile, config
+      else
+        require config
+        app = Object.const_get(::File.basename(config, '.rb').capitalize)
+      end
+      return app, options
+    end
+
+    def self.new_from_string(builder_script, file="(rackup)")
+      eval "Puma::Rack::Builder.new {\n" + builder_script + "\n}.to_app",
+        TOPLEVEL_BINDING, file, 0
+    end
+
+    def initialize(default_app = nil,&block)
+      @use, @map, @run, @warmup = [], nil, default_app, nil
+
+      # Conditionally load rack now, so that any rack middlewares,
+      # etc are available.
+      begin
+        require 'rack'
+      rescue LoadError
+      end
+
+      instance_eval(&block) if block_given?
+    end
+
+    def self.app(default_app = nil, &block)
+      self.new(default_app, &block).to_app
+    end
+
+    # Specifies middleware to use in a stack.
+    #
+    #   class Middleware
+    #     def initialize(app)
+    #       @app = app
+    #     end
+    #
+    #     def call(env)
+    #       env["rack.some_header"] = "setting an example"
+    #       @app.call(env)
+    #     end
+    #   end
+    #
+    #   use Middleware
+    #   run lambda { |env| [200, { "Content-Type" => "text/plain" }, ["OK"]] }
+    #
+    # All requests through to this application will first be processed by the middleware class.
+    # The +call+ method in this example sets an additional environment key which then can be
+    # referenced in the application if required.
+    def use(middleware, *args, &block)
+      if @map
+        mapping, @map = @map, nil
+        @use << proc { |app| generate_map app, mapping }
+      end
+      @use << proc { |app| middleware.new(app, *args, &block) }
+    end
+
+    # Takes an argument that is an object that responds to #call and returns a Rack response.
+    # The simplest form of this is a lambda object:
+    #
+    #   run lambda { |env| [200, { "Content-Type" => "text/plain" }, ["OK"]] }
+    #
+    # However this could also be a class:
+    #
+    #   class Heartbeat
+    #     def self.call(env)
+    #      [200, { "Content-Type" => "text/plain" }, ["OK"]]
+    #    end
+    #   end
+    #
+    #   run Heartbeat
+    def run(app)
+      @run = app
+    end
+
+    # Takes a lambda or block that is used to warm-up the application.
+    #
+    #   warmup do |app|
+    #     client = Rack::MockRequest.new(app)
+    #     client.get('/')
+    #   end
+    #
+    #   use SomeMiddleware
+    #   run MyApp
+    def warmup(prc=nil, &block)
+      @warmup = prc || block
+    end
+
+    # Creates a route within the application.
+    #
+    #   Rack::Builder.app do
+    #     map '/' do
+    #       run Heartbeat
+    #     end
+    #   end
+    #
+    # The +use+ method can also be used here to specify middleware to run under a specific path:
+    #
+    #   Rack::Builder.app do
+    #     map '/' do
+    #       use Middleware
+    #       run Heartbeat
+    #     end
+    #   end
+    #
+    # This example includes a piece of middleware which will run before requests hit +Heartbeat+.
+    #
+    def map(path, &block)
+      @map ||= {}
+      @map[path] = block
+    end
+
+    def to_app
+      app = @map ? generate_map(@run, @map) : @run
+      fail "missing run or map statement" unless app
+      app = @use.reverse.inject(app) { |a,e| e[a] }
+      @warmup.call(app) if @warmup
+      app
+    end
+
+    def call(env)
+      to_app.call(env)
+    end
+
+    private
+
+    def generate_map(default_app, mapping)
+      require 'puma/rack/urlmap'
+
+      mapped = default_app ? {'/' => default_app} : {}
+      mapping.each { |r,b| mapped[r] = self.class.new(default_app, &b).to_app }
+      URLMap.new(mapped)
+    end
+  end
+end