sys-host 0.5.2

data/CHANGES

@@ -0,0 +1,95 @@
+== 0.5.2 - 27-Jun-2006
+* Added the Host.info method for Linux.
+
+== 0.5.1 - 3-Mar-2006
+* The Host.info method is now supported on Solaris.
+* Moved project to RubyForge.
+* Replaced INSTALL with README.
+* Made documentation rdoc friendly.
+ 
+== 0.5.0 - 3-Jul-2004
+* Replaced Windows C extension with pure Ruby version, using WMI + OLE.
+* Added an additional class method called 'info' that returns a HostInfo
+  struct.  Currently on Windows only.
+* Removed the block form of Host.ip_addr. It now simply returns an Array.
+* Renamed and revamped test suite.
+* Moved test.rb to doc/examples
+* Removed the host.html file.
+* Replaced previous exception classes with a single exception class,
+  HostError, and moved it under the Sys module namespace.
+
+== 0.4.0 - 15-Jun-2003
+* Added MS Windows support
+* Modified extconf.rb file - generic test script now in its own file
+  (test/test.rb) and the dynamic rd2 stuff was removed, in addition to proper
+  handling for MS Windows
+* rd2, txt and html docs now included by default
+* Removed VERSION() class method (use the constant instead)
+* Added a universal constants.h file to store VERSION info, etc, that
+  is common to all source files.
+* Added LICENSE info
+
+== 0.3.4 - 3-Apr-2003
+* Fixed a header include issue for solaris systems that don't
+  define inet_ntop().
+
+== 0.3.3 * 24-Mar-2003
+* If inet_ntop() is not defined, now falls back to inet_ntoa().
+
+== 0.3.2 - 14-Mar-2003
+* Added a VERSION constant
+* Modified extconf.rb script, including a bugfix for solaris
+* Added a test suite (for those with testunit installed)
+* Removed the sys-uname requirement
+* Changelog and Manifest are now CHANGES and MANIFEST, respectively
+* Minor internal layout changes
+* rd2 documentation removed from C source files and put into 'doc'
+  directory
+
+== 0.3.1 - 6-Jan-2003
+* Fix to make code C89 compliant so that older compilers don't choke.
+* Added a VERSION class method
+* Added a copyright notice
+* Moved README into doc/host.txt
+* Minor doc changes
+* Fixed extconf.rb file to include socket lib for Solaris.  This was
+  in 0.2.0 and was mistakenly left out of 0.3.0.
+
+== 0.3.0 - 28-Oct-2002
+* Reentrant (thread-safe) support added for ip_addr() method (for Linux,
+  FreeBSD and Solaris currently).
+* The file layout changed so that each platform has its own source file.
+  This was done because different platforms have different implementations
+  of gethostbyname_r(), if they have them at all.  Some platforms (e.g.
+  FreeBSD) use a different function altogether.
+* The file generic.c is used to create the source if the platform is not
+  currently supported, or if gethostbyname_r() isn't found.
+* The FreeBSD implementation uses getipnodebyname() instead of
+  gethostbyname(), if possible.  According to the man page, it's thread
+  safe.
+* Modifications to the extconf.rb file based on the above changes.
+* Added a default value of 16 for INET_ADDRSTRLEN.
+* Added a README file.
+
+== 0.2.0 - 1-Sep-2002
+* Added HostException and HostAddressException classes.  These are raised
+  in the event the gethostname or gethostbyname call fails, respectively.
+* Removed some unnecessary (and warning-causing) free calls.
+* Added an INSTALL file (installation instructions removed from core doc).
+
+== 0.1.2 - 9-Aug-2002
+* Got the BSD support working properly this time.  Thanks to Sean
+  Chittenden for providing BSD access.
+
+== 0.1.1 - 21-Jun-2002
+* Fixed a bug that would cause the ip_addr to segfault on some
+  operating systems.  Apparently ,trying to free memory on a 
+  null pointer is a bad thing.  Hey, Solaris didn't complain!
+  Thanks go to Han Holl for the spot.
+* On *BSD systems the 'netinet/in.h' file is now included (via
+  the makefile).  Thanks go to Magnus Stahre for the spot and
+  the fix.
+* Changed the version number to be more "ruby compliant"
+
+== 0.01 * 11-Jun-2002
+* First release!

