net-ping 1.3.2 → 1.3.3

data/CHANGES

@@ -1,3 +1,14 @@
+== 1.3.3 - 21-Jun-2010
+* Bug fixes for JRuby on MS Windows. The code now explicitly checks for JRuby
+  in a few places to ensure it doesn't try to load unsupported libraries
+  on MS Windows. Thanks go to Rob Schultz for the spot and some patches.
+* The Net::Ping::HTTP class will no longer fail because a root URI
+  is missing a trailing slash. If the URI#path is empty, it now defaults
+  to the root path.
+* The Rakefile tasks and naming were refactored.
+* Some tests were refactored to take advantage of test-unit 2.x features,
+  as well as make them better and more descriptive in general.
+
 == 1.3.2 - 21-Sep-2009
 * Doing a 'require "net/ping"' was not automatically loading the
   Net::Ping::WMI class on MS Windows. This has been fixed. Thanks go to

data/README

@@ -4,17 +4,13 @@
 == Prerequisites
    * Ruby 1.8.0 or later
    * The win32-open3 (1.8.x) and windows-pr libraries are required on
-     MS Windows when using the Net::Ping::External class.
+     MS Windows when using the Net::Ping::External class unless you're
+     using JRuby.
    * Windows 2000 or later is required to use the Ping::WMI class.
 
 == Installation
-=== Remote Installation
    gem install net-ping
 
-=== Local Installation
-   rake test (optional)
-   rake install (standard) OR rake gem_install (gems)
-
 == Notes
    Please read the documentation under the 'doc' directory. Especially pay
    attention to the documentation pertaining to ECONNREFUSED and TCP pings.
@@ -40,6 +36,8 @@
    
 == Known Issues
    Older versions of Ruby 1.9.x may not work with UDP pings.
+   As of JRuby 1.5.1, UDP pings will return false positives because of an
+   incorrect error class being raised. See JRuby-4896.
 
 == License
    Artistic 2.0

data/Rakefile

@@ -2,31 +2,18 @@ require 'rake'
 require 'rake/testtask'
 include Config
 
-desc "Install the net-ping package (non-gem)"
-task :install do
-   dest1 = File.join(CONFIG['sitelibdir'], 'net')
-   dest2 = File.join(dest1, 'ping')
-
-   Dir.mkdir(dest1) unless File.exists?(dest1)
-   Dir.mkdir(dest2) unless File.exists?(dest2)
-
-   FileUtils.cp('lib/net/ping.rb', dest1, :verbose => true)
-
-   Dir['lib/net/ping/*.rb'].each{ |file|
-      FileUtils.cp(file, dest2, :verbose => true)
-   }
-end
-
-desc 'Create and install the net-ping gem'
-task :gem_install => [:gem] do
-   gem_file = Dir["*.gem"].first
-   sh "gem install #{gem_file}"
-end
+namespace 'gem' do
+  desc 'Create the net-ping gem'
+  task :create do
+    spec = eval(IO.read('net-ping.gemspec'))
+    Gem::Builder.new(spec).build
+  end
 
-desc 'Create the net-ping gem'
-task :gem do
-   spec = eval(IO.read('net-ping.gemspec'))
-   Gem::Builder.new(spec).build
+  desc 'Install the net-ping gem'
+  task :install => [:create] do
+    gem_file = Dir["*.gem"].first
+    sh "gem install #{gem_file}"
+  end
 end
 
 namespace 'example' do

data/doc/ping.txt

@@ -238,7 +238,7 @@ Ping#warning
    Artistic 2.0
 
 = Copyright
-   (C) 2003-2009 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2010 Daniel J. Berger, All Rights Reserved
 
 = Warranty
    This package is provided "as is" and without any express or
@@ -247,5 +247,3 @@ Ping#warning
 
 = Author
    Daniel J. Berger
-   djberg96 at gmail dot com
-   imperator on IRC (irc.freenode.net)

data/lib/net/ping.rb

@@ -10,6 +10,8 @@ require File.join(File.dirname(__FILE__), 'ping/icmp')
 require File.join(File.dirname(__FILE__), 'ping/external')
 require File.join(File.dirname(__FILE__), 'ping/http')
 
