bps-nats 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 202e41923cbb093a7504969a3dfa266574e6b5d1f0982cf5c08bb7393252eecf
+  data.tar.gz: 4beb06613f160e27a140e5efeb6b0055df4bcbdff596abecdaf2579685c7515d
+SHA512:
+  metadata.gz: 78975cd84023ae46da605d0a1380b0854383f533f1fb528fb60be9a923e65414b7c7eeac03c4327262d5e586957624a69de5469fad83d3d168609bc9eedef482
+  data.tar.gz: bb70c2a34954e52f923612b7e2ebb77989a553dfa0f7d2179d393cb58089a5f02d011b6de4ccb549f17d59ac6c12574ddd3758a53ed031477acfec10214d8b8b

data/bps-nats.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'bps-nats'
+  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'
+  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-pure', '~> 0.6.2'
+end

data/lib/bps-nats.rb

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

data/lib/bps/nats.rb

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

data/lib/bps/publisher/nats.rb

@@ -0,0 +1,78 @@
+require 'cgi'
+require 'nats/io/client'
+
+module BPS
+  module Publisher
+    class NATS < Abstract
+      FLUSH_TIMEOUT = 5
+
+      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(**)
+          @client.flush(FLUSH_TIMEOUT)
+        end
+      end
+
+      CLIENT_OPTS = {
+        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-pure.rb
+      }.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 }
+        opts.merge(servers: servers)
+      end
+
+      # @return [BPS::Coercer] the options coercer.
+      def self.coercer
+        @coercer ||= BPS::Coercer.new(CLIENT_OPTS).freeze
+      end
+
+      # @param [Hash] options.
+      def initialize(**opts)
+        super()
+
+        # handle TLS if CA file is provided:
+        if !opts[:tls] && opts[:tls_ca_file]
+          ctx = OpenSSL::SSL::SSLContext.new
+          ctx.set_params
+          ctx.ca_file = opts.delete(:tls_ca_file)
+          opts[:tls] = ctx
+        end
+
+        @topics = {}
+        @client = ::NATS::IO::Client.new
+        @client.connect(**opts.slice(*CLIENT_OPTS.keys))
+      end
+
+      def topic(name)
+        @topics[name] ||= self.class::Topic.new(@client, name)
+      end
+
+      def close
+        @client.close
+      end
+    end
+  end
+end

data/spec/bps/nats_spec.rb

@@ -0,0 +1,75 @@
+require 'bps/nats'
+require 'spec_helper'
+
+RSpec.describe 'NATS', nats: true do
+  context 'with addr resolving' do
+    let(:publisher) { instance_double('BPS::Publisher::NATS') }
+
+    before          { allow(BPS::Publisher::NATS).to receive(:new).and_return(publisher) }
+
+    it 'resolves simple URLs' do
+      allow(BPS::Publisher::NATS)
+        .to receive(:new)
+        .with(servers: ['nats://test.host:4222'])
+        .and_return(publisher)
+      BPS::Publisher.resolve(URI.parse('nats://test.host:4222'))
+    end
+
+    it 'resolves URLs with multiple hosts' do
+      allow(BPS::Publisher::NATS)
+        .to receive(:new)
+        .with(servers: ['nats://foo.host:4222', 'nats://bar.host:4222'])
+        .and_return(publisher)
+      BPS::Publisher.resolve(URI.parse('nats://foo.host,bar.host:4222'))
+    end
+
+    it 'resolves URLs with multiple hosts/ports' do
+      allow(BPS::Publisher::NATS)
+        .to receive(:new)
+        .with(servers: ['nats://foo.host:4223', 'nats://bar.host:4222'])
+        .and_return(publisher)
+      BPS::Publisher.resolve(URI.parse('nats://foo.host%3A4223,bar.host'))
+    end
+  end
+
+  context BPS::Publisher::NATS do
+    let(:nats_servers) { ENV.fetch('NATS_SERVERS', '127.0.0.1:4222').split(',') }
+    let(:messages_queue) { Queue.new }
+    let(:nats_servers_with_scheme) { nats_servers.map {|s| "nats://#{s}" } }
+
+    let(:publisher_url) { "nats://#{CGI.escape(nats_servers.join(','))}" }
+
+    # Pure NATS doesn't retain messages, so we need to subscribe BEFORE emitting.
+    # Also, subscription is asynchronous, so we have to use blocking queue to wait for messages.
+
+    # connect to NATS before any test code runs:
+    let!(:nats_client) do
+      opts = {
+        servers: nats_servers_with_scheme,
+        dont_randomize_servers: true,
+      }
+      client = ::NATS::IO::Client.new
+      client.connect(opts)
+      client
+    end
+
+    # don't forget to close NATS connection after tests are done:
+    after do
+      nats_client.close
+    end
+
+    # blocking queue to gather messages in background thread:
+
+    # subscribe to test topic, non-blocking; messages will be pushed into blocking queue:
+    def setup_topic(topic_name, num_messages)
+      nats_client.subscribe(topic_name, max: num_messages) {|msg| messages_queue << msg }
+    end
+
+    # simply drain messages queue to get messages:
+    def read_messages(_topic_name, num_messages)
+      Array.new(num_messages) { messages_queue.pop }
+    end
+
+    it_behaves_like 'publisher'
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: bps-nats
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Black Square Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: nats-pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: https://github.com/bsm/bps
+email: info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bps-nats.gemspec
+- lib/bps-nats.rb
+- lib/bps/nats.rb
+- lib/bps/publisher/nats.rb
+- spec/bps/nats_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.4
+signing_key: 
+specification_version: 4
+summary: BPS adapter for nats
+test_files:
+- spec/bps/nats_spec.rb