RubyGems - plum - Versions diffs - 0.0.1 - Mend

plum 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

checksums.yaml +7 -0
data/.gitignore +11 -0
data/.travis.yml +14 -0
data/Gemfile +4 -0
data/Guardfile +7 -0
data/LICENSE +21 -0
data/README.md +14 -0
data/Rakefile +12 -0
data/bin/.gitkeep +0 -0
data/examples/local_server.rb +206 -0
data/examples/static_server.rb +157 -0
data/lib/plum.rb +21 -0
data/lib/plum/binary_string.rb +74 -0
data/lib/plum/connection.rb +201 -0
data/lib/plum/connection_utils.rb +38 -0
data/lib/plum/errors.rb +35 -0
data/lib/plum/event_emitter.rb +19 -0
data/lib/plum/flow_control.rb +97 -0
data/lib/plum/frame.rb +163 -0
data/lib/plum/frame_factory.rb +53 -0
data/lib/plum/frame_utils.rb +50 -0
data/lib/plum/hpack/constants.rb +331 -0
data/lib/plum/hpack/context.rb +55 -0
data/lib/plum/hpack/decoder.rb +145 -0
data/lib/plum/hpack/encoder.rb +105 -0
data/lib/plum/hpack/huffman.rb +42 -0
data/lib/plum/http_connection.rb +33 -0
data/lib/plum/https_connection.rb +24 -0
data/lib/plum/stream.rb +217 -0
data/lib/plum/stream_utils.rb +58 -0
data/lib/plum/version.rb +3 -0
data/plum.gemspec +29 -0
data/test/plum/connection/test_handle_frame.rb +70 -0
data/test/plum/hpack/test_context.rb +63 -0
data/test/plum/hpack/test_decoder.rb +291 -0
data/test/plum/hpack/test_encoder.rb +49 -0
data/test/plum/hpack/test_huffman.rb +36 -0
data/test/plum/stream/test_handle_frame.rb +262 -0
data/test/plum/test_binary_string.rb +64 -0
data/test/plum/test_connection.rb +96 -0
data/test/plum/test_connection_utils.rb +29 -0
data/test/plum/test_error.rb +13 -0
data/test/plum/test_flow_control.rb +167 -0
data/test/plum/test_frame.rb +59 -0
data/test/plum/test_frame_factory.rb +56 -0
data/test/plum/test_frame_utils.rb +46 -0
data/test/plum/test_https_connection.rb +37 -0
data/test/plum/test_stream.rb +32 -0
data/test/plum/test_stream_utils.rb +16 -0
data/test/server.crt +19 -0
data/test/server.csr +16 -0
data/test/server.key +27 -0
data/test/test_helper.rb +28 -0
data/test/utils/assertions.rb +60 -0
data/test/utils/server.rb +63 -0
metadata +234 -0

data/lib/plum/frame.rb ADDED Viewed

