net-ping 1.5.2 → 1.5.3

data/CHANGES

@@ -1,3 +1,10 @@
+== 1.5.3 - 29-Feb-2012
+* Removed the Windows::Console dependency and replaced it with FFI since there
+  were only two functions needed. This had the nice side effect of making it
+  work with JRuby, too.
+* Minor cleanup on some multi-variable assignment.
+* Fixed require statements and one test for 1.9.
+
 == 1.5.2 - 4-Nov-2011
 * The Net::Ping::HTTP class now defaults to using HEAD instead of GET
   for its ping test. You can alter this via the get_request accessor.

data/README

@@ -6,6 +6,8 @@
    MS Windows when using the Net::Ping::External class unless you're
    using JRuby.
 
+   JRuby users should use 1.6.7 or later.
+
 == Installation
    gem install net-ping
 
@@ -34,9 +36,13 @@
    
 == Known Issues
    Older versions of Ruby 1.9.x may not work with UDP pings.
+
    Older versions of JRuby will return false positives in UDP pings
    because of an incorrect error class being raised. See JRuby-4896.
 
+   JRuby 1.6.7 or later is required for external pings because of a bug
+   in earlier versions with open3 and stream handling.
+
 == License
    Artistic 2.0
    

data/lib/net/ping/external.rb

@@ -1,17 +1,12 @@
+require 'ffi'
 require 'rbconfig'
-require File.join(File.dirname(__FILE__), 'ping')
 
-RbConfig = Config unless Object.const_defined?(:RbConfig)
+require File.join(File.dirname(__FILE__), 'ping')
 
-if RbConfig::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw|windows/i &&
-  RUBY_PLATFORM != 'java'
-then
-  if RUBY_VERSION.to_f < 1.9
-    require 'win32/open3'
-  end
-  require 'windows/console'
+if File::ALT_SEPARATOR && RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM != 'java'
+  require 'win32/open3'
 else
-  require 'open3'            
+  require 'open3'
 end
 
 # The Net module serves as a namespace only.
@@ -20,28 +15,29 @@ module Net
   # The Ping::External class encapsulates methods for external (system) pings.
   class Ping::External < Ping
 
-    CWINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|win32|msdos|cygwin|mingw|windows/i &&
-      RUBY_PLATFORM != 'java'
-      
-    if CWINDOWS
-      include Windows::Console
-    end 
-   
+    if File::ALT_SEPARATOR
+      extend FFI::Library
+      ffi_lib 'kernel32'
+
+      attach_function :SetConsoleCP, [:uint], :bool
+      attach_function :GetConsoleCP, [], :uint
+    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)
 
-      stdin, stdout, stderr = ""
+      stdin = stdout = stderr = nil
       pstring = "ping "
       bool    = false
       orig_cp = nil
-       
+
       case RbConfig::CONFIG['host_os']
         when /linux|bsd|osx|mach|darwin/i
           pstring += "-c 1 #{host}"
@@ -50,17 +46,15 @@ module Net
         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
+          orig_cp = GetConsoleCP()
+          SetConsoleCP(437) if orig_cp != 437 # United States
           pstring += "-n 1 #{host}"
         else
           pstring += "#{host}"
       end
-       
+
       start_time = Time.now
-       
+
       begin
         err = nil
 
@@ -72,10 +66,10 @@ module Net
         stdin.close
         stderr.close
 
-        if CWINDOWS && GetConsoleCP() != orig_cp
+        if File::ALT_SEPARATOR && GetConsoleCP() != orig_cp
           SetConsoleCP(orig_cp)
         end
-      
+
         unless err.nil?
           if err =~ /warning/i
             @warning = err.chomp
@@ -109,7 +103,7 @@ module Net
           end
         end
       rescue Exception => error
-        @exception = error.message 
+        @exception = error.message
       ensure
         stdin.close  if stdin  && !stdin.closed?
         stdout.close if stdout && !stdout.closed?

data/lib/net/ping/icmp.rb

@@ -1,168 +1,180 @@
 require File.join(File.dirname(__FILE__), 'ping')
 
