sys-host 0.6.1 → 0.6.2

data/CHANGES

@@ -1,3 +1,14 @@
+== 0.6.2 - 20-Mar-2010
+* Changed license to Artistic 2.0.
+* The Host.host_id method has been modified to return a hex value on MS
+  Windows in order to be consistent with other platforms.
+* Some internal directory layout changes and corresponding changes to the
+  Rakefile.
+* Additional Rakefile tasks that remove the need for some code that was
+  previously inlined into the gemspec directly.
+* Updated the gemspec, including an updated description, the addition of a
+  license, and changing test-unit to a development dependency.
+
 == 0.6.1 - 18-Nov-2008
 * Added the host_id method for Windows, which just returns the MAC address.
 * Fixed an issue in the Host.ip_addr method for MS Windows where multiple ip

data/MANIFEST

@@ -4,12 +4,14 @@
 * Rakefile
 * sys-host.gemspec
 * doc/host.txt
-* examples/host_test.rb
-* ext/constants.h
-* ext/extconf.rb
-* ext/bsd/bsd.c
-* ext/generic/generic.c
-* ext/linux/linux.c
-* ext/sunos/sunos.c
-* lib/sys/windows.rb
+* examples/example_sys_host.rb
+* ext/bsd/extconf.rb
+* ext/bsd/sys/host.c
+* ext/generic/extconf.rb
+* ext/generic/sys/host.c
+* ext/linux/extconf.rb
+* ext/linux/sys/host.c
+* ext/sunos/extconf.rb
+* ext/sunos/sys/host.c
+* lib/windows/sys/host.rb
 * test/test_sys_host.rb

data/Rakefile

@@ -1,78 +1,169 @@
 require 'rake'
-require 'rake/clean'
 require 'rake/testtask'
 require 'rbconfig'
 include Config
 
 desc "Clean the build files for the sys-host source for UNIX systems"
 task :clean do
-   Dir.chdir('ext') do
-      unless RUBY_PLATFORM.match('mswin')
-         sh 'make distclean' if File.exists?('host.o')
-         FileUtils.rm_rf('host.c') if File.exists?('host.c')
-         FileUtils.rm_rf('sys') if File.exists?('sys')
+  rm_rf('.test-result') if File.exists?('.test-result')
+  rm_rf 'conftest.dSYM' if File.exists?('conftest.dSYM') # OS X
+
+  Dir['*.gem'].each{ |f| File.delete(f) }
+   
+  case Config::CONFIG['host_os']
+    when /bsd|darwin/i
+      dir = 'ext/bsd'
+    when /sunos|solaris/i
+      dir = 'ext/sunos'
+    when /linux/i
+      dir = 'ext/linux'
+    else
+      dir = 'ext/generic'
+  end
+
+  unless Config::CONFIG['host_os'] =~ /win32|mswin|dos|cygwin|mingw/i
+     Dir.chdir(dir) do
+      if Dir['*.o'].length > 0
+        sh 'make distclean'
+        Dir['sys/host.*'].each{ |f| rm(f) if File.extname(f) != '.c' }
       end
-   end
-   FileUtils.rm_rf('sys') if File.exists?('sys')
+    end
+  end
 end
 
-desc "Build the sys-host package on UNIX systems (but don't install it)"
+desc "Build the sys-host library on UNIX systems (but don't install it)"
 task :build => [:clean] do
-   Dir.chdir('ext') do
+  case Config::CONFIG['host_os']
+    when /bsd|darwin/i
+      dir = 'ext/bsd'
+    when /sunos|solaris/i
+      dir = 'ext/sunos'
+    when /linux/i
+      dir = 'ext/linux'
+    else
+      dir = 'ext/generic'
+  end
+
+  unless Config::CONFIG['host_os'] =~ /win32|mswin|dos|cygwin|mingw/i
+    Dir.chdir(dir) do
       ruby 'extconf.rb'
       sh 'make'
-      build_file = 'host.' + Config::CONFIG['DLEXT']
-      Dir.mkdir('sys') unless File.exists?('sys')
-      FileUtils.cp(build_file, 'sys')
-   end
+      cp 'host.' + Config::CONFIG['DLEXT'], 'sys'
+    end
+  end
 end
 
