iana-data 1.1.3

data/examples/ethertypes.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# examples/ethertypes.rb
+
+require 'pathname'
+dir = Pathname.new(File.expand_path(__FILE__)).realpath
+require File.join(File.dirname(dir.to_s), '../lib/iana')
+
+SCRIPT = File.basename(__FILE__)
+
+def known_ethertype?(ethertype)
+
+  IANA_ETHERTYPES.include?(ethertype)
+end
+
+if ARGV.length == 1
+  begin
+    IANA_ETHERTYPES, IANA_ETHERTYPES_UPDATED = IANA::EtherType::load(ARGV[0])
+  rescue
+    puts "#{SCRIPT}: #{$!}"
+    exit 1
+  end
+else
+  puts "Usage: #{SCRIPT} <ethernet-numbers>"
+  exit 1
+end
+
+puts "updated #{IANA_ETHERTYPES_UPDATED} => #{IANA_ETHERTYPES.size} entries"
+puts
+IANA_ETHERTYPES.each do |t|
+  print "#{t.begin}"
+  print "-#{t.end}" if t.end != t.begin
+  puts " => #{t.description}"
+end
+puts
+
+# known in :begin => true
+puts "86dd is known? => #{IANA::EtherType.known?("86dd")}"
+
+# known in :end => true
+puts "8a97 is known? => #{IANA::EtherType.known?("8a97")}"
+
+# known between :begin and :end => true
+puts "8709 is known? => #{IANA::EtherType.known?("8709")}"
+
+# unknown => false
+puts "fefe is known? => #{IANA::EtherType.known?("fefe")}"
+
+exit 0

data/examples/ports.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# examples/ports.rb
+
+require 'pathname'
+dir = Pathname.new(File.expand_path(__FILE__)).realpath
+require File.join(File.dirname(dir.to_s), '../lib/iana')
+
+SCRIPT = File.basename(__FILE__)
+
+if ARGV.length == 1
+  begin
+    IANA_PORT, IANA_PORT_UPDATED = IANA::Port::load(ARGV[0])
+  rescue
+    puts "#{SCRIPT}: #{$!}"
+    exit 1
+  end
+else
+  puts "Usage: #{SCRIPT} <port-numbers>"
+  exit 1
+end
+
+puts "#{IANA_PORT_UPDATED} => #{IANA_PORT.size} entries"
+
+# lookup port 22
+port = 22
+result = IANA_PORT[port]
+puts "#{result.size} matches for port #{port}:"
+result.each do |p|
+  puts "=> #{p.keyword} #{port}/#{p.protocol} \"#{p.description}\""
+end
+
+exit 0

data/examples/protocols.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# examples/protocols.rb
+
+require 'pathname'
+dir = Pathname.new(File.expand_path(__FILE__)).realpath
+require File.join(File.dirname(dir.to_s), '../lib/iana')
+
+SCRIPT = File.basename(__FILE__)
+
+if ARGV.length == 1
+  begin
+    IANA_PROTO, IANA_PROTO_UPDATED = IANA::Protocol::load(ARGV[0])
+  rescue
+    puts "#{SCRIPT}: #{$!}"
+    exit 1
+  end
+else
+  puts "Usage: #{SCRIPT} <protocol-numbers>"
+  exit 1
+end
+
+puts "#{IANA_PROTO_UPDATED} => #{IANA_PROTO.size} entries"
+
+# lookup protocol 22
+result = IANA_PROTO[22]
+print "protocol 22 => #{result.name} \"#{result.description}\""
+if !result.references.nil? && !result.references.empty? then
+  puts " #{result.references}"
+else
+  puts
+end
+
+exit 0

data/examples/tlds.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# examples/tlds.rb
+require 'iana'
+
+# is com a TLD?
+puts "com is a TLD? => #{IANA::TLD.tld?('com')}"
+
+# how about to?
+puts "to is a TLD? => #{IANA::TLD.tld?('to')}"
+
+# grizzlebat is probably not a TLD
+puts "grizzlebat is a TLD? => #{IANA::TLD.tld?('grizzlebat')}"
+
+# how about yn?
+puts "yn is a TLD? => #{IANA::TLD.tld?('yn')}"
+
+exit 0

data/iana.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iana/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iana-data"
+  spec.version       = Iana::VERSION
+  spec.authors       = ["Runar Ingebrigtsen", "Ramsey Dow"]
+  spec.email         = %w{runar@rin.no, yesmar@gmail.com}
+
+  spec.summary       = %q{Look up official IANA data, replacement for iana gem}
+  spec.homepage      = "http://github.com/ringe/iana"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7'
+
+  spec.add_dependency "open-uri-cached", "= 0.0.5"
+end

