tcp-server 1.0.6-java → 1.0.7-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb40677b97f1b1ce0fb1fad9308d527d3086c927044f5e71d1e378c5e0d8e25
-  data.tar.gz: 7e489022262138faae081772672bb99ca5eef415f943ff2b9cf96120390cb984
+  metadata.gz: 119b17b7637a9d30ba40c82660e9b2c9eebbabbe59264cbb49e88b82cef6805c
+  data.tar.gz: 5fa1261d06c758e2934944f79fc9f747d73f387dd4e2ed04cb119fe496a34010
 SHA512:
-  metadata.gz: 1d8afb5280d5a8bfe5dd234dcb5f0dfb26558543074b917de3c39bd08cd5331319a32bd764400d7183fa8814d8b978a57532306dfb2b7464c28cc58aacc5c732
-  data.tar.gz: 8a6c94c3ee130ea33a8c4e95009b75414d9622916b4277a38664f3f08d3f238d787941c9c0e7ed5c566a2c3efd2b2d064dda83f0cdce513fd95036c08c959e09
+  metadata.gz: 3d911168c44588f3c89b557b800bde9cbaf5603185c4c850bf6362c8e24458110ed2b1c33ea8736032d7003d01068a4e7b7bf58151e334adab2b1fef2adba251
+  data.tar.gz: f2863e4c56547ae3f8af9f1b37085863ffefd3f5ffd07eb46a1e288c72694189ff52e44c7fdb1e1b20ee68c8b841a93699e9d32a2ad4defff093e8ac265b567a

data/README.md