-desc "Run the example program"
-task :example => [:build] do
-   ruby 'host_test.rb'
-end
+desc 'Install the sys-host library'
+task :install => [:build] do
+  file = nil
+  dir  = File.join(Config::CONFIG['sitelibdir'], 'sys')
 
-if CONFIG['host_os'].match('mswin')
-   desc "Install the sys-host package (non-gem)"
-   task :install do
-      install_dir = File.join(CONFIG['sitelibdir'], 'sys')
-      install_file = File.join(install_dir, 'host.rb')
-      Dir.mkdir(install_dir) unless File.exists?(install_dir)
-      FileUtils.cp('lib/sys/windows.rb', install_file, :verbose => true)
-   end
-else
-   desc "Install the sys-host package (non-gem)"
-   task :install => [:build] do
-      Dir.chdir('ext') do
-         sh 'make install'
-      end
-   end
+  Dir.mkdir(dir) unless File.exists?(dir)
+
+  case Config::CONFIG['host_os']
+    when /mswin|win32|msdos|cygwin|mingw/i
+      file = 'lib/windows/sys/host.rb'
+    when /bsd|darwin/i
+      Dir.chdir('ext/bsd'){ sh 'make install' }
+    when /sunos|solaris/i
+      Dir.chdir('ext/sunos'){ sh 'make install' }
+    when /linux/i
+      Dir.chdir('ext/linux'){ sh 'make install' }
+    else
+      Dir.chdir('ext/generic'){ sh 'make install' }
+  end
+
+  cp(file, dir, :verbose => true) if file
 end
 
-desc "Install the sys-host package as a gem"
-task :install_gem do
-   ruby 'sys-host.gemspec'
-   file = Dir["sys-host*.gem"].last
-   sh "gem install #{file}"
+desc 'Uninstall the sys-host library'
+task :uninstall do
+  case Config::CONFIG['host_os']
+    when /win32|mswin|dos|cygwin|mingw/i
+      dir  = File.join(Config::CONFIG['sitelibdir'], 'sys')
+      file = File.join(dir, 'host.rb')
+    else
+      dir  = File.join(Config::CONFIG['sitearchdir'], 'sys')
+      file = File.join(dir, 'host.' + Config::CONFIG['DLEXT'])
+  end
+
+  rm(file) 
 end
 
 desc "Run the example sys-host program"
 task :example => [:build] do
    Dir.mkdir('sys') unless File.exists?('sys')
    if CONFIG['host_os'].match('mswin')
-      FileUtils.cp('lib/sys/windows.rb', 'lib/sys/host.rb')
-      ruby '-Ilib examples/host_test.rb'
+      ruby '-Ilib/windows examples/example_sys_host.rb'
    else
-      ruby '-Iext examples/host_test.rb'
+      case Config::CONFIG['host_os']
+        when /bsd|darwin/i
+          dir = 'ext/bsd'
+        when /sunos|solaris/i
+          dir = 'ext/sunos'
+        when /linux/i
+          dir = 'ext/linux'
+        else
+          dir = 'ext/generic'
+      end
+      ruby "-I#{dir} examples/example_sys_host.rb"
    end
 end
 
+desc 'Run the test suite'
 Rake::TestTask.new do |t|
