nio4r-websocket 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5209eee6409bb44849b1d3ff55fd1407052dc43933c6bb480a14f7b224808ed4
-  data.tar.gz: 3b0c7fadb007ba93f0b0034e5930d4d0d050b6d1a4c6bcd8e2c134ccb1e21557
+SHA1:
+  metadata.gz: ef260d2997eba2db8dcff293dd847bc51488f477
+  data.tar.gz: 173b08a770153db1e35132edb4c438d530a5455e
 SHA512:
-  metadata.gz: 66c8d050a9d7d492f983a608f906c6624666b79fb35a75789350f254b3cef0a13b6e1d54518d135fa015c2a9d85243505dce53863885ea10b0965ca147261b17
-  data.tar.gz: 1d9ed2d04ac94a8e4be0300234045ac684bf8d0ba50505f7d172d55d35218257a55f661c52de4af6e199057aa7b96e86e76f4ce6952a51e7b1570617fed8b75a
+  metadata.gz: a93ff5fafb1488c319b3cb5b1383639e6a5b47d856fda7dae9ab55cea2a42b46196aaa126061a3ca9f601346dc217d02036895d34d5f7bc415c18f970c3e7920
+  data.tar.gz: 07a552ff14074cd8211bbb47c9a7d493b1eefe0e591165a3439e97788ba2d39e8cbd835d4b799d0e3dbc000c86fcde642ae305f759ed3d7fc9ee554b67015ad1

data/.travis.yml

@@ -1,9 +1,7 @@
-sudo: false
 language: ruby
 rvm:
-- 2.1.0
 - 2.4.3
-- 2.5.0
+- 2.5.1
 - ruby-head
 matrix:
   allow_failures:

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

data/Rakefile

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

data/Vagrantfile

@@ -1,9 +1,9 @@
-Vagrant.configure('2') do |config|
-  config.vm.box = 'ubuntu/trusty64'
-  config.vm.provider 'virtualbox' do |vb|
-    vb.memory = '512'
+Vagrant.configure("2") do |config|
+  config.vm.box = "ubuntu/trusty64"
+  config.vm.provider "virtualbox" do |vb|
+    vb.memory = "512"
   end
-  config.vm.provision 'chef_apply' do |chef|
+  config.vm.provision "chef_apply" do |chef|
     chef.recipe = <<-RECIPE
       apt_update 'update' do
         action :nothing

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require 'bundler/setup'
-require 'nio4r/websocket'
+require "bundler/setup"
+require "nio4r/websocket"
 
-require 'irb'
+require "irb"
 IRB.start(__FILE__)

data/lib/nio/websocket.rb

@@ -1,13 +1,14 @@
-require 'nio/websocket/version'
-require 'websocket/driver'
-require 'nio'
-require 'socket'
-require 'uri'
-require 'openssl'
-require 'logger'
-require 'nio/websocket/reactor'
-require 'nio/websocket/adapter/client'
-require 'nio/websocket/adapter/server'
+require "nio/websocket/version"
+require "websocket/driver"
+require "nio"
+require "socket"
+require "uri"
+require "openssl"
+require "logger"
+require "nio/websocket/reactor"
+require "nio/websocket/adapter/client"
+require "nio/websocket/adapter/server"
+require "nio/websocket/adapter/proxy"
 
 module NIO
   module WebSocket
@@ -16,7 +17,7 @@ module NIO
       # @return [Logger] the current logger instance
       def logger
         @logger ||= begin
-        logger = Logger.new(STDERR, progname: 'WebSocket', level: Logger::ERROR)
+        logger = Logger.new(STDERR, progname: "WebSocket", level: Logger::ERROR)
         logger.level = Logger::ERROR
         logger
       end
@@ -29,7 +30,6 @@ module NIO
       def log_traffic=(enable)
         @log_traffic = enable
         logger.level = Logger::DEBUG if enable
-        enable
       end
 
       # Should raw traffic be logged through the logger?  Disabled by default for security reasons
@@ -58,6 +58,36 @@ module NIO
         adapter.driver
       end
 
+      # Establish a proxy host listening on the given port and address, that marshalls all data to/from a new connection on remote
+      # @param [Hash] options
+      # @param remote [String] remote server in "hostname_or_ip:port" format
+      # @option options [Integer] :port required: Port on which to listen for incoming connections
+      # @option options [String] :address optional: Specific Address on which to bind the TCPServer
+      # @option options [Hash] :ssl_context Hash from which to create the OpenSSL::SSL::SSLContext object
+      # @yield [::WebSocket::Driver]
+      # @return server, as passed in, or a new TCPServer if no server was specified
+      def proxy(remote, options = {})
+        server = create_server(options)
+        host, port, extra = remote.split(":", 3)
+        raise "Specify the remote parameter in 'hostname_or_ip:port' format" if extra || port.to_i == 0 || host.empty?
+        Reactor.queue_task do
+          monitor = Reactor.selector.register(server, :r)
+          monitor.value = proc do
+            accept_socket server, options do |client|
+              srv = open_socket "tcp://#{remote}", options
+              adapter = PROXY_ADAPTER.new(srv, client, options)
+              Reactor.queue_task do
+                adapter.add_to_reactor
+              end
+              logger.info "Proxy connection established between #{srv} and #{client}"
+            end
+          end
+        end
+        logger.info "Proxy Host listening for new connections on port " + options[:port].to_s
+        Reactor.start
+        server
+      end
+
       # Start handling new connections, passing each through the supplied block
       # @param [Hash] options
       # @param server [TCPServer] (DI) TCPServer-like object to use in lieu of starting a new server
