net-ping 1.7.1 → 1.7.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZmM3MmZjM2MxZTQ4ZWRkMGRjNzFjZDg1NmUyOTYwOTRiM2EzNzA2Yg==
-  data.tar.gz: !binary |-
-    ZmNjYTNiMzY4MDAxZTU1ZGZjMzY5MmQwMjJlNzk3YjI0MDViNGRiMQ==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    MTg3NWJmNTk5OGUzZGUxNzYxN2YzYzhjNWIwN2UxNzlhMzVkYTQ4YjdkMTgz
-    YjQxM2IxZGQxYjE4ODZmYzExMzRiNTBjNjczYTVhNDMxYzc1NjU0M2Y1NTNi
-    NzkxZmI3M2ExMWI4MzhjYTQ3YWQ1NzRhMGM1NDNkZmY1MDUzYjM=
-  data.tar.gz: !binary |-
-    MzdmOTc4ODBhZTQzMzM0NTM3YmQ5MWI2NjkwNTI5YWEwMWViNTk2ZmVjMWFi
-    OTkzZjlhMTdhZWRlNGQ4ZWM3MGVjZjhlMjU4MTc3ZGRkMTA0OWJiOTMzYTY3
-    OWI3NTY2YzA5ZTExZGU4ZDNiYmNmMzMzMjg4NGYwNGRjOTM1NzE=
+SHA1:
+  metadata.gz: 66ef8ec8a4d85b94397739115722bcb52e8b287b
+  data.tar.gz: 9b530dc0bdc258e6c3daef1c6c48677f09093661
+SHA512:
+  metadata.gz: d57ad9937a32293703c097322bc1f24d6f031c4d910b5a4131616226a46320ddfbcf1072a7f40b39b2c1879c421717a6a9389b443254e9419513d7dfbfa307e3
+  data.tar.gz: 9016ac5f9fa70b60b89e0bcca798b516336fb9002cba9f21d6c17ed5dada65c8bd6d761aeb3e227f5dd65675e02984ab31dc3ef1ed290528385e3bf0ad105cf9

data/CHANGES

@@ -1,3 +1,14 @@
+== 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
+  for the spot.
+* Removed win32-open3 require in the Ping::External class since it isn't
+  needed in Ruby 1.9.x or later.
+* Refactored the Ping::External class so that it checks the exit status rather
+  than try to parse output. Thanks go to Miguel Tubia for the suggestion.
+* Dropped explicit support for Windows XP.
+* Removed reference to win32-open3 in README.
+
 == 1.7.1 - 26-Sep-2013
 * Fixed a bug in the Ping::TCP class where it could return nil instead
   of false. Thanks go to Grandy Nguyen for the patch.

data/MANIFEST

@@ -9,7 +9,6 @@
 * examples/example_pingudp.rb
 * lib/net/ping.rb
 * lib/net/ping/icmp.rb
-* lib/net/ping/ldap.rb
 * lib/net/ping/tcp.rb
 * lib/net/ping/udp.rb
 * lib/net/ping/wmi.rb

data/README

@@ -4,7 +4,6 @@
 == Prerequisites
   * ffi
   * win32-security (MS Windows only)
-  * win32-open3 (Ruby 1.8.x on MS Windows only. Not required for JRuby)
   * fakeweb (test only)
   * test-unit (test only)
 
@@ -50,6 +49,12 @@
 
 == License
   Artistic 2.0
+
+== Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
    
 == More documentation
   If you installed this library via Rubygems, you can view the inline

data/lib/net/ping/external.rb

@@ -1,28 +1,13 @@
-require 'ffi'
+require 'open3'
 require 'rbconfig'
 
 require File.join(File.dirname(__FILE__), 'ping')
 
-if File::ALT_SEPARATOR && RUBY_VERSION.to_f < 1.9 && RUBY_PLATFORM != 'java'
-  require 'win32/open3'
-else
-  require 'open3'
-end
-
 # The Net module serves as a namespace only.
 module Net
 
   # The Ping::External class encapsulates methods for external (system) pings.
   class Ping::External < Ping
-
-    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.
     #
@@ -33,24 +18,20 @@ module Net
     def ping(host = @host)
       super(host)
 
-      stdin = stdout = stderr = nil
-      pstring = "ping "
-      bool    = false
-      orig_cp = nil
+      pcmd = ['ping']
+      bool = false
 
       case RbConfig::CONFIG['host_os']
         when /linux|bsd|osx|mach|darwin/i
-          pstring += "-c 1 #{host}"
+          pcmd += ['-c1', host]
         when /solaris|sunos/i
-          pstring += "#{host} 1"
+          pcmd += [host, '1']
         when /hpux/i
-          pstring += "#{host} -n 1"
+          pcmd += [host, '-n1']
         when /win32|windows|msdos|mswin|cygwin|mingw/i
