net-ping 1.2.2-x86-mswin32-60

data/lib/net/ping/tcp.rb

@@ -0,0 +1,86 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'ping'
+
+module Net
+
+   # With a TCP ping, simply try to open a connection.  If we are successful,
+   # assume bool.  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
+
+   # Class alias for backwards compatibility
+   PingTCP = Ping::TCP
+end

data/lib/net/ping/udp.rb

@@ -0,0 +1,119 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'ping'
+
+module Net
+   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
+      
+      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
+
+   # Class alias for backwards compatibility
+   PingUDP = Ping::UDP
+end

data/net-ping.gemspec

@@ -0,0 +1,35 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+   gem.name        = "net-ping"
+   gem.version     = "1.2.2"
+   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/ts_ping.rb"
+   gem.has_rdoc    = true
+   gem.rubyforge_project = "shards"
+   gem.files = Dir["lib/net/*"] + Dir['[A-Z]*']  + Dir['test/*']
+   gem.files += Dir["lib/net/ping/*"]
+   gem.files.reject! { |fn| fn.include? "CVS" }
+   gem.extra_rdoc_files = ["README", "CHANGES", "doc/ping.txt"]
+
+   case RUBY_PLATFORM
+   when /mswin/i
+      gem.platform = Gem::Platform::CURRENT
+      gem.add_dependency('win32-open3', '>= 0.2.5') # Ping::External
+      gem.add_dependency('windows-pr', '>= 0.7.4')  # Ping::External
+   else
+      gem.platform = Gem::Platform::RUBY
+   end
+
+   description = "A ping interface for Ruby. Includes TCP, HTTP, ICMP, UDP, "
+   description << "and External ping interfaces."
+   gem.description = description
+end
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

data/net-ping.gemspec~

@@ -0,0 +1,34 @@
+require "rubygems"
+
+spec = Gem::Specification.new do |gem|
+   gem.name        = "net-ping"
+   gem.version     = "1.2.2"
+   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/ts_ping.rb"
+   gem.has_rdoc    = true
+   gem.files = Dir["lib/net/*"] + Dir['[A-Z]*']  + Dir['test/*']
+   gem.files += Dir["lib/net/ping/*"]
+   gem.files.reject! { |fn| fn.include? "CVS" }
+   gem.extra_rdoc_files = ["README", "CHANGES", "doc/ping.txt"]
+
+   case RUBY_PLATFORM
+   when /mswin/i
+      gem.platform = Gem::Platform::CURRENT
+      gem.add_dependency('win32-open3', '>= 0.2.5') # Ping::External
+      gem.add_dependency('windows-pr', '>= 0.7.4')  # Ping::External
+   else
+      gem.platform = Gem::Platform::RUBY
+   end
+
+   description = "A ping interface for Ruby. Includes TCP, HTTP, ICMP, UDP, "
+   description << "and External ping interfaces."
+   gem.description = description
+end
+
+if $0 == __FILE__
+   Gem.manage_gems
+   Gem::Builder.new(spec).build
+end

data/test/tc_pingexternal.rb

