sys-uptime 0.4.4

data/CHANGES

@@ -0,0 +1,105 @@
+== 0.4.4 - 30-Jun-2006
+* Added inline rdoc documentation to the source files.
+* Added a gemspec.
+
+== 0.4.3 - 18-Dec-2005
+* Changed the Linux version to pure Ruby.  The current method of determining
+  uptime in unix.c does not work in Linux kernel 2.6+.  So, from now on it
+  reads out of /proc/uptime.
+
+== 0.4.2 - 6-May-2005
+* Fixed a potential boot_time bug.
+* Removed the version.h file.  It's no longer needed since the Windows
+  version is pure Ruby.
+* NetBSD 2.x and FreeBSD 5.x now supported.
+* Removed the INSTALL file.  Installation instructions are now in
+  the README file.
+* Removed the uptime.rd file.  You can generate html documentation by
+  running rdoc over the uptime.txt file.
+* Made most documents rdoc friendly.
+* Moved project to RubyForge.
+
+== 0.4.1 - 14-Dec-2004
+* Moved freebsd code into unix.c file.
+* Should now work past 249 days (2**31) on systems that have utmpx.h.
+* Fixed a bug with regards to boot_time, where it was possible that it would
+  simply be empty.
+
+== 0.4.0 - 8-Jul-2004
+* Removed all reference to the CLK_TCK constant, as per documentation from
+  Richard Stevens that it is deprecated and that sysconf() should be used
+  instead (well, I knew about this, but ignored it until now).
+* Scrapped the C version for Windows in favor of a pure Ruby version that
+  uses win32ole + WMI.
+* Added a boot_time method for Unix systems (Windows already had this).
+* Added an UptimeError class on Unix systems (and replaced UptimeException
+  on Windows).
+* Modified an internal function to raise an UptimeError if the times()
+  function fails.  Also, it now returns an unsigned long instead of a plain
+  long.
+* Replaced the two different test suites with a single, unified test suite.
+* Cleaned up the extconf.rb script.  I now assume that TestUnit is installed.
+* Removed the load_avg method (which was never advertised and which I hope
+  you weren't using).  You can find a load_avg method in the sys-cpu package.
+* Changed uptime.rd2 to uptime.rd to be consistent with my other packages.
+* Removed the uptime.html file - you may generate that on your own.
+* Added warranty and license info.
+
+== 0.3.2 - 30-Dec-2003
+* Cleaned up some warnings that showed up with -Wall on some unix platforms
+  (int vs long format, explicit include)
+* Minor test suite and extconf.rb changes
+
+== 0.3.1 - 25-Jun-2003
+* Modified test files to handle HP-UX extensions
+* Minor doc updates
+* Added the dhms() method.  Actually, this was in the 0.3.0
+  release, I just forgot to mention it in this file :)
+
+== 0.3.0 - 22-Jun-2003
+* Added OS X support - thanks go to Mike Hall for the patch
+* Fixed incorrect values in FreeBSD (again Mike Hall)
+* Modified tc_unix.rb test suite to handle OS X, along with a bit
+* of minor cleanup
+* Removed VERSION class method.  Use the constant instead
+* Separated FreeBSD/OS X source into its own file (freebsd.c).
+  The #ifdefs were starting to get too ugly for me
+
+== 0.2.1 - 13-May-2003
+* Fixed bug in extconf.rb file, and made some major changes
+* Modified test.rb for those without TestUnit
+* Modified TestUnit tests - some bogus tests were removed
+* Added a README file with some additional info
+* Created a version.h file, so that I can keep the VERSION number
+  in one place
+* Docs automatically included in doc directory (i.e. no more interactive
+  document creation)
+
+== 0.2.0 - 13-Mar-2003
+* Added MS Windows support
+* Added a VERSION constant
+* Added a test suite (for those with TestUnit installed)
+* Internal directory layout change
+* uptime.c is now split into unix.c and windows.c (and linked appropriately)
+* Changelog and Manifest are now CHANGES and MANIFEST, respectively
+* Many changes to extconf.rb
+
+== 0.1.3 - 6-Jan-2003
+* Added a VERSION class method
+* Added a copyright notice
+* Fixed up the docs a bit and moved them to the doc directory
+* Changed the tarball name to match the RAA package name
+* Modified test.rb script to make it better
+* Changed install instructions slightly
+
+== 0.1.2 - 25-Aug-2002
+* Slight change to preprocessor commands to avoid redefining CLK_TCK on
+  those systems that define it in time.h
+* Added an INSTALL file
+
+== 0.1.1 - 21-Jun-2002
+* The CLK_TCK constant wasn't necessarily being set correctly, which could
+  lead to some odd results.  This has been fixed.
+
+== 0.1.0 - 17-Jun-2002
+* Initial release

