net-ping 1.4.1 → 1.5.0

data/CHANGES

@@ -1,3 +1,9 @@
+== 1.5.0 - 3-May-2011
+* Added the Net::Ping::LDAP class which allows you to perform LDAP pings.
+  Thanks go to Paul Gallagher for adding this.
+* The duration instance variable is now reset to nil on a failed ping. Again,
+  thanks go to Paul Gallagher.
+
 == 1.4.1 - 17-Mar-2011
 * Incorporated changes from Lukas Zapletal that alters the icmp tests to use
   your localhost instead of going outside the network.

data/MANIFEST

@@ -9,6 +9,7 @@
 * 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
@@ -17,6 +18,7 @@
 * test/test_net_ping_external.rb
 * test/test_net_ping_http.rb
 * test/test_net_ping_icmp.rb
+* test/test_net_ping_ldap.rb
 * test/test_net_ping_tcp.rb
 * test/test_net_ping_udp.rb
 * test/test_net_ping_wmi.rb

data/Rakefile

@@ -39,6 +39,11 @@ namespace 'example' do
   task :udp do
      ruby '-Ilib examples/example_pingudp.rb'
   end
+
+  desc 'Run the ldap ping example program'
+  task :ldap do
+     ruby '-Ilib examples/example_pingldap.rb'
+  end
 end
 
 Rake::TestTask.new do |t|
@@ -84,6 +89,12 @@ namespace 'test' do
      t.verbose = true
      t.test_files = FileList['test/test_net_ping_wmi.rb']
   end
+
+  Rake::TestTask.new('ldap') do |t|
+     t.warning = true
+     t.verbose = true
+     t.test_files = FileList['test/test_net_ping_ldap.rb']
+  end
 end
 
 task :default => :test

data/doc/ping.txt

@@ -43,6 +43,7 @@
    * Ping::HTTP
    * Ping::ICMP
    * Ping::WMI
+   * Ping::LDAP
 
    All Ping classes are children of the Ping parent class (which should
    never be instantiated directly).
@@ -135,6 +136,30 @@ Ping::WMI#ping(host, options={})
 Ping::WMI#ping?(host, options={})
    Returns whether or not the ping succeeded.
 
+== Ping::LDAP
+Ping::LDAP.new(uri=nil, timeout=5)
+   Performs a 'ping' to an LDAP server in the form of either an anonymous
+   or an authenticated LDAP bind.
+   Identical to Net::Ping.new except that, instead of a host, the first
+   argument is a URI.
+   The default +timeout+ is 5 seconds.
+  
+   +uri+ string is expected to be a full URI with scheme (ldap/ldaps)
+   and optionally the port (else default port is assumed) e.g.
+    ldap://my.ldap.host.com
+    ldap://my.ldap.host.com:1389
+    ldaps://my.ldap.host.com
+    ldaps://my.ldap.host.com:6636
+  
+  If a plain hostname is provided as the +uri+, a default port of 389 is assumed
+
+Ping::LDAP#encryption
+   Set/get the encyption method. By default is nil, but may be set to :simple_tls
+
+Ping::LDAP#username
+Ping::LDAP#password
+   set/get the username and password for ping using and authenticated bind.
+
 = Common Instance Methods
 Ping#exception
    Returns the error string that was set if a ping call failed.  If an exception

data/examples/example_pingldap.rb

@@ -0,0 +1,22 @@
+########################################################################
+# example_pingldap.rb
+#
+# A short sample program demonstrating an ldap ping. You can run
+# this program via the example:ldap task. Modify as you see fit.
+########################################################################
+require 'net/ping/ldap'
+
+good = 'ldap://localhost'
+bad  = 'ldap://example.com'
+
+puts "== Good ping (if you have an ldap server at #{good})"
+
+p1 = Net::Ping::LDAP.new(good)
+p p1.ping?
+
+puts "== Bad ping"
+
+p2 = Net::Ping::LDAP.new(bad)
+p p2.ping?
+p p2.warning
+p p2.exception

data/lib/net/ping.rb

@@ -9,6 +9,7 @@ require File.join(File.dirname(__FILE__), 'ping/udp')
 require File.join(File.dirname(__FILE__), 'ping/icmp')
 require File.join(File.dirname(__FILE__), 'ping/external')
 require File.join(File.dirname(__FILE__), 'ping/http')
+require File.join(File.dirname(__FILE__), 'ping/ldap')
 
 if Config::CONFIG['host_os'] =~ /msdos|mswin|cygwin|mingw|win32|windows/i
   require File.join(File.dirname(__FILE__), 'ping/wmi')

