http-2 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7bbedd001cf6de0ec84caef4ccd0e4e818315d3
-  data.tar.gz: c1129e49ae319b1cf31151f4e75bf16f0a108e0a
+  metadata.gz: cf205c4c32086ed1a2ec2d784283e7e2c2c983d2
+  data.tar.gz: 272d84cd37cac57b38d391480795b39661fcb20a
 SHA512:
-  metadata.gz: 6c68277cdbc49a1fd695c177e1015334946e4cbba9e93cc2b7b93572b45ab89c61e92ed2638f485c1eafaa2909f1d8a8d0c3ae352743697176b37bf1b27e8be3
-  data.tar.gz: 3357aafb0da7559f22230e8503bd025b4c993ce0fc1dbcc40d078b6b6d0bb5b98b831f40b0d9f53c0358b42939dc7697b72b319ce183975eaaea6e95c092b96a
+  metadata.gz: 338b39a100523327a407abec0cf68586e079290626661e8d39c803dbee7eee1b958d3f70bdcbfb0712d7fd36db0cb315cb729a1704ce8b655485c7b02a2108fb
+  data.tar.gz: d34d0a7325076767c9c36a85319c733268a812968482ff4c81be7533b7467f0a7abfb99ad498bd707dd93a706438ba709b2356554aaa6a34af768290524599b9

data/.rspec

@@ -1,3 +1,4 @@
 autotest
 --color
 --format documentation
+--order rand

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - 'bin/*'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma

data/.rubocop_todo.yml

@@ -0,0 +1,46 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-06 10:04:21 -0700 using RuboCop version 0.30.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 23
+Metrics/AbcSize:
+  Max: 186
+
+# Offense count: 16
+Metrics/BlockNesting:
+  Max: 5
+
+# Offense count: 7
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 331
+
+# Offense count: 12
+Metrics/CyclomaticComplexity:
+  Max: 60
+
+# Offense count: 349
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 231
+
+# Offense count: 27
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 134
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 10
+Metrics/PerceivedComplexity:
+  Max: 46
+
+# Offense count: 7
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,12 @@
+sudo: false
 language: ruby
 rvm:
-  - 2.0.0
-script: bundle exec rake test
+  - 2.1
+  - 2.2
+  - jruby-9.0.0.0
+  - jruby-head
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: rbx-2

data/Gemfile

@@ -4,13 +4,15 @@ gem 'rake'
 gem 'yard'
 
 group :test do
-  gem 'coveralls', :require => false
-  gem 'rspec'
-  gem 'rspec-autotest'
-  gem 'autotest-standalone'
+  gem 'activesupport'
   gem 'autotest-growl'
+  gem 'autotest-standalone'
+  gem 'coveralls', require: false
   gem 'pry'
-  gem 'pry-byebug'
+  gem 'pry-byebug', platform: :mri
+  gem 'rspec'
+  gem 'rspec-autotest'
+  gem 'rubocop', '~> 0.30.0'
 end
 
 gemspec

data/README.md

