plum 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa11d64c7ed018b7ede5e9275adcd9abdb091003
-  data.tar.gz: 5fb20e87686039b5dec5f9b053719935b9788c06
+  metadata.gz: 4fae3d5fc60fdcda63be201fe0349e497ed0c4a2
+  data.tar.gz: e9a1ac852f57acfef9d1eb9585c5b5cca427ce3c
 SHA512:
-  metadata.gz: 1b0095b8f3510be4442524baadcb27a385530753ff0e63ea4eb80bd2ff1755757bbe913ac7977ded238dcb5cc46ad6e6830d720254640a59b4b5fd2e20f8ff1a
-  data.tar.gz: 87e4540bed0f1ec556b177fe16e208527acd43abcea2ef2edbd40fac3070348c7b74891b5d9acf5fe56dbca372940c5c4f771fc60ee05fd29dc26a1106f3ee89
+  metadata.gz: 0f66ed1a0dda7c39d14b0126d871b0c9978069c2b1a27bcb541d9dc9e0e5c0654d86439ff5c27a650d877f827a3a924ee20028f38245d5a9ceb09f3f69a1998c
+  data.tar.gz: 95a3eb71873bb321e4ee683820b4057205a2fde167d38b1e09f605f0dd70e606f0ba6f67e1b3fd6d9a6a08e12c77167d1aee32cd7bec034278892f33651c682f

data/.travis.yml

@@ -7,8 +7,8 @@ install:
   - echo openssl_version=1.0.2d >> $rvm_path/user/db
   - rvm pkg install openssl
   - $rvm_path/usr/bin/openssl version
-  - rvm install 2.2.2-alpn --patch https://gist.githubusercontent.com/rhenium/b1711edcc903e8887a51/raw/2309e469f5a3ba15917d804ac61b19e62b3d8faf/ruby-openssl-alpn-no-tests-and-docs.patch --with-openssl-dir=$rvm_path/usr
-  - rvm use 2.2.2-alpn
+  - rvm install 2.2.3-alpn --patch https://gist.githubusercontent.com/rhenium/b1711edcc903e8887a51/raw/2309e469f5a3ba15917d804ac61b19e62b3d8faf/ruby-openssl-alpn-no-tests-and-docs.patch --with-openssl-dir=$rvm_path/usr
+  - rvm use 2.2.3-alpn
   - bundle install
 script:
   - bundle exec rake test

data/README.md

@@ -1,10 +1,16 @@
 # Plum [![Build Status](https://travis-ci.org/rhenium/plum.png?branch=master)](https://travis-ci.org/rhenium/plum) [![Code Climate](https://codeclimate.com/github/rhenium/plum/badges/gpa.svg)](https://codeclimate.com/github/rhenium/plum) [![Test Coverage](https://codeclimate.com/github/rhenium/plum/badges/coverage.svg)](https://codeclimate.com/github/rhenium/plum/coverage)
 A minimal implementation of HTTP/2 server.
 
