tcp-server 1.0.2-java → 1.0.5-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b184708a43ed78e29a2668c85b546b34120f0358f6224bc6bf8c7895dbb1eb6
-  data.tar.gz: 176d29aab7223469f089f54d2f0d90e3dcec2bda8fd5dbe054af90783a619138
+  metadata.gz: 4915c8f9c555eccbae820aef2e73e1742a27da1765616019d5a48c9b62e40264
+  data.tar.gz: 79a2ef5e23262aea916f25b0244e4ba965d4ecdeffd609c254899ca51a5f5d06
 SHA512:
-  metadata.gz: 417b281f16bfd53faf2be531c23c22e98c2e3ed92b64cb393f6d51d98d3d8ec2c895336aae7b87fa7fcd500fa3eaa279804e0ab1e8415aa3b547ab8fd35b6859
-  data.tar.gz: 49855312f85969ed83a8d254b500f73b01c5448948bd75dab6e337aad0582104359cd366ad03be4d74e33faaccb26fff094e64bab81338a7ec4a4a43da7cf805
+  metadata.gz: d8436967a6786d2321eda7d4ffd7248d8f128d5c2d8b48dc1b3b30a064553067ce5abd5f1a09d87fb3161106614c1370465c17216c703e2d6333a5314a7a7f8e
+  data.tar.gz: 47989e7e6028d4f421cea50e328e7b35abcc5007c86f90864ceb1ebc72a408310ad256aea949e9e9a7b9eb1082b211797eae96097afb447b3ea479713d0e234a

data/README.md

@@ -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,8 +122,8 @@ bundle exec rake clean clobber
 Here is a bird's-eye view of the project layout.
 
 ```sh
-# date && tree
-Wed May  4 22:41:11 CDT 2022
+# date && tree -I "logs|vendor|tmp"
+Thu Jun 16 00:03:23 CDT 2022
 .
 ├── Dockerfile
 ├── Gemfile
@@ -127,6 +136,7 @@ Wed May  4 22:41:11 CDT 2022
 │   └── tcp_server
 ├── lib
 │   ├── client.rb
+│   ├── demo_listener.rb
 │   ├── log.rb
 │   ├── server
 │   │   ├── argument_parser.rb
@@ -139,17 +149,20 @@ Wed May  4 22:41:11 CDT 2022
 │   │   ├── server.rb
 │   │   ├── shutdown_hook.rb
 │   │   └── version.rb
-│   └── server.rb
-├── logs
+│   ├── 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
 
-6 directories, 26 files
+5 directories, 31 files
 ```
 
 ## CI linting
@@ -160,6 +173,33 @@ 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
+```
+
+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
 [asdf]: https://asdf-vm.com/
 [Netty project]: https://github.com/netty/netty

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

@@ -30,23 +30,23 @@ module Server
 
   # The ChannelInitializer class
   class ChannelInitializer < Java::io.netty.channel.ChannelInitializer
-    DefaultHandler = ModularHandler.new
+    DefaultServerHandler = ModularHandler.new
     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
-    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)
@@ -58,16 +58,16 @@ module Server
         Encoder
       )
       add_user_handlers(pipeline)
-      pipeline.addLast(DefaultHandler)
+      pipeline.addLast(DefaultServerHandler)
     end
 
     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))
+        when Proc then pipeline.addLast(::Server::MessageHandler.new(&handler))
         else pipeline.addLast(handler)
         end
       end

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::DefaultServerHandler.add_listener(listener)
+    end
   end
   # module ServerInstanceMethods
 end

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/version.rb

@@ -12,5 +12,5 @@
 
 # The Server module
 module Server
-  VERSION = '1.0.2'.freeze
+  VERSION = '1.0.5'.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.2
+  version: 1.0.5
 platform: java
 authors:
 - Nels Nelson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-22 00:00:00.000000000 Z
+date: 2022-06-20 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: []