docheck 1.1.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659f0d700e8f98839c006ec4a3887f304cd1746764961ab703ad006b61c031f9
-  data.tar.gz: c70248742c4a7554f36ff265d40cf79b78bba8174a0367219c49e435898dd2eb
+  metadata.gz: c34fd2f75f10db6e9de801f8054aedc6b548fa38088b241c20ba7c500cbc99b9
+  data.tar.gz: c385a234aa9d58ea84ec21cfd5bbda42be9adc7c464ba81719e7654479531b4d
 SHA512:
-  metadata.gz: 22abf175257e1dbd787daaec8806db2177851e89168b38df02b365bff5d6e1db502dbad9068c66a556b7eedc5bc92afc799886ef1c8a29259408a413e35cd3bf
-  data.tar.gz: 4113cf23f62e2c5442485fe61093e4c2adae9f19706c72c1058fdf1b751e9b192558a76621288dfbaf2b132fc20725f4424e93de70ba6e4ce3c43298e5049e89
+  metadata.gz: 50861c23841c8595b5294611d5fbba7dd400297c09fa533b96102c0c4b32ed2fb1ec3b7a52e96049e32048092c9e2c1751538f443d914987ac11008d5db54de7
+  data.tar.gz: d91bd42c3182dd4cc35d743f3e448be4fc0d7d83eeee24422589a98564df83ba09e3360edd55514cc4604e3b9d62c107bad4ce056f7abbd1cc100d4809d05ad2

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+## 2.0.0 - Unreleased
+
+### Breaking changes
+
+- Require Ruby 3.2 or later. Tested on Ruby 3.2 to 4.0.
+- Look up domains with RDAP instead of WHOIS. The `whois` dependency is gone.
+- Drop `edu`, `gov`, `int`, and `mil` from the default TLDs. Only institutions can register them.
+- Raise `Docheck::InvalidNameError` for a name that is not a single DNS label.
+- The `docheck` command prints errors to stderr and exits with status 64 on a usage error. It also lists domains whose lookup failed or whose TLD has no RDAP server.
+- `Docheck::Application#print` no longer prints the "Docheck Result" header.
+
+### Added
+
+- `Docheck.check` and `Docheck::Checker`, which return `Docheck::Result` objects with a status of `:available`, `:registered`, `:unknown`, or `:unsupported`.
+- Parallel lookups with an overall deadline.
+- `rake rdap:update` to refresh the bundled IANA RDAP bootstrap file.
+
+### Fixed
+
+- Calling `Docheck::Application#fetch` twice no longer duplicates results.
+- A failed lookup no longer uses up the retry budget of the TLDs after it.

data/README.rdoc

@@ -1,8 +1,14 @@
 = Docheck
-Domain name availability checker. By default, It will return all available and registered domains.
+
+Domain name availability checker. Docheck checks a name against generic TLDs
+and reports which domains are available and which are registered.
+
+Docheck uses RDAP (RFC 9082/9083), the protocol that replaced WHOIS for gTLDs.
+It sends one HTTPS request per TLD to the registry's RDAP server, all in
+parallel. It has no runtime dependencies.
 
 == Requirements
-Ruby >= 1.9.2
+Ruby >= 3.2
 
 == Installation
 
@@ -11,25 +17,42 @@ Ruby >= 1.9.2
 == Usage
 From the command line:
 
-  docheck -n google
+  $ docheck -n google
+
+The command exits with status 0 on success and 64 on a usage error or an
+invalid name.
+
+From Ruby:
+
+  require "docheck"
+
+  results = Docheck.check("github")
+  results.first          # => #<data Docheck::Result domain="github.com", status=:registered>
+  results.select(&:available?).map(&:domain)
 
-From the Ruby file or IRB.
+  # Custom TLDs and deadline (seconds for the whole check)
+  checker = Docheck::Checker.new(tlds: %w[com net io], deadline: 5)
+  checker.check("github")
 
-  require 'docheck'
+Each Docheck::Result has a +status+:
 
-  docheck = Docheck::Application.new('github')
+* +:available+ - the registry has no record of the domain
+* +:registered+ - the registry has a record of the domain
+* +:unknown+ - the lookup failed (timeout, rate limit, or server error)
+* +:unsupported+ - the TLD has no RDAP server in the IANA bootstrap data
 
-  # returns two elements array. first array is available domains, last array is registered domains
-  docheck.fetch
+Docheck::Checker#check raises Docheck::InvalidNameError when the name is not a
+single DNS label (1-63 letters, digits, or hyphens). Pass IDNs in punycode
+(+xn--...+).
 
-  # returns all available domains
-  docheck.available_domains
+The 1.x API (Docheck::Application with +fetch+, +available_domains+,
++registered_domains+, and +print+) still works.
 
-  # returns all registered domains
-  docheck.registered_domains
+== Development
 
-  # print all available and registered domains
-  docheck.print
+  $ bundle install
+  $ bundle exec rake                 # tests and RuboCop
+  $ bundle exec rake rdap:update     # refresh data/rdap_dns.json from IANA
 
 == License
-Copyright (c) 2010 - 2019 Kunto Aji Kristianto, Docheck is released under the MIT license.
+Copyright (c) 2010 - 2026 Kunto Aji Kristianto, Docheck is released under the MIT license.