oui-offline 1.0.1 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef710b1686ae31c0fd80f1f364280b877b262a14
-  data.tar.gz: 97802c5b54fcfe26df0654382a5943b860292eef
+  metadata.gz: 670a47021f9dc5fa1acbe9ee700d34c47a177294
+  data.tar.gz: 3dab82300ccadb0429e3905300cea80ab0639cb4
 SHA512:
-  metadata.gz: 1c72a04ee773060a2d3923456a4fe50b3c467066a313262025b3b05ba7da40317754b1d7d51dbd51076fd283d942f28d6407c6eaefa1114f8ba48deac81d9142
-  data.tar.gz: edfd1c36ed5b737bd8a88136bcd00333752fef82e30b588ce71ec50c930d0a10b9119dbade4febb574c42a644f6d7f930ddb35e281ad2927791039458704c15e
+  metadata.gz: 539dc57d88c7b810a9b3d94dc746c1973003a888ba1428587f041e2a210033345affec1721f34af80891383903cf53a080783fee0d166bf3dab3751bbb01de75
+  data.tar.gz: 41a7b222ef78de1f7023761f5d6f84d72c6ab7ee875b8b1bfd2c54e0411bbf59528df5130e6fde0a20ec5062c24f793e76319c01befc0df0801414a381c079d9

data/README.md

