net-tnsping 1.1.0 → 1.2.0

data/CHANGES

@@ -1,3 +1,14 @@
+== 1.2.0 - 20-Jul-2007
+* Changed the TNSPing class name to Ping::TNS in order to follow the naming
+  convention in net-ping. The TNSPingError class was likewise changed to
+  Ping::TNS::Error. However, I've setup class aliases for the sake of backwards
+  compatability. However, new programs should use the new class names.
+* Fixed an initialization warning.
+* Added a Rakefile with tasks for testing and installation. This also means
+  the install.rb file was removed, since installation is now handled by the
+  Rakefile.
+* Some updates to the test suite.
+
 == 1.1.0 - 16-Jun-2005
 * The prerequisite "net-pingsimple" was changed to "net-ping", because
   that project name changed.

data/MANIFEST

@@ -1,11 +1,8 @@
-CHANGES
-MANIFEST
-README
-install.rb
-net-tnsping.gemspec
-
-examples/test_tnsping.rb
-
-lib/net/tnsping.rb
-
-test/tc_tns_ping.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* net-tnsping.gemspec
+* examples/test_tnsping.rb
+* lib/net/tnsping.rb
+* test/tc_tns_ping.rb

data/README

@@ -10,23 +10,24 @@
 == Installation
 
 === Manual Installation
-   ruby test/tc_tns_ping.rb (optional)
-   ruby install.rb
+   rake test (optional)
+   rake install
    
 === Gem Installation
+   rake test (optional)
    ruby net-tnsping.gemspec
    gem install net-tnsping-<version>.gem
 	
 === Installation Note
    You will have to manually tweak one instance variable (@db) in the
-   test suite in order to get all tests to pass.  Set it to a known database
+   test suite in order to get all tests to pass. Set it to a known database
    name.
 
 == Synopsis
    require "net/tnsping"
    include Net
 
-   t = TNSPing.new("my_db")
+   t = Ping::TNS.new("my_db")
 
    if t.ping?
       puts "Database appears to be up and running"
@@ -39,52 +40,52 @@ VERSION
    The version number of this package, returned as a String.
 
 == Class Methods
-TNSPing.new(db, driver="OCI8", host=nil, port=1521, timeout=5)   
-   Creates and returns a new TNSPing object.  If the db specified cannot be
-   found in the tnsnames.ora file, then a TNSPingError is raised.
+Ping::TNS.new(db, driver="OCI8", host=nil, port=1521, timeout=5)   
+   Creates and returns a new Ping::TNS object. If the db specified cannot be
+   found in the tnsnames.ora file, then a Ping::TNS::Error is raised.
 
 == Instance Methods
-TNSPing#db
-   Returns the name of the database that the TNSPing#ping_database? method
+Ping::TNS#db
+   Returns the name of the database that the Ping::TNS#ping_database? method
    will attempt to connect to.
 
-TNSPing#db=(database)
-   Sets the name of the database that the TNSPing#ping_database? method
+Ping::TNS#db=(database)
+   Sets the name of the database that the Ping::TNS#ping_database? method
    will attempt to connect to.
 
-TNSPing#driver
-   Returns the name of the driver used by the TNSPing#ping_database? method.
+Ping::TNS#driver
+   Returns the name of the driver used by the Ping::TNS#ping_database? method.
    The default is OCI8.
 
-TNSPing#driver=(driver)
-   Sets the name of the driver used by the TNSPing#ping_database? method.
+Ping::TNS#driver=(driver)
+   Sets the name of the driver used by the Ping::TNS#ping_database? method.
 
-TNSPing#dsn
-   Returns the dsn string that is used by TNSPing#ping_database?.
+Ping::TNS#dsn
+   Returns the dsn string that is used by Ping::TNS#ping_database?.
 
-TNSPing#dsn=(string)
-   Sets the dsn string that is used by TNSPing#ping_database?.  It should
+Ping::TNS#dsn=(string)
+   Sets the dsn string that is used by Ping::TNS#ping_database?.  It should
    be in the form "dbi:driver:database".
 
-TNSPing#host
-   Returns the host that the TNSPing#ping_listener? call will use.  This may
-   be nil, in which case, the TNSPing#hosts method will list which hosts it
+Ping::TNS#host
+   Returns the host that the Ping::TNS#ping_listener? call will use.  This may
+   be nil, in which case, the Ping::TNS#hosts method will list which hosts it
    will attempt to ping.
 
