oui-offline 1.2.3 → 1.2.5

data/lib/oui.rb

@@ -1,6 +1,8 @@
-require 'fileutils'
-require 'json'
+autoload :FileUtils, 'fileutils'
+autoload :JSON, 'json'
+require 'monitor'
 require 'open-uri'
+
 require 'sequel'
 
 # Organizationally Unique Identifier
@@ -9,29 +11,93 @@ module OUI
 
   private
 
+  DEBUGGING_DEFAULT = false
   TABLE = :ouis
   # import data/oui.txt instead of fetching remotely
-  IMPORT_LOCAL_TXT_FILE = false
+  IMPORT_LOCAL_TXT_FILE_DEFAULT = false
   # use in-memory instead of persistent file
-  IN_MEMORY_ONLY = false
-  LOCAL_DB = File.expand_path('../../db/oui.sqlite3', __FILE__)
-  LOCAL_MANUAL_FILE = File.expand_path('../../data/oui-manual.json', __FILE__)
-  if IMPORT_LOCAL_TXT_FILE
-    OUI_URL = File.join('data', 'oui.txt')
-  else
-    OUI_URL = 'http://standards.ieee.org/develop/regauth/oui/oui.txt'
-  end
+  IN_MEMORY_ONLY_DEFAULT = false
+  ROOT = File.expand_path(File.join('..', '..'), __FILE__)
+  LOCAL_DB_DEFAULT = File.join(ROOT, 'db', 'oui.sqlite3')
+  LOCAL_TXT_FILE = File.join(ROOT, 'data', 'oui.txt')
+  REMOTE_TXT_URI = 'http://standards.ieee.org/develop/regauth/oui/oui.txt'
+  LOCAL_MANUAL_FILE = File.join(ROOT, 'data', 'oui-manual.json')
   FIRST_LINE_INDEX = 7
   EXPECTED_DUPLICATES = [0x0001C8, 0x080030]
   LINE_LENGTH = 22
+  HEX_BEGINNING_REGEX = /\A[[:space:]]{2}[[:xdigit:]]{2}-/
+  ERASE_LINE = "\b" * LINE_LENGTH
+  BLANK_LINE = ' ' * LINE_LENGTH
+
+  MISSING_COUNTRIES = [
+    0x000052,
+    0x002142,
+    0x684CA8
+  ]
+
+  COUNTRY_OVERRIDES = {
+    0x000052 => 'UNITED STATES',
+    0x002142 => 'SERBIA',
+    0x684CA8 => 'CHINA'
+  }
 
   public
 
+  @@local_db = LOCAL_DB_DEFAULT
+
+  def local_db
+    @@local_db
+  end
+
+  def local_db=(v)
+    @@local_db = v || LOCAL_DB_DEFAULT
+  end
+
+
+  @@debugging = DEBUGGING_DEFAULT
+
+  def debugging
+    @@debugging
+  end
+
+  def debugging=(v)
+    @@debugging = (v.nil?) ? DEBUGGING_DEFAULT : v
+  end
+
+
+  @@import_local_txt_file = IMPORT_LOCAL_TXT_FILE_DEFAULT
+
+  def import_local_txt_file
+    @@import_local_txt_file
+  end
+
+  def import_local_txt_file=(v)
+    @@import_local_txt_file = (v.nil?) ? IMPORT_LOCAL_TXT_FILE_DEFAULT : v
+  end
+
+
+  @@in_memory_only = IN_MEMORY_ONLY_DEFAULT
+
+  def in_memory_only
+    @@in_memory_only
+  end
+
+  def in_memory_only=(v)
+    if v != @@in_memory_only
+      @@in_memory_only = (v.nil?) ? IN_MEMORY_ONLY_DEFAULT : v
+      close_db
+    end
+  end
+
   # @param oui [String,Integer] hex or numeric OUI to find
   # @return [Hash,nil]
   def find(oui)
