interfacez 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cd4cdba45bdc3c9ee5f65a733afdab9736e0a99b9f5f6cc56e2bff6e3f22392
-  data.tar.gz: ab510eaabb3e5cada57f4f10a827eb131386acd1335dafff22024bf575a565f9
+  metadata.gz: e3933043ffa46a19f9a456fe1c499a6d484a7a25ff5d08f31831f9badb10668a
+  data.tar.gz: f955df2c381771688e12a2cb013fc8c1af7cf1a0c598167b7e5cfe707b48edaf
 SHA512:
-  metadata.gz: dfb4a1c0c8ead706d0ada9427d695fd18c647a0b181699de62b3964a15a0407dfe1b41cddd7d96147e9986bf6e86a63ed7295c13ccccbb405057dc2983f8e0d9
-  data.tar.gz: 321405b666b65a6c4b377fb8783b73be700ab260307dd9ff217871e1beab4cf029216472b2d46c44ea1944a0e061241bd735787072b181894ee27eafd22692b7
+  metadata.gz: c18edcdf348bc9c38977cf7fbcaa001278094cbbe2e77bf4b7c610299f9343cee41dde69c54dc753c555d72b25b0317b392f4b90b0eb75d97e60e4e6f02626a2
+  data.tar.gz: 74eb55b9b86dad34452a5912179a3cc63bc7d8a4714605f3bda1cb42ce8d1e75b2764a93383f7653643bca70b21be885220b36165fc7389f56d2762ccc18af3b

data/.github/workflows/CI.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  schedule:
+  - cron: "0 9 * * *"
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    interfacez (1.0.0)
+    interfacez (1.0.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.3)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
       rspec-expectations (~> 3.7.0)
@@ -28,8 +28,8 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   interfacez!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/README.md

@@ -11,15 +11,18 @@
 require 'interfacez'
 
 Interfacez.default
-# => en0
+# => "en0"
 
 Interfacez.loopback
-# => lo0
+# => "lo0"
 
 Interfacez.all do |interface|
   # do something with interface name
   puts interface
 end
