pwhois 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f86327a3c61add78061dea96a88b52668725b54
+  data.tar.gz: 4965237b1a78a0096c8982f17f5a36daab0dda7a
+SHA512:
+  metadata.gz: 16646eb76c116d0c12afef82e76e53cb4fcc1e0ce73aab181103f9ec91a2a6489805e4f618820830175dcd5099906072e1b124471a4021fe28da3e7a4fcd6abe
+  data.tar.gz: c10c8f084cddaf62e22816546c559dc356cf839cc148250fdf7042a055ea7632b678ebad9f7e72f608da933f92388413bcb9c9f7f9188de0e15444d57eaf5433

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pwhois.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Seth Wright
+
+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,193 @@
+pwhois
+======
+
+`pwhois` is a small command-line utility that takes advantage of the
+[Ruby Whois][whois] module to parse Whois results and display them in a
+coherent style.  From their [Parsers][parsers] page:
+
+> I know what you are thinking and the record is yes: in order to support
+> all existing WHOIS servers and registrars, the Whois library should
+> provide more than 500 different parsers. And this is exactly one of the
+> major development goal.
+
+This utility will not give you the full, parsed output of a whois query
+(yet).  It appears that the [Ruby Whois][whois] module supports only a
+subset of possible returned properties.  See the gem's
+[Properties][properties] page for the list of supported properties.
+
+*(This was a simple project to help me learn a little bit about Ruby.  If
+you're a Ruby guru, please don't look too closely at the code.  Or if you
+do, let me know where I could do things better.  Thanks!)*
+
+# Usage
+    $ ./pwhois -h
+    Usage: pwhois [options]
+    
+    Specific options:
+        -v, --[no-]verbose               Run verbosely
+        -o, --output TYPE                Output style.  One of: csv, tsv, table, list
+        -a, --attributes x,y,z           Attributes to return.
+        -h, --help                       Show this message
+
+# Output Styles
+
+## CSV (Comma-Separated Values)
+    $ ./pwhois -o csv github.com
+    Domain,Created On,Updated On,Registrar Name
+    github.com,2013-06-14 19:07:02 -0400,2013-11-27 07:00:15 -0500,"MarkMonitor, Inc."
+
+
+## TSV (Tab-Separated Values)
+    $ ./pwhois -o tsv github.com
+    Domain  Created On      Updated On      Registrar Name
+    github.com      2013-06-14 19:07:02 -0400       2013-11-27 07:00:15 -0500       MarkMonitor, Inc.
+
+
+## List (Default Style)
+    $ ./pwhois -o list github.com
+    Domain        : github.com
+    Created On    : 2013-06-14 19:07:02 -0400
+    Updated On    : 2013-11-27 07:00:15 -0500
+    Registrar Name: MarkMonitor, Inc.
+
+
+## Table
+    $ ./pwhois -o table github.com
+    Domain      Created On                 Updated On                 Registrar Name     
+    ----------  -------------------------  -------------------------  -----------------  
+    github.com  2013-06-14 19:07:02 -0400  2013-11-27 07:00:15 -0500  MarkMonitor, Inc.  
+
+
+# Multiple Queries
+
+You can give `pwhois` a list of domains and it will return the results in
+a format useful to the style.
+
+## CSV/TSV style
+
+The header line is printed only once:
+
+    $ ./pwhois -o csv $(<domains.txt)
+    Domain,Created On,Updated On,Registrar Name
+    github.com,2013-06-14 19:07:02 -0400,2013-11-27 07:00:15 -0500,"MarkMonitor, Inc."
+    google.com,2002-10-02 03:00:00 -0400,2014-05-19 07:00:17 -0400,"MarkMonitor, Inc."
+    cnn.com,1993-09-22 00:00:00 -0400,2013-11-27 04:31:40 -0500,"CSC CORPORATE DOMAINS, INC."
+    twitter.com,2000-01-21 11:28:17 -0500,2013-11-28 05:57:01 -0500,"CSC CORPORATE DOMAINS, INC."
+    ruby-whois.org,2010-02-03 18:03:27 UTC,2014-03-14 01:20:28 UTC,"eNom, Inc. (R39-LROR)"
+
+
+## List style
+
+Individual records are separated by a blank line:
+
+    $ ./pwhois -o list $(<domains.txt)
+    Domain        : github.com
+    Created On    : 2013-06-14 19:07:02 -0400
+    Updated On    : 2013-11-27 07:00:15 -0500
+    Registrar Name: MarkMonitor, Inc.
+
+    Domain        : google.com
+    Created On    : 2002-10-02 03:00:00 -0400
+    Updated On    : 2014-05-19 07:00:17 -0400
+    Registrar Name: MarkMonitor, Inc.
+
+    Domain        : cnn.com
+    Created On    : 1993-09-22 00:00:00 -0400
+    Updated On    : 2013-11-27 04:31:40 -0500
+    Registrar Name: CSC CORPORATE DOMAINS, INC.
+
+    Domain        : twitter.com
+    Created On    : 2000-01-21 11:28:17 -0500
+    Updated On    : 2013-11-28 05:57:01 -0500
+    Registrar Name: CSC CORPORATE DOMAINS, INC.
+
+    Domain        : ruby-whois.org
+    Created On    : 2010-02-03 18:03:27 UTC
+    Updated On    : 2014-03-14 01:20:28 UTC
+    Registrar Name: eNom, Inc. (R39-LROR)
+ 
+
+## Table Style
+
+Columns are sized appropriately for the content.  (Table output with
+multiple queries will not output results until the last query is finished,
+in order to figure out proper column widths.  If you want to know what's
+going on, use the `-v|--verbose` option.)
+
+    $ ./pwhois -o table $(<domains.txt)
+    Domain          Created On                 Updated On                 Registrar Name               
+    --------------  -------------------------  -------------------------  ---------------------------  
+    github.com      2013-06-14 19:07:02 -0400  2013-11-27 07:00:15 -0500  MarkMonitor, Inc.            
+    google.com      2002-10-02 03:00:00 -0400  2014-05-19 07:00:17 -0400  MarkMonitor, Inc.            
+    cnn.com         1993-09-22 00:00:00 -0400  2013-11-27 04:31:40 -0500  CSC CORPORATE DOMAINS, INC.  
+    twitter.com     2000-01-21 11:28:17 -0500  2013-11-28 05:57:01 -0500  CSC CORPORATE DOMAINS, INC.  
+    ruby-whois.org  2010-02-03 18:03:27 UTC    2014-03-14 01:20:28 UTC    eNom, Inc. (R39-LROR)        
+
+
+# Specifying Attributes to Print
+
+See the [Ruby Whois][whois] documentation for the various
+[properties][properties] that can be printed.  Currently there is no way to
+specify *all* properties, sorry. (Note that `pwhois` and this document
+refer to properties as *attributes*, because reasons.)
+
+## Examples
+
+The default set of attributes printed by the utility are `domain`,
+`created_on`, `updated_on`, and `registrar_name`.  If you want to specify
+another set of attributes you're interested in, you can do so with the
+`-a|--attributes` option:
+
+    $ ./pwhois -a domain,created_on,status github.com
+    Domain    : github.com
+    Created On: 2013-06-14 19:07:02 -0400
+    Status    : registered
+
+Note that attributes under Registrar can be specified by prepending
+"registrar\_" to the attribute name.  For instance, to print the registrar
+name and ID:
+
+    $ ./pwhois -a domain,registrar_name,registrar_id crosse.org
+    Domain        : crosse.org
+    Registrar Name: eNom, Inc. (R39-LROR)
+    Registrar Id  : 48
+
+(I would like to handle `registrant_contacts`, `admin_contacts`,
+`technical_contacts`, and `nameservers` similarly, but I haven't done
+so yet.)
+
+# Verbose Mode
+
+Useful for table-style output with multiple queries, or if you just want to
+see what sort of weird verbose logging I do, you can enable verbose mode:
+
+    $ ./pwhois -v -o table $(<domains.txt)
+    [ collating data, please wait... ]
+    [ Querying whois for github.com... ]
+    [ Querying whois for google.com... ]
+    [ Querying whois for cnn.com... ]
+    [ Querying whois for twitter.com... ]
+    [ Querying whois for ruby-whois.org... ]
+    Domain          Created On                 Updated On                 Registrar Name               
+    --------------  -------------------------  -------------------------  ---------------------------  
+    github.com      2013-06-14 19:07:02 -0400  2013-11-27 07:00:15 -0500  MarkMonitor, Inc.            
+    google.com      2002-10-02 03:00:00 -0400  2014-05-19 07:00:17 -0400  MarkMonitor, Inc.            
+    cnn.com         1993-09-22 00:00:00 -0400  2013-11-27 04:31:40 -0500  CSC CORPORATE DOMAINS, INC.  
+    twitter.com     2000-01-21 11:28:17 -0500  2013-11-28 05:57:01 -0500  CSC CORPORATE DOMAINS, INC.  
+    ruby-whois.org  2010-02-03 18:03:27 UTC    2014-03-14 01:20:28 UTC    eNom, Inc. (R39-LROR)        
+
+Verbose output is printed to `stderr`.
+
+
+# TODO
+
+- Print datetime values in either localtime or UTC, but at least in the same
+  format.
+- Handle `registrant_contacts`, `admin_contacts`, `technical_contacts`, and
+  `nameservers`.  Note that these are potentially arrays of things.
+- Handle timeouts and ECONNRESETs in a happier fashion than dying horribly.
+- Learn Ruby.
+
+[whois]: http://ruby-whois.org
+[properties]: http://ruby-whois.org/manual/parser/properties/
+[parsers]: http://ruby-whois.org/manual/parser/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/pwhois