@@ -5,7 +5,7 @@
 [![Coverage Status](https://coveralls.io/repos/igrigorik/http-2/badge.png)](https://coveralls.io/r/igrigorik/http-2)
 [![Analytics](https://ga-beacon.appspot.com/UA-71196-10/http-2/readme)](https://github.com/igrigorik/ga-beacon)
 
-Pure ruby, framework and transport agnostic implementation of [HTTP 2.0 protocol](http://tools.ietf.org/html/draft-ietf-httpbis-http2) with support for:
+Pure Ruby, framework and transport agnostic, implementation of HTTP/2 protocol and HPACK header compression 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)
@@ -14,12 +14,10 @@ Pure ruby, framework and transport agnostic implementation of [HTTP 2.0 protocol
 * Connection and stream management
 * And more... see [API docs](http://www.rubydoc.info/github/igrigorik/http-2/frames)
 
-Current implementation (see [HPBN chapter for HTTP 2.0 overview](http://chimera.labs.oreilly.com/books/1230000000545/ch12.html)), is based on:
+Protocol specifications:
 
-* [draft-ietf-httpbis-http2-14](http://tools.ietf.org/html/draft-ietf-httpbis-http2-14)
-* [draft-ietf-httpbis-header-compression-09](http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-09)
-
-_Note: the underlying specifications are still evolving, expect APIs to change and evolve also..._
+* [Hypertext Transfer Protocol Version 2 (RFC 7540)](https://httpwg.github.io/specs/rfc7540.html)
+* [HPACK: Header Compression for HTTP/2 (RFC 7541)](https://httpwg.github.io/specs/rfc7541.html)
 
 
 ## Getting started
@@ -30,7 +28,7 @@ $> gem install http-2
 
 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:
+Your code is responsible for feeding data into the parser, which performs all of the necessary HTTP/2 decoding, state management and the rest, and vice versa, the parser will emit bytes (encoded HTTP/2 frames) that you can then route to the destination. Roughly, this works as follows:
 
 ```ruby
 require 'http/2'
@@ -56,7 +54,7 @@ Depending on the role of the endpoint you must initialize either a [Client](http
 server = HTTP2::Server.new
 
 server.on(:stream) { |stream| ... } # process inbound stream
-server.on(:frame)  { |bytes| ... }  # encoded HTTP 2.0 frames
+server.on(:frame)  { |bytes| ... }  # encoded HTTP/2 frames
 
 server.ping { ... } # run liveness check, process pong response
 server.goaway # send goaway frame to the client
@@ -83,42 +81,42 @@ Events emitted by the connection object:
   </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>
+    <td>fires once for every encoded HTTP/2 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).
+A single HTTP/2 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 |
-   `-------------------->|        |<--------------------'
-                         +--------+
+                      +--------+
+                 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:
@@ -188,7 +186,7 @@ Events emitted by the [Stream object](http://www.rubydoc.info/github/igrigorik/h
 
 ### 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:
+Each HTTP/2 [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::Client.new
@@ -205,7 +203,7 @@ On the opposite side, the server can optimize its stream processing order or res
 
 ### 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).
+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 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.
 
@@ -230,7 +228,7 @@ conn.settings(streams: 100, window: Float::INFINITY)
 
 ### 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:
+An HTTP/2 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::Server.new

data/Rakefile

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

data/example/README.md

@@ -30,19 +30,6 @@ $> ruby server.rb
 $> nghttp -vnu http://localhost:8080       # Direct request to Ruby server
 ```
 
-### [node-http2](https://github.com/molnarg/node-http2) (node.js client/server)
-
-```bash
-# NPN + GET request (http-2 > node-http2)
-$> ruby client.rb https://gabor.molnar.es:8080/
-
-# NPN + GET request with server push (http-2 > node-http2)
-$> ruby client.rb https://gabor.molnar.es:8080/test/push.html
-
-# NPN + POST request (http-2 > node-http2)
-$> ruby client.rb https://gabor.molnar.es:8080/post -d'some data'
-```
-
 ### Twitter (Java server)
 
 ```bash

data/example/client.rb

@@ -2,14 +2,13 @@ require_relative 'helper'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: client.rb [options]"
+  opts.banner = 'Usage: client.rb [options]'
 
-  opts.on("-d", "--data [String]", "HTTP payload") do |v|
+  opts.on('-d', '--data [String]', 'HTTP payload') do |v|
     options[:payload] = v
   end
 end.parse!
 
-
 uri = URI.parse(ARGV[0] || 'http://localhost:8080/')
 tcp = TCPSocket.new(uri.host, uri.port)
 sock = nil
@@ -68,19 +67,18 @@ conn.on(:altsvc) do |f|
 end
 
 stream.on(:close) do
-  log.info "stream closed"
+  log.info 'stream closed'
   sock.close
 end
 
 stream.on(:half_close) do
-  log.info "closing client-end of the stream"
+  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
@@ -89,17 +87,16 @@ stream.on(:altsvc) do |f|
   log.info "received ALTSVC #{f}"
 end
 
-
 head = {
-  ":scheme" => uri.scheme,
-  ":method" => (options[:payload].nil? ? "GET" : "POST"),
-  ":authority" => [uri.host, uri.port].join(':'),
-  ":path" => uri.path,
-  "accept" => "*/*"
+  ':scheme' => uri.scheme,
+  ':method' => (options[:payload].nil? ? 'GET' : 'POST'),
+  ':authority' => [uri.host, uri.port].join(':'),
+  ':path' => uri.path,
+  'accept' => '*/*',
 }
 
-puts "Sending HTTP 2.0 request"
-if head[":method"] == "GET"
+puts 'Sending HTTP 2.0 request'
+if head[':method'] == 'GET'
   stream.headers(head, end_stream: true)
 else
   stream.headers(head, end_stream: false)
@@ -112,7 +109,7 @@ while !sock.closed? && !sock.eof?
 
   begin
     conn << data
-  rescue Exception => e
+  rescue => e
     puts "Exception: #{e}, #{e.message} - closing socket."
     sock.close
   end

data/example/helper.rb

@@ -1,4 +1,4 @@
-$: << 'lib' << '../lib'
+$LOAD_PATH << 'lib' << '../lib'
 
 require 'optparse'
 require 'socket'
@@ -6,7 +6,7 @@ require 'openssl'
 require 'http/2'
 require 'uri'
 
-DRAFT = 'h2-14'
+DRAFT = 'h2'
 
 class Logger
   def initialize(id)

data/example/server.rb

@@ -1,14 +1,14 @@
 require_relative 'helper'
 
-options = {port: 8080}
+options = { port: 8080 }
 OptionParser.new do |opts|
-  opts.banner = "Usage: server.rb [options]"
+  opts.banner = 'Usage: server.rb [options]'
 
-  opts.on("-s", "--secure", "HTTPS mode") do |v|
+  opts.on('-s', '--secure', 'HTTPS mode') do |v|
     options[:secure] = v
   end
 
-  opts.on("-p", "--port [Integer]", "listen port") do |v|
+  opts.on('-p', '--port [Integer]', 'listen port') do |v|
     options[:port] = v
   end
 end.parse!
@@ -18,8 +18,8 @@ server = TCPServer.new(options[:port])
 
 if options[:secure]
   ctx = OpenSSL::SSL::SSLContext.new
-  ctx.cert = OpenSSL::X509::Certificate.new(File.open("keys/mycert.pem"))
-  ctx.key = OpenSSL::PKey::RSA.new(File.open("keys/mykey.pem"))
+  ctx.cert = OpenSSL::X509::Certificate.new(File.open('keys/mycert.pem'))
+  ctx.key = OpenSSL::PKey::RSA.new(File.open('keys/mykey.pem'))
   ctx.npn_protocols = [DRAFT]
 
   server = OpenSSL::SSL::SSLServer.new(server, ctx)
@@ -27,7 +27,7 @@ end
 
 loop do
   sock = server.accept
-  puts "New TCP connection!"
+  puts 'New TCP connection!'
 
   conn = HTTP2::Server.new
   conn.on(:frame) do |bytes|
@@ -45,8 +45,8 @@ loop do
     log = Logger.new(stream.id)
     req, buffer = {}, ''
 
-    stream.on(:active) { log.info "cliend opened new stream" }
-    stream.on(:close)  { log.info "stream closed" }
+    stream.on(:active) { log.info 'cliend opened new stream' }
+    stream.on(:close)  { log.info 'stream closed' }
 
     stream.on(:headers) do |h|
       req = Hash[*h.flatten]
@@ -59,36 +59,36 @@ loop do
     end
 
     stream.on(:half_close) do
-      log.info "client closed its end of the stream"
+      log.info 'client closed its end of the stream'
 
       response = nil
-      if req[":method"] == "POST"
+      if req[':method'] == 'POST'
         log.info "Received POST request, payload: #{buffer}"
         response = "Hello HTTP 2.0! POST payload: #{buffer}"
       else
-        log.info "Received GET request"
-        response = "Hello HTTP 2.0! GET request"
+        log.info 'Received GET request'
+        response = 'Hello HTTP 2.0! GET request'
       end
 
       stream.headers({
-        ":status" => "200",
-        "content-length" => response.bytesize.to_s,
-        "content-type" => "text/plain"
+        ':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.slice!(0, 5), end_stream: false)
       stream.data(response)
     end
   end
 
-  while !sock.closed? && !sock.eof?
+  while !sock.closed? && !(sock.eof? rescue true) # rubocop:disable Style/RescueModifier
     data = sock.readpartial(1024)
     # puts "Received bytes: #{data.unpack("H*").first}"
 
     begin
       conn << data
-    rescue Exception => e
+    rescue => e
       puts "Exception: #{e}, #{e.message} - closing socket."
       sock.close
     end