-    update_db unless table? && table.count > 0
-    table.where(id: OUI.to_i(oui)).first
+    semaphore.synchronize do
+      update_db unless table? && table.count > 0
+      r = table.where(id: self.to_i(oui)).first
+      r.delete :create_table if r # not sure why this is here, but nuking it
+      r
+    end
   end
 
   # Converts an OUI string to an integer of equal value
@@ -41,8 +107,9 @@ module 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)
+    if oui =~ /([[:xdigit:]]{6})/
+      $1.to_i(16)
+    end
   end
 
   # Convert an id to OUI
@@ -56,62 +123,98 @@ module OUI
     format('%06x', id).scan(/../).join(sep)
   end
 
+  @@db = nil
   # Release backend resources
   def close_db
-    @db = nil
+    semaphore.synchronize do
+      debug 'Closing database'
+      if @@db 
+        @@db.disconnect
+        @@db = nil
+      end
+    end
+  end
+
+  def clear_table
+    debug 'clear_table'
+    table.delete_sql
   end
 
   # Update database from fetched URL
+  # @param [Boolean] whether to connect to the network or not
   # @return [Integer] number of unique records loaded
-  def update_db
-    ## Sequel
-    close_db
-    drop_table
-    create_table
-    db.transaction do
-      table.delete_sql
-      install_manual
-      install_updates
+  def update_db(local = nil, db_file = nil)
+    semaphore.synchronize do
+      debug "update_db(local = #{local}, db_file = #{db_file})"
+      close_db
+      old_import_local_txt_file = self.import_local_txt_file
+      self.import_local_txt_file = local
+      old_local_db = self.local_db
+      self.local_db = db_file
+      ## Sequel
+      debug '--- close db ---'
+      debug '--- close db ---'
+      debug '--- drop table ---'
+      drop_table
+#      debug '--- drop table ---'
+#      debug '--- create table ---'
+      create_table
+#      debug '--- create table ---'
+      db.transaction do
+        debug '--- clear table ---'
+        clear_table
+        debug '--- clear table ---'
+        debug '--- install manual ---'
+        install_manual
+        debug '--- install manual ---'
+        debug '--- install updates ---'
+        install_updates
+        debug '--- install updates ---'
+      end
+      debug '--- close db ---'
+      close_db
+      debug '--- close db ---'
+
+      self.local_db = old_local_db
+      self.import_local_txt_file = old_import_local_txt_file
+      ## AR
+      # self.transaction do
+      #   self.delete_all
+      #   self.install_manual
+      #   self.install_updates
+      # end
+      debug "update_db(local = #{local}, db_file = #{db_file}) finish"
     end
-    ## AR
-    # self.transaction do
-    #   self.delete_all
-    #   self.install_manual
-    #   self.install_updates
-    # end
   end
-
   
   private
 
-  HEX_BEGINNING_REGEX = /\A[[:space:]]{2}[[:xdigit:]]{2}-/
-  ERASE_LINE = "\b" * LINE_LENGTH
-  BLANK_LINE = ' ' * LINE_LENGTH
-
   def connect_file_db(f)
     FileUtils.mkdir_p(File.dirname(f))
     if RUBY_PLATFORM == 'java'
-      Sequel.connect('jdbc:sqlite:'+f) 
+      u = 'jdbc:sqlite:'+f
     else
-      Sequel.sqlite(f)
+      u = 'sqlite:'+f
     end
+    debug "Connecting to db file #{u}"
+    Sequel.connect(u)
   end
 
   def connect_db
-    if IN_MEMORY_ONLY
+    if in_memory_only
+      debug 'Connecting to in-memory 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
+      connect_file_db local_db
     end
   end
 
   def db
-    @db ||= connect_db
+    @@db ||= connect_db
   end
 
   def table?
@@ -123,10 +226,12 @@ module OUI
   end
 
   def drop_table
+    debug 'drop_table'
     db.drop_table(TABLE) if table? 
   end
 
   def create_table
