bps-stan 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0143920a7d80cb269a5fd2d8f15ac90becad86b7177a808b6239a0bb77b0a9
-  data.tar.gz: 23eda94ef4b9e1baaa89a806f435c32f4a087bf7b243bd004484a9e97734377f
+  metadata.gz: 7108a7bf17771ebd494e2fc1cd438aff207e49b2492a3bfa43c8e55de3ec61ca
+  data.tar.gz: 4876378fbb7efa31e15ee93f633c4596919fde413ce1c4fa261b014a76589486
 SHA512:
-  metadata.gz: 7c9d5fab51969ffe5d0c7b5799af272301d603810a7a37ec6593dbe71dc997ac9f3643dc3b2637f329857a616434f59f55733c215552b14f4b099fbe44fd6b67
-  data.tar.gz: 17448d25241e07c5608f3d4a80a9d8f5b5620059a84f02f4770a82d86124c8111dc4bfd0c2b634349ef2531b48e9f0570e50ca174bb7af57481be1867d1c8866
+  metadata.gz: ab1e0361768cfceae98e1709a9065fc33d82f21bc529fa6ef010d6964c7382249e8a3acc1a34a53c33c7bc97f3a10d17198009571e29104461f1d644b7049e48
+  data.tar.gz: 85cda889a293c0c48050139b2888cbd238e2924c1630c9484a83ee870bedc5d03ec7a2d5ae71f7c53ed28d60febb46cce28423aabcb1734db4e218b76b29bfb8

data/bps-stan.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.6.0'
 
   s.add_dependency 'bps', s.version
-  s.add_dependency 'nats-streaming', '= 0.2.2'
+  s.add_dependency 'nats-streaming', '~> 0.2.2'
 end

data/lib/bps/publisher/stan.rb

@@ -21,44 +21,14 @@ module BPS
         end
       end
 
-      CLIENT_OPTS = {
-        nats: {
-          servers: [:string],
-          dont_randomize_servers: :bool,
-          reconnect_time_wait: :float,
-          max_reconnect_attempts: :int,
-          connect_timeout: :float,
-          # TODO: review, list all of them: https://github.com/nats-io/nats.rb (there's tls config etc)
-        },
-      }.freeze
-
-      def self.parse_url(url)
-        port = url.port&.to_s || '4222'
-        servers = CGI.unescape(url.host).split(',').map do |host|
-          addr = "nats://#{host}"
-          addr << ':' << port unless addr.match(/:\d+$/)
-          addr
-        end
-        opts = CGI.parse(url.query).transform_values {|v| v.size == 1 ? v[0] : v }
-        cluster_id = opts.delete('cluster_id')
-        client_id = opts.delete('client_id')
-        [cluster_id, client_id, { nats: { servers: servers } }]
-      end
-
-      # @return [BPS::Coercer] the options coercer.
-      def self.coercer
-        @coercer ||= BPS::Coercer.new(CLIENT_OPTS).freeze
-      end
-
       # @param [String] cluster ID.
       # @param [String] client ID.
       # @param [Hash] options.
-      def initialize(cluster_id, client_id, nats: {}, **opts)
+      def initialize(cluster_id, client_id, **opts)
         super()
 
         @topics = {}
-        @client = ::STAN::Client.new
-        @client.connect(cluster_id, client_id, nats: nats, **opts.slice(*CLIENT_OPTS.keys))
+        @client = ::BPS::STAN.connect(cluster_id, client_id, **opts)
       end
 
       def topic(name)
@@ -66,7 +36,9 @@ module BPS
       end
 
       def close
-        # NATS/STAN do not survive multi-closes, so close only once:
+        super
+
+        # NATS/STAN does not survive multi-closes, so close only once:
         @client&.close
         @client = nil
       end

data/lib/bps/stan.rb

@@ -1,12 +1,72 @@
 require 'bps'
 require 'bps/publisher/stan'
+require 'bps/subscriber/stan'
 
 module BPS
   module Publisher
     register('stan') do |url, **opts|
-      cluster_id, client_id, url_opts = STAN.parse_url(url)
+      cluster_id, client_id, url_opts = ::BPS::STAN.parse_url(url)
       url_opts.update(opts)
-      STAN.new(cluster_id, client_id, **STAN.coercer.coerce(url_opts))
+      STAN.new(cluster_id, client_id, **::BPS::STAN.coercer.coerce(url_opts))
+    end
+  end
+
+  module Subscriber
+    register('stan') do |url, **opts|
+      cluster_id, client_id, url_opts = ::BPS::STAN.parse_url(url)
+      url_opts.update(opts)
+      STAN.new(cluster_id, client_id, **::BPS::STAN.coercer.coerce(url_opts))
+    end
+  end
+
+  module STAN
+    CLIENT_OPTS = {
+      nats: {
+        servers: [:string],
+        dont_randomize_servers: :bool,
+        reconnect_time_wait: :float,
+        max_reconnect_attempts: :int,
+        connect_timeout: :float,
+        tls_ca_file: :string,
+        # TODO: review, list all of them: https://github.com/nats-io/nats.rb
+      },
+    }.freeze
+
+    # @param [String] cluster ID
+    # @param [String] client ID
+    # @param [Hash] options
+    # @return [STAN::Client] connected STAN client
+    def self.connect(cluster_id, client_id, nats: {}, **opts)
+      # handle TLS if CA file is provided:
+      if !nats[:tls] && nats[:tls_ca_file]
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.set_params
+        ctx.ca_file = nats.delete(:tls_ca_file)
+        nats[:tls] = ctx
+      end
+
+      client = ::STAN::Client.new
+      client.connect(cluster_id, client_id, nats: nats, **opts.slice(*CLIENT_OPTS.keys))
+      client
+    end
+
+    # @return [BPS::Coercer] the options coercer
+    def self.coercer
+      @coercer ||= BPS::Coercer.new(CLIENT_OPTS).freeze
+    end
+
+    # @return [Array] arguments for connecting to STAN
+    def self.parse_url(url)
+      port = url.port&.to_s || '4222'
+      servers = CGI.unescape(url.host).split(',').map do |host|
+        addr = "nats://#{host}"
+        addr << ':' << port unless /:\d+$/.match?(addr)
+        addr
+      end
+      opts = CGI.parse(url.query || '').transform_values {|v| v.size == 1 ? v[0] : v }
+      cluster_id = opts.delete('cluster_id')
+      client_id = opts.delete('client_id')
+      [cluster_id, client_id, { nats: { servers: servers } }]
     end
   end
 end

data/lib/bps/subscriber/stan.rb

@@ -0,0 +1,37 @@
+require 'cgi'
+require 'stan/client'
+
+module BPS
+  module Subscriber
+    class STAN < Abstract
+      # @param [String] cluster ID.
+      # @param [String] client ID.
+      # @param [Hash] options.
+      def initialize(cluster_id, client_id, **opts)
+        super()
+
+        @client = ::BPS::STAN.connect(cluster_id, client_id, **opts)
+      end
+
+      # Subscribe to a topic
+      # @param topic [String] topic the topic name.
+      def subscribe(topic, **opts)
+        # important opts:
+        # - queue: 'queue-name'          # https://docs.nats.io/developing-with-nats-streaming/queues
+        # - durable_name: 'durable-name' # https://docs.nats.io/developing-with-nats-streaming/durables
+        @client.subscribe(topic, **opts) do |msg|
+          yield msg.data # TODO: maybe yielding just bytes is not too flexible? But IMO can wait till (much) later
+        end
+      end
+
+      # Close the subscriber.
+      def close
+        super
+
+        # NATS/STAN does not survive multi-closes, so close only once:
+        @client&.close
+        @client = nil
+      end
+    end
+  end
+end

data/spec/bps/{stan_spec.rb → publisher/stan_spec.rb}

@@ -2,32 +2,36 @@ require 'bps/stan'
 require 'spec_helper'
 
 RSpec.describe 'STAN', stan: true do
-  context 'resolve addrs' do
-    let(:publisher) { double('BPS::Publisher::STAN') }
+  context 'with addr resolving' do
+    let(:publisher) { instance_double('BPS::Publisher::STAN') }
+
     before          { allow(BPS::Publisher::STAN).to receive(:new).and_return(publisher) }
 
-    it 'should resolve simple URLs' do
-      expect(BPS::Publisher::STAN)
+    it 'resolves simple URLs' do
+      allow(BPS::Publisher::STAN)
         .to receive(:new)
         .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://test.host:4222'] })
         .and_return(publisher)
