nicinfo 0.2.0

data/lib/notices.rb

@@ -0,0 +1,110 @@
+# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+# IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'config'
+require 'nicinfo_logger'
+require 'utils'
+
+module NicInfo
+
+  # deals with RDAP notices structures
+  class Notices
+
+    def Notices.is_excessive_notice notices, config
+      return false if !notices
+      return false if notices.length == 0
+      return true if notices.length > 2
+      word_count = 0
+      line_count = 0
+      notices.each do |notice|
+        descriptions = NicInfo::get_descriptions notice, config
+        descriptions.each do |line|
+          line_count = line_count + 1
+          word_count = word_count + line.length
+        end if descriptions and descriptions.instance_of? Array
+      end
+      return true if line_count > 10
+      return true if word_count > 700
+      #otherwise
+      return false
+    end
+
+    def display_notices json_response, config, ignore_excessive
+
+      notices = json_response[ "notices" ]
+      return if notices == nil
+      if (Notices::is_excessive_notice(notices,config) ) && (config.logger.data_amount != NicInfo::DataAmount::EXTRA_DATA) && !ignore_excessive
+        config.logger.start_data_item
+        config.logger.raw NicInfo::DataAmount::NORMAL_DATA, "Excessive Notices"
+        config.logger.raw NicInfo::DataAmount::NORMAL_DATA, "-----------------"
+        config.logger.raw NicInfo::DataAmount::NORMAL_DATA, "Response contains excessive notices."
+        config.logger.raw NicInfo::DataAmount::NORMAL_DATA, "Use the \"-V\" or \"--data extra\" options to see them."
+        config.logger.end_data_item
+      else
+        notices.each do |notice|
+          display_single_notice notice, config
+        end
+      end
+
+    end
+
+    def display_single_notice notice, config
+      config.logger.start_data_item
+      title = notice[ "title" ]
+      if title == nil
+        title = ""
+      end
+      config.conf_msgs << "'title' in 'notice' is not a string." unless title.instance_of?( String )
+      config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "[ NOTICE ]", title
+      type = notice[ "type" ]
+      if type != nil
+        config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "Type", NicInfo.capitalize( type )
+      end
+      description = notice[ "description" ]
+      i = 1
+      if description.instance_of?( Array )
+        description.each do |line|
+          if line.instance_of?( String )
+            config.logger.prose NicInfo::DataAmount::NORMAL_DATA, i.to_s, line
+            i = i + 1
+          else
+            config.conf_msgs << "eleemnt of 'description' in 'notice' is not a string."
+          end
+        end
+      else
+        config.conf_msgs << "'description' in 'notice' is not an array."
+      end
+      links = notice[ "links" ]
+      if links
+        if links.instance_of?( Array )
+          alternate = NicInfo.get_alternate_link links
+          config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "More", alternate if alternate
+          about = NicInfo.get_about_link links
+          config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "About", about if about
+          tos = NicInfo.get_tos_link links
+          config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "TOS", tos if tos
+          copyright = NicInfo.get_copyright_link links
+          config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "(C)", copyright if copyright
+          license = NicInfo.get_license_link links
+          config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "License", license if license
+        else
+          config.conf_msgs << "'links' is not an array."
+        end
+      end
+      config.logger.end_data_item
+    end
+
+  end
+
+end

data/lib/ns.rb

@@ -0,0 +1,108 @@
+# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+# IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+require 'config'
+require 'nicinfo_logger'
+require 'utils'
+require 'common_json'
+require 'entity'
+require 'data_tree'
+
+module NicInfo
+
+  def NicInfo.display_ns json_data, config, data_node
+    ns = Ns.new( config ).process( json_data )
+    NicInfo::display_object_with_entities( ns, config, data_node )
+  end
+
+  def NicInfo.display_nameservers json_data, config, data_node
+    ns_array = json_data[ "nameserverSearchResults" ]
+    if ns_array != nil
+      if ns_array.instance_of? Array
+        display_array = Array.new
+        ns_array.each do |ea|
+          ns = Ns.new( config ).process( ea )
+          display_array << ns
+        end
+        NicInfo::display_object_with_entities( display_array, config, data_node )
+      else
+        config.conf_msgs << "'nameserverSearchResults' is not an array"
+      end
+    else
+      config.conf_msgs << "'nameserverSearchResults' is not present"
+    end
+  end
+
+  # deals with RDAP nameserver structures
+  class Ns
+
+    attr_accessor :entities, :objectclass, :asEventActors
+
+    def initialize config
+      @config = config
+      @common = CommonJson.new config
+      @entities = Array.new
+      @asEventActors = Array.new
+    end
+
+    def process json_data
+      @objectclass = json_data
+      @entities = @common.process_entities @objectclass
+      return self
+    end
+
+    def display
+      @config.logger.start_data_item
+      @config.logger.data_title "[ NAME SERVER ]"
+      @config.logger.terse "Handle", NicInfo::get_handle( @objectclass )
+      @config.logger.extra "Object Class Name", NicInfo::get_object_class_name( @objectclass )
+      @config.logger.terse "Host Name", NicInfo::get_ldhName( @objectclass )
+      @config.logger.terse "IDN Host Name", NicInfo::get_unicodeName( @objectclass )
+      ipAddrs = @objectclass[ "ipAddresses" ]
+      if ipAddrs
+        v6Addrs = ipAddrs[ "v6" ]
+        v6Addrs.each do |v6|
+          @config.logger.terse "IPv6 Address", v6
+        end if v6Addrs
+        v4Addrs = ipAddrs[ "v4" ]
+        v4Addrs.each do |v4|
+          @config.logger.terse "IPv4 Address", v4
+        end if v4Addrs
+      end
+      @common.display_status @objectclass
+      @common.display_events @objectclass
+      @common.display_as_events_actors @asEventActors
+      @common.display_port43 @objectclass
+      @common.display_remarks @objectclass
+      @common.display_links( get_cn, @objectclass )
+      @config.logger.end_data_item
+    end
+
+    def get_cn
+      handle = NicInfo::get_handle @objectclass
+      handle = NicInfo::get_ldhName @objectclass if !handle
+      handle = "(unidentifiable nameserver #{object_id})" if !handle
+      if (name = NicInfo::get_ldhName( @objectclass ) ) != nil
+        return "#{name} ( #{handle} )"
+      end
+      return handle
+    end
+
+    def to_node
+      DataNode.new( get_cn, nil, NicInfo::get_self_link( NicInfo::get_links( @objectclass, @config ) ) )
+    end
+
+  end
+
+end

data/lib/utils.rb

@@ -0,0 +1,189 @@
+# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
+# IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+
+require 'stringio'
+require 'uri'
+require 'config'
+
+module NicInfo
+
+  def NicInfo.make_safe( url )
+    safe = URI.escape( url )
+    safe = URI.escape( safe, "!*'();:@&=+$,/?#[]" )
+    return safe
+  end
+
+  def NicInfo.get_secure_dns json_data
+    return json_data[ "secureDNS" ]
+  end
+
+  def NicInfo.get_ds_data_objs json_data
+    secure_dns = NicInfo::get_secure_dns json_data
+    if secure_dns.instance_of? Array
+      secure_dns = secure_dns[ 0 ]
+    end
+    return secure_dns[ "dsData" ] if secure_dns
+    return nil
+  end
+
+  def NicInfo.get_key_data_objs json_data
+    secure_dns = NicInfo::get_secure_dns json_data
+    if secure_dns.instance_of? Array
+      secure_dns = secure_dns[ 0 ]
+    end
+    return secure_dns[ "keyData" ] if secure_dns
+    return nil
+  end
+
+  def NicInfo.get_algorithm json_data
+    return json_data[ "algorithm" ]
+  end
+
+  def NicInfo.get_handle json_data
+    return json_data[ "handle" ]
+  end
+
+  def NicInfo.get_object_class_name json_data
+    return json_data[ "objectClassName" ]
+  end
+
+  def NicInfo.get_ldhName json_data
+    return json_data[ "ldhName" ]
+  end
+
+  def NicInfo.get_unicodeName json_data
+    return json_data[ "unicodeName" ]
+  end
+
+  def NicInfo.get_descriptions json_data, config
+    return if !json_data
+    if json_data.instance_of?( Hash )
+      retval = json_data[ "description" ]
+      unless retval.instance_of?( Array )
+        config.conf_msgs << "'description' is not an array."
+        retval = nil
+      end
+    else
+      config.conf_msgs << "expected object for 'remarks' or 'notices'."
+      retval = nil
+    end
+    return retval
+  end
+
+  def NicInfo.get_entitites json_data
+    return json_data[ "entities" ]
+  end
+
+  def NicInfo.get_networks json_data
+    return json_data[ "networks" ]
+  end
+
+  def NicInfo.get_network json_data
+    return json_data[ "network" ]
+  end
+
+  def NicInfo.get_autnums json_data
+    return json_data[ "autnums" ]
+  end
+
+  def NicInfo.get_nameservers json_data
+    return json_data[ "nameServers" ]
+  end
+
+  def NicInfo.get_startAddress json_data
+    return json_data[ "startAddress" ]
+  end
+
+  def NicInfo.get_endAddress json_data
+    return json_data[ "endAddress" ]
+  end
+
+  def NicInfo.get_startAutnum json_data
+    return json_data[ "startAutnum" ]
+  end
+
+  def NicInfo.get_endAutnum json_data
+    return json_data[ "endAutnum" ]
+  end
+
+  def NicInfo.get_name json_data
+    return json_data[ "name" ]
+  end
+
+  def NicInfo.get_type json_data
+    return json_data[ "type" ]
+  end
+
+  def NicInfo.get_country json_data
+    return json_data[ "country" ]
+  end
+
+  def NicInfo.get_links json_data, config
+    retval = json_data[ "links" ]
+    return nil unless retval
+    if !retval.instance_of?( Array )
+      config.conf_msgs << "'links' is not an array."
+      retval = nil
+    end
+    return retval
+  end
+
+  def NicInfo.get_related_link links
+    get_link "related", links
+  end
+
+  def NicInfo.get_alternate_link links
+    get_link "alternate", links
+  end
+
+  def NicInfo.get_tos_link links
+    get_link "terms-of-service", links
+  end
+
+  def NicInfo.get_license_link links
+    get_link "license", links
+  end
+
+  def NicInfo.get_copyright_link links
+    get_link "copyright", links
+  end
+
+  def NicInfo.get_about_link links
+    get_link "about", links
+  end
+
+  def NicInfo.get_self_link links
+    get_link "self", links
+  end
+
+  def NicInfo.get_link rel, links
+    return nil if !links
+    links.each do |link|
+      if link[ "rel" ] == rel
+        return link[ "href" ]
+      end
+    end
+    return nil
+  end
+
+  def NicInfo.capitalize str
+    words = str.split( /\s/ )
+    words.each do |word|
+      word.capitalize!
+    end
+    return words.join( " " )
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: nicinfo
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Andrew Newton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies: []
+description: A command-line RDAP client.
+email: andy@arin.net
+executables:
+- nicinfo
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/nicinfo
+- lib/autnum.rb
+- lib/bootstrap.rb
+- lib/bsfiles/asn.json
+- lib/bsfiles/dns.json
+- lib/bsfiles/entity.json
+- lib/bsfiles/ipv4.json
+- lib/bsfiles/ipv6.json
+- lib/cache.rb
+- lib/common_json.rb
+- lib/common_names.rb
+- lib/config.rb
+- lib/constants.rb
+- lib/data_tree.rb
+- lib/demo/autnum.json
+- lib/demo/domain-dnr.json
+- lib/demo/domain-rir.json
+- lib/demo/domains.json
+- lib/demo/entities.json
+- lib/demo/entity-dnr.json
+- lib/demo/entity-rir.json
+- lib/demo/error-code.json
+- lib/demo/help.json
+- lib/demo/ip.json
+- lib/demo/nameservers.json
+- lib/demo/ns-simple.json
+- lib/demo/ns-very-simple.json
+- lib/demo/ns.json
+- lib/demo/simple-ip.json
+- lib/demo/simple.json
+- lib/domain.rb
+- lib/ds_data.rb
+- lib/entity.rb
+- lib/enum.rb
+- lib/error_code.rb
+- lib/female-first-names.txt
+- lib/ip.rb
+- lib/key_data.rb
+- lib/last-names.txt
+- lib/male-first-names.txt
+- lib/nicinfo_logger.rb
+- lib/nicinfo_main.rb
+- lib/notices.rb
+- lib/ns.rb
+- lib/utils.rb
+homepage: https://github.com/arinlabs/nicinfo
+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.4.5
+signing_key: 
+specification_version: 4
+summary: RDAP Client
+test_files: []
+has_rdoc: