service_mesh_nats 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a1213855e080bc361b292f2708b4f023ba38a5051c3ebddffc39cf55b91f7c
-  data.tar.gz: fd6939fad816e2beb146fbd8c3697b1221dabb3938a08bdbd73c23664488d71f
+  metadata.gz: 683e607b098b1fd2c8a5aa3d2d89182658f2cc7271523456f4d0c50879a2748f
+  data.tar.gz: 0202c5b52d82746c1ecf86204efc29326c64f1b5edf60bcb6052c538bc26bed5
 SHA512:
-  metadata.gz: 411c35df69a5c8bf43b9ce66e088d666e129c34e64e93a6be3408a471775813f427cb32813a1e47a49bdbaa0e69f56e449ee8e73ee720c397646a70b187c6c0e
-  data.tar.gz: 9fbde8fda5e37e58e4d08b0ffe9fe341098bdf5f84d241ddba5bace38003fcf974517bd2cd009deeb5f28cf45f828e3f1f79aa48f2593e1eec4c8f2355dd5f55
+  metadata.gz: 423a075d243dcc467dc0208a5c5fdb2881c70c03af0c602f48ce0b461a19e2efb08fa68158122724a74cdbecac04e105b459eb49ba492d9ec9b7315f3fa522ed
+  data.tar.gz: 7e63ac578689eecbe34d4b3ee8b1880868eb4d1e40d7ec27e994e0ff8bcb2e911be6ec72ffb301d8fdb203d209b4fc6ec08a89c8c4e6a1861ec30d67b2727519

data/README.md

@@ -1,9 +1,20 @@
 # service-mesh-nats-ruby
 
-`service_mesh_nats` is the NATS transport implementation in Ruby for the
-[Service Mesh API Specification](https://github.com/Paymentbox-com/service-mesh-api).
-
-This gem depends on the contract types and errors in [service-mesh-ruby](https://github.com/Paymentbox-com/service-mesh-ruby).
+service-mesh-nats-ruby is the Ruby implementation of the
+[Service Mesh API Specification](https://github.com/Paymentbox-com/service-mesh-api)
+over NATS. It implements the Ruby contract in the `service_mesh` gem, from
+[service-mesh-ruby](https://github.com/Paymentbox-com/service-mesh-ruby), on
+top of the `nats-pure` client.
+
+The `ServiceMeshNats` module provides:
+* `Client`, which implements the contract's `Client` over one NATS connection
+* `Runtime`, which implements the contract's `Runtime` on a `Client`'s connection
+* the configuration keys it reads
+* the errors it defines
+
+The contract types it works with, such as `ServiceMesh::Target`,
+`ServiceMesh::Message`, `ServiceMesh::Endpoint`, and `ServiceMesh::Subscriber`,
+come from the `service_mesh` gem.
 
 ## Install
 
@@ -12,7 +23,7 @@ This gem depends on the contract types and errors in [service-mesh-ruby](https:/
 gem "service_mesh_nats"
 ```
 
-Requires Ruby 3.3 or newer and a reachable NATS server. Depends on
+Requires Ruby 3.3 or newer and a reachable NATS server. The gem depends on
 `service_mesh` and `nats-pure`.
 
 ## Usage
@@ -49,15 +60,14 @@ reply = client.request(ServiceMesh::Message.new(target: echo, payload: "hi"))
 client.publish(ServiceMesh::Message.new(target: created, payload: "order 42"))
 ```
 
-The client is the runtime's connection. `runtime.client` returns it, and
-`runtime.stop` closes it. A process that only requests and
-publishes builds a client itself and calls `close` when done.
-`runtime.service_map` and `client.service_map` return the map the client was
-built with.
+The client is the runtime's connection. `runtime.client` returns it in every
+state, and `runtime.stop` closes it. A process that only requests and publishes
+builds a client itself and calls `close` when done. `runtime.service_map` and
+`client.service_map` return the map the client was built with.
 
 ## Documentation
 
 - [Examples](docs/examples.md): a server process, a call-only client process, and consumer groups
-- [Public API](docs/public-api.md): the constants this gem exposes and how `Client` and `Runtime` behave
-- [What the NATS Runtime Decides](docs/runtime-behavior.md): targets, configuration, metadata, delivery, handler failure, timeouts, concurrency, lifecycle, and transport errors
+- [Public API](docs/public-api.md): every public constant and method in `ServiceMeshNats`
+- [Transport Specific Implementation](docs/transport-specific-implementation.md): subjects, configuration, metadata, delivery, handler failure, timeouts, concurrency, lifecycle, and errors
 - [Development](docs/development.md): the recipes and the tests

data/lib/service_mesh_nats/runtime.rb

@@ -45,8 +45,8 @@ module ServiceMeshNats
     # Subscribes every binding on the client's connection and begins
     # receiving. Raises AlreadyStarted on a running runtime, Stopped after
     # stop, and Closed when the client has been closed. A failure while
-    # subscribing closes the client, marks the runtime stopped, and passes
-    # through.
+    # subscribing or flushing unsubscribes what was subscribed, leaves the
+    # runtime and the client as they were, and passes through.
     def start
       @lock.synchronize do
         raise AlreadyStarted if @state == :running
@@ -66,8 +66,6 @@ module ServiceMeshNats
         rescue => e
           subs.each { |s| s.unsubscribe rescue nil } # rubocop:disable Style/RescueModifier
           pool.kill
-          @client.close
-          @state = :stopped
           raise e
         end
 

data/lib/service_mesh_nats/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceMeshNats
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_mesh_nats
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Bryant Morrill