data/MANIFEST

@@ -0,0 +1,15 @@
+CHANGES
+MANIFEST
+README
+extconf.rb
+install.rb
+sys-uptime.gemspec
+
+doc/uptime.txt
+
+examples/test.rb
+
+lib/os/unix.c
+lib/os/windows.rb
+
+test/tc_uptime.rb

data/README

@@ -0,0 +1,20 @@
+== Description
+   A Ruby interface for getting system uptime information.
+
+== Prerequisites
+   Ruby 1.8.0 or later.
+   On Win32 systems, Ruby 1.8.2 or later is recommended.
+
+== Installation
+=== Unix:
+ruby extconf.rb
+make
+ruby test/tc_uptime.rb (optional)
+make site-install
+
+=== Windows and Linux:
+ruby test\tc_uptime.rb (optional)
+ruby install.rb
+
+== Notes
+For additional documentation see doc/uptime.txt.

data/doc/uptime.txt

@@ -0,0 +1,97 @@
+== Synopsis
+   require 'sys/uptime'
+   include Sys
+
+   p Uptime.days
+   p Uptime.hours
+   p Uptime.minutes
+   p Uptime.seconds
+   p Uptime.dhms.join(', ')
+   p Uptime.uptime
+   p Uptime.boot_time
+
+== Description
+   This package provides uptime and boot time information, similar to the
+   'uptime' Unix command.
+    
+== Constants
+VERSION
+   Returns the current version number of this package (as a string).
+    
+== Class Methods
+Uptime.boot_time
+   Returns the boot time as a Time object.
+    
+Uptime.days
+   Returns the total number of days the system has been up.
+    
+Uptime.hours
+   Returns the total number of hours the system has been up.
+    
+Uptime.minutes
+   Returns the total number of minutes the system has been up.
+    
+Uptime.seconds
+   Returns the total number of seconds the system has been up.
+    
+Uptime.dhms
+   Calculates and returns the number of days, hours, minutes and
+   seconds the system has been running as a four-element Array.
+    
+Uptime.uptime
+   Calculates and returns the number of days, hours, minutes and
+   seconds the system has been running as a colon-separated string.
+    
+== Exceptions
+UptimeError
+   Raised if something goes wrong.  On Unix, this would likely mean a
+   failure of the times() function.  On Windows, it probably means you
+   failed to connect to WMI properly.
+    
+== Notes
+   On MS Windows each of the class methods optionally takes a host name as
+   a single argument. The default is localhost (or whatever the result of
+   Socket.gethostname returns).
+
+   The current time, users and load average are NOT included in this
+   module, even though you may be used to seeing them with the command
+   line version of 'uptime'.  This is because these things have
+   _absolutely nothing_ to do with uptime (at least, not as I
+   logically think of uptime).
+    
+   This package was tested successfully on a Solaris system with over 1600
+   days of uptime.
+    
+== Known Bugs
+   None that I am aware of.  Please log any bugs you find on the project
+   website at http://www.rubyforge.org/projects/sysutils.
+
+== Questions
+   "Doesn't Struct::Tms do this?" - No.
+    
+== License
+   Ruby's
+    
+== Copyright
+   Copyright 2002-2006, Daniel J. Berger
+
+   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.
+
+== Acknowledgements
+   Mike Hall for help with the BSD side of things.
+   Ola Eriksson, whose source code I shamelessly plagiarized to get a better
+   implementation for systems that have the utmpx.h header file.
+
+== Author
+   Daniel J. Berger
+   djberg96 at gmail dot com
+   imperator on IRC (Freenode)
+    
+== See Also
+   uptime

