net-ping 1.3.4-x86-mingw32 → 1.4.0-x86-mingw32

data/CHANGES

@@ -1,3 +1,33 @@
+== 1.4.0 - 14-Feb-2011
+* Added the redirect_limit accessor for the Net::Ping::HTTP class. This caps
+  the number of redirects that are allowed before a ping is considered a
+  failure. The default is 5.
+* Changed the way in which redirects are detected. Previously I was checking
+  against the response class, but decided this was unreliable. I now check the
+  response code itself. Any code in the 300 range is considered a redirect.
+* The default port for the Net::Ping::HTTP class is no longer explicitly set
+  to 80, but instead uses the result of the URI.parse(uri).port method by
+  default. Note that you can still override the port if you explicitly provide
+  one in the constructor.
+* The Net::Ping::HTTP class now handles https URI's properly. Note that you may
+  get a warning about peer certificates.
+
+== 1.3.7 - 14-Oct-2010
+* Wrapped the ICMP ping in a while loop that breaks on success to prevent
+  the ping from failing too early. Thanks go to Benny Holmgren for the
+  spot and the patch.
+
+== 1.3.6 - 4-Sep-2010
+* Fixed variable naming issue in Net::Ping::External. Thanks go to taw
+  for the spot.
+* Added a default Rake task.
+* Refactored the tests for Net::Ping::External to take advantage of the
+  features of test-unit 2.x.
+
+== 1.3.5 - 3-Sep-2010
+* Allow for custom user agent in Net::Ping::HTTP. Thanks go to Michael
+  Reinsch for the patch.
+
 == 1.3.4 - 25-Jun-2010
 * Fixed a dumb platform bug. Thanks go to Jason Frey for the spot.
 

data/README

@@ -2,11 +2,9 @@
    A collection of classes that provide different ways to ping computers.
 
 == 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 unless you're
      using JRuby.
-   * Windows 2000 or later is required to use the Ping::WMI class.
 
 == Installation
    gem install net-ping
@@ -36,8 +34,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.
+   Older versions of JRuby will return false positives in UDP pings
+   because of an incorrect error class being raised. See JRuby-4896.
 
 == License
    Artistic 2.0

data/Rakefile

@@ -1,10 +1,13 @@
 require 'rake'
+require 'rake/clean'
 require 'rake/testtask'
 include Config
 
+CLEAN.include("**/*.gem", "**/*.rbc")
+
 namespace 'gem' do
   desc 'Create the net-ping gem'
-  task :create do
+  task :create => [:clean] do
     spec = eval(IO.read('net-ping.gemspec'))
     Gem::Builder.new(spec).build
   end
@@ -82,3 +85,5 @@ namespace 'test' do
      t.test_files = FileList['test/test_net_ping_wmi.rb']
   end
 end
+
+task :default => :test

data/lib/net/ping.rb

@@ -10,7 +10,7 @@ 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'] =~ /msdos|mswin|cygwin|mingw|win32/i &&
+if Config::CONFIG['host_os'] =~ /msdos|mswin|cygwin|mingw|win32|windows/i &&
   RUBY_PLATFORM != 'java'
 then
   require File.join(File.dirname(__FILE__), 'ping/wmi')

data/lib/net/ping/external.rb

@@ -1,7 +1,7 @@
 require 'rbconfig'
 require File.join(File.dirname(__FILE__), 'ping')
 
-if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw/i &&
+if Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw|windows/i &&
   RUBY_PLATFORM != 'java'
 then
   if RUBY_VERSION.to_f < 1.9
@@ -18,7 +18,7 @@ module Net
   # 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 &&
+    CWINDOWS = Config::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw|windows/i &&
       RUBY_PLATFORM != 'java'
       
     if CWINDOWS
@@ -35,7 +35,7 @@ module Net
     def ping(host = @host)
       super(host)
 
-      input, output, error = ""
+      stdin, stdout, stderr = ""
       pstring = "ping "
       bool    = false
       orig_cp = nil
@@ -63,12 +63,12 @@ module Net
         err = nil
 
         Timeout.timeout(@timeout){
-          input, output, error = Open3.popen3(pstring)
-          err = error.gets # Can't chomp yet, might be nil
+          stdin, stdout, stderr = Open3.popen3(pstring)
+          err = stderr.gets # Can't chomp yet, might be nil
         }
 
-        input.close
-        error.close
+        stdin.close
+        stderr.close
 
         if CWINDOWS && GetConsoleCP() != orig_cp
           SetConsoleCP(orig_cp)
@@ -83,8 +83,8 @@ module Net
           end
         # The "no answer" response goes to stdout, not stderr, so check it
         else
-          lines = output.readlines
-          output.close
+          lines = stdout.readlines
+          stdout.close
           if lines.nil? || lines.empty?
             bool = true
           else
@@ -109,9 +109,9 @@ module Net
       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?