data/lib/net/ping/ldap.rb

@@ -0,0 +1,107 @@
+require File.join(File.dirname(__FILE__), 'ping')
+require 'net/ldap'
+require 'uri'
+
+
+# The Net module serves as a namespace only.
+module Net
+
+  # The Ping::LDAP class encapsulates methods for LDAP pings.
+  class Ping::LDAP < Ping
+
+    # uri contains the URI object for the request
+    #
+    attr_accessor :uri
+
+    # username and password may be set for ping using
+    # an authenticated LDAP bind
+    #
+    attr_accessor :username
+    attr_accessor :password
+
+    # set/get the encryption method. By default nil,
+    # but may be set to :simple_tls
+    #
+    attr_accessor :encryption
+    def encryption=(value)
+      @encryption = (value.is_a? Symbol) ? value : value.to_sym
+    end
+
+    # Creates and returns a new Ping::LDAP object.
+    # The default +timeout+ is 5 seconds.
+    #
+    # +uri+ string is expected to be a full URI with scheme (ldap/ldaps)
+    # and optionally the port (else default port is assumed) e.g.
+    #   ldap://my.ldap.host.com
+    #   ldap://my.ldap.host.com:1389
+    #   ldaps://my.ldap.host.com
+    #   ldaps://my.ldap.host.com:6636
+    #
+    # If a plain hostname is provided as the +uri+, a default port of 389 is assumed
+    #
+    def initialize(uri=nil, timeout=5)
+      host, port = decode_uri(uri)
+      super(host, port, timeout)
+    end
+
+    # method used to decode uri string
+    #
+    def decode_uri(value)
+      @uri = URI.parse(value)
+      if uri.scheme =~ /ldap/
+        p = @port = uri.port
+        h = @host = uri.host
+        @encryption = uri.scheme=='ldaps' ? :simple_tls : nil
+      else
+        h = value
+        p = 389
+      end
+      [h, p]
+    end
+
+    # constructs the LDAP configuration structure
+    #
+    def config
+      {
+        :host => uri.host,
+        :port => uri.port,
+        :encryption => encryption
+      }.merge(
+        (username && password) ?
+        { :auth => {:method => :simple, :username => username, :password => password} } :
+        { :auth => {:method => :anonymous} }
+      )
+    end
+
+    # perform ping, optionally providing the ping destination uri
+    #
+    def ping(host = nil)
+      decode_uri(host) if host
+      super(@host)
+      
+      bool = false
+
+      start_time = Time.now
+
+      begin
+        Timeout.timeout(@timeout) do
+          Net::LDAP.new( config  ).bind
+        end
+      rescue Net::LDAP::LdapError => e
+        @exception = e.message
+      rescue Exception => e
+        @exception = e.message
+      else
+        bool = true
+      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/ping.rb

@@ -10,7 +10,7 @@ module Net
    #
    class Ping
       # The version of the net-ping library.
-      VERSION = '1.4.1'
+      VERSION = '1.5.0'
 
       # The host to ping. In the case of Ping::HTTP, this is the URI.
       attr_accessor :host
@@ -80,6 +80,7 @@ module Net
          raise ArgumentError, 'no host specified' unless host
          @exception = nil
          @warning   = nil
+         @duration  = nil
       end
 
       alias ping? ping

data/net-ping.gemspec

@@ -3,21 +3,22 @@ require 'rbconfig'
 
 Gem::Specification.new do |gem|
   gem.name      = 'net-ping'
-  gem.version   = '1.4.1'
+  gem.version   = '1.5.0'
   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_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
   if File::ALT_SEPARATOR && RUBY_PLATFORM != 'java'
@@ -32,7 +33,7 @@ Gem::Specification.new do |gem|
 
   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
+    separate TCP, HTTP, LDAP, ICMP, UDP, WMI (for Windows) and external ping
     classes.
   EOF
 end

data/test/test_net_ping.rb

@@ -30,7 +30,7 @@ end
 
 class TC_Net_Ping < Test::Unit::TestCase
   def test_net_ping_version
-    assert_equal('1.4.1', Net::Ping::VERSION)
+    assert_equal('1.5.0', Net::Ping::VERSION)
   end
 end
 

data/test/test_net_ping_external.rb

@@ -59,6 +59,13 @@ class TC_Net_Ping_External < Test::Unit::TestCase
     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('www.ruby-lang.org', @pe.host)

data/test/test_net_ping_ldap.rb