data/iana.tmproj

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>documents</key>
+	<array>
+		<dict>
+			<key>filename</key>
+			<string>README</string>
+		</dict>
+		<dict>
+			<key>filename</key>
+			<string>LICENSE</string>
+		</dict>
+		<dict>
+			<key>filename</key>
+			<string>Rakefile</string>
+		</dict>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>lib</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string>lib</string>
+		</dict>
+		<dict>
+			<key>expanded</key>
+			<true/>
+			<key>name</key>
+			<string>examples</string>
+			<key>regexFolderFilter</key>
+			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<key>sourceDirectory</key>
+			<string>examples</string>
+		</dict>
+	</array>
+	<key>fileHierarchyDrawerWidth</key>
+	<integer>200</integer>
+	<key>metaData</key>
+	<dict/>
+	<key>showFileHierarchyDrawer</key>
+	<true/>
+	<key>windowFrame</key>
+	<string>{{638, 167}, {728, 637}}</string>
+</dict>
+</plist>

data/lib/iana/ethertype.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# lib/iana/ethertype.rb
+
+module IANA
+  module EtherType
+    EtherType = Struct.new('ETHERTYPE', :begin, :end, :description)
+
+    # I hate doing it this way, but the inconsistency of IANA data files...
+    LAST_ENTRY = '^ 65535   FFFF        -      -     Reserved               \[RFC1701\]$'
+
+    # load IANA Ether types list from flat file:
+    # http://www.iana.org/assignments/ethernet-numbers
+    def self.load(pathname)
+      raise ArgumentError, 'nil pathname' if pathname.nil?
+      raise ArgumentError, 'invalid pathname class' if pathname.class != String
+      raise ArgumentError, 'empty pathname' if pathname.empty?
+
+      # TODO: better error checking for files with incorrect content
+
+      ethertypes = []
+      updated = nil
+
+      begin
+        f = File.new(pathname, 'r')
+        while (line = f.gets)
+          line.chomp!
+
+          # extract update stamp
+          if line =~ /^\(last updated (\d{4}-\d{2}-\d{2})\)\s*$/
+            updated = $1
+            next
+          end
+
+          # skip lines that don't have [XXX] or (XXX) at the end
+          next if line !~ /\[\w*\]$/ && line !~ /\([\w\s]*\)$/
+
+          # now skip all lines that don't begin with a space
+          next if line !~ /^[\t\ ]*/
+
+          # skip over decimal Ethertype
+          pos = 0
+          if line =~ /^\t\ /
+            pos = 2
+          else
+            pos = 9
+          end
+
+          # clean up ridiculous IANA formatting
+          line.gsub!(/^\t/, '8') # TODO: investigate this weirdness
+          line.gsub!(/\t     -/, '        -')
+          line.gsub!(/\t\t\t  /, '                     ')
+          line.gsub!(/\t/, '   ')
+
+          tmp = line[pos..-1]
+
+          ethertype = tmp[0..9].strip!
+          low, high = ethertype.split('-')
+          high = low if high.nil?
+
+          description, *junk = tmp[25..-1].split('[')
+          description.strip!
+
+          et = EtherType.new(low, high, description)
+          ethertypes << et
+
+          # short-circuit as soon as we've hit the end of the list
+          break if line =~ /#{LAST_ENTRY}/
+        end
+      ensure
+        f.close if !f.nil?
+      end
+
+      return ethertypes, updated
+    end
+
+    # is specified Ether type known
+    def self.known?(ethertype)
+      raise ArgumentError, 'nil ethertype' if ethertype.nil?
+      raise ArgumentError, 'invalid ethertype class' if \
+        ethertype.class != String
+      raise ArgumentError, 'empty ethertype' if ethertype.empty?
+
+      IANA_ETHERTYPES.each do |t|
+        return true if ethertype.upcase == t.begin
+        if t.end != t.begin
+          return true if ethertype.upcase >= t.begin && \
+            ethertype.upcase <= t.end
+        end
+      end
+
+      false
+    end
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/lsr.rb

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+
+# NOTE
+# RFC 4646 described below has been obseleted by RFC5646. Tests still run OK
+# but I have no idea (yet) what this new RFC has changed in terms of the LSR
+# file format or langugae tags generally.
+# See http://tools.ietf.org/html/rfc5646 (particularly section 8).
+# 2011-04-18
+module IANA
+  # Get the Language Subtag Registry data from the IANA site or a text file
+  # and load it into an array of hashes for further processing.
+  #
+  # IANA's Language Subtag Registry incorporates multiple standards for the
+  # definition of language- and locale-defining strings, including:
+  # ISO 3166: English country names and code elements 
+  # ( http://www.iso.org/iso/english_country_names_and_code_elements )
+  # ISO 639.2: Codes for the Representation of Names of Languages
+  # ( http://www.loc.gov/standards/iso639-2/php/code_list.php )
+  # The registry's format is specified in RFC 4646
+  # ( http://www.ietf.org/rfc/rfc4646.txt )
+  class LanguageSubtagRegistry
+    # Entries always have these keys: Type, [Tag or Subtag], Description, Added
+    # All keys used in the IANA format:
+    Keys = [
+      "Type",
+      "Tag",
+      "Subtag",
+      "Description",
+      "Added",
+      "Preferred-Value",
+      "Deprecated",
+      "Suppress-Script",
+      "Prefix",
+      "Comments" ]
+    IANAHost = 'www.iana.org'
+    IANAPath = '/assignments/language-subtag-registry'
+    IANAFile = File.dirname(__FILE__) + "/../../example-data/lsr.txt"
+    @@tags      = [] 
+    @@file_date = ""
+
+    def self.tags
+      @@tags
+    end
+
+    def self.file_date
+      @@file_date
+    end
+
+    # Load data directly from IANA site
+    def self.get(path=IANAPath, host=IANAHost)
+      require 'net/http'
+      site = Net::HTTP.new host
+      response = site.request_get path
+      self.load(response.body)
+    end
+
+    # Load data from a text file
+    def self.open(filename=IANAFile)
+      file = File.open(filename, 'r')
+      self.load(file.read)
+    end
+
+    # Load data from text string
+    def self.load(text)
+      @@tags = []
+      @@file_date = ""
+      item  = {}
+      prev  = []
+      text.each do |line|
+        line.chomp!
+        case line
+        when /^%%$/
+          (@@tags << item; item = {}) unless item.empty? # separator; append last entry, if present
+        when /^File-Date: .*/
+          @@file_date = line.gsub('File-Date: ','') # File-date entry
+        when /^  [^ ].*/
+          item[prev].kind_of?(Array) ? item[prev].last += " " + line.strip : item[prev] += " " + line.strip # continuation line
+        else # everything else (the actual key: value pairs)
+          key, val = line.split(':', 2) # the main pair (ie, "Subtag: en")
+          if /\.\./.match val # value specifies a range, not simply a string
+            start, finish = val.strip.split('..', 2)
+            val = Range.new(start, finish)
+          else # otherwise it's just a string
+            val.strip!
+          end
+          if item.has_key?(key) # append to array if this key already exists
+            item[key] = [item[key]] unless item[key].kind_of? Array
+            item[key] << val
+          else # otherwise simply assign the item
+            item[key] = val
+          end
+          prev = key # in case of continuation (wrapped text)
+        end
+      end
+      @@tags << item
+      nil
+    end
+
+    # Dump data to:
+    # IANA's flat text format (String)
+    # YAML (String)
+    # A hash of hashes, with the keys being the tags (Hash)
+    def self.dump(format = "iana")
+      begin
+        format = format.strip.downcase
+      rescue
+        raise ArgumentError, "Invalid argument type; expected String"
+      end
+      case format
+      when "iana"
+        new_text = "File-Date: " + @@file_date + $/ + "%%" + $/
+        new_text << @@tags.map do |item|
+          Keys.map do |key|
+            val = item[key]
+            if val 
+              if val.kind_of? Array
+                val.map { |i| key + ": " + i.to_s }.join($/)
+              else
+                key + ": " + val.to_s
+              end
+            else
+              nil
+            end
+          end.compact.join($/) + $/
+        end.join('%%' + $/)
+      when "yaml"
+        require 'yaml'
+        YAML::dump([@@file_date, @@tags])
+      when "hash"
+        taghash = {}
+        @@tags.each do |tag|
+          tag = tag.clone
+          val = tag.delete("Tag") || tag.delete("Subtag")
+          taghash[val.to_s] = tag
+        end
+        taghash
+      else
+        raise ArgumentError, "Invalid format option"
+      end
+    end
+
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/port.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# lib/iana/port.rb
+
+module IANA
+  module Port
+    Port = Struct.new('PORT', :keyword, :protocol, :description)
+
+    # load IANA ports list from flat file:
+    # http://www.iana.org/assignments/port-numbers
+    def self.load(pathname)
+      raise ArgumentError, 'nil pathname' if pathname.nil?
+      raise ArgumentError, 'invalid pathname class' if pathname.class != String
+      raise ArgumentError, 'empty pathname' if pathname.empty?
+
+      # TODO: better error checking for files with incorrect content
+
+      ports = {}
+      updated = nil
+
+      begin
+        f = File.new(pathname, 'r')
+        while (line = f.gets)
+          line.chomp!
+
+          # extract update stamp
+          if line =~ /^\(last updated (\d{4}-\d{2}-\d{2})\)\s*$/
+            updated = $1
+            next
+          end
+
+          # skip commented lines
+          next if line =~ /^#/
+
+          # skip lines which do not contain the /{proto} pattern
+          if line !~ /\/tcp/ && line !~ /\/udp/ && line !~ /\/sctp/ && \
+            line !~ /\/dccp/
+              next
+          end
+
+          line.strip!
+          tokens = line.split(/[\s]+/)
+
+          # if first token is a port/proto pair then the port is unnamed
+          if tokens[0] =~ /\//
+            name = nil
+            num,proto = tokens[0].split(/\//)
+            tokens.delete_at(0)
+          else
+            name = tokens[0]
+            num,proto = tokens[1].split(/\//)
+            2.times { tokens.delete_at(0) }
+          end
+
+          # remainder of tokens serves as the description
+          desc = tokens.join(' ')
+
+          p = Port.new(name, proto, desc)
+
+          if ports[num.to_i].nil?
+            ports[num.to_i] = p
+          else
+            c = []
+            c << ports[num.to_i]
+            c << p
+            ports[num.to_i] = c.flatten
+          end
+        end
+      ensure
+        f.close if !f.nil?
+      end
+
+      return ports, updated
+    end
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/protocol.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# lib/iana/protocol.rb
+
+# rubygems
+require 'nokogiri'
+
+module IANA
+  module Protocol
+    Protocol = Struct.new('PROTOCOL', :name, :description, :references)
+
+    # load IANA protocols list from XML file:
+    # http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml
+    def self.load(pathname)
+      raise ArgumentError, 'nil pathname' if pathname.nil?
+      raise ArgumentError, 'invalid pathname class' if pathname.class != String
+      raise ArgumentError, 'empty pathname' if pathname.empty?
+
+      protocols = {}
+      updated = nil
+
+      begin
+        f = File.new(pathname, 'r')
+        doc = Nokogiri::XML(f)
+        updated = doc.css('registry/updated').text
+        doc.css('registry/registry/record').each do |r|
+          # range
+          value = r.css('value').text
+          if value =~ /-/ then
+            low,high = value.split('-').map(&:to_i)
+          else
+            low = value.to_i
+            high = low
+          end
+
+          # name
+          name = r.css('name').text
+          name = nil if !name.nil? && name.empty?
+
+          # description
+          description = r.css('description').text
+          description = nil if !description.nil? && description.empty?
+
+          # references
+          xref = []
+          r.css('xref').each do |x|
+            data = x['data']
+            xref << data if !data.nil? && !data.empty?
+          end
+
+          if low == high then
+            protocols[low] = Protocol.new(name, description, xref)
+          else
+            # create an entry for each range element
+            (high-low+1).times do |i|
+              protocols[low+i] = Protocol.new(name, description, xref)
+            end
+          end
+        end
+      ensure
+        f.close if !f.nil?
+      end
+
+      return protocols, updated
+    end
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/tld.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# lib/tld.rb
+
+module IANA
+  module TLD
+    # Download official IANA Top Level Domain list
+    # http://data.iana.org/TLD/tlds-alpha-by-domain.txt
+    def self.iana_list
+      open("http://data.iana.org/TLD/tlds-alpha-by-domain.txt").read.
+        split("\n").
+        reject {|ln| ln =~ /^#/ }
+    end
+
+    # is specified tld a valid IANA Top Level Domain?
+    def self.valid?(tld)
+      iana_list.include?(tld.to_s.upcase)
+    end
+
+    # is specified domain name a TLD?
+    def self.tld?(tld)
+      valid?(tld)
+    end
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/version.rb

@@ -0,0 +1,3 @@
+module Iana
+  VERSION = "1.1.3"
+end

data/lib/iana.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# vim: expandtab tabstop=2 softtabstop=2 shiftwidth=2
+
+# lib/iana.rb
+module IANA
+end # IANA
+
+require 'open-uri'
+require 'open-uri/cached'
+
+#require 'consumer'
+require 'iana/ethertype'
+require 'iana/port'
+require 'iana/protocol'
+require 'iana/tld'
+require 'iana/lsr'
+
+# TODO implement consumer model
+# TODO complete documentaion
+# TODO implement unit tests
+# TODO lookup needs to be more flexible
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__