webtube 1.0.0 → 1.1.0

data/lib/webtube/vital-statistics.rb

@@ -3,20 +3,24 @@ require 'thread'
 require 'webtube'
 
 class Webtube
-  # A tracker for live [[Webtube]] instances and their threads.  This allows a
-  # shutdowning WEBrick to gently close the pending WebSockets.
+  # A tracker for live [[Webtube]] instances and their threads.
+  # This allows a shutdowning WEBrick to gently close the
+  # pending WebSockets.
   class Vital_Statistics
-    # A [[ThreadGroup]] into which the Webtube threads can add themselves.
-    # Note that [[Vital_Statistics]] does not forcefully move them (nor could
-    # it -- a Webtube does not get a thread before [[Webtube#run]] is called,
-    # which is normally _after_ [[Vital_Statistics#birth]] gets called).
+    # A [[ThreadGroup]] into which the Webtube threads can add
+    # themselves.  Note that [[Vital_Statistics]] does not
+    # forcefully move them (nor could it -- a Webtube does not
+    # get a thread before [[Webtube#run]] is called, which is
+    # normally _after_ [[Vital_Statistics#birth]] gets called).
     #
-    # When Webtube is being integrated with WEBrick by [[webtube/webrick.rb]],
-    # assigning Webtube-specific threads into this group will cause WEBrick's
-    # standard shutdown procedure to not try to [[Thread#join]] them as it does
-    # to ordinary WEBrick threads.  Instead, the integration code will call
-    # [[Vital_Statistics#close_all]], to request that each Webtube close
-    # itself, and then join the threads from [[Vital_Statistics#thread_group]].
+    # When Webtube is being integrated with WEBrick by
+    # [[webtube/webrick.rb]], assigning Webtube-specific threads
+    # into this group will cause WEBrick's standard shutdown
+    # procedure to not try to [[Thread#join]] them as it does to
+    # ordinary WEBrick threads.  Instead, the integration code
+    # will call [[Vital_Statistics#close_all]], to request that
+    # each Webtube close itself, and then join the threads from
+    # [[Vital_Statistics#thread_group]].
     attr_reader :thread_group
 
     def initialize logger
@@ -42,24 +46,27 @@ class Webtube
       return
     end
 
-    # Construct a list of all the currently living [[Webtube]] instances.  Note
-    # that while the operation is atomic, the Webtube infrastructure is
-    # inherently multithreaded, so the list can get slightly stale immediately
-    # and should, in most contexts, be considered informative.
+    # Construct a list of all the currently living [[Webtube]]
+    # instances.  Note that while the operation is atomic, the
+    # Webtube infrastructure is inherently multithreaded, so the
+    # list can get slightly stale immediately and should, in
+    # most contexts, be considered informative.
     def to_a
       return @mutex.synchronize{@webtubes.to_a}
     end
     
-    # The default status code in a shutdown situation is 1001 'going away'.
+    # The default status code in a shutdown situation is 1001
+    # 'going away'.
     def close_all status_code = 1001, explanation = ""
-      # Note that we're only mutexing off extracting the content of
-      # [[@webtubes]] (see [[to_a]]).  We can't mutex the whole block, for as
-      # the webtubes will be closing, they'll want to notify us about it, and
-      # that is also mutexed.
+      # Note that we're only mutexing off extracting the content
+      # of [[@webtubes]] (see [[to_a]]).  We can't mutex the
+      # whole block, for as the webtubes will be closing,
+      # they'll want to notify us about it, and that is also
+      # mutexed.
       #
-      # This is not as bad as it may sound, for the webserver shouldn't be
-      # accepting new connections anymore anyway by the time it'll start
-      # closing the old ones.
+      # This is not as bad as it may sound, for the webserver
+      # shouldn't be accepting new connections anymore anyway by
+      # the time it'll start closing the old ones.
       self.to_a.each do |webtube|
         begin
           webtube.close status_code, explanation

data/lib/webtube/webrick.rb

@@ -1,6 +1,7 @@
-# webtube/webrick.rb -- WEBrick integration for Webtube, an implementation of
-# the WebSocket protocol
+# webtube/webrick.rb -- WEBrick integration for Webtube, an
+# implementation of the WebSocket protocol
 
+require 'openssl'
 require 'webrick'
 require 'webrick/httprequest'
 require 'webrick/httpserver'
@@ -21,8 +22,9 @@ module WEBrick
   end
 
   class HTTPServer
-    # Attach a [[Webtube::Vital_Statistics]] to new [[WEBrick::HTTPServer]]
-    # instances so that the live webtubes could be closed upon shutdown
+    # Attach a [[Webtube::Vital_Statistics]] to new
+    # [[WEBrick::HTTPServer]] instances so that the live
+    # webtubes could be closed upon shutdown
 
     alias orig_initialize_before_webtube_integration initialize
     def initialize config = {}, default = Config::HTTP
@@ -35,106 +37,123 @@ module WEBrick
       result = @webtubes
       # Usually, this should be it.
       if result.nil? then # ... but ...
-        # Well, it would seem that our extended constructor was not called.
-        # How could this have happened?
+        # Well, it would seem that our extended constructor was
+        # not called.  How could this have happened?
         result = @webtubes = Webtube::Vital_Statistics.new
-        @logger.warn "@webtubes has not been set up before accessing it.  I " +
-            "have attempted to correct this ex post facto, but doing it now " +
-            "is a race condition, and I may have lost track of some webtubes " +
-            "as a result.  The next time, please load webtube/webrick.rb " +
-            "/before/ instantiating your WEBrick::Server."
+        @logger.warn "@webtubes (in a WEBrick::HTTPServer) " +
+            "has not been set up before accessing it.  I " +
+            "have attempted to correct this ex post facto, " +
+            "but doing it now is a race condition, and I may " +
+            "have lost track of some webtubes as a result.  " +
+            "The next time, please load webtube/webrick.rb " +
+            "/before/ instantiating your WEBrick::HTTPServer."
       end
       return result
     end
 
     alias orig_shutdown_before_webtube_integration shutdown
     def shutdown
-      # We'll need to call the original shutdown code first, for we want to
-      # stop accepting new Webtube connections before 'close all Webtube
-      # connections' will have a proper, thread-safe meaning.
+      # We'll need to call the original shutdown code first, for
+      # we want to stop accepting new Webtube connections before
+      # 'close all Webtube connections' will have a proper,
+      # thread-safe meaning.
       orig_shutdown_before_webtube_integration
       webtubes.close_all
       webtubes.thread_group.list.each &:join
       return
     end
 
-    # Given a [[request]] and a [[response]] object, as prepared by a
-    # [[WEBrick::HTTPServer]] for processing in a portlet, attempt to accept
-    # the client's request to establish a WebSocket connection.  The
-    # [[request]] must actually contain such a request; see
+    # Given a [[request]] and a [[response]] object, as prepared
+    # by a [[WEBrick::HTTPServer]] for processing in a portlet,
+    # attempt to accept the client's request to establish a
+    # WebSocket connection.  The [[request]] must actually
+    # contain such a request; see
     # [[websocket_upgrade_request?]].
     #
-    # The attempt will fail in the theoretical case the client and the server
-    # can't agree on the protocol version to use.  In such a case,
-    # [[accept_webtube]] will prepare a 426 'Upgrade required' response,
-    # explaining in plain text what the problem is and advertising, using the
-    # [[Sec-WebSocket-Version]] header field, the protocol version
-    # (specifically, 13) it is prepared to speak.  When this happens, the
-    # WebSocket session will never be set up and no [[listener]] events will be
-    # called.
+    # The attempt will fail in the theoretical case the client
+    # and the server can't agree on the protocol version to use.
+    # In such a case, [[accept_webtube]] will prepare a 426
+    # 'Upgrade required' response, explaining in plain text what
+    # the problem is and advertising, using the
+    # [[Sec-WebSocket-Version]] header field, the protocol
+    # version (specifically, 13) it is prepared to speak.  When
+    # this happens, the WebSocket session will never be set up
+    # and no [[listener]] events will be called.
     #
