net-ping 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66ef8ec8a4d85b94397739115722bcb52e8b287b
-  data.tar.gz: 9b530dc0bdc258e6c3daef1c6c48677f09093661
+  metadata.gz: 96a4aeabebdb1bf7c3347538c1ad96428e5d7386
+  data.tar.gz: 6434d02460e9ff981db346adde0664029a7e0de0
 SHA512:
-  metadata.gz: d57ad9937a32293703c097322bc1f24d6f031c4d910b5a4131616226a46320ddfbcf1072a7f40b39b2c1879c421717a6a9389b443254e9419513d7dfbfa307e3
-  data.tar.gz: 9016ac5f9fa70b60b89e0bcca798b516336fb9002cba9f21d6c17ed5dada65c8bd6d761aeb3e227f5dd65675e02984ab31dc3ef1ed290528385e3bf0ad105cf9
+  metadata.gz: e8075c1a265cd6d0e911e5e4a6a2e38d377d0c00d5a76c05cee37e089f40a51a7405051280e299ba168e8db7854387dd49a334fcc6c12f98cfc17cdebd91b26a
+  data.tar.gz: 8a450d951dafecd0133a85c16f01568c39c6ec6dbea07760b149d9b8f27dfc5de957e3fc4ffb950b1b49328b490377b123e3c031b82faf8f99f3aa74a541fce7

data/CHANGES

@@ -1,3 +1,14 @@
+== 1.7.3 - 3-Apr-2014
+* Removed the Timeout block for the Ping::External class as it apparently
+  hasn't worked with open3 for some time. Instead, it now uses your command
+  line ping's timeout switch. Thanks go to Andrea Bernardo Ciddio for the
+  spot.
+* Made ICMP pings thread safe. I think.
+* Removed a redundant Timeout block in the Ping::ICMP class.
+* If an ICMP ping times out, the exception attribute is set to "timeout".
+* Added explicit support for AIX for the Ping::External class.
+* Bumped minimum required Ruby version to 1.9.3.
+
 == 1.7.2 - 21-Jan-2014
 * Fixed a bug in the Ping::HTTP constructor where it was not honoring the
   port if provided as the second argument. Thanks go to Florian Anderiasch

data/README

@@ -7,6 +7,7 @@
   * fakeweb (test only)
   * test-unit (test only)
 
+  Ruby users should use Ruby 1.9.3 or later.
   JRuby users should use JRuby 1.6.7 or later.
 
 == Installation
@@ -17,10 +18,6 @@
   attention to the documentation pertaining to ECONNREFUSED and TCP pings.
 
   Also note the documentation regarding down hosts.
-   
-  You do not need win32-open3 with Ruby 1.9.x. The open3 library that ships
-  as part of the Ruby standard library should work.
-
 == How to require net-ping
   You can do either this:
 
@@ -44,8 +41,8 @@
   JRuby 1.6.7 or later is required for external pings because of a bug
   in earlier versions with open3 and stream handling.
 
-  ICMP pings are not thread safe. See https://www.ruby-forum.com/topic/146116.
-  Patches welcome.
+  ICMP pings will not work with JRuby without some sort of third-party
+  library support for raw sockets in Java, such as RockSaw.
 
 == License
   Artistic 2.0
@@ -60,3 +57,6 @@
   If you installed this library via Rubygems, you can view the inline
   documentation via ri or fire up 'gem server', and point your browser at
   http://localhost:8808.
+
+== Author
+  Daniel J. Berger

data/doc/ping.txt

@@ -221,7 +221,7 @@ Ping#warning
    UDP pings may not work with older versions of Ruby 1.9.x.
 
    Please report any bugs on the project page at
-   http://www.rubyforge.org/projects/shards.
+   https://github.com/djberg96/net-ping
 
 = Acknowledgements
    The Ping::ICMP#ping method is based largely on the identical method from
@@ -235,7 +235,7 @@ Ping#warning
    Artistic 2.0
 
 = Copyright
