auth_dns_check 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22c37a6683b09a94fca8de172138b353213f34db8ef4cff9ca5dc0c0235e13bc
-  data.tar.gz: b90bc601c6fc5683829e0dd11353410b1a7ad97fef481dee7bc75e67f1aee43e
+  metadata.gz: 694aa2030b2a1849a624a23471174281a7e9ad75489c985124d7cb987c640ec7
+  data.tar.gz: 3df4dd5171e5979c261ed0b227797dd8ffa4b5a8909a4254f1fd9195dc82ef36
 SHA512:
-  metadata.gz: 82db5eb1fe0e5e9b0a4a85ade3327823ea0ab1e6c976081652f7795e08a88c13fdd72cde8094426fa7c805716fda193c49ac0d441ae7e701c0a972218ad4983e
-  data.tar.gz: 9c6d450d60076a196fa3867e027ba96c3ec5383cc74bf2c6e14bcf145e47ca057a7e7abf05484be3625c1f7bc7d25a2ed0198187de7cca0e31991369cd105375
+  metadata.gz: 3a6f8f88f72d3c6afc4f6d5dafe228ed91001f4e8880bb2a5f9520e2c90b33c3dd87b340cbeccfc21dc243405b3cf54d5544df0bf2258a090dbb1381697b9c1f
+  data.tar.gz: c5cbd271edf11b44f33d2a4f32a8f363c7872f8b0052f3aa8d9f37c697d1097659aeea58c2c941483b682aa14487932060dae1eb8fae63d550c557fe283326b2

data/README.md

@@ -1,3 +1,5 @@
+[![Gem](https://img.shields.io/gem/v/auth_dns_check.svg?style=flat)](https://rubygems.org/gems/auth_dns_check "View this project in Rubygems")
+
 # AuthDnsCheck
 
 Provides a client for checking that all authoritative DNS servers know
@@ -26,6 +28,10 @@ Or install it yourself as:
 
     $ gem install auth_dns_check
 
+## Documentation
+
+Full API documentation is available on [rubydoc.info](https://www.rubydoc.info/gems/auth_dns_check).
+
 ## Usage
 
 Example:
@@ -37,14 +43,14 @@ require "auth_dns_check"
 # agree that changed.peculiardomain.com has the address 192.168.1.1
 # and no other addresses.
 #
-client = AuthDnsCheck.client
+client = AuthDnsCheck::Client.new
 client.has_ip?("changed.peculiardomain.com", "192.168.1.1")
 
 # Ignore the NS records for peculiardomain.com and check that
 # 192.168.0.253 and 192.168.0.252 both know about and agree on
 # any and all records for newhost.peculiardomain.com.
 #
-client = AuthDnsCheck.client(
+client = AuthDnsCheck::Client.new(
   overrides: {
     :default => [
       Resolv::DNS.new(nameserver: "192.168.0.253"),
@@ -57,7 +63,17 @@ client.all?("newhost.peculiardomain.com")
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Note that `rake spec` does not work. The tests rely on a pair of name servers configured with fixtures.
+
+To run the tests:
+
+```
+docker-compose down --volumes --remove-orphans && \
+  docker-compose build test && \
+  docker-compose run test
+```
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/auth_dns_check.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "< 3"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9"
 end

data/lib/auth_dns_check.rb

@@ -3,10 +3,19 @@ require "resolv"
 require "auth_dns_check/client"
 require "auth_dns_check/version"
 
+# Parent module for the authoritative DNS check library
+#
+# @see Client
 module AuthDnsCheck
+  # Any AuthDnsCheck error
+  #
+  # Currently the only error is a failure to find authoritative name servers on the network.
   class Error < StandardError; end
 
-  def self.client(overrides: {}, default: Resolv::DNS.new)
+  # Returns a new {Client}
+  #
+  # @deprecated See {Client}
+  def self.client(overrides: {}, default: Resolv::DNS.new("/etc/resolv.conf"))
     Client.new(overrides: overrides, default: default)
   end
 

data/lib/auth_dns_check/client.rb

@@ -1,17 +1,45 @@
 module AuthDnsCheck
 
+  # Client for performing authoritative DNS checks
+  #
+  # @todo IPv6 not supported
   class Client
 
-    def initialize(overrides: {}, default: Resolv::DNS.new)
+    # authoritative name server overrides
+    attr_reader :overrides
+
+    # default resolver for finding authoritative name servers
+    attr_reader :default
+
+    # Initialize a new Client
+    #
+    # @param overrides [Hash<String,Array<Resolv::DNS>>] authoritative name server overrides.
+    #   Maps domain names to lists of name servers that should override those published for the domain.
+    #   The special domain name {Symbol} +:default+ may list the name servers that should override any other domain.
+    # @param default [Resolv::DNS] default resolver for finding authoritative name servers.
+    #   Note that this is not the same as +overrides[:default]+.
+    def initialize(overrides: {}, default: Resolv::DNS.new("/etc/resolv.conf"))
       @overrides = overrides
       @default = default
     end
 
+    # Check authoritative agreement for a name
+    #
+    # @param fqdn [String] the name to check
+    # @return [Boolean] whether all authoritative agree that +fqdn+ has the same non-empty set of records
+    # @raise [Error] if authoritative name servers could not be found
+    # @todo Records of types other than A not yet supported
     def all?(fqdn)
       answers = get_addresses(fqdn)
       answers.all? { |x| x.any? and x == answers.first }
     end
 
+    # Check authoritative agreement for the specific address for a name
+    #
+    # @param fqdn [String] the name to check
+    # @param ip [String] the expected address
+    # @return [Boolean] whether all authoritative name servers agree that the only address of +name+ is +ip+
+    # @raise [Error] if authoritative name servers could not be found
     def has_ip?(fqdn, ip)
       answers = get_addresses(fqdn)
       answers.all? do |x|

data/lib/auth_dns_check/version.rb

@@ -1,3 +1,4 @@
 module AuthDnsCheck
-  VERSION = "0.3.0"
+  # The version of the auth_dns_check gem
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth_dns_check
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sheldon Hearn
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: Checks that all authoritatives answer for a new record.
 email:
 - sheldonh@starjuice.net