rspec-networking 0.1.0 → 0.1.1

data/lib/rspec/networking/mac_address/toshiba.txt

@@ -1,14 +1,14 @@
+000039
+000600
 00080D
 000E7B
 0015B7
 001C7E
+002318
 005FBF
 20B780
-2318
 242FFA
 28FFB2
-39
-600
 6845F1
 78D6B2
 887384

data/lib/rspec/networking/mac_address/xerox.txt

@@ -1,14 +1,14 @@
-0
+000000
+000001
+000002
+000003
+000004
+000005
+000006
+000007
+000008
+000009
 0000AA
-1
-2
-3
-4
-5
-6
-7
-8
-80072
-9
+080072
 9C934E
 E84DEC

data/lib/rspec/networking/mac_address/xiaomi.txt

@@ -2,13 +2,17 @@
 00C30A
 00EC0A
 04106B
+046761
 047A0B
+04AE47
 04B167
 04C807
 04CF8C
 04D13A
 04E598
 081C6E
+082525
+08B339
 0C07DF
 0C1DAF
 0C9838
@@ -17,25 +21,33 @@
 0CF346
 102AB3
 103F44
+10C197
 1449D4
+14907A
 14993E
+14D881
 14F65A
 1801F1
 185936
 188740
 18F0E4
+1C2575
 1C2AB0
 1C8BEF
 1CCCD6
 1CEAAC
+2025CC
+203462
 2034FB
 203B34
 2047DA
 2072A9
 2082C0
+209952
 20A60C
 20F478
 241145
+246477
 24CF24
 24D337
 28167F
@@ -44,58 +56,83 @@
 28D127
 28E31F
 2C0B97
+2C0DCF
 2C195C
 2CD066
 2CFE4F
+3007EB
 3050CE
 341CF0
+343932
 3480B3
 34B98D
 34CE00
+34F015
+34FA1C
 38A4ED
+38C1ED
 38C6BD
 38E60A
 3C135A
 3C2CA6
 3C3824
+3C7F6E
 3CAFB7
 3CBD3E
 3CCD57
+400877
 40313C
 44237C
+444A37
+44579F
 447147
+44BDC8
+44CBAD
 44DF65
+44E213
 44F770
 482CA0
 488759
 48FDA3
 4C0220
 4C49E3
+4C55B2
 4C6371
+4C8E19
 4CC64C
 4CE0DB
+4CE20F
 4CF202
 503DC6
+504F3B
 50642B
 508811
+508E49
 508F4C
+50926A
 509839
 50A009
 50D2F5
 50DAD6
 50EC50
+50FE39
+5448E6
 582059
 584498
 58B623
 58EA1F
 5C0214
+5C4071
 5CD06E
 5CE50C
 606EE8
 60AB67
+60F723
 640980
+646306
 64644A
 6490C1
+649E31
 64A200
 64B473
 64CC2E
@@ -105,11 +142,14 @@
 68B8BB
 68C44C
 68DFDD
+6C0699
 6C0DC4
 6C483F
 6CF784
+70217F
 703A51
 705FA3
+709751
 70BBE9
 741575
 742344
@@ -123,6 +163,7 @@
 78D840
 7C035E
 7C03AB
+7C0CF1
 7C1DD9
 7C2ADB
 7C49EB
@@ -131,12 +172,16 @@
 7CD661
 7CFD6B
 8035C1
+808F97
 80AD16
-82525
+80E63C
 844693
+84AEDE
+882F92
 884604
 8852EB
 886C60
+88B951
 88C397
 8C53C3
 8C5AF8
@@ -150,9 +195,16 @@
 9078B2
 90FB5D
 941700
+94626D
 947BAE
+9487E0
 948B93
 94D331
+9812E0
+98171A
+987552
+98E081
+98EE94
 98F621
 98FAE3
 9C28F7
@@ -169,21 +221,31 @@ A44BD5
 A45046
 A45590
 A4A930
+A4BA70
+A4C3BE
+A4C788
 A4CCB3
 A4E287
+A4FF9F
+A82BD5
 A86A86
 A89CED
 AC1E9E
 AC8C46
 ACC1EE
+ACE4D8
 ACF7F3
+B00BE2
 B09C63
 B0E235
 B405A1
 B460ED
+B47E9F
 B4C4FC
 B83BCC
 B850D8
+B852E0
+B85384
 B894E7
 B8EA98
 BC6193
@@ -192,12 +254,15 @@ BC7FA4
 C01693
 C05B44
 C40BCB
+C46940
 C46AB7
