nats-pure 2.3.0 → 2.5.0

data/lib/nats/io/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/nats/io/jetstream/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,9 +14,9 @@
 # limitations under the License.
 #
 
-require_relative 'errors'
-require 'base64'
-require 'time'
+require_relative "errors"
+require "base64"
+require "time"
 
 module NATS
   class JetStream
@@ -29,12 +31,12 @@ module NATS
       # @!attribute stream_seq
       #   @return [Integer] The stream sequence.
       SequenceInfo = Struct.new(:consumer_seq, :stream_seq, :last_active,
-                                keyword_init: true) do
-        def initialize(opts={})
+        keyword_init: true) do
+        def initialize(opts = {})
           # Filter unrecognized fields and freeze.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
           freeze
         end
       end
@@ -64,21 +66,23 @@ module NATS
       # @!attribute cluster
       #   @return [Hash]
       ConsumerInfo = Struct.new(:type, :stream_name, :name, :created,
-                                :config, :delivered, :ack_floor,
-                                :num_ack_pending, :num_redelivered, :num_waiting,
-                                :num_pending, :cluster, :push_bound,
-                                keyword_init: true) do
-        def initialize(opts={})
+        :config, :delivered, :ack_floor,
+        :num_ack_pending, :num_redelivered, :num_waiting,
+        :num_pending, :cluster, :push_bound,
+        keyword_init: true) do
+        def initialize(opts = {})
           opts[:created] = Time.parse(opts[:created])
           opts[:ack_floor] = SequenceInfo.new(opts[:ack_floor])
           opts[:delivered] = SequenceInfo.new(opts[:delivered])
           opts[:config][:ack_wait] = opts[:config][:ack_wait] / ::NATS::NANOSECONDS
+          opts[:config][:inactive_threshold] = opts[:config][:inactive_threshold] / ::NATS::NANOSECONDS if opts[:config][:inactive_threshold]
+          opts[:config][:idle_heartbeat] = opts[:config][:idle_heartbeat] / ::NATS::NANOSECONDS if opts[:config][:idle_heartbeat]
           opts[:config] = ConsumerConfig.new(opts[:config])
           opts.delete(:cluster)
           # Filter unrecognized fields just in case.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
           freeze
         end
       end
@@ -102,29 +106,30 @@ module NATS
       # @!attribute max_ack_pending
       #   @return [Integer]
       ConsumerConfig = Struct.new(:name, :durable_name, :description,
-                                  :deliver_policy, :opt_start_seq, :opt_start_time,
-                                  :ack_policy, :ack_wait, :max_deliver, :backoff,
-                                  :filter_subject, :replay_policy, :rate_limit_bps,
-                                  :sample_freq, :max_waiting, :max_ack_pending,
-                                  :flow_control, :idle_heartbeat, :headers_only,
-
-                                  # Pull based options
-                                  :max_batch, :max_expires,
-                                  # Push based consumers
-                                  :deliver_subject, :deliver_group,
-                                  # Ephemeral inactivity threshold
-                                  :inactive_threshold,
-                                  # Generally inherited by parent stream and other markers,
-                                  # now can be configured directly.
-                                  :num_replicas,
-                                  # Force memory storage
-                                  :mem_storage,
-                                  keyword_init: true) do
-        def initialize(opts={})
+        :deliver_policy, :opt_start_seq, :opt_start_time,
+        :ack_policy, :ack_wait, :max_deliver, :backoff,
+        :filter_subject, :replay_policy, :rate_limit_bps,
+        :sample_freq, :max_waiting, :max_ack_pending,
+        :flow_control, :idle_heartbeat, :headers_only,
+        # Pull based options
+        :max_batch, :max_expires,
+        # Push based consumers
+        :deliver_subject, :deliver_group,
+        # Ephemeral inactivity threshold
+        :inactive_threshold,
+        # Generally inherited by parent stream and other markers,
+        # now can be configured directly.
+        :num_replicas,
+        # Force memory storage
+        :mem_storage,
+        # NATS v2.10 features
+        :metadata, :filter_subjects, :max_bytes,
+        keyword_init: true) do
+        def initialize(opts = {})
           # Filter unrecognized fields just in case.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
         end
       end
 
@@ -192,12 +197,14 @@ module NATS
         :republish,
         :allow_direct,
         :mirror_direct,
-        keyword_init: true) do
-        def initialize(opts={})
+        :metadata,
+        keyword_init: true
+      ) do
+        def initialize(opts = {})
           # Filter unrecognized fields just in case.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
         end
       end
 
