rspec-networking 0.0.1 → 0.1.0

data/lib/rspec/networking/mac_address.rb

@@ -1,17 +1,121 @@
-# https://en.wikipedia.org/wiki/MAC_address
+require 'rspec/networking/mac_address_manufacturers'
 
 RSpec::Matchers.define :be_a_mac_address do
+  chain :from do |manufacturer|
+    @manufacturer_str = manufacturer
+
+    if manufacturer.match?(/^\h{2}([:-])\h{2}\1\h{2}$/) || manufacturer.match?(/^\h{3}\.\h{3}$/)
+      # exact match
+      @manufacturer = manufacturer.delete('.:-').upcase
+    else
+      # manufacturer lookup
+      @manufacturer = manufacturer.to_s.downcase.tr(' ', '_')
+
+      unless RSpec::Networking::MANUFACTURERS.key?(@manufacturer)
+        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
+
+    @device = device
+  end
+
+  chain :bits do |bits|
+    unless [ 48, 64 ].include?(bits)
+      raise ArgumentError, "invalid bit length: #{bits}"
+    end
+
+    @bits = bits
+  end
+
+  chain :broadcast do
+    @broadcast = true
+  end
+
+  chain :unicast do
+    @cast = :unicast
+  end
+
+  chain :multicast do
+    @cast = :multicast
+  end
+
   match do |actual|
     @actual = actual
 
     return false unless actual.is_a?(String)
 
-    hex = ['\h{2}'] * 5
-    actual.match?(/^\h{2}([:-])#{hex.join('\1')}$/)
+    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'
+      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
+
+      return false if @bits == 64
+
+      hex = actual.delete('.:-').upcase
+    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
+
+    if @manufacturer
+      prefix = hex.slice(0, 6)
+
+      matches &&= if @manufacturer_str.match?(/[.:-]/)
+        # exact match
+        prefix == @manufacturer
+      else
+        # manufacturer lookup
+        RSpec::Networking::MANUFACTURERS[@manufacturer].include?(prefix)
+      end
+    end
+
+    if @device
+      suffix = hex.slice(-6, 6)
+      matches &&= suffix == @device.delete('.:-').upcase
+    end
+
+    matches
   end
 
   description do
-    "a MAC address"
+    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

data/lib/rspec/networking/mac_address_manufacturers.rb

@@ -0,0 +1,19 @@
+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
+  end
+end

data/lib/rspec/networking/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-networking
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Daniel Pepper
@@ -95,6 +95,19 @@ 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
 homepage: https://github.com/dpep/rspec-networking
@@ -116,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: RSpec::Networking