-if Config::CONFIG['host_os'] =~ /dos|mswin|cygwin|mingw|win32/i
-   require File.join(File.dirname(__FILE__), 'ping/wmi')
+if Config::CONFIG['host_os'] =~ /msdos|mswin|cygwin|mingw|win32/i &&
+  JAVA_PLATFORM != 'java'
+then
+  require File.join(File.dirname(__FILE__), 'ping/wmi')
 end

data/lib/net/ping/external.rb

@@ -1,119 +1,126 @@
 require 'rbconfig'
 require File.join(File.dirname(__FILE__), 'ping')
 
-if Config::CONFIG['host_os'] =~ /mswin|win32|dos|cygwin|mingw/i
-   if RUBY_VERSION.to_f < 1.9
-      require 'win32/open3'
-   end
-   require 'windows/console'
+if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i &&
+  RUBY_PLATFORM != 'java'
+then
+  if RUBY_VERSION.to_f < 1.9
+    require 'win32/open3'
+  end
+  require 'windows/console'
 else
-   require 'open3'            
+  require 'open3'            
 end
 
 # The Net module serves as a namespace only.
 module Net
 
-   # The Ping::External class encapsulates methods for external (system) pings.
-   class Ping::External < Ping
+  # The Ping::External class encapsulates methods for external (system) pings.
+  class Ping::External < Ping
+
+    CWINDOWS = Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i &&
+      RUBY_PLATFORM != 'java'
       
-      if Config::CONFIG['host_os'] =~ /mswin|win32|dos|cygwin|mingw/i
-         include Windows::Console
-      end 
+    if CWINDOWS
+      include Windows::Console
+    end 
    
-      # Pings the host using your system's ping utility and checks for any
-      # errors or warnings. Returns true if successful, or false if not.
-      # 
-      # If the ping failed then the Ping::External#exception method should
-      # contain a string indicating what went wrong. If the ping succeeded then
-      # the Ping::External#warning method may or may not contain a value.
-      # 
-      def ping(host = @host)
-         super(host)
+    # Pings the host using your system's ping utility and checks for any
+    # errors or warnings. Returns true if successful, or false if not.
+    # 
+    # If the ping failed then the Ping::External#exception method should
+    # contain a string indicating what went wrong. If the ping succeeded then
+    # the Ping::External#warning method may or may not contain a value.
+    # 
+    def ping(host = @host)
+      super(host)
 
-         input, output, error = ""
-         pstring = "ping "
-         bool    = false
-         orig_cp = nil
-         
-         case Config::CONFIG['host_os']
-            when /linux|bsd|osx|mach|darwin/i
-               pstring += "-c 1 #{host}"
-            when /solaris|sunos/i
-               pstring += "#{host} 1"
-            when /hpux/i
-               pstring += "#{host} -n 1"
-            when /win32|windows|mswin/i
-               orig_cp = GetConsoleCP()
-               SetConsoleCP(437) if orig_cp != 437 # United States
-               pstring += "-n 1 #{host}"
-            else
-               pstring += "#{host}"
-         end
-         
-         start_time = Time.now
-         
-         begin
-           e = nil
+      input, output, error = ""
+      pstring = "ping "
+      bool    = false
+      orig_cp = nil
+       
+      case Config::CONFIG['host_os']
+        when /linux|bsd|osx|mach|darwin/i
+          pstring += "-c 1 #{host}"
+        when /solaris|sunos/i
+          pstring += "#{host} 1"
+        when /hpux/i
+          pstring += "#{host} -n 1"
+        when /win32|windows|msdos|mswin|cygwin|mingw/i
+          if RUBY_PLATFORM != 'java'
+            orig_cp = GetConsoleCP()
+            SetConsoleCP(437) if orig_cp != 437 # United States
+          end
+          pstring += "-n 1 #{host}"
+        else
+          pstring += "#{host}"
+      end
+       
+      start_time = Time.now
+       
+      begin
+        err = nil
 