@@ -83,16 +113,17 @@ module NIO
           end
         end
         Reactor.start
-        logger.info 'Host listening for new connections on port ' + options[:port].to_s
+        logger.info "Host listening for new connections on port " + options[:port].to_s
         server
       end
 
       SERVER_ADAPTER = NIO::WebSocket::Adapter::Server
       CLIENT_ADAPTER = NIO::WebSocket::Adapter::Client
+      PROXY_ADAPTER = NIO::WebSocket::Adapter::Proxy
 
       # Resets this API to a fresh state
       def reset
-        logger.info 'Resetting reactor subsystem'
+        logger.info "Resetting reactor subsystem"
         Reactor.reset
       end
 
@@ -103,10 +134,10 @@ module NIO
       # return an open socket given the url and options
       def open_socket(url, options)
         uri = URI(url)
-        port = uri.port || (uri.scheme == 'wss' ? 443 : 80) # redundant?  test uri.port if port is unspecified but because ws: & wss: aren't default protocols we'll maybe still need this(?)
+        port = uri.port || (uri.scheme == "wss" ? 443 : 80) # redundant?  test uri.port if port is unspecified but because ws: & wss: aren't default protocols we'll maybe still need this(?)
         logger.debug "Opening Connection to #{uri.hostname} on port #{port}"
         io = TCPSocket.new uri.hostname, port
-        return io unless uri.scheme == 'wss'
+        return io unless uri.scheme == "wss"
         logger.debug "Upgrading Connection #{io} to ssl"
         ssl = upgrade_to_ssl(io, options).connect
         logger.info "Connection #{io} upgraded to #{ssl}"
@@ -121,7 +152,7 @@ module NIO
       def accept_socket(server, options)
         waiting = accept_nonblock server
         if [:r, :w].include? waiting
-          logger.warn 'Expected to receive new connection, but the server is not quite ready'
+          logger.warn "Expected to receive new connection, but the server is not quite ready"
           return
         end
         logger.debug "Receiving new connection #{waiting} on port #{options[:port]}"
@@ -157,11 +188,11 @@ module NIO
       end
 
       def accept_nonblock(io)
-        return io.accept_nonblock
+        io.accept_nonblock
       rescue IO::WaitReadable
-        return :r
+        :r
       rescue IO::WaitWritable
-        return :w
+        :w
       end
 
       def upgrade_to_ssl(io, options)

data/lib/nio/websocket/adapter.rb

@@ -1,12 +1,10 @@
+require "nio/websocket/raw_adapter"
+
 module NIO
   module WebSocket
-    class Adapter
+    class Adapter < RawAdapter
       def initialize(io, driver, options)
-        @inner = io
-        @options = options
         @driver = driver
-        @buffer = ''
-        @mutex = Mutex.new
 
         driver.on :close do |ev|
           WebSocket.logger.info "Driver initiated #{inner} close (code #{ev.code}): #{ev.reason}"
@@ -16,85 +14,27 @@ module NIO
           WebSocket.logger.error "Driver reports error on #{inner}: #{ev.message}"
           close :driver
         end
+
+        super io, options
       end
-      attr_reader :inner, :options, :driver, :monitor
+      attr_reader :driver
 
       def teardown
+        driver.force_state :closed
+        driver.emit :io_error
         @driver = nil # circular reference
-        monitor.close
-        inner.close
+        super
       end
 
       def close(from = nil)
-        return false if @closing
-
-        driver.close if from.nil?
-        @closing = true
-        monitor.interests = :rw
-        Reactor.selector.wakeup
-        true
-      end
-
-      def add_to_reactor
-        @monitor = Reactor.selector.register(inner, :rw) # This can block if this is the main thread and the reactor is busy
-        monitor.value = proc do
-          begin
-            read if monitor.readable?
-            pump_buffer if monitor.writable?
-          rescue Errno::ECONNRESET, EOFError, Errno::ECONNABORTED
-            driver.force_state :closed
-            driver.emit :io_error
-            teardown
-            WebSocket.logger.info "#{inner} socket closed"
-          rescue IO::WaitReadable # rubocop:disable Lint/HandleExceptions
-          rescue IO::WaitWritable
-            monitor.interests = :rw
-          end
-          if @closing
-            if !monitor.readable? && @buffer.empty?
-              teardown
-              WebSocket.logger.info "#{inner} closed"
-            else
-              monitor.interests = :rw unless monitor.closed? # keep the :w interest so that our block runs each time
-              # edge case: if monitor was readable this time, and the write buffer is empty, if we emptied the read buffer this time our block wouldn't run again
-            end
-          end
-        end
+        driver.close if from.nil? && !closing
+        super()
       end
 
       def read
-        data = inner.read_nonblock(16384)
-        if data
-          WebSocket.logger.debug { "Incoming data on #{inner}:\n#{data}" } if WebSocket.log_traffic?
+        super do |data|
           driver.parse data
         end
-        data
-      end
-
-      def write(data)
-        @mutex.synchronize do
-          @buffer << data
-        end
-        return unless monitor
-        pump_buffer
-        Reactor.selector.wakeup unless monitor.interests == :r
-      end
-
-      def pump_buffer
-        @mutex.synchronize do
-          written = 0
-          begin
-            written = inner.write_nonblock @buffer unless @buffer.empty?
-            WebSocket.logger.debug { "Pumped #{written} bytes of data from buffer to #{inner}:\n#{@buffer}" } unless @buffer.empty? || !WebSocket.log_traffic?
-            @buffer = @buffer.byteslice(written..-1) if written > 0
-            WebSocket.logger.debug { "The buffer is now:\n#{@buffer}" } unless @buffer.empty? || !WebSocket.log_traffic?
-          rescue IO::WaitWritable, IO::WaitReadable
-            return written
-          ensure
-            monitor.interests = @buffer.empty? ? :r : :rw
-          end
-          written
-        end
       end
     end
   end

data/lib/nio/websocket/adapter/client.rb

@@ -1,4 +1,4 @@
-require 'nio/websocket/adapter'
+require "nio/websocket/adapter"
 
 module NIO
   module WebSocket

data/lib/nio/websocket/adapter/proxy.rb

@@ -0,0 +1,38 @@
+require "nio/websocket/raw_adapter"
+
+module NIO
+  module WebSocket
+    class Adapter
+      class Proxy
+        def initialize(srv, client, options)
+          @srv_adapter = ProxyAdapter.new srv, options do |data|
+            client_adapter.write data
+          end
+          @client_adapter = ProxyAdapter.new client, options do |data|
+            srv_adapter.write data
+          end
+          WebSocket.logger.debug "Initiating proxy connection between #{srv} and #{client}"
+        end
+        attr_reader :srv_adapter, :client_adapter
+
+        def add_to_reactor
+          srv_adapter.add_to_reactor
+          client_adapter.add_to_reactor
+        end
+      end
+
+      class ProxyAdapter < RawAdapter
+        def initialize(io, options, &block)
+          super io, options
+          @read_event = block
+        end
+
+        def read
+          super do |data|
+            @read_event.call data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nio/websocket/adapter/server.rb

@@ -1,4 +1,4 @@
-require 'nio/websocket/adapter'
+require "nio/websocket/adapter"
 
 module NIO
   module WebSocket
@@ -9,7 +9,7 @@ module NIO
           driver.on :connect do
             if ::WebSocket::Driver.websocket? driver.env
               driver.start
-              WebSocket.logger.debug 'driver connected'
+              WebSocket.logger.debug "driver connected"
             end
           end
           super io, driver, options

data/lib/nio/websocket/raw_adapter.rb