@@ -0,0 +1,231 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'whois'
+
+class Symbol
+    def titleize()
+        to_s.split('_').map { |words| words.capitalize }.join(' ')
+    end
+end
+
+class WhoisParser
+    # Constants
+    UNKNOWN = "UNKNOWN"
+
+    # Class variables
+    @@OUTPUT_STYLES = [ :csv, :tsv, :table, :list ]
+
+    # Instance variables
+    attr_accessor :verbose, :output_style, :attributes
+
+    def self.output_styles
+        @@OUTPUT_STYLES
+    end # output_styles
+
+
+    def initialize()
+        @whois_client = Whois::Client.new
+        @verbose = false
+        @output_style = :list
+        @attributes = [:domain, :created_on, :updated_on, :registrar_name]
+    end # initialize()
+
+
+    def get_attr(record, attr)
+        if record == nil
+            raise(ArgumentError, ":record must not be nil")
+        end
+
+        obj,a = nil
+
+        if "#{attr}".start_with?("registrar")
+            a = "#{attr}".split('_')[1]
+            get_attr(record.registrar, a)
+        else
+            if record.respond_to?(attr)
+                record.send(attr)
+            else
+                raise(ArgumentError, "Warning:  attribute \"#{ attr }\" does not exist for this domain")
+            end
+        end
+    end # get_attr()
+
+
+    def query(q)
+        query_list([ q ])
+    end # query()
+
+
+    def query_list(querys)
+        print_header()
+
+        # only required for table listings.
+        results = []
+
+        querys.each do |q|
+            result = Hash.new
+            begin
+                print_verbose("Querying whois for #{q}...")
+                record = @whois_client.lookup(q)
+                if !record
+                    $stderr.puts "wtf just happened"
+                end
+
+                attributes.each do |a|
+                    begin
+                        result[a] = get_attr(record, a)
+                    rescue ArgumentError => e
+                        $stderr.puts e.message
+                    end
+                end
+
+                if output_style == :table
+                    results.push(result)
+                else
+                    print_item(result)
+                end
+            rescue Whois::ConnectionError => e
+                $stderr.puts e.message
+            rescue NoMethodError => e
+                $stderr.puts e.message
+                $stderr.puts e.backtrace
+            rescue SystemExit,Interrupt
+                print_verbose("Ctrl-C pressed, exiting")
+                exit
+            rescue StandardError => e
+                $stderr.puts e.message
+                $stderr.puts e.backtrace
+                exit
+            end
+        end # querys.each
+
+        if output_style == :table
+            print_table(results)
+        end
+    end # query_list()
+
+    
+    private
+    def print_verbose(msg)
+        if verbose
+            $stderr.puts("[ #{msg} ]")
+        end
+    end # verbose()
+
+
+    private
+    def quote_if_include(str, char)
+        if "#{str}".include?(char)
+            "\"#{str}\""
+        else
+            "#{str}"
+        end
+    end
+
+
+    private
+    def print_header()
+        case output_style
+        when :csv
+            puts attributes.map{ |a| quote_if_include(a.titleize, ',') }.join(',')
+        when :tsv
+            puts attributes.map{ |a| quote_if_include(a.titleize, "\t") }.join("\t")
+        when :table
+            print_verbose("collating data, please wait...")
+        end
+    end # print_header()
+
+    
+    private
+    def print_item(result)
+        case output_style
+        when :csv
+            puts attributes.map{ |a| quote_if_include(result[a], ',') }.join(',')
+        when :tsv
+            puts attributes.map{ |a| result[a] }.join("\t")
+        when :list
+            print_list_item(result)
+        end
+    end # print_item()
+
+
+    private
+    def print_list_item(result)
+        l = attributes.map{ |a| a.length }.sort.last
+        attributes.each do |a|
+            printf("%-#{l}s:\t%s\n", a.titleize, result[a])
+        end
+        puts
+    end # print_list_item()
+
+
+    private
+    def print_table(records)
+        attr_lengths = Hash.new
+        attributes.each do |a|
+            l = records.map{ |r| r[a].to_s.length }.sort.last
+            attr_lengths[a] = (a.length > l) ? a.length : l
+        end
+
+        # print the header row
+        attributes.each do |a|
+            printf("%-#{attr_lengths[a]}s  ", a.titleize)
+        end
+        printf("\n")
+        attributes.each do |a|
+            print '-' * attr_lengths[a]
+            print '  '
+        end
+        printf("\n")
+
+        records.each do |r|
+            attributes.each do |a|
+                printf("%-#{attr_lengths[a]}s  ", r[a])
+            end
+            printf("\n")
+        end
+    end # print_table()
+
+end # class WhoisParser
+
+
+w = WhoisParser.new
+
+OptionParser.new do |opts|
+    opts.banner = "Usage: #{opts.program_name} [options]"
+
+    opts.separator ""
+    opts.separator "Specific options:"
+
+    opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        w.verbose = v
+    end
+
+    output_list = WhoisParser.output_styles.join(', ')
+    opts.on("-o", "--output TYPE", WhoisParser.output_styles,
+            "Output style.  One of: #{output_list}") do |style|
+        w.output_style = style
+    end
+
+    opts.on("-a", "--attributes x,y,z", Array,
+            "Attributes to return.") do |list|
+        w.attributes = Array.new(list.map{ |i| i.to_sym })
+        if !w.attributes.include?(:domain)
+            w.attributes.push(:domain)
+        end
+        w.attributes.freeze
+    end
+
+    opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+    end
+
+    #opts.on_tail("--version", "Show version") do
+        #puts ::Version.join('.')
+        #exit
+    #end
+end.parse!
+
+w.query_list(ARGV)

data/pwhois.gemspec

@@ -0,0 +1,15 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "pwhois"
+  spec.version       = "1.0.1"
+  spec.authors       = ["Seth Wright"]
+  spec.email         = ["seth@crosse.org"]
+
+  spec.summary       = %q{Parse whois results and display them in a coherent style.}
+  spec.homepage      = "https://github.com/Crosse/pwhois"
+  spec.license       = "ISC"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ["pwhois"]
+  spec.add_runtime_dependency "whois"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: pwhois
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Seth Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: whois
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- seth@crosse.org
+executables:
+- pwhois
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/pwhois
+- pwhois.gemspec
+homepage: https://github.com/Crosse/pwhois
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Parse whois results and display them in a coherent style.
+test_files: []