+C4710F
 C493BB
 C82832
 C83DDC
 C85CCC
 C8BF4C
+CC033D
 CC4210
 CC4D75
 CCB5D1
@@ -206,9 +271,12 @@ CCDA20
 CCEB5E
 D09C7A
 D0AE05
+D0C1BF
 D0CEC0
 D41761
 D43538
+D4438A
+D4532A
 D45EEC
 D4970B
 D4A365
@@ -216,8 +284,11 @@ D4DA21
 D4F0EA
 D832E3
 D86375
+D893D4
 D8B053
 D8CE3A
+D8E374
+D8EDA8
 DC6AE7
 DCB72E
 DCED83
@@ -227,18 +298,24 @@ E0806B
 E0B655
 E0CCF8
 E0DCFF
+E41B43
 E44519
 E446DA
 E484D3
 E4AAE4
 E4BCAA
+E4D398
 E4DB6D
+E4FE43
 E84A54
 E85A8B
 E85FB4
+E87EEF
 E88843
 E89847
+E8BA17
 E8F791
+EC1055
 EC30B3
 EC4118
 EC4D3E
@@ -251,12 +328,16 @@ F4308B
 F460E2
 F48B32
 F4F5DB
+F843EF
 F8710C
+F88306
 F8A45F
 F8AB82
 FC0296
 FC1999
+FC4345
 FC5B8C
 FC64BA
 FCA9F5
+FCC17D
 FCD908

data/lib/rspec/networking/mac_address/zyxel.txt

@@ -1,18 +1,29 @@
+001349
 0019CB
 0023F8
 00A0C5
+042336
 04BF6D
+082697
 1071B3
-1349
+107BEF
+10C5FA
 143375
 14360E
+14C7C4
 1C740D
 28285D
+301577
+30BD13
+3CF75D
 404A03
+445E82
+4463C2
 48EDE6
 4C9EFF
 4CC53E
 5067F0
+50E039
 54833A
 588BF3
 5C648E
@@ -20,12 +31,14 @@
 5CE28C
 5CF4AB
 603197
+64DD68
+6C4F89
 7049A2
 78C57D
 7C7716
 80EA0B
-82697
 88ACC0
+88F3D5
 8C5973
 909F22
 90EF68
@@ -34,9 +47,12 @@ A0E4CB
 B0B2DC
 B8D526
 B8ECA3
+BC7EC3
 BC9911
 BCCF4F
-BEF 107.00
+C02E5F
+C49A31
+C83374
 C8544B
 C86C87
 CC5D4E
@@ -52,4 +68,5 @@ F08756
 F44D5C
 F80DA9
 FC22F4
+FC9F2A
 FCF528

data/lib/rspec/networking/mac_address.rb

@@ -1,34 +1,48 @@
-require 'rspec/networking/mac_address_manufacturers'
+require "rspec/networking/mac_address_manufacturers"
+
+module RSpec
+  module Networking
+    module MacAddress
+      # MM:MM:MM:SS:SS:SS, MM-MM-MM-SS-SS-SS, MMMM.MMSS.SSSS
+      EUI48 = /\A\h{2}([:-])(\h{2}\1){4}\h{2}\z|\A\h{4}(\.\h{4}){2}\z/
+
+      # MM:MM:MM:FF:FE:SS:SS:SS, MMMM:MMFF:FESS:SSSS
+      EUI64 = /\A\h{2}([:-])(\h{2}\1){6}\h{2}\z|\A\h{4}(:\h{4}){3}\z/
+
+      # half an EUI-48: MM:MM:MM or SS-SS-SS
+      HALF = /\A\h{2}([:-])\h{2}\1\h{2}\z/
+
+      def self.normalize(str)
+        str.delete(".:-").upcase
+      end
+    end
+  end
+end
 
 RSpec::Matchers.define :be_a_mac_address do
+  mac = RSpec::Networking::MacAddress
+
   chain :from do |manufacturer|
-    @manufacturer_str = manufacturer
+    @manufacturer = manufacturer
 
-    if manufacturer.match?(/^\h{2}([:-])\h{2}\1\h{2}$/) || manufacturer.match?(/^\h{3}\.\h{3}$/)
-      # exact match
-      @manufacturer = manufacturer.delete('.:-').upcase
+    @prefixes = if mac::HALF.match?(manufacturer.to_s)
+      Set[mac.normalize(manufacturer)]
     else
