knot-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102f6dc54dc3b034d4b71e890c921cdd3067ef32999cf92e829b56e6cf661266
-  data.tar.gz: 847a1e73410dd0dbe17793c7c2819e22879dfbe47f728ec0625e02b88dcb7c2a
+  metadata.gz: 955cc51d2b5bc2c9057fbac7501aa4cd4ddae6a41769a414d9f3dad99da233ec
+  data.tar.gz: 7e63b760071edf2236e09e2148a447d6f3a6ea11ddef129fc98e6160ea43217e
 SHA512:
-  metadata.gz: e87bfff66910c223c3046dbc0ea63929d7c60d62434e06f1dccac5f2bca3ffc8b9e0652b32c1f4137ff6912cca50f26855dd989a64ec8f2a1c2f741f34307637
-  data.tar.gz: bcd68e1fa196ec799970697180b2dd375c6816da752c721dab9b0bf4bb82405d5909f090f5f10185713ee4c28166af0a64f103ff926ede60a519fc41a13a2e6a
+  metadata.gz: 9c8056ca3f3f7f2b97eb2dbc57047f2d6222a76e2b1d1794a07b016037cb976e6c9d6510e236f26aeb6d9182d98a82ee27f141f5e7bd291ec2d0992847829b6f
+  data.tar.gz: 8f85e0815f1e6bbcc39c357be9ee3d3922201f9fa58aafa576e6d69db1dd8a2d18601d547db2299621fe2bd223745a91987fc6b8a986634e1ec63dd94b8c7811

data/lib/knot/interface.rb

@@ -127,37 +127,39 @@ class Knot::Conf
 		self.commit
 	end
 
-	def parse_item k
-		case k
+	def parse_item kv
+		case kv
 		when Hash
-			case k.keys.sort
-			when %w[section], %w[id section], %w[item section], %w[id item section]
-				k
+			r = {}
+			kv.each {|k,v| r[k.to_s.to_sym] = v }
+			case r.keys.sort
+			when %i[section], %i[id section], %i[item section], %i[id item section]
+				r
 			else
-				raise ArgumentError, "Invalid Item-format"
+				raise ArgumentError, "Invalid Item-format: #{k}"
 			end
 
 		when Array
-			case k.length
-			when 1 then {section: k[0]}
-			when 2 then {section: k[0], item: k[1]}
-			when 3 then {section: k[0], id: k[1], item: k[2]}
-			else raise ArgumentError, "Invalid Item-format"
+			case kv.length
+			when 1 then {section: kv[0]}
+			when 2 then {section: kv[0],            item: kv[1]}
+			when 3 then {section: kv[0], id: kv[1], item: kv[2]}
+			else raise ArgumentError, "Invalid Item-format: #{kv}"
 			end
 
 		when /\A
-					(?<section> [a-z0-9_-]+ )
-					(?: \[ (?<id> [a-z0-9_.-]+) \] )?
-					(?: \. (?<item>[a-z0-9_-]+) )?
+			(?<section> [a-z0-9_-]+ )
+			(?: \[ (?<id> [a-z0-9_.-]+) \] )?
+				(?: \. (?<item>[a-z0-9_-]+) )?
 				\z/xi
 
-			$~.named_captures.delete_if {|_,v| v.nil? }
+				$~.named_captures.delete_if {|_,v| v.nil? }
 
 		when nil
 			{}
 
 		else
-			raise ArgumentError, "Invalid Item-format"
+			raise ArgumentError, "Invalid Item-format: #{kv}"
 		end
 	end
 

data/lib/knot/protocol.rb

@@ -1,5 +1,7 @@
 require 'iounpack'
-require 'stringio'
+require 'pathname'
+require 'socket'
+require 'logger'
 require_relative 'errors'
 
 module Knot
@@ -53,7 +55,7 @@ module Knot::Protocol::Type
 end
 
 #class Knot::KnotC
-#	attr_accessor :debug, :binary
+#	attr_accessor :binary
 #
 #	def initialize path = nil, binary: nil
 #   @path = path
@@ -72,44 +74,100 @@ end
 #	end
 #end
 
