bps-stan 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d0067ac2cf8b4ee41b4f7ff5f33c1ee6eff75304cd4c5775b753b1f126f100
-  data.tar.gz: 64c67e20c09fbe73f8e72512a4d9320551d518c962e2297f536a806270351748
+  metadata.gz: 50e0141e0d0bdb22ecebc986da5d42a20c6fba2bbf33da60c1899fd46d6c6a08
+  data.tar.gz: fe097b32c80fc2b7204a8d08b87cccd9c02cabc63b35c0ecc2222755a677b628
 SHA512:
-  metadata.gz: 80d8471eb192dd551615b1c0f8c8278dd3bc9e578dc4ebdf1a0844162a95a32c639eb3047572c692323756085b3bacb5d3c658dd4e1f73c27637e86335fda151
-  data.tar.gz: 3af18785c7eb3ab110dc0966e7800797fe1b387104311c6736f1ad91621152a4b2d27b628021d7bcbeae880dd39ea4d90b7a8053ebdf986928f31527d2360bf0
+  metadata.gz: 9d471fe8d4d190b8adb39a4df7b29ab2d9d99de26818f22baa2e38a8ad3436ce093b4fae3421c5c2bae9891db4f8fcbbbb8828141b6ad4f2f47506abc86b8fae
+  data.tar.gz: f2d33c064907929224c17838042392bc9b26cd5b482c176e7594d9d0f7ac42aab5995858a15c658320aa689f187efbc1cf5832b7eaa9d6fe25605898f0221183

data/lib/bps/publisher/stan.rb

@@ -21,53 +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,
-          tls_ca_file: :string,
-          # 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 /:\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
-
-      # @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()
 
-        # 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
-
         @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)
@@ -75,7 +36,7 @@ module BPS
       end
 
       def close
-        # NATS/STAN do not survive multi-closes, so close only once:
+        # 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,35 @@
+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
+        # 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}

@@ -12,7 +12,8 @@ RSpec.describe 'STAN', stan: true do
         .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 'resolves URLs with multiple hosts' do
@@ -20,7 +21,8 @@ RSpec.describe 'STAN', stan: true do
         .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 'resolves URLs with multiple hosts/ports' do
@@ -28,7 +30,8 @@ RSpec.describe 'STAN', stan: true do
         .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
 

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_SERVERS', '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.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bps
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: nats-streaming
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -73,4 +75,5 @@ 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