sysinfo 0.5.0 → 0.5.1

data/CHANGES.txt

@@ -1,6 +1,14 @@
 SYSINFO, CHANGES
 
 
+#### 0.5.1 (2009-05-07) ###############################
+
+* CHANGE: Hella cleanup in preparation for future expansion. 
+* CHANGE: Modified platform, now returns VM-OS instead of OS-IMPL
+* ADDED: to_s which returns a full platform string
+* ADDED: sysinfo executable
+
+
 #### 0.5 (2009-05-07) ###############################
 
 * First public release. See commit history for solutious-stella, solutious-rudy, 

data/README.rdoc

@@ -2,6 +2,65 @@
 
 All your system-independent infoz in one handy class. 
 
+SysInfo does a takes a very quick glance at the system it's running on and exposes the results as YAML, JSON, CSV, or TSV. It also determines a platform identifier for the system that takes the form: VM-OS-IMPLEMENTATION-ARCHITECTURE.
+
+=== Platform Identifier Examples
+
+    ruby-unix-osx-i386
+    ruby-unix-osx-powerpc
+    ruby-unix-linux-x86_64
+    java-win32-windows-i386
+    java-win32-mingw-i386
+    
+For the complete list of operating systems, implementations and architectures that SysInfo is aware of, see:
+
+* <tt>$ sysinfo os</tt> 
+* <tt>$ sysinfo impl</tt> 
+* <tt>$ sysinfo arch</tt>
+
+== Usage -- Library
+
+    sysinfo = SysInfo.new
+    p sysinfo.vm                    # => ruby
+    p sysinfo.os                    # => unix
+    p sysinfo.impl                  # => osx
+    p sysinfo.arch                  # => i386
+    p sysinfo.platform              # => ruby-unix
+    p sysinfo.to_s                  # => ruby-unix-osx-i386
+    
+    p sysinfo.user                  # => delano
+    p sysinfo.home                  # => /Users/delano
+    p sysinfo.uptime                # => 290.429              (hours)
+    p sysinfo.shell                 # => /bin/bash
+    p sysinfo.paths                 # => [/sbin, /bin, /usr/bin, ...]
+                  
+    p sysinfo.hostname              # => walter
+    p sysinfo.ipaddress_internal    # => 10.0.1.2
+    p sysinfo.uptime                # => 290.573655656974
+    p sysinfo.ruby                  # => [1,9,1]
+    
+== Usage -- Executable
+
+    $ sysinfo 
+    ruby-unix-osx-i386
+    
+    $ /usr/jruby/bin/sysinfo
+    java-unix-osx-x86_64
+    
+    $ sysinfo -f yaml
+    :vm: :ruby
+    :os: :unix
+    :impl: :osx
+    ...
+    :shell: :"/bin/bash"
+    :user: delano
+    
+    $ sysinfo -f json
+    {"vm":"ruby","os":"unix","impl":"osx", ..., "shell":"\/bin\/bash","user":"delano"}
+    
+    $ sysinfo -f csv
+    ruby,unix,osx, ... /bin/bash,delano
+    
 == Installation
 
 Via Rubygems, one of:
