nats-async 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5711fb8f1a7bcbb63a2e0f25f2d8c397840517af36b050486c51f97a5766d959
-  data.tar.gz: cbe97a371adfb30e0f856941b791c61bbd79bb216e90d41b943e1d2fd962546f
+  metadata.gz: 4b0b20b3bb016f9a35876e423cf937a1c74d56c994b8f4efc415ffc852dcc5c5
+  data.tar.gz: e7e567ac581c680bb61846941d851e4de8c4f741e257ca22b0aec0009bb99d68
 SHA512:
-  metadata.gz: b28f9fe2b99bcc2acf765df56e0681c0ea616708b1bdd873a612495604eb7a445111a07d7e31058aac6dbaa10c7b8d3d6e16e3071bf2d11a032c102b83a84bdd
-  data.tar.gz: dc559c667dfc89842ae802fd7d63263d6af0b63896f702a3f657636f1735093f9d4e77aa1ca9a56d9311695a3e8733063558f14f44ce3019b5245492619143ae
+  metadata.gz: c07415b7a294fa928714c6b24c5040c82c96ce784d6866ba90dc00e01e1a3d69326999162ccc545cdbc1f711075fb9c3ee093a319dc85316063945d18725b1a9
+  data.tar.gz: 9f673345f9bdb095d1005cfccdd55fe367fdceb537fb8f411d1e3dbde407d7d6bf88f2df837bd39125ef9f27ba96bbf8b65bb7fe45b3b75db85d81b966d9a826

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --require spec_helper
---warnings
+--warnings

data/README.md

@@ -1,14 +1,6 @@
 # Nats Async
 
-`nats-async` packages the `nats-test` prototype as a Ruby gem with the same project layout and build flow as `dry-stack`.
-
-```
-$ ./bin/nats-async --help
-Usage: nats-async [--version] [--help]
-
-Library gem for the NatsAsync connector prototype.
-
-```
+`nats-async` packages the `nats-test` is a Ruby gem.
 
 ## Installation
 
@@ -40,6 +32,22 @@ connector.run(duration: 1) do |client, task|
 end
 ```
 
+## Examples
+
+Core pub/sub:
+
+```bash
+bundle exec ruby examples/basic_pub_sub.rb
+```
+
+JetStream publish and pull:
+
+```bash
+bundle exec ruby examples/jetstream_roundtrip.rb
+```
+
+The integration spec boots the bundled [`bin/nats-server`](bin/nats-server) and runs these examples locally.
+
 ## Development
 
 ```bash

data/examples/basic_pub_sub.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nats-async"
+
+url = ENV.fetch("NATS_URL", "nats://127.0.0.1:4222")
+subject = ENV.fetch("NATS_SUBJECT", "demo.subject")
+payload = ENV.fetch("NATS_PAYLOAD", "hello from nats-async")
+
+connector = NatsAsync::SimpleConnector.new(url: url, verbose: true)
+
+connector.run(duration: 1.5, ping_every: 1, ping_timeout: 1) do |client, task|
+  sid = client.subscribe(subject) do |message|
+    puts "received subject=#{message.subject} data=#{message.data.inspect}"
+    client.unsubscribe(sid)
+    task.stop
+  end
+
+  client.publish(subject, payload)
+end

