iana 0.0.4

data/README

@@ -0,0 +1,46 @@
+== What
+IANA Ruby module version 0.0.4
+
+I like to look stuff up, like TCP/IP port numbers, protocols, top-level
+domains, et al. I get my data from the Internet Assigned Numbers Authority
+(IANA) and like to make it available to my programs. Since I am open sourcing
+this code you can add this functionality to your own programs as well.
+
+== How
+require 'rubygems'
+require 'iana'
+
+The IANA Ruby module loads the data into conveniently searchable data
+structures. The flat files the IANA Ruby module consume as data are hosted at
+iana.org. You will need to fetch them so you can process the content locally.
+I grab these files with with curl (but you can use wget or whatever if you
+don't use curl):
+
+curl -O http://www.iana.org/assignments/port-numbers
+curl -O http://www.iana.org/assignments/protocol-numbers
+curl -O http://data.iana.org/TLD/tlds-alpha-by-domain.txt
+
+== Examples
+When you run the example programs, do it like so:
+
+  ruby examples/ports.rb port-numbers
+
+Use these example programs to see how you might use and otherwise integrate
+IANA data functionality into your own programs.
+
+== Install
+I added a Rakefile and a gem spec. To build the gem, just type:
+
+  rake gem
+
+To install the gem, just type:
+
+  sudo gem install pkg/iana-0.0.4.gem
+
+== Notes
+I haven't tested this code with YARV, so YMMV.
+
+== Contribute
+The source is availble at github: git://github.com/yesmar/iana.git. Feel free
+to clone it and implement your own awesome ideas. You can also send your
+patches by email to yesmar[at]speakeasy[dot]net.

data/examples/ports.rb

@@ -0,0 +1,31 @@
+#/usr/bin/env ruby
+
+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,28 @@
+#!/usr/bin/env ruby
+
+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 50
+result = IANA_PROTO[50]
+puts "protocol 50 => #{result.keyword} \"#{result.description}\" " \
+  "#{result.references}"
+
+exit 0

data/examples/tlds.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+# tlds.rb
+# yesmar@speakeasy.net
+
+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 tld?(dn)
+  raise ArgumentError, 'nil dn' if dn.nil?
+  raise ArgumentError, 'invalid dn class' if dn.class != String
+  raise ArgumentError, 'empty dn' if dn.empty?
+
+  return IANA_TLD.include?(dn) ? true : false
+end
+
+if ARGV.length == 1
+  begin
+    IANA_TLD, IANA_TLD_UPDATED, IANA_TLD_VERSION = IANA::TLD::load(ARGV[0])
+  rescue
+    puts "#{SCRIPT}: #{$!}"
+    exit 1
+  end
+else
+  puts "Usage: #{SCRIPT} <tlds>"
+  exit 1
+end
+
+puts "#{IANA_TLD_VERSION} updated #{IANA_TLD_UPDATED} => " \
+  "#{IANA_TLD.size} entries"
+
+# is com a TLD?
+puts "com is a TLD? => #{tld?('com')}"
+
+# how about to?
+puts "to is a TLD? => #{tld?('to')}"
+
+# grizzlebat is probably not a TLD
+puts "grizzlebat is a TLD? => #{tld?('grizzlebat')}"
+
+# how about yn?
+puts "yn is a TLD? => #{tld?('yn')}"
+
+exit 0

data/lib/iana.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# iana.rb
+# yesmar@speakeasy.net
+
+$KCODE = 'UTF8'
+require 'jcode'
+
+module IANA
+  IANA::NAME = 'iana'
+  IANA::VERSION = '0.0.4'
+  IANA::COPYRIGHT = 'Copyright (c) 2008 Ramsey Dow'
+  def self.copyright() IANA::COPYRIGHT end
+  def self.version() IANA::VERSION end
+  def self.libdir() File.expand_path(__FILE__).gsub(%r/\.rb$/, '') end
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__)+'/iana')
+
+require 'port'
+require 'protocol'
+require 'tld'
+
+# TODO: bad developer, no unit tests
+# TODO: lookup needs to be more flexible
+# TODO: add IANA ethernet-numbers support
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

data/lib/iana/port.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+# port.rb
+# yesmsar@speakeasy.net
+
+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\t]+/)
+
+          # 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,79 @@
+#!/usr/bin/env ruby
+
+# protocol.rb
+# yesmar@speakeasy.net
+
+module IANA
+  module Protocol
+    Protocol = Struct.new('PROTOCOL', :keyword, :description, :references)
+
+    # load IANA protocols list from flat file:
+    # http://www.iana.org/assignments/protocol-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
+
+      protocols = {}
+      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
+
+          # match spaces d[dd][-ddd] spaces
+          if line =~ /^\s+\d{1,3}([\-]{1}\d{3})?\s+/
+            line.strip!
+            line.gsub!(/\t/, ' ')
+            line.gsub!(/\s{2,}/, '|')
+            data = line.split('|')
+            raw_decimal = data[0]
+
+            if raw_decimal =~ /\-/
+              first,second = raw_decimal.split(' ')
+              raw_low,raw_high = first.split('-')
+              low = raw_low.to_i
+              high = raw_high.to_i
+              low.upto(high) do |i|
+                p = Protocol.new
+                p.keyword = '<unassigned>'
+                p.description = '<unassigned>'
+                p.references = '[IANA]'
+                protocols[i] = p
+              end
+            else
+              p = Protocol.new
+              decimal = raw_decimal.to_i
+              case data.size
+                when 3
+                  p.keyword = nil
+                  p.description = data[1]
+                  p.references = data[2]
+                else
+                  p.keyword = data[1]
+                  p.description = data[2]
+                  p.references = data[3]
+              end
+              protocols[decimal] = p
+            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,53 @@
+#!/usr/bin/env ruby
+
+# tld.rb
+# yesmar@speakeasy.net
+
+module IANA
+  module TLD
+    # load IANA TLD list from flat file:
+    # http://data.iana.org/TLD/tlds-alpha-by-domain.txt
+    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
+
+      tlds = []
+      updated = nil
+
+      begin
+        f = File.new(pathname, 'r')
+        while (line = f.gets)
+          line.chomp!
+    
+          if line =~ /^# Version \d{10}, Last Updated ([\w\W\d\s]*)$/
+            # extract update stamp
+            updated = $1
+            version,gunk= line.split(',')
+            version.sub!(/^# /, '')
+            updated.strip!
+          else
+            tlds << line.downcase!
+          end
+        end
+      ensure
+        f.close if !f.nil?
+      end
+
+      return tlds, updated, version
+    end
+
+    # is specified domain name a TLD?
+    def self.tld?(dn)
+      raise ArgumentError, 'nil dn' if dn.nil?
+      raise ArgumentError, 'invalid dn class' if dn.class != String
+      raise ArgumentError, 'empty dn' if dn.empty?
+
+      return IANA_TLD.include?(dn) ? true : false
+    end
+  end
+end
+
+raise RuntimeError, 'This library is for require only' if $0 == __FILE__

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: iana
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Ramsey Dow
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-02-25 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: yesmar @nospam@ speakeasy.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/iana.rb
+- lib/iana/port.rb
+- lib/iana/protocol.rb
+- lib/iana/tld.rb
+- examples/ports.rb
+- examples/protocols.rb
+- examples/tlds.rb
+- README
+has_rdoc: true
+homepage: http://iana.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: http://rubyforge.org/projects/iana/
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Ruby module which process flat files from IANA
+test_files: []
+