websocket-server 1.0.1-java → 1.1.2-java

data/lib/websocket/idle_handler.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
@@ -23,6 +23,7 @@ module WebSocket
   # server pipeline.
   class IdleHandler < WebSocket::IdleStateUserEventHandler
     def initialize
+      # Include additional subclass initialization here.
       super()
     end
 

data/lib/websocket/idle_state_user_event_handler.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 

data/lib/websocket/instance_methods.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
@@ -63,36 +63,24 @@ module WebSocket
     # rubocop: disable Metrics/AbcSize
     # rubocop: disable Metrics/MethodLength
     def run(params = {})
-      options.merge!(params)
+      @options.merge!(params)
       channel = bootstrap.bind(port).sync().channel()
       channel_group.add(channel)
       ::WebSocket::ShutdownHook.new(self)
       log.info "Listening on #{channel.local_address}"
       channel.closeFuture().sync()
     rescue java.net.BindException => e
-      raise "Bind error: #{e.message}: #{options[:host]}:#{port}"
+      raise "Bind error: #{e.message}: #{@options[:host]}:#{port}"
     rescue java.net.SocketException => e
-      raise "Socket error: #{e.message}: #{options[:host]}:#{port}"
+      raise "Socket error: #{e.message}: #{@options[:host]}:#{port}"
     ensure
       stop
     end
     # rubocop: enable Metrics/AbcSize
     # rubocop: enable Metrics/MethodLength
 
-    IntegerPattern = /^\d+$/.freeze
-
-    def valid_port?(val)
-      IntegerPattern.match?(val.to_s) && val.positive? && val < 65_536
-    end
-
-    def given_port
-      value = (options[:ssl] ? options[:ssl_port] : options[:port]).to_i
-      raise 'Given port parameter is invalid' unless valid_port?(value)
-      value
-    end
-
     def port
-      @port ||= given_port
+      @port ||= (@options[:ssl] ? @options[:ssl_port] : @options[:port]).to_i
     end
 
     def shutdown
@@ -109,8 +97,8 @@ module WebSocket
       channel_initializer.handlers << handler
     end
 
-    def add_listener(listener)
-      channel_initializer.add_listener(listener)
+    def add_listener(*listener)
+      channel_initializer.add_listener(*listener)
     end
 
     # def all_exist?(*files)

data/lib/websocket/listenable.rb

@@ -6,36 +6,14 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
-require 'java'
-
 # The WebSocket module
 module WebSocket
   # The Listenable module
   module Listenable
-    def listeners
-      @listeners ||= java.util.concurrent.CopyOnWriteArrayList.new
-    end
-
-    def add_listener(listener)
-      listeners << listener
-    end
-
-    def remove_listener(listener)
-      listeners.delete(listener)
-    end
-
-    def notify(message, *args)
-      return if listeners.empty?
-      log.trace "Notifying listeners (#{listeners}) of message: #{message}"
-      listeners.each do |listener|
-        listener.send(message.to_sym, *args) if listener.respond_to?(message.to_sym)
-      end
-    end
+    include ::Server::Listenable
   end
-  # module Listenable
 end
-# module WebSocket

data/lib/websocket/message_handler.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 

data/lib/websocket/response_helpers.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
@@ -26,13 +26,13 @@ module WebSocket
 
   # The ResponseHelpers helpers
   module ResponseHelpers
-    NonSpacesBeforeEOLPattern = %r{([^\s]+)$}.freeze
+    NON_SPACES_BEFORE_EOL_PATTERN = %r{([^\s]+)$}
 
     def index_listing(path)
       results = `ls -la #{path}`.strip.split("\n")
       results.shift
       index = results.collect do |s|