@@ -18,7 +18,9 @@ You may run the websocket server in a container. The [`colima`](https://github.c
 
 ```sh
 colima start
-docker-compose up
+docker-compose up --detach
+nc localhost 4000
+docker-compose down
 ```
 
 Building the image or running the container:
@@ -57,8 +59,7 @@ 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 plugin update --all
 asdf list all ruby
 asdf install ruby jruby-9.3.4.0
 ```
@@ -123,7 +124,7 @@ Here is a bird's-eye view of the project layout.
 
 ```sh
 # date && tree -I "logs|vendor|tmp"
-Thu Jun 16 00:03:23 CDT 2022
+Tue Jun 28 20:25:51 CDT 2022
 .
 ├── Dockerfile
 ├── Gemfile
@@ -157,7 +158,7 @@ Thu Jun 16 00:03:23 CDT 2022
 │   ├── test_spec.rb
 │   └── verify
 │       └── verify_spec.rb
-├── tcp-server-1.0.2-java.gem
+├── tcp-server-1.0.6-java.gem
 ├── tcp-server-jruby.gemspec
 ├── tcp_server.png
 └── tcp_server.rb
@@ -165,6 +166,7 @@ Thu Jun 16 00:03:23 CDT 2022
 5 directories, 31 files
 ```
 
+
 ## CI linting
 
 Use the GitLab CI Linting API to validate the syntax of a CI definition file.
@@ -173,12 +175,13 @@ Use the GitLab CI Linting API to validate the syntax of a CI definition file.
 jq --null-input --arg yaml "$(<.gitlab/ci/gem.gitlab-ci.yml)" '.content=$yaml' | curl --silent --location https://gitlab.com/api/v4/ci/lint --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --header "Content-Type: application/json" --data @- | jq --raw-output '.errors[0]'
 ```
 
+
 ## CI configuration
 
 Generate a deploy key.
 
 ```sh
-ssh-keygen -t ed25519 -C deploy_key
+ssh-keygen -t ed25519 -P '' -C deploy_key -f deploy_key_ed25519
 ```
 
 Use the GitLab Project-level Variables API to add the deploy key as a ssh private key variable.
@@ -186,18 +189,21 @@ Use the GitLab Project-level Variables API to add the deploy key as a ssh privat
 ```sh
 project_path="nelsnelson/$(basename $(pwd))"
 
+# Test auth token validity
+curl --silent --show-error --location "https://gitlab.com/api/v4/projects" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq '.[0]["id"]'
+
 project=$(curl --silent --show-error --location "https://gitlab.com/api/v4/search?scope=projects&search=${project_path}" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq --arg project_path "${project_path}" '.[] | select(.path_with_namespace == $project_path)')
 
 project_id=$(curl --silent --show-error --location "https://gitlab.com/api/v4/search?scope=projects&search=${project_path}" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" | jq --arg project_path "${project_path}" '.[] | select(.path_with_namespace == $project_path) | .id')
 
 # Add the deploy_token as a CI variable:
-curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/variables" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --form "key=SSH_PRIVATE_KEY" --form "value=$(cat ./deploy_token)" --form "protected=true" | jq
+curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/variables" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --form "key=SSH_PRIVATE_KEY" --form "value=$(cat ./deploy_key_ed25519)" --form "protected=true" | jq
 ```
 
 Use the Deploy keys API to add a the public deploy key as a deploy key for the project.
 
 ```sh
-curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/deploy_keys" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --data '{"title": "deploy_key", "key": "$(cat ./deploy_token.pub)", "can_push": "true"}' | jq
+curl --silent --show-error --location --request POST "https://gitlab.com/api/v4/projects/${project_id}/deploy_keys" --header "PRIVATE-TOKEN: ${GITLAB_COM_API_PRIVATE_TOKEN}" --form "title=deploy_key"  --form "key=$(cat ./deploy_key_ed25519.pub)" --form "can_push=true" | jq
 ```
 
 [license]: https://gitlab.com/nelsnelson/tcp-server-jruby/blob/master/LICENSE

data/lib/client.rb

@@ -12,11 +12,12 @@
 #
 # =end
 
-require 'optparse'
-
 require 'java'
 require 'netty'
 
+require 'logger'
+require 'optparse'
+
 require 'log'
 
 # The Client module
@@ -26,16 +27,23 @@ end
 
 # The Client module
 module Client
-  # The Config module
-  module Config
-    DEFAULTS = {
+  # rubocop: disable Metrics/MethodLength
+  def client_config
+    @client_config ||= {
+      host: '0.0.0.0',
       port: 8080,
-      host: 'localhost',
       ssl: false,
-      quit_commands: %i[bye quit],
-      log_level: Logger::INFO
+      idle_reading: 5 * 60, # seconds
+      idle_writing: 30, # seconds
+      log_requests: false,
+      log_level: Logger::INFO,
+      quit_commands: %i[bye cease desist exit leave quit stop terminate],
+      max_frame_length: 8192,
+      delimiter: Java::io.netty.handler.codec.Delimiters.lineDelimiter
     }.freeze
   end
+  # rubocop: enable Metrics/MethodLength
+  module_function :client_config
 end
 
 # The Client module
@@ -77,8 +85,8 @@ module Client
     end
 
     def configure_handlers(*handlers, &block)
-      ::Client::ChannelInitializer::DefaultHandler.add_listener(self)
-      listeners.addAll(handlers)
+      channel_initializer.default_handler.add_listener(self)
+      channel_initializer.default_handler.listeners.addAll(handlers)
       @user_app = block
       @application_handler = lambda do |ctx, msg|
         if @user_app.nil? || @user_app.arity == 1
@@ -342,12 +350,11 @@ module Client
 
   # The ChannelInitializer class
   class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
-    DefaultHandler = ::Client::ModularHandler.new
-    FrameDecoderBufferSize = 8192 # bytes
     # The encoder and decoder are sharable. If they were not, then
     # constant definitions could not be used.
-    Decoder = StringDecoder.new
-    Encoder = StringEncoder.new
+    DECODER = StringDecoder.new
+    ENCODER = StringEncoder.new
+    MAX_FRAME_LENGTH = 8192
     attr_accessor :handlers
 
     def initialize(options = {})
@@ -366,12 +373,16 @@ module Client
       pipeline = channel.pipeline
       pipeline.addLast(ssl_handler(channel)) if @options[:ssl]
       pipeline.addLast(
-        DelimiterBasedFrameDecoder.new(FrameDecoderBufferSize, Delimiters.lineDelimiter()),
-        Decoder,
-        Encoder
+        DelimiterBasedFrameDecoder.new(MAX_FRAME_LENGTH, Delimiters.lineDelimiter()),
+        DECODER,
+        ENCODER
       )
       add_user_handlers(pipeline)
-      pipeline.addLast(DefaultHandler)
+      pipeline.addLast(default_handler)
+    end
+
+    def default_handler
+      @default_handler ||= ::Client::ModularHandler.new
     end
 
     protected
@@ -424,7 +435,7 @@ module TCP
     include ::Client::Listenable
 
     def initialize(options = {}, *handlers, &block)
-      init(::Client::Config::DEFAULTS.merge(options))
+      init(::Client.client_config.merge(options))
       configure_handlers(*handlers, &block)
       connect
       session
@@ -447,7 +458,7 @@ module Client
     Flags = %i[banner port ssl log_level help version].freeze
     attr_reader :parser, :options
 
-    def initialize(parser = OptionParser.new, options = ::Client::Config::DEFAULTS.dup)
+    def initialize(parser = OptionParser.new, options = ::Client.client_config.dup)
       @parser = parser
       @options = options
       Flags.each { |method_name| method(method_name).call }

data/lib/log.rb

@@ -12,56 +12,98 @@ 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: 'tcp-server',
+        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
-  LibDirPath = File.expand_path(__dir__) unless defined?(LibDirPath)
-  ProjectDirPath = File.expand_path(File.dirname(LibDirPath)) unless defined?(ProjectDirPath)
-  LogsDirPath = File.expand_path(File.join(ProjectDirPath, 'logs'))
-  Dir.mkdir(LogsDirPath) unless File.exist?(LogsDirPath)
-  ServerLogFile = File.join(LogsDirPath, 'server.log')
-  RollLogFileNameTemplate = 'server-%d{yyyy-MM-dd}.log.gz'.freeze
-  RollingLogFilePath = File.join(LogsDirPath, RollLogFileNameTemplate)
-  File.write(ServerLogFile, '') unless File.file? ServerLogFile
-  LoggerPatternTemplate = '%d{ABSOLUTE} %-5p [%c{1}] %m%n'.freeze
+  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 self.init_log4j(log_level = org.apache.logging.log4j.Level::INFO)
+  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()
 
-    log_level = org.apache.logging.log4j.Level.to_level(log_level.to_s.upcase) if log_level.is_a?(Symbol)
+    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('websocket')
+    config.setConfigurationName(Logging.config['name'])
 
-    # create a console appender
+    # Create a console appender
     target = org.apache.logging.log4j.core.appender::ConsoleAppender::Target::SYSTEM_OUT
     layout = config.newLayout('PatternLayout')
-    layout = layout.addAttribute('pattern', LoggerPatternTemplate)
+    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
+    # 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', '0 0 0 * * ?')
+    cron = cron.addAttribute('schedule', Logging.config[:schedule])
 
     size = config.newComponent('SizeBasedTriggeringPolicy')
-    size = size.addAttribute('size', '100M')
+    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', ServerLogFile)
-    appender = appender.addAttribute('filePattern', RollingLogFilePath)
+    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)
@@ -77,10 +119,11 @@ module LogInitialization
   # rubocop: enable Metrics/AbcSize
   # rubocop: enable Metrics/MethodLength
   # def init_log4j
+  module_function :init_log4j
 end
 # module LogInitialization
 
-::LogInitialization.init_log4j if defined? Java
+::LogInitialization.init
 
 # The Apache log4j Logger class
 # rubocop: disable Style/ClassAndModuleChildren
@@ -113,35 +156,14 @@ end
 
 # The Logging module
 module Logging
-  # rubocop: disable Style/MutableConstant
-  Configuration = {
-    level: Logger::INFO
-  }
-  # rubocop: enable Style/MutableConstant
-
-  def self.log_level=(log_level)
-    Logging::Configuration[:level] = log_level
-  end
-
-  def self.log_level
-    Logging::Configuration[:level]
-  end
-
-  def log(level = Logging.log_level, log_name = nil)
-    @log ||= init_logger(level, log_name)
-  end
-  alias logger log
-
-  protected
-
-  def init_logger(level = Logging.log_level, logger_name = nil)
+  def init_logger(level = :all, logger_name = nil)
     return init_java_logger(level, logger_name, caller[2]) if defined?(Java)
-    Logging.init_ruby_logger(level, logger_name)
+    init_ruby_logger(level)
   end
 
-  def init_ruby_logger(level, logger_name = nil)
-    logger_instance = Logger.new(logger_name)
-    logger_instance.level = level
+  def init_ruby_logger(level)
+    logger_instance = Logger.new
+    logger_instance.level = Logging::Level.to_level(level.to_s.upcase)
     logger_instance
   end
 
@@ -149,9 +171,8 @@ module Logging
   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?
-    level_name = symbolize_numeric_log_level(level).to_s.upcase
     logger_instance = org.apache.logging.log4j.LogManager.getLogger(logger_name)
-    logger_instance.level = org.apache.logging.log4j.Level.to_level(level_name)
+    logger_instance.level = org.apache.logging.log4j.Level.to_level(level.to_s.upcase)
     logger_instance
   end
   # rubocop: enable Metrics/AbcSize
@@ -185,6 +206,22 @@ module Logging
     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
 

data/lib/server/argument_parser.rb

@@ -26,7 +26,7 @@ module Server
 
     def initialize(option_parser = OptionParser.new)
       @parser = option_parser
-      @options = ::Server::Config::DEFAULTS.dup
+      @options = ::Server.server_config.dup
       Flags.each { |method_name| method(method_name).call }
     end
 
@@ -76,7 +76,8 @@ module Server
 
     def log_level
       @parser.on_tail('-v', '--verbose', 'Increase verbosity') do
-        @options[:log_level] -= 1
+        current_level = @options.fetch(:log_level, 0)
+        @options[:log_level] = current_level - 1
       end
     end
 

data/lib/server/channel_initializer.rb

@@ -30,11 +30,10 @@ module Server
 
   # The ChannelInitializer class
   class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
-    FrameDecoderBufferBytesSize = 8192
     # The encoder and decoder are sharable. If they were not, then
     # constant definitions could not be used.
-    Decoder = StringDecoder.new
-    Encoder = StringEncoder.new
+    DECODER = StringDecoder.new
+    ENCODER = StringEncoder.new
     attr_accessor :user_handlers
     attr_reader :options
 
@@ -42,7 +41,7 @@ module Server
       super()
       @channel_group = channel_group
       @options = options
-      @user_handlers = []
+      @user_handlers = @options.fetch(:handlers, [])
     end
 
     def <<(handler)
@@ -53,9 +52,9 @@ module Server
       pipeline = channel.pipeline
       pipeline.addLast(ssl_handler(channel)) if @options[:ssl]
       pipeline.addLast(
-        DelimiterBasedFrameDecoder.new(FrameDecoderBufferBytesSize, Delimiters.lineDelimiter),
-        Decoder,
-        Encoder
+        DelimiterBasedFrameDecoder.new(@options[:max_frame_length], @options[:delimiter]),
+        DECODER,
+        ENCODER
       )
       add_user_handlers(pipeline)
       pipeline.addLast(default_handler)

data/lib/server/config.rb

@@ -10,13 +10,15 @@
 #
 # =end
 
+require 'netty'
+
 require 'logger'
 
 # The Server module
 module Server
-  # The Config module
-  module Config
-    DEFAULTS = {
+  # rubocop: disable Metrics/MethodLength
+  def server_config
+    @server_config ||= {
       host: '0.0.0.0',
       port: 8080,
       ssl: false,
@@ -24,7 +26,11 @@ module Server
       idle_writing: 30, # seconds
       log_requests: false,
       log_level: Logger::INFO,
-      quit_commands: %i[bye quit]
+      quit_commands: %i[bye cease desist exit leave quit stop terminate],
+      max_frame_length: 8192,
+      delimiter: Java::io.netty.handler.codec.Delimiters.lineDelimiter
     }.freeze
   end
+  module_function :server_config
+  # rubocop: enable Metrics/MethodLength
 end

data/lib/server/message_handler.rb

@@ -39,7 +39,7 @@ module Server
     end
 
     def messageReceived(ctx, msg)
-      log.trace "##{__method} channel: #{ctx.channel}, message: #{msg.inspect}"
+      log.trace "##{__method__} channel: #{ctx.channel}, message: #{msg.inspect}"
       msg&.chomp!
       log.info "Received message: #{msg}"
       return super(ctx, msg) unless respond_to?(:handle_message) && @handler.arity == 2
@@ -49,7 +49,7 @@ module Server
     def handle_message(ctx, message)
       request = message.to_s.strip
       response = @handler.call(ctx.channel, request).to_s.chomp
-      log.debug "response: #{response}"
+      log.debug "##{__method__} response: #{response}"
       ctx.channel.writeAndFlush("#{response}\n")
     end
   end

data/lib/server/modular_handler.rb

@@ -45,7 +45,7 @@ module Server
     end
 
     def channelActive(ctx)
-      log.trace "##{__method__} channel: #{ctx.channel}"
+      log.info "##{__method__} channel: #{ctx.channel}"
       @channel_group.add(ctx.channel)
       notify :channel_active, ctx
       super(ctx)

data/lib/server/server.rb

@@ -25,7 +25,7 @@ module Server
     attr_reader :options
 
     def initialize(params = {}, &block)
-      @options = ::Server::Config::DEFAULTS.merge(params.fetch(:options, {}))
+      @options = ::Server.server_config.merge(params.fetch(:options, {}))
       configure_handlers(&block)
     end
 

data/lib/server/version.rb

@@ -12,5 +12,5 @@
 
 # The Server module
 module Server
-  VERSION = '1.0.6'.freeze
+  VERSION = '1.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-server
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement