net-http2 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10dc650d476227c1a393c90163743402909063f2
+  data.tar.gz: bcbc57dee7a35640a11bc4fd0a237a65a9aa02c3
+SHA512:
+  metadata.gz: 95fca293c965b9f40d39e08664dbdfbb5dcb80b003b790c12d955c3913e7909c8f239c407c2368dff05dc08840819cd414c352e0f19f2de554042d474dabd21b
+  data.tar.gz: a66cc7f54b6ae4400753cfbaf5c5af299bc996fdb0e11680900cc2a1046657b87c31b8f8dd1eadd2be5ba1fbdd6aa26b04bcce52866b0b656b8c258158c18094

data/.gitignore

@@ -0,0 +1,33 @@
+# vim
+.*.sw[a-z]
+*.un~
+Session.vim
+
+# mine
+.idea
+
+# OSX ignores
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+
+._*
+.Spotlight-V100
+.Trashes
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+net-http2

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.0
+
+branches:
+  only:
+    - master

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2016 Roberto Ostinelli.
+
+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,174 @@
+[![Build Status](https://travis-ci.org/ostinelli/net-http2.svg?branch=master)](https://travis-ci.org/ostinelli/net-http2)
+
+# NetHttp2
+
+NetHttp2 is an HTTP2 client for Ruby.
+
+
+## Installation
+Just install the gem:
+
+```
+$ gem install net-http2
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'net-http2'
+```
+
+## Usage
+
+With a blocking call:
+```ruby
+require 'net-http2'
+
+# create a client
+client = NetHttp2::Client.new(uri: "http://106.186.112.116")
+
+# send request
+response = client.get('/')
+
+# read the response
+response.ok?      # => true
+response.status   # => '200'
+response.headers  # => {":status"=>"200"}
+response.body     # => "A body"
+
+# close the connection
+client.close
+```
+
+With a a non-blocking call:
+```ruby
+require 'net-http2'
+
+# create a client
+client = NetHttp2::Client.new(uri: "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"
+
+  # close the connection
+  client.close
+end
+
+# quick & dirty fix to wait for the block to be called asynchronously
+sleep 5
+```
+
+
+## Objects
+
+### `NetHttp2::Client`
+To create a new client:
+
+```ruby
+NetHttp2::Client.new(uri)
+```
+
+#### 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.
+
+ For instance:
+
+  ```ruby
+  certificate = File.read("cert.pem")
+  ctx         = OpenSSL::SSL::SSLContext.new
+  ctx.key     = OpenSSL::PKey::RSA.new(certificate, "cert_password")
+  ctx.cert    = OpenSSL::X509::Certificate.new(certificate)
+
+  NetHttp2::Client.new(uri, ssl_context: ctx)
+  ```
+
+ * **uri** → **`URI`**
+ Returns the URI of the APNS endpoint.
+
+ * **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).
+ Returns `nil` in case a timeout occurs.
+
+  For example:
+
+  ```ruby
+  response_1 = client.get('/path1')
+  response_2 = client.get('/path2', { 'x-custom-header' => 'custom' })
+  response_3 = client.get('/path3', { 'x-custom-header' => 'custom' }, timeout: 1)
+  ```
+
+ * **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).
+ 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).
+ 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).
+ 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).
+ Returns `nil` in case a timeout occurs.
+
+  For example:
+
+  ```ruby
+  client.get('/path1') { |response_1| p response_2 }
+  client.get('/path2', { 'x-custom-header' => 'custom' }) { |response_2| p response_2 }
+  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).
+ 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).
+ 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).
+ Returns `nil` in case a timeout occurs.
+
+
+### `NetHttp2::Response`
+
+#### 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.
+
+
+## Contributing
+So you want to contribute? That's great! Please follow the guidelines below. It will make it easier to get merged in.
+
+Before implementing a new feature, please submit a ticket to discuss what you intend to do. Your feature might already be in the works, or an alternative implementation might have already been discussed.
+
+Do not commit to master in your fork. Provide a clean branch without merge commits. Every pull request should have its own topic branch. In this way, every additional adjustments to the original pull request might be done easily, and squashed with `git rebase -i`. The updated branch will be visible in the same pull request, so there will be no need to open new pull requests when there are changes to be applied.
+
+Ensure to include proper testing. To run tests you simply have to be in the project's root directory and run:
+
+```bash
+$ rake
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "net-http2"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/net-http2.rb

@@ -0,0 +1,13 @@
+require 'net-http2/client'
+require 'net-http2/response'
+require 'net-http2/request/base'
+require 'net-http2/request/delete'
+require 'net-http2/request/get'
+require 'net-http2/request/post'
+require 'net-http2/request/put'
+require 'net-http2/stream'
+require 'net-http2/version'
+
+module NetHttp2
+  raise "Cannot require NetHttp2, unsupported engine '#{RUBY_ENGINE}'" unless RUBY_ENGINE == "ruby"
+end

