network_interface 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d0cb4999f24c11d163ca55348ddeabe91595407a8ca2440ea04c2c4f172e717
-  data.tar.gz: d1b2f9f5bec054bc222b77a2a19d72646c844151f9b0bfe2bf4a184d2a1dc90a
+  metadata.gz: 758a87463cdbf1569ad80a19c47a95e2c91e1eacb6cace97885d84cad09fd8a9
+  data.tar.gz: 6599981462fab25a7914b847f9ddbf42fabf7c260ad3501e3ab3441100e6a6ed
 SHA512:
-  metadata.gz: 0a3f59b944c17959dc30d92a86a8730c7993030fd93f8e7d9560d6e23d51b884c6232be64339660343950b80eb26fba5b5fc1d7dd24a94d0125f8d0e25c9afb3
-  data.tar.gz: 6f2b20d6e6314a4f86cc5c9cb82ff31bdea177737ff42d5f5457bc07749571a4ed576b72dbb18aed2a8889846ec0fabf1f8db9d72969ee0192d1a8622b0e69f7
+  metadata.gz: bf7eaade6035c18e9120a75c0eb86ab2303f9b7ea76f96f6e33b8e256874f854550144f3350309fb6291f2ddd1b78afda9269054c1f3c601ff910c1c6fdeac78
+  data.tar.gz: f5903780de195f98824f5ccdbbee8f749f21094d1885d1e1de5f7d0067ba1c65a3fba1c4ce820bddcf1a48a54ad47b597507bad9ad29bd290fa22a20add80737

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    network_interface (0.0.3)
+    network_interface (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # NetworkInterface
 
-TODO: Write a gem description
+A simple Ruby wrapper for accessing network interface information
 
 ## Installation
 
@@ -18,7 +18,75 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'network_interface'
+
+puts NetworkInterface.interfaces
+puts NetworkInterface.addresses('eth0')
+```
+
+## Development
+
+Compiling:
+
+```
+bundle install
+bundle exec rake clean
+bundle exec rake compile
+```
+
+Running the test suite, requires `ifconfig`/`ipconfig` to be installed:
+
+```
+bundle exec rspec
+```
+
+To debug with GDB:
+
+1. Optional: Explicitly add `asm("int3");` into the C code that you wish to have a breakpoint for:
+
+```c
+VALUE rb_cNetworkInterface;
+void
+Init_network_interface_ext()
+{
+    asm("int3");
+
+    // ...
+}
+```
+
+2. Compile and start GDB:
+
+```shell
+bundle exec rake compile
+gdb run --args ruby -e '$LOAD_PATH.unshift(File.join(Dir.pwd, "lib")); require("network_interface"); puts NetworkInterface.interfaces'
+```
+
+3. Add a runtime breakpoint:
+
+```shell
+(gdb) add-symbol-file ./lib/network_interface_ext.so
+Reading symbols from ./lib/network_interface_ext.so...
+
+(gdb) break Init_network_interface_ext
+Breakpoint 1 at 0x1850: file ../../../../ext/network_interface_ext/netifaces.c, line 825.
+
+(gdb) run
+Starting program: /usr/bin/ruby -e \$LOAD_PATH.unshift\(File.join\(Dir.pwd,\ \"lib\"\)\)\;\ require\(\"network_interface\"\)\;\ puts\ NetworkInterface.interfaces
+[Thread debugging using libthread_db enabled]
+Using host libthread_db library "/lib/x86_64-linux-gnu/libthread_db.so.1".
+
+Breakpoint 1.2, Init_network_interface_ext () at ../../../../ext/network_interface_ext/netifaces.c:825
+825             rb_cNetworkInterface = rb_define_module("NetworkInterface");
+(gdb)
+```
+
+To use a development build of this gem in another project, add this to the target project's `Gemfile`:
+
+```
+gem 'network_interface', path: '../network_interface'
+```
 
 ## Contributing
 

data/ext/network_interface_ext/netifaces.c

@@ -1,6 +1,9 @@
 #include "ruby.h"
 #include "netifaces.h"
 
+VALUE rb_cNetworkInterface;
+VALUE rb_cNetworkInterfaceError;
+
 #if !defined(WIN32)
 #if  !HAVE_GETNAMEINFO
 #undef getnameinfo
@@ -245,7 +248,7 @@ rbnetifaces_s_addresses (VALUE class, VALUE dev)
 
       if (!pAdapterInfo)
       {
-        rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+        rb_raise(rb_cNetworkInterfaceError, "Could not malloc ADAPTER_INFO");
         return Qnil;
     }
     }
@@ -256,7 +259,7 @@ rbnetifaces_s_addresses (VALUE class, VALUE dev)
   {
     if (pAdapterInfo)
       free (pAdapterInfo);
-    rb_raise(rb_eRuntimeError, "Unable to obtain adapter information.");
+    rb_raise(rb_cNetworkInterfaceError, "Unable to obtain adapter information via GetAdaptersInfo");
     return Qnil;
   }
 
@@ -347,7 +350,7 @@ rbnetifaces_s_addresses (VALUE class, VALUE dev)
 #elif HAVE_GETIFADDRS
   if (getifaddrs (&addrs) < 0)
   {
-    rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+    rb_raise(rb_cNetworkInterfaceError, "Unable to retrieve network interface info via getifaddrs");
     }
 
     for (addr = addrs; addr; addr = addr->ifa_next)
@@ -401,7 +404,7 @@ rbnetifaces_s_addresses (VALUE class, VALUE dev)
 
   if (sock < 0)
   {
-        rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+    rb_raise(rb_cNetworkInterfaceError, "Socket not created");
     return Qnil;
   }
 
@@ -530,7 +533,6 @@ rbnetifaces_s_addresses (VALUE class, VALUE dev)
     return Qnil;
 
 }
-
 VALUE
 rbnetifaces_s_interfaces (VALUE self)
 {
@@ -566,7 +568,7 @@ rbnetifaces_s_interfaces (VALUE self)
 
       if (!pAdapterInfo)
       {
-        rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+        rb_raise(rb_cNetworkInterfaceError, "Could not malloc ADAPTER_INFO");
       }
       }
     } while (dwRet == ERROR_BUFFER_OVERFLOW);
@@ -577,7 +579,7 @@ rbnetifaces_s_interfaces (VALUE self)
     if (pAdapterInfo)
       free (pAdapterInfo);
 
-      rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+      rb_raise(rb_cNetworkInterfaceError, "Unable to retrieve adapter info via GetAdaptersInfo");
       return Qnil;
   }
   if (dwRet == ERROR_NO_DATA)
@@ -606,7 +608,7 @@ rbnetifaces_s_interfaces (VALUE self)
 #elif HAVE_GETIFADDRS
   if (getifaddrs (&addrs) < 0)
   {
-    rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+    rb_raise(rb_cNetworkInterfaceError, "Unable to retrieve adapter info via getifaddrs");
   }
 
   for (addr = addrs; addr; addr = addr->ifa_next)
@@ -628,7 +630,7 @@ rbnetifaces_s_interfaces (VALUE self)
   fd = socket (AF_INET, SOCK_DGRAM, 0);
   len = -1;
   if (fd < 0) {
-    rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+    rb_raise(rb_cNetworkInterfaceError, "Error creating socket");
     return Qnil;
   }
 
@@ -661,7 +663,7 @@ rbnetifaces_s_interfaces (VALUE self)
 
   if (!ifc.CNAME(ifc_buf)) {
     close (fd);
-    rb_raise(rb_eRuntimeError, "Not enough memory");
+    rb_raise(rb_cNetworkInterfaceError, "Not enough memory");
     return Qnil;
     }
 
@@ -673,7 +675,7 @@ rbnetifaces_s_interfaces (VALUE self)
 #endif
     free (ifc.CNAME(ifc_req));
     close (fd);
-    rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+    rb_raise(rb_cNetworkInterfaceError, "Unable to calculate buffer size");
     return Qnil;
   }
 
@@ -724,7 +726,7 @@ rbnetifaces_s_interface_info (VALUE self, VALUE dev)
 
       if (!pAdapterInfo)
       {
-        rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+        rb_raise(rb_cNetworkInterfaceError, "Could not malloc ADAPTER_INFO");
       }
       }
     } while (dwRet == ERROR_BUFFER_OVERFLOW);
@@ -735,7 +737,7 @@ rbnetifaces_s_interface_info (VALUE self, VALUE dev)
     if (pAdapterInfo)
       free (pAdapterInfo);
 
-      rb_raise(rb_eRuntimeError, "Unknow error at OS level");
+      rb_raise(rb_cNetworkInterfaceError, "Unable to obtain adapter information via GetAdaptersInfo");
       return Qnil;
   }
   if (dwRet == ERROR_NO_DATA)
@@ -817,11 +819,11 @@ rbnetifaces_s_interface_info (VALUE self, VALUE dev)
   return result;
 }
 
-VALUE rb_cNetworkInterface;
 void
 Init_network_interface_ext()
 {
 	rb_cNetworkInterface = rb_define_module("NetworkInterface");
+	rb_cNetworkInterfaceError = rb_define_class_under(rb_cNetworkInterface, "Error", rb_eRuntimeError);
 	rb_define_module_function(rb_cNetworkInterface, "interfaces", rbnetifaces_s_interfaces, 0);
 	rb_define_module_function(rb_cNetworkInterface, "addresses", rbnetifaces_s_addresses, 1);
 	rb_define_module_function(rb_cNetworkInterface, "interface_info", rbnetifaces_s_interface_info, 1);

data/lib/network_interface/version.rb

@@ -1,3 +1,3 @@
 module NetworkInterface
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: network_interface
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Brandon Turner
@@ -94,7 +94,7 @@ cert_chain:
   EknWpNgVhohbot1lfVAMmIhdtOVaRVcQQixWPwprDj/ydB8ryDMDosIMcw+fkoXU
   9GJsSaSRRYQ9UUkVL27b64okU8D48m8=
   -----END CERTIFICATE-----
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake