websocket-server 1.0.1-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7670d3a4e743e533e42467d4047741a0ea833cc4e7ea4d1855a1ed9b76138560
+  data.tar.gz: d1d6b8efb9502a45b44d56267d8a76fc036d46e4169c15cf93fcc605202ded8c
+SHA512:
+  metadata.gz: a7cf7669311ab73b6a1905cda6d8112052b32ddbd7da3ccfb6bcf36e36e3f1d66b8fabf11da1b0abe0dc29a61c96f10506c1a8c750f95a45a18f494e711ec24f
+  data.tar.gz: 16e0b9f2221cd9a83de57266561ea8797f40ac7d6d717e6b67fef1e078f045a5b2a5605c25c5670bc6fdde6c5db48610b85786f0a5c1a79d2a7df20c366ef6d6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,185 @@
+# websocket-server-jruby
+
+[![License](https://img.shields.io/badge/license-MIT--2.0-blue.svg?style=flat)][license]
+
+This is a small websocket server for [JRuby].
+
+It is based on the [Netty project].  Netty is written in java, but I wanted to write ruby.
+
+
+## Quick-start
+
+Follow these instructions to get a websocket server echo program running in your web browser.
+
+
+### Container
+
+You may run the websocket server in a container.
+
+```sh
+colima start
+docker-compose up &
+open http://localhost:4000/client.html
+```
+
+
+Building the image or running the container:
+
+```sh
+docker build --squash --tag websocket-server-jruby .
+docker run --detach --publish 4000:4000 --name websocket-server-jruby websocket-server-jruby
+```
+
+
+## Manually
+
+Run directly with the required dependencies installed.
+
+### Install asdf
+
+The [asdf] CLI tool used to manage multiple runtime versions.
+
+```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"
+```
+
+### Install required runtime software
+
+Download and install the latest version of the [Java JDK].
+
+```sh
+asdf plugin add java
+asdf install java openjdk-17.0.2
+```
+
+
+Download and install the latest version of [JRuby].
+
+```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
+```
+
+
+Install the project dependencies.
+
+```sh
+bundle install
+```
+
+
+## Run
+
+The entrypoint for the web application service may now be invoked from a command line interface terminal shell.
+
+```sh
+bundle exec ./websocket.rb &
+open http://localhost:4000/client.html
+```
+
+
+## Build the gem
+
+To clean the project, run unit tests, build the gem file, and verify that the built artifact works, execute:
+
+```sh
+bundle exec rake
+```
+
+
+## Publish the gem
+
+To publish the gem, execute:
+
+```sh
+bundle exec rake publish
+```
+
+
+## Project file tree
+
+Here is a bird's-eye view of the project layout.
+
+```sh
+# date && tree
+Wed Apr  6 23:05:28 CDT 2022
+.
+├── Dockerfile
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE
+├── README.md
+├── Rakefile
+├── docker-compose.yaml
+├── exe
+│   └── websocket
+├── lib
+│   ├── log.rb
+│   ├── server
+│   │   ├── mime_types.rb
+│   │   └── server.rb
+│   ├── websocket
+│   │   ├── arguments_parser.rb
+│   │   ├── channel_initializer.rb
+│   │   ├── config.rb
+│   │   ├── encoding.rb
+│   │   ├── file_server_channel_progressive_future_listener.rb
+│   │   ├── frame_handler.rb
+│   │   ├── header_helpers.rb
+│   │   ├── http_static_file_server_handler.rb
+│   │   ├── http_static_file_server_handler_instance_methods.rb
+│   │   ├── idle_handler.rb
+│   │   ├── idle_state_user_event_handler.rb
+│   │   ├── listenable.rb
+│   │   ├── message_handler.rb
+│   │   ├── modular_handler.rb
+│   │   ├── response_helpers.rb
+│   │   ├── server.rb
+│   │   ├── server_instance_methods.rb
+│   │   ├── shutdown_hook.rb
+│   │   ├── ssl_cipher_inspector.rb
+│   │   ├── ssl_context_initialization.rb
+│   │   ├── telnet_proxy.rb
+│   │   ├── validation_helpers.rb
+│   │   └── version.rb
+│   ├── websocket_client.rb
+│   └── websocket_server.rb
+├── logs
+│   └── server.log
+├── spec
+│   ├── spec_helper.rb
+│   ├── test_spec.rb
+│   └── verify
+│       └── verify_spec.rb
+├── web
+│   ├── client.html
+│   ├── css
+│   │   └── client
+│   │       ├── console.css
+│   │       └── parchment.css
+│   ├── favicon.ico
+│   ├── fonts
+│   │   └── droidsansmono.v4.woff
+│   └── js
+│       ├── client
+│       │   ├── ansispan.js
+│       │   ├── client.js
+│       │   ├── console.js
+│       │   └── websocket.js
+│       └── jquery.min.js
+├── websocket-server-jruby.gemspec
+└── websocket.rb
+
+13 directories, 52 files
+```
+
+[license]: https://gitlab.com/nelsnelson/websocket-server-jruby/blob/master/LICENSE
+[asdf]: https://asdf-vm.com/
+[Netty project]: https://github.com/netty/netty
+[Java JDK]: https://www.java.com/en/download/
+[JRuby]: https://jruby.org/download

data/Rakefile

@@ -0,0 +1,56 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+require 'rake'
+require 'rake/clean'
+
+PROJECT = File.basename(__dir__) unless defined?(PROJECT)
+
+load "#{PROJECT}.gemspec"
+
+CLEAN.add File.join('tmp', '**', '*'), 'tmp'
+CLOBBER.add '*.gem', 'pkg'
+
+task default: %i[package]
+
+desc 'Run the rubocop linter'
+task :lint do
+  system('bundle', 'exec', 'rubocop') or abort
+end
+
+desc 'Run the spec tests'
+task :test do
+  system('bundle', 'exec', 'rspec', '--exclude-pattern', 'spec/verify/**/*_spec.rb') or abort
+end
+task test: :lint
+
+desc 'Explode the gem'
+task :explode do
+  system('jgem', 'install', '--no-document', '--install-dir=tmp', '*.gem')
+end
+task explode: :clean
+
+desc 'Package the gem'
+task :package do
+  system('jgem', 'build')
+end
+task package: %i[clean clobber test]
+
+desc 'Verify the gem'
+task :verify do
+  system('bundle', 'exec', 'rspec', 'spec/verify') or abort
+end
+task verify: :explode
+
+desc 'Publish the gem'
+task :publish do
+  system('jgem', 'push', latest_gem)
+end
+task publish: :verify
+
+def latest_gem
+  `ls -t #{PROJECT}*.gem`.strip.split("\n").first
+end

data/exe/websocket

@@ -0,0 +1,41 @@
+#! /usr/bin/env jruby
+
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+# How to invoke this program with Java system property 'ssl' set to true
+# without root privileges:
+#
+#     websocket --ssl --port=4443
+#
+# You may now browse to https://localhost:4443/ to test.
+#
+#
+# How to have this program listen to standard ssl port 443 (this
+# typically requires root privileges):
+#
+#     sudo websocket --ssl
+#
+#
+# How to have this program listen to standard ssl port 443 and use
+# a certificate and private key from the local file system:
+#
+#     sudo websocket --ssl \
+#       --ssl-certificate=/etc/letsencrypt/live/example.com/fullchain.pem \
+#       --ssl-private-key=/etc/letsencrypt/live/example.com/privkey.pem
+#
+# You may now browse to https://localhost/ to test.
+#
+
+require_relative '../lib/websocket_server'
+
+Object.new.extend(WebSocket).main

data/lib/log.rb

@@ -0,0 +1,244 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# =begin
+
+# Copyright Nels Nelson 2016-2019 but freely usable (see license)
+
+# =end
+
+require 'java'
+require 'logger'
+
+require 'log4j-2'
+
+require 'fileutils'
+
+# The Logging module
+module Logging
+  # rubocop: disable Metrics/MethodLength
+  def config
+    @config ||= begin
+      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'))
+      {
+        level: :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',
+        schedule: '0 0 0 * * ?',
+        size: '100M'
+      }
+    end
+  end
+  module_function :config
+  # 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], '')
+  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()
+
+    if log_level.is_a?(Symbol)
+      log_level = org.apache.logging.log4j.Level.to_level(
+        log_level.to_s.upcase
+      )
+    end
+    config.setStatusLevel(log_level)
+    config.setConfigurationName(Logging.config['name'])
+
+    # Create a console appender
+    target = org.apache.logging.log4j.core.appender::ConsoleAppender::Target::SYSTEM_OUT
+    layout = config.newLayout('PatternLayout')
+    layout = layout.addAttribute('pattern', Logging.config[:logger_pattern_template])
+    appender = config.newAppender('stdout', 'CONSOLE')
+    appender = appender.addAttribute('target', target)
+    appender = appender.add(layout)
+    config.add(appender)
+
+    # Create a root logger
+    root_logger = config.newRootLogger(log_level)
+    root_logger = root_logger.add(config.newAppenderRef('stdout'))
+
+    # Create a rolling file appender
+    cron = config.newComponent('CronTriggeringPolicy')
+    cron = cron.addAttribute('schedule', Logging.config[:schedule])
+
+    size = config.newComponent('SizeBasedTriggeringPolicy')
+    size = size.addAttribute('size', Logging.config[:size])
+
+    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.add(layout)
+    appender = appender.addComponent(policies)
+    config.add(appender)
+
+    root_logger = root_logger.addAttribute('additivity', false)
+    root_logger = root_logger.add(config.newAppenderRef('rolling_file'))
+    config.add(root_logger)
+
+    logging_configuration = config.build()
+    ctx = org.apache.logging.log4j.core.config::Configurator.initialize(logging_configuration)
+    ctx.updateLoggers()
+  end
+  # 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
+
+  def generate_message(error_or_message, error)
+    error_message = "#{error_or_message}: #{error.class.name}"
+    error_message << ": #{error.message}" if error.respond_to?(:message)
+    error_message
+  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? }
+    elsif error.respond_to?(:getStackTrace)
+      error.getStackTrace().each { |trace| log4j_error(trace) unless trace.nil? }
+    else
+      default_result
+    end
+  end
+end
+# rubocop: enable Style/ClassAndModuleChildren
+
+# The Logging module
+module Logging
+  def init_logger(level = :all, logger_name = nil)
+    return init_java_logger(level, logger_name, caller[2]) if defined?(Java)
+    init_ruby_logger(level)
+  end
+
+  def init_ruby_logger(level)
+    logger_instance = Logger.new
+    logger_instance.level = Logging::Level.to_level(level.to_s.upcase)
+    logger_instance
+  end
+
+  # rubocop: disable Metrics/AbcSize
+  def init_java_logger(level, 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
+  end
+  # rubocop: enable Metrics/AbcSize
+
+  def get_formatted_logger_name(logger_name = nil)
+    return logger_name.to_s[/\w+$/] unless logger_name.nil?
+    return name[/\w+$/] if is_a?(Class) || is_a?(Module)
+    self.class.name[/\w+$/]
+  end
+
+  # rubocop: disable Metrics/CyclomaticComplexity
+  # OFF: 0
+  # FATAL: 100
+  # ERROR: 200
+  # WARN: 300
+  # INFO: 400
+  # DEBUG: 500
+  # TRACE: 600
+  # ALL: 2147483647
+  # See: https://logging.apache.org/log4j/2.x/log4j-api/apidocs/org/apache/logging/log4j/Level.html
+  def symbolize_numeric_log_level(level)
+    case level
+    when 5..Float::INFINITY then :off
+    when 4 then :fatal
+    when 3 then :error
+    when 2 then :warn
+    when 1 then :info
+    when 0 then :debug
+    when -1 then :trace
+    when -2..-Float::INFINITY 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)
+  end
+  module_function :log_level=
+
+  def log_level
+    Logging.config[:level]
+  end
+  module_function :log_level
+
+  def log(level = Logging.log_level, log_name = nil)
+    @log ||= init_logger(level, log_name)
+  end
+  alias logger log
+end
+# module Logging
+
+# The Module class
+class Module
+  # Universally include Logging
+  include ::Logging
+end
+
+# The Class class
+class Class
+  # Universally include Logging
+  include ::Logging
+end
+
+# The Object class
+class Object
+  # Universally include Logging
+  include ::Logging
+end

data/lib/server/mime_types.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# =begin
+#
+# Copyright Nels Nelson 2016-2022 but freely usable (see license)
+#
+# =end
+
+# The Server module
+module Server
+  MimeTypes = {
+    txt: 'text/plain',
+    css: 'text/css',
+    csv: 'text/csv',
+    htm: 'text/html',
+    html: 'text/html',
+    xml: 'text/xml',
+    js: 'application/javascript',
+    xhtml: 'application/xhtml+xml',
+    json: 'application/json',
+    pdf: 'application/pdf',
+    woff: 'application/x-font-woff',
+    zip: 'application/zip',
+    tar: 'application/x-tar',
+    gif: 'image/gif',
+    jpeg: 'image/jpeg',
+    jpg: 'image/jpeg',
+    tiff: 'image/tiff',
+    tif: 'image/tiff',
+    png: 'image/png',
+    svg: 'image/svg+xml',
+    ico: 'image/vnd.microsoft.icon'
+  }.freeze
+end