omq 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d77750001a2c45808301e5a005f83c8a6f4df44ffa033aa121cc9229b597347
-  data.tar.gz: b009c94d5ea30d5e0983831fb443e1ceb31e8980725b1b9c75b9403814a7a469
+  metadata.gz: d49a1c7caa7a1548615285ae294341b31833fd02bb60a7fa7cbfc0ed5c707d79
+  data.tar.gz: db36537c5dab13faa9cbdbe611c282cbf9dd96726e88145f80c3aaa7bf3df8a5
 SHA512:
-  metadata.gz: e6612b16ae23874f1539154f108359190ac70eeaf9691c326deb4b2545151590e4458071912a987258b9d59cf80c5015024fbfa546d1f5bbcd979564be5cdffe
-  data.tar.gz: 7706e73997b1a96446e6c5e6053756e57e4b33d6b084a82c49f78e40b9454aa26aed1d5e3ca14207c450be75864707618c3a87cf27c750020064393dbe85c71f
+  metadata.gz: 3e3a9e5a0b9ee3857a2946e7468ea2ca30c87544fa75965c79b1ea905c3a8d969aeb94b49282acd502d2ffbb6a0db5b2952f7a18a17e90363f1c5ed13cfbecd4
+  data.tar.gz: 1cb5f13312278d55684f22c420f17287a922633eebdfd143336415aafdc725dd7a38e23b5f9387cc55bf28acc0b125840c5770ef9112556b97b7c3cca8578ee6

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 0.4.0 — 2026-03-27
+
+### Added (omqcat)
+
+- `--curve-server` flag — generates ephemeral keypair, prints
+  `OMQ_SERVER_KEY=...` to stderr for easy copy-paste
+- `--curve-server-key KEY` flag — CURVE client mode from the CLI
+- `--echo` flag for REP — explicit echo mode
+- REP reads stdin/`-F` as reply source (one line per reply, exits at EOF)
+- REP without a reply source now aborts with a helpful error message
+
+### Changed
+
+- CURVE env vars renamed: `OMQ_SERVER_KEY`, `OMQ_SERVER_PUBLIC`,
+  `OMQ_SERVER_SECRET` (was `SERVER_KEY`, `SERVER_PUBLIC`, `SERVER_SECRET`)
+- REP with `--echo`/`-D`/`-e` serves forever by default (like a server).
+  Use `-n 1` for one-shot, `-n` to limit exchanges. Stdin/`-F` replies
+  naturally terminate at EOF.
+
+## 0.3.2 — 2026-03-26
+
+### Improved
+
+- Hide the warning about the experimental `IO::Buffer` (used by io-stream)
+
 ## 0.3.1 — 2026-03-26
 
 ### Improved

data/README.md

@@ -137,6 +137,52 @@ Benchmarked with benchmark-ips on Linux x86_64 (Ruby 4.0.1 +YJIT):
 
 See [`bench/`](bench/) for full results and scripts.
 
+## omqcat — CLI tool
+
+`omqcat` is a command-line tool for sending and receiving messages on any OMQ socket. Like `nngcat` from libnng, but with Ruby superpowers.
+
+```sh
+# Echo server in one line
+omqcat rep -b tcp://:5555 -e '$F.map(&:upcase)'
+
+# Client
+echo "hello" | omqcat req -c tcp://localhost:5555
+# => HELLO
+
+# PUB/SUB
+omqcat sub -b tcp://:5556 -s "weather."  &
+echo "weather.nyc 72F" | omqcat pub -c tcp://localhost:5556 -d 0.3
+
+# Pipeline with filtering
+tail -f /var/log/syslog | omqcat push -c tcp://collector:5557
+omqcat pull -b tcp://:5557 -e '$F.first.include?("error") ? $F : nil'
+
+# Multipart messages via tabs
+printf "routing-key\tpayload data" | omqcat push -c tcp://localhost:5557
+omqcat pull -b tcp://:5557
+# => routing-key	payload data
+
+# JSONL for structured data
+echo '["key","value"]' | omqcat push -c tcp://localhost:5557 -J
+omqcat pull -b tcp://:5557 -J
+
+# Zstandard compression
+omqcat push -c tcp://remote:5557 -z < data.txt
+omqcat pull -b tcp://:5557 -z
+
+# CURVE encryption (auto-detected from env vars)
+SERVER_KEY=... omqcat req -c tcp://secure:5555 -D "secret"
+```
+
+The `-e` flag runs Ruby inside the socket instance — the full socket API (`self <<`, `send`, `subscribe`, ...) is available. Use `-r` to require gems:
+
+```sh
+omqcat sub -c tcp://localhost:5556 -s "" -r json \
+  -e 'JSON.parse($F.first)["temperature"]'
+```
+
+Formats: `--ascii` (default, tab-separated), `--quoted`, `--raw`, `--jsonl`, `--msgpack`. See `omqcat --help` for all options.
+
 ## Interop with native ZMQ
 
 OMQ speaks ZMTP 3.1 on the wire and interoperates with libzmq, CZMQ, pyzmq, etc. over **tcp** and **ipc**. The `inproc://` transport is OMQ-internal (in-process Ruby queues) and is not visible to native ZMQ running in the same process — use `ipc://` to talk across library boundaries.