@@ -0,0 +1,163 @@
+using Plum::BinaryString
+module Plum
+  class Frame
+    extend FrameFactory
+    include FrameUtils
+    FRAME_TYPES = {
+      data:           0x00,
+      headers:        0x01,
+      priority:       0x02,
+      rst_stream:     0x03,
+      settings:       0x04,
+      push_promise:   0x05,
+      ping:           0x06,
+      goaway:         0x07,
+      window_update:  0x08,
+      continuation:   0x09
+    }
+    FRAME_FLAGS = {
+      data: {
+        end_stream:   0x01,
+        padded:       0x08
+      },
+      headers: {
+        end_stream:   0x01,
+        end_headers:  0x04,
+        padded:       0x08,
+        priority:     0x20
+      },
+      priority: {},
+      rst_stream: {},
+      settings: {
+        ack:          0x01
+      },
+      push_promise: {
+        end_headers:  0x04,
+        padded:       0x08
+      },
+      ping: {
+        ack:          0x01
+      },
+      goaway: {},
+      window_update: {},
+      continuation: {
+        end_headers:  0x04
+      }
+    }
+    SETTINGS_TYPE = {
+      header_table_size:      0x01,
+      enable_push:            0x02,
+      max_concurrent_streams: 0x03,
+      initial_window_size:    0x04,
+      max_frame_size:         0x05,
+      max_header_list_size:   0x06
+    }
+    # RFC7540: 4.1 Frame format
+    # +-----------------------------------------------+
+    # |                 Length (24)                   |
+    # +---------------+---------------+---------------+
+    # |   Type (8)    |   Flags (8)   |
+    # +-+-------------+---------------+-------------------------------+
+    # |R|                 Stream Identifier (31)                      |
+    # +=+=============================================================+
+    # |                   Frame Payload (0...)                      ...
+    # +---------------------------------------------------------------+
+    # [Integer] Frame type. 8-bit
+    attr_accessor :type_value
+    # [Integer] Flags. 8-bit
+    attr_accessor :flags_value
+    # [Integer] Stream Identifier. unsigned 31-bit integer
+    attr_accessor :stream_id
+    # [String] The payload.
+    attr_accessor :payload
+    def initialize(type: nil, type_value: nil, flags: nil, flags_value: nil, stream_id: nil, payload: nil)
+      self.payload = (payload || "")
+      self.type_value = type_value or self.type = type
+      self.flags_value = flags_value or self.flags = flags
+      self.stream_id = stream_id or raise ArgumentError.new("stream_id is necessary")
+    end
+    # Returns the length of payload.
+    # @return [Integer] The length.
+    def length
+      @payload.bytesize
+    end
+    # Returns the type of the frame in Symbol.
+    # @return [Symbol] The type.
+    def type
+      FRAME_TYPES.key(type_value) || ("unknown_%02x" % type_value).to_sym
+    end
+    # Sets the frame type.
+    # @param value [Symbol] The type.
+    def type=(value)
+      self.type_value = FRAME_TYPES[value] or raise ArgumentError.new("unknown frame type: #{value}")
+    end
+    # Returns the set flags on the frame.
+    # @return [Array<Symbol>] The flags.
+    def flags
+      fs = FRAME_FLAGS[type]
+      [0x01, 0x02, 0x04, 0x08, 0x10, 0x20, 0x40, 0x80]
+        .select {|v| flags_value & v > 0 }
+        .map {|val| fs && fs.key(val) || ("unknown_%02x" % val).to_sym }
+    end
+    # Sets the frame flags.
+    # @param value [Array<Symbol>] The flags.
+    def flags=(value)
+      self.flags_value = (value && value.map {|flag| FRAME_FLAGS[self.type][flag] }.inject(:|) || 0)
+    end
+    # Assembles the frame into binary representation.
+    # @return [String] Binary representation of this frame.
+    def assemble
+      bytes = "".force_encoding(Encoding::BINARY)
+      bytes.push_uint24(length)
+      bytes.push_uint8(type_value)
+      bytes.push_uint8(flags_value)
+      bytes.push_uint32(stream_id & ~(1 << 31)) # first bit is reserved (MUST be 0)
+      bytes.push(payload)
+      bytes
+    end
+    # @private
+    def inspect
+      "#<Plum::Frame:0x%04x} length=%d, type=%p, flags=%p, stream_id=0x%04x, payload=%p>" % [__id__, length, type, flags, stream_id, payload]
+    end
+    # Parses a frame from given buffer. It changes given buffer.
+    #
+    # @param buffer [String] The buffer stored the data received from peer.
+    # @return [Frame, nil] The parsed frame or nil if the buffer is imcomplete.
+    def self.parse!(buffer)
+      buffer.force_encoding(Encoding::BINARY)
+      return nil if buffer.size < 9 # header: 9 bytes
+      length = buffer.uint24
+      return nil if buffer.size < 9 + length
+      bhead = buffer.byteshift(9)
+      payload = buffer.byteshift(length)
+      type_value = bhead.uint8(3)
+      flags_value = bhead.uint8(4)
+      r_sid = bhead.uint32(5)
+      r = r_sid >> 31
+      stream_id = r_sid & ~(1 << 31)
+      self.new(type_value: type_value,
+               flags_value: flags_value,
+               stream_id: stream_id,
+               payload: payload).freeze
+    end
+  end
+end

data/lib/plum/frame_factory.rb ADDED Viewed