-      # manufacturer lookup
-      @manufacturer = manufacturer.to_s.downcase.tr(' ', '_')
-
-      unless RSpec::Networking::MANUFACTURERS.key?(@manufacturer)
+      RSpec::Networking::MANUFACTURERS.fetch(manufacturer.to_s.downcase.tr(" ", "_")) do
         raise ArgumentError, "unknown manufacturer: #{manufacturer}"
       end
     end
   end
 
   chain :for do |device|
-    unless device.match?(/^\h{2}([:-])\h{2}\1\h{2}$/) || device.match?(/^\h{3}\.\h{3}$/)
-      raise ArgumentError, "invalid device: #{device}"
-    end
+    raise ArgumentError, "invalid device: #{device}" unless mac::HALF.match?(device.to_s)
 
     @device = device
+    @suffix = mac.normalize(device)
   end
 
   chain :bits do |bits|
-    unless [ 48, 64 ].include?(bits)
-      raise ArgumentError, "invalid bit length: #{bits}"
-    end
+    raise ArgumentError, "invalid bit length: #{bits}" unless [48, 64].include?(bits)
 
     @bits = bits
   end
@@ -46,85 +60,46 @@ RSpec::Matchers.define :be_a_mac_address do
   end
 
   match do |actual|
-    @actual = actual
-
     return false unless actual.is_a?(String)
 
-    hex = nil
-
-    if actual.match?(/^\h{2}(:\h{2}){7}$/) || actual.match?(/^\h{4}(:\h{4}){3}$/)
-      # 64 bits
-      # 00:00:00:FF:FE:00:00:00
-      # 0000:00FF:FE00:0000
-
-      hex = actual.delete(':').upcase
-      return false unless hex.slice(6, 4) == 'FFFE'
+    if mac::EUI64.match?(actual)
       return false if @bits == 48
 
-      # normalize to 48 bits
-      hex.slice!(6, 4)
-    elsif actual.match?(/^\h{2}([:-])(\h{2}\1){4}\h{2}$/) || actual.match?(/^\h{3}(\.\h{3}){3}$/)
-      # 48 bits
-      # MM:MM:MM:SS:SS:SS
-      # MM-MM-MM-SS-SS-SS
-      # MMM.MMM.SSS.SSS
+      hex = mac.normalize(actual)
+      return false unless hex[6, 4] == "FFFE"
 
+      # normalize to 48 bits
+      hex = hex[0, 6] + hex[10, 6]
+    elsif mac::EUI48.match?(actual)
       return false if @bits == 64
 
-      hex = actual.delete('.:-').upcase
+      hex = mac.normalize(actual)
     else
       return false
     end
 
-    if @broadcast
-      return false unless hex == 'FF' * 6
-    end
-
-    if @cast
-      bit = @cast == :multicast ? 1 : 0
-
-      return false unless hex[1].to_i(16) & 1 == bit
-    end
-
-    matches = true
+    return false if @broadcast && hex != "FF" * 6
 
-    if @manufacturer
-      prefix = hex.slice(0, 6)
+    # the I/G bit: least significant bit of the first octet
+    return false if @cast && hex[0, 2].to_i(16).odd? != (@cast == :multicast)
 
-      matches &&= if @manufacturer_str.match?(/[.:-]/)
-        # exact match
-        prefix == @manufacturer
-      else
-        # manufacturer lookup
-        RSpec::Networking::MANUFACTURERS[@manufacturer].include?(prefix)
-      end
-    end
+    return false if @prefixes && !@prefixes.include?(hex[0, 6])
+    return false if @suffix && @suffix != hex[6, 6]
 
-    if @device
-      suffix = hex.slice(-6, 6)
-      matches &&= suffix == @device.delete('.:-').upcase
-    end
-
-    matches
+    true
   end
 
   description do
-    from_s = @manufacturer ? " from #{@manufacturer_str}" : ""
-    for_s = @device ? " for #{@device}" : ""
-    bits_s = @bits ? " with #{@bits} bits" : ""
-    broadcast_s = @broadcast ? " broadcast" : ""
-    cast_s = @cast ? " #{@cast}" : ""
-
-    "a MAC address#{bits_s}#{from_s}#{for_s}#{broadcast_s}#{cast_s}"
-  end
-
-  failure_message do
-    "expected '#{@actual}' to be #{description}"
-  end
-
-  failure_message_when_negated do
-    "expected '#{@actual}' not to be #{description}"
+    [
+      "be a",
+      ("broadcast" if @broadcast),
+      @cast,
+      "MAC address",
+      ("with #{@bits} bits" if @bits),
+      ("from #{@manufacturer}" if @manufacturer),
+      ("for #{@device}" if @device),
+    ].compact.join(" ")
   end
 end
 