+
+Interfacez.ipv4_address_of("en0")
+# => "192.168.1.2"
 ```
 
 ## License

data/interfacez.gemspec

@@ -22,6 +22,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/interfacez/version.rb

@@ -1,3 +1,3 @@
 module Interfacez
-  VERSION = "1.0.0"
+  VERSION = "1.0.4"
 end

data/lib/interfacez.rb

@@ -19,6 +19,25 @@ module Interfacez
     Interfacez.ipv6_loopbacks { |iface| return iface }
   end
 
+  # Check for any (ipv4 or ipv6) loopback interface.
+  def self.loopback?
+    Interfacez.ipv4_loopbacks { |iface| return true }
+    Interfacez.ipv6_loopbacks { |iface| return true }
+    return false
+  end
+
+  # Get all (ipv4 or ipv6) loopback interfaces.
+  def self.loopbacks
+    if block_given?
+      Interfacez.ipv4_loopbacks { |iface| yield iface }
+      Interfacez.ipv6_loopbacks { |iface| yield iface }
+    else
+      loopbacks = []
+      Interfacez.loopbacks { |l| loopbacks << l unless loopbacks.any?(l) }
+      return loopbacks
+    end
+  end
+
   # First available ipv4 loopback interface.
   def self.ipv4_loopback
     Interfacez.ipv4_loopbacks { |iface| return iface }
@@ -26,13 +45,17 @@ module Interfacez
 
   # All ipv4 loopback interfaces.
   def self.ipv4_loopbacks
-    results = []
-    raw_interface_addresses.each do |iface| 
-      next unless iface.addr.ipv4_loopback?
-      yield iface.name if block_given?
-      results << iface.name
+    if block_given?
+      raw_interface_addresses.each do |iface| 
+        next unless iface.addr
+        next unless iface.addr.ipv4_loopback?
+        yield iface.name if block_given?
+      end
+    else
+      results = []
+      Interfacez.ipv4_loopbacks { |l| results << l }
+      return results 
     end
-    return results
   end
 
   # First available ipv6 loopback interface.
@@ -42,13 +65,17 @@ module Interfacez
 
   # All ipv6 loopback interfaces.
   def self.ipv6_loopbacks
-    results = []
-    raw_interface_addresses.each do |iface| 
-      next unless iface.addr.ipv6_loopback?
-      yield iface.name if block_given?
-      results << iface.name
+    if block_given?
+      raw_interface_addresses.each do |iface| 
+        next unless iface.addr
+        next unless iface.addr.ipv6_loopback?
+        yield iface.name if block_given?
+      end
+    else
+      results = []
+      Interfacez.ipv4_loopbacks { |l| results << l }
+      return results 
     end
-    return results
   end
 
   # All network interface names available on system. 
@@ -64,9 +91,11 @@ module Interfacez
 
   # Network interfaces with their ipv4 addresses, if they have
   # any asscoited with it.
-  def self.ipv4_addresses
+  def self.ipv4_addresses(interface = nil)
+    return ipv4_addresses_of(interface) unless interface.nil?
     results = Hash.new()
     raw_interface_addresses.each do |iface|
+      next unless iface.addr
       if iface.addr.ipv4?
         results[iface.name] = [] unless results[iface.name]
         results[iface.name] << iface.addr.ip_address
@@ -80,11 +109,25 @@ module Interfacez
     return results
   end
 
+  # Return all ipv4 addresses of a given interface.
+  def self.ipv4_address_of(interface)
+    addresses = Interfacez.ipv4_addresses[interface]
+    return nil if addresses.nil?
+    return addresses[0]
+  end
+
+  # Return the first ipv4 address of a given interface.
+  def self.ipv4_addresses_of(interface)
+    return Interfacez.ipv4_addresses[interface] || []
+  end
+
   # Network interfaces with their ipv6 addresses, if they have
   # any asscoited with it.
-  def self.ipv6_addresses
+  def self.ipv6_addresses(interface = nil)
+    return ipv6_addresses_of(interface) unless interface.nil?
     results = Hash.new()
     raw_interface_addresses.each do |iface|
+      next unless iface.addr
       if iface.addr.ipv6?
         results[iface.name] = [] unless results[iface.name]
         results[iface.name] << iface.addr.ip_address
@@ -98,6 +141,58 @@ module Interfacez
     return results
   end
 
+  # Return all available ipv6 addreses of a given interface.
+  def self.ipv6_addresses_of(interface)
+    return Interfacez.ipv6_addresses[interface] || []
+  end
+
+  # Return the first ipv6 address of a given interface.
+  def self.ipv6_address_of(interface)
+    addresses = Interfacez.ipv6_addresses_of(interface)
+    return nil if addresses.nil? 
+    return addresses[0]
+  end
+  
+  # Return first available mac addresses of a given interface.
+  def self.mac_address_of(interface)
+    list = Interfacez.mac_addresses_of(interface)
+    return nil if list.size.zero?
+    return list[0]
+  end
+  
+  # Return all available mac addresses of a given interface.
+  def self.mac_addresses_of(interface)
+    # BSD support
+    if Socket.const_defined? :PF_LINK
+      list = raw_interface_addresses.map! do |iface|
+        next unless iface.name == interface
+        next unless iface.addr
+        nameinfo = iface.addr.getnameinfo
+        if nameinfo.first != "" && nameinfo.last == ""
+          nameinfo[0]
+        end
+      end.compact
+    # Linux support
+    elsif Socket.const_defined? :PF_PACKET 
+      list = raw_interface_addresses.map! do |iface|
+        next unless iface.name == interface
+        next unless iface.addr
+        iface.addr.inspect_sockaddr[/hwaddr=([\h:]+)/, 1]
+      end.compact
+    else
+      warn "This platform may not be fully supported!"
+      return []
+    end
+  end
+  
+  # Get index of network interface.
+  def self.index_of(interface)
+    raw_interface_addresses.each do |iface|
+      return iface.ifindex if iface.name == interface
+    end
+    return nil
+  end
+
   # :nodoc:
   def self.raw_interface_addresses
     Socket.getifaddrs
@@ -105,4 +200,5 @@ module Interfacez
     warn "Unable to get raw interface address list from Socket class"
     return []
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interfacez
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Kent 'picat' Gruber
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,13 +52,14 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - kgruber1@emich.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/CI.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -78,7 +79,7 @@ homepage: https://github.com/picatz/interfacez
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Simplified network interface API
 test_files: []