-           Timeout.timeout(@timeout){
-              input, output, error = Open3.popen3(pstring)
-              e = error.gets # Can't chomp yet, might be nil
-           }
+        Timeout.timeout(@timeout){
+          input, output, error = Open3.popen3(pstring)
+          err = error.gets # Can't chomp yet, might be nil
+        }
 
-           input.close
-           error.close
+        input.close
+        error.close
 
-           if Config::CONFIG['host_os'] =~ /mswin|win32|dos/i &&
-              GetConsoleCP() != orig_cp
-           then
-              SetConsoleCP(orig_cp)
-           end
-        
-           unless e.nil?
-              if e =~ /warning/i
-                 @warning = e.chomp
-                 bool = true
-              else
-                 @exception = e.chomp
-              end
-           # The "no answer" response goes to stdout, not stderr, so check it
-           else
-              lines = output.readlines
-              output.close
-              if lines.nil? || lines.empty?
-                 bool = true
-              else
-                 regexp = /
-                    no\ answer|
-                    host\ unreachable|
-                    could\ not\ find\ host|
-                    request\ timed\ out|
-                    100%\ packet\ loss
-                 /ix
-                 lines.each{ |line|
-                    if regexp.match(line)
-                       @exception = line.chomp
-                       break
-                    end
-                 }
-                 bool = true unless @exception
-              end
-           end
-         rescue Exception => err
-           @exception = err.message 
-         ensure
-           input.close if input && !input.closed?
-           error.close if error && !error.closed?
-           output.close if output && !output.closed?
-         end
+        if CWINDOWS && GetConsoleCP() != orig_cp
+          SetConsoleCP(orig_cp)
+        end
+      
+        unless err.nil?
+          if err =~ /warning/i
+            @warning = err.chomp
+            bool = true
+          else
+            @exception = err.chomp
+          end
+        # The "no answer" response goes to stdout, not stderr, so check it
+        else
+          lines = output.readlines
+          output.close
+          if lines.nil? || lines.empty?
+            bool = true
+          else
+            regexp = /
+              no\ answer|
+              host\ unreachable|
+              could\ not\ find\ host|
+              request\ timed\ out|
+              100%\ packet\ loss
+            /ix
 
-         # There is no duration if the ping failed
-         @duration = Time.now - start_time if bool
+            lines.each{ |line|
+              if regexp.match(line)
+                @exception = line.chomp
+                break
+              end
+            }
 
-         bool
+            bool = true unless @exception
+          end
+        end
+      rescue Exception => error
+        @exception = error.message 
+      ensure
+        input.close if input && !input.closed?
+        error.close if error && !error.closed?
+        output.close if output && !output.closed?
       end
 
-      alias ping? ping
-      alias pingecho ping
-   end
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      bool
+    end
+
+    alias ping? ping
+    alias pingecho ping
+  end
 end

data/lib/net/ping/http.rb

@@ -5,91 +5,94 @@ require 'rbconfig'
 
 # Force non-blocking Socket.getaddrinfo on Unix systems. Do not use on
 # Windows because it (ironically) causes blocking problems.
-unless Config::CONFIG['host_os'] =~ /mswin|win32|dos|cygwin|mingw/i
-   require 'resolv-replace'
+unless Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i
+  require 'resolv-replace'
 end
 
 # The Net module serves as a namespace only.
 module Net
    
-   # The Ping::HTTP class encapsulates methods for HTTP pings.
-   class Ping::HTTP < Ping
+  # The Ping::HTTP class encapsulates methods for HTTP pings.
+  class Ping::HTTP < Ping
       
-      # By default an http ping will follow a redirect and give you the result
-      # of the final URI.  If this value is set to false, then it will not
-      # follow a redirect and will return false immediately on a redirect.
-      # 
-      attr_accessor :follow_redirect
+    # By default an http ping will follow a redirect and give you the result
+    # of the final URI.  If this value is set to false, then it will not
+    # follow a redirect and will return false immediately on a redirect.
+    # 
+    attr_accessor :follow_redirect
       