@@ -0,0 +1,53 @@
+using Plum::BinaryString
+module Plum
+  module FrameFactory
+    def rst_stream(stream_id, error_type)
+      payload = "".push_uint32(HTTPError::ERROR_CODES[error_type])
+      Frame.new(type: :rst_stream, stream_id: stream_id, payload: payload)
+    end
+    def goaway(last_id, error_type, message = "")
+      payload = "".push_uint32((last_id || 0) | (0 << 31))
+                  .push_uint32(HTTPError::ERROR_CODES[error_type])
+                  .push(message)
+      Frame.new(type: :goaway, stream_id: 0, payload: payload)
+    end
+    def settings(ack = nil, **args)
+      payload = args.inject("") {|payload, (key, value)|
+        id = Frame::SETTINGS_TYPE[key] or raise ArgumentError.new("invalid settings type")
+        payload.push_uint16(id)
+        payload.push_uint32(value)
+      }
+      Frame.new(type: :settings, stream_id: 0, flags: [ack].compact, payload: payload)
+    end
+    def ping(arg1 = "plum\x00\x00\x00\x00", arg2 = nil)
+      if !arg2
+        raise ArgumentError.new("data must be 8 octets") if arg1.bytesize != 8
+        Frame.new(type: :ping, stream_id: 0, payload: arg1)
+      else
+        Frame.new(type: :ping, stream_id: 0, flags: [:ack], payload: arg2)
+      end
+    end
+    def data(stream_id, payload, *flags)
+      Frame.new(type: :data, stream_id: stream_id, flags: flags.compact, payload: payload.to_s)
+    end
+    def headers(stream_id, encoded, *flags)
+      Frame.new(type: :headers, stream_id: stream_id, flags: flags.compact, payload: encoded)
+    end
+    def push_promise(stream_id, new_id, encoded, *flags)
+      payload = "".push_uint32(0 << 31 | new_id)
+                  .push(encoded)
+      Frame.new(type: :push_promise, stream_id: stream_id, flags: flags.compact, payload: payload)
+    end
+    def continuation(stream_id, payload, *flags)
+      Frame.new(type: :continuation, stream_id: stream_id, flags: flags.compact, payload: payload)
+    end
+  end
+end

data/lib/plum/frame_utils.rb ADDED Viewed

@@ -0,0 +1,50 @@
+using Plum::BinaryString
+module Plum
+  module FrameUtils
+    # Splits the DATA frame into multiple frames if the payload size exceeds max size.
+    #
+    # @param max [Integer] The maximum size of a frame payload.
+    # @return [Array<Frame>] The splitted frames.
+    def split_data(max)
+      return [self] if self.length <= max
+      raise "Frame type must be DATA" unless self.type == :data
+      fragments = self.payload.each_byteslice(max).to_a
+      frames = fragments.map {|fragment| Frame.new(type: :data, flags: [], stream_id: self.stream_id, payload: fragment) }
+      frames.first.flags = self.flags - [:end_stream]
+      frames.last.flags = self.flags & [:end_stream]
+      frames
+    end
+    # Splits the HEADERS or PUSH_PROMISE frame into multiple frames if the payload size exceeds max size.
+    #
+    # @param max [Integer] The maximum size of a frame payload.
+    # @return [Array<Frame>] The splitted frames.
+    def split_headers(max)
+      return [self] if self.length <= max
+      raise "Frame type must be HEADERS or PUSH_PROMISE" unless [:headers, :push_promise].include?(self.type)
+      fragments = self.payload.each_byteslice(max).to_a
+      frames = fragments.map {|fragment| Frame.new(type: :continuation, flags: [], stream_id: self.stream_id, payload: fragment) }
+      frames.first.type_value = self.type_value
+      frames.first.flags = self.flags - [:end_headers]
+      frames.last.flags = self.flags & [:end_headers]
+      frames
+    end
+    # Parses SETTINGS frame payload. Ignores unknown settings type (see RFC7540 6.5.2).
+    #
+    # @return [Hash<Symbol, Integer>] The parsed strings.
+    def parse_settings
+      settings = {}
+      payload.each_byteslice(6) do |param|
+        id = param.uint16
+        name = Frame::SETTINGS_TYPE.key(id)
+        # ignore unknown settings type
+        settings[name] = param.uint32(2) if name
+      end
+      settings
+    end
+  end
+end

data/lib/plum/hpack/constants.rb ADDED Viewed

