net-ping 1.6.2-universal-mingw32

data/lib/net/ping/tcp.rb

@@ -0,0 +1,83 @@
+require File.join(File.dirname(__FILE__), 'ping')
+
+# The Net module serves as a namespace only.
+module Net
+
+  # With a TCP ping simply try to open a connection. If we are successful,
+  # assume success. In either case close the connection to be polite.
+  #
+  class Ping::TCP < Ping
+    @@service_check = false
+
+    # Returns whether or not Errno::ECONNREFUSED is considered a successful
+    # ping. The default is false.
+    # 
+    def self.service_check
+      @@service_check
+    end
+
+    # Sets whether or not an Errno::ECONNREFUSED should be considered a
+    # successful ping.
+    # 
+    def self.service_check=(bool)
+      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
+        raise ArgumentError, 'argument must be true or false'
+      end
+      @@service_check = bool
+    end
+
+    # This method attempts to ping a host and port using a TCPSocket with
+    # the host, port and timeout values passed in the constructor.  Returns
+    # true if successful, or false otherwise.
+    # 
+    # Note that, by default, an Errno::ECONNREFUSED return result will be
+    # considered a failed ping.  See the documentation for the
+    # Ping::TCP.service_check= method if you wish to change this behavior.
+    # 
+    def ping(host=@host)
+      super(host)
+
+      bool = false
+      tcp = nil
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout){
+          begin
+            tcp = TCPSocket.new(host, @port)
+          rescue Errno::ECONNREFUSED => err
+            if @@service_check
+              bool = true
+            else
+              @exception = err
+            end
+          rescue Exception => err
+            @exception = err
+          else
+            bool = true
+          end
+        }
+      rescue Timeout::Error => err
+        @exception = err
+      ensure
+        tcp.close if tcp
+      end
+
+      # There is no duration if the ping failed
+      @duration = Time.now - start_time if bool
+
+      bool
+    end
+
+    alias ping? ping
+    alias pingecho ping
+      
+    # Class method aliases. DEPRECATED.
+    class << self
+      alias econnrefused service_check
+      alias econnrefused= service_check=
+      alias ecr service_check
+      alias ecr= service_check=         
+    end
+  end
+end

data/lib/net/ping/udp.rb