-      # Creates and returns a new Ping::HTTP object.  Note that the default
-      # port for Ping::HTTP is 80.
-      # 
-      def initialize(uri=nil, port=80, timeout=5)
-         @follow_redirect = true
-         super(uri, port, timeout)
-      end
+    # Creates and returns a new Ping::HTTP object.  Note that the default
+    # port for Ping::HTTP is 80.
+    # 
+    def initialize(uri=nil, port=80, timeout=5)
+      @follow_redirect = true
+      super(uri, port, timeout)
+    end
 
-      # Looks for an HTTP response from the URI passed to the constructor.
-      # If the result is a kind of Net::HTTPSuccess then the ping was
-      # boolful and true is returned.  Otherwise, false is returned
-      # and the Ping::HTTP#exception method should contain a string
-      # indicating what went wrong.
-      # 
-      # If the HTTP#follow_redirect accessor is set to true (which it is
-      # by default) and a redirect occurs during the ping, then the
-      # HTTP#warning attribute is set to the redirect message, but the
-      # return result is still true.  If it's set to false then a false
-      # value is returned if a redirect occurs.
-      # 
-      def ping(host = @host)
-         super(host)
-         bool = false
-         uri = URI.parse(host)
+    # Looks for an HTTP response from the URI passed to the constructor.
+    # If the result is a kind of Net::HTTPSuccess then the ping was
+    # successful and true is returned.  Otherwise, false is returned
+    # and the Ping::HTTP#exception method should contain a string
+    # indicating what went wrong.
+    # 
+    # If the HTTP#follow_redirect accessor is set to true (which it is
+    # by default) and a redirect occurs during the ping, then the
+    # HTTP#warning attribute is set to the redirect message, but the
+    # return result is still true. If it's set to false then a redirect
+    # response is considered a failed ping.
+    #
+    # If no file or path is specified in the URI, then '/' is assumed.
+    # 
+    def ping(host = @host)
+      super(host)
+      bool = false
+      uri = URI.parse(host)
 
-         start_time = Time.now
+      start_time = Time.now
 
-         begin
-            response = nil
-            Timeout.timeout(@timeout){
-               response = Net::HTTP.get_response(uri.host, uri.path, @port)
-            }
-         rescue Exception => err
-            @exception = err.message
-         else
+      begin
+        response = nil
+        uri_path = uri.path.empty? ? '/' : uri.path
+        Timeout.timeout(@timeout){
+          response = Net::HTTP.get_response(uri.host, uri_path, @port)
+        }
+      rescue Exception => err
+        @exception = err.message
+      else
+        if response.is_a?(Net::HTTPSuccess)
+          bool = true
+        else
+          if @follow_redirect
+            @warning = response.message
+                
+            while response.is_a?(Net::HTTPRedirection)
+              redirect = URI.parse(response['location']) 
+              redirect = uri + redirect if redirect.relative?                     
+              response = Net::HTTP.get_response(redirect.host, redirect.path, @port)
+            end
+                  
             if response.is_a?(Net::HTTPSuccess)
-               bool = true
+              bool = true
             else
-               if @follow_redirect
-                  @warning = response.message
-                  
-                  while response.is_a?(Net::HTTPRedirection)
-                     redirect = URI.parse(response['location']) 
-                     redirect = uri + redirect if redirect.relative?                     
-                     response = Net::HTTP.get_response(redirect.host, redirect.path, @port)
-                  end
-                  
-                  if response.is_a?(Net::HTTPSuccess)
-                     bool = true
-                  else
-                     @warning = nil
-                     @exception = response.message
-                  end
-               else
-                  @exception = response.message
-               end
+              @warning = nil
+              @exception = response.message
             end
-         end
+          else
+            @exception = response.message
+          end
+        end
+      end
 
-         # There is no duration if the ping failed
-         @duration = Time.now - start_time if bool
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
 
-         bool
-      end
+      bool
+    end
 
-      alias ping? ping
-      alias pingecho ping
-      alias follow_redirect? follow_redirect
-      alias uri host
-      alias uri= host=
-   end
+    alias ping? ping
+    alias pingecho ping
+    alias follow_redirect? follow_redirect
+    alias uri host
+    alias uri= host=
+  end
 end