nats-pure 0.7.2 → 2.0.0

data/lib/nats/io/kv.rb

@@ -0,0 +1,172 @@
+# 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.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require_relative 'errors'
+
+module NATS
+  class KeyValue
+    KV_OP = "KV-Operation"
+    KV_DEL = "DEL"
+    KV_PURGE = "PURGE"
+    MSG_ROLLUP_SUBJECT = "sub"
+    MSG_ROLLUP_ALL = "all"
+
+    def initialize(opts={})
+      @name = opts[:name]
+      @stream = opts[:stream]
+      @pre = opts[:pre]
+      @js = opts[:js]
+    end
+
+    # When a key is not found because it was deleted.
+    class KeyDeletedError < NATS::Error; end
+
+    # When there was no bucket present.
+    class BucketNotFoundError < NATS::Error; end
+
+    # When it is an invalid bucket.
+    class BadBucketError < NATS::Error; end
+
+    # get returns the latest value for the key.
+    def get(key)
+      msg = @js.get_last_msg(@stream, "#{@pre}#{key}")
+      entry = Entry.new(bucket: @name, key: key, value: msg.data, revision: msg.seq)
+
+      if not msg.headers.nil?
+        op = msg.headers[KV_OP]
+        raise KeyDeletedError.new("nats: key was deleted") if op == KV_DEL or op == KV_PURGE
+      end
+
+      entry
+    end
+
+    # put will place the new value for the key into the store
+    # and return the revision number.
+    def put(key, value)
+      @js.publish("#{@pre}#{key}", value)
+    end
+
+    # delete will place a delete marker and remove all previous revisions.
+    def delete(key)
+      hdrs = {}
+      hdrs[KV_OP] = KV_DEL
+      @js.publish("#{@pre}#{key}", header: hdrs)
+    end
+
+    # status retrieves the status and configuration of a bucket.
+    def status
+      info = @js.stream_info(@stream)
+      BucketStatus.new(info, @name)
+    end
+
+    Entry = Struct.new(:bucket, :key, :value, :revision, keyword_init: true) do
+      def initialize(opts={})
+        rem = opts.keys - members
+        opts.delete_if { |k| rem.include?(k) }
+        super(opts)
+      end
+    end
+
+    class BucketStatus
+      attr_reader :bucket
+
+      def initialize(info, bucket)
+        @nfo = info
+        @bucket = bucket
+      end
+
+      def values
+        @nfo.state.messages
+      end
+
+      def history
+        @nfo.config.max_msgs_per_subject
+      end
+
+      def ttl
+        @nfo.config.max_age / 1_000_000_000
+      end
+    end
+    
+    module API      
+      KeyValueConfig = Struct.new(:bucket, :description, :max_value_size,
+                                  :history, :ttl, :max_bytes, :storage, :replicas,
+                                  keyword_init: true) do
+        def initialize(opts={})
+          rem = opts.keys - members
+          opts.delete_if { |k| rem.include?(k) }
+          super(opts)
+        end
+      end
+    end
+
+    module Manager
+      def key_value(bucket)
+        stream = "KV_#{bucket}"
+        begin
+          si = stream_info(stream)
+        rescue NATS::JetStream::Error::NotFound
+          raise BucketNotFoundError.new("nats: bucket not found")
+        end
+        if si.config.max_msgs_per_subject < 1
+          raise BadBucketError.new("nats: bad bucket")
+        end
+
+        KeyValue.new(
+          name: bucket,
+          stream: stream,
+          pre: "$KV.#{bucket}.",
+          js: self,
+        )
+      end
+
+      def create_key_value(config)
+        config = if not config.is_a?(JetStream::API::StreamConfig)
+                   KeyValue::API::KeyValueConfig.new(config)
+                 else
+                   config
+                 end
+        config.history ||= 1
+        config.replicas ||= 1
+        if config.ttl
+          config.ttl = config.ttl * 1_000_000_000
+        end
+
+        stream = JetStream::API::StreamConfig.new(
+          name: "KV_#{config.bucket}",
+          subjects: ["$KV.#{config.bucket}.>"],
+          max_msgs_per_subject: config.history,
+          max_bytes: config.max_bytes,
+          max_age: config.ttl,
+          max_msg_size: config.max_value_size,
+          storage: config.storage,
+          num_replicas: config.replicas,
+          allow_rollup_hdrs: true,
+          deny_delete: true,
+        )
+        resp = add_stream(stream)
+
+        KeyValue.new(
+          name: config.bucket,
+          stream: stream.name,
+          pre: "$KV.#{config.bucket}.",
+          js: self,
+        )
+      end
+
+      def delete_key_value(bucket)
+        delete_stream("KV_#{bucket}")
+      end
+    end
+  end
+end