data/examples/jetstream_roundtrip.rb

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nats-async"
+
+url = ENV.fetch("NATS_URL", "nats://127.0.0.1:4222")
+stream_name = ENV.fetch("JS_STREAM", "test_stream")
+subject = ENV.fetch("JS_SUBJECT", "test_stream")
+consumer = ENV.fetch("JS_CONSUMER", "example_consumer")
+payload = ENV.fetch("JS_PAYLOAD", "hello jetstream")
+js_api_prefix = ENV.fetch("JS_API_PREFIX", "$JS.API")
+
+connector = NatsAsync::SimpleConnector.new(
+  url: url,
+  verbose: true,
+  js_api_prefix: js_api_prefix
+)
+
+connector.run(duration: 3, ping_every: 1, ping_timeout: 1) do |client, _task|
+  client.request(
+    client.js_api_subject("STREAM.CREATE", stream_name),
+    {
+      name: stream_name,
+      subjects: [subject]
+    },
+    timeout: 2
+  )
+
+  client.request(
+    client.js_api_subject("CONSUMER.CREATE", stream_name, consumer),
+    {
+      stream_name: stream_name,
+      config: {
+        name: consumer,
+        durable_name: consumer,
+        ack_policy: "explicit",
+        deliver_policy: "new",
+        filter_subject: subject
+      }
+    },
+    timeout: 2
+  )
+
+  pub_ack = client.request(subject, payload, timeout: 2)
+  puts "published seq=#{pub_ack[:seq]} stream=#{pub_ack[:stream]}"
+
+  message = client.request(
+    client.js_api_subject("CONSUMER.MSG.NEXT", stream_name, consumer),
+    {batch: 1, expires: 1_000_000_000},
+    timeout: 2,
+    parse_json: false
+  )
+
+  puts "received subject=#{message.subject} data=#{message.data.inspect}"
+  puts "metadata=#{message.metadata.inspect}"
+  message.ack if message.reply
+
+  client.request(client.js_api_subject("CONSUMER.DELETE", stream_name, consumer), {}, timeout: 2)
+  client.request(client.js_api_subject("STREAM.DELETE", stream_name), {}, timeout: 2)
+end

data/lib/nats-async.rb

@@ -2,4 +2,3 @@
 
 require_relative "version"
 require_relative "nats_async/simple_connector"
-require_relative "nats_async/command_line"

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NatsAsync
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/spec/examples_spec.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# rubocop:disable RSpec/ExampleLength, RSpec/NoExpectationExample
+# rubocop:disable RSpec/DescribeClass
+
+require_relative "spec_helper"
+
+require "open3"
+require "socket"
+require "tempfile"
+require "tmpdir"
+
+RSpec.describe "example scripts" do
+  def report_server_start_failure(reason, log_path)
+    log = File.exist?(log_path) ? File.read(log_path) : "(log file missing)"
+    message = <<~MSG
+      nats-server example integration skipped: #{reason}
+      --- nats-server log ---
+      #{log}
+      --- end nats-server log ---
+    MSG
+
+    warn(message)
+    warn("::warning::#{message.gsub("\n", "%0A")}") if ENV["GITHUB_ACTIONS"] == "true"
+    skip(message)
+  end
+
+  def project_path = File.expand_path("..", __dir__)
+  def server_path = File.join(project_path, "bin", "nats-server")
+  def config_path = File.join(project_path, "config", "nats.conf")
+
+  def free_port
+    server = TCPServer.new("127.0.0.1", 0)
+    server.addr[1]
+  ensure
+    server&.close
+  end
+
+  def wait_for_server(port, server_pid, log_path, timeout: 5)
+    deadline = Process.clock_gettime(Process::CLOCK_MONOTONIC) + timeout
+
+    loop do
+      socket = TCPSocket.new("127.0.0.1", port)
+      socket.close
+      return
+    rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+      if Process.waitpid(server_pid, Process::WNOHANG)
+        report_server_start_failure("bundled nats-server exited before becoming ready", log_path)
+      end
+
+      if Process.clock_gettime(Process::CLOCK_MONOTONIC) >= deadline
+        report_server_start_failure("bundled nats-server did not start on port #{port}", log_path)
+      end
+
+      sleep 0.1
+    end
+  end
+
+  def run_example(example_path, env)
+    stdout, stderr, status = Open3.capture3(env, "bundle", "exec", "ruby", example_path, chdir: project_path)
+    return if status.success?
+
+    raise <<~MSG
+      example failed: #{example_path}
+      status: #{status.exitstatus}
+      stdout:
+      #{stdout}
+      stderr:
+      #{stderr}
+    MSG
+  end
+
+  it "runs the bundled examples against the local nats-server" do
+    port = free_port
+    url = "nats://127.0.0.1:#{port}"
+    Tempfile.create(["nats-async-example", ".log"]) do |log|
+      log_path = log.path
+      Dir.mktmpdir("nats-async-js") do |store_dir|
+        server = Process.spawn(
+          server_path,
+          "-c", config_path,
+          "-js",
+          "-sd", store_dir,
+          "-p", port.to_s,
+          out: log,
+          err: log,
+          chdir: project_path
+        )
+
+        begin
+          wait_for_server(port, server, log_path)
+          run_example("examples/basic_pub_sub.rb", {"NATS_URL" => url})
+          run_example(
+            "examples/jetstream_roundtrip.rb",
+            {
+              "NATS_URL" => url,
+              "JS_STREAM" => "spec_stream",
+              "JS_SUBJECT" => "spec.subject",
+              "JS_CONSUMER" => "spec_consumer",
+              "JS_PAYLOAD" => "spec payload"
+            }
+          )
+        ensure
+          begin
+            Process.kill("TERM", server)
+            Process.wait(server)
+          rescue Errno::ESRCH, Process::Waiter::Error
+            nil
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable RSpec/ExampleLength, RSpec/NoExpectationExample
+# rubocop:enable RSpec/DescribeClass

