sys-host 0.5.2-mswin32 → 0.6.0-mswin32

data/CHANGES

@@ -1,3 +1,13 @@
+== 0.6.0 - 8-Jun-2007
+* Now supports OS X!
+* Added the Host.host_id class method.
+* Bug/warning fix for OS X.
+* HostError is now Host::Error.
+* Added a Rakefile, including tasks for installation and testing.
+* Fixed the gemspec (I hope).
+* Lots of internal reorganization, including the removal of the install.rb
+  file. That's handled by the Rakefile.
+
 == 0.5.2 - 27-Jun-2006
 * Added the Host.info method for Linux.
 

data/MANIFEST

@@ -1,19 +1,15 @@
-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/sys/windows.rb
-
-test/tc_host.rb
+* CHANGES
+* MANIFEST
+* README
+* 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
+* test/tc_host.rb

data/README

@@ -1,14 +1,26 @@
 = Prerequisites
-Ruby 1.8.0 or later.
-Ruby 1.8.2 or later preferred on Windows.
+   Ruby 1.8.0 or later.
+   Ruby 1.8.2 or later preferred on Windows.
+   
+= Synopsis
+   require 'sys/host'
+   include Sys
+
+   p Host.hostname
+   p Host.ip_addr
+
+   Host.info{ |h|
+      p h
+   }
 
 = Installation
-== Windows
-ruby test\tc_host.rb (optional)
-ruby install.rb
-
-== Unix
-ruby extconf.rb
-make
-ruby test/tc_host.rb (optional)
-make install
+== Standard (non-gem) installation
+   rake test (optional)
+   rake install
+
+== Gem Installation
+   rake test (optional)
+   rake install_gem
+
+= Documentation
+   See the doc/host.txt file for more information.

data/Rakefile

@@ -0,0 +1,79 @@
+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')
+      end
+   end
+   FileUtils.rm_rf('sys') if File.exists?('sys')
+end
+
+desc "Build the sys-host package on UNIX systems (but don't install it)"
+task :build => [:clean] do
+   Dir.chdir('ext') 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
+end
+
+desc "Run the example program"
+task :example => [:build] do
+   ruby 'host_test.rb'
+end
+
+if RUBY_PLATFORM.match('mswin')
+   desc "Install the sys-host package (non-gem)"
+   task :install do
+      install_dir = File.join(CONFIG['sitelibdir'], 'sys')
+      Dir.mkdir(install_dir) unless File.exists?(install_dir)
+      FileUtils.cp('lib/sys/windows.rb', install_dir, :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
+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}"
+end
+
+desc "Run the example sys-host program"
+task :example => [:build] do
+   Dir.mkdir('sys') unless File.exists?('sys')
+   if RUBY_PLATFORM.match('mswin')
+      FileUtils.cp('lib/sys/windows.rb', 'lib/sys/host.rb')
+      ruby '-Ilib examples/host_test.rb'
+   else
+      ruby '-Iext examples/host_test.rb'
+   end
+end
+
+Rake::TestTask.new do |t|
+   if RUBY_PLATFORM.match('mswin')
+      FileUtils.cp('lib/sys/windows.rb', 'lib/sys/host.rb')
+      t.libs << 'lib'
+   else
+      task :test => :build
+      t.libs << 'ext'
+      t.libs.delete('lib')
+   end
+   t.test_files = FileList['test/tc_host.rb']
+end

data/Rakefile~

@@ -0,0 +1,67 @@
+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')
+      end
+   end
+   FileUtils.rm_rf('sys') if File.exists?('sys')
+end
+
+desc "Build the sys-host package on UNIX systems (but don't install it)"
+task :build => [:clean] do
+   Dir.chdir('ext') 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
+end
+
+desc "Run the example program"
+task :example => [:build] do
+   ruby 'host_test.rb'
+end
+
+if RUBY_PLATFORM.match('mswin')
+   desc "Install the sys-host package (non-gem)"
+   task :install do
+      install_dir = File.join(CONFIG['sitelibdir'], 'sys')
+      Dir.mkdir(install_dir) unless File.exists?(install_dir)
+      FileUtils.cp('lib/sys/windows.rb', install_dir, :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
+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}"
+end
+
+Rake::TestTask.new do |t|
+   if RUBY_PLATFORM.match('mswin')
+      t.libs << 'lib'
+   else
+      task :test => :build
+      t.libs << 'ext'
+      t.libs.delete('lib')
+   end
+   t.test_files = FileList['test/tc_host.rb']
+end

data/doc/host.txt

@@ -33,7 +33,7 @@ Host.info(host=localhost){ |h| ... }
    vary depending on your platform.
     
 == Exception Classes
