omq 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2e17e1a12c0f44bec5af914b8df2f810029e75c7da17e79e862428a7b0aa99d
-  data.tar.gz: 4a8d06116bad67adc4411cb3281302fd6190ecce46ceb47f21cc15a32c3e9006
+  metadata.gz: a14af693117ccfb193f54e9bc2a4faae9c2bf6396e7769abee97f279fd62fdba
+  data.tar.gz: 1f5e99ae3b61402d2b9e506c84fdb07d2003695515d3f736159cf2c373cc39d0
 SHA512:
-  metadata.gz: 1dad86f1ad0648690bc5a01d3b7258b89f301d4768bac0831495d27f0a0e3c84f5a30af049732f8cc6885bcd6105654d41708d519da69c30a62739ca58a27418
-  data.tar.gz: a71f54aa26dd3e7dea3b249d027c03aeff896c7ded7b0581067fbda609d114c976c8d35a5f7f7e630cbbc34fbb839c7d43f6d445e8f2bb50f1348cb46f8d0e51
+  metadata.gz: 76539e2a9fbdcbe59590e1fa499e300b8f7ad3d527255af6f94665139c3c0a60151f0b82202df372df1cdbc16e90f46369aa7b159342f951cf52babc897b837c
+  data.tar.gz: dba241d3283a0a0330ba0d12081c08f3ae074acaa8be7b1e9292dee9c19a483d822f896a4442ec585005dbeb36efa704b87f51c53e07c1de0ede54a85150f55c