-module Knot::Protocol::Idx
-	Idx = [
-		:command, # 10, :CMD,     # Control command name.
-		:flags,   # 11, :FLAGS,   # Control command flags.
-		:error,   # 12, :ERROR,   # Error message.
-		:section, # 13, :SECTION, # Configuration section name.
-		:item,    # 14, :ITEM,    # Configuration item name.
-		:id,      # 15, :ID,      # Congiguration item identifier.
-		:zone,    # 16, :ZONE,    # Zone name.
-		:owner,   # 17, :OWNER,   # Zone record owner
-		:ttl,     # 18, :TTL,     # Zone record TTL.
-		:type,    # 19, :TYPE,    # Zone record type name.
-		:data,    # 1a, :DATA,    # Configuration item/zone record data.
-		:filter,  # 1b, :FILTER,  # An option or a filter for output data processing.
-	]
-	Name = {}
-	Code = {}
-	Idx.each_with_index do |v, i|
-		Code[0x10+i] = v
-		Name[v] = i
+class Knot::Protocol::Code
+	include Comparable
+	attr_reader :name, :code, :cname, :description
+
+	def initialize name, code, cname, description
+		raise ArgumentError, "Expecting Symbol for #{self.class.name} instead of: #{name.inspect}"   unless Symbol === name
+		raise ArgumentError, "Expecting Integer for #{self.class.name} instead of: #{code.inspect}"  unless Integer === code
+		@name, @code, @cname, @description = name, code, cname, description
+		freeze
+	end
+
+	def === x
+		case x
+		when self.class then @id   == x.id
+		when Symbol     then @name == x
+		when String     then @name == x.to_sym
+		when Integer    then @code == x
+		else nil
+		end
 	end
-	def self.[] k
+
+	def <=>( x)  @id <=> x.id  end
+	def to_s()   @name.to_s  end
+	def to_sym() @name  end
+	def to_i()   @code  end
+end
+
+module Knot::Protocol::Codes
+	include Enumerable
+	def [] k
 		case k
 		when Symbol