-HostError < StandardError
+Host::Error < 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.
@@ -68,7 +68,7 @@ HostError < StandardError
    Ruby's
     
 == Copyright
-   Copyright 2002-2006, Daniel J. Berger, djberg96 at gmail dot com
+   Copyright 2002-2007, 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.

data/lib/sys/host.rb

@@ -1,11 +1,13 @@
-require "win32ole"
-require "socket"
-require "parsedate"
+require 'win32ole'
+require 'socket'
+require 'parsedate'
 
 module Sys
-   class HostError < StandardError; end
    class Host
-      VERSION = "0.5.2"
+      class Error < StandardError; end
+      
+      VERSION = '0.6.0'
+      
       fields = %w/
          arp_always_source_route?
          arp_use_ether_snap?
@@ -69,14 +71,20 @@ module Sys
          wins_secondary_server
       /
       
-      HostInfo = Struct.new("HostInfo",*fields)
+      HostInfo = Struct.new("HostInfo", *fields)
       
+      # 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.
+      # 
       def self.info(host=Socket.gethostname)
+         array = [] unless block_given?
          cs = "winmgmts://#{host}/root/cimv2"
+
          begin
             wmi = WIN32OLE.connect(cs)
-         rescue WIN32OLERuntimeError => e
-            raise HostError, e
+         rescue WIN32OLERuntimeError => err
+            raise Error, err
          else
             query = "
                select * from Win32_NetworkAdapterConfiguration
@@ -86,14 +94,18 @@ module Sys
                dhcp_expires = nic.DHCPLeaseExpires
                dhcp_lease_obtained = nic.DHCPLeaseObtained
                
+               # It appears that the DHCP Lease Expired Date and DHCP Lease
+               # Obtained date can be so large as to cause an error. So, we
+               # simply return nil in these cases.
+               #
                if dhcp_expires
                   parsed = ParseDate.parsedate(dhcp_expires)
-                  dhcp_expires = Time.mktime(*parsed)
+                  dhcp_expires = Time.mktime(*parsed) rescue nil
                end
                
                if dhcp_lease_obtained
                   parsed = ParseDate.parsedate(dhcp_lease_obtained)
-                  dhcp_lease_obtained = Time.mktime(*parsed)
+                  dhcp_lease_obtained = Time.mktime(*parsed) rescue nil
                end
                
                igmp_level = nil
@@ -142,7 +154,7 @@ module Sys
                      tcpip_netbios_options = "DisableNetbios"
                end
                
-               yield HostInfo.new(
+               struct = HostInfo.new(
                   nic.ArpAlwaysSourceRoute,
                   nic.ArpUseEtherSNAP,
                   nic.Caption,
@@ -204,41 +216,56 @@ module Sys
                   nic.WINSScopeID,
                   nic.WINSSecondaryServer
                )
+
+               if block_given?
+                  yield struct
+               else
+                  array << struct
+               end
             }
          end
+
+         block_given? ? nil : array
       end
       
+      # Returns the hostname of the current host.  This may or not return
+      # the FQDN, depending on your system.
+      # 
       def self.hostname
+         host = nil
          begin
             wmi = WIN32OLE.connect("winmgmts://")
          rescue WIN32OLERuntimeError => e
-            raise HostError, e
+            raise Error, e
          else
             query = "
                select * from Win32_NetworkAdapterConfiguration
                where IPEnabled = True
             "
             wmi.ExecQuery(query).each{ |nic|
-               return nic.DNSHostName
+               host = nic.DNSHostName
+               break
             }
          end
+         host
       end
       
+      # Returns a list of unique IP addresses for the current host.
+      #
       def self.ip_addr
+         ip_addrs = []
          begin
             wmi = WIN32OLE.connect("winmgmts://")
          rescue WIN32OLERuntimeError => e
-            raise HostError, e
+            raise Error, e
          else
             query = "
                select * from Win32_NetworkAdapterConfiguration
                where IPEnabled = True
             "
-            wmi.ExecQuery(query).each{ |nic|
-               return nic.IPAddress
-            }
+            wmi.ExecQuery(query).each{ |nic| ip_addrs = nic.IPAddress }
          end
-      end
-      
+         ip_addrs.uniq
+      end      
    end
-end
+end

data/sys-host.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name         = "sys-host"
-   gem.version      = "0.5.2"
+   gem.version      = "0.6.0"
    gem.author       = "Daniel J. Berger"
    gem.email        = "djberg96@gmail.com"
    gem.homepage     = "http://www.rubyforge.org/projects/sysutils"
@@ -16,32 +16,32 @@ spec = Gem::Specification.new do |gem|
    files = Dir["doc/*"] + Dir["test/*"] + Dir["[A-Z]*"]
    files.delete_if{ |item| item.include?("CVS") }
    gem.files = files
-end
-
-if $0 == __FILE__
+   
    if RUBY_PLATFORM.match("mswin")
       File.rename("lib/sys/windows.rb", "lib/sys/host.rb")
-      spec.required_ruby_version = '>= 1.8.2'
-      spec.files += ["lib/sys/host.rb"]
-      spec.platform = Gem::Platform::WIN32
+      gem.required_ruby_version = '>= 1.8.2'
+      gem.files += ["lib/sys/host.rb"]
+      gem.platform = Gem::Platform::WIN32
    else
-      spec.required_ruby_version = '>= 1.8.0'
-      spec.extensions = ["extconf.rb"]
+      gem.required_ruby_version = '>= 1.8.0'
+      gem.extensions = ["ext/extconf.rb"]
 
       case RUBY_PLATFORM
          when /linux/i
-            file = 'ext/linux.c'
+            file = 'ext/linux/linux.c'
          when /sunos|solaris/i
-            file = 'ext/sunos.c'
-         when /freebsd/i
-            file = 'ext/freebsd.c'
+            file = 'ext/sunos/sunos.c'
+         when /bsd|darwin|powerpc|mach/i
+            file = 'ext/bsd/bsd.c'
          else
-            file = 'ext/generic.c'
+            file = 'ext/generic/generic.c'
       end
 
-      spec.files += ['ext/constants.h', file]
+      gem.files += ['ext/constants.h', file]
    end
-	
+end
+
+if $0 == __FILE__
    Gem.manage_gems
    Gem::Builder.new(spec).build
 end

data/test/tc_host.rb

@@ -1,38 +1,15 @@
-#########################################
+#################################################
 # 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"
+# Test suite for sys-host, all platforms.
+#################################################
+require 'sys/host'
+require 'test/unit'
 include Sys
 
 class TC_Host < Test::Unit::TestCase
    def test_version
-      assert_equal("0.5.2",Host::VERSION)
+      assert_equal('0.6.0', Host::VERSION)
    end
 
    def test_hostname
@@ -48,14 +25,20 @@ class TC_Host < Test::Unit::TestCase
       assert_kind_of(Array, Host.ip_addr)
    end
 
+   def test_host_id
+      assert_respond_to(Host, :host_id)
+      assert_nothing_raised{ Host.host_id }
+      assert_kind_of(Integer, Host.host_id)
+   end
+
    def test_info
-      if RUBY_PLATFORM =~ /mswin|solaris|linux/i
+      if RUBY_PLATFORM =~ /mswin|solaris|linux|bsd|mach|darwin|osx/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 } }
+         assert_nothing_raised{ 100.times{ Host.info } }
       else
          puts "The 'test_info' test was skipped on this platform"
       end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.4
 specification_version: 1
 name: sys-host
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
-date: 2006-11-18 00:00:00 -07:00
+  version: 0.6.0
+date: 2007-06-09 00:00:00 -06:00
 summary: Provides hostname and ip address info for a given host
 require_paths: 
 - lib
@@ -35,10 +35,10 @@ files:
 - doc
 - examples
 - ext
-- extconf.rb
-- install.rb
 - lib
 - MANIFEST
+- Rakefile
+- Rakefile~
 - README
 - sys-host.gemspec
 - test

data/extconf.rb

@@ -1,48 +0,0 @@
-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/sys/windows.rb')
-      File.rename('lib/sys/windows.rb', 'lib/sys/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/install.rb

@@ -1,40 +0,0 @@
-################################################
-# install.rb - for sys-host
-#
-# For pure Ruby versions only
-################################################
-require 'rbconfig'
-require 'ftools'
-include Config
-install_dir = CONFIG['sitelibdir'] + '/sys'
-
-file = ""
-
-case RUBY_PLATFORM
-   when /windows|win32|mingw|cygwin|dos/i
-      file = "lib/os/windows.rb"
-   else
-      STDERR.puts "Use 'extconf.rb/make/make site-install' for this platform"
-      exit
-end
-
-# Create the 'sys' toplevel directory if it doesn't already exist
-begin
-   unless File.exist?(install_dir)
-      Dir.mkdir(install_dir)
-   end
-rescue Errno::EACCES => e
-   puts "Unable to create #{install_dir}: #{e}"
-   exit
-end
-
-# Finally, copy the file to the appropriate directory
-begin
-   File.copy(file,"#{install_dir}/host.rb")
-   puts "cp #{file} #{install_dir}/host.rb"
-rescue Errno::EACCES => e
-   puts "Unable to install cpu.rb to #{install_dir}: #{e}"
-   exit
-end
-
-puts "Installation successful"