@@ -12,11 +71,16 @@ Via Rubygems, one of:
 or via download:
 * sysinfo-latest.tar.gz[http://github.com/delano/sysinfo/tarball/latest]
 * sysinfo-latest.zip[http://github.com/delano/sysinfo/zipball/latest]
- 
+
+== Prerequisites
+
+* Ruby 1.8, Ruby 1.9, or JRuby 1.2
+* Storable[http://github.com/delano/storable]
 
 == Credits
 
 * Delano Mandelbaum (delano@solutious.com)
+* Portions of this code were originally from Amazon's EC2 AMI tools, specifically lib/platform.rb.
 
 == License
 

data/Rakefile

@@ -74,7 +74,7 @@ Rake::RDocTask.new do |t|
 	t.rdoc_files.include(LICENSE)
 	t.rdoc_files.include(README)
 	t.rdoc_files.include(CHANGES)
-	#t.rdoc_files.include('bin/*')
+	t.rdoc_files.include('bin/*')
 	t.rdoc_files.include('lib/**/*.rb')
 end
 

data/bin/sysinfo

@@ -0,0 +1,77 @@
+#!/usr/bin/ruby
+
+# SysInfo -- A Command Line Interface
+#
+# If your reading this via the rdocs you won't be able to see the code
+# See: http://github.com/delano/sysinfo/blob/master/bin/sysinfo
+#
+# Usage: bin/sysinfo
+#
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib')) # Make sure our local lib is first in line
+
+require 'rubygems'
+require 'drydock'
+require 'sysinfo'
+
+module SysInfoCLI #:nodoc:
+  extend Drydock
+  
+  debug :off
+  default :info
+  
+  global :f, :format, String, "Output format. One of: yaml, json, csv, tsv, string (default)"
+  global :v, :verbose, "Output everything I know"
+  global :V, :version, "Display version number" do
+    puts "SysInfo version: #{SysInfo::VERSION}"
+    exit 0
+  end
+  
+  about "Display system information"
+  command :info do |obj|
+    format = obj.global.format || :string
+    format = :yaml if obj.global.verbose == true
+    si = SysInfo.new
+    puts si.dump(format)
+  end
+  
+  about "Display list of known architectures"
+  command :arch do |obj|
+    arch = SysInfo::ARCHITECTURES.collect { |arch| 
+      next if arch[0].nil?
+      obj.global.verbose == true ? "%-15s -> %s" % [arch[1], arch[0].source] : arch[1] 
+    }
+    puts arch.compact
+  end
+  command_alias :arch, :architectures
+  
+  about "Display list of known OS implementations"
+  command :impl do |obj|
+    reorg = {}
+    SysInfo::IMPLEMENTATIONS.each do |arch| 
+      next if arch[0].nil?
+      reorg.store(arch[2].to_s, arch[0])
+    end
+    impl = reorg.keys.sort.collect do |key|
+      obj.global.verbose == true ? "%-15s -> %s" % [key, reorg[key].source] : key
+    end
+    puts impl.compact.uniq
+  end
+  command_alias :impl, :implementations
+  
+  about "Display list of known operating systems (OS)"
+  command :os do |obj|
+    reorg = {}
+    SysInfo::IMPLEMENTATIONS.each do |arch| 
+      next if arch[0].nil?
+      reorg.store(arch[1].to_s, arch[0])
+    end
+    impl = reorg.keys.sort.collect do |key|
+      obj.global.verbose == true ? "%-15s -> %s" % [key, reorg[key].source] : key
+    end
+    puts impl.compact.uniq
+  end
+  
+end
+
+

data/lib/sysinfo.rb

@@ -1,4 +1,6 @@
 require 'socket'
+require 'storable'
+require 'time'
 
 # = SysInfo
 # 
@@ -7,7 +9,7 @@ require 'socket'
 # specifically lib/platform.rb. 
 class SysInfo < Storable
   unless defined?(IMPLEMENTATIONS)
-    VERSION = 5.freeze
+    VERSION = 0.5.freeze
     IMPLEMENTATIONS = [
     
       # These are for JRuby, System.getproperty('os.name'). 
@@ -48,257 +50,229 @@ class SysInfo < Storable
       [/sparc/i,    :sparc            ],
       [/mips/i,     :mips             ],
       [/powerpc/i,  :powerpc          ],
-      [/universal/i,:universal        ],
+      [/universal/i,:i386             ],
       [nil,         :unknown          ],
     ].freeze
   end
 
-
+  field :vm => String
   field :os => String
-  field :implementation => String
-  field :architecture => String
+  field :impl => String
+  field :arch => String
   field :hostname => String
-  field :ipaddress => String
-  field :ipaddress_external => String
+  field :ipaddress_internal => String
+  #field :ipaddress_external => String
   field :uptime => Float
   
+  field :paths
+  field :tmpdir
+  field :home
+  field :shell
+  field :user
+  field :ruby
   
-  alias :impl :implementation
-  alias :arch :architecture
+  alias :implementation :impl
+  alias :architecture :arch
 
-  
   def initialize
-    @os, @implementation, @architecture = guess
-    @hostname, @ipaddress, @uptime = get_info
+    @vm, @os, @impl, @arch = find_platform_info
+    @hostname, @ipaddress_internal, @uptime = find_network_info
+    require 'Win32API' if @os == :win32
   end
   
-  
-  # This is called at require-time. It guesses the 
-  # current operating system, implementation, architecture. 
-  # Returns [os, impl, arch]
-  def guess
-    os = :unknown
-    impl = :unknown
-    arch = :unknown
+  # Returns [vm, os, impl, arch]
+  def find_platform_info
+    vm, os, impl, arch = :ruby, :unknown, :unknown, :unknow
     IMPLEMENTATIONS.each do |r, o, i|
-      if r and RUBY_PLATFORM =~ r
-        os, impl = [o, i]
-        break
-      end
+      next unless RUBY_PLATFORM =~ r
+      os, impl = [o, i]
+      break
     end
     ARCHITECTURES.each do |r, a|
-      if r and RUBY_PLATFORM =~ r
-        arch = a
-        break
-      end
-    end
-    
-    #
-    if os == :win32
-      #require 'Win32API'
-      
-    # If we're running in java, we'll need to look elsewhere
-    # for the implementation and architecture. 
-    # We'll replace IMPL and ARCH with what we find. 
-    elsif os == :java
-      require 'java'
-      include_class java.lang.System
-      
-      osname = System.getProperty("os.name")
-      IMPLEMENTATIONS.each do |r, o, i|
-        if r and osname =~ r
-          impl = i
-          break
-        end
-      end
-      
-      osarch = System.getProperty("os.arch")
-      ARCHITECTURES.each do |r, a|
-        if r and osarch =~ r
-          arch = a
-          break
-        end
-      end
-      
+      next unless RUBY_PLATFORM =~ r
+      arch = a
+      break
     end
-    
-    [os, impl, arch]
+    os == :java ? guess_java : [vm, os, impl, arch]
   end
   
-  # Returns [hostname, ipaddr, uptime] for the local machine
-  def get_info
-    hostname = :unknown
-    ipaddr = :unknown
-    uptime = :unknown
-
+  # Returns [hostname, ipaddr (internal), uptime]
+  def find_network_info
+    hostname, ipaddr, uptime = :unknown, :unknown, :unknown
     begin
-      hostname = local_hostname
-      ipaddr = local_ip_address
-      uptime = local_uptime       
-    rescue => ex
-      # Be silent!
+      hostname = find_hostname
+      ipaddr = find_ipaddress_internal
+      uptime = find_uptime       
+    rescue => ex # Be silent!
     end
-
     [hostname, ipaddr, uptime]
   end
   
-  # Return the hostname for the local machine
-  def local_hostname
-    Socket.gethostname
-  end
-  
+    # Return the hostname for the local machine
+  def find_hostname; Socket.gethostname; end
   
   # Returns the local uptime in hours. Use Win32API in Windows, 
   # 'sysctl -b kern.boottime' os osx, and 'who -b' on unix.
   # Based on Ruby Quiz solutions by: Matthias Reitinger 
   # On Windows, see also: net statistics server
-  def local_uptime
-
-    # Each method must return uptime in seconds
-    methods = {
-
-      :win32_windows => lambda {
-        # Win32API is required in self.guess
-        getTickCount = Win32API.new("kernel32", "GetTickCount", nil, 'L')
-        ((getTickCount.call()).to_f / 1000).to_f
-      },
-
-      # Ya, this is kinda wack. Ruby -> Java -> Kernel32. See:
-      # http://www.oreillynet.com/ruby/blog/2008/01/jruby_meets_the_windows_api_1.html
-      # http://msdn.microsoft.com/en-us/library/ms724408(VS.85).aspx
-      # Ruby 1.9.1: Win32API is now deprecated in favor of using the DL library.
-      :java_windows => lambda {
-        kernel32 = com.sun.jna.NativeLibrary.getInstance('kernel32')
-        buf = java.nio.ByteBuffer.allocate(256)
-        (kernel32.getFunction('GetTickCount').invokeInt([256, buf].to_java).to_f / 1000).to_f 
-      },
-      
-      :unix_osx => lambda {
-        # This is faster than who and could work on BSD also. 
-        (Time.now.to_f - Time.at(`sysctl -b kern.boottime 2>/dev/null`.unpack('L').first).to_f).to_f
-      },
-      # This should work for most unix flavours. 
-      :unix => lambda {
-        # who is sloooooow. Use File.read('/proc/uptime')
-        (Time.now.to_f - Time.parse(`who -b 2>/dev/null`).to_f)
-      }
-    }
-
+  def find_uptime
     hours = 0
-    
     begin
-      key = platform
-      method = (methods.has_key? key) ? methods[key] : methods[:unix]
-      hours = (method.call) / 3600 # seconds to hours
+      seconds = execute_platform_specific("find_uptime") || 0
+      hours = seconds / 3600 # seconds to hours
     rescue => ex
+      #puts ex.message  # TODO: implement debug?
     end
     hours
   end
 
-
-  #
+  
   # Return the local IP address which receives external traffic
   # from: http://coderrr.wordpress.com/2008/05/28/get-your-local-ip-address/
   # NOTE: This <em>does not</em> open a connection to the IP address. 
-  def local_ip_address
+  def find_ipaddress_internal
     # turn off reverse DNS resolution temporarily 
     orig, Socket.do_not_reverse_lookup = Socket.do_not_reverse_lookup, true   
-    UDPSocket.open {|s| s.connect('75.101.137.7', 1); s.addr.last } # Solutious IP
+    UDPSocket.open {|s| s.connect('65.74.177.129', 1); s.addr.last } # GitHub IP
   ensure  
     Socket.do_not_reverse_lookup = orig
   end
-
-  #
-  # Returns the local IP address based on the hostname. 
-  # According to coderrr (see comments on blog link above), this implementation
-  # doesn't guarantee that it will return the address for the interface external
-  # traffic goes through. It's also possible the hostname isn't resolvable to the
-  # local IP.  
-  def local_ip_address_alt
-    ipaddr = :unknown
-    begin
-      saddr = Socket.getaddrinfo(  Socket.gethostname, nil, Socket::AF_UNSPEC, Socket::SOCK_STREAM, nil, Socket::AI_CANONNAME)
-      ipaddr = saddr.select{|type| type[0] == 'AF_INET' }[0][3]
-    rescue => ex
-    end
-    ipaddr
-  end
-
-  # returns a symbol in the form: os_implementation. This is used throughout Stella
-  # for platform specific support. 
+  
+  # Returns a Symbol of the short platform descriptor in the format: VM-OS
+  # e.g. <tt>:java-unix</tt>
   def platform
-    "#{@os}_#{@implementation}".to_sym
+    "#{@vm}-#{@os}".to_sym
   end
   
-  # Returns Ruby version as an array
-  def ruby
-    RUBY_VERSION.split('.').map { |v| v.to_i }
+  # Returns a String of the full platform descriptor in the format: VM-OS-IMPL-ARCH
+  # e.g. <tt>java-unix-osx-x86_64</tt>
+  def to_s(*args)
+    "#{@vm}-#{@os}-#{@impl}-#{@arch}".to_sym
   end
   
-  # Returns the environment PATH as an Array
-  def paths
-    if @os == :unix
-      (ENV['PATH'] || '').split(':')
-    elsif @os == :win32
-      (ENV['PATH'] || '').split(';') # Not tested!
-    elsif @os == :java
-      delim = @impl == :windows ? ';' : ':'
-      (ENV['PATH'] || '').split(delim)
-    else
-      raise "paths not implemented for: #{@os}"
+    # Returns Ruby version as an Array of Integers. e.g. [1,9,1]
+  def ruby; RUBY_VERSION.split('.').collect { |v| v.to_i }; end
+    # Return the name of the current user
+  def user; ENV['USER']; end
+    # Returns the environment paths as an Array
+  def paths; execute_platform_specific(:paths); end
+    # Returns the path to the current user's home directory
+  def home; execute_platform_specific(:home); end
+    # Returns the name of the current shell
+  def shell; execute_platform_specific(:shell); end
+    # Returns the path to the current temp directory
+  def tmpdir; execute_platform_specific(:tmpdir); end
+  
+ private
+  
+  # Look for and execute a platform specific method. 
+  # The name of the method will be in the format: +dtype-VM-OS-IMPL+.
+  # e.g. find_uptime_ruby_unix_osx
+  #
+  def execute_platform_specific(dtype)
+    criteria = [@vm, @os, @impl]
+    while !criteria.empty?
+      meth = [dtype, criteria].join('_').to_sym
+      return self.send(meth) if SysInfo.private_method_defined?(meth)
+      criteria.pop
     end
+    raise "#{dtype}_#{@vm}_#{@os}_#{@impl} not implemented" 
   end
   
-  def user
-    ENV['USER']
+  def paths_ruby_unix; (ENV['PATH'] || '').split(':'); end
+  def paths_ruby_win32; (ENV['PATH'] || '').split(';'); end # Not tested!
+  def paths_java
+    delim = @impl == :windows ? ';' : ':'
+    (ENV['PATH'] || '').split(delim)
   end
   
-  def home
-    if @os == :unix
-      File.expand_path(ENV['HOME'])
-    elsif @os == :win32
-      File.expand_path(ENV['USERPROFILE'])
-    elsif @os == :java
-      if @impl == :windows
-        File.expand_path(ENV['USERPROFILE'])
-      else
-        File.expand_path(ENV['HOME'])
-      end
-    else
-      raise "paths not implemented for: #{@os}"
-    end
+  def tmpdir_ruby_unix; (ENV['TMPDIR'] || '/tmp'); end
+  def tmpdir_ruby_win32; (ENV['TMPDIR'] || 'C:\\temp'); end
+  def tmpdir_java
+    default = @impl == :windows ? 'C:\\temp' : '/tmp'
+    (ENV['TMPDIR'] || default)
   end
   
-  def shell
-    if @os == :unix
-      (ENV['SHELL'] || 'bash').to_sym
-    elsif @os == :win32
-      :dos
+  def shell_ruby_unix; (ENV['SHELL'] || 'bash').to_sym; end
+  def shell_ruby_win32; :dos; end
+  alias_method :shell_java_unix, :shell_ruby_unix
+  alias_method :shell_java_win32, :shell_ruby_win32
+  
+  def home_ruby_unix; File.expand_path(ENV['HOME']); end
+  def home_ruby_win32; File.expand_path(ENV['USERPROFILE']); end
+  def home_java
+    if @impl == :windows
+      File.expand_path(ENV['USERPROFILE'])
     else
-      raise "paths not implemented for: #{@os}"
+      File.expand_path(ENV['HOME'])
     end
   end
   
-  def tmpdir
-    if @os == :unix
-      (ENV['TMPDIR'] || '/tmp')
-    elsif @os == :win32
-      (ENV['TMPDIR'] || 'C:\\temp')
-    elsif @os == :java
-      default = @impl == :windows ? 'C:\\temp' : '/tmp'
-      (ENV['TMPDIR'] || default)
-    else
-      raise "paths not implemented for: #{@os}"
-    end
+  # Ya, this is kinda wack. Ruby -> Java -> Kernel32. See:
+  # http://www.oreillynet.com/ruby/blog/2008/01/jruby_meets_the_windows_api_1.html
+  # http://msdn.microsoft.com/en-us/library/ms724408(VS.85).aspx
+  # Ruby 1.9.1: Win32API is now deprecated in favor of using the DL library.
+  def find_uptime_java_win32_windows
+    kernel32 = com.sun.jna.NativeLibrary.getInstance('kernel32')
+    buf = java.nio.ByteBuffer.allocate(256)
+    (kernel32.getFunction('GetTickCount').invokeInt([256, buf].to_java).to_f / 1000).to_f
+  end
+  def find_uptime_ruby_win32_windows
+    # Win32API is required in self.guess
+    getTickCount = Win32API.new("kernel32", "GetTickCount", nil, 'L')
+    ((getTickCount.call()).to_f / 1000).to_f
+  end
+  def find_uptime_ruby_unix_osx
+    # This is faster than "who" and could work on BSD also. 
+    (Time.now.to_f - Time.at(`sysctl -b kern.boottime 2>/dev/null`.unpack('L').first).to_f).to_f
   end
   
-  # Print friendly system information. 
-  ##def to_s
-  ##  sprintf("Hostname: %s#{$/}IP Address: %s#{$/}System: %s#{$/}Uptime: %.2f (hours)#{$/}Ruby: #{ruby.join('.')}", 
-  ##    @hostname, @ipaddress, "#{@os}-#{@implementation}-#{@architecture}", @uptime)
-  ##end
+  # This should work for most unix flavours.
+  def find_uptime_ruby_unix
+    # who is sloooooow. Use File.read('/proc/uptime')
+    (Time.now.to_i - Time.parse(`who -b 2>/dev/null`).to_f)
+  end
+  alias_method :find_uptime_java_unix_osx, :find_uptime_ruby_unix
   
+  # Determine the values for vm, os, impl, and arch when running on Java. 
+  def guess_java
+    vm, os, impl, arch = :java, :unknown, :unknown, :unknown
+    require 'java'
+    include_class java.lang.System
+    
+    osname = System.getProperty("os.name")
+    IMPLEMENTATIONS.each do |r, o, i|
+      next unless osname =~ r
+      os, impl = [o, i]
+      break
+    end
+    
+    osarch = System.getProperty("os.arch")
+    ARCHITECTURES.each do |r, a|
+      next unless osarch =~ r
+      arch = a
+      break
+    end
+    [vm, os, impl, arch]
+  end
   
+  # Returns the local IP address based on the hostname. 
+  # According to coderrr (see comments on blog link above), this implementation
+  # doesn't guarantee that it will return the address for the interface external
+  # traffic goes through. It's also possible the hostname isn't resolvable to the
+  # local IP.  
+  #
+  # NOTE: This code predates the current ip_address_internal. It was just as well
+  # but the other code is cleaner. I'm keeping this old version here for now.
+  def ip_address_internal_alt
+    ipaddr = :unknown
+    begin
+      saddr = Socket.getaddrinfo(  Socket.gethostname, nil, Socket::AF_UNSPEC, Socket::SOCK_STREAM, nil, Socket::AI_CANONNAME)
+      ipaddr = saddr.select{|type| type[0] == 'AF_INET' }[0][3]
+    rescue => ex
+    end
+    ipaddr
+  end
 end
 
 

data/sysinfo.gemspec

@@ -1,7 +1,7 @@
 @spec = Gem::Specification.new do |s|
 	s.name = "sysinfo"
   s.rubyforge_project = "sysinfo"
-	s.version = "0.5.0"
+	s.version = "0.5.1"
 	s.summary = "SysInfo: All your system-independent infoz in one handy class. "
 	s.description = s.summary
   s.author = "Delano Mandelbaum"
@@ -12,12 +12,11 @@
   # = EXECUTABLES =
   # The list of executables in your project (if any). Don't include the path, 
   # just the base filename.
-  s.executables = %w[]
+  s.executables = %w[sysinfo]
   
   # = DEPENDENCIES =
   # Add all gem dependencies
-  #s.add_dependency ''
-  #s.add_dependency '', '>= 0.0'
+  s.add_dependency 'storable', '>= 0.5.1'
     
   # = MANIFEST =
   # The complete list of files to be included in the release. When GitHub packages your gem, 
@@ -30,6 +29,7 @@
   LICENSE.txt
   README.rdoc
   Rakefile
+  bin/sysinfo
   lib/sysinfo.rb
   sysinfo.gemspec
   )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sysinfo
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -12,6 +12,16 @@ cert_chain: []
 date: 2009-05-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: storable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
 - !ruby/object:Gem::Dependency 
   name: RedCloth
   type: :runtime
@@ -24,8 +34,8 @@ dependencies:
     version: 
 description: "SysInfo: All your system-independent infoz in one handy class."
 email: delano@solutious.com
-executables: []
-
+executables: 
+- sysinfo
 extensions: []
 
 extra_rdoc_files: 
@@ -36,6 +46,7 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- bin/sysinfo
 - lib/sysinfo.rb
 - sysinfo.gemspec
 has_rdoc: true