-TNSPing#host=(host)
-   Sets the host that the TNSPing#ping_listener? call will use.  If this is
+Ping::TNS#host=(host)
+   Sets the host that the Ping::TNS#ping_listener? call will use.  If this is
    set, then a ping will only be attempted against this host, irregardless
    of what is in the tnsnames.ora file.
 
-TNSPing#oracle_home
+Ping::TNS#oracle_home
    Returns the path to the oracle home directory.  The default is either
    ENV["ORACLE_HOME"] or ENV["ORA_HOME"].
 
-TNSPing#oracle_home=(path)
+Ping::TNS#oracle_home=(path)
    Sets the path to the oracle home directory.
 
-TNSPing#ping?
-TNSPing#ping_listener?
+Ping::TNS#ping?
+Ping::TNS#ping_listener?
    Performs a TCP ping on the listener. The host and port are determined from
    your tnsnames.ora file. If more than one host and/or port are found in the
    tnsnames.ora file, then each will be tried.  So long as at least one of
@@ -93,7 +94,7 @@ TNSPing#ping_listener?
    If you specify a host and port in the constructor, then the attempt will
    only be made against that host on the given port.
 
-TNSPing#ping_database?(dsn=nil, timeout=nil, user=nil, passwd=nil)
+Ping::TNS#ping_database?(dsn=nil, timeout=nil, user=nil, passwd=nil)
    Attempts to make a connection using a bogus login and password via the DBI
    class.  If an ORA-01017 Oracle error is returned, that means the database
    is up and running and true is returned.
@@ -103,45 +104,45 @@ TNSPing#ping_database?(dsn=nil, timeout=nil, user=nil, passwd=nil)
    should not pass any arguments to this method.
 
    In the event that this method fails, false is returned and the error can
-   be viewed via TNSPing#exception.
+   be viewed via Ping::TNS#exception.
 
-TNSPing#ping_all?
-   A shortcut method that merely calls TNSPing#ping? and TNSPing#ping_database? 
+Ping::TNS#ping_all?
+   A shortcut method that merely calls Ping::TNS#ping? and Ping::TNS#ping_database? 
    in succession.  Returns true if both succeed, false otherwise.
 
-TNSPing#port
-   Returns the port that the TNSPing#ping_listener? will ping against.  This
-   may be nil, in which case the TNSPing#ports method will list which ports
+Ping::TNS#port
+   Returns the port that the Ping::TNS#ping_listener? will ping against.  This
+   may be nil, in which case the Ping::TNS#ports method will list which ports
    it will attempt to ping against.
 
-TNSPing#port=(num)
-   Sets the port that the TNSPing#ping_listener? method will use.  If this is
+Ping::TNS#port=(num)
+   Sets the port that the Ping::TNS#ping_listener? method will use.  If this is
    set, then a ping will only be attempted on this port, irregardless of what
    is in the tnsnames.ora file.
 
-TNSPing#timeout
+Ping::TNS#timeout
    Returns the timeout value used by all internal ping methods.
 
-TNSPing#timeout=(seconds)
+Ping::TNS#timeout=(seconds)
    Sets the timeout used by all internal ping methods.
 
-TNSPing#tns_admin
+Ping::TNS#tns_admin
    Returns the path to the tns admin directory.  The default is
    ENV["TNS_ADMIN"].
 
-TNSPing#tns_admin=(path)
+Ping::TNS#tns_admin=(path)
    Sets the path to the tns admin directory.
 
-TNSPing#tns_file
+Ping::TNS#tns_file
    Returns the full path to the tnsnames.ora file.
 
-TNSPing#tns_file=(path)
+Ping::TNS#tns_file=(path)
    Sets the path to the tnsnames.ora file.
 
 == Notes
-   The TNSPing class is a subclass of PingTCP.
+   The Ping::TNS class is a subclass of Ping::TCP.
 
-   This is NOT a wrapper for the tnsping utility.  It performs two actions.
+   This is NOT a wrapper for the tnsping utility. It performs two actions.
    First, it attempts to ping the database using the appropriate port via TCP.
    Then, it attempts to make a connection using a bogus name and password,
    looking for error ORA-1017.
@@ -150,10 +151,10 @@ TNSPing#tns_file=(path)
    Q: "Why didn't you just wrap a backticked tnsping call?"
 
    A: First, because the output is unpredictable. On two different platforms I
