biryani 0.0.8 → 0.0.10

data/lib/biryani.rb

@@ -3,11 +3,9 @@ require 'uri'
 require_relative 'biryani/connection_error'
 require_relative 'biryani/connection'
 require_relative 'biryani/data_buffer'
-require_relative 'biryani/error'
 require_relative 'biryani/frame'
 require_relative 'biryani/hpack'
-require_relative 'biryani/http_request'
-require_relative 'biryani/http_response'
+require_relative 'biryani/http'
 require_relative 'biryani/server'
 require_relative 'biryani/state'
 require_relative 'biryani/stream_error'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biryani
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - thekuwayama
@@ -30,9 +30,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".github/workflows/conformance.yml"
-- ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
@@ -49,7 +46,6 @@ files:
 - lib/biryani/connection.rb
 - lib/biryani/connection_error.rb
 - lib/biryani/data_buffer.rb
-- lib/biryani/error.rb
 - lib/biryani/frame.rb
 - lib/biryani/frame/continuation.rb
 - lib/biryani/frame/data.rb
@@ -73,8 +69,10 @@ files:
 - lib/biryani/hpack/integer.rb
 - lib/biryani/hpack/option.rb
 - lib/biryani/hpack/string.rb
-- lib/biryani/http_request.rb
-- lib/biryani/http_response.rb
+- lib/biryani/http.rb
+- lib/biryani/http/error.rb
+- lib/biryani/http/request.rb
+- lib/biryani/http/response.rb
 - lib/biryani/server.rb
 - lib/biryani/state.rb
 - lib/biryani/stream.rb
@@ -83,40 +81,6 @@ files:
 - lib/biryani/utils.rb
 - lib/biryani/version.rb
 - lib/biryani/window.rb
-- spec/connection/handle_connection_window_update_spec.rb
-- spec/connection/handle_data_spec.rb
-- spec/connection/handle_headers_spec.rb
-- spec/connection/handle_ping_spec.rb
-- spec/connection/handle_rst_stream_spec.rb
-- spec/connection/handle_settings_spec.rb
-- spec/connection/handle_stream_window_update_spec.rb
-- spec/connection/read_http2_magic_spec.rb
-- spec/connection/send_spec.rb
-- spec/connection/transition_stream_state_send_spec.rb
-- spec/data_buffer_spec.rb
-- spec/frame/continuation_spec.rb
-- spec/frame/data_spec.rb
-- spec/frame/goaway_spec.rb
-- spec/frame/headers_spec.rb
-- spec/frame/ping_spec.rb
-- spec/frame/priority_spec.rb
-- spec/frame/push_promise_spec.rb
-- spec/frame/read_spec.rb
-- spec/frame/rst_stream_spec.rb
-- spec/frame/settings_spec.rb
-- spec/frame/window_update_spec.rb
-- spec/hpack/decoder_spec.rb
-- spec/hpack/encoder_spec.rb
-- spec/hpack/field_spec.rb
-- spec/hpack/fields_spec.rb
-- spec/hpack/huffman_spec.rb
-- spec/hpack/integer_spec.rb
-- spec/hpack/string_spec.rb
-- spec/http_request_spec.rb
-- spec/http_response_spec.rb
-- spec/spec_helper.rb
-- spec/streams_context_spec.rb
-- spec/utils_spec.rb
 homepage: https://github.com/thekuwayama/biryani
 licenses:
 - MIT
@@ -135,41 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.8
 specification_version: 4
 summary: An HTTP/2 server implemented using Ruby Ractor