@@ -0,0 +1,89 @@
+#########################################################################
+# tc_pingexternal.rb
+#
+# Test case for the Net::PingExternal class. Run this via the 'test' or
+# 'test_external' rake task.
+#########################################################################
+require 'test/unit'
+require 'net/ping/external'
+include Net
+
+class TC_PingExternal < Test::Unit::TestCase
+   def setup
+      @host  = 'www.ruby-lang.org'
+      @bogus = 'foo.bar.baz'
+      @pe    = Ping::External.new(@host)
+      @bad   = Ping::External.new(@bogus)
+   end
+
+   def test_version
+      assert_equal('1.2.2', PingExternal::VERSION)
+   end
+   
+   def test_ping
+      assert_respond_to(@pe, :ping)
+      assert_nothing_raised{ @pe.ping }
+      assert_nothing_raised{ @pe.ping(@host) }
+   end
+
+   def test_ping_aliases
+      assert_respond_to(@pe, :ping?)
+      assert_respond_to(@pe, :pingecho)
+      assert_nothing_raised{ @pe.ping? }
+      assert_nothing_raised{ @pe.ping?(@host) }
+      assert_nothing_raised{ @pe.pingecho }
+      assert_nothing_raised{ @pe.pingecho(@host) }
+   end
+
+   def test_good_ping     
+      assert_equal(true, @pe.ping?)
+   end
+
+   def test_bad_ping
+      assert_equal(false, @bad.ping?)
+      assert_equal(false, @bad.exception.nil?, "Bad exception data")
+   end
+
+   def test_duration
+      assert_nothing_raised{ @pe.ping }
+      assert_respond_to(@pe, :duration)
+      assert_kind_of(Float, @pe.duration)
+   end
+
+   def test_host
+      assert_respond_to(@pe, :host)
+      assert_respond_to(@pe, :host=)
+      assert_equal('www.ruby-lang.org', @pe.host)
+   end
+
+   def test_port
+      assert_respond_to(@pe, :port)
+      assert_respond_to(@pe, :port=)
+      assert_equal(7, @pe.port)
+   end
+
+   def test_timeout
+      assert_respond_to(@pe, :timeout)
+      assert_respond_to(@pe, :timeout=)
+      assert_equal(5, @pe.timeout)
+   end
+
+   def test_exception
+      assert_respond_to(@pe, :exception)
+      assert_nothing_raised{ @pe.ping }
+      assert_nothing_raised{ @bad.ping }
+      assert_nil(@pe.exception)
+      assert_not_nil(@bad.exception)
+   end
+
+   def test_warning
+      assert_respond_to(@pe, :warning)
+   end
+
+   def teardown
+      @host  = nil
+      @bogus = nil
+      @pe    = nil
+      @bad   = nil
+   end
+end

data/test/tc_pinghttp.rb

@@ -0,0 +1,83 @@
+#################################################################################
+# tc_pinghttp.rb
+#
+# Test case for the Net::PingHTTP class. This should be run via the 'test' or
+# 'test_http' test task.
+#################################################################################
+require 'test/unit'
+require 'net/ping/http'
+include Net
+
+class TC_PingHTTP < Test::Unit::TestCase
+   def setup
+      @uri  = 'http://www.google.com/index.html'
+      @http = Ping::HTTP.new(@uri, 80, 30)      
+      @bad  = Ping::HTTP.new('http://www.blabfoobarurgh.com') # One hopes not
+   end
+
+   def test_version
+      assert_equal('1.2.2', Ping::HTTP::VERSION)
+   end
+   
+   def test_ping
+      assert_respond_to(@http, :ping)
+      assert_nothing_raised{ @http.ping }
+   end
+
+   def test_ping_aliases
+      assert_respond_to(@http, :ping?)
+      assert_respond_to(@http, :pingecho)
+      assert_nothing_raised{ @http.ping? }
+      assert_nothing_raised{ @http.pingecho }
+   end
+
+   def test_ping_success
+      assert_equal(true, @http.ping?)
+      assert_equal(false, @bad.ping?)
+      assert_not_nil(@bad.exception)
+   end
+
+   def test_duration
+      assert_nothing_raised{ @http.ping }
+      assert_respond_to(@http, :duration)
+      assert_kind_of(Float, @http.duration)
+   end
+
+   def test_host
+      assert_respond_to(@http, :host)
+      assert_respond_to(@http, :host=)
+      assert_respond_to(@http, :uri)   # Alias
+      assert_respond_to(@http, :uri=)  # Alias
+      assert_equal('http://www.google.com/index.html', @http.host)
+   end
+
+   def test_port
+      assert_respond_to(@http, :port)
+      assert_respond_to(@http, :port=)
+      assert_equal(80, @http.port)
+   end
+
+   def test_timeout
+      assert_respond_to(@http, :timeout)
+      assert_respond_to(@http, :timeout=)
+      assert_equal(30, @http.timeout)
+      assert_equal(5, @bad.timeout)
+   end
+
+   def test_exception
+      assert_respond_to(@http, :exception)
+      assert_nothing_raised{ @http.ping }
+      assert_nothing_raised{ @bad.ping }
+      assert_nil(@http.exception)
+      assert_not_nil(@bad.exception)
+   end
+
+   def test_warning
+      assert_respond_to(@http, :warning)
+   end
+
+   def teardown
+      @uri  = nil
+      @http = nil
+   end
+end