glottis 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a42b6e38fd2d75e8acbdc2dcf338453c34b69c7
-  data.tar.gz: 189a29629e5104997a16071815febe031ee1e794
+SHA256:
+  metadata.gz: c4738a04eaf3d36ff79c3b8b18e9408d825729e40a2314f76049aeb848e9fb23
+  data.tar.gz: 3bc4629dfdb5dbc0b9d55b78369fb4f5be2dc9032a0ac1b5b2f922fdff4b7a6d
 SHA512:
-  metadata.gz: 1cffde427455b740691132995a39ac6c1071a23f19bcef3744971958d414967c13ea4c9f28dabd521eef21dda5c074951dd311ee109ac81c6c4420514e1c253d
-  data.tar.gz: 22dd5726fef0948fd4c114dddaa52c02a01699bbbcbe155e15622fc0c7f2b59474ae2bbf2689cbc133fdba2590c0e2ff97bc7ec602d468d67749bf9dc15a5eab
+  metadata.gz: 8b36bbc01a00d869a1bd91f58ccc31348332244896e6bca5b6c2c2ba96ce8c1cdb8a16254a50fe4a4c005cc6b3d79a97f789bae8b4c01d6e084aa497f9bb4081
+  data.tar.gz: 74dcce5991937a677eddbe3ebd51de4f792cd0c47ecff50f4d606288fe12c880ef36b9e9c280de8c7f269bf1e82a50248b0d894e38c34b2be2924ad4de3b6070

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semmle.com/semver/1.0.0/).
+
+## [0.3.0] - 2026-07-24
+
+### Changed
+- Bumped required Ruby version to `>= 3.0.0`.
+- Removed `rb-readline` dependency in favor of Ruby standard library `reline`/`readline`.
+- Updated `slop` runtime dependency to `~> 4.10`.
+- Modernized gemspec metadata and file list configuration.
+- Updated RuboCop configuration for Ruby 3.0+ compatibility (`Layout/LineLength`).
+- Migrated CI from Travis CI to GitHub Actions (`.github/workflows/ci.yml`).
+
+### Added
+- Comprehensive RSpec test suite covering core client and handlers.

data/README.md