data/lib/net-http2/client.rb

@@ -0,0 +1,166 @@
+require 'socket'
+require 'openssl'
+require 'uri'
+require 'http/2'
+
+module NetHttp2
+
+  class Client
+    attr_reader :uri
+
+    def initialize(uri, options={})
+      @uri         = URI.parse(uri)
+      @ssl_context = options[:ssl_context] || OpenSSL::SSL::SSLContext.new
+
+      @is_ssl = (@uri.scheme == 'https')
+
+      @pipe_r, @pipe_w = Socket.pair(:UNIX, :STREAM, 0)
+      @socket_thread   = nil
+      @mutex           = Mutex.new
+    end
+
+    def get(path, headers={}, options={})
+      request = NetHttp2::Request::Get.new(@uri, path, headers, options)
+      call_with request
+    end
+
+    def post(path, body, headers={}, options={})
+      request = NetHttp2::Request::Post.new(@uri, path, body, headers, options)
+      call_with request
+    end
+
+    def put(path, body, headers={}, options={})
+      request = NetHttp2::Request::Put.new(@uri, path, body, headers, options)
+      call_with request
+    end
+
+    def delete(path, headers={}, options={})
+      request = NetHttp2::Request::Delete.new(@uri, path, headers, options)
+      call_with request
+    end
+
+    def async_get(path, headers={}, options={}, &block)
+      request = NetHttp2::Request::Get.new(@uri, path, headers, options)
+      async_call_with request, &block
+    end
+
+    def async_post(path, body, headers={}, options={}, &block)
+      request = NetHttp2::Request::Post.new(@uri, path, body, headers, options)
+      async_call_with request, &block
+    end
+
+    def async_put(path, body, headers={}, options={}, &block)
+      request = NetHttp2::Request::Put.new(@uri, path, body, headers, options)
+      async_call_with request, &block
+    end
+
+    def async_delete(path, headers={}, options={}, &block)
+      request = NetHttp2::Request::Delete.new(@uri, path, headers, options)
+      async_call_with request, &block
+    end
+
+    def ssl?
+      @is_ssl
+    end
+
+    def close
+      exit_thread(@socket_thread)
+
+      @h2            = nil
+      @pipe_r        = nil
+      @pipe_w        = nil
+      @socket_thread = nil
+    end
+
+    private
+
+    def call_with(request)
+      ensure_open
+      new_stream.call_with request
+    end
+
+    def async_call_with(request, &block)
+      ensure_open
+      new_stream.async_call_with request, &block
+    end
+
+    def new_stream
+      NetHttp2::Stream.new(uri: @uri, h2_stream: h2.new_stream)
+    end
+
+    def ensure_open
+      return if @socket_thread
+
+      socket = new_socket
+
+      @socket_thread = Thread.new do
+
+        begin
+          thread_loop(socket)
+        ensure
+          socket.close unless socket.closed?
+          @socket_thread = nil
+        end
+      end
+    end
+
+    def thread_loop(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
+
+        ready = IO.select([socket, @pipe_r])
+
+        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
+
+    def new_socket
+      tcp = TCPSocket.new(@uri.host, @uri.port)
+
+      if ssl?
+        socket            = OpenSSL::SSL::SSLSocket.new(tcp, @ssl_context)
+        socket.sync_close = true
+        socket.hostname   = @uri.hostname
+
+        socket.connect
+
+        socket
+      else
+        tcp
+      end
+    end
+
+    def h2
+      @h2 ||= HTTP2::Client.new.tap do |h2|
+        h2.on(:frame) do |bytes|
+          @mutex.synchronize do
+            @pipe_w.write(bytes)
+            @pipe_w.flush
+          end
+        end
+      end
+    end
+
+    def exit_thread(thread)
+      return unless thread && thread.alive?
+      thread.exit
+      thread.join
+    end
+  end
+end

data/lib/net-http2/request/base.rb

@@ -0,0 +1,33 @@
+module NetHttp2
+
+  module Request
+
+    DEFAULT_TIMEOUT = 60
+
+    class Base
+      attr_reader :uri, :path, :body, :timeout
+
+      def initialize(method, uri, path, body, headers, options={})
+        @method  = method
+        @uri     = uri
+        @path    = path
+        @body    = body
+        @headers = headers
+        @timeout = options[:timeout] || DEFAULT_TIMEOUT
+      end
+
+      def headers
+        @headers.merge!({
+          ':scheme'        => @uri.scheme,
+          ':method'        => @method,
+          ':path'          => @path,
+        })
+
+        @headers.merge!('host' => @uri.host) unless @headers['host']
+        @headers.merge!('content-length' => @body.bytesize.to_s) if @body
+
+        @headers
+      end
+    end
+  end
+end

data/lib/net-http2/request/delete.rb

@@ -0,0 +1,12 @@
+module NetHttp2
+
+  module Request
+
+    class Delete < Base
+
+      def initialize(uri, path, headers, options)
+        super('DELETE', uri, path, nil, headers, options)
+      end
+    end
+  end
+end

data/lib/net-http2/request/get.rb

@@ -0,0 +1,12 @@
+module NetHttp2
+
+  module Request
+
+    class Get < Base
+
+      def initialize(uri, path, headers, options)
+        super('GET', uri, path, nil, headers, options)
+      end
+    end
+  end
+end

data/lib/net-http2/request/post.rb

@@ -0,0 +1,12 @@
+module NetHttp2
+
+  module Request
+
+    class Post < Base
+
+      def initialize(uri, path, body, headers, options)
+        super('POST', uri, path, body, headers, options)
+      end
+    end
+  end
+end

data/lib/net-http2/request/put.rb

@@ -0,0 +1,12 @@
+module NetHttp2
+
+  module Request
+
+    class Put < Base
+
+      def initialize(uri, path, body, headers, options)
+        super('PUT', uri, path, body, headers, options)
+      end
+    end
+  end
+end

data/lib/net-http2/response.rb

@@ -0,0 +1,19 @@
+module NetHttp2
+
+  class Response
+    attr_reader :headers, :body
+
+    def initialize(options={})
+      @headers = options[:headers]
+      @body    = options[:body]
+    end
+
+    def status
+      @headers[':status'] if @headers
+    end
+
+    def ok?
+      status == '200'
+    end
+  end
+end

data/lib/net-http2/stream.rb

@@ -0,0 +1,75 @@
+module NetHttp2
+
+  class Stream
+
+    def initialize(options={})
+      @h2_stream = options[:h2_stream]
+      @uri       = options[:uri]
+      @headers   = {}
+      @data      = ''
+      @completed = false
+      @block     = nil
+
+      @h2_stream.on(:headers) do |hs|
+        hs.each { |k, v| @headers[k] = v }
+      end
+
+      @h2_stream.on(:data) { |d| @data << d }
+      @h2_stream.on(:close) { mark_as_completed_and_async_respond }
+    end
+
+    def call_with(request)
+      send_data_of request
+      sync_respond(request.timeout)
+    end
+
+    def async_call_with(request, &block)
+      @block = block
+      send_data_of request
+
+      Thread.new do
+        wait(request.timeout)
+        @block.call(nil) unless @completed
+      end
+    end
+
+    private
+
+    def send_data_of(request)
+      headers = request.headers
+      body    = request.body
+
+      if body
+        @h2_stream.headers(headers, end_stream: false)
+        @h2_stream.data(body, end_stream: true)
+      else
+        @h2_stream.headers(headers, end_stream: true)
+      end
+    end
+
+    def mark_as_completed_and_async_respond
+      @completed = true
+      @block.call(response) if @block
+    end
+
+    def sync_respond(timeout)
+      wait(timeout)
+      response if @completed
+    end
+
+    def response
+      NetHttp2::Response.new(
+        headers: @headers,
+        body:    @data
+      )
+    end
+
+    def wait(timeout)
+      cutoff_time = Time.now + timeout
+
+      while !@completed && Time.now < cutoff_time
+        sleep 0.1
+      end
+    end
+  end
+end

data/lib/net-http2/version.rb

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

data/net-http2.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net-http2/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = "net-http2"
+  spec.version  = NetHttp2::VERSION
+  spec.licenses = ['MIT']
+  spec.authors  = ["Roberto Ostinelli"]
+  spec.email    = ["roberto@ostinelli.net"]
+  spec.summary  = %q{NetHttp2 is an HTTP2 client for Ruby.}
+  spec.homepage = "http://github.com/ostinelli/net-http2"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http-2", "~> 0.8.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: net-http2
+version: !ruby/object:Gem::Version
+  version: 0.7.0
+platform: ruby
+authors:
+- Roberto Ostinelli
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- roberto@ostinelli.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/net-http2.rb
+- lib/net-http2/client.rb
+- lib/net-http2/request/base.rb
+- lib/net-http2/request/delete.rb
+- lib/net-http2/request/get.rb
+- lib/net-http2/request/post.rb
+- lib/net-http2/request/put.rb
+- lib/net-http2/response.rb
+- lib/net-http2/stream.rb
+- lib/net-http2/version.rb
+- net-http2.gemspec
+homepage: http://github.com/ostinelli/net-http2
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: NetHttp2 is an HTTP2 client for Ruby.
+test_files: []