net-ping 1.3.3-x86-mingw32

data/lib/net/ping/ping.rb

@@ -0,0 +1,88 @@
+require 'socket'
+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.3'
+
+      # The host to ping. In the case of Ping::HTTP, this is the URI.
+      attr_accessor :host
+
+      # The port to ping. This is set to the echo port (7) by default. The
+      # Ping::HTTP class defaults to port 80.
+      #
+      attr_accessor :port
+
+      # The maximum time a ping attempt is made.
+      attr_accessor :timeout
+
+      # If a ping fails, this value is set to the error that occurred which
+      # caused it to fail.
+      #
+      attr_reader :exception
+
+      # This value is set if a ping succeeds, but some other condition arose
+      # during the ping attempt which merits warning, e.g a redirect in the
+      # case of Ping::HTTP#ping.
+      #
+      attr_reader :warning
+
+      # The number of seconds (returned as a Float) that it took to ping
+      # the host. This is not a precise value, but rather a good estimate
+      # since there is a small amount of internal calculation that is added
+      # to the overall time.
+      #
+      attr_reader :duration
+
+      # 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.
+      #
+      # Yields +self+ in block context.
+      #
+      # This class is not meant to be instantiated directly.  It is strictly
+      # meant as an interface for subclasses.
+      #
+      def initialize(host=nil, port=nil, timeout=5)
+         @host      = host
+         @port      = port || Socket.getservbyname('echo') || 7
+         @timeout   = timeout
+         @exception = nil
+         @warning   = nil
+         @duration  = nil
+
+         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
+      # are reset.
+      #
+      # If +host+ is nil here, then it will use the host specified in the
+      # constructor.  If the +host+ is nil and there was no host specified
+      # in the constructor then an ArgumentError is raised.
+      #--
+      # The @duration should be set in the subclass' ping method.
+      #
+      def ping(host = @host)
+         raise ArgumentError, 'no host specified' unless host
+         @exception = nil
+         @warning   = nil
+      end
+      
+      alias ping? ping
+      alias pingecho ping
+   end
+end

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,38 @@
+require 'rubygems'
+require 'rbconfig'
+
+Gem::Specification.new do |gem|
+  gem.name      = 'net-ping'
+  gem.version   = '1.3.3'
+  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.has_rdoc  = true
+  gem.files     = Dir['**/*'].reject{ |f| f.include?('git') }
+
+  gem.rubyforge_project = 'shards'
+  gem.extra_rdoc_files  = ['README', 'CHANGES', 'doc/ping.txt']
+
+  gem.add_development_dependency('test-unit', '>= 2.0.9')
+
+  # These dependencies are for Net::Ping::External
+  if Config::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw/i &&
+    RUBY_PLATFORM != 'java'
+  then
+    gem.platform = Gem::Platform::CURRENT
+    gem.add_dependency('windows-pr', '>= 1.0.8')
+
+    if RUBY_VERSION.to_f < 1.9
+      gem.add_dependency('win32-open3', '>= 0.3.1') 
+    end
+  end
+
+  gem.description = <<-EOF
+    The net-ping library provides a ping interface for Ruby. It includes
+    separate TCP, HTTP, ICMP, UDP, WMI (for Windows) and external ping
+    classes.
+  EOF
+end