@@ -0,0 +1,119 @@
+require File.join(File.dirname(__FILE__), 'ping')
+
+# The Net module serves as a namespace only.
+module Net
+
+  # The Ping::UDP class encapsulates methods for UDP pings.
+  class Ping::UDP < Ping
+    @@service_check = true
+      
+    # Returns whether or not the connect behavior should enforce remote
+    # service availability as well as reachability. The default is true.
+    #
+    def self.service_check
+      @@service_check
+    end
+      
+    # Set whether or not the connect behavior should enforce remote
+    # service availability as well as reachability. If set to false
+    # then Errno::ECONNREFUSED or Errno::ECONNRESET will be considered
+    # a successful ping, meaning no actual data handshaking is required.
+    # By default, if either of those errors occurs it is considered a failed
+    # ping.
+    #
+    def self.service_check=(bool)
+      unless bool.kind_of?(TrueClass) || bool.kind_of?(FalseClass)
+        raise ArgumentError, 'argument must be true or false'
+      end
+      @@service_check = bool         
+    end
+      
+    # The maximum data size that can be sent in a UDP ping.
+    MAX_DATA = 64
+      
+    # The data to send to the remote host. By default this is 'ping'.
+    # This should be MAX_DATA size characters or less.
+    # 
+    attr_reader :data
+      
+    # Creates and returns a new Ping::UDP object.  This is effectively
+    # identical to its superclass constructor.
+    # 
+    def initialize(host=nil, port=nil, timeout=5)
+      @data = 'ping'
+
+      super(host, port, timeout)
+
+      @bind_host = nil
+      @bind_port = nil
+    end
+      
+    # Sets the data string sent to the remote host. This value cannot have
+    # a size greater than MAX_DATA.
+    # 
+    def data=(string)
+       if string.size > MAX_DATA
+         err = "cannot set data string larger than #{MAX_DATA} characters"
+         raise ArgumentError, err
+       end
+         
+       @data = string
+    end
+
+    # Associates the local end of the UDP connection with the given +host+
+    # and +port+. This is essentially a wrapper for UDPSocket#bind.
+    #
+    def bind(host, port)
+      @bind_host = host
+      @bind_port = port
+    end
+
+    # Sends a simple text string to the host and checks the return string. If
+    # the string sent and the string returned are a match then the ping was
+    # successful and true is returned. Otherwise, false is returned.
+    #
+    def ping(host = @host)
+      super(host)
+
+      bool  = false
+      udp   = UDPSocket.open
+      array = []
+
+      if @bind_host
+        udp.bind(@bind_host, @bind_port)
+      end
+
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout){
+          udp.connect(host, @port)
+          udp.send(@data, 0)
+          array = udp.recvfrom(MAX_DATA)
+        }
+      rescue Errno::ECONNREFUSED, Errno::ECONNRESET => err
+        if @@service_check
+          @exception = err
+        else
+          bool = true
+        end
+      rescue Exception => err
+        @exception = err
+      else
+        if array[0] == @data
+          bool = true
+        end
+      ensure
+        udp.close if udp
+      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/wmi.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), 'ping')
+require 'win32ole'
+
+# The Net module serves as a namespace only.
+#
+module Net
+   
+   # The Ping::WMI class encapsulates the Win32_PingStatus WMI class for
+   # MS Windows.
+   #
+   class Ping::WMI < Ping
+
+      PingStatus = Struct.new(
+         'PingStatus',
+         :address,
+         :buffer_size,
+         :no_fragmentation,
+         :primary_address_resolution_status,
+         :protocol_address,
+         :protocol_address_resolved,
+         :record_route,
+         :reply_inconsistency,
+         :reply_size,
+         :resolve_address_names,
+         :response_time,
+         :response_time_to_live,
+         :route_record,
+         :route_record_resolved,
+         :source_route,
+         :source_route_type,
+         :status_code,
+         :timeout,
+         :timestamp_record,
+         :timestamp_record_address,
+         :timestamp_record_address_resolved,
+         :timestamp_route,
+         :time_to_live,
+         :type_of_service
+      )
+
+      # Unlike the ping method for other Ping subclasses, this version returns
+      # a PingStatus struct which contains various bits of information about
+      # the results of the ping itself, such as response time.
+      #
+      # In addition, this version allows you to pass certain options that are
+      # then passed on to the underlying WQL query. See the MSDN documentation
+      # on Win32_PingStatus for details.
+      #
+      # Examples:
+      #
+      #  # Ping with no options
+      #  Ping::WMI.ping('www.perl.com')
+      #
+      #  # Ping with options
+      #  Ping::WMI.ping('www.perl.com', :BufferSize => 64, :NoFragmentation => true)
+      #--
+      # The PingStatus struct is a wrapper for the Win32_PingStatus WMI class.
+      #
+      def ping(host = @host, options = {})
+         super(host)
+
+         lhost = Socket.gethostname
+
+         cs = "winmgmts:{impersonationLevel=impersonate}!//#{lhost}/root/cimv2"
+         wmi = WIN32OLE.connect(cs)
+
+         query = "select * from win32_pingstatus where address = '#{host}'"
+
+         unless options.empty?
+            options.each{ |key, value|
+               if value.is_a?(String)
+                  query << " and #{key} = '#{value}'"
+               else
+                  query << " and #{key} = #{value}"
+               end
+            }
+         end
+
+         status = Struct::PingStatus.new
+
+         wmi.execquery(query).each{ |obj|
+            status.address                           = obj.Address
+            status.buffer_size                       = obj.BufferSize
+            status.no_fragmentation                  = obj.NoFragmentation
+            status.primary_address_resolution_status = obj.PrimaryAddressResolutionStatus
+            status.protocol_address                  = obj.ProtocolAddress
+            status.protocol_address_resolved         = obj.ProtocolAddressResolved
+            status.record_route                      = obj.RecordRoute 
+            status.reply_inconsistency               = obj.ReplyInconsistency
+            status.reply_size                        = obj.ReplySize
+            status.resolve_address_names             = obj.ResolveAddressNames
+            status.response_time                     = obj.ResponseTime
+            status.response_time_to_live             = obj.ResponseTimeToLive
+            status.route_record                      = obj.RouteRecord
+            status.route_record_resolved             = obj.RouteRecordResolved
+            status.source_route                      = obj.SourceRoute
+            status.source_route_type                 = obj.SourceRouteType
+            status.status_code                       = obj.StatusCode
+            status.timeout                           = obj.Timeout
+            status.timestamp_record                  = obj.TimeStampRecord
+            status.timestamp_record_address          = obj.TimeStampRecordAddress
+            status.timestamp_record_address_resolved = obj.TimeStampRecordAddressResolved
+            status.timestamp_route                   = obj.TimeStampRoute
+            status.time_to_live                      = obj.TimeToLive
+            status.type_of_service                   = obj.TypeOfService
+         }
+
+         status.freeze # Read-only data
+      end      
+
+      # Unlike Net::Ping::WMI#ping, this method returns true or false to
+      # indicate whether or not the ping was successful.
+      #
+      def ping?(host = @host, options = {})
+         ping(host, options).status_code == 0
+      end
+   end   
+end

