tcp-server 1.0.1-java → 1.0.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b24ec50845ec5dac9b5d06a19a27575620319981f812f929e234506c8fbce9d
-  data.tar.gz: 1fd77e294ea65d8a69d04c25c10b829d649cfda9d745baca45389605c918b4f9
+  metadata.gz: 3e13c7b958e72b6551472ad5a12389bc88687984b2d17f915f31a34dc2a420e8
+  data.tar.gz: 8682f4628c10fda39dcf7953ce0a31af1947af8507b5fc9ea41593ed8e4e3cba
 SHA512:
-  metadata.gz: e6c68d68dc1d5f062d3febb563064730680ffe1099358bb6da27238eca58a7f5e6f221f82d9591b0015e0f1252d20fadf2fc2e70098951bc4da50417d070d85e
-  data.tar.gz: e2129c54272cd36c5dbf7aa71d54abc0ed082dcd0cd5ad6f3c267aeb0b2c2b6b8475b4273f8fc8b0927f421fb36db95e8abc006f4120397a711462d574da6949
+  metadata.gz: 0535ec8e3b2a0c4d03f3150a1c8f551b2a32a4cf0c387d00b82b1d16f2b75e5fda2111fa8686febd3a36be2acaed68f165d08c99a6fa36a1515dbd4e129e9406
+  data.tar.gz: c2546356d7833043fbc7664afacba069ed21d9b8d5f460a58688f8714bd51dacaca95a60ce6319e3d19c6f54ad05faa57717af087c9e2085c5755b1d50efefe3

data/README.md

@@ -2,7 +2,7 @@
 
 [![License](https://img.shields.io/badge/license-MIT--2.0-blue.svg?style=flat)][license]
 
-This is a small tcp server for [JRuby].
+This is a small tcp server for [JRuby] available as a [ruby gem](https://rubygems.org/gems/tcp-server).
 
 It is based on the [Netty project].  Netty is written in java, but I wanted to write ruby.
 
@@ -14,7 +14,7 @@ Follow these instructions to get a tcp server echo program running.
 
 ### Docker
 
-You may run the websocket server in a container.
+You may run the websocket server in a container. The [`colima`](https://github.com/abiosoft/colima) for a container runtime is recommended.
 
 ```sh
 colima start
@@ -24,7 +24,7 @@ docker-compose up
 Building the image or running the container:
 
 ```sh
-docker build --squash --tag tcp-server-jruby .
+docker build --tag tcp-server-jruby .
 docker run --detach --publish 4000:4000 --name tcp-server-jruby tcp-server-jruby
 ```
 
@@ -76,7 +76,7 @@ bundle install
 The entrypoint for the web application service may now be invoked from a command line interface terminal shell.
 
 ```sh
-bundle exec ./server.rb
+bundle exec ./tcp_server.rb
 ```
 
 
@@ -93,6 +93,15 @@ bundle exec rake
 
 To publish the gem after first verifying that the built gem works, execute:
 
+```sh
+version=$(ruby -r lib/server/version -I . -e 'puts ::Server::VERSION')
+git tag --annotate --message "Release ${version}" "${version}-release"
+git push origin --tags
+```
+
+
+Or manually, if necessary:
+
 ```sh
 bundle exec rake verify
 bundle exec rake publish
@@ -113,7 +122,82 @@ bundle exec rake clean clobber
 Here is a bird's-eye view of the project layout.
 
 ```sh
-# date && tree
+# date && tree -I "logs|vendor|tmp"
+Thu Jun 16 00:03:23 CDT 2022
+.
+├── Dockerfile
+├── Gemfile
+├── Gemfile.lock
+├── LICENSE
+├── README.md
+├── Rakefile
+├── docker-compose.yaml
+├── exe
+│   └── tcp_server
+├── lib
+│   ├── client.rb
+│   ├── demo_listener.rb
+│   ├── log.rb
+│   ├── server
+│   │   ├── argument_parser.rb
+│   │   ├── channel_initializer.rb
+│   │   ├── config.rb
+│   │   ├── instance_methods.rb
+│   │   ├── listenable.rb
+│   │   ├── message_handler.rb
+│   │   ├── modular_handler.rb
+│   │   ├── server.rb
+│   │   ├── shutdown_hook.rb
+│   │   └── version.rb
+│   ├── server.rb
+│   ├── tcp-server.rb
+│   └── tcp_server.rb
+├── spec
+│   ├── spec_helper.rb
+│   ├── test_spec.rb
+│   └── verify
+│       └── verify_spec.rb
+├── tcp-server-1.0.2-java.gem
+├── tcp-server-jruby.gemspec
+├── tcp_server.png
+└── tcp_server.rb
+
+5 directories, 31 files
+```
+
+## CI linting
+
+Use the GitLab CI Linting API to validate the syntax of a CI definition file.
+
+```sh
+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
+```
+
+Use the GitLab Project-level Variables API to add the deploy key as a ssh private key variable.
+
+```sh
+project_path="nelsnelson/$(basename $(pwd))"
+
+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
+```
+
+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
 ```
 
 [license]: https://gitlab.com/nelsnelson/tcp-server-jruby/blob/master/LICENSE

data/lib/demo_listener.rb

@@ -0,0 +1,31 @@
+# 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
+  # The Demo class
+  class Demo
+    def channel_active(ctx)
+      ::Server.log.info "Channel active: #{ctx.channel}"
+      response = 'Hello, world!'
+      log.trace "Sending response: #{response.inspect}"
+      ctx.channel.writeAndFlush("#{response}\n")
+    end
+
+    def exception_caught(_ctx, cause)
+      ::Server.log.error "Exception caught: #{cause}"
+      cause.backtrace.each { |t| ::Server.log.error t }
+      ctx.close()
+    end
+  end
+end
+# module Server

data/lib/server/channel_initializer.rb

@@ -36,17 +36,17 @@ module Server
     # constant definitions could not be used.
     Decoder = StringDecoder.new
     Encoder = StringEncoder.new
-    attr_accessor :handlers
+    attr_accessor :user_handlers
     attr_reader :options
 
     def initialize(options = {})
       super()
       @options = options
-      @handlers = []
+      @user_handlers = []
     end
 
     def <<(handler)
-      @handlers << handler
+      @user_handlers << handler
     end
 
     def initChannel(channel)
@@ -64,7 +64,7 @@ module Server
     protected
 
     def add_user_handlers(pipeline)
-      @handlers.each do |handler|
+      @user_handlers.each do |handler|
         case handler
         when Class then pipeline.addLast(handler.new)
         when Proc then pipeline.addLast(Server::MessageHandler.new(&handler))
@@ -93,23 +93,19 @@ module Server
 
     def ssl_handler(channel)
       handler = ssl_handler_instance(channel)
-      handler.handshake_future.addListener(SslHandshakeFutureListener.new)
+      handler.handshake_future.addListener(ssl_handshake_future_listener)
       handler
     end
 
-    # The SslHandshakeFutureListener class
-    class SslHandshakeFutureListener
-      include FutureListener
-      # @Override
-      #
-      # public void operationComplete(Future<Channel> future) throws Exception
-      def operationComplete(future)
+    def ssl_handshake_future_listener(listener = Object.new.extend(FutureListener))
+      listener.define_singleton_method(:operationComplete) do |future|
         raise future.cause unless future.success?
         session = future.now.pipeline.get('SslHandler#0')&.engine&.session
         ::Server.log.info "Channel protocol: #{session.protocol}, cipher suite: #{session.cipher_suite}"
       rescue StandardError => e
-        ::Server.log.warn e.message
+        ::Server.log.warn "Error handling operation complete event: #{e.message}"
       end
+      listener
     end
 
     def ssl_engine(ssl_ctx)

data/lib/server/instance_methods.rb

@@ -27,14 +27,14 @@ module Server
   # The InstanceMethods module
   module InstanceMethods
     def configure_handlers(&block)
-      ::Server::ChannelInitializer::DefaultHandler.add_listener(self)
+      add_listener(self)
       channel_initializer << block if block_given?
     end
 
     def bootstrap
       @bootstrap = ServerBootstrap.new
       @bootstrap.group(boss_group, worker_group)
-      @bootstrap.channel(::Server::CHANNEL_TYPE)
+      @bootstrap.channel(Server::CHANNEL_TYPE)
       @bootstrap.option(ChannelOption::SO_BACKLOG, 100.to_java(java.lang.Integer))
       @bootstrap.handler(logging_handler) if options[:log_requests]
       @bootstrap.childHandler(channel_initializer)
@@ -71,8 +71,7 @@ module Server
     rescue java.net.SocketException => e
       raise "Socket error: #{e.message}: #{options[:host]}:#{port}"
     ensure
-      boss_group&.shutdownGracefully()
-      worker_group&.shutdownGracefully()
+      stop
     end
     # rubocop: enable Metrics/AbcSize
     # rubocop: enable Metrics/MethodLength
@@ -82,9 +81,18 @@ module Server
       ::Server::Channels.close().awaitUninterruptibly()
     end
 
+    def stop
+      boss_group&.shutdownGracefully()
+      worker_group&.shutdownGracefully()
+    end
+
     def <<(handler)
       channel_initializer << handler
     end
+
+    def add_listener(listener)
+      ::Server::ChannelInitializer::DefaultHandler.add_listener(listener)
+    end
   end
   # module ServerInstanceMethods
 end

data/lib/server/modular_handler.rb

@@ -104,7 +104,7 @@ module Server
       ::Server.log.warn "##{__method__} channel: #{ctx.channel}, cause: #{cause.message}"
       cause.backtrace.each { |t| ::Server.log.error t }
       listeners = notify :exception_caught, ctx, cause
-      super(ctx, cause) if listeners.empty?
+      super(ctx, cause) if listeners.nil? || listeners.empty?
     end
 
     IdentiferTemplate = '#<%<class>s:0x%<id>s>'.freeze

data/lib/server/server.rb

@@ -18,15 +18,14 @@ require_relative 'listenable'
 
 # The Server module
 module Server
-  CHANNEL_TYPE = Java::io.netty.channel.socket.nio.NioServerSocketChannel.java_class
-
   # The Server class sets up the netty server.
   class Server
+    CHANNEL_TYPE = Java::io.netty.channel.socket.nio.NioServerSocketChannel.java_class
     include ::Server::InstanceMethods
     attr_reader :options
 
     def initialize(params = {}, &block)
-      @options = params.fetch(:options, {})
+      @options = ::Server::Config::DEFAULTS.merge(params.fetch(:options, {}))
       configure_handlers(&block)
     end
 
@@ -40,10 +39,6 @@ module Server
       log.debug "Sending response: #{response.inspect}"
       ctx.writeAndFlush("#{response}\n")
     end
-
-    def add_listener(listener)
-      ::Server::ChannelInitializer::DefaultHandler.add_listener(listener)
-    end
     # rubocop: enable Metrics/AbcSize
   end
   # class Server

data/lib/server/shutdown_hook.rb

@@ -28,7 +28,7 @@ module Server
     def run
       $stdout.write "\r\e[0K"
       $stdout.flush
-      Server.log.info 'Shutting down'
+      ::Server.log.info 'Shutting down'
       @server.shutdown if server.respond_to?(:shutdown)
     end
   end

data/lib/server/version.rb

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

data/lib/server.rb

@@ -20,22 +20,6 @@ require_relative 'server/server'
 module Server
   InterruptTemplate = "\r%<class>s".freeze
 
-  # The Demo class
-  class Demo
-    def channel_active(ctx)
-      ::Server.log.info "Channel active: #{ctx.channel}"
-      response = 'Hello, world!'
-      log.trace "Sending response: #{response.inspect}"
-      ctx.channel.writeAndFlush("#{response}\n")
-    end
-
-    def exception_caught(_ctx, cause)
-      ::Server.log.error "Exception caught: #{cause}"
-      cause.backtrace.each { |t| ::Server.log.error t }
-      ctx.close()
-    end
-  end
-
   # rubocop: disable Metrics/AbcSize
   # rubocop: disable Metrics/MethodLength
   def main(args = parse_arguments)
@@ -56,4 +40,6 @@ module Server
 end
 # module Server
 
+require_relative 'demo_listener'
+
 Object.new.extend(::Server).main if $PROGRAM_NAME == __FILE__

data/lib/tcp-server.rb

@@ -0,0 +1,13 @@
+# 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
+
+require_relative 'server'

data/lib/tcp_server.rb

@@ -0,0 +1,13 @@
+# 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
+
+require_relative 'server'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcp-server
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.4
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-17 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - Rakefile
 - exe/tcp_server
 - lib/client.rb
+- lib/demo_listener.rb
 - lib/log.rb
 - lib/server.rb
 - lib/server/argument_parser.rb
@@ -119,6 +120,8 @@ files:
 - lib/server/server.rb
 - lib/server/shutdown_hook.rb
 - lib/server/version.rb
+- lib/tcp-server.rb
+- lib/tcp_server.rb
 homepage: https://rubygems.org/gems/tcp-server-jruby
 licenses:
 - MIT
@@ -144,5 +147,5 @@ requirements: []
 rubygems_version: 3.2.29
 signing_key:
 specification_version: 4
-summary: Server for JRuby packaged as a gem.
+summary: TCP Server for JRuby packaged as a gem.
 test_files: []