knot-ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04ae67be521fbc10dc42972c8b3c7bfc9c0edc2822617a0ef565564e7e93bd6f
-  data.tar.gz: 89396bbc12e9aa181dcbf4af502262d4e8a4fb3ea982c28034c54d374078bd99
+  metadata.gz: 102f6dc54dc3b034d4b71e890c921cdd3067ef32999cf92e829b56e6cf661266
+  data.tar.gz: 847a1e73410dd0dbe17793c7c2819e22879dfbe47f728ec0625e02b88dcb7c2a
 SHA512:
-  metadata.gz: 8cf55c28b347d9f5103451ad60d0da577c1febf8909b10bd30449985057c7d8640777953de99ff5509736ead73b8a8f5a9329150948f1a2dea9c30e55728c738
-  data.tar.gz: 826ffdff42cbf5a3dd7fc0a54707796c283d13eb0e99478c293ac620cf4b179c24393f0c2db2638717904d7aec0ef097dda2c1cb3d566ad81ebfe43273e8b53c
+  metadata.gz: e87bfff66910c223c3046dbc0ea63929d7c60d62434e06f1dccac5f2bca3ffc8b9e0652b32c1f4137ff6912cca50f26855dd989a64ec8f2a1c2f741f34307637
+  data.tar.gz: bcd68e1fa196ec799970697180b2dd375c6816da752c721dab9b0bf4bb82405d5909f090f5f10185713ee4c28166af0a64f103ff926ede60a519fc41a13a2e6a

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

@@ -11,22 +11,35 @@ class Knot::Zone
 		@zone, @transaction_opened = zone, 0
 	end
 
+	# If no transaction opened, yet, it opens a new transaction.
+	# Counts calling begin.
+	# Knot allowes only one global transaction, so if two clients tries to open a transaction,
+	# the second will fail.  But the second client can change items in the same
+	# transaction like the first client.
+	# The first client, which calls commit or abort, wins and the transaction will be closed.
+	# So, the transaction-handling is only safe, if one client connects to knot.
 	def begin
 		@transaction_opened += 1
 		@protocol.call command: 'zone-begin', zone: @zone  if 1 == @transaction_opened
 	end
 
+	# Decreases opened transactions.
+	# If opened transactions is zero, it stores items and closes transaction successfully.
 	def commit
 		@protocol.call command: 'zone-commit', zone: @zone  if 1 == @transaction_opened
 		@transaction_opened -= 1  if 0 < @transaction_opened
 	end
 
+	# Closes transaction without saving immidiatly.
+	# Counter of opened transaction will be reset to 0.
 	def abort
 		@protocol.call command: 'zone-abort', zone: @zone
 		@transaction_opened = 0
 	end
 
-	def transaction
+	# Opens transaction, calls yielded Proc and closes transaction after return.
+	# If exception was raised, the transaction will be aborted.
+	def transaction # :yield:
 		self.begin
 		yield self
 	rescue Object
@@ -56,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
@@ -72,6 +85,7 @@ class Knot::Zone
 	rescue Knot::Errors::ENONODE, Knot::Errors::ENOENT
 	end
 	alias delete unset
+	alias del unset
 
 	def get owner = nil, type = nil
 		@protocol.call command: 'zone-get',
@@ -115,10 +129,12 @@ class Knot::Conf
 
 	def parse_item k
 		case k
-		when k
+		when Hash
 			case k.keys.sort
-			when %w[section], %w[id section], %w[item section], %w[id item section] then k
-			else raise ArgumentError, "Invalid Item-format"
+			when %w[section], %w[id section], %w[item section], %w[id item section]
+				k
+			else
+				raise ArgumentError, "Invalid Item-format"
 			end
 
 		when Array
@@ -134,26 +150,39 @@ class Knot::Conf
 					(?: \[ (?<id> [a-z0-9_.-]+) \] )?
 					(?: \. (?<item>[a-z0-9_-]+) )?
 				\z/xi
+
 			$~.named_captures.delete_if {|_,v| v.nil? }
-		else raise ArgumentError, "Invalid Item-format"
+
+		when nil
+			{}
+
+		else
+			raise ArgumentError, "Invalid Item-format"
 		end
 	end
 
+	def get item = nil
+		@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
-	alias [] set
 
+	# 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,6 +52,26 @@ module Knot::Protocol::Type
 	end
 end
 
+#class Knot::KnotC
+#	attr_accessor :debug, :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
 	Idx = [
 		:command, # 10, :CMD,     # Control command name.
@@ -117,7 +138,7 @@ class Knot::Protocol
 		STDERR.puts( {data: data, _: s}.inspect)  if @debug
 		rsock.write s
 		rsock.flush
-	end 
+	end
 
 	class RecordIO
 		attr_reader :str
@@ -153,7 +174,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'
@@ -167,7 +188,7 @@ class Knot::Protocol
 
 	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 +200,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_unset( **opts) call opts.update( command: 'zone-unset') end
-	def zone_get( **opts)   call opts.update( command: 'zone-get') 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
 end

data/lib/knot/version.rb

@@ -1,3 +1,3 @@
 module Knot
-  VERSION = "0.1.0"
+	VERSION = "0.2.0"
 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.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Denis Knauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-20 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: iounpack
@@ -57,7 +57,7 @@ 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:
   - - ">="