@@ -214,8 +221,8 @@ module NATS
       # @!attribute domain
       #   @return [String]
       StreamInfo = Struct.new(:type, :config, :created, :state, :domain,
-                              keyword_init: true) do
-        def initialize(opts={})
+        keyword_init: true) do
+        def initialize(opts = {})
           opts[:config] = StreamConfig.new(opts[:config])
           opts[:state] = StreamState.new(opts[:state])
           opts[:created] = ::Time.parse(opts[:created])
@@ -223,7 +230,7 @@ module NATS
           # Filter fields and freeze.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
           freeze
         end
       end
@@ -241,12 +248,12 @@ module NATS
       # @!attribute consumer_count
       #   @return [Integer]
       StreamState = Struct.new(:messages, :bytes, :first_seq, :first_ts,
-                               :last_seq, :last_ts, :consumer_count,
-                               keyword_init: true) do
-        def initialize(opts={})
+        :last_seq, :last_ts, :consumer_count,
+        keyword_init: true) do
+        def initialize(opts = {})
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
         end
       end
 
@@ -263,13 +270,13 @@ module NATS
       # @!attribute did_create
       #   @return [Boolean]
       StreamCreateResponse = Struct.new(:type, :config, :created, :state, :did_create,
-                                        keyword_init: true) do
-        def initialize(opts={})
+        keyword_init: true) do
+        def initialize(opts = {})
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
           opts[:config] = StreamConfig.new(opts[:config])
           opts[:state] = StreamState.new(opts[:state])
-          super(opts)
+          super
           freeze
         end
       end
@@ -293,11 +300,11 @@ module NATS
           # Filter out members not present.
           rem = opts.keys - members
           opts.delete_if { |k| rem.include?(k) }
-          super(opts)
+          super
         end
 
         def sequence
-          self.seq
+          seq
         end
       end
     end

data/lib/nats/io/jetstream/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,7 +18,6 @@ module NATS
   class JetStream
     # Error is any error that may arise when interacting with JetStream.
     class Error < NATS::IO::Error
-
       # When there is a NATS::IO::NoResponders error after making a publish request.
       class NoStreamResponse < Error; end
 
@@ -41,18 +42,25 @@ module NATS
 
       # When the server responds with an error from the JetStream API.
       class APIError < Error
-        attr_reader :code, :err_code, :description, :stream, :seq
+        attr_accessor :code, :err_code, :description, :stream, :consumer, :seq
 
-        def initialize(params={})
+        def initialize(params = {})
           @code = params[:code]
           @err_code = params[:err_code]
           @description = params[:description]
           @stream = params[:stream]
+          @consumer = params[:consumer]
           @seq = params[:seq]
         end
 
         def to_s
-          "#{@description} (status_code=#{@code}, err_code=#{@err_code})"
+          if @stream && @consumer
+            "#{@description} (status_code=#{@code}, err_code=#{@err_code}, stream=#{@stream}, consumer=#{@consumer})"
+          elsif @stream
+            "#{@description} (status_code=#{@code}, err_code=#{@err_code}, stream=#{@stream})"
+          else
+            "#{@description} (status_code=#{@code}, err_code=#{@err_code})"
+          end
         end
       end
 
@@ -61,8 +69,8 @@ module NATS
       # running in cluster mode.
       # This condition is represented with a message that has 503 status code header.
       class ServiceUnavailable < APIError
-        def initialize(params={})
-          super(params)
+        def initialize(params = {})
+          super
           @code ||= 503
         end
       end
@@ -70,8 +78,8 @@ module NATS
       # When there is a hard failure in the JetStream.
       # This condition is represented with a message that has 500 status code header.
       class ServerError < APIError
-        def initialize(params={})
-          super(params)
+        def initialize(params = {})
+          super
           @code ||= 500
         end
       end
@@ -79,23 +87,31 @@ module NATS
       # When a JetStream object was not found.
       # This condition is represented with a message that has 404 status code header.
       class NotFound < APIError
-        def initialize(params={})
-          super(params)
+        def initialize(params = {})
+          super
           @code ||= 404
         end
       end
 
       # When the stream is not found.
-      class StreamNotFound < NotFound; end
+      class StreamNotFound < NotFound
+        def initialize(params = {})
+          super
+        end
+      end
 
       # When the consumer or durable is not found by name.
-      class ConsumerNotFound < NotFound; end
+      class ConsumerNotFound < NotFound
+        def initialize(params = {})
+          super
+        end
+      end
 
       # When the JetStream client makes an invalid request.
       # This condition is represented with a message that has 400 status code header.
       class BadRequest < APIError
-        def initialize(params={})
-          super(params)
+        def initialize(params = {})
+          super
           @code ||= 400
         end
       end

data/lib/nats/io/jetstream/js/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,10 +18,14 @@ module NATS
   class JetStream
     module JS
       module Config
+        # rubocop:disable Naming/ConstantName
+
         # AckPolicy
-        AckExplicit = ("explicit".freeze)
-        AckAll      = ("all".freeze)
-        AckNone     = ("none".freeze)
+        AckExplicit = "explicit"
+        AckAll = "all"
+        AckNone = "none"
+
+        # rubocop:enable Naming/ConstantName
       end
     end
   end

data/lib/nats/io/jetstream/js/header.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,15 +18,19 @@ module NATS
   class JetStream
     module JS
       module Header
-        Status              = ("Status".freeze)
-        Desc                = ("Description".freeze)
-        MsgID               = ("Nats-Msg-Id".freeze)
-        ExpectedStream      = ("Nats-Expected-Stream".freeze)
-        ExpectedLastSeq     = ("Nats-Expected-Last-Sequence".freeze)
-        ExpectedLastSubjSeq = ("Nats-Expected-Last-Subject-Sequence".freeze)
-        ExpectedLastMsgID   = ("Nats-Expected-Last-Msg-Id".freeze)
-        LastConsumerSeq     = ("Nats-Last-Consumer".freeze)
-        LastStreamSeq       = ("Nats-Last-Stream".freeze)
+        # rubocop:disable Naming/ConstantName
+
+        Status = "Status"
+        Desc = "Description"
+        MsgID = "Nats-Msg-Id"
+        ExpectedStream = "Nats-Expected-Stream"
+        ExpectedLastSeq = "Nats-Expected-Last-Sequence"
+        ExpectedLastSubjSeq = "Nats-Expected-Last-Subject-Sequence"
+        ExpectedLastMsgID = "Nats-Expected-Last-Msg-Id"
+        LastConsumerSeq = "Nats-Last-Consumer"
+        LastStreamSeq = "Nats-Last-Stream"
+
+        # rubocop:enable Naming/ConstantName
       end
     end
   end

data/lib/nats/io/jetstream/js/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,11 +18,15 @@ module NATS
   class JetStream
     module JS
       module Status
-        CtrlMsg        = ("100".freeze)
-        NoMsgs         = ("404".freeze)
-        NotFound       = ("404".freeze)
-        RequestTimeout = ("408".freeze)
-        ServiceUnavailable = ("503".freeze)
+        # rubocop:disable Naming/ConstantName
+
+        CtrlMsg = "100"
+        NoMsgs = "404"
+        NotFound = "404"
+        RequestTimeout = "408"
+        ServiceUnavailable = "503"
+
+        # rubocop:enable Naming/ConstantName
       end
     end
   end

data/lib/nats/io/jetstream/js/sub.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,9 +18,9 @@ module NATS
   class JetStream
     module JS
       class Sub
-        attr_reader :js, :stream, :consumer, :nms
+        attr_accessor :js, :stream, :consumer, :nms
 
-        def initialize(opts={})
+        def initialize(opts = {})
           @js = opts[:js]
           @stream = opts[:stream]
           @consumer = opts[:consumer]

data/lib/nats/io/jetstream/js.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2021 The NATS Authors
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -12,17 +14,17 @@
 # limitations under the License.
 #
 
-require_relative 'js/config'
-require_relative 'js/header'
-require_relative 'js/status'
-require_relative 'js/sub'
+require_relative "js/config"
+require_relative "js/header"
+require_relative "js/status"
+require_relative "js/sub"
 
 module NATS
   class JetStream
     # Misc internal functions to support JS API.
     # @private
     module JS
-      DefaultAPIPrefix = ("$JS.API".freeze)
+      DefaultAPIPrefix = "$JS.API" # rubocop:disable Naming/ConstantName
 
       class << self
         def next_req_to_json(next_req)
@@ -34,14 +36,14 @@ module NATS
         end
 
         def is_status_msg(msg)
-          return (!msg.nil? and (!msg.header.nil? and msg.header[Header::Status]))
+          (!msg.nil? and (!msg.header.nil? and msg.header[Header::Status]))
         end
 
         # check_503_error raises exception when a NATS::Msg has a 503 status header.
         # @param msg [NATS::Msg] The message with status headers.
         # @raise [NATS::JetStream::Error::ServiceUnavailable]
         def check_503_error(msg)
-          return if msg.nil? or msg.header.nil?
+          return if msg.nil? || msg.header.nil?
           if msg.header[Header::Status] == Status::ServiceUnavailable
             raise ::NATS::JetStream::Error::ServiceUnavailable
           end
@@ -59,7 +61,7 @@ module NATS
           check_503_error(msg)
           code = msg.header[JS::Header::Status]
           desc = msg.header[JS::Header::Desc]
-          return ::NATS::JetStream::API::Error.new({code: code, description: desc})
+          ::NATS::JetStream::API::Error.new({code: code, description: desc})
         end
 
         # from_error takes an API response that errored and maps the error