-   if CONFIG['host_os'].match('mswin')
-      FileUtils.cp('lib/sys/windows.rb', 'lib/sys/host.rb')
-   else
-      task :test => :build
-      t.libs << 'ext'
-      t.libs.delete('lib')
-   end
+  task :test => :build
+  t.libs << 'test'
+  t.test_files = FileList['test/test_sys_host.rb'] 
+   
+  case Config::CONFIG['host_os']
+    when /mswin|msdos|cygwin|mingw/i
+      t.libs << 'lib/windows'
+    when /linux/i
+      t.libs << 'ext/linux'
+    when /sunos|solaris/i
+      t.libs << 'ext/sunos'
+    when /bsd|darwin/i
+      t.libs << 'ext/bsd'
+    else
+      t.libs << 'ext/generic'
+  end
+end
+
+namespace 'gem' do
+  desc 'Create the sys-host gem file'
+  task :create => [:clean] do
+    spec = eval(IO.read('sys-host.gemspec'))
+
+    case Config::CONFIG['host_os']
+      when /bsd|darwin/i
+         spec.files << 'ext/bsd/sys/host.c'
+         spec.extra_rdoc_files << 'ext/bsd/sys/host.c'
+         spec.extensions = ['ext/bsd/extconf.rb']
+      when /linux/i
+         spec.files << 'ext/linux/sys/host.c'
+         spec.extra_rdoc_files << 'ext/linux/sys/host.c'
+         spec.extensions = ['ext/linux/extconf.rb']
+      when /sunos|solaris/i
+         spec.files << 'ext/sunos/sys/host.c'
+         spec.extra_rdoc_files << 'ext/sunos/sys/host.c'
+         spec.extensions = ['ext/sunos/extconf.rb']
+      when /mswin|win32|dos|cygwin|mingw/i
+         spec.platform = Gem::Platform::CURRENT
+         spec.require_paths = ['lib', 'lib/windows']
+         spec.files += ['lib/windows/sys/host.rb']
+      else
+         spec.files << 'ext/generic/sys/host.c'
+         spec.extra_rdoc_files << 'ext/generic/sys/host.c'
+         spec.extensions = ['ext/generic/extconf.rb']
+    end
+
+    Gem::Builder.new(spec).build 
+  end
+
+  desc 'Install the sys-host gem'
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
 end

data/doc/host.txt

@@ -1,88 +1,88 @@
 == Description
-   Provides hostname and ip address information for a given host.
+  Provides hostname and ip address information for a given host.
     
 == Synopsis
-   require 'sys/host'
-   include Sys
+  require 'sys/host'
+  include Sys
 
-   p Host.hostname
-   p Host.ip_addr
+  p Host.hostname
+  p Host.ip_addr
     
-   # Some platforms
-   Host.info{ |h|
-      p h
-   }
+  # Some platforms
+  Host.info{ |h|
+    p h
+  }
 
 == Constants
 VERSION
-    Returns the current version number of this library (as a string)
+  Returns the current version number of this library (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.
+  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).
+  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.
+  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.
+
+Host.host_id
+  Returns the unique hexadecimal identifier for the current host.
     
 == Exception Classes
 Host::Error < StandardError
-   Raised in the event of a failure for any of the class methods provided
-   with this library.  Generally speaking, it means there was a failure in
-   the underlying gethostname() or gethostbyname() calls.
+  Raised in the event of a failure for any of the class methods provided
+  with this library.  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.
+  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 library uses OLE + WMI.  The Host.info method
-   returns considerably more information than the *nix versions of this
-   library.
+  The Windows version of this library uses OLE + WMI.  The Host.info method
+  returns considerably more information than the *nix versions of this
+  library.
    
 == 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.
+  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.
+  None that I'm aware of.
 
-   Please log any bugs on the project home page at
-   http://www.rubyforge.org/projects/sysutils
+  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 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.
+  Thanks also go to Richard Stevens for his excellent Unix programming books.
     
 == License
-   Ruby's
+  Artistic 2.0
     
 == Copyright
-   Copyright 2002-2008, Daniel J. Berger, djberg96 at gmail dot com
+  Copyright 2002-2010, 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.
+  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 library 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.
+  This library 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)
+  Daniel J. Berger
     
 == See Also
-   gethostbyname, gethostbyname_r, gethostname, hostname (Unix)
-   WMI, OLE (Windows)
+  gethostbyname, gethostbyname_r, gethostname, hostname (Unix)
+  WMI, OLE (Windows)

data/examples/example_sys_host.rb

