http-2 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb3959b06060d626b9065b6b267fc1e4f3906742
+  data.tar.gz: c7da3c39b1829b0458d6d550df7db911bcd69d29
+SHA512:
+  metadata.gz: 293393327feb7f5aafd7017fb63ddb1a332957c8c5221c26050cb5045edf7067b8c2094ee8587227262c3be427838bab46ebd16c33ae8c0e05f8e08482d222ee
+  data.tar.gz: d619c4939dfe5daa0d861d190d9f83368cfd352e46e22b897eaca17318e12550612b855a0a1bf7f860d5443776d3ca9d1fe5e873bdde452c6e2b29c21b568292

data/.autotest

@@ -0,0 +1,19 @@
+require 'autotest/growl'
+
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}
+  at.add_exception %r{^./tmp}
+
+  at.clear_mappings
+
+  at.add_mapping(%r%^spec/.*_spec\.rb$%) { |filename, _|
+    filename
+  }
+  at.add_mapping(%r%^lib/(.*)\.rb$%) { |_, m|
+    ["spec/#{m[1].split('/').last}_spec.rb"]
+  }
+  at.add_mapping(%r%^spec/(spec_helper|shared/.*)\.rb$%) {
+    files_matching %r%^spec/.*_spec\.rb$%
+  }
+  nil
+}

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+autotest
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+script: bundle exec rake test

data/Gemfile

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

data/README.md