-   received two different output streams for the same datasource.  Who knows
+   received two different output streams for the same datasource. Who knows
    what it's like on other platforms?
 
-   Second, tnsping *only* tells you if the listener is up.  It doesn't
+   Second, tnsping *only* tells you if the listener is up. It doesn't
    actually test that the datasource is up and running.
 
    Q: "Why didn't you write an extension using the tnsping source?"
@@ -172,7 +173,7 @@ TNSPing#tns_file=(path)
    with some questions I had.
 
 == Copyright
-   (C) 2003-2005 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All rights reserved.
 	
 == Warranty
@@ -185,5 +186,5 @@ TNSPing#tns_file=(path)
 
 == Author
    Daniel J. Berger
-   djberg96 at yahoo dot com
+   djberg96 at nospam at gmail dot com
    imperator on IRC (irc.freenode.net)

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+
+desc "Install the net-tnsping package (non-gem)"
+task :install do
+   dest = File.join(Config::CONFIG['sitelibdir'], 'net')
+   Dir.mkdir(dest) unless File.exists? dest
+   cp 'lib/net/tnsping.rb', dest, :verbose => true
+end
+
+desc "Install the net-tnsping package as a gem"
+task :install_gem do
+   ruby 'net-tnsping.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+end
+
+Rake::TestTask.new do |t|
+   t.libs << 'lib'
+   t.warning = true
+   t.test_files = FileList['test/tc*']
+end

data/lib/net/tnsping.rb

@@ -2,21 +2,22 @@ require "dbi"
 require "net/ping"
 
 module Net
-   class TNSPingError < StandardError; end
-   class TNSPing < PingTCP
+   class Ping::TNS < Ping::TCP
+      class Error < StandardError; end
 
-      VERSION = "1.1.0"
+      VERSION = '1.2.0'
 
       attr_accessor :db, :dsn, :tns_file, :host, :tns_admin
-      attr_accessor :oracle_home, :driver, :timeout
+      attr_accessor :ora_home, :driver, :timeout
       attr_reader :hosts, :ports, :port
 
-      # Creates and returns a new TNSPing object.  If the db specified cannot
-      # be found in the tnsnames.ora file, then a TNSPingError is raised.
+      # Creates and returns a new Ping::TNS object. If the db specified cannot
+      # be found in the tnsnames.ora file, then a Ping::TNS::Error is raised.
       #
       def initialize(db, driver="OCI8", host=nil, port=1521, timeout=5)
          @db        = db
          @dsn       = "dbi:#{driver}:" << db
+         @host      = host
          @timeout   = timeout
          @port      = port
          @tns_admin = tns_admin
@@ -24,15 +25,15 @@ module Net
          @hosts     = []  # for each dsn.  Try them in order.
          @sid       = nil
 
-         @tns_admin   = ENV["TNS_ADMIN"]
-         @oracle_home = ENV["ORACLE_HOME"] || ENV["ORA_HOME"]
+         @tns_admin = ENV['TNS_ADMIN']
+         @ora_home  = ENV['ORACLE_HOME'] || ENV['ORA_HOME']
 
          if @tns_admin
-            @tns_file = @tns_admin + "/tnsnames.ora"
-         elsif @oracle_home
-            @tns_file = @oracle_home + "/network/admin/tnsnames.ora"
+            @tns_file = File.join(@tns_admin, 'tnsnames.ora')
+         elsif @ora_home
+            @tns_file = File.join(@ora_home, 'network', 'admin', 'tnsnames.ora')
          else
-            @tns_file = ENV["HOME"] + "/tnsnames.ora"
+            @tns_file = File.join(ENV["HOME"] + 'tnsnames.ora')
          end
 
          yield self if block_given?
@@ -40,7 +41,7 @@ module Net
          # If the host is not specified, look for it in the tnsnames.or file
          if host.nil?
             err_msg = "tnsnames.ora file could not be found"
-            raise TNSPingError, err_msg unless File.exists?(@tns_file)
+            raise Error, err_msg unless File.exists?(@tns_file)
             parse_tns_file
          else
             @hosts.push(host)
@@ -48,7 +49,7 @@ module Net
          end
       end
 
-      # Sets the port that the TNSPing#ping_listener? method will use.  If
+      # Sets the port that the Ping::TNS#ping_listener? method will use.  If
       # this is set, then a ping will only be attempted on this port,
       # regardless of what is in the tnsnames.ora file.
       #
