h2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b533a3c1702ec83aad19b84c16dcb97badbc669b
-  data.tar.gz: e8adb1f561a47a3970d1bed94b276b26220798e5
+  metadata.gz: 7026103d2e280847900dbd974196250ef62d1ba0
+  data.tar.gz: df6cd50fb58732f2256aa90c85d36a6d8d9cb6c3
 SHA512:
-  metadata.gz: c948d743e1a8923c0cfc7e87564aedb6e16fbf27173859aa1fd6316e900adf05e661f223e243b2604c611685fc5280e9984c4d25a5f6053c17862af9d31db9e5
-  data.tar.gz: bbd51fcf78448aeb6636dc55d0cc22f188c5a44517a4887e01db8d0936efa10133d65c6637237463413224f1d79fbc2c9b2c71b01f22d5ee188ef4c98055f1ae
+  metadata.gz: af9a7b61585c3b9a0dc9f4fca518dd7516a57db3ac7299969c95b9790c7e3de965a83b63391fcba731079ef88db30dacabb872e1c05573b2077dc0db3a660c0a
+  data.tar.gz: 54ad799634b7cc747cdfa0cf2cf9b42324f67464bcfd941bb86bd7b118d4d44975aab518ab4d558be0d0f54d79a76a4e63e55a9e0b86b7b2e520d3e84310d866

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+h2 changelog
+============
+
+### 0.2.0 7 mar 2017
+
+* add concurrency alternates
+
+### 0.1.1 -
+
+* removed extra rescue/ensure in H2::Client#read
+
+### 0.1.0 - 30 dec 2016
+
+* initial release
+* seems to work! :)

data/Gemfile

@@ -1,9 +1,17 @@
 source 'https://rubygems.org'
 
-gem 'http-2', git: 'https://github.com/igrigorik/http-2'
+gem 'http-2', git: 'https://github.com/kenichi/http-2', branch: 'stream_close_state'
 
 gemspec
 
+group :concurrent_ruby do
+  gem 'concurrent-ruby'
+end
+
+group :celluloid do
+  gem 'celluloid'
+end
+
 group :development, :test do
   gem 'awesome_print'
   gem 'pry-byebug'

data/README.md

@@ -1,12 +1,11 @@
 # H2
 
-[![Build Status](https://travis-ci.org/kenichi/h2.png?branch=master)](https://travis-ci.org/kenichi/h2)
+[![Build Status](https://travis-ci.org/kenichi/h2.svg?branch=master)](https://travis-ci.org/kenichi/h2)
 
-H2 is a basic HTTP/2 client based on the [http-2](https://github.com/igrigorik/http-2) gem.
+H2 is a basic, _experimental_ HTTP/2 client based on the [http-2](https://github.com/igrigorik/http-2) gem.
 
-H2 currently uses:
+H2 uses:
 
-* one new thread per client (see [TODO](#TODO) item 3)
 * keyword arguments (>=2.0)
 * exception-less socket IO (>=2.3).
 
@@ -70,17 +69,65 @@ end
 client.goaway!
 ```
 
+## CLI
+
+For more info on using the CLI `h2` installed with this gem:
+
+`$ h2 --help`
+
+## Alternate Concurrency Models
+
+Right now, h2 uses one new thread per connection. This is hardly ideal, so a
+couple other models are tentatively supported out of the box:
+
+* [celluloid](https://github.com/celluloid/celluloid)
+* [concurrent-ruby](https://github.com/ruby-concurrency/concurrent-ruby)
+
+Neither of these gems are hard dependencies. If you want to use either one, you must
+have it available to your Ruby VM, most likely via Bundler, *and* require the
+sub-component of h2 that will prepend and extend `H2::Client`. They are also intended
+to be mutually exclusive: you can have both in your VM, but you can only use one at a
+time with h2.
+
+#### Celluloid Pool
+
+To use a celluloid actor pool for reading from `H2::Client` connections:
+
+```ruby
+require 'h2/client/celluloid'
+```
+
+This will lazily fire up a celluloid pool, with defaults defined by Celluloid.
+
+#### Concurrent-Ruby ThreadPoolExecutor
+
+To use a concurrent-ruby thread pool executor for reading from `H2::Client` connections:
+
+```ruby
+require 'h2/client/concurrent'
+```
+
+This will lazily fire up a `Concurrent::ThreadPoolExecutor` with the following settings:
+
+```ruby
+procs = ::Concurrent.processor_count
+
+min_threads: 0,
+max_threads: procs,
+max_queue:   procs * 5
+```
+
 ## TODO
 
 * [x] HTTPS / TLS
-* [ ] push promise cancellation
-* [ ] alternate concurrency models
+* [x] push promise cancellation
+* [x] alternate concurrency models
+* [ ] fix up CLI to be more curlish
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kenichi/h2. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -4,5 +4,22 @@ require 'bundler/setup'
 require 'h2'
 require 'irb'
 
-Bundler.require :development
+#Bundler.require :development
+
+def trunc_payload f
+  x = f.dup
+  size = x[:payload]&.to_s&.bytesize || 0
+  x[:payload] = "#{size} redacted" if size > 64
+  x
+end
+
+def new_client
+  # H2::Client.new url: 'https://127.0.0.1:4430', tls: { ca_file: '/Users/ken/src/ruby/other_reel/tmp/certs/ca.crt' } do |client|
+  # H2::Client.new url: 'http://127.0.0.1:1234' do |client|
+  H2::Client.new url: 'https://vux.nakamura.io:4430', tls: { ca_file: '/usr/local/etc/cacert-201611290415.pem' } do |client|
+    client.client.on(:frame_sent){|f| STDERR.puts ">> #{trunc_payload(f).inspect}"}
+    client.client.on(:frame_received){|f| STDERR.puts "<< #{trunc_payload(f).inspect}"}
+  end
+end
+
 IRB.start

data/exe/h2

@@ -22,6 +22,7 @@ end # }}}
 options = {
   body: nil,
   block: false,
+  debug: false,
   headers: {},
   goaway: false,
   method: nil,
@@ -52,7 +53,7 @@ OptionParser.new do |o|
   end
 
   o.on '-g', '--goaway', 'send GOAWAY frame when stream is complete' do
-    options[:debug] = true
+    options[:goaway] = true
   end
 
   o.on '-v', '--verbose', 'turn on verbosity' do
@@ -65,6 +66,7 @@ OptionParser.new do |o|
     options[:method] = meth
   end
 
+
 end.parse!
 
 options[:method] ||= :get

data/lib/h2/client/celluloid.rb

@@ -0,0 +1,33 @@
+require 'celluloid/current'
+require 'h2'
+
+module H2
+  class Client
+    module Celluloid
+
+      class Reader
+        include ::Celluloid
+
+        def read client, maxlen = DEFAULT_MAXLEN
+          client._read maxlen
+        end
+      end
+
+      module ClassMethods
+        def thread_pool
+          @thread_pool ||= Reader.pool
+        end
+      end
+
+      def read maxlen = DEFAULT_MAXLEN
+        self.class.thread_pool.async.read self
+      end
+
+    end
+
+    extend H2::Client::Celluloid::ClassMethods
+    prepend H2::Client::Celluloid
+  end
+end
+
+

data/lib/h2/client/concurrent.rb

@@ -0,0 +1,34 @@
+require 'concurrent'
+require 'h2'
+
+module H2
+  class Client
+    module Concurrent
+
+      module ClassMethods
+        def thread_pool
+          procs = ::Concurrent.processor_count
+          @thread_pool ||= ::Concurrent::ThreadPoolExecutor.new min_threads: 0,
+                                                                max_threads: procs,
+                                                                max_queue:   procs * 5
+        end
+      end
+
+      def read maxlen = DEFAULT_MAXLEN
+        main = Thread.current
+        @reader = self.class.thread_pool.post do
+          begin
+            _read maxlen
+          rescue => e
+            main.raise e
+          end
+        end
+      end
+
+    end
+
+    extend H2::Client::Concurrent::ClassMethods
+    prepend H2::Client::Concurrent
+  end
+end
+

data/lib/h2/client.rb

@@ -13,11 +13,6 @@ module H2
       :promise
     ]
 
-    PROMISE_EVENTS = [
-      :headers,
-      :data
-    ]
-
     ALPN_PROTOCOLS = ['h2']
     DEFAULT_MAXLEN = 4096
 
@@ -112,17 +107,16 @@ module H2
         METHOD_KEY    => method.to_s.upcase,
         PATH_KEY      => path,
         SCHEME_KEY    => @scheme
-      }
+      }.merge USER_AGENT
       h.merge! stringify_headers(headers)
     end
 
     def add_stream method:, path:, stream:, &block
-      stream_id = stream.id
       @streams[method] ||= {}
       @streams[method][path] ||= []
       stream = Stream.new client: self, stream: stream, &block unless Stream === stream
       @streams[method][path] << stream
-      @streams[stream_id] = stream
+      @streams[stream.id] = stream
       stream
     end
 
@@ -143,12 +137,6 @@ module H2
           main.raise e
         end
       end
-    rescue => e
-      STDERR.puts "#{e.message} - closing socket"
-      STDERR.puts e.backtrace.map {|l| "\t" + l}
-      close
-    ensure
-      unblock!
     end
 
     def _read maxlen = DEFAULT_MAXLEN
@@ -214,18 +202,18 @@ module H2
     end
 
     def on_promise promise
-      on :promise, promise
-
-      Stream.new client: self,
-                 parent: @streams[promise.parent.id],
-                 push: true,
-                 stream: promise do |p|
+      push_promise = Stream.new client: self,
+                                parent: @streams[promise.parent.id],
+                                push: true,
+                                stream: promise do |p|
         p.on :close do
           method = p.headers[METHOD_KEY].downcase.to_sym rescue :error
           path = p.headers[PATH_KEY]
           add_stream method: method, path: path, stream: p
         end
       end
+
+      on :promise, push_promise
     end
 
     # ---

data/lib/h2/stream.rb

@@ -49,8 +49,8 @@ module H2
     end
 
     def cancel!
-      unblock!
       @stream.cancel
+      unblock!
     end
 
     def block! timeout = nil

data/lib/h2/version.rb

@@ -1,3 +1,3 @@
 module H2
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/h2.rb

@@ -3,6 +3,8 @@
 require 'http/2'
 require 'uri'
 
+require 'h2/version'
+
 module H2
 
   # http/2 psuedo-headers
@@ -13,6 +15,10 @@ module H2
   SCHEME_KEY    = ':scheme'
   STATUS_KEY    = ':status'
 
+  USER_AGENT = {
+    'user-agent' => "h2/#{H2::VERSION} #{RUBY_ENGINE}-#{RUBY_VERSION}/#{RUBY_PLATFORM}"
+  }
+
   REQUEST_METHODS = [
     :get,
     :delete,
@@ -92,4 +98,3 @@ end
 
 require 'h2/client'
 require 'h2/stream'
-require 'h2/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kenichi Nakamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-31 00:00:00.000000000 Z
+date: 2017-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http-2
@@ -96,6 +96,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -106,6 +107,8 @@ files:
 - h2.gemspec
 - lib/h2.rb
 - lib/h2/client.rb
+- lib/h2/client/celluloid.rb
+- lib/h2/client/concurrent.rb
 - lib/h2/client/tcp_socket.rb
 - lib/h2/stream.rb
 - lib/h2/version.rb
@@ -129,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: an http/2 client based on http-2 and modern ruby