data/lib/nats/io/msg.rb

@@ -0,0 +1,56 @@
+# Copyright 2016-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.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require_relative 'js'
+
+module NATS
+  class Msg
+    attr_accessor :subject, :reply, :data, :header
+
+    # Enhance it with ack related methods from JetStream to ack msgs.
+    include JetStream::Msg::AckMethods
+
+    def initialize(opts={})
+      @subject = opts[:subject]
+      @reply   = opts[:reply]
+      @data    = opts[:data]
+      @header  = opts[:header]
+      @nc      = opts[:nc]
+      @sub     = opts[:sub]
+      @ackd    = false
+      @meta    = nil
+    end
+
+    def respond(data='')
+      return unless @nc
+      if self.header
+        dmsg = self.dup
+        dmsg.subject = self.reply
+        dmsg.data = data
+        @nc.publish_msg(dmsg)
+      else
+        @nc.publish(self.reply, data)
+      end
+    end
+
+    def respond_msg(msg)
+      return unless @nc
+      @nc.publish_msg(msg)
+    end
+
+    def inspect
+      hdr = ", header=#{@header}" if @header
+      "#<NATS::Msg(subject: \"#{@subject}\", reply: \"#{@reply}\", data: #{@data.slice(0, 10).inspect}#{hdr})>"
+    end
+  end
+end

data/lib/nats/io/parser.rb

@@ -71,22 +71,22 @@ module NATS
               @buf = $'
             when ERR
               @buf = $'
-              @nc.process_err($1)
+              @nc.send(:process_err, $1)
             when PING
               @buf = $'
-              @nc.process_ping
+              @nc.send(:process_ping)
             when PONG
               @buf = $'
-              @nc.process_pong
+              @nc.send(:process_pong)
             when INFO
               @buf = $'
               # First INFO message is processed synchronously on connect,
               # and onwards we would be receiving asynchronously INFO commands
               # signaling possible changes in the topology of the NATS cluster.
-              @nc.process_info($1)
+              @nc.send(:process_info, $1)
             when UNKNOWN
               @buf = $'
-              @nc.process_err("Unknown protocol: #{$1}")
+              @nc.send(:process_err, "Unknown protocol: #{$1}")
             else
               # If we are here we do not have a complete line yet that we understand.
               return
@@ -98,10 +98,10 @@ module NATS
             if @header_needed
               hbuf = @buf.slice(0, @header_needed)
               payload = @buf.slice(@header_needed, (@needed-@header_needed))
-              @nc.process_msg(@sub, @sid, @reply, payload, hbuf)
+              @nc.send(:process_msg, @sub, @sid, @reply, payload, hbuf)
               @buf = @buf.slice((@needed + CR_LF_SIZE), @buf.bytesize)
             else
-              @nc.process_msg(@sub, @sid, @reply, @buf.slice(0, @needed), nil)
+              @nc.send(:process_msg, @sub, @sid, @reply, @buf.slice(0, @needed), nil)
               @buf = @buf.slice((@needed + CR_LF_SIZE), @buf.bytesize)
             end
 

data/lib/nats/io/subscription.rb

