iana-data 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccc684f77c372ae813ac2a6d6618bf93fe23dc58
-  data.tar.gz: 0f77640e7ff7b7a4a443b61077293c4cae300aa9
+  metadata.gz: a732c3eecaaa5d69c11766b2566566cdb6b780ce
+  data.tar.gz: ad5edb9e28796712e1f675aa3c7d7b0ce0f5ee54
 SHA512:
-  metadata.gz: 2752d111927c4ccebb353e05dd67d06f31cf3f71b759bb50416e1f7d7ede11491388c352e7fb4c1dd4b46f8d739822a3117714bc27d97c02eac11c0de2a7ae39
-  data.tar.gz: e93ec9eb7e3a7a0d9d7501e5cd235fc64c8947962b4ff5bb5bc433a3a1bbb7ab76369715fe8805c9a2d20956908edd2f95a7efedddc34747d27b4e9e447841ab
+  metadata.gz: 087a3b8f4aee08a82c12e9395ab8cc4c09fc0d3728652fd319e2c70903597216768f93b3738a54c31847a5f9653fce623f13cecc6878c8b0a74c2f3cc272ca8b
+  data.tar.gz: f1f414f6e5d6a113b4a49b8288257c151134189e8c8b04f0c9918440dfd766c317a890baa32abd691ed8f2a18b8397f67edb5192aa00cf7da4c79b6263090406

data/Gemfile.lock

@@ -1,13 +1,17 @@
 PATH
   remote: .
   specs:
-    iana-data (1.1.2)
+    iana-data (1.1.3)
+      nokogiri (~> 1.6)
       open-uri-cached (= 0.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.2.5)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
     open-uri-cached (0.0.5)
     rake (10.5.0)
     rspec (3.4.0)
@@ -33,7 +37,7 @@ DEPENDENCIES
   iana-data!
   rake (~> 10.0)
   rspec (~> 3.0)
-  yard (~> 0.8, >= 0.8.7)
+  yard (~> 0.8)
 
 BUNDLED WITH
    1.11.2

data/README.md

@@ -1,5 +1,5 @@
 ## What
-IANA Ruby module version 1.1.2
+IANA Ruby module version 1.1.3
 
 Look up TCP/IP port numbers, protocols, top-level domains, et al.
 
@@ -8,25 +8,58 @@ available to your programs.
 
 ## Install
 
-    gem 'iana', github: 'ringe/iana'
+    gem install iana-data
+
+In your Gemfile
+
+    gem 'iana-data'
 
 ## Usage
 
 ```ruby
-  require 'iana'
+require 'iana'
+
+IANA::TLD.valid?("com")
+=> true
+IANA::TLD.valid?(".com")
+=> true
+IANA::TLD.valid?("isthisforreal")
+=> false
+
+prot = IANA::Protocol[25]
+=> #<IANA::Protocol:0x00563e8bdd18a8 @protocol=25, @name="LEAF-1", @description="Leaf-1", @references=["Barry_Boehm"]>
+prot.number
+=> 25
+
+port = IANA::Port[25]
+=> [#<IANA::Port:0x00556cba04b600 @port=25, @keyword="smtp", @protocol="tcp", @description="Simple Mail Transfer">, #<IANA::Port:0x00556cba04b1a0 @port=25, @keyword="smtp", @protocol="udp", @description="Simple Mail Transfer">]
+port.map(&:protocol)
+=> ["tcp", "udp"]
+
+IANA::Port.select port: 25, protocol: "udp"
+=> {25=>[#<IANA::Port:0x00556cba1f3d90 @port=25, @keyword="smtp", @protocol="udp", @description="Simple Mail Transfer">]}
+
+IANA::Port::DCCP[25]
+=> []
+IANA::Port::DCCP[8282]
+=> [#<IANA::Port:0x00556cb9bc7840 @port=8282, @keyword="", @protocol="dccp", @description="Reserved">]
+
+IANA::Port::UDP[443]
+=> [#<IANA::Port:0x00556cba1a43a8 @port=443, @keyword="https", @protocol="udp", @description="http protocol over TLS/SSL">]
+
 ```
 
+You still need to download some data files manually, while the IANA module is
+rewritten to make use of open-uri everywhere.
+
 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 -L -O http://www.iana.org/assignments/port-numbers
-    curl -L -O http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml
     curl -L -O http://www.iana.org/assignments/ethernet-numbers
 
-TLD data is downloaded automatically using open-uri, so no need to fetch yourself.
 
 ## Examples
 When you run the example programs, do it like so:

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iana"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/ports.rb

@@ -3,30 +3,11 @@
 # 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"
+require 'iana'
 
 # lookup port 22
 port = 22
-result = IANA_PORT[port]
+result = IANA::Port[port]
 puts "#{result.size} matches for port #{port}:"
 result.each do |p|
   puts "=> #{p.keyword} #{port}/#{p.protocol} \"#{p.description}\""

data/examples/protocols.rb

@@ -3,34 +3,10 @@
 # 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"
+require 'iana'
 
 # 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
+result = IANA::Protocol[22]
+puts "protocol 22 => #{result.name} \"#{result.description}\""
 
 exit 0

data/iana.gemspec

@@ -29,7 +29,8 @@ Gem::Specification.new do |spec|
   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_development_dependency 'yard', '~> 0.8'
 
   spec.add_dependency "open-uri-cached", "= 0.0.5"
+  spec.add_dependency "nokogiri", '~> 1.6'
 end

data/lib/iana/port.rb

@@ -5,74 +5,109 @@
 # lib/iana/port.rb
 
 module IANA
