knot-ruby 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d24b7dfed91ed556ec5c2ee1b6c765eb96879e2d7d5fdd4dfaf060e474f4c91
-  data.tar.gz: 66c899d76cbd7ff9ea68d7f3f0fad98dc8bf21a1e136d156379f25ee42046ad1
+  metadata.gz: 431bf7db78b2a1b8e1698f53eec8ae8726ef3aca3a9c3b38c77f06ef592fd9c9
+  data.tar.gz: 8dcf78f6703e9c1c00149f629684b1cda175f20f2148c9780cd4eead1a9e78fb
 SHA512:
-  metadata.gz: 5763ee24991d9d75ef48da2bb203acba69dc89dc4d982d35abd23980792f0649062ef4e58b8a9f5982a341cda9c20ac810873de1476d057c69cc733105fa5ecc
-  data.tar.gz: b932a258e7340a0e3baa7a0a833868b6a5a9ae8eb6f5d1149601193238c1279abe3710d3dda9e1e5cc193ba74baa3fad61411ad34820b60fdffca52d6a7035f5
+  metadata.gz: 68642c8b64d37524a7ee4b53187e444dfe003fc5e47ee6208954b078c9849fabbfcd5080472a7bd42f2fa9721cac6060a04ff26233ba3ee891698cd4227ff919
+  data.tar.gz: 7bcbe887741d86b4fdc09212ae92a8ffc08e824aaaf9ec82fa225e4faf3a5db9434ab99bfff14cc0e918f24f9df6ea792b074f66c1a58ba7a25f8b12d32c1dfd

data/Gemfile

@@ -1,4 +1,5 @@
 source "https://rubygems.org"
+ruby '>=2.7'
 
 # Specify your gem's dependencies in knot.gemspec
 gemspec

data/knot-ruby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 	spec.summary       = %q{Provides interface to knot-server.}
   spec.description   = %q{Implements knot-protocol to provide an interface to knot-DNS-server}
 	spec.homepage      = 'https://git.denkn.at/deac/knot'
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 

data/lib/knot/interface.rb

@@ -69,7 +69,7 @@ class Knot::Zone
 
 	def read() @protocol.call command: 'zone-read', zone: @zone end
 	def diff() @protocol.call command: 'zone-diff', zone: @zone end
-	
+
 	# setting record
 	# if data is nil, it will be unset.
 	def set owner, ttl = nil, type, data
@@ -127,59 +127,64 @@ 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
 
 	def get item = nil
-		@protocol.call (item ? parse_item( item) : {}).update( command: 'conf-get')
+		@protocol.call **parse_item( item).update( command: 'conf-get')
 	end
 
 	# Sets or adds a new value to item.
 	# knot knows single-value items like `server.rundir` and multi-value items like `server.listen`.
 	# If you set a single-value, it will replace the old value.  On a multi-value, it will add it.
 	def set item, value
-		@protocol.call parse_item( item).update( command: 'conf-set', data: value)
+		@protocol.call **parse_item( item).update( command: 'conf-set', data: value)
 	end
 
 	# Removes value from item.  If you provide a value, this value will be removed.
 	def unset item, value = nil
-		@protocol.call parse_item( item).update( command: 'conf-unset', data: value)
+		@protocol.call **parse_item( item).update( command: 'conf-unset', data: value)
 	end
 	alias delete unset
 
 	def list item = nil
-		@protocol.call (item ? parse_item( item) : {}).update( command: 'conf-list')
+		@protocol.call **parse_item( item).update( command: 'conf-list')
 	end
 
 	def read item = nil
-		@protocol.call (item ? parse_item( item) : {}).update( command: 'conf-read')
+		@protocol.call **parse_item( item).update( command: 'conf-read')
 	end
 end

data/lib/knot/protocol.rb

@@ -1,4 +1,5 @@
 require 'iounpack'
+require 'stringio'
 require_relative 'errors'
 
 module Knot
@@ -51,44 +52,98 @@ module Knot::Protocol::Type
 	end
 end
 
+#class Knot::KnotC
+#	attr_accessor :binary
+#
+#	def initialize path = nil, binary: nil
+#   @path = path
+#		@binary = binary || 'knotc'
+#		@conf = Knot::Conf.new self
+#		@zones = Hash.new {|h, zone| h[zone] = Knot::Zone.new zone, self }
+#	end
+#
+#	def call command:, flags: nil, section: nil, item: nil, id: nil, zone: nil, owner: nil, ttl: nil, type: nil, data: nil, filter: nil
+#		cs =
+#			case command.to_s
+#			when 'conf-begin', 'conf-commit', 'conf-abort', 'status', 'stop', 'reload'
+#				[@binary, command,  ]
+#			else raise ArgumentError, "Unknown Command: #{command}"
+#			end
+#	end
+#end
+
 module Knot::Protocol::Idx
