websocket-server 1.1.1-java → 1.1.2-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efeef05a280e5bd37c7aac5e935d3be061d0d2e3cc8058af0beb431a6ac91b2f
-  data.tar.gz: ebe9d73d1f5c6cb9939551957531c78c5e93a93ffede7a6d2b14ac233ffd60ab
+  metadata.gz: 1a82a08a0eb5e690dcea50d8df9c9173fc9ee89dcb533e856b70c4a6622a5c11
+  data.tar.gz: 561c75644b76a40ed767a5c4e03d7d35dfb606c1819d39f08449b0c4283620ff
 SHA512:
-  metadata.gz: f88e570186167360f06486585614c9b94dc85246aef73036f387908f3e9d7b286552fccec802b8b7e85826c6bc87cbf21010443e9f2485d2017ce4f74fe18af3
-  data.tar.gz: d35daddf002f5f847fcd05b0d2a1f0a89616a027c410fcac25a26183d957111b213ca8f65835c3a6936e5950b4aa21a267a6e4086cb617128489042f7cdfc788
+  metadata.gz: '083153e26d8f09e3cf8c9667bb02970d5861bba51d6390b9d02b8a5a5950c8c5e47afb172822b44e2e2e14810f90112314b87d3a5fbef201bbec1c8f2d4b46d1'
+  data.tar.gz: 446b92140447fdf3a45abae203308a1ac716f9ca6e6e15bd79053059c44a60fb2345a5421e7c391e855ba4739682258b5e01207ce52775e2eb6561a40a23db09

data/{LICENSE → LICENSE.txt}

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Nels Nelson
+Copyright (c) 2016-2024 Nels Nelson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -14,12 +14,13 @@ Follow these instructions to get a websocket server echo program running in your
 
 ### Container
 
-You may run the websocket server in a container.
+You may run the websocket server in a container. Using [colima] for a container runtime is recommended.
 
 ```sh
 colima start
-docker-compose up &
+docker-compose up --detach
 open http://localhost:4000/client.html
+docker-compose down
 ```
 
 
@@ -35,34 +36,33 @@ docker run --detach --publish 4000:4000 --name websocket-server-jruby websocket-
 
 Run directly with the required dependencies installed.
 
-### Install asdf
 
-The [asdf] CLI tool used to manage multiple runtime versions.
+## Install mise-en-place
+
+The [mise] CLI tool used to manage multiple runtime versions.
+
+See: https://mise.jdx.dev/getting-started.html
 
 ```sh
-git clone https://github.com/asdf-vm/asdf.git "${HOME}/.asdf" --branch v0.8.1
-pushd "${HOME}/.asdf"; git fetch origin; popd
-source "${HOME}/.asdf/asdf.sh"; source "${HOME}/.asdf/completions/asdf.bash"
+curl https://mise.jdx.dev/install.sh | sh
+~/.local/bin/mise --version
+mise 2024.x.x
 ```
 
-### Install required runtime software
-
-Download and install the latest version of the [Java JDK].
+Enable mise activation in future zsh sessions.
 
 ```sh
-asdf plugin add java
-asdf install java openjdk-17.0.2
+echo 'eval "$(~/.local/bin/mise activate zsh)"' >> ~/.zshrc
 ```
 
 
-Download and install the latest version of [JRuby].
+## Install required runtime software
+
+Use mise to install the runtime software defined as requirements
+in the .tool-versions file.
 
 ```sh
-asdf plugin add ruby
-pushd "${HOME}/.asdf/plugins/ruby/ruby-build"; git fetch origin; git pull origin master; popd
-# ~/.asdf/plugins/ruby/bin/list-all
-asdf list all ruby
-asdf install
+mise install
 ```
 
 
@@ -106,8 +106,8 @@ bundle exec rake publish
 Here is a bird's-eye view of the project layout.
 
 ```sh
-# date && tree
-Sun Jul 24 22:53:59 CDT 2022
+# date && tree -A -I "logs|vendor|tmp|Gemfile.lock"
+Sun Jul 31 15:17:32 CDT 2022
 .
 ├── Dockerfile
 ├── Gemfile
@@ -118,11 +118,9 @@ Sun Jul 24 22:53:59 CDT 2022
 ├── exe
 │   └── websocket
 ├── lib
-│   ├── client.rb
-│   ├── log.rb
+│   ├── logging.rb
 │   ├── server
-│   │   ├── mime_types.rb
-│   │   └── modular_handler.rb
+│   │   └── mime_types.rb
 │   ├── websocket
 │   │   ├── arguments_parser.rb
 │   │   ├── channel_initializer.rb
@@ -175,11 +173,12 @@ Sun Jul 24 22:53:59 CDT 2022
 ├── websocket.rb
 └── websocket_server.png
 
-12 directories, 53 files
+12 directories, 51 files
 ```
 
 [license]: https://gitlab.com/nelsnelson/websocket-server-jruby/blob/master/LICENSE