@@ -0,0 +1,200 @@
+#################################################################################
+# test_net_ping_http.rb
+#
+# Test case for the Net::PingHTTP class. This should be run via the 'test' or
+# 'test:http' Rake task.
+#################################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'net/ping/ldap'
+require 'fakeldap'
+
+class TC_Net_Ping_LDAP < Test::Unit::TestCase
+  class << self
+    def startup
+      @@host = 'localhost'
+      @@port = 2389
+      @@uri = "ldap://#{@@host}:#{@@port}"
+      @@timeout = 30
+      @@cn = 'el.Daper'
+      @@password = 'ldappassword'
+      
+      @@ldap_server = FakeLDAP::Server.new(:port => @@port)
+      @@ldap_server.run_tcpserver
+      @@ldap_server.add_user("cn=#{@@cn},ou=USERS,dc=example,dc=com", @@password)
+    end
+    def shutdown
+      @@ldap_server.stop
+    end
+  end
+  def setup
+    @ldap = Net::Ping::LDAP.new(@@uri, @@timeout)
+    @ldap.username = @@cn
+    @ldap.password = @@password
+    @bogus = 'ldap://blabfoobarurghxxxx.com' # One hopes so
+    @bad  = Net::Ping::LDAP.new(@bogus)
+  end
+
+  def teardown
+    @ldap = nil
+  end
+
+  test 'ping basic functionality' do
+    assert_respond_to(@ldap, :ping)
+    assert_nothing_raised{ @ldap.ping }
+  end
+
+  test 'ping returns a boolean value' do
+    assert_boolean(@ldap.ping?)
+    assert_boolean(@bad.ping?)
+  end
+
+  test 'ping? is an alias for ping' do
+    assert_alias_method(@ldap, :ping?, :ping)
+  end
+
+  test 'pingecho is an alias for ping' do
+    assert_alias_method(@ldap, :pingecho, :ping)
+  end
+
+  test 'ping should succeed for a valid website' do
+    assert_true(@ldap.ping?)
+  end
+
+  test 'ping should fail for an invalid website' do
+    assert_false(@bad.ping?)
+  end
+
+  test 'duration basic functionality' do
+    assert_respond_to(@ldap, :duration)
+    assert_nothing_raised{ @ldap.ping }
+  end
+
+  test 'duration returns a float value on a successful ping' do
+    assert_true(@ldap.ping)
+    assert_kind_of(Float, @ldap.duration)
+  end
+
+  test 'duration is nil on an unsuccessful ping' do
+    assert_false(@bad.ping)
+    assert_nil(@ldap.duration)
+  end
+
+  test "duration is unset if a bad ping follows a good ping" do
+    assert_true{ @ldap.ping }
+    assert_not_nil(@ldap.duration)
+    assert_false(@ldap.ping?(@bogus))
+    assert_nil(@ldap.duration)
+  end
+
+  test 'host attribute basic functionality' do
+    assert_respond_to(@ldap, :host)
+    assert_respond_to(@ldap, :host=)
+    assert_equal(@@host, @ldap.host)
+  end
+  
+  test 'port attribute basic functionality' do
+    assert_respond_to(@ldap, :port)
+    assert_respond_to(@ldap, :port=)
+  end
+
+  test 'port attribute expected value' do
+    assert_equal(@@port, @ldap.port)
+  end
+
+  test 'timeout attribute basic functionality' do
+    assert_respond_to(@ldap, :timeout)
+    assert_respond_to(@ldap, :timeout=)
+  end
+
+  test 'timeout attribute expected values' do
+    assert_equal(@@timeout, @ldap.timeout)
+    assert_equal(5, @bad.timeout)
+  end
+
+  test 'exception attribute basic functionality' do
+    assert_respond_to(@ldap, :exception)
+    assert_nil(@ldap.exception)
+  end
+
+  test 'exception attribute is nil if the ping is successful' do
+    assert_true(@ldap.ping)
+    assert_nil(@ldap.exception)
+  end
+
+  test 'exception attribute is not nil if the ping is unsuccessful' do
+    assert_false(@bad.ping)
+    assert_not_nil(@bad.exception)
+  end
+
+  test 'warning attribute basic functionality' do
+    assert_respond_to(@ldap, :warning)
+    assert_nil(@ldap.warning)
+  end
+
+  test 'uri attribute basic functionality' do
+    assert_respond_to(@ldap, :uri)
+    assert_respond_to(@ldap, :uri=)
+  end
+
+  test 'username attribute basic functionality' do
+    assert_respond_to(@ldap, :username)
+    assert_respond_to(@ldap, :username=)
+  end
+
+  test 'password attribute basic functionality' do
+    assert_respond_to(@ldap, :password)
+    assert_respond_to(@ldap, :password=)
+  end
+
+  test 'encryption attribute basic functionality' do
+    assert_respond_to(@ldap, :encryption)
+    assert_respond_to(@ldap, :encryption=)
+  end
+
+  test 'encryption defaults to nil for ldap' do
+    assert_nil(Net::Ping::LDAP.new('ldap://somehost.example.net').encryption)
+  end
+
+  test 'encryption defaults to simple_tls for ldaps' do
+    assert_equal(:simple_tls, Net::Ping::LDAP.new('ldaps://somehost.example.net').encryption)
+  end
+
+  test 'port defaults to 389 for ldap' do
+    assert_equal(389, Net::Ping::LDAP.new('ldap://somehost.example.net').port)
+  end
+
+  test 'port defaults to 636 for ldaps' do
+    assert_equal(636, Net::Ping::LDAP.new('ldaps://somehost.example.net').port)
+  end
+
+  test 'port extracted from uri if provided' do
+    assert_equal(12345, Net::Ping::LDAP.new('ldap://somehost.example.net:12345').port)
+    assert_equal(12345, Net::Ping::LDAP.new('ldaps://somehost.example.net:12345').port)
+  end
+
+  test 'encryption setting is forced to symbol' do
+    @ldap.encryption = 'simple_tls'
+    assert_true( @ldap.encryption.is_a? Symbol )
+    assert_true( @ldap.config[:encryption].is_a? Symbol )
+  end
+
+  test 'username/password set in config auth section' do
+    @ldap.username, @ldap.password = 'fred', 'derf'
+    assert_equal('fred', @ldap.config[:auth][:username] )
+    assert_equal('derf', @ldap.config[:auth][:password] )
+  end
+
+  test 'auth method defaults to simple if username/password set' do
+    @ldap.username, @ldap.password = 'fred', 'derf'
+    assert_equal(:simple, @ldap.config[:auth][:method] )
+  end
+
+  test 'if no username/password then defaults to auth anonymous' do
+    @ldap.username = @ldap.password = nil
+    assert_equal({:method => :anonymous}, @ldap.config[:auth] )
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: net-ping
 version: !ruby/object:Gem::Version 
