async-dns 1.3.0 → 1.4.0

data/lib/async/dns/system.rb

@@ -1,25 +1,12 @@
-# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2024, by Samuel Williams.
+
+require_relative "endpoint"
 
 begin
-	require 'win32/resolv'
+	require "win32/resolv"
 rescue LoadError
 	# Ignore this - we aren't running on windows.
 end
@@ -29,7 +16,8 @@ module Async::DNS
 	module System
 		RESOLV_CONF = "/etc/resolv.conf"
 		HOSTS = "/etc/hosts"
-
+		
+		# Get the path to the hosts file.
 		def self.hosts_path
 			if RUBY_PLATFORM =~ /mswin32|mingw|bccwin/
 				Win32::Resolv.get_hosts_path
@@ -37,110 +25,189 @@ module Async::DNS
 				HOSTS
 			end
 		end
-
-		# This code is very experimental
+		
+		# @returns [Boolean] True if the system supports IPv6.
+		def self.ipv6?
+			begin
+				list = Socket.ip_address_list
+			rescue NotImplementedError
+				return true
+			end
+			
+			list.any? {|a| a.ipv6? && !a.ipv6_loopback? && !a.ipv6_linklocal? }
+		end
+		
+		Resource = Struct.new(:address, :ttl)
+		
+		# An interface for querying the system's hosts file.
 		class Hosts
+			# Hosts for the local system.
+			def self.local
+				hosts = self.new
+				
+				path = System.hosts_path
+				
+				if path and File.exist?(path)
+					File.open(path) do |file|
+						hosts.parse_hosts(file)
+					end
+				end
+				
+				return hosts
+			end
+			
+			# Create a new hosts file interface.
 			def initialize
 				@addresses = {}
 				@names = {}
 			end
-
-			attr :addresses
-			attr :names
-
-			# This is used to match names against the list of known hosts:
-			def call(name)
-				@names.include?(name)
-			end
-
-			def lookup(name)
+			
+			# Lookup a name in the hosts file.
+			def lookup(name, origin: nil)
+				name = Resolv::DNS::Name.create(name).with_origin(origin)
+				
 				addresses = @names[name]
-
+				
 				if addresses
 					addresses.last
 				else
 					nil
 				end
 			end
-
+			
 			alias [] lookup
-
+			
+			# Add a new address with the given names.
 			def add(address, names)
 				@addresses[address] ||= []
 				@addresses[address] += names
-
+				
 				names.each do |name|
+					name = Resolv::DNS::Name.create(name).with_origin(nil)
+					
 					@names[name] ||= []
 					@names[name] << address
 				end
 			end
-
+			
+			def each(&block)
+				@names.each(&block)
+			end
+			
+			# Parse a hosts file and add the entries.
 			def parse_hosts(io)
 				io.each do |line|