@@ -0,0 +1,21 @@
+####################################################################
+# example_sys_host.rb
+#
+# Generic test script for general futzing. Use the 'rake example'
+# task to run this.
+#
+# Modify as you see fit.
+####################################################################
+require 'sys/host'
+include Sys
+
+puts "VERSION: " + Host::VERSION
+puts "Hostname: " + Host.hostname
+puts "IP Addresses : " + Host.ip_addr.join(',')
+puts "Host ID: " + Host.host_id.to_s
+
+puts "Info: "
+
+Host.info{ |i|
+   p i
+}

data/ext/bsd/extconf.rb

@@ -0,0 +1,11 @@
+require 'mkmf'
+require 'rbconfig'
+
+dir_config('host')
+
+have_func('gethostid')
+have_func('inet_ntop')
+have_func('gethostent_r')
+have_func('getipnodebyname')
+
+create_makefile('sys/host', 'sys')

data/ext/bsd/sys/host.c

@@ -0,0 +1,268 @@
+/******************************************************************************
+ * host.c - Source code for BSD and OS X for the sys-host library.
+ *
+ * Author: Daniel Berger
+ *****************************************************************************/
+#include <ruby.h>
+#include <unistd.h>
+#include <netdb.h>
+#include <arpa/inet.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <errno.h>
+
+#define SYS_HOST_VERSION "0.6.2"
+
+#ifndef MAXHOSTNAMELEN
+#define MAXHOSTNAMELEN 256
+#endif
+
+#ifndef INET_ADDRSTRLEN
+#define INET_ADDRSTRLEN 16
+#endif
+
+#ifndef HOSTENT_BUF
+#define HOSTENT_BUF 8192
+#endif
+
+VALUE cHostError, sHostInfo;
+
+/*
+ * call-seq:
+ *    Host.hostname
+ *
+ * Returns the hostname of the current host.  This may or not return the FQDN,
+ * depending on your system.
+ */
+static VALUE host_hostname(){
+  char host_name[MAXHOSTNAMELEN];
+  int rv;
+
+  rv = gethostname(host_name, MAXHOSTNAMELEN);
+
+  // If you get this exception, you've got big problems
+  if(rv != 0)
+    rb_raise(cHostError, "gethostname() call failed: %s", strerror(errno));
+
+  return rb_str_new2(host_name);
+}
+
+/*
+ * call-seq:
+ *    Host.ip_addr
+ *
+ * Returns a list of IP addresses for the current host (yes, it is possible
+ * to have more than one).
+ */
+static VALUE host_ip_addr(){
+  char host_name[MAXHOSTNAMELEN];
+  char str[INET_ADDRSTRLEN];
+  char **pptr;
+  struct hostent* hp;
+  int err;
+  VALUE v_results = rb_ary_new();
+#ifndef HAVE_INET_NTOP
+  struct in_addr ipa;
+  int n;
+#endif
+
+  if(gethostname(host_name, MAXHOSTNAMELEN) != 0)
+    rb_raise(cHostError, "gethostname() call failed");
+
+#ifdef HAVE_GETIPNODEBYNAME
+  hp = getipnodebyname(host_name, AF_INET, AI_DEFAULT, &err);
+#else
+  hp = gethostbyname(host_name);
+#endif
+
+  if(hp == NULL)
+    rb_raise(cHostError, "getipnodebyname() call failed");
+
+  pptr = hp->h_addr_list;
+
+#ifdef HAVE_INET_NTOP
+  for( ; *pptr != NULL; pptr++){
+    rb_ary_push(v_results,
+      rb_str_new2(inet_ntop(hp->h_addrtype, *pptr, str, INET_ADDRSTRLEN)));
+  }
+#else
+  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(v_results, rb_str_new2(inet_ntoa(ipa)));
+  }
+#endif
+
+  return v_results;
+}
+
+/* :call-seq:
+ *    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) => Typically 2 (AF_INET) or 28 (AF_INET6)
+ * * length    (Integer) => Typically 4 (IPv4) or 16 (IPv6)
+ * * addr_list (Array)
+ */
+static VALUE host_info(VALUE klass){
+  VALUE v_hostinfo = Qnil;
+  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;
+  struct hostent* result;
+  char sbuf[HOSTENT_BUF];
+  char ibuf[INET_ADDRSTRLEN];
+  int err;
+
+  while(!gethostent_r(&host, sbuf, HOSTENT_BUF, &result, &err)){
+#ifdef __MACH__ or #ifdef __APPLE__
+    char **aliases = result->h_aliases;
+    char **addrs = result->h_addr_list;
+
+    while(*aliases){
+      rb_ary_push(v_aliases, rb_str_new2(*aliases));
+      *aliases++;
+    }
+
+    while(*addrs){
+      inet_ntop(result->h_addrtype, addrs, addr, INET_ADDRSTRLEN);
+      rb_ary_push(v_addr, rb_str_new2(ibuf));
+      memset(ibuf, 0, sizeof(ibuf));
+      addrs++;
+    }
+#else
+    while(*result->h_aliases){
+      rb_ary_push(v_aliases, rb_str_new2(*result->h_aliases));
+      *result->h_aliases++;
+    }
+
+    while(*result->h_addr_list){
+      inet_ntop(result->h_addrtype, *result->h_addr_list, ibuf, INET_ADDRSTRLEN);
+      rb_ary_push(v_addr, rb_str_new2(ibuf));
+      *result->h_addr_list++;
+      memset(ibuf, 0, sizeof(ibuf));
+    }
+#endif
+
+    // Dup the arrays because Ruby is holding onto the same reference.
+    v_hostinfo = rb_struct_new(sHostInfo,
+      rb_str_new2(result->h_name),
+      rb_ary_dup(v_aliases),
+      INT2FIX(result->h_addrtype),
+      INT2FIX(result->h_length),
+      rb_ary_dup(v_addr)
+    );         
+#else
+  struct hostent* host;
+  char ibuf[INET_ADDRSTRLEN];
+
+  while((host = gethostent())){
+#ifdef __MACH__ or #ifdef __APPLE__
+    char **aliases = host->h_aliases;
+    char **addrs = host->h_addr_list;
+
+    while(*aliases){
+      rb_ary_push(v_aliases, rb_str_new2(*aliases));
+      *aliases++;
+    }
+
+    while(*addrs){
+      inet_ntop(host->h_addrtype, addrs, ibuf, INET_ADDRSTRLEN);
+      rb_ary_push(v_addr, rb_str_new2(ibuf));
+      memset(ibuf, 0, sizeof(ibuf));
+      addrs++;
+    }
+#else
+    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, ibuf, INET_ADDRSTRLEN);
+      rb_ary_push(v_addr, rb_str_new2(ibuf));
+      memset(ibuf, 0, sizeof(ibuf));
+      *host->h_addr_list++;
+    }
+#endif
+
+    v_hostinfo = rb_struct_new(sHostInfo,
+      rb_str_new2(host->h_name),
+      rb_ary_dup(v_aliases),
+      INT2FIX(host->h_addrtype),
+      INT2FIX(host->h_length),
+      rb_ary_dup(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;
+}
+
+#ifdef HAVE_GETHOSTID
+/*
+ * Sys::Host.host_id
+ *
+ * Returns the host id of the current machine.
+ */
+static VALUE host_host_id(){
+  return ULL2NUM(gethostid());
+}
+#endif
+
+void Init_host()
+{
+   VALUE sys_mSys, cHost;
+
+   /* The Sys module serves as a toplevel namespace, nothing more. */
+   sys_mSys = rb_define_module("Sys");
+
+   /* The Host class encapsulates information about your machine, such as
+    * the host name and IP address.
+    */
+   cHost = rb_define_class_under(sys_mSys, "Host", rb_cObject);
+
+   /* This error is raised if any of the Host methods fail. */
+   cHostError = rb_define_class_under(cHost, "Error", rb_eStandardError);
+
+   /* 0.6.2: The version of this library. This is a string, not a number. */
+   rb_define_const(cHost, "VERSION", rb_str_new2(SYS_HOST_VERSION));
+   
+   /* Structs */
+   sHostInfo = rb_struct_define("HostInfo", "name", "aliases", "addr_type",
+      "length", "addr_list", NULL
+   );
+
+   /* 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, "host_id", host_host_id, 0);
+#endif
+}