-   (C) 2003-2013 Daniel J. Berger, All Rights Reserved
+   (C) 2003-2014 Daniel J. Berger, All Rights Reserved
 
 = Warranty
    This package is provided "as is" and without any express or

data/lib/net/ping/external.rb

@@ -22,14 +22,18 @@ module Net
       bool = false
 
       case RbConfig::CONFIG['host_os']
-        when /linux|bsd|osx|mach|darwin/i
-          pcmd += ['-c1', host]
+        when /linux/i
+          pcmd += ['-c', '1', '-W', @timeout.to_s, host]
+        when /aix/i
+          pcmd += ['-c', '1', '-w', @timeout.to_s, host]
+        when /bsd|osx|mach|darwin/i
+          pcmd += ['-c', '1', '-t', @timeout.to_s, host]
         when /solaris|sunos/i
-          pcmd += [host, '1']
+          pcmd += [host, @timeout.to_s]
         when /hpux/i
-          pcmd += [host, '-n1']
+          pcmd += [host, '-n1', '-m', @timeout.to_s]
         when /win32|windows|msdos|mswin|cygwin|mingw/i
-          pcmd += ['-n', '1', host]
+          pcmd += ['-n', '1', '-w', (@timeout * 1000).to_s, host]
         else
           pcmd += [host]
       end
@@ -39,25 +43,33 @@ module Net
       begin
         err = nil
 
-        Timeout.timeout(@timeout){
-          Open3.popen3(*pcmd) do |stdin, stdout, stderr, thread|
-            err = stderr.gets # Can't chomp yet, might be nil
+        Open3.popen3(*pcmd) do |stdin, stdout, stderr, thread|
+          stdin.close
+          err = stderr.gets # Can't chomp yet, might be nil
 
-            case thread.value.exitstatus
-              when 0
-                bool = true  # Success, at least one response.
-                if err & err =~ /warning/i
-                  @warning = err.chomp
-                end
-              when 2
-                bool = false # Transmission successful, no response.
+          case thread.value.exitstatus
+            when 0
+              bool = true  # Success, at least one response.
+              if err & err =~ /warning/i
+                @warning = err.chomp
+              end
+            when 2
+              bool = false # Transmission successful, no response.
+              @exception = err.chomp if err
+            else
+              bool = false # An error occurred
+              if err
                 @exception = err.chomp
               else
-                bool = false # An error occurred
-                @exception = err.chomp
-            end
+                stdout.each_line do |line|
+                  if line =~ /(timed out|could not find host|packet loss)/i
+                    @exception = line.chomp
+                    break
+                  end
+                end
+              end
           end
-        }
+        end
       rescue Exception => error
         @exception = error.message
       end

data/lib/net/ping/icmp.rb

@@ -44,7 +44,7 @@ module Net
 
       0.upto(@data_size){ |n| @data << (n % 256).chr }
 
-      @pid  = Process.pid & 0xffff
+      @ping_id = (Thread.current.object_id ^ Process.pid) & 0xffff
 
       super(host, port, timeout)
       @port = nil # This value is not used in ICMP pings.
@@ -59,7 +59,7 @@ module Net
     end
 
     # Associates the local end of the socket connection with the given
-    # +host+ and +port+.  The default port is 0.
+    # +host+ and +port+. The default port is 0.
     #
     def bind(host, port = 0)
       @bind_host = host
@@ -90,10 +90,10 @@ module Net
       timeout = @timeout
 
       checksum = 0
-      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
+      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @ping_id, @seq, @data].pack(pstring)
 
       checksum = checksum(msg)
-      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
+      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @ping_id, @seq, @data].pack(pstring)
 
       begin
         saddr = Socket.pack_sockaddr_in(0, host)
@@ -107,37 +107,36 @@ module Net
       socket.send(msg, 0, saddr) # Send the message
 
       begin