-          orig_cp = GetConsoleCP()
-          SetConsoleCP(437) if orig_cp != 437 # United States
-          pstring += "-n 1 #{host}"
+          pcmd += ['-n', '1', host]
         else
-          pstring += "#{host}"
+          pcmd += [host]
       end
 
       start_time = Time.now
@@ -59,55 +40,26 @@ module Net
         err = nil
 
         Timeout.timeout(@timeout){
-          stdin, stdout, stderr = Open3.popen3(pstring)
-          err = stderr.gets # Can't chomp yet, might be nil
-        }
-
-        stdin.close
-        stderr.close
-
-        if File::ALT_SEPARATOR && GetConsoleCP() != orig_cp
-          SetConsoleCP(orig_cp)
-        end
-
-        unless err.nil?
-          if err =~ /warning/i
-            @warning = err.chomp
-            bool = true
-          else
-            @exception = err.chomp
+          Open3.popen3(*pcmd) do |stdin, stdout, stderr, thread|
+            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.
+                @exception = err.chomp
+              else
+                bool = false # An error occurred
+                @exception = err.chomp
+            end
           end
-        # The "no answer" response goes to stdout, not stderr, so check it
-        else
-          lines = stdout.readlines
-          stdout.close
-          if lines.nil? || lines.empty?
-            bool = true
-          else
-            regexp = /
-              no\ answer|
-              host\ unreachable|
-              could\ not\ find\ host|
-              request\ timed\ out|
-              100%\ packet\ loss
-            /ix
-
-            lines.each{ |line|
-              if regexp.match(line)
-                @exception = line.chomp
-                break
-              end
-            }
-
-            bool = true unless @exception
-          end
-        end
+        }
       rescue Exception => error
         @exception = error.message
-      ensure
-        stdin.close  if stdin  && !stdin.closed?
-        stdout.close if stdout && !stdout.closed?
-        stderr.close if stderr && !stderr.closed?
       end
 
       # There is no duration if the ping failed

data/lib/net/ping/http.rb

@@ -37,6 +37,10 @@ module Net
     # was this ping proxied?
     attr_accessor :proxied
 
+    # For unsuccessful requests that return a server error, it is
+    # useful to know the HTTP status code of the response.
+    attr_reader :code
+
     # Creates and returns a new Ping::HTTP object. The default port is the
     # port associated with the URI. The default timeout is 5 seconds.
     #
@@ -45,6 +49,7 @@ module Net
       @redirect_limit  = 5
       @ssl_verify_mode = OpenSSL::SSL::VERIFY_NONE
       @get_request     = false
+      @code            = nil
 
       port ||= URI.parse(uri).port if uri
 
@@ -75,9 +80,13 @@ module Net
 
       uri = URI.parse(host)
 
+      # A port provided here overrides anything provided in constructor
+      port = URI.split(host)[3] || @port
+      port = port.to_i
+
       start_time = Time.now
 
-      response = do_ping(uri)
+      response = do_ping(uri, port)
 
       if response.is_a?(Net::HTTPSuccess)
         bool = true
@@ -93,7 +102,7 @@ module Net
             end
             redirect = URI.parse(response['location'])
             redirect = uri + redirect if redirect.relative?
-            response = do_ping(redirect)
+            response = do_ping(redirect, port)
             rlimit   += 1
           end
 
@@ -107,6 +116,8 @@ module Net
         else
           @exception = response.message
         end
+      else
+        @exception ||= response.message
       end
 
       # There is no duration if the ping failed
@@ -127,7 +138,7 @@ module Net
       response && response.code.to_i >= 300 && response.code.to_i < 400
     end
 
-    def do_ping(uri)
+    def do_ping(uri, port)
       response = nil
       proxy    = uri.find_proxy || URI.parse("")
       begin
@@ -135,7 +146,7 @@ module Net
         headers  = { }
         headers["User-Agent"] = user_agent unless user_agent.nil?
         Timeout.timeout(@timeout) do
-          http = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(uri.host, uri.port)
+          http = Net::HTTP::Proxy(proxy.host, proxy.port, proxy.user, proxy.password).new(uri.host, port)
           @proxied = http.proxy?
           if @get_request == true
             request = Net::HTTP::Get.new(uri_path)
@@ -153,6 +164,7 @@ module Net
       rescue Exception => err
         @exception = err.message
       end
+      @code = response.code if response
       response
     end
   end

data/lib/net/ping/icmp.rb

@@ -2,7 +2,6 @@ require File.join(File.dirname(__FILE__), 'ping')
 
 if File::ALT_SEPARATOR
   require 'win32/security'
-  require File.join(File.dirname(__FILE__), 'helper')
 end
 
 # The Net module serves as a namespace only.
@@ -31,7 +30,7 @@ module Net
     def initialize(host=nil, port=nil, timeout=5)
       raise 'requires root privileges' if Process.euid > 0
 
-      if File::ALT_SEPARATOR && Windows.version >= 6
+      if File::ALT_SEPARATOR
         unless Win32::Security.elevated_security?
           raise 'requires elevated security'
         end

