louis 1.1.0 → 1.1.1

data/lib/louis/helpers.rb

@@ -0,0 +1,50 @@
+module Louis
+  module Helpers
+    # Calculate the bit mask for testing whether or not a mac_prefix matches.
+    # This returns an integer with the upper X bits set where X is the mask
+    # length.
+    #
+    # @param [String] prefix
+    # @param [String] mask
+    # @return [Fixnum]
+    def calculate_mask(prefix, mask)
+      mask_base = mask.nil? ? (clean_mac(prefix).length * 4) : mask.to_i
+      (2 ** 48 - 1) - (2 ** (48 - mask_base) - 1)
+    end
+
+    # Returns the hex representing a full or partial MAC address with the
+    # 'connecting' characters removed. Does nothing to ensure length.
+    #
+    # @param [String] mac
+    # @return [String]
+    def clean_mac(mac)
+      mac.gsub(/[:-]/, '')
+    end
+
+    # Converts a hexidecimal version of a full or partial (prefix) MAC address
+    # into it's integer representation.
+    #
+    # @param [String] mac
+    def mac_to_num(mac)
+      clean_mac(mac).ljust(12, '0').to_i(16)
+    end
+
+    # Handle parsing a line from the raw OUI file into it's associated lookup
+    # table format. This will return nil if the line is poorly formatted, empty
+    # or a comment.
+    #
+    # @param [String]
+    # @return [Hash<String=>Object>]
+    def line_parser(line)
+      return unless (matches = OUI_FORMAT_REGEX.match(line))
+      result = Hash[matches.names.zip(matches.captures)]
+
+      {
+        'mask'         => calculate_mask(result['prefix'], result['mask']),
+        'prefix'       => mac_to_num(result['prefix']),
+        'short_vendor' => result['short_vendor'],
+        'long_vendor'  => result['long_vendor']
+      }
+    end
+  end
+end

data/lib/louis/version.rb

@@ -1,3 +1,3 @@
 module Louis
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/lib/louis.rb

@@ -1,27 +1,11 @@
+require 'json'
+
 require 'louis/const'
+require 'louis/helpers'
 require 'louis/version'
 
 module Louis
-  # Calculate the bit mask for testing whether or not a mac_prefix matches.
-  # This returns an integer with the upper X bits set where X is the mask
-  # length.
-  #
-  # @param [String] prefix
-  # @param [String] mask
-  # @return [Fixnum]
-  def self.calculate_mask(prefix, mask)
-    mask_base = mask.nil? ? (clean_mac(prefix).length * 4) : mask.to_i
-    (2 ** 48 - 1) - (2 ** (48 - mask_base) - 1)
-  end
-
-  # Returns the hex representing a full or partial MAC address with the
-  # 'connecting' characters removed. Does nothing to ensure length.
-  #
-  # @param [String] mac
-  # @return [String]
-  def self.clean_mac(mac)
-    mac.gsub(/[:-]/, '')
-  end
+  extend Helpers
 
   # Search through the OUI lookup table and return all the entries in the
   # lookup table that match the provided MAC.
@@ -29,27 +13,13 @@ module Louis
   # @param [String] mac
   # @return [Array<Hash<String=>Object>>]
   def self.find_matches(mac)
-    @lookup_table.select { |m| mac_matches_prefix?(mac, m['prefix'], m['mask']) }
+    lookup_table.select { |m| mac_matches_prefix?(mac, m['prefix'], m['mask']) }
   end
 
   # Loads the lookup table, parsing out the uncommented non-blank lines into
   # objects we can compare MACs against to find their vendor.
-  def self.load_lookup_table
-    return if @lookup_table
-    @lookup_table = []
-
-    File.open(ORIGINAL_OUI_FILE).each_line do |line|
-      if (matches = OUI_FORMAT_REGEX.match(line))
-        result = Hash[matches.names.zip(matches.captures)]
-
-        @lookup_table.push({
-          'mask'         => calculate_mask(result['prefix'], result['mask']),
-          'prefix'       => mac_to_num(result['prefix']),
-          'short_vendor' => result['short_vendor'],
-          'long_vendor'  => result['long_vendor']
-        })
-      end
-    end
+  def self.lookup_table
+    @lookup_table ||= JSON.parse(File.read(Louis::PARSED_DATA_FILE))
   end
 
   # Returns the name of the vendor that has the most specific prefix
@@ -58,8 +28,6 @@ module Louis
   # @param [String] mac
   # @return [String]
   def self.lookup(mac)
-    load_lookup_table
-
     o = find_matches(mac).sort_by { |m| m['prefix'] }.first
     o ||= {'long_vendor' => 'Unknown', 'short_vendor' => 'Unknown'}
 
@@ -75,12 +43,4 @@ module Louis
   def self.mac_matches_prefix?(mac, prefix, mask)
     (mac_to_num(mac) & mask) == prefix
   end
-
-  # Converts a hexidecimal version of a full or partial (prefix) MAC address
-  # into it's integer representation.
-  #
-  # @param [String] mac
-  def self.mac_to_num(mac)
-    clean_mac(mac).ljust(12, '0').to_i(16)
-  end
 end

data/louis.gemspec

@@ -15,7 +15,10 @@ Gem::Specification.new do |spec|
   spec.homepage      = ""
   spec.license       = "AGPLv3"
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  file_list = `git ls-files -z`.split("\x0")
+  file_list.delete('data/mac_oui_manuf.txt')
+
+  spec.files         = file_list
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]

data/spec/louis_spec.rb

@@ -5,11 +5,15 @@ RSpec.describe Louis do
     expect(Louis::VERSION).not_to be nil
   end
 
-  it "it should have it's data file" do
+  it "it should have it's source data file" do
     expect(File.readable?(Louis::ORIGINAL_OUI_FILE)).to be(true)
   end
 
-  describe 'Format RegEx' do
+  it "it should have it's parsed data file" do
+    expect(File.readable?(Louis::PARSED_DATA_FILE)).to be(true)
+  end
+
+  describe 'Original OUI format regex' do
     subject { Louis::OUI_FORMAT_REGEX }
 
     it "should ignore comment lines" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: louis
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sam Stelfox
@@ -141,9 +141,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- data/mac_oui_manuf.txt
+- data/processed_data.json
 - lib/louis.rb
 - lib/louis/const.rb
+- lib/louis/helpers.rb
 - lib/louis/version.rb
 - louis.gemspec
 - spec/louis_spec.rb