net-http2 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10dc650d476227c1a393c90163743402909063f2
-  data.tar.gz: bcbc57dee7a35640a11bc4fd0a237a65a9aa02c3
+  metadata.gz: f2b511abf99b004afe56dbae182ac4cb4e0436d6
+  data.tar.gz: 3ef6020ae7d52ee3d79f08aef4fbd16ea46351de
 SHA512:
-  metadata.gz: 95fca293c965b9f40d39e08664dbdfbb5dcb80b003b790c12d955c3913e7909c8f239c407c2368dff05dc08840819cd414c352e0f19f2de554042d474dabd21b
-  data.tar.gz: a66cc7f54b6ae4400753cfbaf5c5af299bc996fdb0e11680900cc2a1046657b87c31b8f8dd1eadd2be5ba1fbdd6aa26b04bcce52866b0b656b8c258158c18094
+  metadata.gz: a1b52e03696044abe9b62d4f74ec6bdaf8cdc801c89dd278fcdcf33e2d84efdc17ea7174416c74e68295c2b014406dc54854c4fc795f95b04ff477d63bc136d4
+  data.tar.gz: 49820fe72d72647981e5d08434c6054783b7f69cf0bf8c8b1154ad84f87ba60adf8e6ff52bdb47b43e9b485a1011b240cf7b6a3c7419aa02fbf353c537feb96e

data/README.md

@@ -2,7 +2,7 @@
 
 # NetHttp2
 
-NetHttp2 is an HTTP2 client for Ruby.
+NetHttp2 is an HTTP/2 client for Ruby.
 
 
 ## Installation
@@ -25,7 +25,7 @@ With a blocking call:
 require 'net-http2'
 
 # create a client
-client = NetHttp2::Client.new(uri: "http://106.186.112.116")
+client = NetHttp2::Client.new("http://106.186.112.116")
 
 # send request
 response = client.get('/')
@@ -40,21 +40,21 @@ response.body     # => "A body"
 client.close
 ```
 
-With a a non-blocking call:
+With a non-blocking call:
 ```ruby
 require 'net-http2'
 
 # create a client
-client = NetHttp2::Client.new(uri: "http://106.186.112.116")
+client = NetHttp2::Client.new("http://106.186.112.116")
 
 # send request
 client.async_get('/') do |response|
 
   # read the response
-  p response.ok?      # => true
-  p response.status   # => '200'
-  p response.headers  # => {":status"=>"200"}
-  p response.body     # => "A body"
+  response.ok?      # => true
+  response.status   # => '200'
+  response.headers  # => {":status"=>"200"}
+  response.body     # => "A body"
 
   # close the connection
   client.close
@@ -71,14 +71,15 @@ sleep 5
 To create a new client:
 
 ```ruby
-NetHttp2::Client.new(uri)
+NetHttp2::Client.new(url)
 ```
 
 #### Methods
 
- * **new(uri, options={})** → **`NetHttp2::Client`**
- Returns w new client. `uri` is a `string` such as https://localhost:443.
- The only current option is `:ssl_context`, in case the uri has an https scheme and you want your SSL client to use a custom context.
+ * **new(url, options={})** → **`NetHttp2::Client`**
+
+ Returns a new client. `url` is a `string` such as https://localhost:443.
+ The only current option is `:ssl_context`, in case the url has an https scheme and you want your SSL client to use a custom context.
 
  For instance:
 
@@ -88,14 +89,19 @@ NetHttp2::Client.new(uri)
   ctx.key     = OpenSSL::PKey::RSA.new(certificate, "cert_password")
   ctx.cert    = OpenSSL::X509::Certificate.new(certificate)
 