-        s.gsub(NonSpacesBeforeEOLPattern) do |resource_name|
+        s.gsub(NON_SPACES_BEFORE_EOL_PATTERN) do |resource_name|
           %(<a href="#{resource_name}">#{resource_name}</a>)
         end
       end.join '<br />'

data/lib/websocket/server.rb

@@ -6,12 +6,10 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
-require 'java'
-require 'netty'
 require 'tcp-server'
 
 require_relative 'instance_methods'

data/lib/websocket/shutdown_hook.rb

@@ -6,12 +6,11 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
 require 'java'
-require 'netty'
 
 # The WebSocket module
 module WebSocket

data/lib/websocket/ssl_cipher_inspector.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
@@ -22,6 +22,7 @@ module WebSocket
   # cipher configuration and pipeline handling of SSL handshakes.
   class SslCipherInspector < SimpleChannelInboundHandler
     def initialize
+      # Include additional subclass initialization here.
       super()
     end
 

data/lib/websocket/ssl_context_initialization.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 

data/lib/websocket/telnet_proxy.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 

data/lib/websocket/validation_helpers.rb

@@ -6,41 +6,37 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
-require 'java'
-require 'netty'
-
 require_relative 'encoding'
 
 # The WebSocket module
 module WebSocket
   # The ValidationHelpers module
   module ValidationHelpers
-    FileSeparatorDotPattern = %r{#{File::SEPARATOR}\.}.freeze
-    DotFileSeparatorPattern = %r{\.#{File::SEPARATOR}}.freeze
+    FILE_SEPARATOR_DOT_PATTERN = %r{#{File::SEPARATOR}\.}
+    DOT_FILE_SEPARATOR_PATTERN = %r{\.#{File::SEPARATOR}}
+    QUERY_STRING_PATTERN = %r{\?.*}
+    FORWARD_SLASH_PATTERN = %r{/}
 
     # Simplistic dumb security check.
     # Something more serious is required in a production environment.
     def insecure_uri?(uri)
-      FileSeparatorDotPattern.match?(uri) ||
-        DotFileSeparatorPattern.match?(uri) ||
+      FILE_SEPARATOR_DOT_PATTERN.match?(uri) ||
+        DOT_FILE_SEPARATOR_PATTERN.match?(uri) ||
         uri.start_with?('.') ||
         uri.end_with?('.') ||
         options[:insecure_uri_pattern].match?(uri)
     end
 
-    QueryStringPattern = %r{\?.*}.freeze
-    ForwardSlashPattern = %r{/}.freeze
-
     def sanitize_uri(uri)
       # Decode the path.
-      uri = CGI.unescape(uri.gsub(QueryStringPattern, ''), WebSocket::Encoding.name)
+      uri = CGI.unescape(uri.gsub(QUERY_STRING_PATTERN, ''), WebSocket::Encoding.name)
       return nil if uri.empty? || !uri.start_with?('/')
       # Convert file separators.
-      uri = uri.gsub(ForwardSlashPattern, File::SEPARATOR)
+      uri = uri.gsub(FORWARD_SLASH_PATTERN, File::SEPARATOR)
       return nil if insecure_uri?(uri)
       # Convert to absolute path.
       File.join(options[:web_root], uri)

data/lib/websocket/version.rb

@@ -6,11 +6,11 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
 # The WebSocket module
 module WebSocket
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.2'.freeze
 end

data/lib/websocket-server.rb

@@ -6,7 +6,7 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 

data/lib/websocket_client.rb

@@ -8,16 +8,16 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
+require 'java'
 require 'optparse'
 
-require 'java'
 require 'netty'
 
-require 'log'
+require_relative 'logging'
 
 # Simple websocket client ported from the example from Netty-io.
 
@@ -260,23 +260,32 @@ module WebSocket
       @listeners ||= java.util.concurrent.CopyOnWriteArrayList.new
     end
 
-    def add_listener(listener)
-      listeners << listener
+    def add_listener(*listener)
+      listeners.addAll(listener)
+    ensure
+      log.trace "Listeners: #{listeners}"
+    end
+
+    def remove_listener(*listener)
+      listeners.removeAll(listener)
     end
 
-    def remove_listener(listener)
-      listeners.delete(listener)
+    def replace_listeners(*listener)
+      listeners.clear
+      add_listener(*listener)
     end
 
-    def notify(message, *args)
-      return if listeners.empty?
-      log.trace "Notifying listeners (#{listeners}) of message: #{message}"
+    def notify(event, *args)
       listeners.each do |listener|
-        listener.send(message.to_sym, *args) if listener.respond_to?(message.to_sym)
+        next unless listener.respond_to?(event.to_sym)
+        log.trace "Notifying listener #{listener} of event: #{event}"
+        listener.send(event.to_sym, *args)
       end
     end
   end
+  # module Listenable
 end
+# module WebSocket
 
 # The WebSocket module
 module WebSocket
@@ -326,7 +335,6 @@ module WebSocket
     end
 
     def exceptionCaught(ctx, cause)
-      log.info "##{__method__} wtf1"
       cause.printStackTrace()
       @handshake_future.setFailure(cause) unless @handshake_future.isDone()
       ctx.close()
@@ -424,10 +432,8 @@ module WebSocket
       session
     end
 
-    IdentiferTemplate = '#<%<class>s:0x%<id>s>'.freeze
-
     def to_s
-      format(IdentiferTemplate, class: self.class.name, id: object_id.to_s(16))
+      format('#<%<class>s:0x%<id>s>', class: self.class.name, id: object_id.to_s(16))
     end
     alias inspect to_s
   end
@@ -436,31 +442,69 @@ end
 
 # The WebSocket module
 module WebSocket
-  # rubocop: disable Metrics/AbcSize
-  # rubocop: disable Metrics/MethodLength
-  def parse_arguments(options = ::WebSocket.client_config.dup)
-    parser = OptionParser.new
-    parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
-    parser.separator ''
-    parser.separator 'Options:'
-    parser.on_head('-u', '--uri=<uri>', 'Fully qualified connection string') do |v|
-      options[:uri] = java.net.URI.new(v)
-    end
-    parser.on_tail('-v', '--verbose', 'Increase verbosity') { options[:log_level] -= 1 }
-    parser.on_tail('-?', '--help', 'Show this message') do
-      puts parser
-      exit
-    end
-    parser.on_tail('--version', 'Show version') do
-      puts "#{$PROGRAM_NAME} version #{::WebSocket.version}"
-      exit
-    end
-    parser.parse!
-    options
+  # The ArgumentsParser class
+  class ArgumentsParser
+    attr_reader :parser, :options
+
+    def initialize(parser = OptionParser.new, options = ::WebSocket.client_config.dup)
+      @parser = parser
+      @options = options
+      @flags = %i[banner uri log_level help version]
+      @flags.each { |method_name| method(method_name)&.call if respond_to?(method_name) }
+    end
+
+    def banner
+      @parser.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+      @parser.separator ''
+      @parser.separator 'Options:'
+    end
+
+    def uri
+      @parser.on_head('-u', '--uri=<uri>', 'Fully qualified connection string') do |v|
+        @options[:uri] = java.net.URI.new(v)
+      end
+    end
+
+    def log_level
+      @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
+        @options[:log_level] ||= 0
+        @options[:log_level] -= 1
+      end
+    end
+
+    def help
+      @parser.on_tail('-?', '--help', 'Show this message') do
+        puts @parser
+        exit
+      end
+    end
+
+    def version
+      @parser.on_tail('--version', 'Show version') do
+        puts "#{File.basename($PROGRAM_NAME)} version #{::WebSocket::VERSION}"
+        exit
+      end
+    end
   end
-  # rubocop: enable Metrics/AbcSize
-  # rubocop: enable Metrics/MethodLength
+  # class ArgumentsParser
+
+  def parse_arguments(arguments_parser = ArgumentsParser.new)
+    arguments_parser.parser.parse!(ARGV)
+    arguments_parser.parse_positional_arguments!
+    arguments_parser.options
+  rescue OptionParser::InvalidArgument, OptionParser::InvalidOption,
+         OptionParser::MissingArgument, OptionParser::NeedlessArgument => e
+    puts e.message
+    puts parser
+    exit
+  rescue OptionParser::AmbiguousOption => e
+    abort e.message
+  end
+end
+# module WebSocket
 
+# The WebSocket module
+module WebSocket
   def main(args = parse_arguments)
     Logging.log_level = args[:log_level]
     ::WebSocket::Client.new(args)
@@ -475,4 +519,4 @@ module WebSocket
 end
 # module WebSocket
 
-Object.new.extend(::WebSocket).main if $PROGRAM_NAME == __FILE__
+Object.new.extend(WebSocket).main if $PROGRAM_NAME == __FILE__

data/lib/websocket_server.rb

@@ -8,42 +8,47 @@
 
 # =begin
 #
-# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+# Copyright Nels Nelson 2016-2024 but freely usable (see license)
 #
 # =end
 
-require_relative 'log'
+require 'java'
+
+require_relative 'logging'
 require_relative 'websocket/arguments_parser'
 require_relative 'websocket/server'
 require_relative 'websocket/telnet_proxy'
 
 # The WebSocket module
 module WebSocket
-  EchoServerMessageTemplate = "%<message>s\n".freeze
-  InterruptTemplate = "\r%<class>s".freeze
-
   def echo_server(options)
-    WebSocket::Server.new(options: options) do |_ctx, msg|
-      format(EchoServerMessageTemplate, message: msg.upcase)
+    ::WebSocket::Server.new(options) do |_ctx, msg|
+      format("%<message>s\n", message: msg.upcase)
     end.run
   end
 
   def telnet_proxy(options)
-    handler = WebSocket::TelnetProxy.new(options[:telnet_proxy_host], options[:telnet_proxy_port])
-    WebSocket::Server.new(handler: handler, options: options).run
+    handler = ::WebSocket::TelnetProxy.new(options[:telnet_proxy_host], options[:telnet_proxy_port])
+    ::WebSocket::Server.new(options, handler).run
   end
 
+  # rubocop: disable Metrics/AbcSize
+  # rubocop: disable Metrics/MethodLength
   def main(args = parse_arguments)
     Logging.log_level = args[:log_level]
     return telnet_proxy(args) unless args[:telnet_proxy_host].nil?
     echo_server(args)
   rescue Interrupt => e
-    warn format(InterruptTemplate, class: e.class)
+    warn format("\r%<class>s", class: e.class)
     exit
   rescue StandardError => e
-    WebSocket::Server.log.fatal(e.message)
+    puts Logging.log_level
+    ::WebSocket::Server.log.fatal(e.message)
+    e.backtrace.each { |t| WebSocket::Server.log.debug t }
     abort
   end
+  # rubocop: enable Metrics/AbcSize
+  # rubocop: enable Metrics/MethodLength
 end
 # module WebSocket
 

metadata

@@ -1,71 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: websocket-server
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.2
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-26 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.1.3
   name: tcp-server
-  prerelease: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.0.5
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.0
-  name: rake
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 12.3.0
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  name: rspec
-  prerelease: false
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-- !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.25.0
-  name: rubocop
   prerelease: false
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 1.1.3
+  force_ruby_platform: false
 description: Websocket Server for JRuby is a websocket server with a file server to
   support a demo javascript client application which interfaces with a demo echo server
   application.
@@ -75,11 +34,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
 - exe/websocket
-- lib/log.rb
+- lib/logging.rb
 - lib/server/mime_types.rb
 - lib/websocket-server.rb
 - lib/websocket/arguments_parser.rb
@@ -138,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Websocket Server for JRuby packaged as a gem.