-					line.sub!(/#.*/, '')
+					line.sub!(/#.*/, "")
 					address, hostname, *aliases = line.split(/\s+/)
-
-					add(address, [hostname] + aliases)
-				end
-			end
-
-			def self.local
-				hosts = self.new
-
-				path = System::hosts_path
-
-				if path and File.exist?(path)
-					File.open(path) do |file|
-						hosts.parse_hosts(file)
+					
+					if address =~ Resolv::IPv4::Regex
+						address = Resolv::IPv4.create(address)
+					elsif address =~ Resolv::IPv6::Regex
+						address = Resolv::IPv6.create(address)
+					else
+						next
 					end
+					
+					add(address, [hostname] + aliases)
 				end
-
-				return hosts
 			end
 		end
-
+		
+		DEFAULT_TIMEOUT = 5.0
+		
+		# Parse the `resolv.conf` file and return a list of nameservers.
 		def self.parse_resolv_configuration(path)
 			nameservers = []
+			search = nil
+			ndots = 1
+			edns = nil
+			timeout = DEFAULT_TIMEOUT
+			
 			File.open(path) do |file|
 				file.each do |line|
 					# Remove any comments:
-					line.sub!(/[#;].*/, '')
-
+					line.sub!(/[#;].*/, "")
+					
 					# Extract resolv.conf command:
-					keyword, *args = line.split(/\s+/)
-
+					keyword, *arguments = line.split(/\s+/)
+					
 					case keyword
-					when 'nameserver'
-						nameservers += args
+					when "nameserver"
+						nameservers.concat(arguments)
+					when "domain", "search"
+						search = arguments
+					when "options"
+						arguments.each do |argument|
+							key, value = argument.split(":", 2)
+							
+							case key
+							when "ndots"
+								ndots = value.to_i
+							when "edns0"
+								edns = 0
+							when "timeout"
+								timeout = value.to_f
+							end
+						end
 					end
 				end
 			end
-
-			return nameservers
-		end
-
-		def self.standard_connections(nameservers)
-			connections = []
-
-			nameservers.each do |host|
-				connections << [:udp, host, 53]
-				connections << [:tcp, host, 53]
-			end
-
-			return connections
+			
+			return {
+				nameservers: nameservers,
+				search: search,
+				ndots: ndots,
+				edns: edns,
+				timeout: timeout,
+			}
 		end
-
+		
 		# Get a list of standard nameserver connections which can be used for querying any standard servers that the system has been configured with. There is no equivalent facility to use the `hosts` file at present.
-		def self.nameservers
+		def self.resolver(**options)
 			nameservers = []
-
+			
 			if File.exist? RESOLV_CONF
-				nameservers = parse_resolv_configuration(RESOLV_CONF)
+				options.update(parse_resolv_configuration(RESOLV_CONF))
+				nameservers = options.delete(:nameservers)
 			elsif defined?(Win32::Resolv) and RUBY_PLATFORM =~ /mswin32|cygwin|mingw|bccwin/
 				search, nameservers = Win32::Resolv.get_resolv_info
+				options.update(search: search)
+			end
+			
+			if search = options[:search]
+				unless search.include?(".")
+					search << nil
+				end
+			else
+				options[:search] = [nil]
+			end
+			
+			if hosts = Hosts.local
+				cache = options.fetch(:cache) do
+					options[:cache] = Cache.new
+				end
+				
+				hosts.each do |name, addresses|
+					addresses.each do |address|
+						resource = Resource.new(address, nil)
+						case address
+						when Resolv::IPv4
+							cache.store(name, Resolv::DNS::Resource::IN::A, resource)
+						when Resolv::IPv6
+							cache.store(name, Resolv::DNS::Resource::IN::AAAA, resource)
+						end
+					end
+				end
+			end
+			
+			timeout = options.delete(:timeout) || DEFAULT_TIMEOUT
+			endpoint = Endpoint.for(nameservers, timeout: timeout)
+			
+			if block_given?
+				yield endpoint, **options
+			else
+				return Resolver.new(endpoint, **options)
 			end
-
-			return standard_connections(nameservers)
 		end
 	end
 end

data/lib/async/dns/transaction.rb

@@ -1,25 +1,10 @@
-# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2015-2024, by Samuel Williams.
+# Copyright, 2023, by Hal Brodigan.
 
 module Async::DNS
-	
 	# This class provides all details of a single DNS question and response. This is used by the DSL to provide DNS related functionality.
 	# 
 	# The main functions to complete the transaction are: {#append!} (evaluate a new query and append the results), {#passthrough!} (pass the query to an upstream server), {#respond!} (compute a specific response) and {#fail!} (fail with an error code).
@@ -27,7 +12,15 @@ module Async::DNS
 		# The default time used for responses (24 hours).
 		DEFAULT_TTL = 86400
 		
-		def initialize(server, query, question, resource_class, response, options = {})
+		# Create a new transaction with the given server, query, question, resource class, response, and options.
+		#
+		# @parameter server [Server] The server to use for processing.
+		# @parameter query [Resolv::DNS::Message] The incoming query.
+		# @parameter question [Resolv::DNS::Name] The question to answer.
+		# @parameter resource_class [Class(Resolv::DNS::Resource)] The resource class to use for responses.
+		# @parameter response [Resolv::DNS::Message] The response to the query.
+		# @parameter options [Hash] Additional options to pass to the transaction.
+		def initialize(server, query, question, resource_class, response, **options)
 			@server = server
 			@query = query
 			@question = question
@@ -37,21 +30,24 @@ module Async::DNS
 			@options = options
 		end
 
-		# The resource_class that was requested. This is typically used to generate a response.
+		# @attribute [Class(Resolv::DNS::Resource)] The resource class to use for responses. This is typically used to generate a response.
 		attr :resource_class
 		
-		# The incoming query which is a set of questions.
+		# @attribute [Resolv::DNS::Message] The incoming query.
 		attr :query
 		
-		# The question that this transaction represents.
+		# @attribute [Resolv::DNS::Name] The question to answer.
 		attr :question
 		
-		# The current full response to the incoming query.
+		# @attribute [Resolv::DNS::Message] The response to the query.
 		attr :response
 		
-		# Any options or configuration associated with the given transaction.
+		# @attribute [Hash] Additional options associated with the transaction.
 		attr :options
 		
+		# Access the options hash.
+		#
+		# @parameter key [Object] The key to lookup.
 		def [] key
 			@options[key]
 		end
@@ -68,7 +64,7 @@ module Async::DNS
 		
 		# Run a new query through the rules with the given name and resource type. The results of this query are appended to the current transaction's `response`.
 		def append!(name, resource_class = nil, options = {})
-			Transaction.new(@server, @query, name, resource_class || @resource_class, @response, options).process
+			Transaction.new(@server, @query, name, resource_class || @resource_class, @response, **options).process
 		end
 		
 		# Use the given resolver to respond to the question. Uses `passthrough` to do the lookup and merges the result.
@@ -78,9 +74,9 @@ module Async::DNS
 		# If recursion is not requested, the result is `fail!(:Refused)`. This check is ignored if an explicit `options[:name]` or `options[:force]` is given.
 		#
 		# If the resolver can't reach upstream servers, `fail!(:ServFail)` is invoked.
-		def passthrough!(resolver, options = {}, &block)
-			if @query.rd || options[:force] || options[:name]
-				response = passthrough(resolver, options)
+		def passthrough!(resolver, force: false, **options, &block)
+			if @query.rd || force || options[:name]
+				response = passthrough(resolver, **options)
 				
 				if response
 					yield response if block_given?
@@ -102,11 +98,8 @@ module Async::DNS
 		# A block must be supplied, and provided a valid response is received from the upstream server, this function yields with the reply and reply_name.
 		#
 		# If `options[:name]` is provided, this overrides the default query name sent to the upstream server. The same logic applies to `options[:resource_class]`.
-		def passthrough(resolver, options = {})
-			query_name = options[:name] || name
-			query_resource_class = options[:resource_class] || resource_class
-			
-			resolver.query(query_name, query_resource_class)
+		def passthrough(resolver, name: self.name, resource_class: self.resource_class)
+			resolver.query(name, resource_class)
 		end
 		
 		# Respond to the given query with a resource record. The arguments to this function depend on the `resource_class` requested. This function instantiates the resource class with the supplied arguments, and then passes it to {#append!}.
@@ -143,7 +136,7 @@ module Async::DNS
 			ttl = options[:ttl] || DEFAULT_TTL
 			name = options[:name] || @question.to_s + "."
 			
-			section = (options[:section] || 'answer').to_sym
+			section = (options[:section] || "answer").to_sym
 			method = "add_#{section}".to_sym
 			
 			resources.each do |resource|
@@ -153,7 +146,7 @@ module Async::DNS
 			end
 		end
 		
-		# This function indicates that there was a failure to resolve the given question. The single argument must be an integer error code, typically given by the constants in {Resolv::DNS::RCode}.
+		# This function indicates that there was a failure to resolve the given question. The single argument must be an integer error code, typically given by the constants in `Resolv::DNS::RCode`.
 		#
 		# The easiest way to use this function it to simply supply a symbol. Here is a list of the most commonly used ones:
 		#

data/lib/async/dns/transport.rb

@@ -1,61 +1,49 @@
-# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'stringio'
-require 'ipaddr'
+# Released under the MIT License.
+# Copyright, 2015-2024, by Samuel Williams.
 
-require_relative 'message'
+require "stringio"
+require "ipaddr"
 
 module Async
 	module DNS
-		def self.address_family(host)
-			return IPAddr.new(host).family
-		end
-		
+		# A simple DNS message stream encoder/decoder.
 		class Transport
+			# Create a new transport.
+			#
+			# @parameter socket [IO] The socket to read/write from.
 			def initialize(socket)
-				@stream = IO::Stream.new(socket)
+				@socket = socket
 			end
 			
+			# Write a message to the socket.
+			#
+			# @parameter message [Resolv::DNS::Message] The message to write.
 			def write_message(message)
 				write_chunk(message.encode)
 			end
 			
+			# Read a chunk from the socket.
+			#
+			# @returns [String] The data read from the socket.
 			def read_chunk
-				if size_data = @stream.read(2)
+				if size_data = @socket.read(2)
 					# Read in the length, the first two bytes:
-					size = size_data.unpack('n')[0]
+					size = size_data.unpack("n")[0]
 					
-					return @stream.read(size)
+					return @socket.read(size)
 				end
 			end
 			
-			def write_chunk(output_data)
-				size_data = [output_data.bytesize].pack('n')
-				
-				@stream.write(size_data)
-				@stream.write(output_data)
-				
-				@stream.flush
-				
-				return output_data.bytesize
+			# Write a chunk to the socket.
+			#
+			# @parameter data [String] The data to write.
+			def write_chunk(data)
+				size_data = [data.bytesize].pack("n")
+				@socket.write(size_data)
+				@socket.write(data)
+				@socket.flush
 			end
 		end
 	end

data/lib/async/dns/version.rb

@@ -1,25 +1,11 @@
-# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2012-2013, by Tony Arcieri.
+# Copyright, 2015-2024, by Samuel Williams.
 
 module Async
 	module DNS
-		VERSION = '1.3.0'
+		VERSION = "1.4.0"
 	end
 end

data/lib/async/dns.rb

@@ -1,35 +1,19 @@
-# Copyright, 2009, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
 
-require 'async'
-require 'async/io/tcp_socket'
-require 'async/io/udp_socket'
+# Released under the MIT License.
+# Copyright, 2012, by Tony Arcieri.
+# Copyright, 2015-2024, by Samuel Williams.
 
-require_relative 'dns/version'
+require "async"
+require_relative "dns/version"
 
-require_relative 'dns/message'
-require_relative 'dns/server'
-require_relative 'dns/resolver'
-require_relative 'dns/handler'
+require_relative "dns/server"
+require_relative "dns/resolver"
+require_relative "dns/handler"
 
+# @namespace
 module Async
+	# @namespace
 	module DNS
 	end
 end

data/license.md

@@ -0,0 +1,29 @@
+# MIT License
+
+Copyright, 2012-2017, by Tony Arcieri.  
+Copyright, 2013, by Greg Thornton.  
+Copyright, 2014, by Hendrik Beskow.  
+Copyright, 2015-2025, by Samuel Williams.  
+Copyright, 2017-2020, by Olle Jonsson.  
+Copyright, 2019, by Stefan Wrobel.  
+Copyright, 2021, by Mike Perham.  
+Copyright, 2023, by Hal Brodigan.  
+Copyright, 2024, by Sean Dilda.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,53 @@
+# Async::DNS
+
+Async::DNS is a high-performance DNS client resolver and server which can be easily integrated into other projects or used as a stand-alone daemon. It was forked from [RubyDNS](https://github.com/ioquatix/rubydns) which is now implemented in terms of this library.
+
+[![Development Status](https://github.com/socketry/async-dns/workflows/Test/badge.svg)](https://github.com/socketry/async-dns/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/async-dns/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-dns/guides/getting-started/index) - This guide explains how to get started with the `async-dns` gem.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-dns/releases/index) for all releases.
+
+### v1.4.0
+
+  - Minimum Ruby version is now v3.1.
+  - Drop dependency on `Async::IO` and refactor internal network code to use `IO::Endpoint` and `Socket` directly.
+  - Introduce `Async::DNS::Endpoint` for getting the default endpoint for a given name server.
+  - Remove old hacks for IPv6 on Ruby v2.3.
+  - Introduce `Async::DNS::Cache` for caching DNS lookups.
+  - Remove `logger` as an option and instance variable in favour of using `Console.logger` directly. This is a breaking change.
+  - Update error logging to include more details.
+  - Use keyword arguments `**options` where possible. This is a breaking change.
+  - `Async::DNS::StreamHandler` and `Async::DNS::DatagramHandler` have been refactored to use `IO::Endpoint` and have minor breaking interface changes.
+  - `Async::DNS::Resolver.default` should be used to get a default resolver instance.
+  - The resolver now supports `ndots:` when resolving names.
+  - `Async::DNS::Resolver#fully_qualified_name` is replaced by `Async::DNS::Resolver#fully_qualified_names` and can yield multiple names.
+  - If the host system supports IPv6, the resolver will also try to resolve IPv6 addresses.
+  - `Async::DNS::Server::DEFAULT_ENDPOINTS` is removed and replaced by `Async::DNS::Server.default_endpoint(port = 53)`.
+  - `Async::DNS::Server#fire` is removed with no replacement.
+  - The default `Async::DNS::Server#process` fails with `NXDomain` instead of `NotImplementedError`.
+  - `Async::DNS::System` implementation is updated to support IPv6 and `resolv.conf` options.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.