nats 0.9.2 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55e7d5acd3bc948f6238b7b294e5c7dfd03698e0173b677115bb2361a29db842
-  data.tar.gz: a1d0c1d206407117fbe35604a9e2b4f0f5954fcda03af9dd23be2ed0dacdeb69
+  metadata.gz: 8caff8d7b6a0c87a312c9942174fe3c455e2cfc1c3abdb7c6baf7eb5db7445ef
+  data.tar.gz: 2dd5eb84f34dea3c6509c732b8da35d095af409fb955de312bc75c0b5306c7b0
 SHA512:
-  metadata.gz: 5d11348d74d766bcf25169b3af693f4cd1bc5a2b1adb4d60919feb44718670c162cd93a0bf728e4f8624eb2c54ae952ab556f725a3e7254be91923df4b2b1986
-  data.tar.gz: 29b9b7a9bd9152fa19491a9ac56670564549656102422b383887d919ad32268ce481f7cf2a74be07df232fa25d802fa1791f850503f82a40eab49b4e8c5dfdd7
+  metadata.gz: 2d8e2aa2738f152cc9f15bb1a5759714062535d55a6c449fc0a55e61b2cd59f45d37e39129fade9acf9cb0a82c2f5bf555f00fd82302e97ec9ec603ee2d2e493
+  data.tar.gz: '07828fd12c5c5a89eebfabaf8dae0315fa0bb0eb5dd013fee13282a63a5c037e04d2a072424fd97c266cabeb9d465ad3f79b66c4ace6c1280af85a4acf5da203'

data/README.md