+	class Id
+		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 self == x
+			when Symbol then @name == x
+			when String then @name == x.to_sym
+			when Integer then @code == x
+			else nil
+			end
+		end
+
+		def <=>( x)  @id <=> x.id  end
+		def to_s()  @name.to_s  end
+		def to_sym()  @name  end
+		def to_i()  @code  end
+	end
+
 	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.
+		Id.new( :command, 0x10, :CMD,     'Control command name.'),
+		Id.new( :flags,   0x11, :FLAGS,   'Control command flags.'),
+		Id.new( :error,   0x12, :ERROR,   'Error message.'),
+		Id.new( :section, 0x13, :SECTION, 'Configuration section name.'),
+		Id.new( :item,    0x14, :ITEM,    'Configuration item name.'),
+		Id.new( :id,      0x15, :ID,      'Congiguration item identifier.'),
+		Id.new( :zone,    0x16, :ZONE,    'Zone name.'),
+		Id.new( :owner,   0x17, :OWNER,   'Zone record owner'),
+		Id.new( :ttl,     0x18, :TTL,     'Zone record TTL.'),
+		Id.new( :type,    0x19, :TYPE,    'Zone record type name.'),
+		Id.new( :data,    0x1a, :DATA,    'Configuration item/zone record data.'),
+		Id.new( :filter,  0x1b, :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
+
+	Idx.each do |id|
+		Code[id.to_i] = id
+		Name[id.to_sym] = id
 	end
-	def self.[] k
-		case k
-		when Symbol
-			Name[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
-		when Integer
-			Idx[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
-		else
-			raise ArgumentError, "Unknown Idx-Type: #{k}"
+
+	class <<self
+		def [] k
+			case k
+			when Symbol
+				Name[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
+			when Integer
+				Code[k] or raise Knot::Errors::EINVAL, "Unknown Idx: #{k}"
+			else
+				raise ArgumentError, "Unknown Idx-Type: #{k}"
+			end
+		end
+
+		def each &exe
+			block_given? ? Idx.each( &exe) : Idx.to_enum( :each)
 		end
 	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
@@ -97,54 +152,62 @@ 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::Idx.
+				select {|n| data[n.to_sym] }.
+				map {|n| v = data[n.to_sym].to_s.b; [n.to_i, v.size, v ] }
+		s = (ds.flatten+[3]).pack( ('c na*'*ds.length)+'c').b
+		#Idx::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 
+	end
 
 	class RecordIO
 		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
@@ -153,7 +216,7 @@ class Knot::Protocol
 			when 1, 2
 				type = t
 				ret.push( r = {})
-			else 
+			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}"
 				l = sock.unpack1 'n'
@@ -161,13 +224,16 @@ class Knot::Protocol
 			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
 
 	def call sock: nil, **data
 		snd sock: sock, **data
-		rcv( sock: sock).each do |r| 
+		rcv( sock: sock).each do |r|
 			if r[:error]
 				if e = Knot::Errors.err2exc[r[:error]]
 					raise e, r[:error]
@@ -179,10 +245,10 @@ class Knot::Protocol
 
 	def zone( zone) @zones[zone.to_s.to_sym] end
 
-	def conf_set( **opts)   call **opts.update( command: 'conf-set') end
-	def conf_unset( **opts) call **opts.update( command: 'conf-set') end
+	def conf_set( **opts)   call **opts.update( command: 'conf-set')   end
+	def conf_unset( **opts) call **opts.update( command: 'conf-unset') end
 
-	def zone_set( **opts)   call **opts.update( command: 'zone-set') end
+	def zone_set( **opts)   call **opts.update( command: 'zone-set')   end
 	def zone_unset( **opts) call **opts.update( command: 'zone-unset') end
-	def zone_get( **opts)   call **opts.update( command: 'zone-get') end
+	def zone_get( **opts)   call **opts.update( command: 'zone-get')   end
 end

data/lib/knot/version.rb

@@ -1,3 +1,3 @@
 module Knot
-  VERSION = "0.1.2"
+	VERSION = "0.2.1"
 end

data/lib/knot.rb

@@ -2,3 +2,13 @@ require 'knot/version'
 require 'knot/errors'
 require 'knot/protocol'
 require 'knot/interface'
+
+module Knot
+	class <<self
+		def new *as, **os
+			Protocol.new *as, **os
+		end
+		alias connect new
+		alias open new
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knot-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iounpack
@@ -57,15 +57,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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.