-test_files:
-- spec/connection/handle_connection_window_update_spec.rb
-- spec/connection/handle_data_spec.rb
-- spec/connection/handle_headers_spec.rb
-- spec/connection/handle_ping_spec.rb
-- spec/connection/handle_rst_stream_spec.rb
-- spec/connection/handle_settings_spec.rb
-- spec/connection/handle_stream_window_update_spec.rb
-- spec/connection/read_http2_magic_spec.rb
-- spec/connection/send_spec.rb
-- spec/connection/transition_stream_state_send_spec.rb
-- spec/data_buffer_spec.rb
-- spec/frame/continuation_spec.rb
-- spec/frame/data_spec.rb
-- spec/frame/goaway_spec.rb
-- spec/frame/headers_spec.rb
-- spec/frame/ping_spec.rb
-- spec/frame/priority_spec.rb
-- spec/frame/push_promise_spec.rb
-- spec/frame/read_spec.rb
-- spec/frame/rst_stream_spec.rb
-- spec/frame/settings_spec.rb
-- spec/frame/window_update_spec.rb
-- spec/hpack/decoder_spec.rb
-- spec/hpack/encoder_spec.rb
-- spec/hpack/field_spec.rb
-- spec/hpack/fields_spec.rb
-- spec/hpack/huffman_spec.rb
-- spec/hpack/integer_spec.rb
-- spec/hpack/string_spec.rb
-- spec/http_request_spec.rb
-- spec/http_response_spec.rb
-- spec/spec_helper.rb
-- spec/streams_context_spec.rb
-- spec/utils_spec.rb
+test_files: []

data/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: lint & test
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  ci:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['4.0']
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@ae195bbe749a7cef685ac729197124a48305c1cb # v1.276.0
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - name: Install dependencies
-        run: |
-          gem --version
-          gem install bundler
-          bundle --version
-          bundle install
-      - name: Run rubocop & rspec
-        run: bundle exec rake

data/.github/workflows/conformance.yml

@@ -1,46 +0,0 @@
-name: h2spec
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-    branches:
-      - '*'
-
-jobs:
-  conformance:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      checks: write
-    strategy:
-      matrix:
-        ruby-version: ['4.0']
-    steps:
-      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@ae195bbe749a7cef685ac729197124a48305c1cb # v1.276.0
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-      - name: Install dependencies
-        run: |
-          gem --version
-          gem install bundler
-          bundle --version
-          bundle install
-      - name: Install h2spec
-        run: |
-          set -eu
-          curl -Ls https://github.com/summerwind/h2spec/releases/download/v2.6.0/h2spec_linux_amd64.tar.gz | tar xz
-          mkdir -p $GITHUB_WORKSPACE/bin
-          mv h2spec $GITHUB_WORKSPACE/bin/h2spec
-          chmod +x $GITHUB_WORKSPACE/bin/h2spec
-          echo $GITHUB_WORKSPACE/bin >> $GITHUB_PATH
-      - name: Run conformance test
-        run: bundle exec rake conformance
-      - uses: mikepenz/action-junit-report@a294a61c909bd8a4b563024a2faa28897fd53ebc # v6.1.0
-        if: success()
-        with:
-          report_paths: conformance/reports/h2spec.xml
-          detailed_summary: true

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.config
-.rvmrc
-/.bundle/
-/vendor/
-/lib/bundler/man/
-/pkg/
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-/coverage/
-/spec/reports/
-/conformance/reports/
-/tmp/
-.DS_Store
-Gemfile.lock

data/lib/biryani/error.rb

@@ -1,8 +0,0 @@
-module Biryani
-  module Error
-    # Generic error, common for all classes under Biryani::Error module.
-    class Error < StandardError; end
-
-    class InvalidHTTPResponseError < Error; end
-  end
-end

data/lib/biryani/http_request.rb

