kontena-websocket-client 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a021faa81b4ccbdf828328d594afa2c4e8f67106
+  data.tar.gz: e2492654a39c665aaa2ec360256ac82b31d50830
+SHA512:
+  metadata.gz: fb510138008dfa603069858a9c1dbb715edce8761d326de6983dfb2851b7559819264ddbbefa09354ff8b335d197d2e93a6d98f875112f97d5d54187a25334d0
+  data.tar.gz: dd61aaba0fbf17c2cbc7d0942e58fbf1749a95716c68c80f87c9fe11666e44c82344c2e84899b6be172bc0729a9224194f29ac73901538b376c4e3b533ba2fd0

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+dist: trusty
+language: ruby
+rvm:
+- 2.1.10
+- 2.2.6
+- 2.3.3
+- 2.4.1
+before_install: gem install bundler -v 1.15.1
+install:
+- bundle install --path vendor/bundle
+script:
+- bundle exec rspec
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Aw06Tbfzg5J2XcdnbI6t5o2Wc04pqybm/7skgLtyMw1H8cmMY+7xglO7GHgz0C+Mp3oXs4NSLbUWoM2vmdL936NtQkv0WV6Zp1Ardkk3wl40m9dPDnhXy2pJoEaC00PFEuMNxAG0PphPwskSXyjzpGqTeohuZSkVER9VaKlWrbdroRlJK2u9XSkTyne9Nk1QJwrO/guCVwHGn+/VgzACE0xNsCoDcyUWxuwz/XZFupWzIrrCGGVnuzOxpY93nBIJmyFM5Va43b2QzvRWex5EmetoMaHAA9NiCa2bzjFauY9z6M93bXHvCipqd2YFb47AsSNVb6U8hVFaWwR+dYs3xN/O3Isil90BagPUHl/JGgq1MCR5qjpsFNY95F1DepRuHolFTxtHVZigJyPRxnb7YtUZUCHNvBYAsGI9l0weRlj3Ucp1sbGlVvxSOvkrIMgM7ii5SG/t6hgYTyahdIlQcNVwG/JE6Ll2IPUIb8ZLFPN4OnFzzWpmnOja4liOqC1N1X9kKKTa9yFmQbdSID+vd3KPn1IBnS2s2amB1ApmAJ64WDTeGw947kXRy+t2Wk/Ux9qXj1RD/JM6dgPZAvrTvGA17T2Z75yHWYtCG99/FJyhn4kCCYLuui1c+DkvieBeMrZrG4S0hzK30gPsQ3K36YH9VJPvyqlCrURvqpiNfkE=
+  gem: kontena-websocket-client
+  on:
+    tags: true
+    repo: kontena/kontena-websocket-client

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kontena-websocket-client.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,190 @@
+Copyright 2017 Kontena, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,136 @@
+[![Build Status](https://travis-ci.org/kontena/kontena-websocket-client.svg?branch=master)](https://travis-ci.org/kontena/kontena-websocket-client)
+
+# Kontena::Websocket::Client
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kontena-websocket-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kontena-websocket-client
+
+## Usage
+
+The high-level `Kontena::Websocket::Client#connect` API uses a synchronous programming model instead of the event-based `on(:event) do ...` model used by the browser WebSockets API:
+
+* The `connect` class method yields the connected `Kontena::Websocket::Client` object
+* The `read` method yields received websocket messages and returns once the websocket is closed
+* The `send` and `close` methods can be called from the `connect` block, the `read` block, or a different thread
+* Any of these functions can also raise `Kontena::Websocket::Error`
+
+```ruby
+require 'kontena-websocket-client'
+
+def websocket_connect
+  Kontena::Websocket::Client.connect(url, options...) do |client|
+    on_open
+
+    client.send(...)
+    client.close(1000)
+
+    client.read do |message|
+      on_message(message)
+    end
+
+    on_close(client.close_code, client.close_reason) # client closed connection
+  end
+rescue Kontena::Websocket::CloseError => exc
+  on_close(exc.code, exc.reason) # server closed connection
+rescue Kontena::Websocket::Error => exc
+  on_error(exc)
+end
+```
+### Environment variables
+
+The library uses the following environment variables:
+
+* `SSL_CERT_FILE`: Default value for `ssl_params: { ca_file: ... }`
+* `SSL_CERT_PATH`: Default value for `ssl_params: { ca_path: ... }`
+
+### Threadsafe
+
+The `Kontena::Websocket::Client` is threadsafe: while a single read thread is blocking on `read`, other threads may safely call `send`, `ping` and `close`.
+
+The `read` block may also call `send`, `ping` and `close`.
+Do not call `read` from multiple threads, or the websocket messages may get corrupted.
+
+The library uses an internal `Mutex` to protect the internal `Websocket::Driver` state, and prevent socket read/write reordering/corruption.
+
+XXX: The `on_pong` callback is called with the mutex held; do not call any client methods from the `on_pong` block.
+
+### Timeouts
+
+The `Kontena::Websocket::Client` uses timeouts (given in `options`) to deal with network errors and not leave the client hanging. Timeouts will raise a descriptive `Kontena::Websocket::TimeoutError` from either the `connect`, `read` or `send/close` methods.
+
+* `connect_timeout` is used for both TCP, SSL `connect` operations
+* `open_timeout` is used for the websocket `open` handshake
+* `write_timeout` is used for each socket `write` operation
+* `ping_timeout` is used for each websocket `ping` request
+
+The `Kontena::Websocket::Client` supports keepalive pings, where the `read` method will send a websocket ping request every `ping_interval` seconds, and raise a `Kontena::Websocket::TimeoutError` if it does not receive a websocket pong response within `ping_timeout` seconds.
+
+### SSL Validation
+
+The `Kontena::Websocket::Client` validates `wss://` server SSL certificates by default, using the OpenSSL APIs to provide useful `Kontena::Websocket::SSLVerifyError` messages. It also provides methods to inspect and validate the server SSL certificates, even when not using strict SSL validation.
+
+Example code and resulting messages:
+
+```ruby
+begin
+  ssl_cert = ws.ssl_cert!
+rescue Kontena::Websocket::SSLVerifyError => ssl_error
+  ssl_cert = ssl_error.cert
+else
+  ssl_error = nil
+end
+
+if ssl_cert && ssl_error
+  $logger.warn "Connected to #{url} with ssl errors: #{ssl_error} (subject #{ssl_cert.subject}, issuer #{ssl_cert.issuer})"
+elsif ssl_error
+  $logger.warn "Connected to #{url} with ssl errors: #{ssl_error}"
+elsif ssl_cert && !ws.ssl_verify?
+  $logger.warn "Connected to #{url} without ssl verify: #{ssl_cert.subject} (issuer #{ssl_cert.issuer})"
+elsif ssl_cert
+  $logger.info "Connected to #{url} with ssl verify: #{ssl_cert.subject} (issuer #{ssl_cert.issuer})"
+else
+  $logger.info "Connected to #{url} without ssl"
+end
+```
+
+* `ERROR -- websocket-echo-client: certificate verify failed: self signed certificate`
+* `WARN -- websocket-echo-client: Connected to wss://localhost:9293 with ssl errors: certificate verify failed: self signed certificate (subject /CN=kontena.test, issuer /CN=kontena.test)`
+* `WARN -- websocket-echo-client: Connected to wss://echo.websocket.org without ssl verify: /OU=Domain Control Validated/CN=*.websocket.org (issuer /C=US/ST=Arizona/L=Scottsdale/O=GoDaddy.com, Inc./OU=http://certs.godaddy.com/repository//CN=Go Daddy Secure Certificate Authority - G2)`
+* `INFO -- websocket-echo-client: Connected to wss://echo.websocket.org with ssl verify: /OU=Domain Control Validated/CN=*.websocket.org (issuer /C=US/ST=Arizona/L=Scottsdale/O=GoDaddy.com, Inc./OU=http://certs.godaddy.com/repository//CN=Go Daddy Secure Certificate Authority - G2)`
+* `INFO -- websocket-echo-client: Connected to ws://echo.websocket.org without ssl`
+
+### Examples
+
+Use `bundle exec ./examples/...` to run the examples.
+
+#### [Websocket Echo Client](./examples/websocket-echo-client.rb)
+
+Connect to a websocket server, displaying the server SSL certificate. Send lines from `stdin`, and write messages to `stdout`. Close on `EOF`.
+
+```
+I, [2017-07-21T17:06:48.353944 #17507]  INFO -- : Connecting to wss://echo.websocket.org...
+I, [2017-07-21T17:06:49.329616 #17507]  INFO -- : Connected to wss://echo.websocket.org with ssl verify: /OU=Domain Control Validated/CN=*.websocket.org (issuer /C=US/ST=Arizona/L=Scottsdale/O=GoDaddy.com, Inc./OU=http://certs.godaddy.com/repository//CN=Go Daddy Secure Certificate Authority - G2)
+hello
+D, [2017-07-21T17:06:50.447423 #17507] DEBUG -- : websocket write: "hello\n"
+D, [2017-07-21T17:06:50.578683 #17507] DEBUG -- : websocket read: "hello\n"
+hello
+D, [2017-07-21T17:06:51.135395 #17507] DEBUG -- : websocket close: EOF
+I, [2017-07-21T17:06:51.375279 #17507]  INFO -- : Client closed connection with code 1000: EOF
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kontena/kontena-websocket-client.

data/Rakefile

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

data/examples/websocket-echo-client.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'logger'
+require 'kontena-websocket-client'
+
+$logger = Logger.new(STDERR)
+$logger.progname = 'websocket-echo-client'
+
+def websocket_echo_writer(ws)
+  while line = $stdin.gets
+    $logger.debug "websocket write: #{line.inspect}"
+    ws.send(line)
+  end
+  $logger.debug "websocket close: EOF"
+
+  ws.close(1000, "EOF")
+end
+
+def websocket_echo_reader(ws)
+  ws.read do |msg|
+    $logger.debug "websocket read: #{msg.inspect}"
+    $stderr.puts msg
+  end
+end
+
+def websocket_echo_client(url, **options)
+  write_thread = nil
+
+  $logger.info "Connecting to #{url}..."
+
+  Kontena::Websocket::Client.connect(url, **options) do |ws|
+    begin
+      ssl_cert = ws.ssl_cert!
+    rescue Kontena::Websocket::SSLVerifyError => ssl_error
+      ssl_cert = ssl_error.cert
+    else
+      ssl_error = nil
+    end
+
+    if ssl_cert && ssl_error
+      $logger.warn "Connected to #{url} with ssl errors: #{ssl_error} (subject #{ssl_cert.subject}, issuer #{ssl_cert.issuer})"
+    elsif ssl_error
+      $logger.warn "Connected to #{url} with ssl errors: #{ssl_error}"
+    elsif ssl_cert && !ws.ssl_verify?
+      $logger.warn "Connected to #{url} without ssl verify: #{ssl_cert.subject} (issuer #{ssl_cert.issuer})"
+    elsif ssl_cert
+      $logger.info "Connected to #{url} with ssl verify: #{ssl_cert.subject} (issuer #{ssl_cert.issuer})"
+    else
+      $logger.info "Connected to #{url} without ssl"
+    end
+
+    write_thread = Thread.new {
+      websocket_echo_writer(ws)
+    }
+
+    websocket_echo_reader(ws)
+
+    $logger.info "Client closed connection with code #{ws.close_code}: #{ws.close_reason}"
+  end
+
+rescue Kontena::Websocket::CloseError => exc
+  $logger.info "#{exc}"
+rescue Kontena::Websocket::Error => exc
+  $logger.error "#{exc}"
+ensure
+  if write_thread
+    write_thread.kill
+    write_thread.join
+  end
+end
+
+url = ARGV[0] || ENV['WEBSOCKET_URL'] || 'wss://echo.websocket.org'
+ssl_verify = ENV['WEBSOCKET_SSL_VERIFY']
+ssl_verify = !ssl_verify.nil? && !ssl_verify.empty?
+
+websocket_echo_client(url,
+  ssl_params: {
+    verify_mode: ssl_verify ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE,
+  },
+)

data/kontena-websocket-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "kontena-websocket-client"
+  spec.version       = '0.0.0'
+  spec.authors       = ["Kontena, Inc"]
+  spec.email         = ["info@kontena.io"]
+
+  spec.summary       = %q{Websocket client library}
+  spec.homepage      = "https://github.com/kontena/kontena-websocket-client"
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "websocket-driver", '~> 0.6.5'
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/kontena/websocket/client/connection.rb

@@ -0,0 +1,119 @@
+# WebSocket::Driver.client(...) API
+class Kontena::Websocket::Client::Connection
+  include Kontena::Websocket::Logging
+
+  # ruby version >= 2.3
+  module Waitable
+    # @param socket [Socket]
+    # @param timeout [Float] default (nil) blocks indefinitely
+    # @raise [Kontena::Websocket::TimeoutError]
+    def wait_socket_readable!(socket, timeout = nil)
+      debug "wait read: timeout=#{timeout}"
+
+      unless @socket.wait_readable(timeout)
+        raise Kontena::Websocket::TimeoutError, "read timeout after #{timeout}s"
+      end
+    end
+
+    # @param socket [Socket]
+    # @param timeout [Float] default (nil) blocks indefinitely
+    # @raise [Kontena::Websocket::TimeoutError]
+    def wait_socket_writable!(socket, timeout = nil)
+      debug "wait write: timeout=#{timeout}"
+
+      unless @socket.wait_writable(timeout)
+        raise Kontena::Websocket::TimeoutError, "write timeout after #{timeout}s"
+      end
+    end
+  end
+
+  # ruby version <= 2.2
+  #
+  # io/wait IO#wait_readable returns nil on EOF
+  module Waitable_Ruby2_2
+    # @param socket [Socket]
+    # @param timeout [Float] default (nil) blocks indefinitely
+    # @raise [Kontena::Websocket::TimeoutError]
+    def wait_socket_readable!(socket, timeout = nil)
+      debug "wait read: timeout=#{timeout}"
+
+      unless IO.select([socket], nil, nil, timeout)
+        raise Kontena::Websocket::TimeoutError, "read timeout after #{timeout}s"
+      end
+    end
+
+    # @param socket [Socket]
+    # @param timeout [Float] default (nil) blocks indefinitely
+    # @raise [Kontena::Websocket::TimeoutError]
+    def wait_socket_writable!(socket, timeout = nil)
+      debug "wait write: timeout=#{timeout}"
+
+      unless IO.select(nil, [socket], nil, timeout)
+        raise Kontena::Websocket::TimeoutError, "write timeout after #{timeout}s"
+      end
+    end
+  end
+
+  if Kontena::Websocket::Client.ruby_version? '2.3'
+    require 'io/wait'
+    include Waitable
+  else
+    include Waitable_Ruby2_2
+  end
+
+  attr_reader :uri
+
+  # @param uri [URI]
+  # @param socket [TCPSocket, OpenSSL::SSL::SSLSocket]
+  # @param write_timeout [Float] per each write syscall
+  def initialize(uri, socket, write_timeout: nil)
+    @uri = uri
+    @socket = socket
+    @write_timeout = write_timeout
+  end
+
+  # @return [String]
+  def url
+    @uri.to_s
+  end
+
+  # Wait up to timeout before retrying any blocking operation.
+  #
+  # @param timeout [Float] default (nil) blocks indefinitely
+  # @raise [Kontena::Websocket::TimeoutError]
+  def nonblocking_timeout(timeout = nil, &block)
+    return yield
+  rescue IO::WaitReadable
+    wait_socket_readable!(@socket, timeout) # raises Kontena::Websocket::TimeoutError
+    retry
+  rescue IO::WaitWritable
+    wait_socket_writable!(@socket, timeout) # raises Kontena::Websocket::TimeoutError
+    retry
+  end
+
+  # @param size [Integer]
+  # @param timeout [Float]
+  # @raise [EOFError]
+  # @return [String] 0..size bytes
+  def read(size, timeout: nil)
+    buf = nonblocking_timeout(timeout) do
+      @socket.read_nonblock(size)
+    end
+
+    debug "read size=#{size}: #buf=#{buf.size}"
+
+    return buf
+  end
+
+  # @param buf [String]
+  def write(buf)
+    until buf.empty?
+      # it can take more than the timeout to write out the entire buffer
+      size = nonblocking_timeout(@write_timeout) do
+        @socket.write_nonblock(buf)
+      end
+      debug "write #buf=#{buf.size}: size=#{size}"
+      buf = buf[size..-1]
+    end
+  end
+end

data/lib/kontena/websocket/client/version.rb

@@ -0,0 +1,13 @@
+class Kontena::Websocket::Client
+  VERSION = "0.0.0"
+
+  # Running ruby >= version?
+  # @param gte_version [String]
+  # @return [Boolean]
+  def self.ruby_version?(gte_version)
+    ruby_version = RUBY_VERSION.split('.').map{|x|x.to_i}
+    gte_version = gte_version.split('.').map{|x|x.to_i}
+
+    return (ruby_version <=> gte_version) >= 0
+  end
+end