data/lib/net/ping/ping.rb

@@ -10,7 +10,7 @@ module Net
    #
    class Ping
       # The version of the net-ping library.
-      VERSION = '1.7.1'
+      VERSION = '1.7.2'
 
       # 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.1'
+  spec.version   = '1.7.2'
   spec.license   = 'Artistic 2.0'
   spec.author    = 'Daniel J. Berger'
   spec.email     = 'djberg96@gmail.com'
@@ -18,10 +18,8 @@ Gem::Specification.new do |spec|
   # The TCP Ping class requires this for non-blocking sockets.
   spec.required_ruby_version = ">= 1.9.1"
 
-  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('test-unit')
+  spec.add_development_dependency('fakeweb')
   spec.add_development_dependency('rake')
 
   if File::ALT_SEPARATOR
@@ -32,10 +30,6 @@ Gem::Specification.new do |spec|
 
     # 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

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.1', Net::Ping::VERSION)
+    assert_equal('1.7.2', Net::Ping::VERSION)
   end
 end
 

data/test/test_net_ping_http.rb

@@ -26,6 +26,9 @@ class TC_Net_Ping_HTTP < Test::Unit::TestCase
                          :status => ["302", "Found"])
 
     FakeWeb.register_uri(:any, 'http://www.blabfoobarurghxxxx.com', :exception => SocketError)
+    FakeWeb.register_uri(:head, 'http://http502.com',
+                         :body => "",
+                         :status => ["502", "Bad Gateway"])
 
     @http = Net::Ping::HTTP.new(@uri, 80, 30)
     @bad  = Net::Ping::HTTP.new('http://www.blabfoobarurghxxxx.com') # One hopes not
@@ -122,6 +125,11 @@ class TC_Net_Ping_HTTP < Test::Unit::TestCase
     assert_nil(@http.warning)
   end
 
+  test 'code attribute is set' do
+    assert_true(@http.ping)
+    assert_equal('200', @http.code)
+  end
+
   test 'user_agent accessor is defined' do
     assert_respond_to(@http, :user_agent)
     assert_respond_to(@http, :user_agent=)
@@ -163,6 +171,18 @@ class TC_Net_Ping_HTTP < Test::Unit::TestCase
     assert_equal("Redirect limit exceeded", @http.exception)
   end
 
+  test 'http 502 sets exception' do
+    @http = Net::Ping::HTTP.new("http://http502.com")
+    assert_false(@http.ping)
+    assert_equal('Bad Gateway', @http.exception)
+  end
+
+  test 'http 502 sets code' do
+    @http = Net::Ping::HTTP.new("http://http502.com")
+    assert_false(@http.ping)
+    assert_equal('502', @http.code)
+  end
+
   test 'ping against https site defaults to port 443' do
     @http = Net::Ping::HTTP.new(@uri_https)
     assert_equal(443, @http.port)

metadata

@@ -1,73 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: net-ping
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ffi
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-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"
+description: |2
+      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.
 email: djberg96@gmail.com
 executables: []
 extensions: []
@@ -77,25 +65,24 @@ extra_rdoc_files:
 - doc/ping.txt
 files:
 - CHANGES
+- Gemfile
+- MANIFEST
+- README
+- Rakefile
 - doc/ping.txt
 - examples/example_pingexternal.rb
 - examples/example_pinghttp.rb
 - examples/example_pingtcp.rb
 - examples/example_pingudp.rb
-- Gemfile
+- lib/net/ping.rb
 - lib/net/ping/external.rb
-- lib/net/ping/helper.rb
 - lib/net/ping/http.rb
 - lib/net/ping/icmp.rb
 - lib/net/ping/ping.rb
 - lib/net/ping/tcp.rb
 - lib/net/ping/udp.rb
 - lib/net/ping/wmi.rb
-- lib/net/ping.rb
-- MANIFEST
 - net-ping.gemspec
-- Rakefile
-- README
 - test/test_net_ping.rb
 - test/test_net_ping_external.rb
 - test/test_net_ping_http.rb
@@ -113,17 +100,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: shards
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A ping interface for Ruby.

data/lib/net/ping/helper.rb

@@ -1,33 +0,0 @@
-require 'ffi'
-
-module Windows
-  extend FFI::Library
-  ffi_lib :kernel32
-
-  attach_function :GetVersion, [], :ulong
-
-  def version
-    version = GetVersion()
-    major = LOBYTE(LOWORD(version))
-    minor = HIBYTE(LOWORD(version))
-    eval("Float(#{major}.#{minor})")
-  end
-
-  private
-
-  class << self
-    def LOWORD(l)
-      l & 0xffff
-    end
-
-    def LOBYTE(w)
-      w & 0xff
-    end
-
-    def HIBYTE(w)
-      w >> 8
-    end
-  end
-
-  module_function :version
-end