data/spec/nats_async_spec.rb

@@ -1,19 +1,13 @@
 # frozen_string_literal: true
 
-RSpec.describe NatsAsync do
-  it "exposes a version" do
-    expect(NatsAsync::VERSION).to eq("0.1.0")
-  end
+require_relative "spec_helper"
+
+describe NatsAsync do
+  # it "exposes a version" do
+  #   expect(NatsAsync::VERSION).to eq("0.1.0")
+  # end
 
   it "loads the simple connector" do
     expect(NatsAsync::SimpleConnector).to be_a(Class)
   end
-
-  it "formats cli help" do
-    output = StringIO.new
-
-    NatsAsync::CommandLine.run([], stdout: output)
-
-    expect(output.string).to include("Usage: nats-async")
-  end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: nats-async
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- OpenAI Codex
+- Artem Borodkin
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -183,33 +183,31 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
-description: Lightweight async Ruby connector for NATS with request/reply and basic
-  JetStream ack helpers.
+description: Lightweight async Ruby connector for NATS
 email:
 - author@email.address
-executables:
-- nats-async
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/release.yml"
 - ".rspec"
 - ".rubocop.yml"
-- README.erb
 - README.md
 - Rakefile
-- bin/nats-async
+- examples/basic_pub_sub.rb
+- examples/jetstream_roundtrip.rb
 - lib/nats-async.rb
-- lib/nats_async/command_line.rb
 - lib/nats_async/simple_connector.rb
 - lib/version.rb
+- spec/examples_spec.rb
 - spec/nats_async_spec.rb
 - spec/spec_helper.rb
 homepage: https://rubygems.org/gems/nats-async
 licenses:
 - Nonstandard
 metadata:
-  source_code_uri: https://github.com/example/nats-async
+  source_code_uri: https://github.com/artyomb/nats-async
 rdoc_options: []
 require_paths:
 - lib
@@ -226,5 +224,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Async NATS connector prototype packaged as a gem
+summary: Async NATS connector
 test_files: []

data/README.erb

@@ -1,46 +0,0 @@
-# Nats Async
-
-`nats-async` packages the `nats-test` prototype as a Ruby gem with the same project layout and build flow as `dry-stack`.
-
-```
-$ ./bin/nats-async --help
-<%= %x{./bin/nats-async --help} %>
-```
-
-## Installation
-
-Add the gem to your bundle:
-
-```ruby
-gem "nats-async"
-```
-
-Or install it directly:
-
-```bash
-gem install nats-async
-```
-
-## Usage
-
-```ruby
-require "nats-async"
-
-connector = NatsAsync::SimpleConnector.new(url: "nats://127.0.0.1:4222", verbose: false)
-connector.run(duration: 1) do |client, task|
-  client.subscribe("demo.subject") do |message|
-    puts "received: #{message.data}"
-    task.stop
-  end
-
-  client.publish("demo.subject", "hello")
-end
-```
-
-## Development
-
-```bash
-bundle install
-bundle exec rspec
-rake build
-```

data/bin/nats-async

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-
-lib = File.expand_path("../lib", __dir__)
-$LOAD_PATH << lib
-
-require "nats-async"
-require "nats_async/command_line"
-
-NatsAsync::CommandLine.run(ARGV)

data/lib/nats_async/command_line.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module NatsAsync
-  module CommandLine
-    module_function
-
-    def run(argv, stdout: $stdout)
-      case argv.first
-      when "-v", "--version"
-        stdout.puts(NatsAsync::VERSION)
-      else
-        stdout.puts("Usage: nats-async [--version] [--help]")
-        stdout.puts
-        stdout.puts("Library gem for the NatsAsync connector prototype.")
-      end
-    end
-  end
-end