-[asdf]: https://asdf-vm.com/
+[mise]: https://mise.jdx.dev/
+[colima]: https://github.com/abiosoft/colima
 [Netty project]: https://github.com/netty/netty
 [Java JDK]: https://www.java.com/en/download/
 [JRuby]: https://jruby.org/download

data/exe/websocket

@@ -8,7 +8,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/{log.rb → logging.rb}

@@ -1,6 +1,9 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
 # =begin
 
 # Copyright Nels Nelson 2016-2019 but freely usable (see license)
@@ -8,11 +11,10 @@
 # =end
 
 require 'java'
+require 'fileutils'
 require 'logger'
 
-require 'log4j-2'
-
-require 'fileutils'
+require 'apache-log4j-2'
 
 # The Logging module
 module Logging
@@ -22,16 +24,22 @@ module Logging
       lib_dir_path = File.expand_path(__dir__)
       project_dir_path = File.expand_path(File.dirname(lib_dir_path))
       logs_dir_path = File.expand_path(File.join(project_dir_path, 'logs'))
-      server_log_file = File.expand_path(File.join(logs_dir_path, 'server.log'))
+      FileUtils.mkdir_p(logs_dir_path)
+      log_file_path = File.expand_path(File.join(logs_dir_path, 'server.log'))
+      FileUtils.touch(log_file_path)
       {
-        level: :info,
+        level: Logger::INFO,
         name: 'websocket',
         lib_dir_path: lib_dir_path,
         project_dir_path: project_dir_path,
         logs_dir_path: logs_dir_path,
-        server_log_file: server_log_file,
-        rolling_log_file_name_template: 'server-%d{yyyy-MM-dd}.log.gz',
-        logger_pattern_template: '%d{ABSOLUTE} %-5p [%c{1}] %m%n',
+        log_file_path: log_file_path,
+        rolling_log_file_name_template: File.expand_path(
+          File.join(logs_dir_path, 'server-%d{yyyy-MM-dd}.log.gz')),
+        logging_pattern_template: {
+          java: '%d{ABSOLUTE} %-5p [%c{1}] %m%n',
+          ruby: "%<timestamp>s %-5<severity>s [%<progname>s] %<msg>s\n"
+        },
         schedule: '0 0 0 * * ?',
         size: '100M'
       }
@@ -41,69 +49,52 @@ module Logging
   # rubocop: enable Metrics/MethodLength
 end
 
-# The LogInitialization module
-module LogInitialization
-  def init
-    init_log_file
-    init_log4j if defined? Java
-  end
-  module_function :init
-
-  def init_log_file
-    FileUtils.mkdir_p(Logging.config[:logs_dir_path])
-    return if File.file?(Logging.config[:server_log_file])
-
-    File.write(Logging.config[:server_log_file], '')
+# The Logging module
+module Logging
+  if defined?(Java)
+  java_import Java::org.apache.logging.log4j.core.appender::ConsoleAppender
+  java_import Java::org.apache.logging.log4j.core.config::Configurator
+  java_import Java::org.apache.logging.log4j.core.config.builder.api::ConfigurationBuilderFactory
   end
-  module_function :init_log_file
 
   # rubocop: disable Metrics/AbcSize
   # rubocop: disable Metrics/MethodLength
   def init_log4j(log_level = org.apache.logging.log4j.Level::INFO)
-    server_log_file = Logging.config[:server_log_file]
-    logs_dir_path = Logging.config[:logs_dir_path]
-    rolling_log_file_name_template = Logging.config[:rolling_log_file_name_template]
-    rolling_log_file_path = File.join(logs_dir_path, rolling_log_file_name_template)
-
     java.lang::System.setProperty('log4j.shutdownHookEnabled', java.lang::Boolean.toString(false))
-    factory = org.apache.logging.log4j.core.config.builder.api::ConfigurationBuilderFactory
-    config = factory.newConfigurationBuilder()
+    config = ConfigurationBuilderFactory.newConfigurationBuilder()
 
-    if log_level.is_a?(Symbol)
-      log_level = org.apache.logging.log4j.Level.to_level(
-        log_level.to_s.upcase
-      )
-    end
+    log_level = org.apache.logging.log4j::Level.to_level(log_level.to_s.upcase) if log_level.is_a? Symbol
     config.setStatusLevel(log_level)
-    config.setConfigurationName(Logging.config['name'])
+    config.setConfigurationName('websocket')
 
-    # Create a console appender
-    target = org.apache.logging.log4j.core.appender::ConsoleAppender::Target::SYSTEM_OUT
+    # create a console appender
+    target = ConsoleAppender::Target::SYSTEM_OUT
+    pattern = Logging.config[:logging_pattern_template][:java]
     layout = config.newLayout('PatternLayout')