@@ -69,7 +70,7 @@ module Net
       #
       def ping?
          if @hosts.empty?
-            raise TNSPingError, "No hosts found"
+            raise Error, "No hosts found"
          end
 
          # Use 1521 if no ports were found in the tnsnames.ora file.
@@ -100,16 +101,16 @@ module Net
       # passed to the constructor (or have a default otherwise set).  You
       # generally should not pass any arguments to this method.
       # In the event that this method fails, false is returned and the error
-      # can be viewed via TNSPing#exception.
+      # can be viewed via Ping::TNS#exception.
       #--
-      # I have intentionally set the user and password to something zany in
+      # I have intentionally set the user and password to something random in
       # order to avoid the possibility of accidentally guessing them.  In
       # case of cosmic coincidence, set them yourself.
       #
-      def ping_database?(dsn=@dsn, timeout=@timeout, user=@sid, passwd="xz949")
+      def ping_database?(dsn=@dsn, timeout=@timeout, user=@sid, passwd=Time.now.to_s)
          re   = /ORA-01017/
          dbh  = nil
-         user ||= "pzoyadf244"
+         user ||= Time.now.to_s
          rv = false
          begin
             Timeout.timeout(timeout){
@@ -180,7 +181,7 @@ module Net
          }
 
          unless found
-            raise TNSPingError, "unable to find #{db} in #{file}"
+            raise Error, "unable to find '#{db}' in #{file}"
          end
 
          # Break each 'key = value' line into its parts
@@ -200,6 +201,11 @@ module Net
          }
       end
 
-      alias :ping_listener? :ping?
+      alias ping_listener? ping?
+      alias oracle_home ora_home
+      alias oracle_home= ora_home=
    end
+
+   TNSPing = Ping::TNS             # Alias for backwards compatability
+   TNSPingError = Ping::TNS::Error # Alias for backwards compatability
 end

data/test/tc_tns_ping.rb

@@ -1,31 +1,22 @@
-#########################################
+########################################################################
 # tc_tns_ping.rb
 #
-# Test suite for the tns-ping package.
-#########################################
-base = File.basename(Dir.pwd)
-
-if base == "test" || base =~ /net-tnsping.*/
-   Dir.chdir("..") if base == "test"
-   $LOAD_PATH.unshift(Dir.pwd)
-   $LOAD_PATH.unshift(Dir.pwd + "/lib")
-end
-
+# Test suite for the tns-ping package. This should be run via the
+# 'rake test' Rake task.
+########################################################################
 require "test/unit"
 require "net/tnsping"
 include Net
 
-# NOTE:
-# You'll need to change the db and host if you want to run these tests.
-
-class TC_TNSPing < Test::Unit::TestCase
+class TC_TNS_Ping < Test::Unit::TestCase
    def setup
-      @db = "changme"
-      @tp = TNSPing.new(@db)
+      @db = 'changme' # Change to a valid host in your network
+      @tp = Ping::TNS.new(@db)
    end
    
    def test_version
-      assert_equal("1.1.0", TNSPing::VERSION)
+      assert_equal("1.2.0", Ping::TNS::VERSION)
+      assert_equal("1.2.0", TNSPing::VERSION) # Testing the alias really
    end
 
    def test_db
@@ -99,14 +90,14 @@ class TC_TNSPing < Test::Unit::TestCase
    end
 
    def test_bad_db
-      bad_db = "foo123bar"
-      assert_raises(TNSPingError){ TNSPing.new(bad_db) }
+      assert_raises(Ping::TNS::Error){ Ping::TNS.new('bogus_db') }
+      assert_raises(TNSPingError){ Ping::TNS.new('bogus_db') } # Alias test
       @tp.port = 9999
       assert_equal(false, @tp.ping_listener?)
    end
 
    def teardown
-      @db   = nil
-      @tp   = nil
+      @db = nil
+      @tp = nil
    end
 end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.9.4
 specification_version: 1
 name: net-tnsping
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2005-06-16
+  version: 1.2.0
+date: 2007-07-20 00:00:00 -06:00
 summary: A package for pinging Oracle listeners and databases
 require_paths: 
 - lib
@@ -23,6 +23,9 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
       version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
 - Daniel J. Berger
 files: 
@@ -30,6 +33,7 @@ files:
 - CHANGES
 - MANIFEST
 - README
+- Rakefile
 - test/tc_tns_ping.rb
 test_files: 
 - test/tc_tns_ping.rb