plum 0.0.3 → 0.1.0

data/lib/plum/stream.rb

@@ -9,25 +9,21 @@ module Plum
     attr_reader :id, :state, :connection
     attr_reader :weight, :exclusive
     attr_accessor :parent
+    # The child (depending on this stream) streams.
+    attr_reader :children
 
     def initialize(con, id, state: :idle, weight: 16, parent: nil, exclusive: false)
       @connection = con
       @id = id
       @state = state
       @continuation = []
+      @children = Set.new
 
       initialize_flow_control(send: @connection.remote_settings[:initial_window_size],
                               recv: @connection.local_settings[:initial_window_size])
       update_dependency(weight: weight, parent: parent, exclusive: exclusive)
     end
 
-    # Returns the child (depending on this stream) streams.
-    #
-    # @return [Array<Stream>] The child streams.
-    def children
-      @connection.streams.values.select {|c| c.parent == self }.freeze
-    end
-
     # Processes received frames for this stream. Internal use.
     # @private
     def receive_frame(frame)
@@ -58,7 +54,6 @@ module Plum
     end
 
     # Closes this stream. Sends RST_STREAM frame to the peer.
-    #
     # @param error_type [Symbol] The error type to be contained in the RST_STREAM frame.
     def close(error_type = :no_error)
       @state = :closed
@@ -67,20 +62,30 @@ module Plum
 
     private
     def send_immediately(frame)
-      callback(:send_frame, frame)
       @connection.send(frame)
     end
 
     def update_dependency(weight: nil, parent: nil, exclusive: nil)
       raise StreamError.new(:protocol_error, "A stream cannot depend on itself.") if parent == self
-      @weight = weight unless weight.nil?
-      @parent = parent unless parent.nil?
-      @exclusive = exclusive unless exclusive.nil?
-
-      if exclusive == true
-        parent.children.each do |child|
-          next if child == self
-          child.parent = self
+
+      if weight
+        @weight = weight
+      end
+
+      if parent
+        @parent = parent
+        @parent.children << self
+      end
+
+      if exclusive != nil
+        @exclusive = exclusive
+        if @parent && exclusive
+          @parent.children.to_a.each do |child|
+            next if child == self
+            @parent.children.delete(child)
+            child.parent = self
+            @children << child
+          end
         end
       end
     end
@@ -105,7 +110,7 @@ module Plum
         raise StreamError.new(:stream_closed)
       end
 
-      if frame.flags.include?(:padded)
+      if frame.padded?
         padding_length = frame.payload.uint8(0)
         if padding_length >= frame.length
           raise ConnectionError.new(:protocol_error, "padding is too long")
@@ -116,18 +121,17 @@ module Plum
       end
       callback(:data, body)
 
-      receive_end_stream if frame.flags.include?(:end_stream)
+      receive_end_stream if frame.end_stream?
     end
 
     def receive_complete_headers(frames)
-      frames = frames.dup
       first = frames.shift
 
       payload = first.payload
       first_length = first.length
       padding_length = 0
 
-      if first.flags.include?(:padded)
+      if first.padded?
         padding_length = payload.uint8
         first_length -= 1 + padding_length
         payload = payload.byteslice(1, first_length)
@@ -135,7 +139,7 @@ module Plum
         payload = payload.dup
       end
 
-      if first.flags.include?(:priority)
+      if first.priority?
         receive_priority_payload(payload.byteshift(5))
         first_length -= 5
       end
@@ -156,7 +160,7 @@ module Plum
 
       callback(:headers, decoded_headers)
 
-      receive_end_stream if first.flags.include?(:end_stream)
+      receive_end_stream if first.end_stream?
     end
 
     def receive_headers(frame)
@@ -171,7 +175,7 @@ module Plum
       @state = :open
       callback(:open)
 
-      if frame.flags.include?(:end_headers)
+      if frame.end_headers?
         receive_complete_headers([frame])
       else
         @continuation << frame
@@ -182,7 +186,7 @@ module Plum
       # state error mustn't happen: server_connection validates
       @continuation << frame
 
-      if frame.flags.include?(:end_headers)
+      if frame.end_headers?
         receive_complete_headers(@continuation)
         @continuation.clear
       end
@@ -214,5 +218,11 @@ module Plum
       callback(:rst_stream, frame)
       @state = :closed # MUST NOT send RST_STREAM
     end
+
+    # override EventEmitter
+    def callback(name, *args)
+      super(name, *args)
+      @connection.callback(name, self, *args)
+    end
   end
 end

data/lib/plum/stream_utils.rb

