louis 1.0.0

data/lib/louis/version.rb

@@ -0,0 +1,3 @@
+module Louis
+  VERSION = "1.0.0"
+end

data/lib/louis.rb

@@ -0,0 +1,90 @@
+require "louis/version"
+
+module Louis
+  OUI_FILE = File.expand_path(File.join(File.dirname(__FILE__), '..', 'data',
+    'mac_oui_manuf.txt'))
+
+  OUI_FORMAT_REGEX = /^(?<prefix>[0-9a-fA-F:\-]+)(\/(?<mask>(\d+)))?\s+(?<short_vendor>\S+)(\s+# (?<long_vendor>.+))?$/
+
+  # 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
+
+  # Search through the OUI lookup table and return all the entries in the
+  # lookup table that match the provided MAC.
+  #
+  # @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']) }
+  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(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
+  end
+
+  # Returns the name of the vendor that has the most specific prefix
+  # available in the OUI table or failing any matches will return "Unknown".
+  #
+  # @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'}
+
+    o.select { |k,_| %w(long_vendor short_vendor).include?(k) }
+  end
+
+  # Checks to see whether or not the MAC address has the provided prefix.
+  #
+  # @param [String] mac
+  # @param [Fixnum] prefix
+  # @param [Fixnum] mask
+  # @return [Boolean]
+  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

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'louis/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "louis"
+  spec.version       = Louis::VERSION
+  spec.authors       = ["Sam Stelfox"]
+  spec.email         = ["sstelfox@bedroomprogrammers.net"]
+  spec.summary       = %q{Library for looking up the the vendor associated with a MAC address.}
+  spec.description   = %q{There is a public registry maintained by the IANA that is required to be used by all vendors operating in certains spaces. Ethernet, Bluetooth, and Wireless device manufacturers are all assigned unique prefixes. This database is available publicly online and can be used to identify the manufacturer of these devices. This library provides an easy mechanism to perform these lookups.}
+  spec.homepage      = ""
+  spec.license       = "AGPLv3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "yard"
+end

data/spec/louis_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+RSpec.describe Louis do
+  it 'has a version number' do
+    expect(Louis::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+base_path = File.expand_path(File.join(File.basename(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(base_path) unless $LOAD_PATH.include?(base_path)
+
+require 'rspec'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+SimpleCov.add_filter "/spec/"
+SimpleCov.add_filter do |source_file|
+  source_file.lines.count < 3
+end
+
+SimpleCov.start
+
+require 'louis'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+    mocks.verify_doubled_constant_names = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 3
+  config.order = :random
+
+  Kernel.srand(config.seed)
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: louis
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sam Stelfox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: There is a public registry maintained by the IANA that is required to
+  be used by all vendors operating in certains spaces. Ethernet, Bluetooth, and Wireless
+  device manufacturers are all assigned unique prefixes. This database is available
+  publicly online and can be used to identify the manufacturer of these devices. This
+  library provides an easy mechanism to perform these lookups.
+email:
+- sstelfox@bedroomprogrammers.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- data/mac_oui_manuf.txt
+- lib/louis.rb
+- lib/louis/version.rb
+- louis.gemspec
+- spec/louis_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Library for looking up the the vendor associated with a MAC address.
+test_files:
+- spec/louis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: