maca 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354cde56cdb070aa38ceb4cca307d0bb1d4d2698a13f9694bbff5ee4f090088c
-  data.tar.gz: 63aea21d117ec506239c76457b3ab2c0aa498b18724b63f9b26d78eceb637c11
+  metadata.gz: 85373f80878aa63bce4ea371c64c5f3c41ad318f76b2eb72733d2c72b57794bf
+  data.tar.gz: fc31705f45c8209c33da8d9b8d5effb211c417b2fdf6ccbaf3330fdd5e8d9d90
 SHA512:
-  metadata.gz: 762d2de2dbb2df24df41aa278a04dcc66d1a104ae2e5a5bac23e76491f4f991c8b645ee7977806773eef254b40833a3b1a96ef107f15930475770c446b9853f4
-  data.tar.gz: cde0e4e55056e611b5b47a57fc99012e88fd58826a88e7d53ac3669c37e8058a45a1d6f3f7757fdfa951eb7162daaf8a662ed9c5c5c99d1d4b9511f68997829b
+  metadata.gz: d1bfca6661cba8b9b968f789003249d992db9c178970196611d7a40db12f87c88e8d2eabc9e9cc82882f280ad68e96b03ee8c92713b4ab06b354d620659ffacf
+  data.tar.gz: 54deb43cf21756b8d3e81d85557cfb9b6f95def0074edadcdea4f0f7b0c034648be1068eae84a9c8d18b44c1b008d2374f8f90f38b901eba2524da1ad12f4570

data/README.md

@@ -17,17 +17,30 @@ gem install maca
 ```
 
 ## Usage
+### Basic
+
+Create a new `Macaddress` object from a MAC Address in various formats.
 
 ```ruby
 require 'maca'
 
-Macaddress.new("00:00:00:00:00:00")
-=> #<Macaddress @macaddress="00:00:00:00:00:00">
+Macaddress.new("01:23:45:67:89:ab")
+=> #<Macaddress:0x000000012073db08 @macaddress="0123456789ab">
 
 Macaddress.new("01:23:45:67:89:ab").to_s
 => "01:23:45:67:89:AB"
 
-# Format normalization
+Macaddress.new("01:23:45:67:89:ab").to_i
+=> 1250999896491
+```
+
+### Format String
+
+**Format Normalization**
+
+Normalize various MAC Address notations (hyphenated, dot-separated, raw hex, etc.) into the standard colon-separated format.
+
+```ruby
 Macaddress.new("00-00-00-00-00-00").to_s
 => "00:00:00:00:00:00"
 
@@ -39,8 +52,22 @@ Macaddress.new("0000.0000.0000").to_s
 
 Macaddress.new("000000-000000").to_s
 => "00:00:00:00:00:00"
+```
+
+**Format Conversion**
+
+Convert the MAC Address to a custom string format using a specified delimiter and step size.
 
-# Comparison
+```ruby
+Macaddress.new("00-00-00-00-00-00").to_fs(delimiter: '.', step: 4)
+=> "0000.0000.0000"
+```
+
+### Comparison
+
+Compare `Macaddress` objects for equality based on their normalized form.
+
+```ruby
 Macaddress.new("00:00:00:00:00:00") == Macaddress.new("00:00:00:00:00:00")
 => true
 
@@ -48,6 +75,44 @@ Macaddress.new("00:00:00:00:00:00") == Macaddress.new("00:00:00:00:00:01")
 => false
 ```
 
+### Address type check
+
+Determine the type of a MAC address, such as whether it is unicast or multicast, and whether it is locally or universally administered.
+
+```ruby
+Macaddress.new("00:00:00:00:00:00").unicast?
+=> true
+
+Macaddress.new("00:00:00:00:00:00").broadcast?
+=> false
+
+Macaddress.new("33:33:00:00:00:01").multicast?
+=> true
+
+Macaddress.new("02:00:00:00:00:00").locally_administered?
+=> true
+
+Macaddress.new("01:00:00:00:00:00").universally_administered?
+=> true
+
+Macaddress.new("02:00:00:00:00:00").random?
+=> true
+```
+
+### OUI
+
+Extract the Organizationally Unique Identifier (OUI) from a MAC address.
+
+The `#oui` method returns the first 24 bits (or the first 3 octets) of a MAC Address, which typically identifies the device manufacturer or vendor.
+
+```ruby
+Macaddress.new("01:23:45:67:89:ab").oui # default format: :base16
+=> "012345"
+
+Macaddress.new("01:23:45:67:89:ab").oui(format: :hex)
+=> "01-23-45"
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/maca/macaddress.rb

@@ -2,22 +2,85 @@
 
 module Maca
   class Macaddress
-    REGEXP_MACADDRESS = /^([0-9A-Fa-f]{2}[:.-]?){5}([0-9A-Fa-f]{2})$/
+    DEFAULT_DELIMITER = ':'
+    DEFAULT_STEP = 2
+    DELIMITERS = ':.-'
+    REGEXP_LIST_MACADDRESS = [
+      /^([0-9A-Fa-f]{2}[#{DELIMITERS}]){5}([0-9A-Fa-f]{2})$/, # xx:xx:xx:xx:xx:xx
+      /^([0-9A-Fa-f]{4}[#{DELIMITERS}]){2}([0-9A-Fa-f]{4})$/, # xxxx:xxxx:xxxx
+      /^([0-9A-Fa-f]{6}[#{DELIMITERS}]){1}([0-9A-Fa-f]{6})$/, # xxxxxx:xxxxxx
+      /^([0-9A-Fa-f]{12})$/, # xxxxxxxxxxxx
+    ]
 
     def initialize(addr)
       if Maca::Macaddress.valid?(addr)
-        @macaddress = addr
+        @macaddress = addr.downcase.delete(DELIMITERS)
       else
         raise Maca::InvalidAddressError, "Invalid MAC Address #{addr}"
       end
     end
 
     def self.valid?(addr)
-      REGEXP_MACADDRESS.match?(addr)
+      REGEXP_LIST_MACADDRESS.each do |regexp_macaddress|
+        if regexp_macaddress.match?(addr)
+          return true
+        end
+      end
+
+      false
     end
 
     def to_s
-      @macaddress.upcase.gsub(/[-:.]/, '').scan(/.{1,2}/).join(':')
+      to_fs
+    end
+
+    def to_fs(delimiter: DEFAULT_DELIMITER, step: DEFAULT_STEP)
+      raise RangeError, "step must be even, and between 2 and 6" unless (2..6).cover?(step) && step.even?
+
+      @macaddress.upcase.scan(/.{1,#{step}}/).join(delimiter)
+    end
+    alias_method :to_formatted_s, :to_fs
+
+    def to_i
+      @macaddress.hex
+    end
+
+    def broadcast?
+      @macaddress == 'ff' * 6
+    end
+
+    def multicast?
+      (@macaddress[0..1].hex & 0x01).positive?
+    end
+
+    def unicast?
+      !multicast?
+    end
+
+    def locally_administered?
+      return false if broadcast?
+      (@macaddress[0..1].hex & 0x02).positive?
+    end
+
+    def universally_administered?
+      !locally_administered?
+    end
+
+    def random?
+      unicast? && locally_administered?
+    end
+
+    def oui(format: :base16)
+      oui = @macaddress[0..5]
+
+      # format: base 16 (xxxxxx)
+      if format.to_s == "base16"
+        return oui.upcase
+      end
+
+      # default format: hex (xx-xx-xx)
+      delimiter = "-"
+      oui.upcase.scan(/.{1,2}/).join(delimiter)
     end
 
     def ==(other)

data/lib/maca/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Maca
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maca
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Taketo Takashima