@@ -0,0 +1,92 @@
+# Copyright 2016-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.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module NATS
+
+  # A Subscription represents interest in a given subject.
+  # 
+  # @example Create NATS subscription with callback.
+  #   require 'nats/client'
+  # 
+  #   nc = NATS.connect("demo.nats.io")
+  #   sub = nc.subscribe("foo") do |msg|
+  #     puts "Received [#{msg.subject}]: #{}"
+  #   end
+  # 
+  class Subscription
+    include MonitorMixin
+
+    attr_accessor :subject, :queue, :future, :callback, :response, :received, :max, :pending, :sid
+    attr_accessor :pending_queue, :pending_size, :wait_for_msgs_t, :wait_for_msgs_cond, :is_slow_consumer
+    attr_accessor :pending_msgs_limit, :pending_bytes_limit
+    attr_accessor :nc
+    attr_accessor :jsi
+    attr_accessor :closed
+
+    def initialize
+      super # required to initialize monitor
+      @subject  = ''
+      @queue    = nil
+      @future   = nil
+      @callback = nil
+      @response = nil
+      @received = 0
+      @max      = nil
+      @pending  = nil
+      @sid      = nil
+      @nc       = nil
+      @closed   = nil
+
+      # State from async subscriber messages delivery
+      @pending_queue       = nil
+      @pending_size        = 0
+      @pending_msgs_limit  = nil
+      @pending_bytes_limit = nil
+      @wait_for_msgs_t     = nil
+      @is_slow_consumer    = false
+
+      # Sync subscriber
+      @wait_for_msgs_cond = nil
+    end
+
+    # Auto unsubscribes the server by sending UNSUB command and throws away
+    # subscription in case already present and has received enough messages.
+    def unsubscribe(opt_max=nil)
+      @nc.send(:unsubscribe, self, opt_max)
+    end
+
+    # next_msg blocks and waiting for the next message to be received.
+    def next_msg(opts={})
+      timeout = opts[:timeout] ||= 0.5
+      synchronize do
+        return @pending_queue.pop if not @pending_queue.empty?
+
+        # Wait for a bit until getting a signal.
+        MonotonicTime::with_nats_timeout(timeout) do
+          wait_for_msgs_cond.wait(timeout)
+        end
+
+        if not @pending_queue.empty?
+          return @pending_queue.pop
+        else
+          raise NATS::Timeout
+        end
+      end
+    end
+
+    def inspect
+      "#<NATS::Subscription(subject: \"#{@subject}\", queue: \"#{@queue}\", sid: #{@sid})>"
+    end
+  end
+end

data/lib/nats/io/version.rb

@@ -1,4 +1,4 @@
-# Copyright 2016-2021 The NATS Authors
+# Copyright 2016-2022 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.
 # You may obtain a copy of the License at
@@ -14,9 +14,13 @@
 
 module NATS
   module IO
-    # NOTE: These are all announced to the server on CONNECT
-    VERSION  = "0.7.2"
-    LANG     = "#{RUBY_ENGINE}#{RUBY_VERSION}".freeze
+    # VERSION is the version of the client announced on CONNECT to the server.
+    VERSION = "2.0.0".freeze
+
+    # LANG is the lang runtime of the client announced on CONNECT to the server.
+    LANG = "#{RUBY_ENGINE}#{RUBY_VERSION}".freeze
+
+    # PROTOCOL is the supported version of the protocol in the client.
     PROTOCOL = 1
   end
 end

data/lib/nats.rb

@@ -0,0 +1,39 @@
+# 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.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'nats/io/client'
+require 'nats/nuid'
+
+# A thread safe Ruby client for the NATS messaging system (https://nats.io).
+#
+# @example Service example
+#   nc = NATS.connect("demo.nats.io")
+#   nc.subscribe("foo") do |msg|
+#     msg.respond("Hello World")
+#   end
+#
+#   resp = nc.request("foo")
+#   puts "Received: #{msg.data}"
+# 
+# 
+# @example Stream example
+#   nc = NATS.connect("demo.nats.io")
+#   sub = nc.subscribe("foo")
+# 
+#   nc.publish("foo")
+#   msg = sub.next_msg
+#   puts "Received: #{msg.data}"
+# 
+module NATS
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nats-pure
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Waldemar Quevedo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-25 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies: []
 description: NATS is an open-source, high-performance, lightweight cloud messaging
   system.
@@ -18,8 +18,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/nats.rb
+- lib/nats/client.rb
 - lib/nats/io/client.rb
+- lib/nats/io/errors.rb
+- lib/nats/io/js.rb
+- lib/nats/io/kv.rb
+- lib/nats/io/msg.rb
 - lib/nats/io/parser.rb
+- lib/nats/io/subscription.rb
 - lib/nats/io/version.rb
 - lib/nats/nuid.rb
 homepage: https://nats.io