@@ -0,0 +1,87 @@
+module NIO
+  module WebSocket
+    class RawAdapter
+      def initialize(io, options)
+        @inner = io
+        @options = options
+        @buffer = ""
+        @mutex = Mutex.new
+      end
+      attr_reader :inner, :options, :monitor, :closing
+
+      def teardown
+        monitor.close
+        inner.close
+      end
+
+      def close
+        return false if @closing
+
+        @closing = true
+        monitor.interests = :rw
+        Reactor.selector.wakeup
+        true
+      end
+
+      def add_to_reactor
+        @monitor = Reactor.selector.register(inner, :rw) # This can block if this is the main thread and the reactor is busy
+        monitor.value = proc do
+          begin
+            read if monitor.readable?
+            pump_buffer if monitor.writable?
+          rescue Errno::ECONNRESET, EOFError, Errno::ECONNABORTED
+            teardown
+            WebSocket.logger.info "#{inner} socket closed"
+          rescue IO::WaitReadable # rubocop:disable Lint/HandleExceptions
+          rescue IO::WaitWritable
+            monitor.interests = :rw
+          end
+          if @closing
+            if !monitor.readable? && @buffer.empty?
+              teardown
+              WebSocket.logger.info "#{inner} closed"
+            else
+              monitor.interests = :rw unless monitor.closed? # keep the :w interest so that our block runs each time
+              # edge case: if monitor was readable this time, and the write buffer is empty, if we emptied the read buffer this time our block wouldn't run again
+            end
+          end
+        end
+      end
+
+      def read
+        data = inner.read_nonblock(16384)
+        if data
+          WebSocket.logger.debug { "Incoming data on #{inner}:\n#{data}" } if WebSocket.log_traffic?
+          yield data if block_given?
+        end
+        data
+      end
+
+      def write(data)
+        @mutex.synchronize do
+          @buffer << data
+        end
+        return unless monitor
+        pump_buffer
+        Reactor.selector.wakeup unless monitor.interests == :r
+      end
+
+      def pump_buffer
+        @mutex.synchronize do
+          written = 0
+          begin
+            written = inner.write_nonblock @buffer unless @buffer.empty?
+            WebSocket.logger.debug { "Pumped #{written} bytes of data from buffer to #{inner}:\n#{@buffer}" } unless @buffer.empty? || !WebSocket.log_traffic?
+            @buffer = @buffer.byteslice(written..-1) if written > 0
+            WebSocket.logger.debug { "The buffer is now:\n#{@buffer}" } unless @buffer.empty? || !WebSocket.log_traffic?
+          rescue IO::WaitWritable, IO::WaitReadable
+            return written
+          ensure
+            monitor.interests = @buffer.empty? ? :r : :rw
+          end
+          written
+        end
+      end
+    end
+  end
+end

data/lib/nio/websocket/reactor.rb

@@ -1,4 +1,4 @@
-require 'nio'
+require "nio"
 
 module NIO
   module WebSocket
@@ -26,10 +26,10 @@ module NIO
         end
 
         def start
-          WebSocket.logger.debug 'Starting reactor' unless @reactor
+          WebSocket.logger.debug "Starting reactor" unless @reactor
           @reactor ||= Thread.start do
             Thread.current.abort_on_exception = true
-            WebSocket.logger.info 'Reactor started'
+            WebSocket.logger.info "Reactor started"
             begin
               loop do
                 queue = []
@@ -53,7 +53,7 @@ module NIO
                 Thread.pass # give other threads a chance at manipulating our selector (e.g. a new connection on the main thread trying to register)
               end
             rescue => e
-              WebSocket.logger.fatal 'Error occured in reactor subsystem.'
+              WebSocket.logger.fatal "Error occured in reactor subsystem."
               WebSocket.logger.fatal "#{e.class}: #{e.message}"
               e.backtrace.map { |s| WebSocket.logger.fatal "\t#{s}" }
               raise

data/lib/nio/websocket/version.rb

@@ -1,5 +1,5 @@
 module NIO
   module WebSocket
-    VERSION = '0.6.3'.freeze
+    VERSION = "0.7.0".freeze
   end
 end

data/nio4r-websocket.gemspec

@@ -1,30 +1,30 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'nio/websocket/version'
+require "nio/websocket/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'nio4r-websocket'
+  spec.name          = "nio4r-websocket"
   spec.version       = NIO::WebSocket::VERSION
-  spec.authors       = ['Sean Zachariasen']
-  spec.email         = ['thewyzard@hotmail.com']
+  spec.authors       = ["Sean Zachariasen"]
+  spec.email         = ["thewyzard@hotmail.com"]
 
-  spec.summary       = 'websocket-driver implementation built over nio4r'
-  spec.homepage      = 'https://github.com/nexussw/nio4r-websocket'
-  spec.license       = 'MIT'
+  spec.summary       = "websocket-driver implementation built over nio4r"
+  spec.homepage      = "https://github.com/nexussw/nio4r-websocket"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
+  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_dependency 'nio4r', '>= 1.2.1', '< 3.0' # Allow older nio4r, if possible, so as to not lock our ruby version to 2.2.2
-  spec.add_dependency 'websocket-driver', '~> 0.6'
+  spec.add_dependency "nio4r", ">= 1.2.1", "< 3.0" # Allow older nio4r, if possible, so as to not lock our ruby version to 2.2.2
+  spec.add_dependency "websocket-driver", "~> 0.6"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nio4r-websocket
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Sean Zachariasen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nio4r
@@ -120,7 +120,9 @@ files:
 - lib/nio/websocket.rb
 - lib/nio/websocket/adapter.rb
 - lib/nio/websocket/adapter/client.rb
+- lib/nio/websocket/adapter/proxy.rb
 - lib/nio/websocket/adapter/server.rb
+- lib/nio/websocket/raw_adapter.rb
 - lib/nio/websocket/reactor.rb
 - lib/nio/websocket/version.rb
 - nio4r-websocket.gemspec
@@ -144,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: websocket-driver implementation built over nio4r