data/extconf.rb

@@ -0,0 +1,36 @@
+##############################################
+# extconf.rb
+#
+# Configuration & build script for sys-uptime
+##############################################
+require 'mkmf'
+require 'ftools'
+
+#######################################################################
+# In case this is run more than one time, delete the link/copy if it
+# already exists.
+#######################################################################
+uptime_file = "uptime.c"
+File.delete(uptime_file) if File.exists?(uptime_file)
+
+case RUBY_PLATFORM
+   when /windows|win32|cygwin|mingw|dos|linux/i
+      STDERR.puts "Run the 'install.rb' script instead on this platform"
+      exit
+   else 
+      have_header("sys/loadavg.h")
+      c_file = "lib/os/unix.c"
+
+      File.symlink(c_file, uptime_file)
+
+      if File.exists?("lib/os/windows.rb")
+         File.move("lib/os/windows.rb", "lib/os/windows.orig") # Don't install
+      end
+
+      if File.exists?("lib/os/linux.rb")
+         File.move("lib/os/linux.rb", "lib/os/linux.orig") # Don't install
+      end
+end
+
+have_header("utmpx.h")
+create_makefile('sys/uptime')

data/lib/os/unix.c

@@ -0,0 +1,231 @@
+/******************************************************************************
+ * unix.c (uptime.c)
+ *
+ * Authors:
+ *    Daniel Berger
+ *    Mike Hall
+ *
+ * sys-uptime source code for most *nix platforms
+ *****************************************************************************/
+#include "ruby.h"
+
+#if defined (__FreeBSD__) || defined (__NetBSD__)
+#include <sys/time.h>
+
+#if defined (__NetBSD__)
+#include <sys/param.h>
+#endif
+
+#if (__FreeBSD >= 5)
+#include <sys/types.h>
+#endif
+
+#include <sys/sysctl.h>
+
+#else
+#include <sys/times.h>
+#include <unistd.h>
+#include <time.h>
+
+#ifdef HAVE_UTMPX_H
+#include <utmpx.h>
+#endif
+
+#ifdef HAVE_SYS_LOADAVG_H
+#include <sys/loadavg.h>
+#endif
+
+#ifdef _SC_CLK_TCK
+#define TICKS sysconf(_SC_CLK_TCK)
+#else
+#define TICKS sysconf(CLOCKS_PER_SEC)
+#endif
+
+#endif
+
+#define MAXSTRINGSIZE 32 /* reasonable limit */
+
+#define SYS_UPTIME_VERSION "0.4.4"
+
+VALUE cUptimeError;
+
+unsigned long get_uptime_secs()
+{
+#if defined (__FreeBSD__) || defined (__NetBSD__)
+   struct timeval tv;
+   size_t tvlen = sizeof(tv);
+   int mib[2];
+
+   mib[0] = CTL_KERN;
+   mib[1] = KERN_BOOTTIME;
+   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0)){
+      rb_raise(cUptimeError,"sysctl() call failed");
+   }
+   return time(NULL) - tv.tv_sec;
+#else
+   struct tms tms;
+   unsigned long seconds;
+   seconds = times(&tms) / TICKS;
+   
+   if(-1 == seconds)
+      rb_raise(cUptimeError,"times() function failed");
+      
+   if(seconds < 0)
+      rb_raise(cUptimeError,"value returned larger than type could handle");
+   
+   return seconds;
+#endif
+}
+
+/*
+ * call-seq:
+ *    Uptime.seconds
+ *
+ * Returns the total number of seconds the system has been up.
+ */
+static VALUE uptime_seconds()
+{
+   return UINT2NUM(get_uptime_secs());
+}
+
+/*
+ * call-seq:
+ *    Uptime.minutes
+ * 
+ * Returns the total number of minutes the system has been up.
+ */
+static VALUE uptime_minutes()
+{
+   return UINT2NUM(get_uptime_secs() / 60);
+}
+
+/*
+ * call-seq:
+ *    Uptime.hours
+ *
+ * Returns the total number of hours the system has been up.
+ */
+static VALUE uptime_hours()
+{
+   return UINT2NUM(get_uptime_secs() / 3600);
+}
+
+/*
+ * call-seq:
+ *    Uptime.days
+ *
+ * Returns the total number of days the system has been up.
+ */
+static VALUE uptime_days()
+{
+   return UINT2NUM(get_uptime_secs() / 86400);
+}
+
+/*
+ * call-seq:
+ *    Uptime.uptime
+ *
+ * Calculates and returns the number of days, hours, minutes and
+ * seconds the system has been running as a colon-separated string.
+ */
+static VALUE uptime_uptime()
+{
+   char c_string[MAXSTRINGSIZE];
+   long seconds, days, hours, minutes;
+ 
+   seconds = get_uptime_secs();
+   days = seconds/86400;
+   seconds -= days*86400;
+   hours = seconds/3600;
+   seconds -= hours*3600;
+   minutes = seconds/60;
+   seconds -= minutes*60;
+
+   sprintf(c_string, "%ld:%ld:%ld:%ld", days, hours, minutes, seconds);
+   return rb_str_new2(c_string);
+}
+
+/*
+ * call-seq:
+ *    Uptime.dhms
+ *
+ * Calculates and returns the number of days, hours, minutes and
+ * seconds the system has been running as a four-element Array.
+ */
+static VALUE uptime_dhms()
+{
+   VALUE a = rb_ary_new2(4);
+   long s, m, h, d;
+
+   s = get_uptime_secs();
+   d =  s                / (24*60*60);
+   h = (s -= d*24*60*60) / (   60*60);
+	m = (s -= h*   60*60) /        60;
+	s      -= m*      60;
+
+	rb_ary_push(a, INT2FIX(d));
+	rb_ary_push(a, INT2FIX(h));
+	rb_ary_push(a, INT2FIX(m));
+	rb_ary_push(a, INT2FIX(s));
+	return a;
+}
+
+/*
+ * call-seq:
+ *    Uptime.boot_time
+ *
+ * Returns the boot time as a Time object.
+ */
+static VALUE uptime_btime(){
+#if defined (__FreeBSD__) || defined (__NetBSD__)
+   struct timeval tv;
+   size_t tvlen = sizeof(tv);
+   int mib[2];
+
+   mib[0] = CTL_KERN;
+   mib[1] = KERN_BOOTTIME;
+   if(sysctl(mib, 2, &tv, &tvlen, NULL, 0)){
+      rb_raise(cUptimeError,"sysctl() call failed");
+   }
+   return rb_time_new(tv.tv_sec,tv.tv_usec);
+#else
+#ifdef HAVE_UTMPX_H
+   struct utmpx* ent;
+ 
+   setutxent();
+
+   while( (ent = getutxent()) ){
+      if(ent->ut_type == BOOT_TIME){
+         return rb_time_new(ent->ut_tv.tv_sec,ent->ut_tv.tv_usec);
+      }      
+   }
+
+   endutxent();
+#else
+   rb_raise(cUptimeError,"boot_time() not implemented on this platform");
+#endif
+#endif
+   return Qnil;
+}
+
+void Init_uptime()
+{
+   VALUE mSys, cUptime;
+
+   /* Modules and Classes */
+   mSys = rb_define_module("Sys");
+   cUptime = rb_define_class_under(mSys, "Uptime", rb_cObject);
+   cUptimeError = rb_define_class_under(mSys, "UptimeError", rb_eStandardError);
+   
+   /* Constants */
+   rb_define_const(cUptime, "VERSION", rb_str_new2(SYS_UPTIME_VERSION));
+
+   /* Class Methods */
+   rb_define_singleton_method(cUptime, "seconds", uptime_seconds, 0);
+   rb_define_singleton_method(cUptime, "minutes", uptime_minutes, 0);
+   rb_define_singleton_method(cUptime, "hours",   uptime_hours,   0);
+   rb_define_singleton_method(cUptime, "days",    uptime_days,    0);
+   rb_define_singleton_method(cUptime, "uptime",  uptime_uptime,  0);
+   rb_define_singleton_method(cUptime, "dhms",    uptime_dhms,    0);
+   rb_define_singleton_method(cUptime, "boot_time", uptime_btime, 0);
+}