+## Examples
+* examples/ - Minimal usage.
+* [rhenium/plum-server](https://github.com/rhenium/plum-server) - A example server for https://rhe.jp and http://rhe.jp.
+
 ## Requirements
-* OpenSSL 1.0.2+
-* Ruby 2.2 with [ALPN support](https://gist.github.com/rhenium/b1711edcc903e8887a51) and [ECDH support (r51348)](https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/51348/diff?format=diff) or latest Ruby 2.3.0-dev.
-* [http-parser.rb gem](https://rubygems.org/gems/http_parser.rb) if you use "http" URI scheme.
+* Ruby
+  * Ruby 2.2 with [ALPN support patch](https://gist.github.com/rhenium/b1711edcc903e8887a51) and [ECDH support patch (r51348)](https://bugs.ruby-lang.org/projects/ruby-trunk/repository/revisions/51348/diff?format=diff)
+  * or latest Ruby 2.3.0-dev
+* OpenSSL 1.0.2 or newer (HTTP/2 requires ALPN)
+* [http-parser.rb gem](https://rubygems.org/gems/http_parser.rb) (HTTP/1.1 parser; if you use "http" URI scheme)
 
 ## TODO
 * **Better API**

data/lib/plum/connection.rb

@@ -74,7 +74,7 @@ module Plum
     #
     # @param args [Hash] The argument to pass to Stram.new.
     def reserve_stream(**args)
-      next_id = ((@streams.keys.last / 2).to_i + 1) * 2
+      next_id = (@streams.keys.select(&:even?).max || 0) + 2
       stream = new_stream(next_id, state: :reserved_local, **args)
       stream
     end
@@ -98,10 +98,6 @@ module Plum
     end
 
     def new_stream(stream_id, **args)
-      if @streams.size > 0 && @streams.keys.max >= stream_id
-        raise Plum::ConnectionError.new(:protocol_error)
-      end
-
       stream = Stream.new(self, stream_id, **args)
       callback(:stream, stream)
       @streams[stream_id] = stream
@@ -142,7 +138,10 @@ module Plum
         if @streams.key?(frame.stream_id)
           stream = @streams[frame.stream_id]
         else
-          raise ConnectionError.new(:protocol_error) if frame.stream_id.even? # stream started by client must have odd ID
+          if frame.stream_id.even? || (@streams.size > 0 && @streams.keys.select(&:odd?).max >= frame.stream_id)
+            raise Plum::ConnectionError.new(:protocol_error)
+          end
+
           stream = new_stream(frame.stream_id)
         end
         stream.receive_frame(frame)
@@ -162,6 +161,7 @@ module Plum
       when :ping
         receive_ping(frame)
       when :goaway
+        callback(:goaway, frame)
         goaway
         close
       when :data, :headers, :priority, :rst_stream, :push_promise, :continuation

data/lib/plum/connection_utils.rb

@@ -26,6 +26,11 @@ module Plum
       send_immediately Frame.goaway(last_id, error_type)
     end
 
+    # Returns whether peer enables server push or not
+    def push_enabled?
+      @remote_settings[:enable_push] == 1
+    end
+
     private
     def update_local_settings(new_settings)
       old_settings = @local_settings.dup

data/lib/plum/errors.rb

@@ -1,6 +1,5 @@
 module Plum
   class Error < StandardError; end
-  class LegacyHTTPError < Error; end
   class HPACKError < Error; end
   class HTTPError < Error
     ERROR_CODES = {
@@ -33,4 +32,14 @@ module Plum
   end
   class ConnectionError < HTTPError; end
   class StreamError < HTTPError; end
+
+  class LegacyHTTPError < Error
+    attr_reader :headers, :data, :parser
+
+    def initialize(headers, data, parser)
+      @headers = headers
+      @data = data
+      @parser = parser
+    end
+  end
 end

data/lib/plum/flow_control.rb

@@ -90,6 +90,8 @@ module Plum
         raise local_error.new(:protocol_error)
       end
 
+      callback(:window_update, wsi)
+
       @send_remaining_window += wsi
       consume_send_buffer
     end

data/lib/plum/http_connection.rb

@@ -35,7 +35,7 @@ module Plum
             settings != nil)
           switch_protocol(settings)
         else
-          raise LegacyHTTPError.new
+          raise LegacyHTTPError.new(@_headers, @_body, parser)
         end
       }
 

data/lib/plum/stream.rb

@@ -211,6 +211,7 @@ module Plum
         raise ConnectionError.new(:protocol_error)
       end
 
+      callback(:rst_stream, frame)
       @state = :closed # MUST NOT send RST_STREAM
     end
   end

data/lib/plum/stream_utils.rb

@@ -2,9 +2,9 @@ using Plum::BinaryString
 
 module Plum
   module StreamUtils
-    # Responds to HTTP request.
+    # Responds to a HTTP request.
     #
-    # @param headers [Hash<String, String>] The response headers.
+    # @param headers [Enumerable<String, String>] The response headers.
     # @param body [String, IO] The response body.
     def respond(headers, body = nil, end_stream: true) # TODO: priority, padding
       if body
@@ -17,7 +17,7 @@ module Plum
 
     # Reserves a stream to server push. Sends PUSH_PROMISE and create new stream.
     #
-    # @param headers [Hash<String, String>] The *request* headers. It must contain all of them: ':authority', ':method', ':scheme' and ':path'.
+    # @param headers [Enumerable<String, String>] The *request* headers. It must contain all of them: ':authority', ':method', ':scheme' and ':path'.
     # @return [Stream] The stream to send push response.
     def promise(headers)
       stream = @connection.reserve_stream(weight: self.weight + 1, parent: self)
@@ -29,7 +29,10 @@ module Plum
       stream
     end
 
-    private
+    # Sends response headers. If the encoded frame is larger than MAX_FRAME_SIZE, the headers will be splitted into HEADERS frame and CONTINUATION frame(s).
+    #
+    # @param headers [Enumerable<String, String>] The response headers.
+    # @param end_stream [Boolean] Set END_STREAM flag or not.
     def send_headers(headers, end_stream:)
       max = @connection.remote_settings[:max_frame_size]
       encoded = @connection.hpack_encoder.encode(headers)
@@ -40,6 +43,10 @@ module Plum
       @state = :half_closed_local if end_stream
     end
 
+    # Sends DATA frame. If the data is larger than MAX_FRAME_SIZE, DATA frame will be splitted.
+    #
+    # @param data [String, IO] The data to send.
+    # @param end_stream [Boolean] Set END_STREAM flag or not.
     def send_data(data, end_stream: true)
       max = @connection.remote_settings[:max_frame_size]
       if data.is_a?(IO)

data/lib/plum/version.rb

@@ -1,3 +1,3 @@
 module Plum
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/plum/test_https_connection.rb

@@ -47,7 +47,7 @@ class HTTPSConnectionNegotiationTest < Minitest::Test
 
     server_thread = Thread.new {
       begin
-        timeout(3) {
+        Timeout.timeout(3) {
           sock = ssl_server.accept
           plum = HTTPSConnection.new(sock)
           assert_connection_error(:inadequate_security) {
@@ -55,7 +55,7 @@ class HTTPSConnectionNegotiationTest < Minitest::Test
             plum.run
           }
         }
-      rescue TimeoutError
+      rescue Timeout::Error
         flunk "server timeout"
       ensure
         tcp_server.close
@@ -64,7 +64,7 @@ class HTTPSConnectionNegotiationTest < Minitest::Test
     client_thread = Thread.new {
       sock = TCPSocket.new("127.0.0.1", LISTEN_PORT)
       begin
-        timeout(3) {
+        Timeout.timeout(3) {
           ctx = OpenSSL::SSL::SSLContext.new.tap {|ctx|
             ctx.alpn_protocols = ["h2"]
             ctx.ciphers = "AES256-GCM-SHA384"
@@ -74,7 +74,7 @@ class HTTPSConnectionNegotiationTest < Minitest::Test
           ssl.write Connection::CLIENT_CONNECTION_PREFACE
           ssl.write Frame.settings.assemble
         }
-      rescue TimeoutError
+      rescue Timeout::Error
         flunk "client timeout"
       ensure
         sock.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plum
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - rhenium
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,7 +151,6 @@ files:
 - README.md
 - Rakefile
 - bin/.gitkeep
-- examples/local_server.rb
 - examples/non_tls_server.rb
 - examples/static_server.rb
 - lib/plum.rb
@@ -220,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A minimal implementation of HTTP/2 server.

data/examples/local_server.rb

@@ -1,207 +0,0 @@
-DEBUG = ENV["DEBUG"] || false
-HOST = ENV["HOST"]
-PORT = ENV["PORT"]
-DOCUMENT_ROOT = ENV["DOCUMENT_ROOT"] || "/srv/http"
-TLS_CERT = ENV["TLS_CERT"]
-TLS_KEY = ENV["TLS_KEY"]
-
-CONTENT_TYPES = {
-  /\.html$/ => "text/html",
-  /\.png$/ => "image/png",
-  /\.jpg$/ => "image/jpeg",
-  /\.css$/ => "text/css",
-  /\.js$/ => "application/javascript",
-  /\.atom$/ => "application/atom+xml",
-}
-
-$LOAD_PATH << File.expand_path("../../lib", __FILE__)
-require "plum"
-require "openssl"
-require "socket"
-begin
-  require "oga"
-  HAVE_OGA = true
-rescue LoadError
-  puts "Oga is needed for parsing HTML"
-  HAVE_OGA = false
-end
-
-begin
-  require "sslkeylog/autotrace" # for debug
-rescue LoadError
-end
-
-def log(con, stream, s)
-  prefix = "[%02x;%02x] " % [con, stream]
-  if s.is_a?(Enumerable)
-    puts s.map {|a| prefix + a.to_s }.join("\n")
-  else
-    puts prefix + s.to_s
-  end
-end
-
-def content_type(filename)
-  exp, ct = CONTENT_TYPES.lazy.select {|pat, e| pat =~ filename }.first
-  ct || "texp/plain"
-end
-
-def assets(file)
-  if /\.html$/ =~ File.basename(file)
-    doc = Oga.parse_html(File.read(file))
-    assets = []
-    doc.xpath("img").each {|img| assets << img.get("src") }
-    doc.xpath("//html/head/link[@rel='stylesheet']").each {|css| assets << css.get("href") }
-    doc.xpath("script").each {|js| assets << js.get("src") }
-    assets.compact.uniq.map {|path|
-      if path.include?("//")
-        next nil
-      end
-
-      if path.start_with?("/")
-        pa = File.expand_path(DOCUMENT_ROOT + path)
-      else
-        pa = File.expand_path(path, file)
-      end
-      
-      if pa.start_with?(DOCUMENT_ROOT) & File.exist?(pa)
-        pa
-      else
-        nil
-      end
-    }.compact
-  else
-    []
-  end
-end
-
-ctx = OpenSSL::SSL::SSLContext.new
-ctx.ssl_version = :TLSv1_2
-ctx.alpn_select_cb = -> protocols {
-  raise "Client does not support HTTP/2: #{protocols}" unless protocols.include?("h2")
-  "h2"
-}
-ctx.tmp_ecdh_callback = -> (sock, ise, keyl) {
-  OpenSSL::PKey::EC.new("prime256v1")
-}
-
-ctx.cert = OpenSSL::X509::Certificate.new File.read(TLS_CERT)
-ctx.key = OpenSSL::PKey::RSA.new File.read(TLS_KEY)
-tcp_server = TCPServer.new(HOST, PORT)
-ssl_server = OpenSSL::SSL::SSLServer.new(tcp_server, ctx)
-
-loop do
-  begin
-    sock = ssl_server.accept
-    id = sock.io.fileno
-    puts "#{id}: accept!"
-  rescue => e
-    puts e
-    next
-  end
-
-  plum = Plum::HTTPSConnection.new(sock)
-
-  plum.on(:frame) do |frame|
-    log(id, frame.stream_id, "recv: #{frame.inspect}")
-  end if DEBUG
-
-  plum.on(:send_frame) do |frame|
-    log(id, frame.stream_id, "send: #{frame.inspect}")
-  end if DEBUG
-
-  plum.on(:remote_settings) do |settings|
-    log(id, 0, settings.map {|name, value| "#{name}: #{value}" }) if DEBUG
-  end
-
-  plum.on(:connection_error) do |exception|
-    puts exception
-    puts exception.backtrace
-  end if DEBUG
-
-  plum.on(:stream) do |stream|
-    log(id, stream.id, "stream open")
-    stream.on(:stream_error) do |exception|
-      puts exception
-      puts exception.backtrace
-    end if DEBUG
-
-    headers = data = nil
-
-    stream.on(:open) do
-      headers = nil
-      data = ""
-    end
-
-    stream.on(:headers) do |headers_|
-      log(id, stream.id, headers_.map {|name, value| "#{name}: #{value}" }) if DEBUG
-      headers = headers_.to_h
-    end
-
-    stream.on(:data) do |data_|
-      log(id, stream.id, data_) if DEBUG
-      data << data_
-    end
-
-    stream.on(:end_stream) do
-      if headers[":method"] == "GET"
-        file = File.expand_path(DOCUMENT_ROOT + headers[":path"])
-        file << "/index.html" if Dir.exist?(file)
-        if file.start_with?(DOCUMENT_ROOT) && File.exist?(file)
-          io = File.open(file)
-          size = File.stat(file).size
-          i_sts = assets(file).map {|asset|
-            i_st = stream.promise({
-              ":authority": headers[":authority"],
-              ":method": "GET",
-              ":scheme": "https",
-              ":path": asset[DOCUMENT_ROOT.size..-1]
-            })
-            [i_st, asset]
-          }
-          stream.respond({
-            ":status": "200",
-            "server": "plum/#{Plum::VERSION}",
-            "content-type": content_type(file),
-            "content-length": size
-          }, io)
-          i_sts.each do |i_st, asset|
-            aio = File.open(asset)
-            asize = File.stat(asset).size
-            i_st.respond({
-              ":status": "200",
-              "server": "plum/#{Plum::VERSION}",
-              "content-type": content_type(asset),
-              "content-length": asize
-            }, aio)
-          end
-        else
-          body = headers.map {|name, value| "#{name}: #{value}" }.join("\n") + "\n" + data
-          stream.respond({
-            ":status": "404",
-            "server": "plum/#{Plum::VERSION}",
-            "content-type": "text/plain",
-            "content-length": body.bytesize
-          }, body)
-        end
-      else
-        # Not implemented
-        body = headers.map {|name, value| "#{name}: #{value}" }.join("\n") << "\n" << data
-        stream.respond({
-          ":status": "501",
-          "server": "plum/#{Plum::VERSION}",
-          "content-type": "text/plain",
-          "content-length": body.bytesize
-        }, body)
-      end
-    end
-  end
-
-  Thread.new {
-    begin
-      plum.run
-    rescue
-      puts $!
-      puts $!.backtrace
-    end
-  }
-end