@@ -1,95 +0,0 @@
-module Biryani
-  class HTTPRequest
-    attr_accessor :method, :uri, :fields, :content
-
-    # @param method [String]
-    # @param uri [URI]
-    # @param fields [Hash<String, Array<String>>]
-    # @param content [String]
-    def initialize(method, uri, fields, content)
-      @method = method
-      @uri = uri
-      @fields = fields
-      @content = content
-    end
-
-    # @return [Array<String>, nil]
-    def trailers
-      # https://datatracker.ietf.org/doc/html/rfc9110#section-6.6.2-4
-      keys = (@fields['trailer'] || []).flat_map { |x| x.split(',').map(&:strip) }
-      @fields.slice(*keys)
-    end
-  end
-
-  class HTTPRequestBuilder
-    PSEUDO_HEADER_FIELDS = [':authority', ':method', ':path', ':scheme'].freeze
-    Ractor.make_shareable(PSEUDO_HEADER_FIELDS)
-
-    def initialize
-      @h = {}
-    end
-
-    # @param name [String]
-    # @param value [String]
-    #
-    # @return [nil, ConnectioError]
-    # rubocop: disable Metrics/AbcSize
-    # rubocop: disable Metrics/CyclomaticComplexity
-    # rubocop: disable Metrics/PerceivedComplexity
-    def field(name, value)
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'field name has uppercase letter') if name.downcase != name
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'unknown pseudo-header field name') if name[0] == ':' && !PSEUDO_HEADER_FIELDS.include?(name)
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'appear pseudo-header fields after regular fields') if name[0] == ':' && @h.any? { |name_, _| name_[0] != ':' }
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'duplicated pseudo-header fields') if PSEUDO_HEADER_FIELDS.include?(name) && @h.key?(name)
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, "invalid `#{name}` field") if PSEUDO_HEADER_FIELDS.include?(name) && value.empty?
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'connection-specific field is forbidden') if name == 'connection'
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, '`TE` field has a value other than `trailers`') if name == 'te' && value != 'trailers'
-
-      @h[name] = [] unless @h.key?(name)
-      @h[name] << value
-
-      nil
-    end
-    # rubocop: enable Metrics/AbcSize
-    # rubocop: enable Metrics/CyclomaticComplexity
-    # rubocop: enable Metrics/PerceivedComplexity
-
-    # @param arr [Array]
-    #
-    # @return [nil, ConnectioError]
-    def fields(arr)
-      arr.each do |name, value|
-        err = field(name, value)
-        return err unless err.nil?
-      end
-
-      nil
-    end
-
-    # @param s [String]
-    #
-    # @return [HTTPRequest]
-    def build(s)
-      # `Ractor.send(req, move: true)` moves entries in HPACK::DynamicTable; therefore, a `dup` call is required.
-      h = @h.transform_values { |x| x.map(&:dup) }
-      self.class.http_request(h, s)
-    end
-
-    # @param h [Hash<String, Array<String>>]
-    # @param s [String]
-    #
-    # @return [HTTPRequest, ConnectionError]
-    def self.http_request(h, s)
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'missing pseudo-header fields') unless PSEUDO_HEADER_FIELDS.all? { |x| h.key?(x) }
-      return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'invalid content-length') if h.key?('content-length') && !s.empty? && s.length != h['content-length'].to_i
-
-      scheme = h[':scheme'][0]
-      domain = h[':authority'][0]
-      path = h[':path'][0]
-      uri = URI("#{scheme}://#{domain}#{path}")
-      method = h[':method'][0]
-      h['cookie'] = [h['cookie'].join('; ')] if h.key?('cookie')
-      HTTPRequest.new(method, uri, h, s)
-    end
-  end
-end

data/lib/biryani/http_response.rb

@@ -1,66 +0,0 @@
-module Biryani
-  class HTTPResponse
-    FORBIDDEN_KEY_CHARS = (0x00..0x20).chain([0x3a]).chain(0x41..0x5a).chain(0x7f..0xff).to_a.freeze
-    FORBIDDEN_VALUE_CHARS = [0x00, 0x0a, 0x0d].freeze
-
-    attr_accessor :status, :fields, :content
-
-    # @param status [Integer]
-    # @param fields [Hash]
-    # @param content [String, nil]
-    def initialize(status, fields, content)
-      @status = status
-      @fields = fields
-      @content = content
-    end
-
-    # @raise [InvalidHTTPResponseError]
-    # rubocop: disable Metrics/CyclomaticComplexity
-    def validate
-      # https://datatracker.ietf.org/doc/html/rfc9113#section-8.2.1
-      raise Error::InvalidHTTPResponseError, 'invalid HTTP status' if @status < 100 || @status >= 600
-      raise Error::InvalidHTTPResponseError, 'HTTP field name contains invalid characters' if (@fields.keys.join.downcase.bytes.uniq & FORBIDDEN_KEY_CHARS).any?
-      raise Error::InvalidHTTPResponseError, 'HTTP field value contains NUL, LF or CR' if (@fields.values.join.bytes.uniq & FORBIDDEN_VALUE_CHARS).any?
-      raise Error::InvalidHTTPResponseError, 'HTTP field value starts/ends with SP or HTAB' if @fields.values.filter { |s| s.start_with?("\t", ' ') || s.end_with?("\t", ' ') }.any?
-    end
-    # rubocop: enable Metrics/CyclomaticComplexity
-
-    def self.default
-      HTTPResponse.new(0, {}, nil)
-    end
-
-    def self.internal_server_error
-      HTTPResponse.new(500, {}, 'Internal Server Error')
-    end
-  end
-
-  class HTTPResponseParser
-    # @param res [HTTPResponse]
-    def initialize(res)
-      @res = res
-    end
-
-    # @return [Array]
-    def fields
-      fields = [[':status', @res.status.to_s]]
-      @res.fields.each do |name, value|
-        fields << [name.to_s.downcase, value.to_s]
-      end
-
-      fields
-    end
-
-    # @return [String]
-    def content
-      @res.content
-    end
-
-    # @param encoder [Encoder]
-    #
-    # @return [String] fragment
-    # @return [String] data
-    def parse(encoder)
-      [encoder.encode(fields), content]
-    end
-  end
-end

data/spec/connection/handle_connection_window_update_spec.rb

@@ -1,16 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_connection_window_update' do
-    let(:window_update) do
-      Frame::WindowUpdate.new(0, 1000)
-    end
-    let(:send_window) do
-      Window.new(65_535)
-    end
-    it 'should handle' do
-      expect { Connection.handle_connection_window_update(window_update, send_window) }.not_to raise_error
-      expect(send_window.length).to eq 2**16 - 1 + 1000
-    end
-  end
-end

data/spec/connection/handle_data_spec.rb

@@ -1,58 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_data' do
-    let(:decoder) do
-      HPACK::Decoder.new(4_096)
-    end
-
-    let(:recv_window1) do
-      Window.new(65_535)
-    end
-    let(:streams_ctx1) do
-      streams_ctx = StreamsContext.new(do_nothing_proc)
-      streams_ctx.new_context(1, 65_535, 65_535)
-      streams_ctx.new_context(2, 65_535, 65_535)
-      streams_ctx
-    end
-    it 'should handle' do
-      expect(Connection.handle_data(2, 'Hello, world!', recv_window1, streams_ctx1, decoder)).to eq []
-      expect(streams_ctx1[2].content).to eq 'Hello, world!'
-    end
-
-    let(:recv_window2) do
-      recv_window = Window.new(65_535)
-      recv_window.consume!(65_535 / 2)
-      recv_window
-    end
-    let(:streams_ctx2) do
-      streams_ctx = StreamsContext.new(do_nothing_proc)
-      streams_ctx.new_context(1, 65_535, 65_535)
-      streams_ctx.new_context(2, 65_535, 65_535)
-      streams_ctx[2].recv_window.consume!(65_535 / 2)
-      streams_ctx
-    end
-    it 'should handle' do
-      frames = Connection.handle_data(2, 'Hello, world!', recv_window2, streams_ctx2, decoder)
-      expect(frames.map(&:f_type)).to eq [FrameType::WINDOW_UPDATE, FrameType::WINDOW_UPDATE]
-      expect(frames.map(&:stream_id)).to eq [0, 2]
-      expect(frames.map(&:window_size_increment)).to eq [65_535 / 2 + 13, 65_535 / 2 + 13]
-      expect(streams_ctx2[2].content).to eq 'Hello, world!'
-    end
-
-    let(:recv_window3) do
-      recv_window = Window.new(65_535)
-      recv_window.consume!(65_535)
-      recv_window
-    end
-    let(:streams_ctx3) do
-      streams_ctx = StreamsContext.new(do_nothing_proc)
-      streams_ctx.new_context(1, 65_535, 65_535)
-      streams_ctx.new_context(2, 65_535, 65_535)
-      streams_ctx
-    end
-    it 'should not handle' do
-      expect(Connection.handle_data(2, 'Hello, world!', recv_window3, streams_ctx3, decoder)).to be_kind_of ConnectionError
-    end
-  end
-end

data/spec/connection/handle_headers_spec.rb

@@ -1,19 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_headers' do
-    let(:headers) do
-      Frame::Headers.new(true, false, 2, nil, nil, 'this is dummy', nil)
-    end
-    let(:ctx) do
-      StreamContext.new(2, 65_535, 65_535, do_nothing_proc)
-    end
-    let(:decoder) do
-      HPACK::Decoder.new(4_096)
-    end
-    it 'should handle' do
-      expect(Connection.handle_headers(headers, ctx, decoder)).to eq nil
-      expect(ctx.fragment).to eq 'this is dummy'
-    end
-  end
-end

data/spec/connection/handle_ping_spec.rb