data/MANIFEST

@@ -0,0 +1,19 @@
+CHANGES
+MANIFEST
+INSTALL
+extconf.rb
+install.rb
+
+doc/host.txt
+
+doc/examples/test.rb
+
+ext/constants.h
+ext/freebsd.c
+ext/generic.c
+ext/linux.c
+ext/sunos.c
+
+lib/windows.rb
+
+test/tc_host.rb

data/README

@@ -0,0 +1,14 @@
+= Prerequisites
+Ruby 1.8.0 or later.
+Ruby 1.8.2 or later preferred on Windows.
+
+= Installation
+== Windows
+ruby test\tc_host.rb (optional)
+ruby install.rb
+
+== Unix
+ruby extconf.rb
+make
+ruby test/tc_host.rb (optional)
+make install

data/doc/host.txt

@@ -0,0 +1,88 @@
+== Description
+   Provides hostname and ip address information for a given host.
+    
+== Synopsis
+   require 'sys/host'
+   include Sys
+
+   p Host.hostname
+   p Host.ip_addr
+    
+   # Some platforms
+   Host.info{ |h|
+      p h
+   }
+
+== Constants
+VERSION
+    Returns the current version number of this package (as a string)
+    
+== Class Methods
+Host.hostname
+    Returns the hostname of the current host.  This may or not return
+    the FQDN, depending on your system.
+    
+Host.ip_addr
+   Returns a list of IP addresses for the current host (yes, it is
+   possible to have more than one).
+    
+Host.info(host=localhost)
+Host.info(host=localhost){ |h| ... }
+   Yields a HostInfo struct for each network adapter on 'host', or an array
+   of HostInfo struct's in non-block form.  The exact members of this struct
+   vary depending on your platform.
+    
+== Exception Classes
+HostError < StandardError
+   Raised in the event of a failure for any of the class methods provided
+   with this package.  Generally speaking, it means there was a failure in
+   the underlying gethostname() or gethostbyname() calls.
+    
+== Future Plans
+   Add support for IPV6.  This will be difficult unless I have access to a
+   system on an IPV6 network.  Any help on this front appreciated.
+    
+== Notes
+   The Windows version of this package uses OLE + WMI.  The Host.info method
+   returns considerably more information than the *nix versions of this
+   package.
+   
+== Comments and Questions
+   Please direct all comments and/or questions to one of the Forums on the
+   project home page at http://www.rubyforge.org/projects/sysutils.
+	
+== Known Bugs
+   None that I'm aware of.
+
+   Please log any bugs on the project home page at
+   http://www.rubyforge.org/projects/sysutils
+    
+== Acknowledgements
+   Thanks go to Mike Hall, Guy Decoux, and Matz for their help with
+   C extensions in general.
+
+   Thanks also go to Richard Stevens for his excellent Unix programming
+   books.
+    
+== License
+   Ruby's
+    
+== Copyright
+   Copyright 2002-2006, Daniel J. Berger, djberg96 at gmail dot com
+
+   All Rights Reserved. This module is free software. It may be used,
+   redistributed and/or modified under the same terms as Ruby itself.
+    
+== Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose.
+	
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (freenode)
+    
+== See Also
+   gethostbyname, gethostbyname_r, gethostname, hostname (Unix)
+   WMI, OLE (Windows)

data/ext/constants.h

@@ -0,0 +1,14 @@
+/* constants.h - one version to bind them all... */
+#define SYS_HOST_VERSION "0.5.2"
+
+#ifndef MAXHOSTNAMELEN
+#define MAXHOSTNAMELEN 256
+#endif
+
+#ifndef INET_ADDRSTRLEN
+#define INET_ADDRSTRLEN 16
+#endif
+
+#ifndef HOSTENT_BUF
+#define HOSTENT_BUF 8192
+#endif

data/ext/sunos.c

@@ -0,0 +1,236 @@
+/*****************************************************************
+ * sunos.c (host.c) - Solaris specific version
+ *
+ * Author: Daniel Berger
+ *****************************************************************/
+#include "ruby.h"
+#include "constants.h"
+#include <unistd.h>
+#include <netdb.h>
+
+#ifndef HAVE_INET_NTOP
+
+#ifndef _SYS_TYPES_H
+#include <sys/types.h>
+#endif
+
+#ifndef _SYS_SOCKET_H
+#include <sys/socket.h>
+#endif
+
+#ifndef _NETINET_IN_H
+#include <netinet/in.h>
+#endif
+
+#endif
+
+#include <arpa/inet.h>
+
+#define MAXBUF 2048
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+VALUE cHostError, sHostInfo;
+
+/*
+ * Sys::Host.hostname
+ *
+ * Returns the hostname of the current machine.
+ */
+static VALUE host_hostname()
+{
+   char host_name[MAXHOSTNAMELEN];
+
+   if(gethostname(host_name, sizeof(host_name)) != 0)
+      rb_raise(cHostError, "gethostname() call failed");
+
+   return rb_str_new2(host_name);
+}
+
+#ifdef HAVE_GETHOSTID
+/*
+ * Sys::Host.hostid
+ *
+ * Returns the host id of the current machine.
+ */
+static VALUE host_hostid(){
+   return ULL2NUM(gethostid());
+}
+#endif
+
+/*
+ * Sys::Host.ip_addr
+ *
+ * Returns an array of IP addresses associated with the current hostname.
+ */
+static VALUE host_ip_addr()
+{
+   char host_name[MAXHOSTNAMELEN];
+   struct hostent* hp;
+   VALUE v_addr = rb_ary_new();
+#ifndef HAVE_INET_NTOP
+   struct in_addr ipa;
+#endif
+
+   if(gethostname(host_name, sizeof(host_name)) != 0)
+      rb_raise(cHostError, "gethostname() call failed");
+
+#ifdef HAVE_GETHOSTBYNAME_R
+{
+   char buf[HOSTENT_BUF];
+   struct hostent hp_buf;
+   int err;
+   hp = gethostbyname_r(host_name, &hp_buf, buf, sizeof(buf), &err);
+}
+#else
+   hp = gethostbyname(host_name);
+#endif
+
+   if(!hp)
+      rb_raise(cHostError, "gethostbyname() call failed");
+
+#ifdef HAVE_INET_NTOP
+   char str[INET_ADDRSTRLEN];
+   while(*hp->h_addr_list){
+      rb_ary_push(
+         v_addr,
+         rb_str_new2(inet_ntop(hp->h_addrtype, *hp->h_addr_list, str, sizeof(str)))
+      );
+      *hp->h_addr_list++;
+   }
+#else
+   int n;
+   for(n = 0; hp->h_addr_list[n] != NULL; n++){
+      memcpy(&ipa.s_addr, hp->h_addr_list[n], hp->h_length);
+      rb_ary_push(rbResults, rb_str_new2(inet_ntoa(ipa)));
+   }
+#endif
+
+   return v_addr;
+}
+
+/*
+ * Sys::Host.info
+ * Sys::Host.info{ |i| ... }
+ *
+ * Yields a HostInfo struct containing various bits of information about
+ * the local machine for each entry in the hosts table.  In non-block form,
+ * returns an array of HostInfo structs.
+ *
+ * The Struct::HostInfo struct contains 5 fields:
+ *
+ * * name      (String)
+ * * aliases   (Array)
+ * * addr_type (Integer)
+ * * length    (Integer)
+ * * addr_list (Array)
+ */
+static VALUE host_info(VALUE klass){
+   VALUE v_hostinfo;
+   VALUE v_addr    = rb_ary_new();
+   VALUE v_array   = rb_ary_new();
+   VALUE v_aliases = rb_ary_new();
+
+   sethostent(0);
+
+#ifdef HAVE_GETHOSTENT_R
+   struct hostent host;
+   char buf[MAXBUF];
+   int err;
+
+   while(gethostent_r(&host, buf, sizeof(buf), &err)){
+      while(*host.h_aliases){
+         rb_ary_push(v_aliases, rb_str_new2(*host.h_aliases));
+         *host.h_aliases++;
+      }
+
+      while(*host.h_addr_list){
+         inet_ntop(host.h_addrtype, *host.h_addr_list, buf, sizeof(buf));
+         rb_ary_push(v_addr, rb_str_new2(buf));
+         *host.h_addr_list++;
+      }
+
+      v_hostinfo = rb_struct_new(sHostInfo,
+         rb_str_new2(host.h_name),
+         v_aliases,
+         INT2FIX(host.h_addrtype),
+         INT2FIX(host.h_length),
+         v_addr
+      );         
+#else
+   struct hostent* host;
+   char buf[INET_ADDRSTRLEN];
+
+   while((host = gethostent())){
+      while(*host->h_aliases){
+         rb_ary_push(v_aliases, rb_str_new2(*host->h_aliases));
+         *host->h_aliases++;
+      }
+
+      while(*host->h_addr_list){
+         inet_ntop(host->h_addrtype, *host->h_addr_list, buf, sizeof(buf));
+         rb_ary_push(v_addr, rb_str_new2(buf));
+         *host->h_addr_list++;
+      }
+
+      v_hostinfo = rb_struct_new(sHostInfo,
+         rb_str_new2(host->h_name),
+         v_aliases,
+         INT2FIX(host->h_addrtype),
+         INT2FIX(host->h_length),
+         v_addr
+      );         
+#endif
+
+      if(rb_block_given_p())
+         rb_yield(v_hostinfo);
+      else
+         rb_ary_push(v_array, v_hostinfo);
+
+      rb_ary_clear(v_aliases);   
+      rb_ary_clear(v_addr);
+   }      
+
+   endhostent();
+
+   if(rb_block_given_p())
+      return Qnil;
+
+   return v_array;
+}
+
+void Init_host()
+{
+   VALUE mSys, cHost;
+
+   /* Modules and Classes */
+   mSys  = rb_define_module("Sys");
+   cHost = rb_define_class_under(mSys, "Host", rb_cObject);
+
+   /* Constants */
+   rb_define_const(cHost, "VERSION", rb_str_new2(SYS_HOST_VERSION));
+
+   /* Structs */
+   sHostInfo = rb_struct_define("HostInfo", "name", "aliases", "addr_type",
+      "length", "addr_list", 0
+   );
+
+   /* Class Methods */
+   rb_define_singleton_method(cHost, "hostname", host_hostname, 0);
+   rb_define_singleton_method(cHost, "ip_addr", host_ip_addr, 0);
+   rb_define_singleton_method(cHost, "info", host_info, 0);
+
+#ifdef HAVE_GETHOSTID
+   rb_define_singleton_method(cHost, "hostid", host_hostid, 0);
+#endif
+
+   /* Exceptions */
+   cHostError = rb_define_class_under(mSys,"HostError",rb_eStandardError);
+}
+
+#ifdef __cplusplus
+}
+#endif

