bps-stan 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d0143920a7d80cb269a5fd2d8f15ac90becad86b7177a808b6239a0bb77b0a9
+  data.tar.gz: 23eda94ef4b9e1baaa89a806f435c32f4a087bf7b243bd004484a9e97734377f
+SHA512:
+  metadata.gz: 7c9d5fab51969ffe5d0c7b5799af272301d603810a7a37ec6593dbe71dc997ac9f3643dc3b2637f329857a616434f59f55733c215552b14f4b099fbe44fd6b67
+  data.tar.gz: 17448d25241e07c5608f3d4a80a9d8f5b5620059a84f02f4770a82d86124c8111dc4bfd0c2b634349ef2531b48e9f0570e50ca174bb7af57481be1867d1c8866

data/bps-stan.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'bps-stan'
+  s.version     = File.read(File.expand_path('../../.version', __dir__)).strip
+  s.platform    = Gem::Platform::RUBY
+
+  s.licenses    = ['Apache-2.0']
+  s.summary     = 'BPS adapter for nats-streaming'
+  s.description = 'https://github.com/bsm/bps'
+
+  s.authors     = ['Black Square Media']
+  s.email       = 'info@blacksquaremedia.com'
+  s.homepage    = 'https://github.com/bsm/bps'
+
+  s.executables   = []
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.add_dependency 'bps', s.version
+  s.add_dependency 'nats-streaming', '= 0.2.2'
+end

data/lib/bps-stan.rb

@@ -0,0 +1 @@
+require 'bps/stan'

data/lib/bps/publisher/stan.rb

@@ -0,0 +1,75 @@
+require 'cgi'
+require 'stan/client'
+
+module BPS
+  module Publisher
+    class STAN < Abstract
+      class Topic < Abstract::Topic
+        def initialize(client, topic)
+          super()
+
+          @client = client
+          @topic = topic
+        end
+
+        def publish(message, **_opts)
+          @client.publish(@topic, message)
+        end
+
+        def flush(**)
+          # noop
+        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)
+        super()
+
+        @topics = {}
+        @client = ::STAN::Client.new
+        @client.connect(cluster_id, client_id, nats: nats, **opts.slice(*CLIENT_OPTS.keys))
+      end
+
+      def topic(name)
+        @topics[name] ||= self.class::Topic.new(@client, name)
+      end
+
+      def close
+        # NATS/STAN do not survive multi-closes, so close only once:
+        @client&.close
+        @client = nil
+      end
+    end
+  end
+end

data/lib/bps/stan.rb

@@ -0,0 +1,12 @@
+require 'bps'
+require 'bps/publisher/stan'
+
+module BPS
+  module Publisher
+    register('stan') do |url, **opts|
+      cluster_id, client_id, url_opts = STAN.parse_url(url)
+      url_opts.update(opts)
+      STAN.new(cluster_id, client_id, **STAN.coercer.coerce(url_opts))
+    end
+  end
+end

data/spec/bps/stan_spec.rb

@@ -0,0 +1,60 @@
+require 'bps/stan'
+require 'spec_helper'
+
+RSpec.describe 'STAN', stan: true do
+  context 'resolve addrs' do
+    let(:publisher) { 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)
+        .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'))
+    end
+
+    it 'should resolve URLs with multiple hosts' do
+      expect(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'))
+    end
+
+    it 'should resolve URLs with multiple hosts/ports' do
+      expect(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'))
+    end
+  end
+
+  context BPS::Publisher::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('NATS_SERVERS', '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}" }
+
+    def read_messages(topic_name, num_messages)
+      [].tap do |messages|
+        opts = {
+          servers: nats_servers_with_scheme,
+          dont_randomize_servers: true,
+        }
+        ::STAN::Client.new.connect(cluster_id, client_id, nats: opts) do |client|
+          client.subscribe(topic_name, start_at: :first) do |msg|
+            messages << msg.data
+            next if messages.size == num_messages
+          end
+        end
+      end
+    end
+
+    it_behaves_like 'publisher'
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: bps-stan
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Black Square Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.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
+email: info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bps-stan.gemspec
+- lib/bps-stan.rb
+- lib/bps/publisher/stan.rb
+- lib/bps/stan.rb
+- spec/bps/stan_spec.rb
+homepage: https://github.com/bsm/bps
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: BPS adapter for nats-streaming
+test_files:
+- spec/bps/stan_spec.rb