-    # Note that [[accept_webtube]] will manipulate [[response]] and return
-    # immediately.  The actual WebSocket session will begin once WEBrick
-    # attempts to deliver the [[response]], and will be marked by the newly
-    # constructed [[Webtube]] instance delivering an [[onopen]] event to
-    # [[listener]].
+    # Note that [[accept_webtube]] will manipulate [[response]]
+    # and return immediately.  The actual WebSocket session will
+    # begin once WEBrick attempts to deliver the [[response]],
+    # and will be marked by the newly constructed [[Webtube]]
+    # instance delivering an [[onopen]] event to [[listener]].
     #
-    # Also note that the loop to process incoming WebSocket frames will hog the
-    # whole thread; in order to deliver asynchronous messages over the
-    # WebSocket, [[Webtube#send_message]] needs to be called from another
-    # thread.  (For synchronous messages, it can safely be called from the
-    # handlers inside [[listener]].)
+    # Also note that the loop to process incoming WebSocket
+    # frames will hog the whole thread; in order to deliver
+    # asynchronous messages over the WebSocket,
+    # [[Webtube#send_message]] needs to be called from another
+    # thread.  (For synchronous messages, it can safely be
+    # called from the handlers inside [[listener]].)
     #
-    # See [[Webtube#run]] for a list of the supported methods for the
-    # [[listener]].
+    # See [[Webtube#run]] for a list of the supported methods
+    # for the [[listener]].
     def accept_webtube request, response, listener,
         session: nil, context: nil
       # Check that the client speaks our version
-      unless (request['Sec-WebSocket-Version'] || '').split(/\s*,\s*/).
+      unless (request['Sec-WebSocket-Version'] || '').
+          strip.split(/\s*,\s*/).
           include? '13' then
         @logger.error "Sec-WebSocket-Version mismatch"
-        response.status, response.reason_phrase = '426', 'Upgrade required'
+        response.status, response.reason_phrase =
+            '426', 'Upgrade required'
         response['Content-type'] = 'text/plain'
         response['Sec-WebSocket-Version'] = '13'
             # advertise the version we speak
-        response.body = "This WebSocket server only speaks version 13 of the " +
-            "protocol, as specified by RFC 6455.\n"
+        response.body = "This WebSocket server only speaks " +
+            "version 13 of the protocol, as specified by " +
+            "RFC 6455.\n"
       else
-        response.status, response.reason_phrase = '101', 'Hello WebSocket'
+        response.status, response.reason_phrase =
+            '101', 'Hello WebSocket'
         response['Upgrade'] = 'websocket'