@@ -2,26 +2,47 @@
 
 A CLI for the [valyx](https://github.com/maxdeliso/valyx) message passing server.
 
+[![CI](https://github.com/maxdeliso/glottis/actions/workflows/ci.yml/badge.svg)](https://github.com/maxdeliso/glottis/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/glottis.svg)](https://badge.fury.io/rb/glottis)
+
+## Requirements
+
+- Ruby >= 3.0.0
+
 ## Installation
 
+Install the gem by executing:
+
     $ gem install glottis
 
+Or add it to your application's Gemfile:
+
+    $ gem 'glottis', '~> 0.3'
+
 ## Usage
 
-    $ glottis -h
+Run the `glottis` command-line executable:
+
+    $ glottis --host localhost --port 8080
+
+For help and available command line flags:
+
+    $ glottis --help
 
 ## Development
 
-To check the code:
+To run the test suite and linter:
 
-     $ bundle exec rake
+    $ bundle exec rake
 
 To install this gem onto your local machine:
 
-     $ bundle exec rake install
+    $ bundle exec rake install
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/maxdeliso/glottis.
 
-[![Gem Version](https://badge.fury.io/rb/glottis.svg)](https://badge.fury.io/rb/glottis)
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
 
 RuboCop::RakeTask.new(:rubocop)
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]
 
-task default: [:rubocop]

data/exe/glottis

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'slop'
 require 'glottis'
@@ -20,3 +21,4 @@ end
 Glottis::Client.new(opts[:host],
                     opts[:port],
                     verbose: opts[:verbose]).run
+

data/glottis.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'glottis/version'
 
@@ -11,19 +12,27 @@ Gem::Specification.new do |spec|
   spec.licenses      = ['MIT']
   spec.summary       = 'simple http messaging client'
   spec.homepage      = 'https://github.com/maxdeliso/glottis'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/maxdeliso/glottis'
+  spec.metadata['changelog_uri'] = 'https://github.com/maxdeliso/glottis/blob/main/CHANGELOG.md'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/maxdeliso/glottis/issues'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
+  spec.files         = Dir.glob('{exe,lib}/**/*') + %w[Rakefile README.md CHANGELOG.md glottis.gemspec]
+  spec.files         = spec.files.select { |f| File.file?(f) }
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rb-readline', '~> 0.5.3'
-  spec.add_runtime_dependency 'slop', '~> 4.2'
+  spec.add_runtime_dependency 'slop', '~> 4.10'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.37.2'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
 end
+
+

data/lib/glottis/client.rb

@@ -1,4 +1,5 @@
-require 'thread'
+# frozen_string_literal: true
+
 require 'logger'
 require 'glottis/handlers/console_input_handler'
 require 'glottis/handlers/console_output_handler'
@@ -6,10 +7,10 @@ require 'glottis/handlers/remote_input_handler'
 require 'glottis/handlers/remote_output_handler'
 
 module Glottis
-  # Client class, used to interact with the host specified.
+  # Client class used to interact with the specified host and port.
   class Client
     def self.logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new($stdout)
     end
 
     def initialize(host, port, opts = {})
@@ -17,12 +18,12 @@ module Glottis
       @port = port
       @outgoing = Queue.new
       @incoming = Queue.new
+      @handlers = []
       Client.logger.level = opts[:verbose] ? Logger::DEBUG : Logger::WARN
     end
 
     def run
       Client.logger.info('starting...')
-      Thread.abort_on_exception = true
 
       @handlers = [
         Handlers::ConsoleInputHandler.new(@outgoing),
@@ -31,14 +32,25 @@ module Glottis
         Handlers::RemoteOutputHandler.new(@outgoing, @host, @port)
       ]
 
+      @handlers.each(&:start)
       @handlers.each(&:join)
+    rescue Glottis::Exceptions::UserExitedException
+      Client.logger.info('User exited.')
+    rescue Interrupt
+      Client.logger.info('Received interrupt signal. Exiting...')
     rescue Errno::ECONNREFUSED => conn_ref
-      Client.logger.error("failed to connect: #{conn_ref}")
+      Client.logger.error("Failed to connect to host: #{conn_ref.message}")
     rescue StandardError => ex
-      Client.logger.warn("shutting down: #{ex}")
+      Client.logger.warn("Shutting down due to error: #{ex.message}")
     ensure
+      stop_handlers
+    end
+
+    private
+
+    def stop_handlers
       @handlers.each(&:cleanup)
-      exit(0)
-    end # run
-  end # Client
+    end
+  end
 end
+

data/lib/glottis/exceptions/glottis_exception.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module Glottis
   module Exceptions
     class GlottisException < StandardError
     end
   end
 end
+

data/lib/glottis/exceptions/user_exited_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'glottis/exceptions/glottis_exception'
 
 module Glottis
@@ -6,3 +8,4 @@ module Glottis
     end
   end
 end
+

data/lib/glottis/handlers/console_input_handler.rb

@@ -1,32 +1,50 @@
+# frozen_string_literal: true
+
 require 'glottis/exceptions/user_exited_exception'
 require 'readline'
 
 module Glottis
   module Handlers
-    # This class holds a reference to the outgoing message queue,
-    # and posts messages to it from the console as they are entered.
-    class ConsoleInputHandler < Thread
-      USER_PROMPT = '> '.freeze
+    # Holds a reference to the outgoing message queue and posts console input.
+    class ConsoleInputHandler
+      USER_PROMPT = '> '
 
       def initialize(outgoing)
         @outgoing = outgoing
-        super do
-          loop do
-            user_input = Readline.readline(USER_PROMPT)
-            Readline::HISTORY.push(user_input)
+        @running = false
+        @thread = nil
+      end
 
-            # if user_input.nil?
-            #   raise Glottis::Exceptions::UserExitedException.new
-            # end
+      def start
+        @running = true
+        @thread = Thread.new { run_loop }
+        self
+      end
 
-            @outgoing.push(user_input)
-          end
-        end
+      def join
+        @thread&.join
       end
 
       def cleanup
-        # do nothing
+        @running = false
+        @thread&.kill if @thread&.alive?
       end
-    end # ConsoleInputHandler
-  end # Handlers
-end # Glottis
+
+      private
+
+      def run_loop
+        while @running
+          user_input = Readline.readline(USER_PROMPT, true)
+
+          raise Glottis::Exceptions::UserExitedException, 'User exited readline stream' if user_input.nil?
+
+          @outgoing.push(user_input)
+        end
+      rescue Glottis::Exceptions::UserExitedException => ex
+        Client.logger.info("Console input ended: #{ex.message}")
+        raise ex
+      end
+    end
+  end
+end
+

data/lib/glottis/handlers/console_output_handler.rb

@@ -1,21 +1,41 @@
+# frozen_string_literal: true
+
 module Glottis
   module Handlers
-    # This class holds a reference to the incoming message queue,
-    # and displays messages in the console as they are received.
-    class ConsoleOutputHandler < Thread
+    # Holds a reference to incoming message queue and prints messages to stdout.
+    class ConsoleOutputHandler
       def initialize(incoming)
         @incoming = incoming
-        super do
-          loop do
-            new_msg = @incoming.pop
-            puts "#{new_msg['from']}, #{new_msg['to']}, #{new_msg['msg']}"
-          end
-        end
+        @running = false
+        @thread = nil
+      end
+
+      def start
+        @running = true
+        @thread = Thread.new { run_loop }
+        self
+      end
+
+      def join
+        @thread&.join
       end
 
       def cleanup
-        puts '|'
+        @running = false
+        @thread&.kill if @thread&.alive?
       end
-    end # ConsoleOutputHandler
-  end # Handlers
-end # Glottis
+
+      private
+
+      def run_loop
+        while @running
+          new_msg = @incoming.pop
+          break if new_msg.nil? || new_msg == :shutdown
+
+          puts "#{new_msg['from']}, #{new_msg['to']}, #{new_msg['msg']}"
+        end
+      end
+    end
+  end
+end
+

data/lib/glottis/handlers/remote_input_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'uri'
 require 'net/http'
@@ -5,11 +7,11 @@ require 'json'
 
 module Glottis
   module Handlers
-    # This class manages a TCP connection with a valyx server.
-    class RemoteInputHandler < Thread
-      PROTOCOL = 'http'.freeze
-      STREAM_DELIMITER = "\0".freeze
-      READ_TIMEOUT = 3600 # this needs to be high
+    # Manages stream input from the remote valyx server.
+    class RemoteInputHandler
+      PROTOCOL = 'http'
+      STREAM_DELIMITER = "\0"
+      READ_TIMEOUT = 3600
       REMOTE_PATHS = {
         get_message_stream: '/api/messages/stream'
       }.freeze
@@ -18,17 +20,29 @@ module Glottis
         @incoming = incoming
         @host = host
         @port = port
-
+        @running = false
+        @thread = nil
+        @buffer = String.new
         setup_http
+      end
 
-        super do
+      def start
+        @running = true
+        @thread = Thread.new do
           @http.start
           read_loop
         end
+        self
+      end
+
+      def join
+        @thread&.join
       end
 
       def cleanup
+        @running = false
         @http.finish if @http.started?
+        @thread&.kill if @thread&.alive?
       end
 
       private
@@ -42,12 +56,32 @@ module Glottis
       def read_loop
         Client.logger.info('reading stream...')
         @http.get(REMOTE_PATHS.fetch(:get_message_stream)) do |chunk|
+          break unless @running
+
           Client.logger.debug("got chunk of length: #{chunk.length}")
-          chunk.split(STREAM_DELIMITER).each do |msg_data|
-            @incoming.push(JSON.parse(msg_data))
-          end # each
-        end # get
-      end # read_loop
-    end # RemoteInputHandler
-  end # Handlers
-end # Glottis
+          process_chunk(chunk)
+        end
+      rescue StandardError => ex
+        Client.logger.error("Error reading message stream: #{ex.message}") if @running
+      end
+
+      def process_chunk(chunk)
+        @buffer << chunk
+
+        while (delimiter_index = @buffer.index(STREAM_DELIMITER))
+          msg_raw = @buffer.slice!(0..delimiter_index)
+          msg_data = msg_raw.chomp(STREAM_DELIMITER)
+          next if msg_data.empty?
+
+          begin
+            parsed_msg = JSON.parse(msg_data)
+            @incoming.push(parsed_msg)
+          rescue JSON::ParserError => err
+            Client.logger.warn("Failed to parse JSON payload: #{err.message}")
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/glottis/handlers/remote_output_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 require 'uri'
 require 'net/http'
@@ -5,10 +7,10 @@ require 'json'
 
 module Glottis
   module Handlers
-    # This class manages a TCP connection with a valyx server.
-    class RemoteOutputHandler < Thread
+    # Manages posting outgoing messages to the remote valyx server.
+    class RemoteOutputHandler
       POLL_INTERVAL = 0.1
-      PROTOCOL = 'http'.freeze
+      PROTOCOL = 'http'
 
       REMOTE_PATHS = {
         get_session: '/api/session',
@@ -19,28 +21,39 @@ module Glottis
         @outgoing = outgoing
         @host = host
         @port = port
-
+        @running = false
+        @thread = nil
+        @sid = nil
         setup_http
+      end
 
-        super do
+      def start
+        @running = true
+        @thread = Thread.new do
           @http.start
           request_session
 
-          loop do
+          while @running
             send_queued
           end
         end
+        self
+      end
+
+      def join
+        @thread&.join
       end
 
       def cleanup
+        @running = false
         @http.finish if @http.started?
+        @thread&.kill if @thread&.alive?
       end
 
       private
 
       def setup_http
         @http = Net::HTTP.new(@host, @port)
-        # TODO: make these configurable somewhere
         @http.open_timeout = 1
         @http.read_timeout = 1
       end
@@ -49,7 +62,6 @@ module Glottis
         Client.logger.info('making initial request for session...')
 
         session_req = @http.get(REMOTE_PATHS.fetch(:get_session))
-
         response = JSON.parse(session_req.body)
 
         if Integer(session_req.code) != 201
@@ -60,20 +72,20 @@ module Glottis
         Client.logger.info("current session id: #{@sid}")
       end
 
-      # given the result of a .get or .post, converts the response code,
-      # and executes the (side effecting) block if the response was not
-      # successful. calls the block with a message describing the error.
-      def if_not_ok(http_req, ok_code = 200, &_b)
+      def if_not_ok(http_req, ok_code = 200)
         yield http_req.body if Integer(http_req.code) != ok_code
       end
 
       def send_queued
+        raw_msg = @outgoing.pop
+        return if raw_msg.nil? || raw_msg == :shutdown
+
         Client.logger.info("processing message with #{@outgoing.size} messages outgoing")
 
         message_data = {
           from: @sid,
           to: '*',
-          msg: @outgoing.pop
+          msg: raw_msg
         }.to_json
 
         post_req = @http.post(REMOTE_PATHS.fetch(:post_message), message_data)
@@ -81,7 +93,8 @@ module Glottis
         if_not_ok(post_req) do |err|
           Client.logger.warn("failed to post message: #{message_data} #{err}")
         end
-      end # send_queued
-    end # RemoteOutputHandler
-  end # Handlers
-end # Glottis
+      end
+    end
+  end
+end
+

data/lib/glottis/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Glottis
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.3.0'
 end

data/lib/glottis.rb

@@ -1,2 +1,5 @@
+# frozen_string_literal: true
+
 require 'glottis/version'
 require 'glottis/client'
+

metadata

@@ -1,86 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: glottis
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Max DeLiso
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rb-readline
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '4.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.3
+        version: '4.10'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.37.2
-description: 
+        version: '1.0'
 email:
 - maxdeliso@gmail.com
 executables:
@@ -88,14 +86,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - exe/glottis
 - glottis.gemspec
 - lib/glottis.rb
@@ -110,8 +103,12 @@ files:
 homepage: https://github.com/maxdeliso/glottis
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/maxdeliso/glottis
+  source_code_uri: https://github.com/maxdeliso/glottis
+  changelog_uri: https://github.com/maxdeliso/glottis/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/maxdeliso/glottis/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -119,16 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: simple http messaging client
 test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.log
-*.gem

data/.rubocop.yml

@@ -1,5 +0,0 @@
-Metrics/LineLength:
-  Max: 99
-
-Metrics/MethodLength:
-  Max: 20

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.5
-before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in glottis.gemspec
-gemspec

data/bin/console

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'glottis'
-require 'irb'
-
-IRB.start

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here