data/test/tc_uptime.rb

@@ -0,0 +1,82 @@
+#################################
+# tc_uptime.rb
+#
+# Test suite for sys-uptime
+#################################
+base = File.basename(Dir.pwd)
+if base == "test" || base =~ /sys-uptime.*/
+   require "ftools"
+   Dir.chdir("..") if base == "test"
+
+   extension = ".so"
+   extension = ".bundle" if RUBY_PLATFORM =~ /powerpc|darwin/i
+   extension = ".sl" if RUBY_PLATFORM =~ /hpux/i
+   
+   Dir.mkdir("sys") unless File.exists?("sys")
+
+   if PLATFORM.match("mswin")
+      File.copy("lib/os/windows.rb", "sys/uptime.rb")
+   elsif PLATFORM.match("linux")
+      File.copy("lib/os/linux.rb", "sys/uptime.rb")
+   else
+      file = "uptime" + extension  
+      File.copy(file,"sys")
+   end
+   $LOAD_PATH.unshift Dir.pwd
+end
+
+require "sys/uptime"
+require "test/unit"
+include Sys
+
+class TC_Uptime < Test::Unit::TestCase
+   def test_version
+      assert_equal('0.4.4', Uptime::VERSION, "Bad VERSION")
+   end
+
+   def test_seconds
+      assert_respond_to(Uptime, :seconds)
+      assert_nothing_raised{ Uptime.seconds }
+      assert_kind_of(Fixnum, Uptime.seconds,"Bad seconds() type")
+      assert_equal(true, Uptime.seconds > 0, "Bad seconds() return value")
+   end
+
+   def test_minutes
+      assert_respond_to(Uptime, :minutes)
+      assert_nothing_raised{ Uptime.minutes }
+      assert_kind_of(Fixnum, Uptime.minutes,"Bad minutes() type")
+   end
+
+   def test_hours
+      assert_respond_to(Uptime, :hours)
+      assert_nothing_raised{ Uptime.hours }
+      assert_kind_of(Fixnum, Uptime.hours,"Bad hours() type")
+   end
+
+   def test_days
+      assert_respond_to(Uptime,:days)
+      assert_nothing_raised{ Uptime.days }
+      assert_kind_of(Fixnum, Uptime.days,"Bad days() type")
+   end 
+
+   def test_uptime
+      assert_respond_to(Uptime,:uptime)
+      assert_nothing_raised{ Uptime.uptime }
+      assert_kind_of(String, Uptime.uptime,"Bad uptime() type")
+      assert_equal(false, Uptime.uptime.empty?,"Empty string uptime()")
+   end
+   
+   def test_dhms
+      assert_respond_to(Uptime,:dhms)
+      assert_nothing_raised{ Uptime.dhms }
+      assert_kind_of(Array, Uptime.dhms,"Bad uptime() type")
+      assert_equal(false, Uptime.dhms.empty?,"Empty array from dhms()")
+      assert_equal(4, Uptime.dhms.length)
+   end
+   
+   def test_boot_time
+      assert_respond_to(Uptime,:boot_time)
+      assert_nothing_raised{ Uptime.boot_time }
+      assert_kind_of(Time, Uptime.boot_time)
+   end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: sys-uptime
+version: !ruby/object:Gem::Version 
+  version: 0.4.4
+date: 2006-06-30 00:00:00 -06:00
+summary: A Ruby interface for getting system uptime information.
+require_paths: 
+- lib
+email: djberg96@gmail.com
+homepage: http://www.rubyforge.org/projects/sysutils
+rubyforge_project: sysutils
+description: A Ruby interface for getting system uptime information.
+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/uptime.txt
+- test/tc_uptime.rb
+- CHANGES
+- MANIFEST
+- README
+- extconf.rb
+- lib/os/unix.c
+test_files: 
+- test/tc_uptime.rb
+rdoc_options: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+executables: []
+
+extensions: 
+- extconf.rb
+requirements: []
+
+dependencies: []
+