-        Timeout.timeout(@timeout){
-          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 = socket.recvfrom(1500).first
-            type = data[20, 2].unpack('C2').first
-
-            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
+        while true
+          io_array = select([socket], nil, nil, timeout)
+
+          if io_array.nil? || io_array[0].empty?
+            @exception = "timeout" if io_array.nil?
+            return false
+          end
+
+          ping_id = nil
+          seq = nil
+
+          data = socket.recvfrom(1500).first
+          type = data[20, 2].unpack('C2').first
+
+          case type
+            when ICMP_ECHOREPLY
+              if data.length >= 28
+                ping_id, seq = data[24, 4].unpack('n3')
+              end
+            else
+              if data.length > 56
+                ping_id, seq = data[52, 4].unpack('n3')
+              end
           end
-        }
+
+          if ping_id == @ping_id && seq == @seq && type == ICMP_ECHOREPLY
+            bool = true
+            break
+          end
+        end
       rescue Exception => err
         @exception = err
       ensure

data/lib/net/ping/ping.rb

@@ -10,7 +10,7 @@ module Net
    #
    class Ping
       # The version of the net-ping library.
-      VERSION = '1.7.2'
+      VERSION = '1.7.3'
 
       # The host to ping. In the case of Ping::HTTP, this is the URI.
       attr_accessor :host

data/net-ping.gemspec

@@ -3,7 +3,7 @@ require 'rbconfig'
 
 Gem::Specification.new do |spec|
   spec.name      = 'net-ping'
-  spec.version   = '1.7.2'
+  spec.version   = '1.7.3'
   spec.license   = 'Artistic 2.0'
   spec.author    = 'Daniel J. Berger'
   spec.email     = 'djberg96@gmail.com'
@@ -12,11 +12,10 @@ Gem::Specification.new do |spec|
   spec.test_file = 'test/test_net_ping.rb'
   spec.files     = Dir['**/*'].reject{ |f| f.include?('git') }
 
-  spec.rubyforge_project = 'shards'
   spec.extra_rdoc_files  = ['README', 'CHANGES', 'doc/ping.txt']
 
   # The TCP Ping class requires this for non-blocking sockets.
-  spec.required_ruby_version = ">= 1.9.1"
+  spec.required_ruby_version = ">= 1.9.3"
 
   spec.add_development_dependency('test-unit')
   spec.add_development_dependency('fakeweb')

data/test/test_net_ping.rb

@@ -28,7 +28,7 @@ end
 
 class TC_Net_Ping < Test::Unit::TestCase
   def test_net_ping_version
-    assert_equal('1.7.2', Net::Ping::VERSION)
+    assert_equal('1.7.3', Net::Ping::VERSION)
   end
 end
 

data/test/test_net_ping_external.rb

@@ -120,6 +120,15 @@ class TC_Net_Ping_External < Test::Unit::TestCase
     assert_nil(@pe.warning)
   end
 
+  test "timing out causes expected result" do
+    ext = Net::Ping::External.new('foo.bar.baz', nil, 1)
+    start = Time.now
+    assert_false(ext.ping?)
+    elapsed = Time.now - start
+    assert_true(elapsed < 2.5, "Actual elapsed: #{elapsed}")
+    assert_not_nil(ext.exception)
+  end
+
   def teardown
     @host  = nil
     @bogus = nil

data/test/test_net_ping_icmp.rb

@@ -1,12 +1,13 @@
 #######################################################################
 # test_net_ping_icmp.rb
 #
-# Test case for the Net::PingICMP class.  You must run this test case
+# Test case for the Net::PingICMP class. You must run this test case
 # with root privileges on UNIX systems. This should be run via the
 # 'test' or 'test:icmp' Rake task.
 #######################################################################
 require 'test-unit'
 require 'net/ping/icmp'
+require 'thread'
 
 if File::ALT_SEPARATOR
   require 'win32/security'
@@ -21,30 +22,62 @@ else
 end
 
 class TC_PingICMP < Test::Unit::TestCase
+  def self.startup
+    @@jruby = RUBY_PLATFORM == 'java'
+  end
+
   def setup
     @host = '127.0.0.1' # 'localhost'
     @icmp = Net::Ping::ICMP.new(@host)
+    @concurrency = 3
   end
 
   test "icmp ping basic functionality" do
     assert_respond_to(@icmp, :ping)
+    omit_if(@@jruby)
     assert_nothing_raised{ @icmp.ping }
   end
 
   test "icmp ping accepts a host" do
+    omit_if(@@jruby)
     assert_nothing_raised{ @icmp.ping(@host) }
   end
 
   test "icmp ping returns a boolean" do
+    omit_if(@@jruby)
     assert_boolean(@icmp.ping)
     assert_boolean(@icmp.ping(@host))
   end
 
   test "icmp ping of local host is successful" do
+    omit_if(@@jruby)
     assert_true(Net::Ping::ICMP.new(@host).ping?)
     assert_true(Net::Ping::ICMP.new('192.168.0.1').ping?)
   end
 
+  test "threaded icmp ping returns expected results" do
+    omit_if(@@jruby)
+    ips = ['8.8.4.4', '8.8.9.9', '127.0.0.1', '8.8.8.8', '8.8.8.9']
+    queue = Queue.new
+    threads = []
+
+    ips.each{ |ip| queue <<  ip }
+
+    @concurrency.times{
+      threads << Thread.new(queue) do |q|
+        ip = q.pop
+        icmp = Net::Ping::ICMP.new(ip, nil, 1)
+        if ip =~ /9/
+          assert_false(icmp.ping?)
+        else
+          assert_true(icmp.ping?)
+        end
+      end
+    }
+
+    threads.each{ |t| t.join }
+  end
+
   test "ping? is an alias for ping" do
     assert_respond_to(@icmp, :ping?)
     assert_alias_method(@icmp, :ping?, :ping)
@@ -56,6 +89,7 @@ class TC_PingICMP < Test::Unit::TestCase
   end
 
   test "icmp ping fails if host is invalid" do
+    omit_if(@@jruby)
     assert_false(Net::Ping::ICMP.new('bogus').ping?)
     assert_false(Net::Ping::ICMP.new('http://www.asdfhjklasdfhlkj.com').ping?)
   end
@@ -67,6 +101,7 @@ class TC_PingICMP < Test::Unit::TestCase
   end
 
   test "duration method basic functionality" do
+    omit_if(@@jruby)
     assert_nothing_raised{ @icmp.ping }
     assert_respond_to(@icmp, :duration)
     assert_kind_of(Float, @icmp.duration)
@@ -99,9 +134,15 @@ class TC_PingICMP < Test::Unit::TestCase
     assert_equal(7, @icmp.timeout)
   end
 
+  test "timeout works as expected" do
+    omit_if(@@jruby)
+    icmp = Net::Ping::ICMP.new('bogus.com', nil, 0.000001)
+    assert_false(icmp.ping?)
+    assert_equal('timeout', icmp.exception)
+  end
+
   test "exception method basic functionality" do
     assert_respond_to(@icmp, :exception)
-    assert_nothing_raised{ @icmp.ping }
   end
 
   test "exception method returns nil if no ping has happened yet" do
@@ -128,6 +169,7 @@ class TC_PingICMP < Test::Unit::TestCase
   end
 
   test "setting an odd data_size is valid" do
+    omit_if(@@jruby)
     assert_nothing_raised{ @icmp.data_size = 57 }
     assert_boolean(@icmp.ping)
   end
@@ -135,5 +177,10 @@ class TC_PingICMP < Test::Unit::TestCase
   def teardown
     @host = nil
     @icmp = nil
+    @concurrency = nil
+  end
+
+  def self.shutdown
+    @@jruby = nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-ping
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -102,15 +102,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: shards
-rubygems_version: 2.2.0
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ping interface for Ruby.