-    layout = layout.addAttribute('pattern', Logging.config[:logger_pattern_template])
+    layout = layout.addAttribute('pattern', pattern)
     appender = config.newAppender('stdout', 'CONSOLE')
     appender = appender.addAttribute('target', target)
     appender = appender.add(layout)
     config.add(appender)
 
-    # Create a root logger
+    # create a root logger
     root_logger = config.newRootLogger(log_level)
     root_logger = root_logger.add(config.newAppenderRef('stdout'))
 
-    # Create a rolling file appender
+    # create a rolling file appender
     cron = config.newComponent('CronTriggeringPolicy')
-    cron = cron.addAttribute('schedule', Logging.config[:schedule])
+    cron = cron.addAttribute('schedule', '0 0 0 * * ?')
 
     size = config.newComponent('SizeBasedTriggeringPolicy')
-    size = size.addAttribute('size', Logging.config[:size])
+    size = size.addAttribute('size', '100M')
 
     policies = config.newComponent('Policies')
     policies = policies.addComponent(cron)
     policies = policies.addComponent(size)
 
     appender = config.newAppender('rolling_file', 'RollingFile')
-    appender = appender.addAttribute('fileName', server_log_file)
-    appender = appender.addAttribute('filePattern', rolling_log_file_path)
+    appender = appender.addAttribute('fileName', Logging.config[:log_file_path])
+    appender = appender.addAttribute('filePattern', Logging.config[:rolling_log_file_name_template])
     appender = appender.add(layout)
     appender = appender.addComponent(policies)
     config.add(appender)
@@ -113,28 +104,20 @@ module LogInitialization
     config.add(root_logger)
 
     logging_configuration = config.build()
-    ctx = org.apache.logging.log4j.core.config::Configurator.initialize(logging_configuration)
+    ctx = Configurator.initialize(logging_configuration)
     ctx.updateLoggers()
   end
+  module_function :init_log4j
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/MethodLength
   # def init_log4j
-  module_function :init_log4j
-end
-# module LogInitialization
-
-::LogInitialization.init
 
-# The Apache log4j Logger class
-# rubocop: disable Style/ClassAndModuleChildren
-class org.apache.logging.log4j.core::Logger
-  alias log4j_error error
-  def error(error_or_message, error = nil)
-    return extract_backtrace(error_or_message) if error.nil?
-    log4j_error(generate_message(error_or_message, error))
-    extract_backtrace(error)
-  end
+  init_log4j if defined?(Java)
+end
+# module Logging
 
+# Namespace for methods to help with implicit backtrace printing
+module LoggerHelpers
   def generate_message(error_or_message, error)
     error_message = "#{error_or_message}: #{error.class.name}"
     error_message << ": #{error.message}" if error.respond_to?(:message)
@@ -142,40 +125,67 @@ class org.apache.logging.log4j.core::Logger
   end
 
   def extract_backtrace(error, default_result = nil)
-    log4j_error(error)
     if error.respond_to?(:backtrace)
-      error.backtrace.each { |trace| log4j_error(trace) unless trace.nil? }
+      error.backtrace.each { |trace| original_error(trace) unless trace.nil? }
     elsif error.respond_to?(:getStackTrace)
-      error.getStackTrace().each { |trace| log4j_error(trace) unless trace.nil? }
+      error.getStackTrace().each { |trace| original_error(trace) unless trace.nil? }
     else
       default_result
     end
   end
 end
-# rubocop: enable Style/ClassAndModuleChildren
+
+# Monkey-patch the built-in Ruby Logger class to support
+# implicit backtrace printing
+# TODO: Figure out if this is actually useful.
+class Logger
+  include LoggerHelpers
+
+  alias original_error error
+  def error(error_or_message, error = nil)
+    return extract_backtrace(error_or_message) if error.nil?
+    original_error(generate_message(error_or_message, error))
+    extract_backtrace(original_error(error))
+  end
+end
 
 # The Logging module
 module Logging
-  def init_logger(level = :all, logger_name = nil)
+  if defined?(Java)
+  java_import Java::org.apache.logging.log4j.Level
+  java_import Java::org.apache.logging.log4j.LogManager
+  end
+
+  FORWARD_SLASH_PATTERN = %r{/}
+
+  def init_logger(level = :info, logger_name = nil)
     return init_java_logger(level, logger_name, caller[2]) if defined?(Java)
-    init_ruby_logger(level)
+    init_ruby_logger(level, logger_name, caller[2])
   end
 
-  def init_ruby_logger(level)
-    logger_instance = Logger.new
-    logger_instance.level = Logging::Level.to_level(level.to_s.upcase)
-    logger_instance
+  def ruby_log_formatter(severity_level, datetime, program_name, message)
+    format(
+      Logging.config[:logging_pattern_template][:ruby],
+      timestamp: datetime.strftime(Logging.config[:logging_timestamp_format]),
+      progname: program_name, severity: severity_level, msg: message)
   end
 
-  # rubocop: disable Metrics/AbcSize
-  def init_java_logger(level, logger_name = nil, source_location = nil)
+  def init_ruby_logger(level = nil, logger_name = nil, source_location = nil)
     logger_name = get_formatted_logger_name(logger_name)
-    logger_name = source_location.split(/\//).last if logger_name.empty?
-    logger_instance = org.apache.logging.log4j.LogManager.getLogger(logger_name)
-    logger_instance.level = org.apache.logging.log4j.Level.to_level(level.to_s.upcase)
-    logger_instance
+    logger_name = source_location.split(FORWARD_SLASH_PATTERN).last if logger_name.empty?
+    log = Logger.new($stdout, progname: logger_name)
+    log.level = level.to_s unless level.nil?
+    log.formatter = method(:ruby_log_formatter)
+    log
+  end
+
+  def init_java_logger(level = nil, logger_name = nil, source_location = nil)
+    logger_name = get_formatted_logger_name(logger_name)
+    logger_name = source_location.split(FORWARD_SLASH_PATTERN).last if logger_name.empty?
+    log = LogManager.getLogger(logger_name)
+    log.level = Level.to_level(level.to_s.upcase) unless level.nil?
+    log
   end
-  # rubocop: enable Metrics/AbcSize
 
   def get_formatted_logger_name(logger_name = nil)
     return logger_name.to_s[/\w+$/] unless logger_name.nil?
@@ -202,14 +212,13 @@ module Logging
     when 1 then :info
     when 0 then :debug
     when -1 then :trace
-    when -2..-Float::INFINITY then :all
+    when -Float::INFINITY..-2 then :all
     end
   end
   # rubocop: enable Metrics/CyclomaticComplexity
-  module_function :symbolize_numeric_log_level
 
-  def log_level=(log_level)
-    Logging.config[:level] = symbolize_numeric_log_level(log_level)
+  def log_level=(level)
+    Logging.config[:level] = symbolize_numeric_log_level(level)
   end
   module_function :log_level=
 
@@ -218,7 +227,7 @@ module Logging
   end
   module_function :log_level
 
-  def log(level = Logging.log_level, log_name = nil)
+  def log(level = Logging.log_level, log_name = Logging.config[:app_name])
     @log ||= init_logger(level, log_name)
   end
   alias logger log

data/lib/server/mime_types.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/arguments_parser.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/channel_initializer.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/config.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/encoding.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/file_server_channel_progressive_future_listener.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/frame_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/header_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
 

data/lib/websocket/http_static_file_server_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/http_static_file_server_handler_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
 
@@ -36,8 +36,8 @@ module WebSocket
 
   # The HttpStaticFileServerHandlerInstanceMethods module
   module HttpStaticFileServerHandlerInstanceMethods
-    ForwardSlashBeforeEOLPattern = %r{/$}.freeze
-    URIForwardSlashTemplate = '%<uri>s/'.freeze
+    FORWARD_SLASH_BEFORE_EOL_PATTERN = %r{/$}
+    URI_FORWARD_SLASH_TEMPLATE = '%<uri>s/'.freeze
 
     # rubocop: disable Metrics/AbcSize
     # rubocop: disable Metrics/CyclomaticComplexity
@@ -69,10 +69,10 @@ module WebSocket
       end
 
       if File.directory? path
-        if ForwardSlashBeforeEOLPattern.match?(uri)
+        if FORWARD_SLASH_BEFORE_EOL_PATTERN.match?(uri)
           send_listing(ctx, path)
         else
-          send_redirect(ctx, format(URIForwardSlashTemplate, uri: uri))
+          send_redirect(ctx, format(URI_FORWARD_SLASH_TEMPLATE, uri: uri))
         end
         return
       end
@@ -149,7 +149,6 @@ module WebSocket
     # rubocop: enable Metrics/PerceivedComplexity
 
     def exceptionCaught(ctx, cause)
-      log.info "##{__method__} wtf2"
       cause.printStackTrace()
       return unless ctx.channel().isActive()
       send_error(ctx, HttpResponseStatus::INTERNAL_SERVER_ERROR)

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
 

data/lib/websocket/listenable.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'
-
 # The WebSocket module
 module WebSocket
   # The Listenable module

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.1.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.
 
@@ -335,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()
@@ -520,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,11 +8,13 @@
 
 # =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'

metadata

@@ -1,71 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: websocket-server
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-25 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.1.0
+        version: 1.1.3
   name: tcp-server
-  prerelease: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !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.