-  module Port
-    Port = Struct.new('PORT', :keyword, :protocol, :description)
+  class Port
+    attr_reader :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?
+    def initialize(port, keyword, protocol, description)
+      @port, @keyword, @protocol, @description = port, keyword, protocol, description
+    end
+
+    def port; @port; end
+    def number; @port; end
+    def keyword; @keyword; end
+    def protocol; @protocol; end
+    def description; @description; end
 
-      # TODO: better error checking for files with incorrect content
+    # Download IANA ports list in XML format, return list
+    # http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xml
+    def self.iana_list
+      source = open("http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.csv").
+        read
+
+      # concatenate multiline strings, then split on newline
+      lines = source.gsub(/(?<!\r)\n/, ' ').split(/\r\n/)
 
       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
+        while (line = lines.shift)
+          # skip lines which do not contain the ,proto, pattern
+          if line !~ /\d,(tcp|udp|sctp|dccp),/
             next
           end
 
-          # skip commented lines
-          next if line =~ /^#/
+          proto = line.split(/,(?=(?:[^"]|"[^"]*")*$)/)
+          name = proto[0]
+          num = proto[1].to_i
+          protocol = proto[2]
+          desc = proto[3]
 
-          # skip lines which do not contain the /{proto} pattern
-          if line !~ /\/tcp/ && line !~ /\/udp/ && line !~ /\/sctp/ && \
-            line !~ /\/dccp/
-              next
-          end
+          ports[num] ||= Array.new
+          ports[num] << Port.new(num, name, protocol, desc)
+        end
+      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
+      return ports
+    end
 
-          # remainder of tokens serves as the description
-          desc = tokens.join(' ')
+    # Look up port definition in iana_list by number
+    def self.[](num, protocol=nil)
+      raise ArgumentError, 'port number must be an Fixnum' if num.class != Fixnum
+      raise ArgumentError, 'protocol must be tcp, udp, sctp or dccp' unless [nil, 'tcp', 'udp', 'sctp', 'dccp'].include?(protocol)
 
-          p = Port.new(name, proto, desc)
+      if protocol.nil?
+        iana_list[num]
+      else
+        iana_list[num].select {|p| p.protocol == protocol }
+      end
+    end
 
-          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
+    # Select Ports by properties and values
+    def self.select(properties)
+      portlist = iana_list.collect do |num, ports|
+        list = ports.select do |p|
+          properties.collect {|key, val|
+            p.send(key) == val
+          }.all?
         end
-      ensure
-        f.close if !f.nil?
+        list.empty? ? nil : [num, list]
       end
+      Hash[*portlist.compact.flatten(1)]
+    end
+
+    # Methods to query IANA Ports within a namespace, like IANA::Port::TCP
+    class PortQuerying
+
+      # Return the Port's protocol name in lower case
+      def self.protocol
+        name.sub(/.*::/,'').downcase
+      end
+
+      # List all Ports by this protocol
+      def self.list
+        IANA::Port.select protocol: protocol
+      end
+
+      # Look up given Port number under this protocol
+      def self.[](num)
+        IANA::Port[num, protocol]
+      end
+    end
+
+    # Look up DCCP port definition in iana_list
+    class DCCP < PortQuerying
+    end
+
+    # Look up SCTP port definition in iana_list
+    class SCTP < PortQuerying
+    end
+
+    # Look up UDP port definition in iana_list
+    class UDP < PortQuerying
+    end
 
-      return ports, updated
+    # Look up TCP port definition in iana_list
+    class TCP < PortQuerying
     end
   end
 end

data/lib/iana/protocol.rb

@@ -8,22 +8,29 @@
 require 'nokogiri'
 
 module IANA
-  module Protocol
-    Protocol = Struct.new('PROTOCOL', :name, :description, :references)
+  class Protocol
+    attr_reader :protocol, :name, :description, :references
 
-    # load IANA protocols list from XML file:
+    def initialize(protocol, name, description, xref)
+      @protocol, @name, @description, @references = protocol, name, description, xref
+    end
+
+    def protocol; @protocol; end
+    def number; @protocol; end
+    def name; @name; end
+    def description; @description; end
+    def references; @references; end
+
+    # Download IANA protocols list in XML format, return list
     # 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?
+    def self.iana_list
+      source = open("http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xml").read
 
       protocols = {}
       updated = nil
 
       begin
-        f = File.new(pathname, 'r')
-        doc = Nokogiri::XML(f)
+        doc = Nokogiri::XML(source)
         updated = doc.css('registry/updated').text
         doc.css('registry/registry/record').each do |r|
           # range
@@ -51,19 +58,23 @@ module IANA
           end
 
           if low == high then
-            protocols[low] = Protocol.new(name, description, xref)
+            protocols[low] = Protocol.new(low, 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)
+              protocols[low+i] = Protocol.new(low+i, name, description, xref)
             end
           end
         end
-      ensure
-        f.close if !f.nil?
       end
 
-      return protocols, updated
+      return protocols
+    end
+
+    # Look up protocol definition in iana_list
+    def self.[](arg)
+      raise ArgumentError, 'protocol number must be an Fixnum' if arg.class != Fixnum
+      iana_list[arg]
     end
   end
 end

data/lib/iana/tld.rb

@@ -16,7 +16,7 @@ module IANA
 
     # is specified tld a valid IANA Top Level Domain?
     def self.valid?(tld)
-      iana_list.include?(tld.to_s.upcase)
+      iana_list.include?(tld.to_s.upcase.sub('.',''))
     end
 
     # is specified domain name a TLD?

data/lib/iana/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iana-data
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Runar Ingebrigtsen
@@ -60,9 +60,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -70,9 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: open-uri-cached
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +81,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: 
 email:
 - runar@rin.no,
@@ -102,6 +110,8 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - example-data/lsr.txt
 - examples/ethertypes.rb
 - examples/ports.rb