-      BPS::Publisher.resolve(URI.parse('stan://test.host:4222?cluster_id=CLUSTER&client_id=CLIENT'))
+      expect(BPS::Publisher.resolve(URI.parse('stan://test.host:4222?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(publisher)
     end
 
-    it 'should resolve URLs with multiple hosts' do
-      expect(BPS::Publisher::STAN)
+    it 'resolves URLs with multiple hosts' do
+      allow(BPS::Publisher::STAN)
         .to receive(:new)
         .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://foo.host:4222', 'nats://bar.host:4222'] })
         .and_return(publisher)
-      BPS::Publisher.resolve(URI.parse('stan://foo.host,bar.host:4222?cluster_id=CLUSTER&client_id=CLIENT'))
+      expect(BPS::Publisher.resolve(URI.parse('stan://foo.host,bar.host:4222?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(publisher)
     end
 
-    it 'should resolve URLs with multiple hosts/ports' do
-      expect(BPS::Publisher::STAN)
+    it 'resolves URLs with multiple hosts/ports' do
+      allow(BPS::Publisher::STAN)
         .to receive(:new)
         .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://foo.host:4223', 'nats://bar.host:4222'] })
         .and_return(publisher)
-      BPS::Publisher.resolve(URI.parse('stan://foo.host%3A4223,bar.host?cluster_id=CLUSTER&client_id=CLIENT'))
+      expect(BPS::Publisher.resolve(URI.parse('stan://foo.host%3A4223,bar.host?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(publisher)
     end
   end
 
@@ -35,7 +39,7 @@ RSpec.describe 'STAN', stan: true do
     let(:cluster_id) { 'test-cluster' } # this is a default cluster for https://hub.docker.com/_/nats-streaming
     let(:client_id)  { 'bps-test' }
 
-    let(:nats_servers) { ENV.fetch('NATS_SERVERS', '127.0.0.1:4222').split(',') }
+    let(:nats_servers) { ENV.fetch('STAN_ADDRS', '127.0.0.1:4222').split(',') }
     let(:nats_servers_with_scheme) { nats_servers.map {|s| "nats://#{s}" } }
 
     let(:publisher_url) { "stan://#{CGI.escape(nats_servers.join(','))}/?cluster_id=#{cluster_id}&client_id=#{client_id}" }

data/spec/bps/subscriber/stan_spec.rb

@@ -0,0 +1,61 @@
+require 'bps/stan'
+require 'spec_helper'
+
+RSpec.describe 'STAN', stan: true do
+  context 'with addr resolving' do
+    let(:subscriber) { instance_double('BPS::Subscriber::STAN') }
+
+    before { allow(BPS::Subscriber::STAN).to receive(:new).and_return(subscriber) }
+
+    it 'resolves simple URLs' do
+      allow(BPS::Subscriber::STAN)
+        .to receive(:new)
+        .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://test.host:4222'] })
+        .and_return(subscriber)
+      expect(BPS::Subscriber.resolve(URI.parse('stan://test.host:4222?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(subscriber)
+    end
+
+    it 'resolves URLs with multiple hosts' do
+      allow(BPS::Subscriber::STAN)
+        .to receive(:new)
+        .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://foo.host:4222', 'nats://bar.host:4222'] })
+        .and_return(subscriber)
+      expect(BPS::Subscriber.resolve(URI.parse('stan://foo.host,bar.host:4222?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(subscriber)
+    end
+
+    it 'resolves URLs with multiple hosts/ports' do
+      allow(BPS::Subscriber::STAN)
+        .to receive(:new)
+        .with('CLUSTER', 'CLIENT', nats: { servers: ['nats://foo.host:4223', 'nats://bar.host:4222'] })
+        .and_return(subscriber)
+      expect(BPS::Subscriber.resolve(URI.parse('stan://foo.host%3A4223,bar.host?cluster_id=CLUSTER&client_id=CLIENT')))
+        .to eq(subscriber)
+    end
+  end
+
+  context BPS::Subscriber::STAN do
+    let(:cluster_id) { 'test-cluster' } # this is a default cluster for https://hub.docker.com/_/nats-streaming
+    let(:client_id)  { 'bps-test' }
+
+    let(:nats_servers) { ENV.fetch('STAN_ADDRS', '127.0.0.1:4222').split(',') }
+    let(:nats_servers_with_scheme) { nats_servers.map {|s| "nats://#{s}" } }
+
+    let(:subscriber_url) { "stan://#{CGI.escape(nats_servers.join(','))}/?cluster_id=#{cluster_id}&client_id=#{client_id}" }
+
+    def produce_messages(topic_name, messages)
+      opts = {
+        servers: nats_servers_with_scheme,
+        dont_randomize_servers: true,
+      }
+      ::STAN::Client.new.connect(cluster_id, client_id, nats: opts) do |client|
+        messages.each do |message|
+          client.publish(topic_name, message)
+        end
+      end
+    end
+
+    it_behaves_like 'subscriber'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bps-stan
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.2
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bps
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.2.2
 - !ruby/object:Gem::Dependency
   name: nats-streaming
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.2
 description: https://github.com/bsm/bps
@@ -48,7 +48,9 @@ files:
 - lib/bps-stan.rb
 - lib/bps/publisher/stan.rb
 - lib/bps/stan.rb
-- spec/bps/stan_spec.rb
+- lib/bps/subscriber/stan.rb
+- spec/bps/publisher/stan_spec.rb
+- spec/bps/subscriber/stan_spec.rb
 homepage: https://github.com/bsm/bps
 licenses:
 - Apache-2.0
@@ -68,9 +70,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: BPS adapter for nats-streaming
 test_files:
-- spec/bps/stan_spec.rb
+- spec/bps/publisher/stan_spec.rb
+- spec/bps/subscriber/stan_spec.rb