-  NetHttp2::Client.new(uri, ssl_context: ctx)
+  NetHttp2::Client.new(url, ssl_context: ctx)
   ```
 
  * **uri** → **`URI`**
- Returns the URI of the APNS endpoint.
+
+ Returns the URI of the endpoint.
+
+##### Blocking calls
+These behave similarly to HTTP/1 calls.
 
  * **get(path, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a GET request. This is a blocking call. Options can only specify a `:timeout` (defaults to 60).
+
+ Sends a GET request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
   For example:
@@ -107,19 +113,26 @@ NetHttp2::Client.new(uri)
   ```
 
  * **post(path, body, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a POST request. This is a blocking call. Options can only specify a `:timeout` (defaults to 60).
+
+ Sends a POST request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
  * **put(path, body, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a PUT request. This is a blocking call. Options can only specify a `:timeout` (defaults to 60).
+
+ Sends a PUT request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
  * **delete(path, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a DELETE request. This is a blocking call. Options can only specify a `:timeout` (defaults to 60).
+
+ Sends a DELETE request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
- * **async_get(path, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a GET request. This is a non-blocking call. Options can only specify a `:timeout` (defaults to 60).
+##### Non-blocking calls
+> The API of these calls is still subject to change, as on of HTTP/2 benefits is to allow for the streaming of responses' bodies.
+
+ * **async_get(path, headers={}, options={})** → block called with **`NetHttp2::Response` or `nil`**
+
+ Sends a GET request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
   For example:
@@ -130,16 +143,19 @@ NetHttp2::Client.new(uri)
   client.get('/path3', {}, timeout: 1) { |response_3| p response_3 }
   ```
 
- * **async_post(path, body, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a POST request. This is a non-blocking call. Options can only specify a `:timeout` (defaults to 60).
+ * **async_post(path, body, headers={}, options={})** → block called with **`NetHttp2::Response` or `nil`**
+
+ Sends a POST request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
- * **async_put(path,body, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a PUT request. This is a non-blocking call. Options can only specify a `:timeout` (defaults to 60).
+ * **async_put(path,body, headers={}, options={})** → block called with **`NetHttp2::Response` or `nil`**
+
+ Sends a PUT request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
- * **async_delete(path, headers={}, options={})** → **`NetHttp2::Response` or `nil`**
- Sends a DELETE request. This is a non-blocking call. Options can only specify a `:timeout` (defaults to 60).
+ * **async_delete(path, headers={}, options={})** → block called with **`NetHttp2::Response` or `nil`**
+
+ Sends a DELETE request. Options can only specify a `:timeout` (defaults to 60).
  Returns `nil` in case a timeout occurs.
 
 
@@ -148,15 +164,19 @@ NetHttp2::Client.new(uri)
 #### Methods
 
  * **ok?** → **`boolean`**
+
  Returns if the request was successful.
 
  * **headers** → **`hash`**
+
  Returns a Hash containing the Headers of the response.
 
  * **status** → **`string`**
+
  Returns the status code.
 
  * **body** → **`string`**
+
  Returns the RAW body of the response.
 
 

data/lib/net-http2/client.rb

@@ -5,12 +5,14 @@ require 'http/2'
 
 module NetHttp2
 
+  DRAFT = 'h2'
+
   class Client
     attr_reader :uri
 
-    def initialize(uri, options={})
-      @uri         = URI.parse(uri)
-      @ssl_context = options[:ssl_context] || OpenSSL::SSL::SSLContext.new
+    def initialize(url, options={})
+      @uri         = URI.parse(url)
+      @ssl_context = add_npn_to_context(options[:ssl_context] || OpenSSL::SSL::SSLContext.new)
 
       @is_ssl = (@uri.scheme == 'https')
 
@@ -105,28 +107,24 @@ module NetHttp2
     end
 
     def thread_loop(socket)
+
+      send_before_receiving(socket)
+
       loop do
-        if ssl?
-          available = socket.pending
-          if available > 0
-            data_received = socket.sysread(available)
-            h2 << data_received
-            break if socket.closed?
-          end
-        end
+
+        next if read_if_pending(socket)
 
         ready = IO.select([socket, @pipe_r])
 
+        if ready[0].include?(socket)
+          data_received = socket.readpartial(1024)
+          h2 << data_received
+        end
+
         if ready[0].include?(@pipe_r)
           data_to_send = @pipe_r.read_nonblock(1024)
           socket.write(data_to_send)
         end
-
-        if ready[0].include?(socket)
-          data_received = socket.read_nonblock(1024)
-          h2 << data_received
-          break if socket.closed?
-        end
       end
     end
 
@@ -139,6 +137,7 @@ module NetHttp2
         socket.hostname   = @uri.hostname
 
         socket.connect
+        raise "Failed to negotiate #{DRAFT} via NPN" if socket.npn_protocol != DRAFT
 
         socket
       else
@@ -146,6 +145,27 @@ module NetHttp2
       end
     end
 
+    def send_before_receiving(socket)
+      data_to_send = @pipe_r.read_nonblock(1024)
+      socket.write(data_to_send)
+    rescue IO::WaitReadable
+      IO.select([@pipe_r])
+      retry
+    end
+
+    def read_if_pending(socket)
+      if ssl?
+        available = socket.pending
+
+        if available > 0
+          data_received = socket.sysread(available)
+          h2 << data_received
+
+          true
+        end
+      end
+    end
+
     def h2
       @h2 ||= HTTP2::Client.new.tap do |h2|
         h2.on(:frame) do |bytes|
@@ -157,6 +177,14 @@ module NetHttp2
       end
     end
 
+    def add_npn_to_context(ctx)
+      ctx.npn_protocols = [DRAFT]
+      ctx.npn_select_cb = lambda do |protocols|
+        DRAFT if protocols.include?(DRAFT)
+      end
+      ctx
+    end
+
     def exit_thread(thread)
       return unless thread && thread.alive?
       thread.exit

data/lib/net-http2/version.rb

@@ -1,3 +1,3 @@
 module NetHttp2
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-http2
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Roberto Ostinelli
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2