data/net-ping.gemspec

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |spec|
+  spec.name      = 'net-ping'
+  spec.version   = '1.6.2'
+  spec.license   = 'Artistic 2.0'
+  spec.author    = 'Daniel J. Berger'
+  spec.email     = 'djberg96@gmail.com'
+  spec.homepage  = 'https://github.com/djberg96/net-ping'
+  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('ffi', '>= 1.0.0')
+
+  spec.add_development_dependency('test-unit', '>= 2.5.0')
+  spec.add_development_dependency('fakeweb', '>= 1.3.0')
+  spec.add_development_dependency('rake')
+
+  if File::ALT_SEPARATOR
+    require 'rbconfig'
+    arch = RbConfig::CONFIG['build_os']
+    spec.platform = Gem::Platform.new(['universal', arch])
+    spec.platform.version = nil
+
+    # Used for icmp pings.
+    spec.add_dependency('win32-security', '>= 0.2.0')
+
+    if RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM != 'java'
+      spec.add_dependency('win32-open3', '>= 0.3.1')
+    end
+  end
+
+  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.
+  EOF
+end

data/test/test_net_ping.rb

@@ -0,0 +1,35 @@
+######################################################################
+# test_net_ping.rb
+#
+# Test suite for all the Ping subclasses. Note that the Ping::ICMP
+# class test won't be run unless this is run as a privileged process.
+######################################################################
+require 'test_net_ping_external'
+require 'test_net_ping_http'
+require 'test_net_ping_tcp'
+require 'test_net_ping_udp'
+require 'fakeweb'
+
+if File::ALT_SEPARATOR
+  require 'win32/security'
+
+  if Win32::Security.elevated_security?
+    require 'test_net_ping_icmp'
+  end
+else
+  if Process.euid == 0
+    require 'test_net_ping_icmp'
+  end
+end
+
+if File::ALT_SEPARATOR
+  require 'test_net_ping_wmi'
+end
+
+class TC_Net_Ping < Test::Unit::TestCase
+  def test_net_ping_version
+    assert_equal('1.6.2', Net::Ping::VERSION)
+  end
+end
+
+FakeWeb.allow_net_connect = false

data/test/test_net_ping_external.rb

@@ -0,0 +1,129 @@
+#########################################################################
+# test_net_ping_external.rb
+#
+# Test case for the Net::PingExternal class. Run this via the 'test' or
+# 'test:external' rake task.
+#
+# WARNING: I've noticed that test failures will occur if you're using
+# OpenDNS. This is apparently caused by them messing with upstream
+# replies for advertising purposes.
+#########################################################################
+require 'test-unit'
+require 'net/ping/external'
+
+class TC_Net_Ping_External < Test::Unit::TestCase
+  def setup
+    @host  = 'localhost'
+    @bogus = 'foo.bar.baz'
+    @pe    = Net::Ping::External.new(@host)
+    @bad   = Net::Ping::External.new(@bogus)
+  end
+
+  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
+
+  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_alias_method(@pe, :ping?, :ping)
+  end
+
+  test "pingecho alias" do
+    assert_nothing_raised{ @pe.pingecho }
+    assert_alias_method(@pe, :pingecho, :ping)
+  end
+
+  test "pinging a good host returns true" do
+    assert_true(@pe.ping?)
+  end
+
+  test "pinging a bogus host returns false" do
+    assert_false(@bad.ping?)
+  end
+
+  test "duration basic functionality" do
+    assert_nothing_raised{ @pe.ping }
+    assert_respond_to(@pe, :duration)
+    assert_kind_of(Float, @pe.duration)
+  end
+
+  test "duration is unset if a bad ping follows a good ping" do
+    assert_nothing_raised{ @pe.ping }
+    assert_not_nil(@pe.duration)
+    assert_false(@pe.ping?(@bogus))
+    assert_nil(@pe.duration)
+  end
+
+  test "host getter basic functionality" do
+    assert_respond_to(@pe, :host)
+    assert_equal('localhost', @pe.host)
+  end
+
+  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_equal(7, @pe.port)
+  end
+
+  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_equal(5, @pe.timeout)
+  end
+
+  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_nil(@pe.exception)
+  end
+
+  test "pinging a bogus host stores exception data" do
+    assert_nothing_raised{ @bad.ping? }
+    assert_not_nil(@bad.exception)
+  end
+
+  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
+    @host  = nil
+    @bogus = nil
+    @pe    = nil
+    @bad   = nil
+  end
+end