-        response['Sec-WebSocket-Accept'] = Digest::SHA1.base64digest(
-            request['Sec-WebSocket-Key'] +
-            '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
+        response['Sec-WebSocket-Accept'] =
+            OpenSSL::Digest::SHA1.base64digest(
+                request['Sec-WebSocket-Key'] +
+                '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')
         response['Sec-WebSocket-Version'] = '13'
         response.keep_alive = false
-            # so that WEBrick will close the TCP socket when we're done
+            # so that WEBrick will close the TCP socket when
+            # we're done
         vital_statistics = self.webtubes
         (class << response; self; end).instance_eval do
-          # We'll need to deliver the [[Connection: Upgrade]] header;
-          # unfortunately, HTTPResponse#setup_header would munge it if we set
-          # this header field in the ordinary way.  Accordingly, we'll have to
-          # override the method.
+          # We'll need to deliver the [[Connection: Upgrade]]
+          # header; unfortunately, HTTPResponse#setup_header
+          # would munge it if we set this header field in the
+          # ordinary way.  Accordingly, we'll have to override
+          # the method.
           define_method :setup_header do ||
             super()
             @header['connection'] = 'Upgrade'
             return
           end
 
-          # Replace [[response.send_body]] with the WS engine.  WEBrick will
-          # call it automatically after sending the response header.
+          # Replace [[response.send_body]] with the WS engine.
+          # WEBrick will call it automatically after sending the
+          # response header.
           #
-          # Also notify the server's attached [[Webtube::Vital_Statistics]]
-          # instance so that server shutdown could also close all pending
+          # Also notify the server's attached
+          # [[Webtube::Vital_Statistics]] instance so that
+          # server shutdown could also close all pending
           # Webtubes.
           define_method :send_body do |socket|
-            webtube = Webtube.new(socket, true, close_socket: false)
+            webtube = Webtube.new socket, true,
+                close_socket: false
             begin
               vital_statistics.birth webtube
               webtube.header = request
               webtube.session = session
               webtube.context = context
-              # Reassign us from the WEBrick's thread group to the one
-              # maintained by [[Webtube::Vital_Statistics]].
+              # Reassign us from the WEBrick's thread group to
+              # the one maintained by
+              # [[Webtube::Vital_Statistics]].
               vital_statistics.thread_group.add Thread.current
               # And now, run!
               webtube.run listener
@@ -171,7 +190,8 @@ module WEBrick
               # advertise the version we speak
           # prepare a human-readable content
           response['Content-type'] = 'text/plain'
-          response.body = "426\n\nThis is a WebSocket-only resource."
+          response.body =
+              "426\n\nThis is a WebSocket-only resource.\n"
         end
         return
       end

data/sample-server.rb

@@ -1,9 +1,9 @@
 #! /usr/bin/ruby
 
-# A sample WEBrick server using the Webtube API.  It listens on port 8888 and
-# provides two services: [[/diag]], which logs all the events from
-# [[Webtube#run]] and remains silent towards the client (although note that
-# the Webtube library pongs the pings), and [[/echo]], which echos.
+# A sample WEBrick server using the Webtube API.  It listens
+# on port 8888 and provides two services: [[/diag]], which
+# logs all the events from [[Webtube#run]] and remains silent
+# towards the client, and [[/echo]], which echos.
 
 require 'webrick'
 require 'webtube/webrick'

data/webtube.gemspec

@@ -1,17 +1,17 @@
 Gem::Specification.new do |s|
   s.name = 'webtube'
-  s.version = '1.0.0'
-  s.date = '2014-10-19'
+  s.version = '1.1.0'
+  s.date = '2018-04-26'
   s.homepage = 'https://github.com/digwuren/webtube'
-  s.summary = 'A Ruby implementation of the [[WebSocket]] protocol'
+  s.summary = 'A Ruby implementation of the WebSocket protocol'
   s.author = 'Andres Soolo'
   s.email = 'dig@mirky.net'
   s.files = File.read('Manifest.txt').split(/\n/)
   s.executables << 'wsc'
-  s.license = 'GPL-3'
+  s.license = 'GPL-3.0'
   s.description = <<EOD
-Webtube is an implementation of the [[WebSocket]] protocol for [[Ruby]].  Some
-integration with the [[WEBrick]] server is also included.
+Webtube is an implementation of the WebSocket protocol for Ruby.
+Some integration with the WEBrick server is also included.
 EOD
   s.has_rdoc = false
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: webtube
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Andres Soolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-19 00:00:00.000000000 Z
+date: 2018-04-26 00:00:00.000000000 Z
 dependencies: []
 description: |
-  Webtube is an implementation of the [[WebSocket]] protocol for [[Ruby]].  Some
-  integration with the [[WEBrick]] server is also included.
+  Webtube is an implementation of the WebSocket protocol for Ruby.
+  Some integration with the WEBrick server is also included.
 email: dig@mirky.net
 executables:
 - wsc
@@ -30,7 +30,7 @@ files:
 - webtube.gemspec
 homepage: https://github.com/digwuren/webtube
 licenses:
-- GPL-3
+- GPL-3.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -38,18 +38,18 @@ 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.0.14
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
-summary: A Ruby implementation of the [[WebSocket]] protocol
+summary: A Ruby implementation of the WebSocket protocol
 test_files: []