-			Name[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
+			self::Name[k] or raise Knot::Errors::EINVAL, "Unknown Codes: #{k}"
 		when Integer
-			Idx[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
+			self::Code[k] or raise Knot::Errors::EINVAL, "Unknown Codes: #{k}"
 		else
-			raise ArgumentError, "Unknown Idx-Type: #{k}"
+			raise ArgumentError, "Unknown Codes-Type: #{k}"
 		end
 	end
+
+	def each &exe
+		block_given? ? self::Codes.each( &exe) : self::Codes.to_enum( :each)
+	end
+end
+
+module Knot::Protocol::Idx
+	extend Knot::Protocol::Codes
+
+	Codes = [
+		Knot::Protocol::Code.new( :command, 0x10, :CMD,     'Control command name.'),
+		Knot::Protocol::Code.new( :flags,   0x11, :FLAGS,   'Control command flags.'),
+		Knot::Protocol::Code.new( :error,   0x12, :ERROR,   'Error message.'),
+		Knot::Protocol::Code.new( :section, 0x13, :SECTION, 'Configuration section name.'),
+		Knot::Protocol::Code.new( :item,    0x14, :ITEM,    'Configuration item name.'),
+		Knot::Protocol::Code.new( :id,      0x15, :ID,      'Congiguration item identifier.'),
+		Knot::Protocol::Code.new( :zone,    0x16, :ZONE,    'Zone name.'),
+		Knot::Protocol::Code.new( :owner,   0x17, :OWNER,   'Zone record owner'),
+		Knot::Protocol::Code.new( :ttl,     0x18, :TTL,     'Zone record TTL.'),
+		Knot::Protocol::Code.new( :type,    0x19, :TYPE,    'Zone record type name.'),
+		Knot::Protocol::Code.new( :data,    0x1a, :DATA,    'Configuration item/zone record data.'),
+		Knot::Protocol::Code.new( :filter,  0x1b, :FILTER,  'An option or a filter for output data processing.'),
+	]
+	Name = {}
+	Code = {}
+
+	Codes.each do |id|
+		Code[id.to_i] = id
+		Name[id.to_sym] = id
+	end
+end
+
+module Knot::Protocol::Types
+	extend Knot::Protocol::Codes
+
+	Codes = [
+		Knot::Protocol::Code.new( :end,   0x00, :END,   'Type END.'),
+		Knot::Protocol::Code.new( :data,  0x01, :DATA,  'Type DATA.'),
+		Knot::Protocol::Code.new( :extra, 0x02, :EXTRA, 'Type EXTRA.'),
+		Knot::Protocol::Code.new( :block, 0x03, :BLOCK, 'Type BLOCK.'),
+	]
+
+	Name = {}
+	Code = {}
+
+	Codes.each do |id|
+		Code[id.to_i] = id
+		Name[id.to_sym] = id
+	end
 end
 
 class Knot::Protocol
-	attr_reader :sock, :conf, :zones
-	attr_accessor :debug
+	attr_reader :sock, :conf, :zones, :logger
 
-	def initialize path_or_sock = nil
+	def initialize path_or_sock = nil, logger: nil
 		case path_or_sock
 		when String, Pathname
 			@sock = UNIXSocket.new path_or_sock.to_s
@@ -118,24 +176,32 @@ class Knot::Protocol
 		when nil
 			@sock = UNIXSocket.new '/run/knot/knot.sock'
 		end
-		@debug = false
+		@logger = logger || Logger.new(STDERR)
 		@conf = Knot::Conf.new self
 		@zones = Hash.new {|h, zone| h[zone] = Knot::Zone.new zone, self }
 	end
 
 	def snd sock: nil, **data
 		rsock = sock || @sock
-		s = ''
-		sock = StringIO.new s
-		sock.write [1].pack( 'c')
+		#s = ''.b
+		#sock = StringIO.new s
+		#sock.write [1].pack( 'c')
 		data[:flags] ||= ''
-		Idx::Idx.each_with_index do |n, i|
-			v = data[n]&.to_s
-			sock.write [0x10+i, v.size, v].pack( 'c na*')  if v
+		ds =
+			Idx.
+				select {|n| data[n.to_sym] }.
+				map {|n| v = data[n.to_sym].to_s.b; [n.to_i, v.size, v ] }
+		s = [Types[:data].to_i, ds, Types[:block].to_i].flatten.pack( "c #{'c na*'*ds.length} c").b
+		#Idx.each do |n|
+		#	v = data[n.to_sym]&.to_s&.b
+		#	sock.write [n.to_i, v.size, v].pack( 'c na*')  if v
+		#end
+		#sock.write [3].pack( 'c')
+		#sock.flush
+		if 0 >= @logger.sev_threshold
+			@logger.debug "send data #{data.inspect}"
+			@logger.debug "send raw  #{s.inspect}"
 		end
-		sock.write [3].pack( 'c')
-		sock.flush
-		STDERR.puts( {data: data, _: s}.inspect)  if @debug
 		rsock.write s
 		rsock.flush
 	end
@@ -144,45 +210,48 @@ class Knot::Protocol
 		attr_reader :str
 
 		def initialize sock, str = nil
-			@str, @sock = str || '', sock
+			@str, @sock = str || ''.b, sock
 		end
 
 		def unpack pattern
-			IOUnpack.new(pattern).unpack self
+			IOUnpack.new( pattern).unpack self
 		end
 
 		def unpack1 pattern
-			IOUnpack.new(pattern).unpack1 self
+			IOUnpack.new( pattern).unpack1 self
 		end
 
 		def read n
 			s = @sock.read n
-			@str.insert -1, s
-			s
+			@str.insert -1, s  unless s.nil?
+			s || ''
 		end
 	end
 
 	def rcv sock: nil
 		ret, r = [], nil
 		sock = sock || @sock
-		sock = RecordIO.new sock  if @debug
+		sock = RecordIO.new sock  if 0 >= @logger.sev_threshold
 		loop do
 			t = sock.unpack1 'c'
 			case t
-			when 0, 3
+			when Knot::Protocol::Types[:end], Knot::Protocol::Types[:block]
 				return ret
-			when 1, 2
+			when Knot::Protocol::Types[:data], Knot::Protocol::Types[:extra]
 				type = t
 				ret.push( r = {})
 			else
 				raise Knot::Errors::EINVAL, "Missing Type before: #{t}"  if ret.empty?
-				i = Idx::Idx[t - 0x10] or raise Knot::Errors::EINVAL, "Unknown index: #{t-0x10}"
+				i = Idx[t] or raise Knot::Errors::EINVAL, "Unknown index: #{t}"
 				l = sock.unpack1 'n'
-				r[i] = sock.read( l)
+				r[i.to_sym] = sock.read( l)
 			end
 		end
 	ensure
-		STDERR.puts( {rcvd: ret, read: sock.str}.inspect)  if @debug
+		if RecordIO === sock
+			@logger.debug "rcvd raw  #{sock.str.inspect}"
+			@logger.debug "rcvd data #{ret.inspect}"
+		end
 		ret
 	end
 

data/lib/knot/version.rb

@@ -1,3 +1,3 @@
 module Knot
-	VERSION = "0.2.0"
+	VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iounpack
@@ -64,8 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.2.5
 signing_key: 
 specification_version: 4
 summary: Provides interface to knot-server.