data/exe/omqcat

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
+Warning[:experimental] = false
 
 #
 # omqcat — command-line access to OMQ (ZeroMQ) sockets.
@@ -29,7 +30,7 @@ opts = {
   identity:     nil,
   target:       nil,
   interval:     nil,
-  count:        0,
+  count:        nil,
   delay:        nil,
   recv_timeout: nil,
   send_timeout: nil,
@@ -47,7 +48,8 @@ parser = OptionParser.new do |o|
   o.on("-c", "--connect URL", "Connect to endpoint (repeatable)")   { |v| opts[:connects] << v }
   o.on("-b", "--bind URL",    "Bind to endpoint (repeatable)")      { |v| opts[:binds] << v }
 
-  o.separator "\nData source:"
+  o.separator "\nData source (REP: reply source):"
+  o.on(      "--echo",        "Echo received messages back (REP)")   { opts[:echo] = true }
   o.on("-D", "--data DATA",   "Message data (literal string)")      { |v| opts[:data] = v }
   o.on("-F", "--file FILE",   "Read message from file (- = stdin)") { |v| opts[:file] = v }
 
@@ -79,6 +81,11 @@ parser = OptionParser.new do |o|
   o.on("-e", "--eval EXPR", "Eval Ruby for each message ($F = parts)") { |v| opts[:expr] = v }
   o.on("-r", "--require LIB", "Require a Ruby library (repeatable)")   { |v| require v }
 
+  o.separator "\nCURVE encryption (requires omq-curve gem):"
+  o.on("--curve-server",         "Enable CURVE as server (generates keypair)") { opts[:curve_server] = true }
+  o.on("--curve-server-key KEY", "Enable CURVE as client (server's Z85 public key)") { |v| opts[:curve_server_key] = v }
+  o.separator "  Env vars: OMQ_SERVER_KEY (client), OMQ_SERVER_PUBLIC + OMQ_SERVER_SECRET (server)"
+
   o.separator "\nOther:"
   o.on("-v", "--verbose", "Print connection events to stderr") { opts[:verbose] = true }
   o.on("-q", "--quiet",   "Suppress message output")           { opts[:quiet] = true }
@@ -215,21 +222,31 @@ end
 
 # ── CURVE setup ─────────────────────────────────────────────────────
 
-def setup_curve(sock)
-  if ENV["SERVER_KEY"]
+def setup_curve(sock, opts)
+  server_key_z85 = opts[:curve_server_key] || ENV["OMQ_SERVER_KEY"]
+  server_mode    = opts[:curve_server] || (ENV["OMQ_SERVER_PUBLIC"] && ENV["OMQ_SERVER_SECRET"])
+
+  if server_key_z85
+    # Client mode
     require "omq/curve"
-    server_key = OMQ::Z85.decode(ENV["SERVER_KEY"])
+    server_key = OMQ::Z85.decode(server_key_z85)
     client_key = RbNaCl::PrivateKey.generate
     sock.mechanism = OMQ::Curve.client(
       client_key.public_key.to_s, client_key.to_s, server_key: server_key
     )
-    $stderr.puts "CURVE client mode" if $VERBOSE
-  elsif ENV["SERVER_PUBLIC"] && ENV["SERVER_SECRET"]
+  elsif server_mode
+    # Server mode
     require "omq/curve"
-    server_pub = OMQ::Z85.decode(ENV["SERVER_PUBLIC"])
-    server_sec = OMQ::Z85.decode(ENV["SERVER_SECRET"])
+    if ENV["OMQ_SERVER_PUBLIC"] && ENV["OMQ_SERVER_SECRET"]
+      server_pub = OMQ::Z85.decode(ENV["OMQ_SERVER_PUBLIC"])
+      server_sec = OMQ::Z85.decode(ENV["OMQ_SERVER_SECRET"])
+    else
+      key        = RbNaCl::PrivateKey.generate
+      server_pub = key.public_key.to_s
+      server_sec = key.to_s
+    end
     sock.mechanism = OMQ::Curve.server(server_pub, server_sec)
-    $stderr.puts "SERVER_KEY=#{ENV["SERVER_PUBLIC"]}"
+    $stderr.puts "OMQ_SERVER_KEY='#{OMQ::Z85.encode(server_pub)}'"
   end
 rescue LoadError
   abort "omq-curve gem required for CURVE encryption: gem install omq-curve"
@@ -280,6 +297,10 @@ def eval_expr(parts, sock, opts)
   end
 end
 
+def count_reached?(i, opts)
+  opts[:count] && opts[:count] > 0 && i >= opts[:count]
+end
+
 def output(parts, opts)
   return if opts[:quiet]
   parts = [""] if parts.nil?
@@ -303,7 +324,7 @@ def send_loop(sock, opts)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       if opts[:interval]
         sleep(opts[:interval])
       else
@@ -318,7 +339,7 @@ def send_loop(sock, opts)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       sleep(opts[:interval]) if opts[:interval]
     end
   end
@@ -331,7 +352,7 @@ def recv_loop(sock, opts)
     parts = eval_expr(parts, sock, opts)
     output(parts, opts)
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
   end
 end
 
@@ -346,7 +367,7 @@ def req_loop(sock, opts)
     reply = eval_expr(reply, sock, opts)
     output(reply, opts)
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
     if opts[:interval]
       sleep(opts[:interval])
     elsif !opts[:data] && !opts[:file]
@@ -365,13 +386,19 @@ def rep_loop(sock, opts)
       reply = eval_expr(msg, sock, opts)
       output(reply, opts)
       send_msg(sock, reply || [""], opts)
-    else
+    elsif opts[:echo]
+      output(msg, opts)
+      send_msg(sock, msg, opts)
+    elsif opts[:data] || opts[:file] || !$stdin.tty?
+      reply = read_next(opts)
+      break unless reply  # EOF on stdin/-F
       output(msg, opts)
-      reply = opts[:data] ? parse_input(opts[:data] + "\n", opts[:format]) : msg
       send_msg(sock, reply, opts)
+    else
+      abort "REP needs a reply source: --echo, --data, --file, -e, or stdin pipe"
     end
     i += 1
-    break if opts[:count] > 0 && i >= opts[:count]
+    break if count_reached?(i, opts)
   end
 end
 
@@ -383,7 +410,7 @@ def pair_loop(sock, opts, task)
       parts = eval_expr(parts, sock, opts)
       output(parts, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
     end
   end
 
@@ -396,13 +423,13 @@ def pair_loop(sock, opts, task)
       sleep(opts[:delay]) if opts[:delay] && i == 0
       send_msg(sock, parts, opts) if parts
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       break if (opts[:data] || opts[:file]) && !opts[:interval]
       sleep(opts[:interval]) if opts[:interval]
     end
   end
 
-  if opts[:count] > 0
+  if opts[:count] && opts[:count] > 0
     receiver.wait
     sender.stop
   else
@@ -424,7 +451,7 @@ def router_loop(sock, opts, task)
       result = eval_expr([id_display, *parts], sock, opts)
       output(result, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
     end
   end
 
@@ -439,7 +466,7 @@ def router_loop(sock, opts, task)
       end
       send_msg(sock, parts, opts)
       i += 1
-      break if opts[:count] > 0 && i >= opts[:count]
+      break if count_reached?(i, opts)
       break if (opts[:data] || opts[:file]) && !opts[:interval]
       sleep(opts[:interval]) if opts[:interval]
     end
@@ -447,7 +474,7 @@ def router_loop(sock, opts, task)
 
   # If count is set, the receiver will exit when count is reached.
   # Otherwise, wait for Ctrl-C.
-  if opts[:count] > 0
+  if opts[:count] && opts[:count] > 0
     receiver.wait
     sender.stop
   else
@@ -472,7 +499,7 @@ Async do |task|
   sock.send_timeout = opts[:send_timeout] if opts[:send_timeout]
   sock.identity     = opts[:identity]     if opts[:identity]
 
-  setup_curve(sock)
+  setup_curve(sock, opts)
 
   opts[:binds].each do |url|
     sock.bind(url)

data/lib/omq/version.rb

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

data/lib/omq/zmtp/transport/ipc.rb

@@ -35,7 +35,7 @@ module OMQ
                   engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: endpoint)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
-                rescue => e
+                rescue
                   client&.close rescue nil
                   raise
                 end

data/lib/omq/zmtp/transport/tcp.rb

@@ -32,7 +32,7 @@ module OMQ
                   engine.handle_accepted(IO::Stream::Buffered.wrap(client, minimum_write_size: 0), endpoint: resolved)
                 rescue ProtocolError, *ZMTP::CONNECTION_LOST
                   # peer disconnected during handshake
-                rescue => e
+                rescue
                   client&.close rescue nil
                   raise
                 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omq
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Patrik Wenger