+if File::ALT_SEPARATOR
+  require 'win32/security'
+  require 'windows/system_info'
+  include Windows::SystemInfo
+end
+
 # The Net module serves as a namespace only.
 module Net
 
-   # The Net::Ping::ICMP class encapsulates an icmp ping.
-   class Ping::ICMP < Ping   
-      ICMP_ECHOREPLY = 0 # Echo reply
-      ICMP_ECHO      = 8 # Echo request
-      ICMP_SUBCODE   = 0
-      
-      # You cannot set or change the port value. A value of 0 is always
-      # used internally for ICMP pings.
-      #
-      undef_method :port=
-
-      # Returns the data size, i.e. number of bytes sent on the ping. The
-      # default size is 56.
-      #
-      attr_reader :data_size
-
-      # Creates and returns a new Ping::ICMP object.  This is similar to its
-      # superclass constructor, but must be created with root privileges (on
-      # UNIX systems), and the port value is ignored.
-      #
-      def initialize(host=nil, port=nil, timeout=5)
-         raise 'requires root privileges' if Process.euid > 0
-
-         @seq = 0
-         @bind_port = 0
-         @bind_host = nil
-         @data_size = 56
-         @data = ''
-
-         0.upto(@data_size){ |n| @data << (n % 256).chr }
-
-         @pid  = Process.pid & 0xffff
-
-         super(host, port, timeout)
-         @port = nil # This value is not used in ICMP pings.
+  # The Net::Ping::ICMP class encapsulates an icmp ping.
+  class Ping::ICMP < Ping
+    ICMP_ECHOREPLY = 0 # Echo reply
+    ICMP_ECHO      = 8 # Echo request
+    ICMP_SUBCODE   = 0
+
+    # You cannot set or change the port value. A value of 0 is always
+    # used internally for ICMP pings.
+    #
+    undef_method :port=
+
+    # Returns the data size, i.e. number of bytes sent on the ping. The
+    # default size is 56.
+    #
+    attr_reader :data_size
+
+    # Creates and returns a new Ping::ICMP object.  This is similar to its
+    # superclass constructor, but must be created with root privileges (on
+    # UNIX systems), and the port value is ignored.
+    #
+    def initialize(host=nil, port=nil, timeout=5)
+      raise 'requires root privileges' if Process.euid > 0
+
+      if File::ALT_SEPARATOR && windows_version >= 6
+        unless Win32::Security.elevated_security?
+          raise 'requires elevated security'
+        end
       end
 
-      # Sets the number of bytes sent in the ping method.
-      #
-      def data_size=(size)
-         @data_size = size
-         @data = ''
-         0.upto(size){ |n| @data << (n % 256).chr }
+      @seq = 0
+      @bind_port = 0
+      @bind_host = nil
+      @data_size = 56
+      @data = ''
+
+      0.upto(@data_size){ |n| @data << (n % 256).chr }
+
+      @pid  = Process.pid & 0xffff
+
+      super(host, port, timeout)
+      @port = nil # This value is not used in ICMP pings.
+    end
+
+    # Sets the number of bytes sent in the ping method.
+    #
+    def data_size=(size)
+      @data_size = size
+      @data = ''
+      0.upto(size){ |n| @data << (n % 256).chr }
+    end
+
+    # Associates the local end of the socket connection with the given
+    # +host+ and +port+.  The default port is 0.
+    #
+    def bind(host, port = 0)
+      @bind_host = host
+      @bind_port = port
+    end
+
+    # Pings the +host+ specified in this method or in the constructor.  If a
+    # host was not specified either here or in the constructor, an
+    # ArgumentError is raised.
+    #
+    def ping(host = @host)
+      super(host)
+      bool = false
+
+      socket = Socket.new(
+        Socket::PF_INET,
+        Socket::SOCK_RAW,
+        Socket::IPPROTO_ICMP
+      )
+
+      if @bind_host
+        saddr = Socket.pack_sockaddr_in(@bind_port, @bind_host)
+        socket.bind(saddr)
       end
 
-      # Associates the local end of the socket connection with the given
-      # +host+ and +port+.  The default port is 0.
-      #
-      def bind(host, port = 0)
-         @bind_host = host
-         @bind_port = port
+      @seq = (@seq + 1) % 65536
+      pstring = 'C2 n3 A' << @data_size.to_s
+      timeout = @timeout
+
+      checksum = 0
+      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
+
+      checksum = checksum(msg)
+      msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
+
+      begin
+        saddr = Socket.pack_sockaddr_in(0, host)
+      rescue Exception
+        socket.close unless socket.closed?
+        return bool
       end
-      
-      # Pings the +host+ specified in this method or in the constructor.  If a
-      # host was not specified either here or in the constructor, an
-      # ArgumentError is raised.
-      #
-      def ping(host = @host)
-         super(host)
-         bool = false
-
-         socket = Socket.new(
-            Socket::PF_INET,
-            Socket::SOCK_RAW,
-            Socket::IPPROTO_ICMP
-         )
-
-         if @bind_host
-            saddr = Socket.pack_sockaddr_in(@bind_port, @bind_host)
-            socket.bind(saddr)
-         end
-         
-         @seq = (@seq + 1) % 65536
-         pstring = 'C2 n3 A' << @data_size.to_s
-         timeout = @timeout
-
-         checksum = 0
-         msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
-         checksum = checksum(msg)
-         msg = [ICMP_ECHO, ICMP_SUBCODE, checksum, @pid, @seq, @data].pack(pstring)
-
-         begin
-            saddr = Socket.pack_sockaddr_in(0, host)
-         rescue Exception
-            socket.close unless socket.closed?
-	         return bool
-         end
-         
-         start_time = Time.now
-
-         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, 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
-         ensure
-            socket.close if socket
-         end
-         
-         # There is no duration if the ping failed
-         @duration = Time.now - start_time if bool
-
-         return bool
+
+      start_time = Time.now
+
+      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
+          end
+        }
+      rescue Exception => err
+        @exception = err
+      ensure
+        socket.close if socket
       end
 
-      alias ping? ping
-      alias pingecho ping
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      return bool
+    end
 
-      private
+    alias ping? ping
+    alias pingecho ping
 
-      # Perform a checksum on the message.  This is the sum of all the short
-      # words and it folds the high order bits into the low order bits.
-      #
-      def checksum(msg)
-         length    = msg.length
-         num_short = length / 2
-         check     = 0
+    private
 
-         msg.unpack("n#{num_short}").each do |short|
-            check += short
-         end
+    # Perform a checksum on the message.  This is the sum of all the short
+    # words and it folds the high order bits into the low order bits.
+    #
+    def checksum(msg)
+      length    = msg.length
+      num_short = length / 2
+      check     = 0
 
-         if length % 2 > 0
-            check += msg[length-1, 1].unpack('C').first << 8
-         end
+      msg.unpack("n#{num_short}").each do |short|
+        check += short
+      end
+
+      if length % 2 > 0
+        check += msg[length-1, 1].unpack('C').first << 8
+      end
 
-         check = (check >> 16) + (check & 0xffff)
-         return (~((check >> 16) + check) & 0xffff)
-      end   
-   end
+      check = (check >> 16) + (check & 0xffff)
+      return (~((check >> 16) + check) & 0xffff)
+    end
+  end
 end

data/net-ping.gemspec

@@ -1,37 +1,41 @@
 require 'rubygems'
 require 'rbconfig'
 
-Gem::Specification.new do |gem|
-  gem.name      = 'net-ping'
-  gem.version   = '1.5.2'
-  gem.license   = 'Artistic 2.0'
-  gem.author    = 'Daniel J. Berger'
-  gem.email     = 'djberg96@gmail.com'
-  gem.homepage  = 'http://www.rubyforge.org/projects/shards'
-  gem.summary   = 'A ping interface for Ruby.'
-  gem.test_file = 'test/test_net_ping.rb'
-  gem.files     = Dir['**/*'].reject{ |f| f.include?('git') }
-
-  gem.rubyforge_project = 'shards'
-  gem.extra_rdoc_files  = ['README', 'CHANGES', 'doc/ping.txt']
-
-  gem.add_dependency('net-ldap', '~> 0.2.2')
-  gem.add_development_dependency('test-unit', '>= 2.1.2')
-  gem.add_development_dependency('fakeweb', '>= 1.3.0')
-  gem.add_development_dependency('fakeldap', '~> 0.0.1')
-
-  # These dependencies are for Net::Ping::External
+Gem::Specification.new do |spec|
+  spec.name      = 'net-ping'
+  spec.version   = '1.5.3'
+  spec.license   = 'Artistic 2.0'
+  spec.author    = 'Daniel J. Berger'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'http://www.rubyforge.org/projects/shards'
+  spec.summary   = 'A ping interface for Ruby.'
+  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']
+
+  spec.add_dependency('net-ldap', '~> 0.2.2')
+  spec.add_dependency('ffi', '>= 1.0.0')
+
+  spec.add_development_dependency('test-unit', '>= 2.1.2')
+  spec.add_development_dependency('fakeweb', '>= 1.3.0')
+  spec.add_development_dependency('fakeldap', '~> 0.0.1')
+
   if File::ALT_SEPARATOR && RUBY_PLATFORM != 'java'
-    gem.platform = Gem::Platform::CURRENT
-    gem.add_dependency('windows-pr', '>= 1.0.8')
-    gem.add_development_dependency('win32-security', '>= 1.0.8')
+    spec.platform = Gem::Platform::CURRENT
+    spec.platform.cpu = 'universal'
+    spec.platform.version = nil
+
+    # Used primarily for icmp pings.
+    spec.add_development_dependency('win32-security', '>= 1.0.8')
 
     if RUBY_VERSION.to_f < 1.9
-      gem.add_dependency('win32-open3', '>= 0.3.1')
+      spec.add_dependency('win32-open3', '>= 0.3.1')
     end
   end
 
-  gem.description = <<-EOF
+  spec.description = <<-EOF
     The net-ping library provides a ping interface for Ruby. It includes
     separate TCP, HTTP, LDAP, ICMP, UDP, WMI (for Windows) and external ping
     classes.

data/test/test_net_ping_icmp.rb

@@ -28,7 +28,7 @@ end
 
 class TC_PingICMP < Test::Unit::TestCase
   def setup
-    @host = 'localhost'
+    @host = '127.0.0.1' # 'localhost'
     @icmp = Ping::ICMP.new(@host)
   end
 
@@ -50,6 +50,10 @@ class TC_PingICMP < Test::Unit::TestCase
     assert_boolean(@icmp.pingecho(@host))
   end
 
+  def test_ping_expected_success
+    assert_true(Ping::ICMP.new(@host).ping?)
+  end
+
   def test_ping_expected_failure
     assert_false(Ping::ICMP.new('bogus').ping?)
     assert_false(Ping::ICMP.new('http://www.asdfhjklasdfhlkj.com').ping?)
@@ -70,7 +74,7 @@ class TC_PingICMP < Test::Unit::TestCase
   def test_host
     assert_respond_to(@icmp, :host)
     assert_respond_to(@icmp, :host=)
-    assert_equal('localhost', @icmp.host)
+    assert_equal(@host, @icmp.host)
   end
 
   def test_port

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-ping
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 1
   - 5
-  - 2
-  version: 1.5.2
+  - 3
+  version: 1.5.3
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-05 00:00:00 Z
+date: 2012-02-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ldap
@@ -34,9 +34,25 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: test-unit
+  name: ffi
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -48,11 +64,11 @@ dependencies:
         - 2
         version: 2.1.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -64,11 +80,11 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: fakeldap
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,7 +96,7 @@ dependencies:
         - 1
         version: 0.0.1
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: "    The net-ping library provides a ping interface for Ruby. It includes\n    separate TCP, HTTP, LDAP, ICMP, UDP, WMI (for Windows) and external ping\n    classes.\n"
 email: djberg96@gmail.com
 executables: []