louis 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b5383749d40c79dfcdfa4b3b3e598d39950b231
-  data.tar.gz: 5ad4b175cb613acbaa1ab0e204b1e5c2d3f8128c
+  metadata.gz: c504dde7be169053134a867e3d2c34cb86a2f75c
+  data.tar.gz: f97494bf3010114f5c6ada56d951faf4f5fb99f4
 SHA512:
-  metadata.gz: 8ff32ce290f6b88d7ed40f778a890cad0661719e1a5ad2269361dafaa2d4938718a1413f3414aff5feb407ab48dd1b8c7ab979714aa6c18d078dfe1463a34b32
-  data.tar.gz: cf8ec033daf39bc16ba1335decccbcecabf46d24a3ddab4df1a08399bcf9d3ba62d8978405694143ef54f28093a523d7e8d12397305c4d8b6b0cc2d3dcfa5345
+  metadata.gz: efb736393a05a7cd590e4967b97a155f7807ebd5c58e9f1497a937f82a03703a6c05a9526b15c6fdd5ccce3b1573ec3c7f9fde3d45fa012e99f7c68c951aa308
+  data.tar.gz: 85dc12268c91e3b2dd9d9a71fb01f7e2361a5b358a85ccd1860073adfca3b848d9196566e556301e8591dd73a276ec26f4265ee32594b29dd6009f55629fa55f

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.1.5

data/README.md

@@ -1,5 +1,12 @@
 # Louis
 
+[![Gem Version](https://badge.fury.io/rb/louis.svg)](http://badge.fury.io/rb/louis)
+[![Build Status](https://travis-ci.org/pwnieexpress/louis.svg?branch=master)](https://travis-ci.org/pwnieexpress/louis)
+[![Coverage Status](https://coveralls.io/repos/pwnieexpress/louis/badge.svg?branch=master)](https://coveralls.io/r/pwnieexpress/louis?branch=master)
+[![Dependency Status](https://gemnasium.com/pwnieexpress/louis.svg)](https://gemnasium.com/pwnieexpress/louis)
+[![Security](https://hakiri.io/github/pwnieexpress/louis/master.svg)](https://hakiri.io/github/pwnieexpress/louis/master)
+[![Code Climate](https://codeclimate.com/github/pwnieexpress/louis/badges/gpa.svg)](https://codeclimate.com/github/pwnieexpress/louis)
+
 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

data/Rakefile

@@ -1,5 +1,16 @@
 require "bundler/gem_tasks"
 
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end
+
+task :parse_data_file => [:environment] do
+end
+
 task :environment do
   base_path = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
   $LOAD_PATH.unshift(base_path) unless $LOAD_PATH.include?(base_path)

data/lib/louis.rb

@@ -1,11 +1,7 @@
-require "louis/version"
+require 'louis/const'
+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.
@@ -42,7 +38,7 @@ module Louis
     return if @lookup_table
     @lookup_table = []
 
-    File.open(OUI_FILE).each_line do |line|
+    File.open(ORIGINAL_OUI_FILE).each_line do |line|
       if (matches = OUI_FORMAT_REGEX.match(line))
         result = Hash[matches.names.zip(matches.captures)]
 

data/lib/louis/const.rb

@@ -0,0 +1,9 @@
+module Louis
+  ORIGINAL_OUI_FILE = File.expand_path(File.join(File.dirname(__FILE__), \
+    '..', '..', 'data', 'mac_oui_manuf.txt'))
+
+  PARSED_DATA_FILE = File.expand_path(File.join(File.dirname(__FILE__), \
+    '..', '..', 'data', 'processed_data.json'))
+
+  OUI_FORMAT_REGEX = /^(?<prefix>[0-9a-fA-F:\-]+)(\/(?<mask>(\d+)))?\s+(?<short_vendor>\S+)(\s+# (?<long_vendor>.+))?$/
+end

data/lib/louis/version.rb

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

data/louis.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "coveralls", "0.7.0"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rdoc"

data/spec/louis_spec.rb

@@ -4,4 +4,60 @@ RSpec.describe Louis do
   it 'has a version number' do
     expect(Louis::VERSION).not_to be nil
   end
+
+  it "it should have it's data file" do
+    expect(File.readable?(Louis::ORIGINAL_OUI_FILE)).to be(true)
+  end
+
+  describe 'Format RegEx' do
+    subject { Louis::OUI_FORMAT_REGEX }
+
+    it "should ignore comment lines" do
+      comment_line = "# This is just a sample of what a comment might look like"
+      expect(subject).to_not match(comment_line)
+    end
+
+    it "should ignore blank lines" do
+      expect(subject).to_not match("")
+    end
+  end
+
+  # The core of the whole library
+  describe '#lookup' do
+    let(:base_mac) { '00:12:34:00:00:00' }
+    let(:partial_mac) { '3c:97:0e' }
+    let(:unknown_mac) { 'c5:00:00:00:00:00' }
+
+    it 'should return a hash' do
+      expect(Louis.lookup(base_mac)).to be_a(Hash)
+    end
+
+    it 'should have both the long vendor and short vendor' do
+      expect(Louis.lookup(base_mac).keys).to eq(['short_vendor', 'long_vendor'])
+    end
+
+    it 'should be able to identify the short vendor of a full MAC' do
+      expect(Louis.lookup(base_mac)['short_vendor']).to eq('CamilleB')
+    end
+
+    it 'should be able to identify the long vendor of a full MAC' do
+      expect(Louis.lookup(base_mac)['long_vendor']).to eq('Camille Bauer')
+    end
+
+    it 'should be able to identify the short vendor of a partial MAC' do
+      expect(Louis.lookup(partial_mac)['short_vendor']).to eq('WistronI')
+    end
+
+    it 'should be able to identify the long vendor of a patrial MAC' do
+      expect(Louis.lookup(partial_mac)['long_vendor']).to eq('Wistron InfoComm(Kunshan)Co.,Ltd.')
+    end
+
+    it 'should return "Unknown" as the short vendor string for unknown MAC prefixes' do
+      expect(Louis.lookup(unknown_mac)['short_vendor']).to eq('Unknown')
+    end
+
+    it 'should return "Unknown" as the long vendor string for unknown MAC prefixes' do
+      expect(Louis.lookup(unknown_mac)['long_vendor']).to eq('Unknown')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -3,8 +3,13 @@ $LOAD_PATH.unshift(base_path) unless $LOAD_PATH.include?(base_path)
 
 require 'rspec'
 require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
 
-SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
 SimpleCov.add_filter "/spec/"
 SimpleCov.add_filter do |source_file|
   source_file.lines.count < 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: louis
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sam Stelfox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,7 @@ files:
 - Rakefile
 - data/mac_oui_manuf.txt
 - lib/louis.rb
+- lib/louis/const.rb
 - lib/louis/version.rb
 - louis.gemspec
 - spec/louis_spec.rb