nicinfo 0.2.0

data/lib/data_tree.rb

@@ -0,0 +1,205 @@
+# 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 'yaml'
+require 'nicinfo_logger'
+
+module NicInfo
+
+  class DataNode
+
+    attr_accessor :alert, :handle, :rest_ref, :data, :children, :data_type
+
+    def initialize name, handle = nil, rest_ref = nil, data = nil, data_type = nil
+      @name = name
+      @children = []
+      @data = data
+      @handle = handle
+      @rest_ref = rest_ref
+      @data_type = data_type
+    end
+
+    def add_child node
+      @children << node if node
+    end
+
+    def to_s
+      @name
+    end
+
+    def empty?
+      @children.empty?
+    end
+
+    def <=> x
+      @name <=> x.to_s
+    end
+
+    def has_meta_info
+      return true if @handle
+      return true if @rest_ref
+      return true if @data
+      return false
+    end
+
+  end
+
+  class DataTree
+
+    def initialize
+      @roots = []
+    end
+
+    def add_root node
+      @roots << node if node
+    end
+
+    def add_child node
+      add_root( node )
+    end
+
+    def add_children_as_root node
+      node.children.each do |child|
+        add_root( child )
+      end if node
+    end
+
+    def roots
+      @roots
+    end
+
+    def empty?
+      @roots.empty?
+    end
+
+    def find_data data_address
+      node = find_node data_address
+      return node.data if node
+      return nil
+    end
+
+    def find_handle data_address
+      node = find_node data_address
+      return node.handle if node
+      return nil
+    end
+
+    def find_rest_ref data_address
+      node = find_node data_address
+      return node.rest_ref if node
+      return nil
+    end
+
+    def find_node data_address
+      node = NicInfo::DataNode.new( "fakeroot" )
+      node.children=roots
+      data_address.split( /\D/ ).each do |index_str|
+        index = index_str.to_i - 1
+        node = node.children[ index ] if node
+      end
+      if node != nil
+        return node
+      end
+      #else
+      return nil
+    end
+
+    def to_terse_log logger, annotate = false
+      @logger = logger
+      @data_amount = DataAmount::TERSE_DATA
+      to_log( annotate )
+    end
+
+    def to_normal_log logger, annotate = false
+      @logger = logger
+      @data_amount = DataAmount::NORMAL_DATA
+      to_log( annotate )
+    end
+
+    def to_extra_log logger, annotate = false
+      @logger = logger
+      @data_amount = DataAmount::EXTRA_DATA
+      to_log( annotate )
+    end
+
+    private
+
+    def to_log annotate
+      retval = false
+      print_tree = false
+      @roots.each do |root|
+        print_tree = true unless root.children.empty?
+      end
+      num_count = 1
+      @roots.each do |root|
+        @logger.start_data_item if print_tree
+        @logger.prose( @data_amount, "[ RESPONSE DATA ]", " ")
+        if annotate
+          if root.alert
+            s = format( "   # %s", root.to_s )
+          elsif root.has_meta_info
+            s = format( "%3d= %s", num_count, root.to_s )
+          else
+            s = format( "%3d. %s", num_count, root.to_s )
+          end
+        else
+          s = root.to_s
+        end
+        retval = @logger.log_tree_item( @data_amount, s )
+        if annotate
+          prefix = " "
+          child_num = 1
+        else
+          prefix = ""
+          child_num = 0
+        end
+        root.children.each do |child|
+          rprint( child_num, root, child, prefix )
+          child_num += 1 if child_num > 0
+        end if root.children() != nil
+        num_count += 1
+        @logger.end_data_item
+      end if print_tree
+      return retval
+    end
+
+    def rprint( num, parent, node, prefix )
+      if( num > 0 )
+        spacer = "    "
+        if node.alert
+          num_str = format( " # ", num )
+        elsif node.has_meta_info
+          num_str = format( " %d= ", num )
+        else
+          num_str = format( " %d. ", num )
+        end
+        num_str = num_str.rjust( 7, "-" )
+        child_num = 1
+      else
+        spacer = "  "
+        num_str = "- "
+        child_num = 0
+      end
+      prefix = prefix.tr( "`", " ") + spacer + ( node == parent.children.last ? "`" : "|" )
+      @logger.log_tree_item( @data_amount, prefix + num_str + node.to_s )
+      node.children.each do |child|
+        rprint( child_num, node, child, prefix )
+        child_num += 1 if child_num > 0
+      end if node.children() != nil
+    end
+
+  end
+
+end

data/lib/demo/autnum.json

@@ -0,0 +1,228 @@
+{
+    "nicInfo_demoUrl":"http://rdappilot.arin.net/restfulwhois/rdap/autnum/10",
+    "nicInfo_demoHint":"nicinfo as10",
+    "rdapConformance":[
+        "rdap_level_0"
+    ],
+    "notices":[
+        {
+            "title":"ARIN's RDAP Service",
+            "description":[
+                "ARIN has been a leader in RESTful Whois technologies and is proud to offer the Registration Data Access Protocol service.",
+                "ARIN's RDAP server is complaint with RDAP Level 0."
+            ]
+        },
+        {
+            "title":"Terms of Use",
+            "description":[
+                "ARIN WHOIS data and services are subject to the Terms of Use available at: https://www.arin.net/whois_tou.html"
+            ],
+            "links":[
+                {
+                    "value":"http://whois.apnic.net/ip/2001:db8::0",
+                    "rel":"terms-of-service",
+                    "type":"text/html",
+                    "href":"https://www.arin.net/whois_tou.html"
+                }
+            ]
+        }
+    ],
+    "handle":"AS10-RIR",
+    "objectClassName":"autnum",
+    "startAutnum":10,
+    "endAutnum":15,
+    "name":"AS-RTR-1",
+    "description":[ "AS for Exchange" ],
+    "type":"DIRECT ALLOCATION",
+    "country":"AU",
+    "remarks":[
+        {
+            "description":[
+                "She sells sea shells down by the sea shore.",
+                "Originally written by Terry Sullivan."
+            ]
+        }
+    ],
+    "links":[
+        {
+            "value":"http://rdappilot.arin.net/restfulwhois/rdap/autnum/10",
+            "rel":"self",
+            "href":"http://rdappilot.arin.net/restfulwhois/rdap/autnum/10"
+        }
+    ],
+    "events":[
+        {
+            "eventAction":"registration",
+            "eventDate":"1990-12-31T23:59:60Z"
+        },
+        {
+            "eventAction":"last changed",
+            "eventDate":"1991-12-31T23:59:60Z"
+        }
+    ],
+    "entities":[
+        {
+            "handle":"MATTR-ARIN",
+            "objectClassName":"entity",
+            "vcardArray":[
+                "vcard",
+                [
+                    ["version", {}, "text", "4.0"],
+                    ["fn", {}, "text", "Matt Rowley"],
+                    ["kind", {}, "text", "individual"],
+                    ["org", {
+                        "type":"work"
+                    }, "text", "American Registry for Internet Numbers"],
+                    ["title", {}, "text", "Operations Manager"],
+                    ["role", {}, "text", "Project Lead"],
+                    ["adr",
+                        {
+                            "type":"work"
+                        },
+                        "text",
+                        [
+                            "",
+                            "Suite 200",
+                            "3635 Concorde Parkway",
+                            "Chantilly",
+                            "VA",
+                            "20151",
+                            "United States"
+                        ]
+                    ],
+                    ["tel",
+                        {
+                            "type":["work", "voice"],
+                            "pref":"1"
+                        },
+                        "uri",
+                        "tel:+1-703-227-9840"
+                    ],
+                    ["email",
+                        {
+                            "type":"work"
+                        },
+                        "text",
+                        "info@arin.net"
+                    ]
+                ]
+            ],
+            "roles":[ "administrative" ],
+            "remarks":[
+                {
+                    "title": "No Solicitations",
+                    "description":[
+                        "Absolutely no solicitations are accepted at by this contact. If you wish to offer services or products to the American Registry for Internet Numbers, contact Pete Toscano at +1-703-227-9840."
+                    ]
+                }
+            ],
+            "links":[
+                {
+                    "value":"http://example.net/entity/MATTR-ARIN",
+                    "rel":"self",
+                    "href":"http://example.net/entity/MATTR-ARIN"
+                }
+            ],
+            "events":[
+                {
+                    "eventAction":"registration",
+                    "eventDate":"2012-12-31T23:59:60Z",
+                    "eventActor": "mattr@arin.net"
+                },
+                {
+                    "eventAction":"last changed",
+                    "eventDate":"2013-12-31T23:59:60Z",
+                    "eventActor": "mattr@arin.net"
+                }
+            ],
+            "asEventActor":[
+                {
+                    "eventAction":"last changed",
+                    "eventDate":"2013-12-31T23:59:60Z"
+                }
+            ]
+        },
+        {
+            "handle":"MAK21-ARIN",
+            "objectClassName":"entity",
+            "vcardArray":[
+                "vcard",
+                [
+                    ["version", {}, "text", "4.0"],
+                    ["fn", {}, "text", "Mark Kosters"],
+                    ["kind", {}, "text", "individual"],
+                    ["org", {
+                        "type":"work"
+                    }, "text", "American Registry for Internet Numbers"],
+                    ["title", {}, "text", "Chief Technical Officer"],
+                    ["role", {}, "text", "Pointy Haired Boss"],
+                    ["adr",
+                        {
+                            "type":"work",
+                            "label" : "3635 Concorde Parkway\nSuite200\nChantilly\nVA\n20151"
+                        },
+                        "text",
+                        [
+                            "",
+                            "",
+                            "",
+                            "",
+                            "",
+                            "",
+                            ""
+                        ]
+                    ],
+                    ["tel",
+                        {
+                            "type":["work", "voice"],
+                            "pref":"1"
+                        },
+                        "uri",
+                        "tel:+1-703-227-9840"
+                    ],
+                    ["email",
+                        {
+                            "type":"work"
+                        },
+                        "text",
+                        "info@arin.net"
+                    ]
+                ]
+            ],
+            "roles":[ "technical" ],
+            "remarks":[
+                {
+                    "title": "No Solicitations",
+                    "description":[
+                        "Absolutely no solicitations are accepted at by this contact. If you wish to offer services or products to the American Registry for Internet Numbers, contact Pete Toscano at +1-703-227-9840."
+                    ]
+                }
+            ],
+            "links":[
+                {
+                    "value":"http://example.net/entity/MAK21-ARIN",
+                    "rel":"self",
+                    "href":"http://example.net/entity/MAK21-ARIN"
+                }
+            ],
+            "events":[
+                {
+                    "eventAction":"registration",
+                    "eventDate":"2012-12-31T23:59:60Z",
+                    "eventActor": "markk@arin.net"
+                },
+                {
+                    "eventAction":"last changed",
+                    "eventDate":"2013-12-31T23:59:60Z",
+                    "eventActor": "markkb@arin.net"
+                }
+            ],
+            "asEventActor":[
+                {
+                    "eventAction":"reregistration",
+                    "eventDate":"2012-12-31T23:59:60Z"
+                }
+            ]
+        }
+    ]
+}