@@ -3,14 +3,14 @@
 A [Ruby](http://ruby-lang.org) client for the [NATS messaging system](https://nats.io).
 
 [![License Apache 2.0](https://img.shields.io/badge/License-Apache2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
-[![Build Status](https://travis-ci.org/nats-io/ruby-nats.svg)](http://travis-ci.org/nats-io/ruby-nats) [![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=5&v=0.9.2)](https://rubygems.org/gems/nats/versions/0.9.2) [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/nats)
+[![Build Status](https://travis-ci.org/nats-io/ruby-nats.svg)](http://travis-ci.org/nats-io/ruby-nats) [![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=5&v=0.10.0)](https://rubygems.org/gems/nats/versions/0.10.0) [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/gems/nats)
 
 ## Supported Platforms
 
 This gem and the client are known to work on the following Ruby platforms:
 
-- MRI 2.2, 2.3.0, 2.4.0, 2.5.0
-- JRuby 9.1.2.0, 9.1.15.0
+- MRI 2.3.0, 2.4.0, 2.5.0
+- JRuby 9.1.2.0, 9.1.15.0, 9.2.0.0
 
 If you're looking for a non-EventMachine alternative, check out the [nats-pure](https://github.com/nats-io/pure-ruby-nats) gem.
 
@@ -108,11 +108,10 @@ end
 
 ### Auto discovery
 
-Starting from release `0.8.0` of the gem, the client also auto
-discovers new nodes announced by the server as they attach to the
-cluster.  Reconnection logic parameters such as time to back-off on
-failure and max attempts apply the same to both discovered nodes and
-those defined explicitly on connect:
+The client also auto discovers new nodes announced by the server as
+they attach to the cluster.  Reconnection logic parameters such as
+time to back-off on failure and max attempts apply the same to both
+discovered nodes and those defined explicitly on connect:
 
 ```ruby
 opts = {
@@ -149,7 +148,10 @@ NATS.unsubscribe(sid, MAX_WANTED)
 # Multiple connections
 NATS.subscribe('test') do |msg|
   puts "received msg"
-  NATS.stop
+  
+  # Gracefully disconnect from NATS after handling
+  # messages that have already been delivered by server.
+  NATS.drain
 end
 
 # Form second connection to send message on

data/lib/nats/client.rb

@@ -42,6 +42,9 @@ module NATS
   DEFAULT_PING_INTERVAL = 120
   DEFAULT_PING_MAX = 2
 
+  # Drain mode support
+  DEFAULT_DRAIN_TIMEOUT = 30
+
   # Protocol
   # @private
   MSG      = /\AMSG\s+([^\s]+)\s+([^\s]+)\s+(([^\s]+)[^\S\r\n]+)?(\d+)\r\n/i #:nodoc:
@@ -93,6 +96,7 @@ module NATS
     # Create and return a connection to the server with the given options.
     # The optional block will be called when the connection has been completed.
     #
+    # @param [String] uri The URI or comma separated list of URIs of NATS servers to connect to.
     # @param [Hash] opts
     # @option opts [String|URI] :uri The URI to connect to, example nats://localhost:4222
     # @option opts [Boolean] :reconnect Boolean that can be used to suppress reconnect functionality.
@@ -107,7 +111,50 @@ module NATS
     # @option opts [Integer] :max_outstanding_pings Integer that can be used to set the max number of outstanding pings before declaring a connection closed.
     # @param [Block] &blk called when the connection is completed. Connection will be passed to the block.
     # @return [NATS] connection to the server.
-    def connect(opts={}, &blk)
+    #
+    # @example Connect to local NATS server.
+    #  NATS.connect do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Setting custom server URI to connect.
+    #  NATS.connect("nats://localhost:4222") do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Setting username and password to authenticate.
+    #  NATS.connect("nats://user:password@localhost:4222") do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Specifying explicit list of servers via options.
+    #  NATS.connect(servers: ["nats://127.0.0.1:4222","nats://127.0.0.1:4223","nats://127.0.0.1:4224"]) do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Using comma separated array to define list of servers.
+    #  NATS.connect("nats://localhost:4223,nats://localhost:4224") do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Only specifying endpoint uses NATS default scheme and port.
+    #  NATS.connect("demo.nats.io") do |nc|
+    #    # ...
+    #  end
+    #
+    # @example Setting infinite reconnect retries with 2 seconds back off against custom URI.
+    #  NATS.connect("demo.nats.io:4222", max_reconnect_attempts: -1, reconnect_time_wait: 2) do |nc|
+    #    # ...
+    #  end
+    #
+    def connect(uri=nil, opts={}, &blk)
+      case uri
+      when String
+        opts[:uri] = process_uri(uri)
+      when Hash
+        opts = uri
+      end
+
       # Defaults
       opts[:verbose] = false if opts[:verbose].nil?
       opts[:pedantic] = false if opts[:pedantic].nil?
@@ -117,6 +164,7 @@ module NATS
       opts[:reconnect_time_wait] = RECONNECT_TIME_WAIT if opts[:reconnect_time_wait].nil?
       opts[:ping_interval] = DEFAULT_PING_INTERVAL if opts[:ping_interval].nil?
       opts[:max_outstanding_pings] = DEFAULT_PING_MAX if opts[:max_outstanding_pings].nil?
+      opts[:drain_timeout] = DEFAULT_DRAIN_TIMEOUT if opts[:drain_timeout].nil?
 
       # Override with ENV
       opts[:uri] ||= ENV['NATS_URI'] || DEFAULT_URI
@@ -129,10 +177,10 @@ module NATS
       opts[:max_reconnect_attempts] = ENV['NATS_MAX_RECONNECT_ATTEMPTS'].to_i unless ENV['NATS_MAX_RECONNECT_ATTEMPTS'].nil?
       opts[:reconnect_time_wait] = ENV['NATS_RECONNECT_TIME_WAIT'].to_i unless ENV['NATS_RECONNECT_TIME_WAIT'].nil?
       opts[:name] ||= ENV['NATS_CONNECTION_NAME']
-
-
+      opts[:no_echo] ||= ENV['NATS_NO_ECHO'] || false
       opts[:ping_interval] = ENV['NATS_PING_INTERVAL'].to_i unless ENV['NATS_PING_INTERVAL'].nil?
       opts[:max_outstanding_pings] = ENV['NATS_MAX_OUTSTANDING_PINGS'].to_i unless ENV['NATS_MAX_OUTSTANDING_PINGS'].nil?
+      opts[:drain_timeout] ||= ENV['NATS_DRAIN_TIMEOUT'].to_i unless ENV['NATS_DRAIN_TIMEOUT'].nil?
 
       uri = opts[:uris] || opts[:servers] || opts[:uri]
 
@@ -211,6 +259,16 @@ module NATS
       @disconnect_cb = nil
     end
 
+    # Drain gracefully disconnects from the server, letting
+    # subscribers process pending messages already sent by server and
+    # optionally calls the associated block.
+    # @param [Block] &blk called when drain is done and connection is closed.
+    def drain(&blk)
+      if (client and !client.draining? and (client.connected? || client.reconnecting?))
+        client.drain { blk.call if blk }
+      end
+    end
+
     # @return [URI] Connected server
     def connected_server
       return nil unless client
@@ -229,6 +287,12 @@ module NATS
       client.reconnecting?
     end
 
+    # @return [Boolean] Draining state
+    def draining?
+      return false unless client
+      client.draining?
+    end
+
     # @return [Hash] Options
     def options
       return {} unless client
@@ -343,16 +407,48 @@ module NATS
       uri.host != 'localhost' && uri.host != '127.0.0.1'
     end
 
+    def process_uri(uris)
+      connect_uris = []
+      uris.split(',').each do |uri|
+        opts = {}
+
+        # Scheme
+        if uri.include?("://")
+          scheme, uri = uri.split("://")
+          opts[:scheme] = scheme
+        else
+          opts[:scheme] = 'nats'
+        end
+
+        # UserInfo
+        if uri.include?("@")
+          userinfo, endpoint = uri.split("@")
+          host, port = endpoint.split(":")
+          opts[:userinfo] = userinfo
+        else
+          host, port = uri.split(":")
+        end
+
+        # Host and Port
+        opts[:host] = host || "localhost"
+        opts[:port] = port || DEFAULT_PORT
+
+        connect_uris << URI::Generic.build(opts)
+      end
+
+      connect_uris
+    end
   end
 
   attr_reader :connected, :connect_cb, :err_cb, :err_cb_overridden, :pongs_received #:nodoc:
-  attr_reader :closing, :reconnecting, :server_pool, :options, :server_info #:nodoc
+  attr_reader :closing, :reconnecting, :draining, :server_pool, :options, :server_info #:nodoc
   attr_reader :msgs_received, :msgs_sent, :bytes_received, :bytes_sent, :pings
   attr_reader :disconnect_cb, :close_cb
 
   alias :connected? :connected
   alias :closing? :closing
   alias :reconnecting? :reconnecting
+  alias :draining? :draining
 
   def initialize(options)
     @options = options
@@ -383,6 +479,9 @@ module NATS
     @resp_sub_prefix = nil
     @nuid = NATS::NUID.new
 
+    # Drain mode
+    @draining = false
+    @drained_subs = false
     send_connect_command
   end
 
@@ -392,7 +491,7 @@ module NATS
   # @param [String] opt_reply
   # @param [Block] blk, closure called when publish has been processed by the server.
   def publish(subject, msg=EMPTY_MSG, opt_reply=nil, &blk)
-    return unless subject
+    return unless subject and not @drained_subs
     msg = msg.to_s
 
     # Accounting
@@ -412,7 +511,7 @@ module NATS
   # @param [Block] callback, called when a message is delivered.
   # @return [Object] sid, Subject Identifier
   def subscribe(subject, opts={}, &callback)
-    return unless subject
+    return unless subject and not draining?
     sid = (@ssid += 1)
     sub = @subs[sid] = { :subject => subject, :callback => callback, :received => 0 }
     sub[:queue] = opts[:queue] if opts[:queue]
@@ -427,6 +526,7 @@ module NATS
   # @param [Object] sid
   # @param [Number] opt_max, optional number of responses to receive before auto-unsubscribing
   def unsubscribe(sid, opt_max=nil)
+    return if draining?
     opt_max_str = " #{opt_max}" unless opt_max.nil?
     send_command("UNSUB #{sid}#{opt_max_str}#{CR_LF}")
     return unless sub = @subs[sid]
@@ -434,6 +534,48 @@ module NATS
     @subs.delete(sid) unless (sub[:max] && (sub[:received] < sub[:max]))
   end
 
+  # Drain gracefully closes the connection.
+  # @param [Block] blk called when drain is done and connection is closed.
+  def drain(&blk)
+    return if draining? or closing?
+    @draining = true
+
+    # Remove interest in all subjects to stop receiving messages.
+    @subs.each do |sid, _|
+      send_command("UNSUB #{sid} #{CR_LF}")
+    end
+
+    # Roundtrip to ensure no more messages are received.
+    flush do
+      drain_timeout_timer, draining_timer = nil, nil
+      drain_timeout_timer = EM.add_timer(options[:drain_timeout]) do
+        EM.cancel_timer(draining_timer)
+
+        # Report the timeout via the error callback and just close
+        err_cb.call(NATS::ClientError.new("Drain Timeout"))
+        @draining = false
+        close unless closing?
+        blk.call if blk
+      end
+
+      # Periodically check for the pending data to be empty.
+      draining_timer = EM.add_periodic_timer(0.1) do
+        next unless closing? or @buf.nil? or @buf.empty?
+
+        # Subscriptions have been drained already so disallow publishing.
+        @drained_subs = true
+        next unless pending_data_size == 0
+        EM.cancel_timer(draining_timer)
+        EM.cancel_timer(drain_timeout_timer)
+
+        # We're done draining and can close now.
+        @draining = false
+        close unless closing?
+        blk.call if blk
+      end
+    end
+  end
+
   # Return the active subscription count.
   # @return [Number]
   def subscription_count
@@ -628,7 +770,7 @@ module NATS
   end
 
   def auth_connection?
-    !@uri.user.nil?
+    !@uri.user.nil? || @options[:token]
   end
 
   def connect_command #:nodoc:
@@ -637,12 +779,19 @@ module NATS
       :pedantic => @options[:pedantic],
       :lang => ::NATS::LANG,
       :version => ::NATS::VERSION,
-      :protocol => ::NATS::PROTOCOL_VERSION
+      :protocol => ::NATS::PROTOCOL_VERSION,
+      :echo => !@options[:no_echo]
     }
-    if auth_connection?
+    case
+    when @options[:token]
+      cs[:auth_token] = @options[:token]
+    when @uri.password.nil?
+      cs[:auth_token] = @uri.user
+    else
       cs[:user] = @uri.user
       cs[:pass] = @uri.password
-    end
+    end if auth_connection?
+
     cs[:name] = @options[:name] if @options[:name]
     cs[:ssl_required] = @ssl if @ssl
     cs[:tls_required] = true if @tls
@@ -701,6 +850,7 @@ module NATS
 
   def receive_data(data) #:nodoc:
     @buf = @buf ? @buf << data : data
+
     while (@buf)
       case @parse_state
       when AWAITING_CONTROL_LINE
@@ -748,7 +898,6 @@ module NATS
         @parse_state = AWAITING_CONTROL_LINE
         @buf = nil if (@buf && @buf.empty?)
       end
-
     end
   end
 
@@ -775,6 +924,14 @@ module NATS
       # Otherwise, use a regular connection.
     end
 
+    # Check whether there no echo is supported by the server.
+    if @options[:no_echo]
+      if @server_info[:proto].nil? || @server_info[:proto] < 1
+        err_cb.call(NATS::ServerError.new('No echo option not supported by this server'))
+        close_connection_after_writing
+      end
+    end
+
     # Detect any announced server that we might not be aware of...
     connect_urls = @server_info[:connect_urls]
     if connect_urls
@@ -792,9 +949,9 @@ module NATS
           u.password = options[:pass] if options[:pass]
 
           # Use creds from the current server if not set explicitly.
-          if @uri
-            u.user ||= @uri.user if @uri.user
-            u.password ||= @uri.password if @uri.password
+          if @uri and !@uri.user.nil? and !@uri.user.empty?
+            u.user ||= @uri.user
+            u.password ||= @uri.password
           end
 
           srvs << { :uri => u, :reconnect_attempts => 0, :discovered => true }

data/lib/nats/version.rb

@@ -14,7 +14,7 @@
 
 module NATS
   # NOTE: These are all announced to the server on CONNECT
-  VERSION = "0.9.2".freeze
+  VERSION = "0.10.0".freeze
   LANG    = RUBY_ENGINE
   PROTOCOL_VERSION = 1
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nats
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
 platform: ruby
 authors:
 - Derek Collison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-27 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine