sys-host 0.5.2-mswin32

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/sys/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/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/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

@@ -0,0 +1,40 @@
+################################################
+# 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"

data/lib/sys/host.rb

@@ -0,0 +1,244 @@
+require "win32ole"
+require "socket"
+require "parsedate"
+
+module Sys
+   class HostError < StandardError; end
+   class Host
+      VERSION = "0.5.2"
+      fields = %w/
+         arp_always_source_route?
+         arp_use_ether_snap?
+         caption
+         database_path
+         dead_gw_detect_enabled?
+         default_ip_gateway
+         default_tos
+         default_ttl
+         description
+         dhcp_enabled?
+         dhcp_lease_expires
+         dhcp_lease_obtained
+         dhcp_server
+         dns_domain
+         dns_domain_suffix_search_order
+         dns_enabled_for_wins_resolution?
+         dns_host_name
+         dns_server_search_order
+         domain_dns_registration_enabled?
+         forward_buffer_memory
+         full_dns_registration_enabled?
+         gateway_cost_metric
+         igmp_level
+         index
+         ip_address
+         ip_connection_metric
+         ip_enabled?
+         ip_filter_security_enabled?
+         ip_port_security_enabled?
+         ip_sec_permit_ip_protocols
+         ip_sec_permit_tcp_ports
+         ip_sec_permit_udp_ports
+         ip_subnet
+         ip_use_zero_broadcast
+         ipx_address
+         ipx_enabled?
+         ipx_frame_type
+         ipx_media_type
+         ipx_network_number
+         ipx_virtual_net_number
+         keep_alive_interval
+         keep_alive_time
+         mac_address
+         mtu
+         num_forward_packets
+         pmtubh_detect_enabled?
+         pmtu_discovery_enabled?
+         service_name
+         setting_id
+         tcpip_netbios_options
+         tcp_max_connect_retransmissions
+         tcp_max_data_retransmissions
+         tcp_num_connections
+         tcp_use_rfc1122_urgent_pointer?
+         tcp_window_size
+         wins_enable_lm_hosts_lookup?
+         wins_host_lookup_file
+         wins_primary_server
+         wins_scope_id
+         wins_secondary_server
+      /
+      
+      HostInfo = Struct.new("HostInfo",*fields)
+      
+      def self.info(host=Socket.gethostname)
+         cs = "winmgmts://#{host}/root/cimv2"
+         begin
+            wmi = WIN32OLE.connect(cs)
+         rescue WIN32OLERuntimeError => e
+            raise HostError, e
+         else
+            query = "
+               select * from Win32_NetworkAdapterConfiguration
+               where IPEnabled = True
+            "
+            wmi.ExecQuery(query).each{ |nic|
+               dhcp_expires = nic.DHCPLeaseExpires
+               dhcp_lease_obtained = nic.DHCPLeaseObtained
+               
+               if dhcp_expires
+                  parsed = ParseDate.parsedate(dhcp_expires)
+                  dhcp_expires = Time.mktime(*parsed)
+               end
+               
+               if dhcp_lease_obtained
+                  parsed = ParseDate.parsedate(dhcp_lease_obtained)
+                  dhcp_lease_obtained = Time.mktime(*parsed)
+               end
+               
+               igmp_level = nil
+               case nic.IGMPLevel
+                  when 0
+                     igmp_level = "None"
+                  when 1
+                     igmp_level = "IP"
+                  when 2
+                     igmp_level = "IP & IGMP"
+               end
+                  
+               ipx_frame_type = nil
+               case nic.IPXFrameType
+                  when 0
+                     ipx_frame_type = "Ethernet II"
+                  when 1
+                     ipx_frame_type = "Ethernet 802.3"
+                  when 2
+                     ipx_frame_type = "Ethernet 802.2"
+                  when 3
+                     ipx_frame_type = "Ethernet SNAP"
+                  when 255
+                     ipx_frame_type = "AUTO"
+               end
+               
+               ipx_media_type = nil
+               case nic.IPXMediaType
+                  when 0
+                     ipx_media_type = "Ethernet"
+                  when 1
+                     ipx_media_type = "Token Ring"
+                  when 2
+                     ipx_media_type = "FDDI"
+                  when 8
+                     ipx_media_type = "ARCNET"
+               end
+               
+               tcpip_netbios_options = nil
+               case nic.TcpipNetbiosOptions
+                  when 0
+                     tcpip_netbios_options = "EnableNetbiosViaDhcp"
+                  when 1
+                     tcpip_netbios_options = "EnableNetbios"
+                  when 2
+                     tcpip_netbios_options = "DisableNetbios"
+               end
+               
+               yield HostInfo.new(
+                  nic.ArpAlwaysSourceRoute,
+                  nic.ArpUseEtherSNAP,
+                  nic.Caption,
+                  nic.DatabasePath,
+                  nic.DeadGWDetectEnabled,
+                  nic.DefaultIPGateway,
+                  nic.DefaultTOS,
+                  nic.DefaultTTL,
+                  nic.Description,
+                  nic.DHCPEnabled,
+                  dhcp_expires,
+                  dhcp_lease_obtained,
+                  nic.DHCPServer,
+                  nic.DNSDomain,
+                  nic.DNSDomainSuffixSearchOrder,
+                  nic.DNSEnabledForWINSResolution,
+                  nic.DNSHostName,
+                  nic.DNSServerSearchOrder,
+                  nic.DomainDNSRegistrationEnabled,
+                  nic.ForwardBufferMemory,
+                  nic.FullDNSRegistrationEnabled,
+                  nic.GatewayCostMetric,
+                  igmp_level,
+                  nic.Index,
+                  nic.IpAddress,
+                  nic.IPConnectionMetric,
+                  nic.IPEnabled,
+                  nic.IPFilterSecurityEnabled,
+                  nic.IPPortSecurityEnabled,
+                  nic.IPSecPermitIPProtocols,
+                  nic.IPSecPermitTCPPorts,
+                  nic.IPSecPermitUDPPorts,
+                  nic.IPSubnet,
+                  nic.IPUseZeroBroadcast,
+                  nic.IPXAddress,
+                  nic.IPXEnabled,
+                  ipx_frame_type,
+                  ipx_media_type,
+                  nic.IPXNetworkNumber,
+                  nic.IPXVirtualNetNumber,
+                  nic.KeepAliveInterval,
+                  nic.KeepAliveTime,
+                  nic.MacAddress,
+                  nic.MTU,
+                  nic.NumForwardPackets,
+                  nic.PMTUBHDetectEnabled,
+                  nic.PMTUDiscoveryEnabled,
+                  nic.ServiceName,
+                  nic.SettingID,
+                  tcpip_netbios_options,
+                  nic.TcpMaxConnectRetransmissions,
+                  nic.TcpMaxDataRetransmissions,
+                  nic.TcpNumConnections,
+                  nic.TcpUseRFC1122UrgentPointer,
+                  nic.TcpWindowSize,
+                  nic.WINSEnableLMHostsLookup,
+                  nic.WINSHostLookupFile,
+                  nic.WINSPrimaryServer,
+                  nic.WINSScopeID,
+                  nic.WINSSecondaryServer
+               )
+            }
+         end
+      end
+      
+      def self.hostname
+         begin
+            wmi = WIN32OLE.connect("winmgmts://")
+         rescue WIN32OLERuntimeError => e
+            raise HostError, e
+         else
+            query = "
+               select * from Win32_NetworkAdapterConfiguration
+               where IPEnabled = True
+            "
+            wmi.ExecQuery(query).each{ |nic|
+               return nic.DNSHostName
+            }
+         end
+      end
+      
+      def self.ip_addr
+         begin
+            wmi = WIN32OLE.connect("winmgmts://")
+         rescue WIN32OLERuntimeError => e
+            raise HostError, e
+         else
+            query = "
+               select * from Win32_NetworkAdapterConfiguration
+               where IPEnabled = True
+            "
+            wmi.ExecQuery(query).each{ |nic|
+               return nic.IPAddress
+            }
+         end
+      end
+      
+   end
+end

data/sys-host.gemspec

@@ -0,0 +1,47 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+   gem.name         = "sys-host"
+   gem.version      = "0.5.2"
+   gem.author       = "Daniel J. Berger"
+   gem.email        = "djberg96@gmail.com"
+   gem.homepage     = "http://www.rubyforge.org/projects/sysutils"
+   gem.platform     = Gem::Platform::RUBY
+   gem.summary      = "Provides hostname and ip address info for a given host"
+   gem.description  = "Provides hostname and ip address info for a given host"
+   gem.test_file    = "test/tc_host.rb"
+   gem.has_rdoc     = true
+   gem.extra_rdoc_files  = ["CHANGES", "README", "MANIFEST"]
+   gem.rubyforge_project = "sysutils"
+   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
+   else
+      spec.required_ruby_version = '>= 1.8.0'
+      spec.extensions = ["extconf.rb"]
+
+      case RUBY_PLATFORM
+         when /linux/i
+            file = 'ext/linux.c'
+         when /sunos|solaris/i
+            file = 'ext/sunos.c'
+         when /freebsd/i
+            file = 'ext/freebsd.c'
+         else
+            file = 'ext/generic.c'
+      end
+
+      spec.files += ['ext/constants.h', file]
+   end
+	
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

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,61 @@
+--- !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-11-18 00:00:00 -07: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.2
+  version: 
+platform: mswin32
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Daniel J. Berger
+files: 
+- doc/host.txt
+- test/tc_host.rb
+- CHANGES
+- doc
+- examples
+- ext
+- extconf.rb
+- install.rb
+- lib
+- MANIFEST
+- README
+- sys-host.gemspec
+- test
+- lib/sys/host.rb
+test_files: 
+- test/tc_host.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+