nicinfo 1.3.0.pre.alpha1 → 1.3.0.pre.alpha2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f574db872855ffbfa72d6a22daaf59fdc1aec3b5
-  data.tar.gz: 414c3b45e8a4fe46e6afc31fc3d02c591a27c485
+  metadata.gz: 1541e4e748c2ac0eeddfefd4288d65ea85af1826
+  data.tar.gz: 49e3d7584b192966fe458b2cd57911d4e48d244e
 SHA512:
-  metadata.gz: 2eedd1a0b3a0226000664e4c9268874ac1886d7d940668f79826348cfbc285609be465c280a727f332297514ef5138eac095c91ed376881d406713962f8fa438
-  data.tar.gz: 93bd001ca3321104020bb7a0d1c48324c571cc97e81fc130d114958865eac35e378461b69c9e5e582070100686f9c99c89c74b02a64fada2c48a532bd22f100f
+  metadata.gz: 8a0849a883b4cd8339ee447054c1dbcd5638403b7e75038c507c8dcb6a48a4accacb862c005fa45da22c93590072502478b9011461b0a586cc7ecd0277a8ef55
+  data.tar.gz: cacddfe85ad2b640fd8b7622ca098dd7f3c4abca3e5245fdedf0c377935b3364395cb0b74ff272d2845f3b49f0b83f1495cb122f2ae71c668a85afbc0a42269b

data/lib/nicinfo/autnum.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -22,7 +22,7 @@ require 'nicinfo/data_tree'
 module NicInfo
 
   def NicInfo.display_autnum json_data, config, data_tree
-    autnum = Autnum.new( config ).process( json_data )
+    autnum = config.factory.new_autnum.process( json_data )
     NicInfo::display_object_with_entities( autnum, config, data_tree )
   end
 

data/lib/nicinfo/common_json.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -67,7 +67,7 @@ module NicInfo
       entities = Array.new
       json_entities = NicInfo::get_entitites( objectclass )
       json_entities.each do |json_entity|
-        entity = Entity.new( @config )
+        entity = @config.factory.new_entity
         entity.process( json_entity )
         entities << entity
       end if json_entities
@@ -76,14 +76,15 @@ module NicInfo
 
     def display_remarks objectclass
       remarks = objectclass[ "remarks" ]
-      if (Notices::is_excessive_notice(remarks, @config)) && (@config.logger.data_amount != NicInfo::DataAmount::EXTRA_DATA)
-        @config.logger.datum "Excessive Remarks", "Use \"-V\" or \"--data extra\" to see them."
-      else
-        if remarks
-          if remarks.instance_of?( Array )
+      if remarks
+        excessive_notice = @config.factory.new_notices.is_excessive_notice(remarks)
+        if (excessive_notice && (@config.logger.data_amount != NicInfo::DataAmount::EXTRA_DATA))
+          @config.logger.datum "Excessive Remarks", "Use \"-V\" or \"--data extra\" to see them."
+        else
+          if remarks.instance_of?(Array)
             remarks.each do |remark|
-              if remark.instance_of?( Hash )
-                title = remark[ "title" ]
+              if remark.instance_of?(Hash)
+                title = remark["title"]
                 @config.logger.datum "Remarks", "-- #{title} --" if title
                 descriptions = NicInfo::get_descriptions remark, @config
                 i = 1
@@ -97,11 +98,11 @@ module NicInfo
                 end if descriptions
                 links = NicInfo::get_links remark, @config
                 if links
-                  @config.logger.datum "More", NicInfo::get_alternate_link( links )
-                  @config.logger.datum "About", NicInfo::get_about_link( links )
-                  @config.logger.datum "TOS", NicInfo::get_tos_link( links )
-                  @config.logger.datum "(C)", NicInfo::get_copyright_link( links )
-                  @config.logger.datum "License", NicInfo::get_license_link( links )
+                  @config.logger.datum "More", NicInfo::get_alternate_link(links)
+                  @config.logger.datum "About", NicInfo::get_about_link(links)
+                  @config.logger.datum "TOS", NicInfo::get_tos_link(links)
+                  @config.logger.datum "(C)", NicInfo::get_copyright_link(links)
+                  @config.logger.datum "License", NicInfo::get_license_link(links)
                 end
               else
                 @config.conf_msgs << "remark is not an object."

