hpack 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6783e15162742ae6a5234b6246e5e6a3e79a62d
+  data.tar.gz: 706528046402ce381f19218dd67155f705b96028
+SHA512:
+  metadata.gz: 17e698d980a2a6db5c6fe473d057694e131483539917a3ecd1c8cc922eedf25fa951b204f5c0fcf67239af34f691d7367bf2ba4c7bf4d4da6d771cb521028ca3
+  data.tar.gz: 89b6189be4973cc58e71620f1b8119b70d8004af34033a590674bd896ce768f7b8c84267ddae0bcb24c4ce89ed48c786478941e8640c829c9ef2a1c9301072a1

data/.gitignore

@@ -0,0 +1,2 @@
+/*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--require hpack

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hpack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Konstantin Burnaev
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+# Hpack
+
+Ruby implementation of the HPACK (Header Compression for HTTP/2) standard.
+
+http://http2.github.io/http2-spec/compression.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hpack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hpack
+
+## Usage
+
+```
+require 'hpack'
+
+io_stream = ... something which gives you IO object with data to be processed ...
+
+decoder = Hpack::Decoder.new
+decoder.decode io_stream do |header, value, metadata|
+  ...
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hpack/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/hpack.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hpack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hpack"
+  spec.version       = Hpack::VERSION
+  spec.authors       = ["Konstantin Burnaev"]
+  spec.email         = ["kbourn@gmail.com"]
+  spec.summary       = %q{HPACK implementation for Ruby.}
+  spec.description   = """Ruby implementation of the HPACK (Header Compression for HTTP/2) standard available at http://http2.github.io/http2-spec/compression.html"""
+  spec.homepage      = "https://github.com/bkon/hpack"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.4", ">= 10.4.2"
+  spec.add_development_dependency "simplecov", "~> 0.9", ">= 0.9.1"
+  spec.add_development_dependency "rspec", "~> 3.1", ">= 3.1.0"
+end

data/lib/hpack.rb

@@ -0,0 +1,10 @@
+require "hpack/version"
+require "hpack/decoder"
+require "hpack/field"
+require "hpack/huffman"
+require "hpack/integer_reader"
+require "hpack/lookup_table"
+
+module Hpack
+  # Your code goes here...
+end

data/lib/hpack/decoder.rb

@@ -0,0 +1,110 @@
+module Hpack
+  class Decoder
+    class DecodingError < StandardError; end
+    class ZeroIndexedFieldIndex < DecodingError; end
+
+    attr_reader :lookup_table
+
+    def initialize lookup_table_size: LookupTable::SETTINGS_HEADER_TABLE_SIZE
+      @lookup_table = LookupTable.new max_size: lookup_table_size
+    end
+
+    def decode input
+      read_fields_from input do |field|
+        yield field.header, field.value, field
+      end
+    end
+
+    private
+
+    def read_fields_from input
+      while not input.eof?
+        header_byte = input.readbyte
+
+        # indexed
+        if header_byte & 0b1000_0000 == 0b1000_0000
+          index = read_integer_with_prefix length: 7, input: input, start_with: header_byte
+
+          if index == 0
+            raise ZeroIndexedFieldIndex
+          end
+
+          header = @lookup_table[index].name
+          value = @lookup_table[index].value
+
+          yield Field.new header, value
+
+        # literal indexed
+        elsif header_byte & 0b1100_0000 == 0b0100_0000
+          name_index = read_integer_with_prefix length: 6, input: input, start_with: header_byte
+          if name_index == 0
+            header = read_string input
+          else
+            header = @lookup_table[name_index].name
+          end
+
+          value = read_string input
+
+          @lookup_table << LookupTable::Entry.new(header, value)
+
+          yield Field.new header, value
+
+        elsif header_byte & 0b1111_0000 == 0b0000_0000
+          name_index = read_integer_with_prefix length: 4, input: input, start_with: header_byte
+
+          if name_index == 0
+            header = read_string input
+          else
+            header = @lookup_table[name_index].name
+          end
+
+          value = read_string input
+
+          yield Field.new header, value
+
+        elsif header_byte & 0b1111_0000 == 0b0001_0000
+          name_index = read_integer_with_prefix length: 4, input: input, start_with: header_byte
+
+          if name_index == 0
+            header = read_string input
+          else
+            header = @lookup_table[name_index].name
+          end
+
+          value = read_string input
+
+          yield Field.new header, value
+
+        elsif header_byte & 0b1110_0000 == 0b0010_0000
+          new_size = read_integer_with_prefix length: 5, input: input, start_with: header_byte
+
+          @lookup_table.max_size = new_size
+        end
+      end
+    end
+
+    def read_integer_with_prefix *options
+      integer_reader.read(*options)
+    end
+
+    def read_string input
+      header_byte = input.readbyte
+      huffman = (header_byte & 0b1000_0000 != 0)
+      length = read_integer_with_prefix length: 7, input: input, start_with: header_byte
+
+      if huffman
+        huffman_decoder.decode input: input, length: length
+      else
+        input.read length
+      end
+    end
+
+    def huffman_decoder
+      @huffman_decode ||= Hpack::Huffman.new
+    end
+
+    def integer_reader
+      @integer_reader ||= Hpack::IntegerReader.new
+    end
+  end
+end

data/lib/hpack/encoder.rb

@@ -0,0 +1,4 @@
+module Hpack
+  class Encoder
+  end
+end

data/lib/hpack/field.rb

@@ -0,0 +1,11 @@
+module Hpack
+  class Field
+    attr_reader :header
+    attr_reader :value
+
+    def initialize header, value
+      @header = header
+      @value = value
+    end
+  end
+end

data/lib/hpack/huffman.rb

@@ -0,0 +1,326 @@
+module Hpack
+  class Huffman
+    HUFFMAN = [
+      "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" # EOS
+    ]
+
+    def initialize
+      @root = {}
+      HUFFMAN.each_with_index do |code, terminal|
+        load_terminal code, terminal
+      end
+    end
+
+    def load_terminal code, terminal
+      node = @root
+
+      code.each_char do |bit_sym|
+        bit = bit_sym.to_i
+        unless node.include? bit
+          node[bit] = {}
+        end
+
+        node = node[bit]
+      end
+
+      node[:value] = terminal
+    end
+
+    def decode input: nil, length: 0
+      node = @root
+
+      decode_bits input, length do |bit|
+        node = node[bit]
+
+        next nil unless node.include? :value
+
+        char = node[:value]
+        node = @root
+        char
+      end
+    end
+
+    def decode_bits input, length
+      data = ""
+      padding = []
+
+      length.times do |i|
+        byte = input.readbyte
+
+        8.times do
+          bit = (byte & 0b1000_0000 == 0) && 0 || 1
+          char = yield bit
+
+          if char
+            data << char
+            padding = []
+          else
+            padding << bit
+          end
+
+          byte <<= 1
+        end
+      end
+
+      # TODO: padding check
+
+      data
+    end
+  end
+end