rspec-networking 0.0.1 → 0.1.1

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

@@ -0,0 +1,343 @@
+009EC8
+00C30A
+00EC0A
+04106B
+046761
+047A0B
+04AE47
+04B167
+04C807
+04CF8C
+04D13A
+04E598
+081C6E
+082525
+08B339
+0C07DF
+0C1DAF
+0C9838
+0CC6FD
+0CEDC8
+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
+285923
+286C07
+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
+64DDE9
+684DB6
+68ABBC
+68B8BB
+68C44C
+68DFDD
+6C0699
+6C0DC4
+6C483F
+6CF784
+70217F
+703A51
+705FA3
+709751
+70BBE9
+741575
+742344
+743822
+7451BA
+74F2FA
+7802F8
+7811DC
+785333
+789987
+78D840
+7C035E
+7C03AB
+7C0CF1
+7C1DD9
+7C2ADB
+7C49EB
+7CA449
+7CC294
+7CD661
+7CFD6B
+8035C1
+808F97
+80AD16
+80E63C
+844693
+84AEDE
+882F92
+884604
+8852EB
+886C60
+88B951
+88C397
+8C53C3
+8C5AF8
+8C7A3D
+8CAACE
+8CBEBE
+8CD0B2
+8CD9D6
+8CDEF9
+902AEE
+9078B2
+90FB5D
+941700
+94626D
+947BAE
+9487E0
+948B93
+94D331
+9812E0
+98171A
+987552
+98E081
+98EE94
+98F621
+98FAE3
+9C28F7
+9C2EA1
+9C5A81
+9C99A0
+9C9D7E
+9C9ED5
+9CBCF0
+A086C6
+A439B3
+A44519
+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
+BC6AD1
+BC7FA4
+C01693
+C05B44
+C40BCB
+C46940
+C46AB7
+C4710F
+C493BB
+C82832
+C83DDC
+C85CCC
+C8BF4C
+CC033D
+CC4210
+CC4D75
+CCB5D1
+CCD843
+CCDA20
+CCEB5E
+D09C7A
+D0AE05
+D0C1BF
+D0CEC0
+D41761
+D43538
+D4438A
+D4532A
+D45EEC
+D4970B
+D4A365
+D4DA21
+D4F0EA
+D832E3
+D86375
+D893D4
+D8B053
+D8CE3A
+D8E374
+D8EDA8
+DC6AE7
+DCB72E
+DCED83
+E01F88
+E06267
+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
+ECD09F
+ECFA5C
+F06C5D
+F0B429
+F41A9C
+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

@@ -0,0 +1,72 @@
+001349
+0019CB
+0023F8
+00A0C5
+042336
+04BF6D
+082697
+1071B3
+107BEF
+10C5FA
+143375
+14360E
+14C7C4
+1C740D
+28285D
+301577
+30BD13
+3CF75D
+404A03
+445E82
+4463C2
+48EDE6
+4C9EFF
+4CC53E
+5067F0
+50E039
+54833A
+588BF3
+5C648E
+5C6A80
+5CE28C
+5CF4AB
+603197
+64DD68
+6C4F89
+7049A2
+78C57D
+7C7716
+80EA0B
+88ACC0
+88F3D5
+8C5973
+909F22
+90EF68
+980D67
+A0E4CB
+B0B2DC
+B8D526
+B8ECA3
+BC7EC3
+BC9911
+BCCF4F
+C02E5F
+C49A31
+C83374
+C8544B
+C86C87
+CC5D4E
+D41AD1
+D43DF3
+D8912A
+D8ECE5
+E4186B
+E8377A
+EC3EB3
+EC43F6
+F08756
+F44D5C
+F80DA9
+FC22F4
+FC9F2A
+FCF528

data/lib/rspec/networking/mac_address.rb

@@ -1,26 +1,105 @@
-# https://en.wikipedia.org/wiki/MAC_address
+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
-  match do |actual|
-    @actual = actual
+  mac = RSpec::Networking::MacAddress
 
-    return false unless actual.is_a?(String)
+  chain :from do |manufacturer|
+    @manufacturer = manufacturer
 
-    hex = ['\h{2}'] * 5
-    actual.match?(/^\h{2}([:-])#{hex.join('\1')}$/)
+    @prefixes = if mac::HALF.match?(manufacturer.to_s)
+      Set[mac.normalize(manufacturer)]
+    else
+      RSpec::Networking::MANUFACTURERS.fetch(manufacturer.to_s.downcase.tr(" ", "_")) do
+        raise ArgumentError, "unknown manufacturer: #{manufacturer}"
+      end
+    end
   end
 
-  description do
-    "a MAC address"
+  chain :for do |device|
+    raise ArgumentError, "invalid device: #{device}" unless mac::HALF.match?(device.to_s)
+
+    @device = device
+    @suffix = mac.normalize(device)
+  end
+
+  chain :bits do |bits|
+    raise ArgumentError, "invalid bit length: #{bits}" unless [48, 64].include?(bits)
+
+    @bits = bits
+  end
+
+  chain :broadcast do
+    @broadcast = true
   end
 
-  failure_message do
-    "expected '#{@actual}' to be #{description}"
+  chain :unicast do
+    @cast = :unicast
   end
 
-  failure_message_when_negated do
-    "expected '#{@actual}' not to be #{description}"
+  chain :multicast do
+    @cast = :multicast
+  end
+
+  match do |actual|
+    return false unless actual.is_a?(String)
+
+    if mac::EUI64.match?(actual)
+      return false if @bits == 48
+
+      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 = mac.normalize(actual)
+    else
+      return false
+    end
+
+    return false if @broadcast && hex != "FF" * 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)
+
+    return false if @prefixes && !@prefixes.include?(hex[0, 6])
+    return false if @suffix && @suffix != hex[6, 6]
+
+    true
+  end
+
+  description do
+    [
+      "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

@@ -0,0 +1,10 @@
+require "set"
+
+module RSpec
+  module Networking
+    # 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.0.1"
+    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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rspec-networking
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Daniel Pepper
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-expectations
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,8 +79,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: RSpec matchers for IP and MAC Addresses
-email:
+description: RSpec matchers for IP and MAC addresses
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,13 +93,28 @@ files:
 - lib/rspec/networking.rb
 - lib/rspec/networking/ip_address.rb
 - lib/rspec/networking/mac_address.rb
+- lib/rspec/networking/mac_address/apple.txt
+- lib/rspec/networking/mac_address/eero.txt
+- lib/rspec/networking/mac_address/google.txt
+- lib/rspec/networking/mac_address/microsoft.txt
+- lib/rspec/networking/mac_address/nokia.txt
+- lib/rspec/networking/mac_address/oracle.txt
+- lib/rspec/networking/mac_address/sony.txt
+- lib/rspec/networking/mac_address/texas_instruments.txt
+- lib/rspec/networking/mac_address/toshiba.txt
+- lib/rspec/networking/mac_address/xerox.txt
+- lib/rspec/networking/mac_address/xiaomi.txt
+- lib/rspec/networking/mac_address/zyxel.txt
+- lib/rspec/networking/mac_address_manufacturers.rb
 - lib/rspec/networking/version.rb
 - rspec-networking.gemspec
+- script/update_manufacturers
 homepage: https://github.com/dpep/rspec-networking
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  changelog_uri: https://github.com/dpep/rspec-networking/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -116,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
-summary: RSpec::Networking
+summary: RSpec matchers for IP and MAC addresses
 test_files: []