-  hash: 5
-  prerelease: false
+  hash: 3
+  prerelease: 
   segments: 
   - 1
-  - 4
-  - 1
-  version: 1.4.1
+  - 5
+  - 0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -15,13 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-17 00:00:00 -06:00
+date: 2011-05-04 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: test-unit
+  name: net-ldap
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 2
+        - 2
+        version: 0.2.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,11 +49,11 @@ dependencies:
         - 2
         version: 2.1.2
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: fakeweb
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -49,8 +65,24 @@ dependencies:
         - 0
         version: 1.3.0
   type: :development
-  version_requirements: *id002
-description: "    The net-ping library provides a ping interface for Ruby. It includes\n    separate TCP, HTTP, ICMP, UDP, WMI (for Windows) and external ping\n    classes.\n"
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeldap
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :development
+  version_requirements: *id004
+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: []
 
@@ -61,31 +93,34 @@ extra_rdoc_files:
 - CHANGES
 - doc/ping.txt
 files: 
-- CHANGES
+- Rakefile
+- README
 - doc/ping.txt
-- examples/example_pingexternal.rb
-- examples/example_pinghttp.rb
-- examples/example_pingtcp.rb
-- examples/example_pingudp.rb
+- lib/net/ping.rb
 - lib/net/ping/external.rb
-- lib/net/ping/http.rb
 - lib/net/ping/icmp.rb
+- lib/net/ping/wmi.rb
+- lib/net/ping/udp.rb
 - lib/net/ping/ping.rb
+- lib/net/ping/ldap.rb
+- lib/net/ping/http.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
+- CHANGES
+- examples/example_pinghttp.rb
+- examples/example_pingldap.rb
+- examples/example_pingexternal.rb
+- examples/example_pingtcp.rb
+- examples/example_pingudp.rb
+- test/test_net_ping_ldap.rb
 - test/test_net_ping_http.rb
 - test/test_net_ping_icmp.rb
-- test/test_net_ping_tcp.rb
 - test/test_net_ping_udp.rb
 - test/test_net_ping_wmi.rb
+- test/test_net_ping_external.rb
+- test/test_net_ping_tcp.rb
+- test/test_net_ping.rb
+- MANIFEST
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
 licenses: 
@@ -116,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A ping interface for Ruby.