dnslookup 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4de8b546e5c95a9c250a56c52dc0351ba11f1ffc0c02c490431623e60ba2697
-  data.tar.gz: 20fd3fd059e88602f15671dd47e1b2ae72acc065c8e17a2bd61ab1ee54832f17
+  metadata.gz: ee4e5a965cfceb5404a336c75c7957d24b7d77e4ca370b386450a494c8442e56
+  data.tar.gz: d98e8daf75997c8df3f9ccd6fc90b9643376d17977d18f7240fbc378c129727a
 SHA512:
-  metadata.gz: ec8a8f5aa96cc3f3998cfcee760fb5873a12f3360d2beed31c2e25c729e6d4b4edd241affc50215b7143c91c06bfec8a419c8776c6671243b37fa62d06e05474
-  data.tar.gz: dbbe24b3f43b0285f6c98a3756c3b84cfe51731f011af742533f0749f02b7f64c0d5401ae8120921efe6476e18d9738322b6bf108b9ddec38e04454e3f9d33c4
+  metadata.gz: aad2d24318eba691eaba31f0fa69b315271ad0be20893f159157499c354c54fcc45f498e24825d65ff5200623e54aaed1c2d7e7d73928b1b518e62d1a4413aef
+  data.tar.gz: 3a097d3e994669632e534bb2550da4719a80584a7931c16de3d82d6379530da8167b62e50d5ec17e47f897b9329f48b08db0cea04b545e6c526da78fdf7f2652

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# CHANGELOG
+
+Noteworthy updates for each DNSLookup version are included here. For a complete changelog, see the git history.
+
+## [0.4.0] - 2026-03-31
+
+### Changed
+
+- Fixed `-h` and `-v` so they work without requiring a domain argument
+- Made the default lookup explicit by querying `A` records when no type flag is provided
+- Improved security for safer argv-based call and report failed lookups separately from empty results
+- Corrected `CNAME` queries
+- Separated CLI argument parsing from query execution
+- Refreshed the CLI documentation, tightened gem packaging metadata, and made the test suite deterministic
+- Updated documentation to clarify installation requirements
+- Expanded usage examples for default lookups
+
+## [0.3.1] - 2025-06-13
+
+### Changes
+
+- General cleanup and maintenance
+
+## [0.3.0] - 2025-06-12
+
+### Changes
+
+- Refactor gem source
+- Refactor tests
+- General cleanup and maintenance
+
+## [0.2.0] - 2024-02-08
+
+### New Features
+
+- Added ability to check multiple record types at once.
+- Updated core gem Ruby code and general code improvements.
+- Updated tests.
+
+## [0.1.6] - 2023-02-06
+
+### Changes
+
+- Added Ruby 3.0 to required versions.
+- Spec bumps and general code improvements.
+
+## [0.1.0] - 2016-02-01
+
+### New Features
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 - 2024 Victor S. Keenan
+
+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,127 @@
+# dnslookup — A simple Ruby CLI tool for querying DNS records
+
+![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)
+![Ruby](https://img.shields.io/badge/ruby-%3E%3D3.0-red)
+[![Issues](https://img.shields.io/github/issues/VictorSK/dnslookup)](https://github.com/VictorSK/dnslookup/issues)
+[![Last Commit](https://img.shields.io/github/last-commit/VictorSK/dnslookup)](https://github.com/VictorSK/dnslookup/commits/main)
+[![Gem Version](https://badge.fury.io/rb/dnslookup.svg)](https://badge.fury.io/rb/dnslookup)
+
+**dnslookup** is a Ruby CLI for querying A, MX, CNAME, and TXT records from default or custom DNS servers. It wraps `dig` with a small command-line interface that is useful for quick troubleshooting, scripting, and day-to-day DNS checks.
+
+Please use [GitHub Issues](https://github.com/VictorSK/dnslookup/issues) to report bugs.
+
+## Requirements
+
+- Ruby 3.0 or newer
+- The `dig` executable available on your `PATH`
+
+If `dig` is not already installed, common package names are:
+
+```bash
+brew install bind
+```
+
+```bash
+sudo apt-get install dnsutils
+```
+
+## Installation
+
+To add dnslookup to an existing project, add this line to your project's Gemfile:
+
+```ruby
+gem 'dnslookup'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or to install the CLI locally:
+
+```bash
+gem install dnslookup
+```
+
+## Usage
+
+Lookup DNS records for a domain:
+
+```bash
+dnslookup example.com -a
+```
+
+If you omit a record-type option, `dnslookup` queries `A` records by default:
+
+```bash
+dnslookup example.com
+```
+
+By default, `dnslookup` queries Google's public resolvers: `8.8.8.8` and `8.8.4.4`. Use `-s` to query a specific resolver.
+
+### Options
+
+| Option              | Description                          |
+| ------------------- | ------------------------------------ |
+| `-m`, `--mx`        | Return only MX records               |
+| `-a`, `--aname`     | Return only A records                |
+| `-c`, `--cname`     | Return only CNAME records            |
+| `-t`, `--txt`       | Return only TXT records              |
+| `-A`, `--all`       | Return A, MX, CNAME, and TXT records |
+| `-s`, `--server=IP` | Query a specific name server IP      |
+| `-h`, `--help`      | Show help message                    |
+| `-v`, `--version`   | Show gem version                     |
+
+### Examples
+
+Lookup the default `A` record:
+
+```bash
+dnslookup example.com
+```
+
+Lookup a `CNAME` record explicitly:
+
+```bash
+dnslookup ftp.victorkeenan.com -c
+```
+
+Query a specific name server:
+
+```bash
+dnslookup example.com -a -s1.1.1.1
+```
+
+Query all supported record types at once:
+
+```bash
+dnslookup example.com --all
+```
+
+If `dig` cannot complete the lookup, `dnslookup` reports the query as failed instead of showing an empty result:
+
+```bash
+dnslookup example.com -a -s203.0.113.53
+```
+
+Depending on the failure, the output will include either `(query failed)` or `(query failed: ...)`.
+
+Help with usage and options:
+
+```bash
+dnslookup -h
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/VictorSK/dnslookup). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the terms specified in the [CODE OF CONDUCT](CODE_OF_CONDUCT.md).
+
+## License
+
+dnslookup is copyright © 2016-2026 Victor S. Keenan. It is free software and may be redistributed under the terms specified in the [LICENSE](LICENSE.txt) file.
+
+## Coded With Love
+
+Code crafted by me, [Victor S. Keenan](https://www.victorkeenan.com). Find me on Twitter [@VictorSK](https://twitter.com/victorsk) or [hire me](https://www.inspyre.com) to design, develop, and grow your product or service.

data/bin/dnslookup

@@ -2,4 +2,4 @@
 
 require 'dnslookup'
 
-DNSLookup::Query.new
+DNSLookup::CLI.run(argv: ARGV)

data/lib/dnslookup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DNSLookup
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/dnslookup.rb

@@ -2,26 +2,35 @@
 
 require_relative "dnslookup/version"
 require 'optparse'
+require 'open3'
 
 module DNSLookup
   class Error < StandardError; end
-  class Query
+  class CLI
     DEFAULT_SERVERS = ['8.8.8.8', '8.8.4.4'].freeze
 
-    def initialize
+    def self.run(argv: ARGV, out: $stdout)
+      new(argv: argv, out: out).run
+    end
+
+    def initialize(argv: ARGV, out: $stdout)
+      @argv = argv.dup
+      @out = out
       @type = []
       @single_server = nil
-      @domain = ARGV.shift
+    end
+
+    def run
+      parse_options
+      domain = @argv.shift
 
-      if @domain.nil? || @domain.start_with?('-')
-        puts "Error: You must specify a domain name.\n\n"
-        puts "Usage: dnslookup <domain name> [options]"
+      if domain.nil? || domain.start_with?('-')
+        @out.puts "Error: You must specify a domain name.\n\n"
+        @out.puts "Usage: dnslookup <domain name> [options]"
         exit 1
       end
 
-      parse_options
-      setup_query_servers
-      query_with_options
+      Query.new(domain: domain, types: @type, servers: query_servers, out: @out).run
     end
 
     def parse_options
@@ -39,29 +48,41 @@ module DNSLookup
         end
         opt.on("-A", "--all", "Return all record types") { @type = %w[a mx c txt] }
         opt.on("-h", "--help", "Prints this help") do
-          puts opt
+          @out.puts opt
           exit
         end
         opt.on("-v", "--version", "Prints version") do
-          puts DNSLookup::VERSION
+          @out.puts DNSLookup::VERSION
           exit
         end
-      end.parse!
+      end.parse!(@argv)
     end
 
-    def setup_query_servers
-      @servers = []
+    def query_servers
+      return [@single_server] if @single_server
 
-      if @single_server
-        @servers << @single_server
-      else
-        @servers = DEFAULT_SERVERS
-      end
+      DEFAULT_SERVERS
     end
+  end
 
-    def query_with_options
+  class Query
+    RECORD_TYPES = {
+      'a' => 'A',
+      'mx' => 'MX',
+      'c' => 'CNAME',
+      'txt' => 'TXT'
+    }.freeze
+
+    def initialize(domain:, types: [], servers: CLI::DEFAULT_SERVERS, out: $stdout)
+      @domain = domain
+      @type = types
+      @servers = servers
+      @out = out
+    end
+
+    def run
       if @type.empty?
-        query_command('any')
+        query_command('a')
       else
         query_command(@type)
       end
@@ -70,13 +91,32 @@ module DNSLookup
     def query_command(types)
       @servers.each do |server|
         Array(types).each do |type|
-          record_type = type == 'any' ? '' : type.upcase
-          check = `dig @#{server} #{@domain} #{record_type} +short`
-          puts "Checking server: #{server} for #{record_type.empty? ? 'ALL' : record_type} records"
-          puts check.empty? ? "(no records found)" : check
-          puts
+          record_type = normalize_record_type(type)
+          check, error, status = Open3.capture3('dig', "@#{server}", @domain, record_type, '+short')
+          @out.puts "Checking server: #{server} for #{record_type} records"
+          @out.puts format_lookup_result(check: check, error: error, status: status)
+          @out.puts
         end
       end
+    rescue Errno::ENOENT
+      @out.puts "(query failed: dig command not found)"
+      @out.puts
+    end
+
+    private
+
+    def normalize_record_type(type)
+      RECORD_TYPES.fetch(type.to_s.downcase, type.to_s.upcase)
+    end
+
+    def format_lookup_result(check:, error:, status:)
+      return check if status.success? && !check.empty?
+      return "(no records found)" if status.success?
+
+      error_message = error.to_s.strip
+      return "(query failed)" if error_message.empty?
+
+      "(query failed: #{error_message})"
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: dnslookup
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Victor S. Keenan
 bindir: bin
 cert_chain: []
-date: 2025-06-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby CLI tool to query DNS records from multiple public or custom name
   servers, providing fast and flexible DNS lookups.
@@ -18,6 +18,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - bin/dnslookup
 - lib/dnslookup.rb
 - lib/dnslookup/version.rb
@@ -45,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 4.0.9
 specification_version: 4
 summary: A simple Ruby CLI tool for querying DNS records.
 test_files: []