+        stdin.close  if stdin  && !stdin.closed?
+        stdout.close if stdout && !stdout.closed?
+        stderr.close if stderr && !stderr.closed?
       end
 
       # There is no duration if the ping failed

data/lib/net/ping/http.rb

@@ -1,31 +1,41 @@
 require File.join(File.dirname(__FILE__), 'ping')
 require 'net/http'
+require 'net/https'
 require 'uri'
-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|msdos|cygwin|mingw/i
+unless File::ALT_SEPARATOR
   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
-      
+
     # 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)
+
+    # The maximum number of redirects allowed. The default is 5.
+    attr_accessor :redirect_limit
+
+    # The user agent used for the HTTP request. The default is nil.
+    attr_accessor :user_agent
+
+    # Creates and returns a new Ping::HTTP object. The default port is the
+    # port associated with the URI. The default timeout is 5 seconds.
+    #
+    def initialize(uri=nil, port=nil, timeout=5)
       @follow_redirect = true
+      @redirect_limit  = 5
+
+      port ||= URI.parse(uri).port if uri
+
       super(uri, port, timeout)
     end
 
@@ -34,7 +44,7 @@ module Net
     # 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
@@ -42,7 +52,7 @@ module Net
     # 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
@@ -53,9 +63,14 @@ module Net
       begin
         response = nil
         uri_path = uri.path.empty? ? '/' : uri.path
-        Timeout.timeout(@timeout){
-          response = Net::HTTP.get_response(uri.host, uri_path, @port)
-        }
+        headers = { }
+        headers["User-Agent"] = user_agent unless user_agent.nil?
+        Timeout.timeout(@timeout) do
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = (uri.scheme == 'https')
+          request = Net::HTTP::Get.new(uri_path)
+          response = http.start{ |h| h.request(request) }
+        end
       rescue Exception => err
         @exception = err.message
       else
@@ -64,18 +79,25 @@ module Net
         else
           if @follow_redirect
             @warning = response.message
-                
-            while response.is_a?(Net::HTTPRedirection)
-              redirect = URI.parse(response['location']) 
-              redirect = uri + redirect if redirect.relative?                     
+            rlimit = 0
+
+            # Any response code in the 300 range is a redirect
+            while response.code.to_i >= 300 && response.code.to_i < 400
+              if rlimit >= redirect_limit
+                @exception = "Redirect limit exceeded"
+                break
+              end
+              redirect = URI.parse(response['location'])
+              redirect = uri + redirect if redirect.relative?
               response = Net::HTTP.get_response(redirect.host, redirect.path, @port)
+              rlimit += 1
             end
-                  
+
             if response.is_a?(Net::HTTPSuccess)
               bool = true
             else
               @warning = nil
-              @exception = response.message
+              @exception ||= response.message
             end
           else
             @exception = response.message

data/lib/net/ping/icmp.rb

@@ -97,33 +97,36 @@ module Net
 
          begin
             Timeout.timeout(@timeout){
-               io_array = select([socket], nil, nil, timeout)
-
-               if io_array.nil? || io_array[0].empty?
-                  return false
-               end
-
-               pid = nil
-               seq = nil
-
-               data, sender  = socket.recvfrom(1500)
-               port, host    = Socket.unpack_sockaddr_in(sender)
-               type, subcode = data[20, 2].unpack('C2')
-
-               case type
-                  when ICMP_ECHOREPLY
-                     if data.length >= 28
-                        pid, seq = data[24, 4].unpack('n3')
-                     end
-                  else
-                     if data.length > 56
-                        pid, seq = data[52, 4].unpack('n3')
-                     end
-               end
-
-               if pid == @pid && seq == @seq && type == ICMP_ECHOREPLY
-                  bool = true
-               end
+              while true
+                 io_array = select([socket], nil, nil, timeout)
+
+                 if io_array.nil? || io_array[0].empty?
+                    return false
+                 end
+
+                 pid = nil
+                 seq = nil
+
+                 data, sender  = socket.recvfrom(1500)
+                 port, host    = Socket.unpack_sockaddr_in(sender)
+                 type, subcode = data[20, 2].unpack('C2')
+
+                 case type
+                    when ICMP_ECHOREPLY
+                       if data.length >= 28
+                          pid, seq = data[24, 4].unpack('n3')
+                       end
+                    else
+                       if data.length > 56
+                          pid, seq = data[52, 4].unpack('n3')
+                       end
+                 end
+
+                 if pid == @pid && seq == @seq && type == ICMP_ECHOREPLY
+                    bool = true
+                    break
+                 end
+              end
             }
          rescue Exception => err
             @exception = err

data/lib/net/ping/ping.rb

@@ -4,13 +4,13 @@ require 'timeout'
 # The Net module serves as a namespace only.
 #
 module Net
-   
+
    # The Ping class serves as an abstract base class for all other Ping class
    # types. You should not instantiate this class directly.
    #
    class Ping
       # The version of the net-ping library.
-      VERSION = '1.3.4'
+      VERSION = '1.4.0'
 
       # The host to ping. In the case of Ping::HTTP, this is the URI.
       attr_accessor :host
@@ -44,7 +44,7 @@ module Net
       # The default constructor for the Net::Ping class.  Accepts an optional
       # +host+, +port+ and +timeout+.  The port defaults to your echo port, or
       # 7 if that happens to be undefined.  The default timeout is 5 seconds.
-      # 
+      #
       # The host, although optional in the constructor, must be specified at
       # some point before the Net::Ping#ping method is called, or else an
       # ArgumentError will be raised.
@@ -64,7 +64,7 @@ module Net
 
          yield self if block_given?
       end
-      
+
       # The default interface for the Net::Ping#ping method.  Each subclass
       # should call super() before continuing with their own implementation in
       # order to ensure that the @exception and @warning instance variables
@@ -81,7 +81,7 @@ module Net
          @exception = nil
          @warning   = nil
       end
-      
+
       alias ping? ping
       alias pingecho ping
    end

data/net-ping.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name      = 'net-ping'
-  gem.version   = '1.3.4'
+  gem.version   = '1.4.0'
   gem.license   = 'Artistic 2.0'
   gem.author    = 'Daniel J. Berger'
   gem.email     = 'djberg96@gmail.com'
@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
   gem.rubyforge_project = 'shards'
   gem.extra_rdoc_files  = ['README', 'CHANGES', 'doc/ping.txt']
 
-  gem.add_development_dependency('test-unit', '>= 2.0.9')
+  gem.add_development_dependency('test-unit', '>= 2.1.2')
 
   # These dependencies are for Net::Ping::External
-  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i &&
+  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|windows|cygwin|mingw/i &&
     RUBY_PLATFORM != 'java'
   then
     gem.platform = Gem::Platform::CURRENT

data/test/test_net_ping.rb

@@ -21,6 +21,6 @@ end
 
 class TC_Net_Ping < Test::Unit::TestCase
   def test_net_ping_version
-    assert_equal('1.3.4', Net::Ping::VERSION)
+    assert_equal('1.4.0', Net::Ping::VERSION)
   end
 end

data/test/test_net_ping_external.rb

@@ -18,64 +18,98 @@ class TC_Net_Ping_External < Test::Unit::TestCase
     @bad   = Net::Ping::External.new(@bogus)
   end
 
-  def test_ping
+  test "ping basic functionality" do
     assert_respond_to(@pe, :ping)
+  end
+
+  test "ping with no arguments" do
     assert_nothing_raised{ @pe.ping }
+  end
+
+  test "ping accepts a hostname" do
     assert_nothing_raised{ @pe.ping(@host) }
   end
 
-  def test_ping_aliases
+  test "ping returns a boolean" do
+    assert_boolean(@pe.ping)
+    assert_boolean(@bad.ping)
+  end
+
+  test "ping? alias" do
     assert_respond_to(@pe, :ping?)
-    assert_respond_to(@pe, :pingecho)
-    assert_nothing_raised{ @pe.ping? }
-    assert_nothing_raised{ @pe.ping?(@host) }
+    assert_alias_method(@pe, :ping?, :ping)
+  end
+
+  test "pingecho alias" do
     assert_nothing_raised{ @pe.pingecho }
-    assert_nothing_raised{ @pe.pingecho(@host) }
+    assert_alias_method(@pe, :pingecho, :ping)
   end
 
-  def test_good_ping     
-    assert_equal(true, @pe.ping?)
+  test "pinging a good host returns true" do
+    assert_true(@pe.ping?)
   end
 
-  def test_bad_ping
-    assert_equal(false, @bad.ping?)
-    assert_equal(false, @bad.exception.nil?, "Bad exception data")
+  test "pinging a bogus host returns false" do
+    assert_false(@bad.ping?)
   end
 
-  def test_duration
+  test "duration basic functionality" do
     assert_nothing_raised{ @pe.ping }
     assert_respond_to(@pe, :duration)
     assert_kind_of(Float, @pe.duration)
   end
 
-  def test_host
+  test "host getter basic functionality" do
     assert_respond_to(@pe, :host)
-    assert_respond_to(@pe, :host=)
     assert_equal('www.ruby-lang.org', @pe.host)
   end
 
-  def test_port
+  test "host setter basic functionality" do
+    assert_respond_to(@pe, :host=)
+    assert_nothing_raised{ @pe.host = @bad }
+    assert_equal(@bad, @pe.host)
+  end
+
+  test "port getter basic functionality" do
     assert_respond_to(@pe, :port)
-    assert_respond_to(@pe, :port=)
     assert_equal(7, @pe.port)
   end
 
-  def test_timeout
+  test "port setter basic functionality" do
+    assert_respond_to(@pe, :port=)
+    assert_nothing_raised{ @pe.port = 90 }
+    assert_equal(90, @pe.port)
+  end
+
+  test "timeout getter basic functionality" do
     assert_respond_to(@pe, :timeout)
-    assert_respond_to(@pe, :timeout=)
     assert_equal(5, @pe.timeout)
   end
 
-  def test_exception
+  test "timeout setter basic functionality" do
+    assert_respond_to(@pe, :timeout=)
+    assert_nothing_raised{ @pe.timeout = 30 }
+    assert_equal(30, @pe.timeout)
+  end
+
+  test "exception method basic functionality" do
     assert_respond_to(@pe, :exception)
-    assert_nothing_raised{ @pe.ping }
-    assert_nothing_raised{ @bad.ping }
     assert_nil(@pe.exception)
+  end
+
+  test "pinging a bogus host stores exception data" do
+    assert_nothing_raised{ @bad.ping? }
     assert_not_nil(@bad.exception)
   end
 
-  def test_warning
+  test "pinging a good host results in no exception data" do
+    assert_nothing_raised{ @pe.ping }
+    assert_nil(@pe.exception)
+  end
+
+  test "warning basic functionality" do
     assert_respond_to(@pe, :warning)
+    assert_nil(@pe.warning)
   end
 
   def teardown

data/test/test_net_ping_http.rb

@@ -13,7 +13,7 @@ require 'net/ping/http'
 class TC_Net_Ping_HTTP < Test::Unit::TestCase
   def setup
     @uri  = 'http://www.google.com/index.html'
-    @http = Net::Ping::HTTP.new(@uri, 80, 30)      
+    @http = Net::Ping::HTTP.new(@uri, 80, 30)
     @bad  = Net::Ping::HTTP.new('http://www.blabfoobarurghxxxx.com') # One hopes not
   end
 
@@ -108,6 +108,58 @@ class TC_Net_Ping_HTTP < Test::Unit::TestCase
     assert_nil(@http.warning)
   end
 
+  test 'user_agent accessor is defined' do
+    assert_respond_to(@http, :user_agent)
+    assert_respond_to(@http, :user_agent=)
+  end
+
+  test 'user_agent defaults to nil' do
+    assert_nil(@http.user_agent)
+  end
+
+  test 'ping with user agent' do
+    @http.user_agent = "KDDI-CA32"
+    assert_true(@http.ping)
+  end
+
+  test 'redirect_limit accessor is defined' do
+    assert_respond_to(@http, :redirect_limit)
+    assert_respond_to(@http, :redirect_limit=)
+  end
+
+  test 'redirect_limit defaults to 5' do
+    assert_equal(5, @http.redirect_limit)
+  end
+
+  test 'redirects succeed by default' do
+    @http = Net::Ping::HTTP.new("http://jigsaw.w3.org/HTTP/300/302.html")
+    assert_true(@http.ping)
+  end
+
+  test 'redirect fail if follow_redirect is set to false' do
+    @http = Net::Ping::HTTP.new("http://jigsaw.w3.org/HTTP/300/302.html")
+    @http.follow_redirect = false
+    assert_false(@http.ping)
+  end
+
+  test 'ping with redirect limit set to zero fails' do
+    @http = Net::Ping::HTTP.new("http://jigsaw.w3.org/HTTP/300/302.html")
+    @http.redirect_limit  = 0
+    assert_false(@http.ping)
+    assert_equal("Redirect limit exceeded", @http.exception)
+  end
+
+  test 'ping against https site defaults to port 443' do
+    @http = Net::Ping::HTTP.new("https://encrypted.google.com/")
+    assert_equal(443, @http.port)
+  end
+
+  # This will generate a warning. Nothing I can do about it.
+  test 'ping against https site works as expected' do
+    @http = Net::Ping::HTTP.new("https://encrypted.google.com/")
+    assert_true(@http.ping)
+  end
+
   def teardown
     @uri  = nil
     @http = nil

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-ping
 version: !ruby/object:Gem::Version 
+  hash: 7
   prerelease: false
   segments: 
   - 1
-  - 3
   - 4
-  version: 1.3.4
+  - 0
+  version: 1.4.0
 platform: x86-mingw32
 authors: 
 - Daniel J. Berger
@@ -14,30 +15,34 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-25 00:00:00 -06:00
+date: 2011-02-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: test-unit
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
-        - 0
-        - 9
-        version: 2.0.9
+        - 1
+        - 2
+        version: 2.1.2
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: windows-pr
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 7
         segments: 
         - 1
         - 0
@@ -49,9 +54,11 @@ dependencies:
   name: win32-open3
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 0
         - 3
@@ -105,23 +112,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A ping interface for Ruby.