data/lib/nicinfo/config.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014,2015 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -15,9 +15,10 @@
 
 require 'fileutils'
 require 'time'
-require 'nicinfo/nicinfo_logger'
 require 'yaml'
 require 'ostruct'
+require 'nicinfo/nicinfo_logger'
+require 'nicinfo/factory'
 require 'nicinfo/constants'
 
 module NicInfo
@@ -25,7 +26,7 @@ module NicInfo
   # Handles configuration of the application
   class Config
 
-    attr_accessor :logger, :config, :rdap_cache_dir, :options, :conf_msgs, :rdap_bootstrap_dir
+    attr_accessor :logger, :config, :rdap_cache_dir, :options, :conf_msgs, :rdap_bootstrap_dir, :factory
 
     # Intializes the configuration with a place to look for the config file
     # If the file doesn't exist, a default is used.
@@ -36,6 +37,7 @@ module NicInfo
       @app_data = app_data
       @logger = NicInfo::Logger.new
       @conf_msgs = Array.new
+      @factory = NicInfo::Factory.new( self )
 
       config_file_name = Config.formulate_config_file_name( @app_data )
       if File.exist?( config_file_name )

data/lib/nicinfo/constants.rb

@@ -18,7 +18,7 @@
 
 module NicInfo
 
-  VERSION = "1.3.0-alpha1"
+  VERSION = "1.3.0-alpha2"
   VERSION_LABEL = "NicInfo v." + VERSION
   COPYRIGHT = "Copyright (c) 2011-2017 American Registry for Internet Numbers (ARIN)"
   CONFIG_VERSION = 4

data/lib/nicinfo/domain.rb

@@ -32,7 +32,7 @@ module NicInfo
     end
     respObjs = ResponseObjSet.new config
     obj_array.each do |array_object|
-      domain = Domain.new( config ).process( array_object )
+      domain = config.factory.new_domain.process( array_object )
       root = domain.to_node
       data_node.add_root( root )
       if !domain.entities.empty? or !domain.nameservers.empty?
@@ -112,13 +112,13 @@ module NicInfo
       @entities = @common.process_entities @objectclass
       json_nses = NicInfo::get_nameservers json_data
       json_nses.each do |json_ns|
-        ns = Ns.new( @config )
+        ns = @config.factory.new_ns
         ns.process( json_ns )
         @nameservers << ns
       end if json_nses
       json_net = NicInfo::get_network json_data
       if json_net
-        ip = Ip.new @config
+        ip = @config.factory.new_ip
         ip.process json_net
         @network = ip
       end

data/lib/nicinfo/entity.rb

@@ -21,7 +21,7 @@ require 'nicinfo/data_tree'
 module NicInfo
 
   def NicInfo.display_entity json_data, config, data_tree
-    entity = Entity.new( config ).process( json_data )
+    entity = config.factory.new_entity.process( json_data )
 
     respobjs = ResponseObjSet.new config
     root = entity.to_node
@@ -64,7 +64,7 @@ module NicInfo
       if entity_array.instance_of? Array
         display_array = Array.new
         entity_array.each do |ea|
-          entity = Entity.new( config ).process( ea )
+          entity = config.factory.new_entity.process( ea )
           display_array << entity
         end
         NicInfo.display_object_with_entities( display_array, config, data_tree )
@@ -258,7 +258,7 @@ module NicInfo
       json_networks = NicInfo::get_networks( @objectclass )
       json_networks.each do |json_network|
         if json_network.is_a?( Hash )
-          network = Ip.new( @config )
+          network = @config.factory.new_ip
           network.process( json_network )
           @networks << network
         else
@@ -269,7 +269,7 @@ module NicInfo
       json_autnums = NicInfo::get_autnums( @objectclass )
       json_autnums.each do |json_autnum|
         if json_autnum.is_a?( Hash )
-          autnum = Autnum.new( @config )
+          autnum = @config.factory.new_autnum
           autnum.process( json_autnum )
           @autnums << autnum
         else

data/lib/nicinfo/error_code.rb

@@ -21,34 +21,40 @@ module NicInfo
   # deals with RDAP error code structures
   class ErrorCode
 
-    def display_error_code ec, config
-      config.logger.start_data_item
+    attr_accessor :config
+
+    def initialize( config )
+      @config = config
+    end
+
+    def display_error_code ec
+      @config.logger.start_data_item
       title = ec[ "title" ]
       if title == nil
         title = ""
       end
-      config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "[ ERROR ]", title
-      config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "Code", ec[ "errorCode" ]
+      @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "[ ERROR ]", title
+      @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "Code", ec[ "errorCode" ]
       description = ec[ "description" ]
       i = 1
       description.each do |line|
-        config.logger.prose NicInfo::DataAmount::NORMAL_DATA, i.to_s, line
+        @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, i.to_s, line
         i = i + 1
       end
       links = ec[ "links" ]
       if links
         alternate = NicInfo.get_alternate_link links
-        config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "More", alternate if alternate
+        @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
+        @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
+        @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
+        @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
+        @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "License", license if license
       end
-      config.logger.end_data_item
+      @config.logger.end_data_item
     end
 
   end

data/lib/nicinfo/factory.rb

@@ -0,0 +1,56 @@
+# Copyright (C) 2017 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.
+
+module NicInfo
+
+  # Creates objects we want to mock
+  class Factory
+
+    attr_accessor :config
+
+    def initialize( config )
+      @config = config
+    end
+
+    def new_error_code
+      return ErrorCode.new( config )
+    end
+
+    def new_autnum
+      return Autnum.new( config )
+    end
+
+    def new_domain
+      return Domain.new( config )
+    end
+
+    def new_entity
+      return Entity.new( config )
+    end
+
+    def new_ip
+      return Ip.new( config )
+    end
+
+    def new_notices
+      return Notices.new( config )
+    end
+
+    def new_ns
+      return Ns.new( config )
+    end
+
+  end
+
+end

data/lib/nicinfo/ip.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -25,7 +25,7 @@ require 'nicinfo/cidrs'
 module NicInfo
 
   def NicInfo.display_ip json_data, config, data_tree
-    ip = Ip.new( config ).process( json_data )
+    ip = config.factory.new_ip.process( json_data )
     NicInfo::display_object_with_entities( ip, config, data_tree )
   end
 

data/lib/nicinfo/nicinfo_main.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -506,7 +506,7 @@ module NicInfo
           end
         else
           json_data = do_rdap_query
-          display_rdap_query( json_data, true )
+          display_rdap_query( json_data, true ) if json_data
       end
 
 
@@ -521,6 +521,7 @@ module NicInfo
     end
 
     def do_rdap_query
+      retval = nil
       if @config.config[ NicInfo::BOOTSTRAP ][ NicInfo::BOOTSTRAP_URL ] == nil && !@config.options.url
         bootstrap = Bootstrap.new( @config )
         qtype = @config.options.query_type
@@ -578,7 +579,7 @@ module NicInfo
         end
         inspect_rdap_compliance json_data
         cache_self_references json_data
-        json_data
+        retval = json_data
       rescue JSON::ParserError => a
         @config.logger.mesg( "Server returned invalid JSON!" )
       rescue SocketError => a
@@ -617,6 +618,7 @@ module NicInfo
         end
         @config.logger.trace("Server response code was " + e.response.code)
       end
+      return retval
     end
 
     def display_rdap_query json_data, show_help = true
@@ -627,7 +629,7 @@ module NicInfo
           @config.logger.raw( DataAmount::TERSE_DATA, eval_json_value( value, json_data), false )
         end
       else
-        Notices.new.display_notices json_data, @config, @config.options.query_type == QueryType::BY_SERVER_HELP
+        @config.factory.new_notices.display_notices json_data, @config.options.query_type == QueryType::BY_SERVER_HELP
         if @config.options.query_type != QueryType::BY_SERVER_HELP
           result_type = get_query_type_from_result( json_data )
           if result_type != nil
@@ -694,8 +696,8 @@ module NicInfo
     if res["content-type"] == NicInfo::RDAP_CONTENT_TYPE && res.body && res.body.to_s.size > 0
         json_data = JSON.load( res.body )
         inspect_rdap_compliance json_data
-        Notices.new.display_notices json_data, @config, true
-        ErrorCode.new.display_error_code json_data, @config
+        @config.factory.new_notices.display_notices json_data, true
+        @config.factory.new_error_code.display_error_code( json_data )
       end
     end
 

data/lib/nicinfo/notices.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2011,2012,2013,2014 American Registry for Internet Numbers
+# Copyright (C) 2011-2017 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
@@ -21,14 +21,20 @@ module NicInfo
   # deals with RDAP notices structures
   class Notices
 
-    def Notices.is_excessive_notice notices, config
+    attr_accessor :config
+
+    def initialize( config )
+      @config = config
+    end
+
+    def is_excessive_notice notices
       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 = NicInfo::get_descriptions notice, @config
         descriptions.each do |line|
           line_count = line_count + 1
           word_count = word_count + line.length
@@ -40,69 +46,69 @@ module NicInfo
       return false
     end
 
-    def display_notices json_response, config, ignore_excessive
+    def display_notices json_response, 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
+      if (is_excessive_notice(notices) ) && (@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
+          display_single_notice notice
         end
       end
 
     end
 
-    def display_single_notice notice, config
-      config.logger.start_data_item
+    def display_single_notice notice
+      @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
+      @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 )
+        @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
+            @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."
+            @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."
+        @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
+          @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
+          @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
+          @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
+          @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
+          @config.logger.prose NicInfo::DataAmount::NORMAL_DATA, "License", license if license
         else
-          config.conf_msgs << "'links' is not an array."
+          @config.conf_msgs << "'links' is not an array."
         end
       end
-      config.logger.end_data_item
+      @config.logger.end_data_item
     end
 
   end

data/lib/nicinfo/ns.rb

@@ -22,7 +22,7 @@ require 'nicinfo/data_tree'
 module NicInfo
 
   def NicInfo.display_ns json_data, config, data_node
-    ns = Ns.new( config ).process( json_data )
+    ns = config.factory.new_ns.process( json_data )
     NicInfo::display_object_with_entities( ns, config, data_node )
   end
 
@@ -32,7 +32,7 @@ module NicInfo
       if ns_array.instance_of? Array
         display_array = Array.new
         ns_array.each do |ea|
-          ns = Ns.new( config ).process( ea )
+          ns = config.factory.new_ns.process( ea )
           display_array << ns
         end
         NicInfo::display_object_with_entities( display_array, config, data_node )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nicinfo
 version: !ruby/object:Gem::Version
-  version: 1.3.0.pre.alpha1
+  version: 1.3.0.pre.alpha2
 platform: ruby
 authors:
 - Andrew Newton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netaddr
@@ -74,6 +74,7 @@ files:
 - lib/nicinfo/entity.rb
 - lib/nicinfo/enum.rb
 - lib/nicinfo/error_code.rb
+- lib/nicinfo/factory.rb
 - lib/nicinfo/female-first-names.txt
 - lib/nicinfo/ip.rb
 - lib/nicinfo/key_data.rb
@@ -105,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: RDAP Client