@@ -0,0 +1,280 @@
+# HTTP-2
+
+Pure ruby, framework and transport agnostic implementation of [HTTP 2.0 protocol](http://tools.ietf.org/html/draft-ietf-httpbis-http2) with support for:
+
+* [Binary framing](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#_binary_framing_layer) parsing and encoding
+* [Stream multiplexing](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_STREAMS_MESSAGES_FRAMES) and [prioritization](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PRIORITIZATION)
+* Connection and stream [flow control](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#_flow_control)
+* [Header compression](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_HEADER_COMPRESSION) and [server push](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PUSH)
+* Connection and stream management, and other HTTP 2.0 goodies...
+
+Current implementation (see [HPBN chapter for HTTP 2.0 overview](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html)), is based on:
+
+* [draft-ietf-httpbis-http2-06](http://tools.ietf.org/html/draft-ietf-httpbis-http2-06)
+* [draft-ietf-httpbis-header-compression-01](http://tools.ietf.org/html/draft-ietf-httpbis-header-compression)
+
+_Note: the underlying specifications are still evolving, expect APIs to change and evolve also..._
+
+
+## Getting started
+
+This implementation makes no assumptions as how the data is delivered: it could be a regular Ruby TCP socket, your custom eventloop, or whatever other transport you wish to use - e.g. ZeroMQ, [avian carriers](http://www.ietf.org/rfc/rfc1149.txt), etc.
+
+Your code is responsible for feeding data into the parser, which performs all of the necessary HTTP 2.0 decoding, state management and the rest, and vice versa, the parser will emit bytes (encoded HTTP 2.0 frames) that you can then route to the destination. Roughly, this works as follows:
+
+```ruby
+socket = YourTransport.new
+
+conn = HTTP2::Connection.new(:client)
+conn.on(:frame) {|bytes| socket << bytes }
+
+while bytes = socket.read
+ conn << bytes
+end
+```
+
+Checkout provided [client](https://github.com/igrigorik/http-2/blob/master/example/client.rb) and [server]((https://github.com/igrigorik/http-2/blob/master/example/server.rb) implementations for basic examples.
+
+
+### Connection lifecycle management
+
+When the connection object is instantiated you must specify its role (`:client` or `:server`) to initialize appropriate header compression / decompression algorithms and stream management logic. From there, you can subscribe to connection level events, or invoke appropriate APIs to allocate new streams and manage the lifecycle. For example:
+
+```ruby
+# - Server ---------------
+server = HTTP2::Connection.new(:server)
+
+server.on(:stream) { |stream| ... } # process inbound stream
+server.on(:frame)  { |bytes| ... }  # encoded HTTP 2.0 frames
+
+server.ping { ... } # run liveness check, process pong response
+server.goaway # send goaway frame to the client
+
+# - Client ---------------
+client = HTTP2::Connection.new(:client)
+client.on(:promise) { |stream| ... } # process push promise
+
+stream = client.new_stream # allocate new stream
+stream.headers({':method' => 'post', ...}, end_stream: false)
+stream.data(payload, end_stream: true)
+```
+
+Events emitted by the connection object:
+
+<table>
+  <tr>
+    <td><b>:promise</b></td>
+    <td>client role only, fires once for each new push promise</td>
+  </tr>
+  <tr>
+    <td><b>:stream</b></td>
+    <td>server role only, fires once for each new client stream</td>
+  </tr>
+  <tr>
+    <td><b>:frame</b></td>
+    <td>fires once for every encoded HTTP 2.0 frame that needs to be sent to the peer</td>
+  </tr>
+</table>
+
+
+### Stream lifecycle management
+
+A single HTTP 2.0 connection can [multiplex multiple streams](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#REQUEST_RESPONSE_MULTIPLEXING) in parallel: multiple requests and responses can be in flight simultaneously and stream data can be interleaved and prioritized. Further, the specification provides a well-defined lifecycle for each stream (see below).
+
+The good news is, all of the stream management, and state transitions, and error checking is handled by the library. All you have to do is subscribe to appropriate events (marked with ":" prefix in diagram below) and provide your application logic to handle request and response processing.
+
+```
+                         +--------+
+                    PP   |        |   PP
+                ,--------|  idle  |--------.
+               /         |        |         \
+              v          +--------+          v
+       +----------+          |           +----------+
+       |          |          | H         |          |
+   ,---|:reserved |          |           |:reserved |---.
+   |   | (local)  |          v           | (remote) |   |
+   |   +----------+      +--------+      +----------+   |
+   |      | :active      |        |      :active |      |
+   |      |      ,-------|:active |-------.      |      |
+   |      | H   /   ES   |        |   ES   \   H |      |
+   |      v    v         +--------+         v    v      |
+   |   +-----------+          |          +-_---------+  |
+   |   |:half_close|          |          |:half_close|  |
+   |   |  (remote) |          |          |  (local)  |  |
+   |   +-----------+          |          +-----------+  |
+   |        |                 v                |        |
+   |        |    ES/R    +--------+    ES/R    |        |
+   |        `----------->|        |<-----------'        |
+   | R                   | :close |                   R |
+   `-------------------->|        |<--------------------'
+                         +--------+
+```
+
+For sake of example, let's take a look at a simple server implementation:
+
+```ruby
+conn = HTTP2::Connection.new(:server)
+
+# emits new streams opened by the client
+conn.on(:stream) do |stream|
+  stream.on(:active) { } # fires when stream transitions to open state
+  stream.on(:close)  { } # stream is closed by client and server
+
+  stream.on(:headers) { |head| ... } # header callback
+  stream.on(:data) { |chunk| ... }   # body payload callback
+
+  # fires when client terminates its request (i.e. request finished)
+  stream.on(:half_close) do
+
+    # ... generate_response
+
+    # send response
+    stream.headers({
+      ":status" => 200,
+      "content-type" => "text/plain"
+    })
+
+    # split response between multiple DATA frames
+    stream.data(response_chunk, end_stream: false)
+    stream.data(last_chunk)
+  end
+end
+```
+
+Events emitted by the stream object:
+
+<table>
+  <tr>
+    <td><b>:reserved</b></td>
+    <td>fires exactly once when a push stream is initialized</td>
+  </tr>
+  <tr>
+    <td><b>:active</b></td>
+    <td>fires exactly once when the stream become active and is counted towards the open stream limit</td>
+  </tr>
+  <tr>
+    <td><b>:headers</b></td>
+    <td>fires once for each received header block (multi-frame blocks are reassembled before emitting this event)</td>
+  </tr>
+  <tr>
+    <td><b>:data</b></td>
+    <td>fires once for every DATA frame (no buffering)</td>
+  </tr>
+  <tr>
+    <td><b>:half_close</b></td>
+    <td>fires exactly once when the opposing peer closes its end of connection (e.g. client indicating that request is finished, or server indicating that response is finished)</td>
+  </tr>
+  <tr>
+    <td><b>:close</b></td>
+    <td>fires exactly once when both peers close the stream, or if the stream is reset</td>
+  </tr>
+  <tr>
+    <td><b>:priority</b></td>
+    <td>fires once for each received priority update (server only)</td>
+  </tr>
+</table>
+
+
+### Prioritization
+
+Each HTTP 2.0 [stream has a priority value](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PRIORITIZATION) that can be sent when the new stream is initialized, and optionally reprioritized later:
+
+```ruby
+client = HTTP2::Connection.new(:client)
+
+default_priority_stream = client.new_stream
+custom_priority_stream = client.new_stream(42) # priority: 42
+
+# sometime later: change priority value
+custom_priority_stream.priority = 32000 # emits PRIORITY frame
+```
+
+On the opposite side, the server can optimize its stream processing order or resource allocation by accessing the stream priority value (`stream.priority`).
+
+
+### Flow control
+
+Multiplexing multiple streams over the same TCP connection introduces contention for shared bandwidth resources. Stream priorities can help determine the relative order of delivery, but priorities alone are insufficient to control how the resource allocation is performed between multiple streams. To address this, HTTP 2.0 provides a simple mechanism for [stream and connection flow control](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#_flow_control).
+
+Connection and stream flow control is handled by the library: all streams are initialized with the default window size (64KB), and send/receive window updates are automatically processed - i.e. window is decremented on outgoing data transfers, and incremented on receipt of window frames. Similarly, if the window is exceeded, then data frames are automatically buffered until window is updated.
+
+The only thing left is for your application to specify the logic as to when to emit window updates:
+
+```ruby
+conn.buffered_amount     # check amount of buffered data
+conn.window              # check current window size
+conn.window_update(1024) # increment connection window by 1024 bytes
+
+stream.buffered_amount     # check amount of buffered data
+stream.window              # check current window size
+stream.window_update(2048) # increment stream window by 2048 bytes
+```
+
+Alternatively, flow control can be disabled by emitting an appropriate settings frame on the connection:
+
+```ruby
+conn.settings({
+  settings_max_concurrent_streams: 100, # limit number of concurrent streams
+  settings_flow_control_options: 1      # disable flow control
+})
+```
+
+### Server push
+
+An HTTP 2.0 server can [send multiple replies](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html#HTTP2_PUSH) to a single client request. To do so, first it emits a "push promise" frame which contains the headers of the promised resource, followed by the response to the original request, as well as promised resource payloads (which may be interleaved). A simple example is in order:
+
+```ruby
+conn = HTTP2::Connection.new(:server)
+
+conn.on(:stream) do |stream|
+  stream.on(:headers) { |head| ... }
+  stream.on(:data) { |chunk| ... }
+
+  # fires when client terminates its request (i.e. request finished)
+  stream.on(:half_close) do
+    head = {
+     ":status" => 200,
+     ":path"   => "/other_resource",
+     "content-type" => "text/plain"
+    }
+
+    # initiate server push stream
+    stream.promise(head) do |push|
+      push.headers({ ... })
+      push.data(...)
+    end
+
+    # send response
+    stream.headers({
+      ":status" => 200,
+      "content-type" => "text/plain"
+    })
+
+    # split response between multiple DATA frames
+    stream.data(response_chunk, end_stream: false)
+    promise.data(payload)
+    stream.data(last_chunk)
+  end
+end
+```
+
+When a new push promise stream is sent by the server, the client is notifed via the `:promise` event:
+
+```ruby
+conn = HTTP2::Connection.new(:client)
+conn.on(:promise) do |push|
+  # process push stream
+end
+```
+
+The client can cancel any given push stream (via `.close`), or disable server push entirely by sending the appropriate settings frame (note that below setting only impacts server > client direction):
+
+```ruby
+client.settings({
+  settings_max_concurrent_streams: 0 # set number of server initiated streams to 0 (aka, disable push)
+})
+```
+
+### License
+
+(MIT License) - Copyright (c) 2013 Ilya Grigorik

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => [:spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/example/client.rb

@@ -0,0 +1,46 @@
+require_relative 'helper'
+
+Addrinfo.tcp("localhost", 8080).connect do |sock|
+  conn = HTTP2::Connection.new(:client)
+  conn.on(:frame) do |bytes|
+    puts "Sending bytes: #{bytes.inspect}"
+    sock.print bytes
+    sock.flush
+  end
+
+  stream = conn.new_stream
+  log = Logger.new(stream.id)
+
+  stream.on(:close) do
+   log.info "stream closed"
+   sock.close
+ end
+
+ stream.on(:half_close) do
+  log.info "closing client-end of the stream"
+ end
+
+  stream.on(:headers) do |h|
+    log.info "response headers: #{h}"
+  end
+
+  stream.on(:data) do |d|
+    log.info "response data chunk: <<#{d}>>"
+  end
+
+  puts "Sending POST request"
+  stream.headers({
+    ":method" => "post",
+    ":host" => "localhost",
+    ":path" => "/resource",
+    "accept" => "*/*"
+  })
+
+  stream.data("woot!")
+
+  while !sock.closed? && !sock.eof?
+    data = sock.readpartial(1024)
+    puts "Received bytes: #{data.inspect}"
+    conn << data
+  end
+end

data/example/helper.rb

@@ -0,0 +1,14 @@
+$: << 'lib' << '../lib'
+
+require 'socket'
+require 'http/2'
+
+class Logger
+  def initialize(id)
+    @id = id
+  end
+
+  def info(msg)
+    puts "[Stream #{@id}]: #{msg}"
+  end
+end

data/example/server.rb

@@ -0,0 +1,50 @@
+require_relative 'helper'
+
+puts "Starting server on port 8080"
+Socket.tcp_server_loop(8080) do |sock|
+  puts "New TCP connection!"
+
+  conn = HTTP2::Connection.new(:server)
+  conn.on(:frame) do |bytes|
+    puts "Writing bytes: #{bytes.inspect}"
+    sock.write bytes
+  end
+
+  conn.on(:stream) do |stream|
+    log = Logger.new(stream.id)
+    buffer = ""
+
+    stream.on(:active) { log.info "cliend opened new stream" }
+    stream.on(:close)  { log.info "stream closed" }
+
+    stream.on(:headers) do |h|
+      log.info "request headers: #{h}"
+    end
+
+    stream.on(:data) do |d|
+      log.info "payload chunk: <<#{d}>>"
+      buffer << d
+    end
+
+    stream.on(:half_close) do
+      log.info "client closed its end of the stream, " +
+               "payload size: #{buffer.size}"
+
+      response = "Hello HTTP 2.0! echo: #{buffer}"
+      stream.headers({
+        ":status" => "200",
+        "content-length" => response.bytesize.to_s,
+        "content-type" => "text/plain"
+      }, end_stream: false)
+
+      # split response into multiple DATA frames
+      stream.data(response.slice!(0,5), end_stream: false)
+      stream.data(response)
+    end
+  end
+
+  while !sock.closed? && !sock.eof?
+    data = sock.readpartial(1024)
+    conn << data
+  end
+end

data/http-2.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http/2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "http-2"
+  spec.version       = HTTP2::VERSION
+  spec.authors       = ["Ilya Grigorik"]
+  spec.email         = ["ilya@igvita.com"]
+  spec.description   = "Pure-ruby HTTP 2.0 protocol implementation"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/igrigorik/http-2"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/http/2/buffer.rb

@@ -0,0 +1,21 @@
+module HTTP2
+
+  # Simple binary buffer backed by string.
+  #
+  class Buffer < String
+
+    # Forces binary encoding on the string
+    def initialize(*args)
+      force_encoding('binary')
+      super(*args)
+    end
+
+    # Emulate StringIO#read: slice first n bytes from the buffer.
+    #
+    # @param n [Integer] number of bytes to slice from the buffer
+    def read(n)
+      slice!(0,n)
+    end
+  end
+
+end