data/extconf.rb

@@ -0,0 +1,48 @@
+require "mkmf"
+require "ftools"
+
+# Remove any symlinks that may already exist
+File.delete('host.c') if File.exists?('host.c')
+File.delete('constants.h') if File.exists?('constants.h')
+
+have_func("gethostid")
+
+case RUBY_PLATFORM
+   when /freebsd/i
+      have_func("getipnodebyname")
+      File.symlink("ext/freebsd.c", "host.c")
+      File.symlink("ext/constants.h", "constants.h")
+   when /sunos|solaris/i
+      have_library("nsl")
+      have_library("socket")
+      have_func("gethostbyname_r", "netdb.h")
+      have_func("gethostent_r", "netdb.h")
+      File.symlink("ext/sunos.c", "host.c")
+      File.symlink("ext/constants.h", "constants.h")
+   when /linux/i
+      have_func("gethostbyname_r", "netdb.h")
+      have_func("gethostent_r", "netdb.h")
+      File.symlink("ext/linux.c", "host.c")
+      File.symlink("ext/constants.h", "constants.h")
+   when /win32|windows|dos|mingw|cygwin/i
+      STDERR.puts "Run the 'install.rb' script to install on Windows systems"
+   else
+      File.symlink("ext/generic.c", "host.c")
+      File.symlink("ext/constants.h", "constants.h")
+end
+
+# Rename the windows.rb file to prevent 'make install' from installing it
+unless RUBY_PLATFORM.match("mswin")
+   if File.exists?('lib/windows.rb')
+      File.rename('lib/windows.rb', 'lib/windows.orig')
+   end
+end
+
+have_func("inet_ntop")
+
+# Already grabbed this from netdb.h on Solaris
+unless RUBY_PLATFORM =~ /sunos|solaris/i
+   have_func("gethostent_r")
+end
+
+create_makefile("sys/host")

data/test/tc_host.rb

@@ -0,0 +1,63 @@
+#########################################
+# tc_host.rb
+#
+# Test suite for sys-host, all platforms
+#########################################
+base = File.basename(Dir.pwd)
+if base == "test" || base =~ /host.*/
+   require "ftools"
+   Dir.chdir("..") if base == "test"
+   Dir.mkdir("sys") unless File.exists?("sys")
+
+   if RUBY_PLATFORM.match("mswin")
+      File.copy("lib/windows.rb", "sys/host.rb")
+   else
+      case RUBY_PLATFORM
+         when /hpux/i
+            File.copy("host.sl","sys")
+         when /osx|darwin|mac/i
+            File.copy("host.bundle","sys")
+         else
+            File.copy("host.so","sys")
+      end
+   end
+
+   $LOAD_PATH.unshift Dir.pwd
+   Dir.chdir("test") rescue nil
+end
+
+require "sys/host"
+require "test/unit"
+include Sys
+
+class TC_Host < Test::Unit::TestCase
+   def test_version
+      assert_equal("0.5.2",Host::VERSION)
+   end
+
+   def test_hostname
+      assert_respond_to(Host, :hostname)
+      assert_nothing_raised{ Host.hostname }
+      assert_kind_of(String, Host.hostname)
+      assert_equal(`hostname`.chomp, Host.hostname) # sanity check
+   end
+
+   def test_ip_addr
+      assert_respond_to(Host, :ip_addr)
+      assert_nothing_raised{ Host.ip_addr }
+      assert_kind_of(Array, Host.ip_addr)
+   end
+
+   def test_info
+      if RUBY_PLATFORM =~ /mswin|solaris|linux/i
+         assert_respond_to(Host, :info)
+         assert_nothing_raised{ Host.info }
+         assert_kind_of(Array, Host.info)
+         assert_kind_of(Struct::HostInfo, Host.info.first)
+         assert_nil(Host.info{ })
+         assert_nothing_raised{ 1000.times{ Host.info } }
+      else
+         puts "The 'test_info' test was skipped on this platform"
+      end
+   end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: sys-host
+version: !ruby/object:Gem::Version 
+  version: 0.5.2
+date: 2006-06-30 00:00:00 -06:00
+summary: Provides hostname and ip address info for a given host
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/sysutils
+rubyforge_project: sysutils
+description: Provides hostname and ip address info for a given host
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Daniel J. Berger
+files: 
+- doc/host.txt
+- test/tc_host.rb
+- CHANGES
+- MANIFEST
+- README
+- extconf.rb
+- ext/constants.h
+- ext/sunos.c
+test_files: 
+- test/tc_host.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: []
+