rspec-networking 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27e1529533844c6f359735dc609ecb1a937762787f2c609a147d4a30bdb700ee
-  data.tar.gz: 9c6856542b1477181e7b5ee82c39525e5295ed145e1a6edeaadfbd8feac6b500
+  metadata.gz: c23ab357e131d559918e6f06633477b8b7a6db590f90a13ab8337b53a2d2f1d3
+  data.tar.gz: 3de02a615ac9a9f49af41e648de4bd8782d2d702b753e9d29c0b7f477e28c92b
 SHA512:
-  metadata.gz: 0eb7ec667852a07380d2bc2344c04a175066b03ad86bfc5630f3b45f692555947e6ad02a505200fb73e76b0ff801214a684f19b2697baecf9bc52e941da5a326
-  data.tar.gz: 3a2521fe2955a92542c82e322d0f82eb602f8967aaf208e814f303586fd6de72cb42680b8f6df59dd3fa77fedceda74ce3292e656922e012c9f96ba40275a68e
+  metadata.gz: a40ebea318ce0a503558b3e62bc26e907d1f2da926ccb3b90ba78c2a86922fa43aca0cfe072be5853cb194e13ce6687f232dc07d444bde3dcdc48f2061e67255
+  data.tar.gz: d6802ad3a46dda23b9a7908657ab4d822b1dd994d50225f5b0c6f8f0edc1afc188eead8ab18fc9e0b5cd8da334171449e41f4d6ddc36c7f5c59a47232436ae2e

data/CHANGELOG.md

@@ -1,2 +1,7 @@
+###  0.1.0  (2024-08-31)
+- ip address
+- mac addresses
+- manufacturers
+
 ###  0.0.1  (2024-08-30)
 init

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-networking (0.0.1)
+    rspec-networking (0.1.0)
       rspec-expectations (>= 3)
 
 GEM

data/README.md

@@ -6,11 +6,52 @@ RSpec::Networking
 RSpec matchers for IP and MAC Addresses
 
 
+### Install
+```bash
+gem install rspec-networking
+```
+
+
+### Usage
+
 ```ruby
 require "rspec/networking"
+
+expect(obj).to be_an_ip_address
+
+# check version
+expect(obj).to be_an_ip_address.v4
+
+# check for localhost
+expect(obj).to be_an_ip_address.localhost
+
+# compose with other matchers
+expect(data).to include(addr: an_ip_address)
+
+
+
+###  match a MAC address  ###
+expect(obj).to be_a_mac_address
+
+expect(obj).to be_a_mac_address.broadcast
+expect(obj).to be_a_mac_address.multicast
+expect(obj).to be_a_mac_address.unicast
+
+# check manufacturer or specific device
+expect(obj).to be_a_mac_address.from("xerox")
+expect(obj).to be_a_mac_address.for(device)
+
+# compose with other matchers
+expect(data).to include(addr: a_mac_address)
 ```
 
 
+### Resources
+- https://en.wikipedia.org/wiki/IP_address
+- https://en.wikipedia.org/wiki/MAC_address
+- https://www.lifewire.com/introduction-to-mac-addresses-817937
+
+
 ----
 ## Contributing
 

data/lib/rspec/networking/ip_address.rb

@@ -0,0 +1,54 @@
+require "ipaddr"
+
+RSpec::Matchers.define :be_an_ip_address do
+  chain :v4 do
+    @version = 4
+  end
+
+  chain :v6 do
+    @version = 6
+  end
+
+  chain :localhost do
+    @localhost = true
+  end
+
+  match do |actual|
+    @actual = actual
+
+    return false unless actual.is_a?(String) || actual.is_a?(IPAddr)
+
+    addr = actual.is_a?(IPAddr) ? actual : IPAddr.new(actual)
+
+    if @version
+      return false unless @version == 4 ? addr.ipv4? : addr.ipv6?
+    end
+
+    if @localhost
+      return false unless addr.loopback?
+    end
+
+    true
+  rescue IPAddr::InvalidAddressError
+    false
+  end
+
+  description do
+    if @version
+      addr = @localhost ? "localhost " : "address"
+      "an IPv#{@version} #{addr}"
+    else
+      @localhost ? "a localhost" : "an IP address"
+    end
+  end
+
+  failure_message do
+    "expected '#{@actual}' to be #{description}"
+  end
+
+  failure_message_when_negated do
+    "expected '#{@actual}' not to be #{description}"
+  end
+end
+
+RSpec::Matchers.alias_matcher :an_ip_address, :be_an_ip_address