data/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## 0.9.0 — 2026-03-31
+
+### Breaking
+
+- **CLI extracted into omq-cli gem** — the `omq` executable, all CLI
+  code (`lib/omq/cli/`), tests, and `CLI.md` have moved to the
+  [omq-cli](https://github.com/paddor/omq-cli) gem. `gem install omq`
+  no longer provides the `omq` command — use `gem install omq-cli`.
+- **`OMQ.outgoing` / `OMQ.incoming`** registration API moved to omq-cli.
+  Library-only users are unaffected (these were CLI-specific).
+
+### Changed
+
+- **Gemspec is library-only** — no `exe/`, no `bindir`, no `executables`.
+- **README** — restored title, replaced inline CLI section with a
+  pointer to omq-cli, fixed ZMTP attribution for protocol-zmtp.
+- **DESIGN.md** — acknowledged protocol-zmtp, clarified transient
+  task / linger interaction, removed ZMTP wire protocol section (now in
+  protocol-zmtp), simplified inproc description, removed CLI section.
+
+## 0.8.0 — 2026-03-31
+
+### Breaking
+
+- **CURVE mechanism moved to protocol-zmtp** — `OMQ::ZMTP::Mechanism::Curve`
+  is now `Protocol::ZMTP::Mechanism::Curve` with a required `crypto:` parameter.
+  Pass `crypto: RbNaCl` (libsodium) or `crypto: Nuckle` (pure Ruby). The
+  omq-curve and omq-kurve gems are superseded.
+
+  ```ruby
+  # Before (omq-curve)
+  require "omq/curve"
+  rep.mechanism = OMQ::Curve.server(pub, sec)
+
+  # After (protocol-zmtp + any NaCl backend)
+  require "protocol/zmtp/mechanism/curve"
+  require "nuckle"  # or: require "rbnacl"
+  rep.mechanism = Protocol::ZMTP::Mechanism::Curve.server(pub, sec, crypto: Nuckle)
+  ```
+
+### Changed
+
+- **Protocol layer extracted into protocol-zmtp gem** — Codec (Frame,
+  Greeting, Command), Connection, Mechanism::Null, Mechanism::Curve,
+  ValidPeers, and Z85 now live in the
+  [protocol-zmtp](https://github.com/paddor/protocol-zmtp) gem. OMQ
+  re-exports them under `OMQ::ZMTP::` for backwards compatibility.
+  protocol-zmtp has zero runtime dependencies.
+- **Unified CURVE mechanism** — one implementation with a pluggable
+  `crypto:` backend replaces the two near-identical copies in omq-curve
+  (RbNaCl) and omq-kurve (Nuckle). 1,088 → 467 lines (57% reduction).
+- **Heartbeat ownership** — `Connection#start_heartbeat` removed.
+  Connection tracks timestamps only; the engine drives the PING/PONG loop.
+- **CI no longer needs libsodium** — CURVE tests use
+  [nuckle](https://github.com/paddor/nuckle) (pure Ruby) by default.
+  Cross-backend interop tests run when rbnacl is available.
+
 ## 0.7.0 — 2026-03-30
 
 ### Breaking
@@ -502,4 +559,4 @@ Initial release. Pure Ruby implementation of ZMTP 3.1 (ZeroMQ) using Async.
 - Linger on close (drain send queue before closing)
 - `max_message_size` enforcement
 - Works inside Async reactors or standalone (shared IO thread)
-- Optional CURVE encryption via the [omq-curve](https://github.com/zeromq/omq-curve) gem
+- Optional CURVE encryption via the [protocol-zmtp](https://github.com/paddor/protocol-zmtp) gem

data/README.md

@@ -1,4 +1,4 @@
-# OMQ — ZeroMQ in pure Ruby
+# OMQ — Where did the C dependency go!?
 
 [![CI](https://github.com/zeromq/omq/actions/workflows/ci.yml/badge.svg)](https://github.com/zeromq/omq/actions/workflows/ci.yml)
 [![Gem Version](https://img.shields.io/gem/v/omq?color=e9573f)](https://rubygems.org/gems/omq)
@@ -7,7 +7,7 @@
 
 `gem install omq` — that's it. No libzmq, no compiler, no system packages. Just Ruby.
 
-OMQ implements the [ZMTP 3.1](https://rfc.zeromq.org/spec/23/) wire protocol from scratch using [Async](https://github.com/socketry/async) fibers. It speaks native ZeroMQ on the wire and interoperates with libzmq, pyzmq, CZMQ, and everything else in the ZMQ ecosystem.
+OMQ builds ZeroMQ socket patterns on top of [protocol-zmtp](https://github.com/paddor/protocol-zmtp) (a pure Ruby [ZMTP 3.1](https://rfc.zeromq.org/spec/23/) codec) using [Async](https://github.com/socketry/async) fibers. It speaks native ZeroMQ on the wire and interoperates with libzmq, pyzmq, CZMQ, and everything else in the ZMQ ecosystem.
 
 > **234k msg/s** inproc | **49k msg/s** ipc | **36k msg/s** tcp
 >
@@ -31,12 +31,12 @@ See [GETTING_STARTED.md](GETTING_STARTED.md) for a ~30 min walkthrough of all ma
 
 - **Zero dependencies on C** — no extensions, no FFI, no libzmq. `gem install` just works everywhere
 - **Fast** — YJIT-optimized hot paths, batched sends, 234k msg/s inproc with 12 µs latency
-- **`omq` CLI** — pipe, filter, and transform messages from the terminal with Ruby eval, Ractor parallelism, and [script handlers](CLI.md#script-handlers--r)
+- **[`omq` CLI](https://github.com/paddor/omq-cli)** — `gem install omq-cli` for a command-line tool with Ruby eval, Ractor parallelism, and script handlers
 - **Every socket pattern** — req/rep, pub/sub, push/pull, dealer/router, xpub/xsub, pair, and all draft types
 - **Every transport** — tcp, ipc (Unix domain sockets), inproc (in-process queues)
 - **Async-native** — built on fibers, non-blocking from the ground up. A shared IO thread handles sockets outside of Async — no reactor needed for simple scripts
 - **Wire-compatible** — interoperates with libzmq, pyzmq, CZMQ over tcp and ipc
-- **Bind/connect order doesn't matter** — connect before bind, bind before connect, peers come and go. ZeroMQ reconnects and requeues automatically
+- **Bind/connect order doesn't matter** — connect before bind, bind before connect, peers come and go. ZeroMQ reconnects automatically and queued messages drain when peers arrive
 
 For architecture internals, see [DESIGN.md](DESIGN.md).
 
@@ -150,58 +150,18 @@ All sockets are thread-safe. Default HWM is 1000 messages per socket. Classes li
 | **PEER** | Routing-ID | Fair-queue | Block |
 | **CHANNEL** | Exclusive 1-to-1 | Exclusive 1-to-1 | Block |
 
-## omq — CLI tool
+## CLI
 
-`omq` is a command-line tool for sending and receiving messages on any OMQ socket. Like `nngcat` from libnng, but with Ruby superpowers.
+Install [omq-cli](https://github.com/paddor/omq-cli) for a command-line tool that sends, receives, pipes, and transforms ZeroMQ messages from the terminal:
 
 ```sh
-# Echo server
-omq rep -b tcp://:5555 --echo
-
-# Upcase server — -e evals Ruby on each incoming message
-omq rep -b tcp://:5555 -e '$F.map(&:upcase)'
+gem install omq-cli
 
-# Client
+omq rep -b tcp://:5555 --echo
 echo "hello" | omq req -c tcp://localhost:5555
-# => HELLO
-
-# PUB/SUB
-omq sub -b tcp://:5556 -s "weather."  &
-echo "weather.nyc 72F" | omq pub -c tcp://localhost:5556 -d 0.3
-
-# Pipeline with filtering
-tail -f /var/log/syslog | omq push -c tcp://collector:5557
-omq pull -b tcp://:5557 -e 'next unless /error/; $F'
-
-# Transform outgoing messages with -E
-echo hello | omq push -c tcp://localhost:5557 -E '$F.map(&:upcase)'
-
-# REQ: transform request and reply independently
-echo hello | omq req -c tcp://localhost:5555 \
-  -E '$F.map(&:upcase)' -e '$F.map(&:reverse)'
-
-# Pipe: PULL → eval → PUSH in one process
-omq pipe -c ipc://@work -c ipc://@sink -e '$F.map(&:upcase)'
-
-# Pipe with Ractor workers for CPU parallelism (-P = all CPUs)
-omq pipe -c ipc://@work -c ipc://@sink -P -r./fib -e 'fib(Integer($_)).to_s'
-```
-
-`-e` (recv-eval) transforms incoming messages, `-E` (send-eval) transforms outgoing messages. `$F` is the message parts array, `$_` is the first part. Use `-r` to require gems or load scripts that register handlers via `OMQ.incoming` / `OMQ.outgoing`:
-
-```ruby
-# my_handler.rb
-db = DB.connect("postgres://localhost/app")
-
-OMQ.incoming { db.query($F.first) }
-at_exit { db.close }
-```
-
-```sh
-omq pull -b tcp://:5557 -r./my_handler.rb
 ```
 
-See [CLI.md](CLI.md) for full documentation, or `omq --help` / `omq --examples`.
+See the [omq-cli README](https://github.com/paddor/omq-cli) for full documentation.
 
 ## Development
 

data/lib/omq/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OMQ
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/omq/zmtp/engine.rb

@@ -432,17 +432,14 @@ module OMQ
       def setup_connection(io, as_server:, endpoint: nil, done: nil)
         conn = Connection.new(
           io,
-          socket_type:        @socket_type.to_s,
-          identity:           @options.identity,
-          as_server:          as_server,
-          mechanism:          @options.mechanism,
-          heartbeat_interval: @options.heartbeat_interval,
-          heartbeat_ttl:      @options.heartbeat_ttl,
-          heartbeat_timeout:  @options.heartbeat_timeout,
-          max_message_size:   @options.max_message_size,
+          socket_type:      @socket_type.to_s,
+          identity:         @options.identity,
+          as_server:        as_server,
+          mechanism:        @options.mechanism&.dup,
+          max_message_size: @options.max_message_size,
         )
         conn.handshake!
-        conn.start_heartbeat
+        start_heartbeat(conn)
         @connections << conn
         @connection_endpoints[conn] = endpoint if endpoint
         @connection_promises[conn]  = done if done
@@ -454,6 +451,35 @@ module OMQ
       end
 
 
+      # Spawns a heartbeat task for the connection.
+      # The connection only tracks timestamps — the engine drives the loop.
+      #
+      # @param conn [Connection]
+      # @return [void]
+      #
+      def start_heartbeat(conn)
+        interval = @options.heartbeat_interval
+        return unless interval
+
+        ttl     = @options.heartbeat_ttl || interval
+        timeout = @options.heartbeat_timeout || interval
+        conn.touch_heartbeat
+
+        @tasks << Reactor.spawn_pump(annotation: "heartbeat") do
+          loop do
+            sleep interval
+            conn.send_command(Codec::Command.ping(ttl: ttl, context: "".b))
+            if conn.heartbeat_expired?(timeout)
+              conn.close
+              break
+            end
+          end
+        rescue *CONNECTION_LOST
+          # connection closed
+        end
+      end
+
+
       # Spawns a background task that reconnects to the given endpoint
       # with exponential back-off based on the reconnect_interval option.
       #

data/lib/omq/zmtp.rb

@@ -1,13 +1,26 @@
 # frozen_string_literal: true
 
+require "protocol/zmtp"
+require "io/stream"
+
 module OMQ
   # ZMTP 3.1 protocol internals.
   #
-  # These classes implement the wire protocol, transports, and routing
-  # strategies. They are not part of the public API.
+  # The wire protocol (codec, connection, mechanisms) lives in the
+  # protocol-zmtp gem. This module re-exports those classes under the
+  # OMQ::ZMTP namespace and adds the transport/routing/engine layers.
   #
   module ZMTP
-    require "io/stream"
+    # Re-export protocol-zmtp classes
+    Codec         = Protocol::ZMTP::Codec
+    Connection    = Protocol::ZMTP::Connection
+    ProtocolError = Protocol::ZMTP::Error
+    VALID_PEERS   = Protocol::ZMTP::VALID_PEERS
+
+    module Mechanism
+      Null  = Protocol::ZMTP::Mechanism::Null
+      Curve = Protocol::ZMTP::Mechanism::Curve if defined?(Protocol::ZMTP::Mechanism::Curve)
+    end
 
     # Errors raised when a peer disconnects or resets the connection.
     CONNECTION_LOST = [
@@ -32,24 +45,14 @@ module OMQ
   end
 end
 
-# Constants
-require_relative "zmtp/valid_peers"
-
-# Codec
-require_relative "zmtp/codec"
-
 # Transport
 require_relative "zmtp/transport/inproc"
 require_relative "zmtp/transport/tcp"
 require_relative "zmtp/transport/ipc"
 
-# Mechanisms
-require_relative "zmtp/mechanism/null"
-
 # Core
 require_relative "zmtp/reactor"
 require_relative "zmtp/options"
-require_relative "zmtp/connection"
 require_relative "zmtp/routing"
 require_relative "zmtp/routing/round_robin"
 require_relative "zmtp/routing/fan_out"

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Patrik Wenger
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: protocol-zmtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: async
   requirement: !ruby/object:Gem::Requirement
@@ -37,40 +51,21 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.11'
-description: Pure Ruby implementation of the ZMTP 3.1 wire protocol (ZeroMQ) with
-  all socket types (REQ/REP, PUB/SUB, PUSH/PULL, DEALER/ROUTER, and draft types) and
-  TCP/IPC/inproc transports. Includes an `omq` CLI for composable message pipelines
-  — pipe, filter, and transform across processes with Ruby eval, multiple formats
-  (JSON, msgpack, marshal), Ractor parallelism, and compression. No native libraries
+description: Pure Ruby implementation of ZeroMQ with all socket types (REQ/REP, PUB/SUB,
+  PUSH/PULL, DEALER/ROUTER, and draft types) and TCP/IPC/inproc transports. Built
+  on protocol-zmtp (ZMTP 3.1 wire protocol) and Async fibers. No native libraries
   required.
 email:
 - paddor@gmail.com
-executables:
-- omq
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- exe/omq
 - lib/omq.rb
 - lib/omq/channel.rb
-- lib/omq/cli.rb
-- lib/omq/cli/base_runner.rb
-- lib/omq/cli/channel.rb
-- lib/omq/cli/client_server.rb
-- lib/omq/cli/config.rb
-- lib/omq/cli/formatter.rb
-- lib/omq/cli/pair.rb
-- lib/omq/cli/peer.rb
-- lib/omq/cli/pipe.rb
-- lib/omq/cli/pub_sub.rb
-- lib/omq/cli/push_pull.rb
-- lib/omq/cli/radio_dish.rb
-- lib/omq/cli/req_rep.rb
-- lib/omq/cli/router_dealer.rb
-- lib/omq/cli/scatter_gather.rb
 - lib/omq/client_server.rb
 - lib/omq/pair.rb
 - lib/omq/peer.rb
@@ -83,13 +78,7 @@ files:
 - lib/omq/socket.rb
 - lib/omq/version.rb
 - lib/omq/zmtp.rb
-- lib/omq/zmtp/codec.rb
-- lib/omq/zmtp/codec/command.rb
-- lib/omq/zmtp/codec/frame.rb
-- lib/omq/zmtp/codec/greeting.rb
-- lib/omq/zmtp/connection.rb
 - lib/omq/zmtp/engine.rb
-- lib/omq/zmtp/mechanism/null.rb
 - lib/omq/zmtp/options.rb
 - lib/omq/zmtp/reactor.rb
 - lib/omq/zmtp/readable.rb
@@ -119,7 +108,6 @@ files:
 - lib/omq/zmtp/transport/inproc.rb
 - lib/omq/zmtp/transport/ipc.rb
 - lib/omq/zmtp/transport/tcp.rb
-- lib/omq/zmtp/valid_peers.rb
 - lib/omq/zmtp/writable.rb
 homepage: https://github.com/zeromq/omq
 licenses:
@@ -141,5 +129,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Pure Ruby ZMQ library + CLI
+summary: Pure Ruby ZMQ library
 test_files: []

data/exe/omq

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-Warning[:experimental] = false
-
-require_relative "../lib/omq/cli"
-OMQ::CLI.run