@@ -1,17 +1,37 @@
+[![Build Status](https://travis-ci.org/steakknife/oui.svg)](https://travis-ci.org/steakknife/oui)
 # OUI (Organizationally Unique Identifiers)
+
+The 24-bit prefix of MAC / EUI-\* addresses.
+
+This is a Ruby library and CLI tool `oui`
+
 ## Usage
 
-    >OUI.find 'AA-BB-CC'
-    => nil
-    > OUI.find '00:0c:85'
-    => {
-                  :id => 3205,
-        :organization => "CISCO SYSTEMS, INC.",
-            :address1 => "170 W. TASMAN DRIVE",
-            :address2 => "M/S SJA-2",
-            :address3 => "SAN JOSE CA 95134-1706",
-             :country => "UNITED STATES"
-    }
+```ruby
+> OUI.find 'AA-BB-CC'
+=> nil
+> OUI.find '00:0c:85'
+=> {
+              :id => 3205,
+    :organization => "CISCO SYSTEMS, INC.",
+        :address1 => "170 W. TASMAN DRIVE",
+        :address2 => "M/S SJA-2",
+        :address3 => "SAN JOSE CA 95134-1706",
+         :country => "UNITED STATES"
+}
+```
+
+## CLI usage
+
+```text
+  Usage: oui lookup [options...] oui+     # get corp name, oui in 24-bit oui in hex format
+
+             -j JSON verbose output
+             -r Ruby verbose output
+             -y YAML verbose output
+
+         oui update                       # update oui internal db from ieee.org
+```
 
 ## Installation
 ### Gem (insecure installation)
@@ -31,7 +51,7 @@ See also: [waxseal](https://github.com/steakknife/waxseal)
 ### Bundler Installation
 
 ```ruby
-gem 'oui-offline', git: 'https://github.com/steakknife/oui.git'
+gem 'oui-offline'
 ```
 
 ### Manual Installation
@@ -47,9 +67,35 @@ gem 'oui-offline', git: 'https://github.com/steakknife/oui.git'
 
 `oui lookup ABCDEF`
 
-## Data
+## Data source
 
 Database sourced from the public IEEE list, but it can be rebuilt anytime by running `oui update` or `OUI.update_db`
+The few duplicates that are of multiple entities per OUI instead choose the first registration.
+
+## Unregistered OUIs
+
+Place custom/unregistered OUIs in `data/oui-manual.json` and re-run `oui update` or `OUI.update_db`.  Feel free to submit a PR to update these permanently.
+
+## Return format
+
+The `id` column is a stable, reversible conversion of the OUI as follows: the hexadecimal value of the OUI) to unsigned integer in network order (id).
+
+- Use `OUI.oui_to_i('aa-bb-cc')` to obtain an `id` from an OUI
+- Use `OUI.to_s(12345)` to do the inverse, obtain an OUI from an `id`
+
+## Supported Ruby Engines
+
+- JRuby
+- Ruby 1.9.3+ (until February 2015), 2.*
+
+## Tested Ruby Engines
+
+- JRuby 1.7.*
+- Ruby (MRI) 2.2.*
+
+## Thanks
+
+[Your name here]
 
 ## License
 

data/bin/oui

@@ -2,23 +2,51 @@
 lib_dir = File.expand_path('../../lib', __FILE__)
 $:.unshift lib_dir unless $:.include? lib_dir
 require 'oui'
+autoload :JSON, 'json'
+autoload :YAML, 'yaml'
+
+# TODO: OptParse || thor
+RUBY_OUTPUT = ARGV.delete '-v'
+JSON_OUTPUT = ARGV.delete '-j'
+YAML_OUTPUT = ARGV.delete '-y'
+
+def output(r)
+  put(if YAML_OUTPUT
+    YAML.dump r
+  elsif JSON_OUTPUT
+    JSON.dump r
+  elsif RUBY_OUTPUT
+    r
+  else
+    r[:organization]
+  end)
+end
 
-VERBOSE = ARGV.delete '-v'
 case ARGV.shift
 when 'lookup'
+  success = nil
+  formats = [RUBY_OUTPUT, JSON_OUTPUT, YAML_OUTPUT].count { |x| x };
+  fail 'Only one format flag is allowed' if formats > 1
   ARGV.map do |mac|
-    if r = OUI.find(mac)
-      puts (VERBOSE) ? r : r[:organization]
-    end
+    r = OUI.find(mac)
+    success &= !!r
+    output(r || {})
   end
+  exit 1 unless success
 
 when 'update'
   OUI.update_db
 
 else
   $stderr.puts <<-EOS
-  Usage: oui lookup oui+     # get corp name, oui in 24-bit oui in hex format
-         oui update          # update oui db from ieee.org
+  Usage: oui lookup [options...] oui+     # get corp name, oui in 24-bit oui in hex format
+  
+             -j JSON verbose output
+             -r Ruby verbose output
+             -y YAML verbose output
+
+         oui update                       # update oui internal db from ieee.org
+
 EOS
   exit 1
 end 

data/ext/mkrf_conf.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'rubygems/command'
+require 'rubygems/dependency_installer' 
+
+begin
+  Gem::Command.build_args = ARGV
+  $stderr.puts "ARGV=#{ARGV}"
+rescue NoMethodError
+end 
+
+inst = Gem::DependencyInstaller.new
+if RUBY_PLATFORM == 'java'
+  inst.install 'jdbc-sqlite3'
+else
+  inst.install 'sqlite3', '~> 1'
+end
+
+# create dummy rakefile to indicate success
+File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') do |f|
+  f.puts('task :default')
+end
+$stderr.puts 'Finished installing oui driver for sequel'

data/lib/oui.rb

@@ -31,20 +31,31 @@ module OUI
   # @return [Hash,nil]
   def find(oui)
     update_db unless table? && table.count > 0
-    table.where(id: oui_to_i(oui)).first
+    table.where(id: OUI.to_i(oui)).first
   end
 
   # Converts an OUI string to an integer of equal value
   # @param oui [String,Integer] MAC OUI in hexadecimal formats
   #                             hhhh.hh, hh:hh:hh, hh-hh-hh or hhhhhh
   # @return [Integer] numeric representation of oui
-  def oui_to_i(oui)
+  def to_i(oui)
     return oui if oui.is_a? Integer
     oui = oui.strip.gsub(/[:\- .]/, '')
     return unless oui =~ /[[:xdigit:]]{6}/
     oui.to_i(16)
   end
 
+  # Convert an id to OUI
+  # @param oui [String,nil] string to place between pairs of hex digits, nil for none
+  # @return [String] hexadecimal format of id
+  def to_s(id, sep = '-')
+    return id if id.is_a? String
+    unless id >= 0x000000 && id <= 0xFFFFFF
+      raise ArgumentError, "#{id} is not a valid 24-bit OUI"
+    end
+    format('%06x', id).scan(/../).join(sep)
+  end
+
   # Release backend resources
   def close_db
     @db = nil
@@ -54,6 +65,7 @@ module OUI
   # @return [Integer] number of unique records loaded
   def update_db
     ## Sequel
+    close_db
     drop_table
     create_table
     db.transaction do
@@ -78,12 +90,20 @@ module OUI
 
   def connect_file_db(f)
     FileUtils.mkdir_p(File.dirname(f))
-    Sequel.sqlite(f)
+    if RUBY_PLATFORM == 'java'
+      Sequel.connect('jdbc:sqlite:'+f) 
+    else
+      Sequel.sqlite(f)
+    end
   end
 
   def connect_db
     if IN_MEMORY_ONLY
-      Sequel.sqlite # in-memory sqlite database
+      if RUBY_PLATFORM == 'java'
+        Sequel.connect('jdbc:sqlite::memory:')
+      else 
+        Sequel.sqlite # in-memory sqlite database
+      end
     else
       debug "Connecting to db file #{LOCAL_DB}"
       connect_file_db LOCAL_DB
@@ -198,7 +218,7 @@ module OUI
       g = g.map { |k, v| [k.to_sym, v] }
       g = Hash[g]
       # convert OUI octets to integers
-      g[:id] = oui_to_i(g[:id])
+      g[:id] = OUI.to_i(g[:id])
       create_unless_present(g)
     end
   rescue Errno::ENOENT

data/oui-offline.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification::new do |s|
   s.name = 'oui-offline'
-  s.version = '1.0.1'
+  s.version = '1.2.3'
   s.platform = Gem::Platform::RUBY
   s.summary = 'Organizationally Unique Idenitfiers (OUI)'
   s.description = 'Organizationally Unique Idenitfiers (OUI) offline database'
@@ -12,6 +12,7 @@ Gem::Specification::new do |s|
  'bin/oui',
  'data/oui-manual.json',
  'db/oui.sqlite3',
+ 'ext/mkrf_conf.rb',
  'lib/oui.rb',
  'oui-offline.gemspec',
 ]
@@ -25,7 +26,9 @@ Gem::Specification::new do |s|
   s.homepage = 'https://github.com/steakknife/oui'
   s.post_install_message = 'Oui!'
 
-  s.add_dependency 'sqlite3', '>= 1.3', '< 2'
-  s.add_dependency 'sequel', '>= 4', '< 5'
+  s.add_dependency 'sequel', '~> 4'
+  s.extensions << 'ext/mkrf_conf.rb'
+  s.add_development_dependency 'rake', '~> 10'
+  s.add_development_dependency 'minitest', '~> 5'
 end
 .tap {|gem| pk = File.expand_path(File.join('~/.keys', 'gem-private_key.pem')); gem.signing_key = pk if File.exist? pk; gem.cert_chain = ['gem-public_cert.pem']} # pressed firmly by waxseal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oui-offline
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.3
 platform: ruby
 authors:
 - Barry Allard
@@ -41,53 +41,56 @@ cert_chain:
   TE/ChTQStrIVMKgW+FbU3E6AmrM6HcwTi7mwsDM8S36y2NZ5DVaZPCpvkiTDgPSW
   t/HWh1yhriCUe/y8+De8M87btOs=
   -----END CERTIFICATE-----
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: sequel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5'
 description: Organizationally Unique Idenitfiers (OUI) offline database
 email: barry.allard@gmail.com
 executables:
 - oui
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - Gemfile
@@ -95,6 +98,7 @@ files:
 - bin/oui
 - data/oui-manual.json
 - db/oui.sqlite3
+- ext/mkrf_conf.rb
 - lib/oui.rb
 - oui-offline.gemspec
 homepage: https://github.com/steakknife/oui