@@ -3,7 +3,6 @@ using Plum::BinaryString
 module Plum
   module StreamUtils
     # Responds to a HTTP request.
-    #
     # @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
@@ -16,7 +15,6 @@ module Plum
     end
 
     # Reserves a stream to server push. Sends PUSH_PROMISE and create new stream.
-    #
     # @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)
@@ -30,7 +28,6 @@ module Plum
     end
 
     # 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:)
@@ -44,7 +41,6 @@ module Plum
     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)

data/lib/plum/version.rb

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

data/lib/plum.rb

@@ -1,6 +1,7 @@
 require "openssl"
 require "socket"
 require "base64"
+require "set"
 require "plum/version"
 require "plum/errors"
 require "plum/binary_string"

data/lib/rack/handler/plum.rb

@@ -0,0 +1,49 @@
+module Rack
+  module Handler
+    class Plum
+      def self.run(app, options = {})
+        opts = default_options.merge(options)
+
+        config = ::Plum::Rack::Config.new(
+          listeners: [
+            {
+              listener: ::Plum::Rack::TLSListener,
+              hostname: opts[:Host],
+              port: opts[:Port].to_i
+            }
+          ],
+          debug: !!opts[:Debug]
+        )
+
+        @server = ::Plum::Rack::Server.new(app, config)
+        yield @server if block_given? # TODO
+        @server.start
+      end
+
+      def self.shutdown
+        @server.stop if @server
+      end
+
+      def self.valid_options
+        {
+          "Host=HOST"    => "Hostname to listen on (default: #{default_options[:Host]})",
+          "Port=PORT"    => "Port to listen on (default: #{default_options[:Port]})",
+          "Debug"        => "Turn on debug mode (default: #{default_options[:Debug]})",
+        }
+      end
+
+      private
+      def self.default_options
+        rack_env = ENV["RACK_ENV"] || "development"
+        dev = rack_env == "development"
+        default_options = {
+          Host: dev ? "localhost" : "0.0.0.0",
+          Port: 8080,
+          Debug: dev,
+        }
+      end
+    end
+
+    register(:plum, ::Rack::Handler::Plum)
+  end
+end

data/plum.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "http_parser.rb"
+  spec.add_development_dependency "rack"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "minitest", "~> 5.7.0"

data/test/plum/hpack/test_decoder.rb

@@ -4,38 +4,38 @@ class HPACKDecoderTest < Minitest::Test
   # C.1.1
   def test_hpack_read_integer_small
     buf = [0b11001010, 0b00001111].pack("C*")
-    result = new_decoder.__send__(:read_integer!, buf, 5)
+    result, succ = new_decoder.__send__(:read_integer, buf, 0, 5)
     assert_equal(10, result)
-    assert_equal([0b00001111].pack("C*"), buf)
+    assert_equal(1, succ)
   end
 
   # C.1.2
   def test_hpack_read_integer_big
     buf = [0b11011111, 0b10011010, 0b00001010, 0b00001111].pack("C*")
-    result = new_decoder.__send__(:read_integer!, buf, 5)
+    result, succ = new_decoder.__send__(:read_integer, buf, 0, 5)
     assert_equal(1337, result)
-    assert_equal([0b00001111].pack("C*"), buf)
+    assert_equal(3, succ)
   end
 
   # C.1.3
   def test_hpack_read_integer_8prefix
     buf = [0b00101010, 0b00001111].pack("C*")
-    result = new_decoder.__send__(:read_integer!, buf, 8)
+    result, succ = new_decoder.__send__(:read_integer, buf, 0, 8)
     assert_equal(42, result)
-    assert_equal([0b00001111].pack("C*"), buf)
+    assert_equal(1, succ)
   end
 
   def test_hpack_read_integer_too_big
     buf = [0b11011111, 0b10011010, 0b10001010, 0b10001111, 0b11111111, 0b00000011].pack("C*")
     assert_raises(HPACKError) {
-      new_decoder.__send__(:read_integer!, buf, 5)
+      new_decoder.__send__(:read_integer, buf, 0, 5)
     }
   end
 
   def test_hpack_read_integer_incomplete
     buf = [0b11011111, 0b10011010].pack("C*")
     assert_raises(HPACKError) {
-      new_decoder.__send__(:read_integer!, buf, 5)
+      new_decoder.__send__(:read_integer, buf, 0, 5)
     }
   end
 

data/test/plum/hpack/test_encoder.rb

@@ -3,19 +3,19 @@ require "test_helper"
 class HPACKEncoderTest < Minitest::Test
   # C.1.1
   def test_hpack_encode_integer_small