-RSpec::Matchers.alias_matcher :a_mac_address, :be_a_mac_address
+RSpec::Matchers.alias_matcher(:a_mac_address, :be_a_mac_address) { |desc| desc.delete_prefix("be ") }

data/lib/rspec/networking/mac_address_manufacturers.rb

@@ -1,19 +1,10 @@
-require 'set'
+require "set"
 
 module RSpec
   module Networking
-    MANUFACTURERS = {
-      "xerox" => Set.new(['00:00:00'.delete(':')]),
-    }
-
-    # load manufacturers
-    Dir.glob("#{__dir__}/mac_address/*.txt").each do |file|
-      manufacturer = File.basename(file, '.txt').downcase
-
-      File.readlines(file).map(&:chomp).each do |entry|
-        MANUFACTURERS[manufacturer] ||= Set.new
-        MANUFACTURERS[manufacturer] << entry.upcase
-      end
-    end
+    # generated by script/update_manufacturers
+    MANUFACTURERS = Dir["#{__dir__}/mac_address/*.txt"].to_h do |file|
+      [File.basename(file, ".txt"), Set.new(File.readlines(file, chomp: true))]
+    end.freeze
   end
 end

data/lib/rspec/networking/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Networking
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/rspec-networking.gemspec

@@ -1,22 +1,25 @@
 require_relative "lib/rspec/networking/version"
-package = RSpec::Networking
-package_name = "rspec-networking"
 
 Gem::Specification.new do |s|
   s.authors     = ["Daniel Pepper"]
-  s.description = "RSpec matchers for IP and MAC Addresses"
+  s.description = "RSpec matchers for IP and MAC addresses"
   s.files       = `git ls-files * ':!:spec'`.split("\n")
-  s.homepage    = "https://github.com/dpep/#{package_name}"
+  s.homepage    = "https://github.com/dpep/rspec-networking"
   s.license     = "MIT"
-  s.name        = package_name
-  s.summary     = package.to_s
-  s.version     = package.const_get "VERSION"
+  s.name        = "rspec-networking"
+  s.summary     = "RSpec matchers for IP and MAC addresses"
+  s.version     = RSpec::Networking::VERSION
+
+  s.metadata = {
+    "changelog_uri" => "https://github.com/dpep/rspec-networking/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+  }
 
   s.required_ruby_version = ">= 3"
 
   s.add_dependency "rspec-expectations", ">= 3"
 
-  s.add_development_dependency "byebug"
+  s.add_development_dependency "debug"
   s.add_development_dependency "faker"
   s.add_development_dependency "rspec"
   s.add_development_dependency "simplecov"

data/script/update_manufacturers

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+# Regenerates lib/rspec/networking/mac_address/*.txt from the IEEE OUI registry.
+#
+# usage: script/update_manufacturers [path/to/oui.csv]
+
+require "csv"
+require "net/http"
+
+URL = "https://standards-oui.ieee.org/oui/oui.csv"
+DIR = File.expand_path("../lib/rspec/networking/mac_address", __dir__)
+
+# matched against the registry's "Organization Name"
+MANUFACTURERS = {
+  "apple" => /\AApple, Inc/,
+  "eero" => /\Aeero/i,
+  "google" => /\AGoogle/,
+  "microsoft" => /\AMicrosoft/i,
+  "nokia" => /\ANokia/,
+  "oracle" => /\AOracle/,
+  "sony" => /\ASony/i,
+  "texas_instruments" => /\ATexas Instruments/,
+  "toshiba" => /Toshiba/i,
+  "xerox" => /\AXerox/i,
+  "xiaomi" => /Xiaomi/i,
+  "zyxel" => /Zyxel/i,
+}
+
+csv = ARGV[0] ? File.read(ARGV[0]) : Net::HTTP.get(URI(URL))
+
+# only MA-L assignments are full 24-bit OUIs
+rows = CSV.parse(csv, headers: true).select { |row| row["Registry"] == "MA-L" }
+
+MANUFACTURERS.each do |name, pattern|
+  ouis = rows.select { |row| row["Organization Name"].to_s.strip.match?(pattern) }
+             .map { |row| row["Assignment"].upcase }
+             .sort
+             .uniq
+
+  abort "no OUIs found for #{name}" if ouis.empty?
+
+  File.write("#{DIR}/#{name}.txt", ouis.join("\n") + "\n")
+  puts "#{name}: #{ouis.size}"
+end