@@ -0,0 +1,331 @@
+module Plum
+  module HPACK
+    # RFC7541 Appendix A
+    # index is starting from 0
+    STATIC_TABLE = [
+      [":authority"],
+      [":method", "GET"],
+      [":method", "POST"],
+      [":path", "/"],
+      [":path", "/index.html"],
+      [":scheme", "http"],
+      [":scheme", "https"],
+      [":status", "200"],
+      [":status", "204"],
+      [":status", "206"],
+      [":status", "304"],
+      [":status", "400"],
+      [":status", "404"],
+      [":status", "500"],
+      ["accept-charset"],
+      ["accept-encoding", "gzip, deflate"],
+      ["accept-language"],
+      ["accept-ranges"],
+      ["accept"],
+      ["access-control-allow-origin"],
+      ["age"],
+      ["allow"],
+      ["authorization"],
+      ["cache-control"],
+      ["content-disposition"],
+      ["content-encoding"],
+      ["content-language"],
+      ["content-length"],
+      ["content-location"],
+      ["content-range"],
+      ["content-type"],
+      ["cookie"],
+      ["date"],
+      ["etag"],
+      ["expect"],
+      ["expires"],
+      ["from"],
+      ["host"],
+      ["if-match"],
+      ["if-modified-since"],
+      ["if-none-match"],
+      ["if-range"],
+      ["if-unmodified-since"],
+      ["last-modified"],
+      ["link"],
+      ["location"],
+      ["max-forwards"],
+      ["proxy-authenticate"],
+      ["proxy-authorization"],
+      ["range"],
+      ["referer"],
+      ["refresh"],
+      ["retry-after"],
+      ["server"],
+      ["set-cookie"],
+      ["strict-transport-security"],
+      ["transfer-encoding"],
+      ["user-agent"],
+      ["vary"],
+      ["via"],
+      ["www-authenticate"],
+    ]
+    HUFFMAN_TABLE = [
+      "1111111111000",
+      "11111111111111111011000",
+      "1111111111111111111111100010",
+      "1111111111111111111111100011",
+      "1111111111111111111111100100",
+      "1111111111111111111111100101",
+      "1111111111111111111111100110",
+      "1111111111111111111111100111",
+      "1111111111111111111111101000",
+      "111111111111111111101010",
+      "111111111111111111111111111100",
+      "1111111111111111111111101001",
+      "1111111111111111111111101010",
+      "111111111111111111111111111101",
+      "1111111111111111111111101011",
+      "1111111111111111111111101100",
+      "1111111111111111111111101101",
+      "1111111111111111111111101110",
+      "1111111111111111111111101111",
+      "1111111111111111111111110000",
+      "1111111111111111111111110001",
+      "1111111111111111111111110010",
+      "111111111111111111111111111110",
+      "1111111111111111111111110011",
+      "1111111111111111111111110100",
+      "1111111111111111111111110101",
+      "1111111111111111111111110110",
+      "1111111111111111111111110111",
+      "1111111111111111111111111000",
+      "1111111111111111111111111001",
+      "1111111111111111111111111010",
+      "1111111111111111111111111011",
+      "010100",
+      "1111111000",
+      "1111111001",
+      "111111111010",
+      "1111111111001",
+      "010101",
+      "11111000",
+      "11111111010",
+      "1111111010",
+      "1111111011",
+      "11111001",
+      "11111111011",
+      "11111010",
+      "010110",
+      "010111",
+      "011000",
+      "00000",
+      "00001",
+      "00010",
+      "011001",
+      "011010",
+      "011011",
+      "011100",
+      "011101",
+      "011110",
+      "011111",
+      "1011100",
+      "11111011",
+      "111111111111100",
+      "100000",
+      "111111111011",
+      "1111111100",
+      "1111111111010",
+      "100001",
+      "1011101",
+      "1011110",
+      "1011111",
+      "1100000",
+      "1100001",
+      "1100010",
+      "1100011",
+      "1100100",
+      "1100101",
+      "1100110",
+      "1100111",
+      "1101000",
+      "1101001",
+      "1101010",
+      "1101011",
+      "1101100",
+      "1101101",
+      "1101110",
+      "1101111",
+      "1110000",
+      "1110001",
+      "1110010",
+      "11111100",
+      "1110011",
+      "11111101",
+      "1111111111011",
+      "1111111111111110000",
+      "1111111111100",
+      "11111111111100",
+      "100010",
+      "111111111111101",
+      "00011",
+      "100011",
+      "00100",
+      "100100",
+      "00101",
+      "100101",
+      "100110",
+      "100111",
+      "00110",
+      "1110100",
+      "1110101",
+      "101000",
+      "101001",
+      "101010",
+      "00111",
+      "101011",
+      "1110110",
+      "101100",
+      "01000",
+      "01001",
+      "101101",
+      "1110111",
+      "1111000",
+      "1111001",
+      "1111010",
+      "1111011",
+      "111111111111110",
+      "11111111100",
+      "11111111111101",
+      "1111111111101",
+      "1111111111111111111111111100",
+      "11111111111111100110",
+      "1111111111111111010010",
+      "11111111111111100111",
+      "11111111111111101000",
+      "1111111111111111010011",
+      "1111111111111111010100",
+      "1111111111111111010101",
+      "11111111111111111011001",
+      "1111111111111111010110",
+      "11111111111111111011010",
+      "11111111111111111011011",
+      "11111111111111111011100",
+      "11111111111111111011101",
+      "11111111111111111011110",
+      "111111111111111111101011",
+      "11111111111111111011111",
+      "111111111111111111101100",
+      "111111111111111111101101",
+      "1111111111111111010111",
+      "11111111111111111100000",
+      "111111111111111111101110",
+      "11111111111111111100001",
+      "11111111111111111100010",
+      "11111111111111111100011",
+      "11111111111111111100100",
+      "111111111111111011100",
+      "1111111111111111011000",
+      "11111111111111111100101",
+      "1111111111111111011001",
+      "11111111111111111100110",
+      "11111111111111111100111",
+      "111111111111111111101111",
+      "1111111111111111011010",
+      "111111111111111011101",
+      "11111111111111101001",
+      "1111111111111111011011",
+      "1111111111111111011100",
+      "11111111111111111101000",
+      "11111111111111111101001",
+      "111111111111111011110",
+      "11111111111111111101010",
+      "1111111111111111011101",
+      "1111111111111111011110",
+      "111111111111111111110000",
+      "111111111111111011111",
+      "1111111111111111011111",
+      "11111111111111111101011",
+      "11111111111111111101100",
+      "111111111111111100000",
+      "111111111111111100001",
+      "1111111111111111100000",
+      "111111111111111100010",
+      "11111111111111111101101",
+      "1111111111111111100001",
+      "11111111111111111101110",
+      "11111111111111111101111",
+      "11111111111111101010",
+      "1111111111111111100010",
+      "1111111111111111100011",
+      "1111111111111111100100",
+      "11111111111111111110000",
+      "1111111111111111100101",
+      "1111111111111111100110",
+      "11111111111111111110001",
+      "11111111111111111111100000",
+      "11111111111111111111100001",
+      "11111111111111101011",
+      "1111111111111110001",
+      "1111111111111111100111",
+      "11111111111111111110010",
+      "1111111111111111101000",
+      "1111111111111111111101100",
+      "11111111111111111111100010",
+      "11111111111111111111100011",
+      "11111111111111111111100100",
+      "111111111111111111111011110",
+      "111111111111111111111011111",
+      "11111111111111111111100101",
+      "111111111111111111110001",
+      "1111111111111111111101101",
+      "1111111111111110010",
+      "111111111111111100011",
+      "11111111111111111111100110",
+      "111111111111111111111100000",
+      "111111111111111111111100001",
+      "11111111111111111111100111",
+      "111111111111111111111100010",
+      "111111111111111111110010",
+      "111111111111111100100",
+      "111111111111111100101",
+      "11111111111111111111101000",
+      "11111111111111111111101001",
+      "1111111111111111111111111101",
+      "111111111111111111111100011",
+      "111111111111111111111100100",
+      "111111111111111111111100101",
+      "11111111111111101100",
+      "111111111111111111110011",
+      "11111111111111101101",
+      "111111111111111100110",
+      "1111111111111111101001",
+      "111111111111111100111",
+      "111111111111111101000",
+      "11111111111111111110011",
+      "1111111111111111101010",
+      "1111111111111111101011",
+      "1111111111111111111101110",
+      "1111111111111111111101111",
+      "111111111111111111110100",
+      "111111111111111111110101",
+      "11111111111111111111101010",
+      "11111111111111111110100",
+      "11111111111111111111101011",
+      "111111111111111111111100110",
+      "11111111111111111111101100",
+      "11111111111111111111101101",
+      "111111111111111111111100111",
+      "111111111111111111111101000",
+      "111111111111111111111101001",
+      "111111111111111111111101010",
+      "111111111111111111111101011",
+      "1111111111111111111111111110",
+      "111111111111111111111101100",
+      "111111111111111111111101101",
+      "111111111111111111111101110",
+      "111111111111111111111101111",
+      "111111111111111111111110000",
+      "11111111111111111111101110",
+      "111111111111111111111111111111"
+    ]
+    HUFFMAN_TABLE_INVERSED = HUFFMAN_TABLE.each_with_index.to_h
+  end
+end