-    result = new_encoder(1 << 31).__send__(:encode_integer, 10, 5)
+    result = new_encoder(1 << 31).__send__(:encode_integer, 10, 5, 0b00000000)
     assert_equal([0b00001010].pack("C*"), result)
   end
 
   # C.1.2
   def test_hpack_encode_integer_big
-    result = new_encoder(1 << 31).__send__(:encode_integer, 1337, 5)
+    result = new_encoder(1 << 31).__send__(:encode_integer, 1337, 5, 0b000000)
     assert_equal([0b00011111, 0b10011010, 0b00001010].pack("C*"), result)
   end
 
   # C.1.3
   def test_hpack_encode_integer_8prefix
-    result = new_encoder(1 << 31).__send__(:encode_integer, 42, 8)
+    result = new_encoder(1 << 31).__send__(:encode_integer, 42, 8, 0b000000)
     assert_equal([0b00101010].pack("C*"), result)
   end
 

data/test/plum/stream/test_handle_frame.rb

@@ -8,7 +8,7 @@ class StreamHandleFrameTest < Minitest::Test
     payload = "ABC" * 5
     open_new_stream(state: :open) {|stream|
       data = nil
-      stream.on(:data) {|_data| data = _data }
+      stream.connection.on(:data) {|_, _data| data = _data }
       stream.receive_frame(Frame.new(type: :data, stream_id: stream.id,
                                      flags: [], payload: payload))
       assert_equal(payload, data)
@@ -19,7 +19,7 @@ class StreamHandleFrameTest < Minitest::Test
     payload = "ABC" * 5
     open_new_stream(state: :open) {|stream|
       data = nil
-      stream.on(:data) {|_data| data = _data }
+      stream.connection.on(:data) {|_, _data| data = _data }
       stream.receive_frame(Frame.new(type: :data, stream_id: stream.id,
                                      flags: [:padded], payload: "".push_uint8(6).push(payload).push("\x00"*6)))
       assert_equal(payload, data)
@@ -59,7 +59,7 @@ class StreamHandleFrameTest < Minitest::Test
   def test_stream_handle_headers_single
     open_new_stream {|stream|
       headers = nil
-      stream.on(:headers) {|_headers|
+      stream.connection.on(:headers) {|_, _headers|
         headers = _headers
       }
       stream.receive_frame(Frame.new(type: :headers,
@@ -75,7 +75,7 @@ class StreamHandleFrameTest < Minitest::Test
     open_new_stream {|stream|
       payload = HPACK::Encoder.new(0).encode([[":path", "/"]])
       headers = nil
-      stream.on(:headers) {|_headers|
+      stream.connection.on(:headers) {|_, _headers|
         headers = _headers
       }
       stream.receive_frame(Frame.new(type: :headers,
@@ -96,7 +96,7 @@ class StreamHandleFrameTest < Minitest::Test
     open_new_stream {|stream|
       payload = HPACK::Encoder.new(0).encode([[":path", "/"]])
       headers = nil
-      stream.on(:headers) {|_headers|
+      stream.connection.on(:headers) {|_, _headers|
         headers = _headers
       }
       stream.receive_frame(Frame.new(type: :headers,
@@ -156,7 +156,7 @@ class StreamHandleFrameTest < Minitest::Test
       stream = open_new_stream(con)
 
       headers = nil
-      stream.on(:headers) {|_headers| headers = _headers }
+      stream.connection.on(:headers) {|_, _headers| headers = _headers }
       header_block = HPACK::Encoder.new(0).encode([[":path", "/"]])
       payload = "".push_uint32((1 << 31) | parent.id)
                   .push_uint8(50)

data/test/plum/test_frame.rb

@@ -4,6 +4,7 @@ class FrameTest < Minitest::Test
   # Frame.parse!
   def test_parse_header_uncomplete
     buffer = "\x00\x00\x00" << "\x00" << "\x00"
+    buffer.force_encoding(Encoding::BINARY)
     buffer_orig = buffer.dup
     assert_nil(Plum::Frame.parse!(buffer))
     assert_equal(buffer_orig, buffer)
@@ -11,6 +12,7 @@ class FrameTest < Minitest::Test
 
   def test_parse_body_uncomplete
     buffer = "\x00\x00\x03" << "\x00" << "\x00" << "\x00\x00\x00\x00" << "ab"
+    buffer.force_encoding(Encoding::BINARY)
     buffer_orig = buffer.dup
     assert_nil(Plum::Frame.parse!(buffer))
     assert_equal(buffer_orig, buffer)
@@ -18,7 +20,8 @@ class FrameTest < Minitest::Test
 
   def test_parse
     # R 0x1, stream_id 0x4, body "abc"
-    buffer = "\x00\x00\x03" << "\x00" << "\x09" << "\x80\x00\x00\x04" << "abc" << "next_frame_data"
+    buffer = "\x00\x00\x03" << "\x00" << "\x09" << "\x00\x00\x00\x04" << "abc" << "next_frame_data"
+    buffer.force_encoding(Encoding::BINARY)
     frame = Plum::Frame.parse!(buffer)
     assert_equal(3, frame.length)
     assert_equal(:data, frame.type)

data/test/plum/test_http_connection.rb

@@ -27,9 +27,7 @@ class HTTPConnectionNegotiationTest < Minitest::Test
     io = StringIO.new
     con = HTTPConnection.new(io)
     heads = nil
-    con.on(:stream) {|stream|
-      stream.on(:headers) {|_h| heads = _h.to_h }
-    }
+    con.on(:headers) {|_, _h| heads = _h.to_h }
     req = "GET / HTTP/1.1\r\n" <<
           "Host: rhe.jp\r\n" <<
           "User-Agent: nya\r\n" <<

data/test/plum/test_https_connection.rb

@@ -64,24 +64,21 @@ class HTTPSConnectionNegotiationTest < Minitest::Test
     client_thread = Thread.new {
       sock = TCPSocket.new("127.0.0.1", LISTEN_PORT)
       begin
-        Timeout.timeout(3) {
-          ctx = OpenSSL::SSL::SSLContext.new.tap {|ctx|
-            ctx.alpn_protocols = ["h2"]
-            ctx.ciphers = "AES256-GCM-SHA384"
-          }
-          ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)
-          ssl.connect
-          ssl.write Connection::CLIENT_CONNECTION_PREFACE
-          ssl.write Frame.settings.assemble
+        ctx = OpenSSL::SSL::SSLContext.new.tap {|ctx|
+          ctx.alpn_protocols = ["h2"]
+          ctx.ciphers = "AES256-GCM-SHA384"
         }
-      rescue Timeout::Error
-        flunk "client timeout"
+        ssl = OpenSSL::SSL::SSLSocket.new(sock, ctx)
+        ssl.connect
+        ssl.write Connection::CLIENT_CONNECTION_PREFACE
+        ssl.write Frame.settings.assemble
+        sleep
       ensure
         sock.close
       end
     }
-    client_thread.join
     server_thread.join
+    client_thread.kill
 
     flunk "test not run" unless run
   end

data/test/utils/server.rb

@@ -31,7 +31,7 @@ module ServerUtils
   end
 
   def sent_frames(con = nil)
-    resp = (con || @_con).io.string.dup
+    resp = (con || @_con).sock.string.dup.force_encoding(Encoding::BINARY)
     frames = []
     while f = Frame.parse!(resp)
       frames << f
@@ -40,10 +40,10 @@ module ServerUtils
   end
 
   def capture_frames(con = nil, &blk)
-    io = (con || @_con).io
+    io = (con || @_con).sock
     pos = io.string.bytesize
     blk.call
-    resp = io.string.byteslice(pos, io.string.bytesize - pos)
+    resp = io.string.byteslice(pos, io.string.bytesize - pos).force_encoding(Encoding::BINARY)
     frames = []
     while f = Frame.parse!(resp)
       frames << f

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plum
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - rhenium
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2015-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -139,7 +153,8 @@ dependencies:
 description: A minimal implementation of HTTP/2 server.
 email:
 - k@rhe.jp
-executables: []
+executables:
+- plum
 extensions: []
 extra_rdoc_files: []
 files:
@@ -151,7 +166,9 @@ files:
 - README.md
 - Rakefile
 - bin/.gitkeep
+- bin/plum
 - examples/non_tls_server.rb
+- examples/rack.ru
 - examples/static_server.rb
 - lib/plum.rb
 - lib/plum/binary_string.rb
@@ -170,9 +187,17 @@ files:
 - lib/plum/hpack/huffman.rb
 - lib/plum/http_connection.rb
 - lib/plum/https_connection.rb
+- lib/plum/rack.rb
+- lib/plum/rack/cli.rb
+- lib/plum/rack/config.rb
+- lib/plum/rack/connection.rb
+- lib/plum/rack/dsl.rb
+- lib/plum/rack/listener.rb
+- lib/plum/rack/server.rb
 - lib/plum/stream.rb
 - lib/plum/stream_utils.rb
 - lib/plum/version.rb
+- lib/rack/handler/plum.rb
 - plum.gemspec
 - test/plum/connection/test_handle_frame.rb
 - test/plum/hpack/test_context.rb