+#    debug 'create_table'
     db.create_table TABLE do
       primary_key :id
       String :organization, null: false
@@ -164,18 +269,6 @@ module OUI
     g[1].split(' ')[0].to_i(16)
   end
 
-  MISSING_COUNTRIES = [
-    0x000052,
-    0x002142,
-    0x684CA8
-  ]
-
-  COUNTRY_OVERRIDES = {
-    0x000052 => 'UNITED STATES',
-    0x002142 => 'SERBIA',
-    0x684CA8 => 'CHINA'
-  }
-
   def parse_address1(g)
     g[2] if g.length >= 4
   end
@@ -208,23 +301,26 @@ module OUI
   end
 
   def fetch
-    debug "Fetching #{OUI_URL}"
-    open(OUI_URL).read
+    uri = oui_uri
+    $stderr.puts "Fetching #{uri}"
+    open(uri).read
   end
 
   def install_manual
+    debug 'install_manual'
     JSON.load(File.read(LOCAL_MANUAL_FILE)).each do |g|
       # convert keys to symbols
       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] = self.to_i(g[:id])
       create_unless_present(g)
     end
   rescue Errno::ENOENT
   end
 
   def install_updates
+    debug 'install_updates'
     lines = fetch.split("\n").map { |x| x.sub(/\r$/, '') } 
     parse_lines_into_groups(lines).each_with_index do |group, idx|
       create_from_line_group(group)
@@ -240,11 +336,23 @@ module OUI
 
   # Has a particular id been added yet?
   def added
-    @added ||= {}
+    @@added ||= {}
+  end
+
+  def debug?
+    $DEBUG || debugging || ENV['DEBUG_OUI']
   end
 
   def debug(*args)
-    $stderr.puts(*args) if $DEBUG
+    $stderr.puts(*args) if debug?
+  end
+
+  def debug_print(*args)
+    $stderr.print(*args) if debug?
+  end
+
+  def semaphore
+    @@semaphore ||= Monitor.new
   end
 
   def create_unless_present(opts)
@@ -259,4 +367,14 @@ module OUI
       added[id] = true
     end
   end
+
+  def oui_uri
+    if import_local_txt_file
+      debug 'oui_uri = local'
+      LOCAL_TXT_FILE
+    else
+      debug 'oui_uri = remote'
+      REMOTE_TXT_URI
+    end
+  end
 end

data/oui-offline.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification::new do |s|
   s.name = 'oui-offline'
-  s.version = '1.2.3'
-  s.platform = Gem::Platform::RUBY
+  s.version = '1.2.5'
   s.summary = 'Organizationally Unique Idenitfiers (OUI)'
   s.description = 'Organizationally Unique Idenitfiers (OUI) offline database'
   s.license = 'MIT'
@@ -12,10 +11,11 @@ Gem::Specification::new do |s|
  'bin/oui',
  'data/oui-manual.json',
  'db/oui.sqlite3',
- 'ext/mkrf_conf.rb',
  'lib/oui.rb',
  'oui-offline.gemspec',
-]
+  ]
+  s.files << 'data/oui.txt' if File.exist?('data/oui.txt')
+
   s.required_ruby_version = '>= 1.9.3'
 
   s.require_path = 'lib'
@@ -27,7 +27,13 @@ Gem::Specification::new do |s|
   s.post_install_message = 'Oui!'
 
   s.add_dependency 'sequel', '~> 4'
-  s.extensions << 'ext/mkrf_conf.rb'
+  if RUBY_PLATFORM == 'java'
+    s.platform = 'java'
+    s.add_dependency 'jdbc-sqlite3'
+  else
+    s.platform = Gem::Platform::RUBY
+    s.add_dependency 'sqlite3', '~> 1'
+  end
   s.add_development_dependency 'rake', '~> 10'
   s.add_development_dependency 'minitest', '~> 5'
 end

metadata

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