@@ -1,21 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_ping' do
-    let(:ping1) do
-      Frame::Ping.new(true, 0, "\x00" * 8)
-    end
-    it 'should handle' do
-      expect(Connection.handle_ping(ping1)).to eq nil
-    end
-
-    let(:ping2) do
-      Frame::Ping.new(false, 0, "\x00" * 8)
-    end
-    it 'should handle' do
-      expect(Connection.handle_ping(ping2)).to_not eq nil
-      expect(Connection.handle_ping(ping2).ack?).to eq true
-      expect(Connection.handle_ping(ping2).opaque).to eq "\x00" * 8
-    end
-  end
-end

data/spec/connection/handle_rst_stream_spec.rb

@@ -1,16 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_rst_stream' do
-    let(:rst_stream) do
-      Frame::RstStream.new(2, 0)
-    end
-    let(:ctx) do
-      StreamContext.new(2, 65_535, 65_535, do_nothing_proc)
-    end
-    it 'should handle' do
-      Connection.handle_rst_stream(rst_stream, ctx)
-      expect(ctx.closed?).to eq true
-    end
-  end
-end

data/spec/connection/handle_settings_spec.rb

@@ -1,37 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_settings' do
-    let(:send_settings) do
-      Connection.default_settings
-    end
-    let(:decoder) do
-      HPACK::Decoder.new(4_096)
-    end
-    let(:streams_ctx) do
-      streams_ctx = StreamsContext.new(do_nothing_proc)
-      streams_ctx.new_context(1, 65_535, 65_535)
-      streams_ctx.new_context(2, 65_535, 65_535)
-      streams_ctx
-    end
-
-    let(:settings1) do
-      Frame::Settings.new(false, 0, { SettingsID::SETTINGS_HEADER_TABLE_SIZE => 8_192 })
-    end
-    it 'should handle' do
-      reply_settings = Connection.handle_settings(settings1, send_settings, decoder, streams_ctx)
-      expect(reply_settings.ack?).to eq true
-      expect(reply_settings.setting.empty?).to eq true
-      expect(send_settings[SettingsID::SETTINGS_MAX_CONCURRENT_STREAMS]).to eq 0xffffffff
-      expect(send_settings[SettingsID::SETTINGS_MAX_FRAME_SIZE]).to eq 16_384
-      expect(send_settings[SettingsID::SETTINGS_HEADER_TABLE_SIZE]).to eq 8_192
-    end
-
-    let(:settings2) do
-      Frame::Settings.new(true, 0, {})
-    end
-    it 'should handle' do
-      expect(Connection.handle_settings(settings2, send_settings, decoder, streams_ctx)).to eq nil
-    end
-  end
-end

data/spec/connection/handle_stream_window_update_spec.rb

@@ -1,20 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'handle_stream_window_update' do
-    let(:window_update) do
-      Frame::WindowUpdate.new(1, 1000)
-    end
-    let(:streams_ctx) do
-      streams_ctx = StreamsContext.new(do_nothing_proc)
-      streams_ctx.new_context(1, 65_535, 65_535)
-      streams_ctx.new_context(2, 65_535, 65_535)
-      streams_ctx
-    end
-    it 'should handle' do
-      expect { Connection.handle_stream_window_update(window_update, streams_ctx) }.not_to raise_error
-      expect(streams_ctx[1].send_window.length).to eq 65_535 + 1000
-      expect(streams_ctx[2].send_window.length).to eq 65_535
-    end
-  end
-end

data/spec/connection/read_http2_magic_spec.rb

@@ -1,26 +0,0 @@
-require_relative '../spec_helper'
-
-RSpec.describe Connection do
-  context 'read_http2_magic' do
-    let(:io1) do
-      StringIO.new("PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n")
-    end
-    it 'should read' do
-      expect(Connection.read_http2_magic(io1)).to eq nil
-    end
-
-    let(:io2) do
-      StringIO.new("PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n\x00xff")
-    end
-    it 'should read' do
-      expect(Connection.read_http2_magic(io2)).to eq nil
-    end
-
-    let(:io3) do
-      StringIO.new("\x00xffPRI * HTTP/2.0\r\n\r\nSM\r\n\r\n")
-    end
-    it 'should not read' do
-      expect(Connection.read_http2_magic(io3)).to be_kind_of ConnectionError
-    end
-  end
-end