dbi-dbrc 1.1.2-x86-mswin32-60 → 1.1.3-x86-mswin32-60

data/CHANGES

@@ -1,3 +1,10 @@
+== 1.1.3 - 21-Jul-2008
+* More RUBY_PLATFORM changes that I missed in the last release.
+* Added inline RDOC for the accessors and updated the documentation
+  for the constructor.
+* Added the DBI::DBRC#dbrc_dir and DBI::DBRC#dbrc_file methods.
+* More tests.
+
 == 1.1.2 - 18-Jul-2008
 * Changed platform checking from RUBY_PLATFORM to Config::CONFIG['host_os']
   so that other implementations won't choke.

data/README

@@ -1,6 +1,8 @@
 == Description
    This is a supplement to the dbi module, allowing you to avoid hard-coding
-   passwords in your programs that make database connections.
+   passwords in your programs that make database connections. It can also
+   be used as a general password storage mechanism for other types of
+   connections, e.g. ssh, ftp, etc.
 
 == Requirements
    * Ruby 1.8.2 or later
@@ -26,8 +28,6 @@
    puts dbrc.interval
    puts dbrc.dsn
 
-   dbh = DBI.connect(dbrc.dsn, dbrc.user, dbrc.password)
-
 == Installation
    rake test (optional)
    rake install (non-gem) or rake install_gem (gem)
@@ -81,7 +81,7 @@
    
 == Constants
 VERSION
-   The current version of this packages, returned as a String.
+   The current version of this library, returned as a String.
     
 == Class Methods
 DBRC.new(db, user=nil, dir=nil)
@@ -190,13 +190,15 @@ DBRC#dsn=(dsn)
    n = db.max_reconn
 
    begin
-      timeout(db.time_out){
+      Timeout.timeout(db.timeout){
          DBI.connect(db.dsn, db.user, db.passwd)
       }
    rescue DBI::Error
       n -= 1
-      sleep db.interval if n > 0
-      retry if n > 0
+      if n > 0
+         sleep db.interval
+         retry
+      end
       raise
    rescue TimeoutError
       # handle timeout error
@@ -232,7 +234,7 @@ DBRC#dsn=(dsn)
 
 == Adding your own configuration
    If you want to add your own type of configuration file, you can still use
-   the dbi-dbrc package. All you need to do is:
+   the dbi-dbrc library. All you need to do is:
 
    * subclass DBRC
    * redefine the +parse_dbrc_config_file+ method (a private method).

data/lib/dbi/dbrc.rb

@@ -6,7 +6,6 @@ if Config::CONFIG['host_os'].match('mswin')
 end
 
 require 'sys/admin'
-include Sys
 
 # The DBI module serves as a namespace only.
 module DBI
@@ -18,14 +17,45 @@ module DBI
       # the error that is raised. 
       class Error < StandardError; end
 
-      VERSION = '1.1.2'
-      attr_accessor :database, :user, :password, :driver, :dsn
-      attr_accessor :maximum_reconnects, :timeout, :interval, :dbrc_dir
+      # The version of this library
+      VERSION = '1.1.3'
 
-      # Returns a new DBRC object.  The contents of the object depend on the
-      # arguments passed to the constructor.  If only a database name is
+      # The database or host to be connected to.
+      attr_accessor :database
+
+      # The user name used for the database or host connection.
+      attr_accessor :user
+
+      # The password associated with the database or host.
+      attr_accessor :password
+
+      # The driver associated with the database. This is used to internally to
+      # construct the DSN.
+      attr_accessor :driver
+
+      # Data source name, e.g. "dbi:OCI8:your_database".
+      attr_accessor :dsn
+
+      # The maximum number of reconnects a program should make before
+      # giving up.
+      attr_accessor :maximum_reconnects
+
+      # The timeout, in seconds, for each connection attempt.
+      attr_accessor :timeout
+
+      # The interval, in seconds, between each connection attempt.
+      attr_accessor :interval
+
+      # The directory where the .dbrc file is stored.
+      attr_accessor :dbrc_dir
+
+      # The full path to the .dbrc file.
+      attr_accessor :dbrc_file
+
+      # Returns a new DBI::DBRC object. The contents of the object depend on
+      # the arguments passed to the constructor. If only a database name is
       # passed, then the first entry found in the .dbrc file that matches that
-      # database is parsed.  If a user name is also included, then the first
+      # database is parsed. If a user name is also included, then the first
       # entry that matches both the database and user name is parsed.
       #
       # If a directory is passed as the third argument, then DBRC will look
@@ -35,11 +65,28 @@ module DBI
       # If an entry cannot be found for the database, or database plus user
       # combination, then a Error is raised.  If the .dbrc file cannot
       # be found, or is setup improperly with regards to permissions or
-      # properties, a Error is raised.
+      # properties, a DBI::DBRC::Error is raised.
+      #
+      # See the README for the rules regarding .dbrc files and permissions.
+      #
+      # Note that this library can also be used as a general password
+      # storage mechanism. In that case simply treat the 'database' as the
+      # host name, and ignore the DBI::DBRC#dsn and DBI::DBRC#driver methods.
+      #
+      # Examples:
+      #
+      #   # Find the first match for 'some_database'
+      #   DBI::DBRC.new('some_database')
+      #
+      #   # Find the first match for 'foo_user@some_database'
+      #   DBI::DBRC.new('some_database', 'foo_user')
+      #
+      #   # Find the first match for 'foo_user@some_database' under /usr/local
+      #   DBI::DBRC.new('some_database', 'foo_usr', '/usr/local')
       #
       def initialize(database, user=nil, dbrc_dir=nil)
          if dbrc_dir.nil?
-            if RUBY_PLATFORM.match('mswin')
+            if Config::CONFIG['host_os'].match('mswin')
                home = ENV['USERPROFILE'] || ENV['HOME']
                file = nil
                
@@ -51,12 +98,16 @@ module DBI
                
                @dbrc_file = file
             else
-               @dbrc_file = File.join(Admin.get_user(Process.uid).dir, '.dbrc')
+               @dbrc_file = File.join(
+                  Sys::Admin.get_user(Process.uid).dir,
+                  '.dbrc'
+               )
             end
          else
             @dbrc_file = File.join(dbrc_dir, '.dbrc')
          end
          
+         @dbrc_dir  = dbrc_dir
          @database  = database
          @user      = user
          encrypted  = false # Win32 only
@@ -69,7 +120,7 @@ module DBI
          check_file()
          
          # If on Win32 and the file is encrypted, decrypt it.
-         if RUBY_PLATFORM.match("mswin") && File.encrypted?(@dbrc_file)
+         if Config::CONFIG['host_os'].match("mswin") && File.encrypted?(@dbrc_file)
             encrypted = true
             File.decrypt(@dbrc_file)
          end
@@ -80,7 +131,7 @@ module DBI
          create_dsn_string()
          
          # If on Win32 and the file was encrypted, re-encrypt it
-         if RUBY_PLATFORM.match("mswin") && encrypted
+         if Config::CONFIG['host_os'].match("mswin") && encrypted
             File.encrypt(@dbrc_file)
          end
       end
@@ -116,7 +167,7 @@ module DBI
 
             # Permissions must be set to 600 or better on Unix systems.
             # Must be hidden on Win32 systems.
-            if RUBY_PLATFORM.match("mswin")
+            if Config::CONFIG['host_os'].match("mswin")
                unless File.hidden?(file)
                   raise Error, "The .dbrc file must be hidden"
                end
@@ -165,14 +216,15 @@ module DBI
          raise Error, err
       end
 
-      alias_method(:db,:database)
-      alias_method(:db=,:database=)
-      alias_method(:passwd,:password)
-      alias_method(:passwd=,:password=)
-      alias_method(:max_reconn,:maximum_reconnects)
-      alias_method(:max_reconn=,:maximum_reconnects=)
-      alias_method(:time_out,:timeout)
-      alias_method(:time_out=,:timeout=)
+      alias_method(:db, :database)
+      alias_method(:db=, :database=)
+      alias_method(:passwd, :password)
+      alias_method(:passwd=, :password=)
+      alias_method(:max_reconn, :maximum_reconnects)
+      alias_method(:max_reconn=, :maximum_reconnects=)
+      alias_method(:time_out, :timeout)
+      alias_method(:time_out=, :timeout=)
+      alias_method(:host, :database)
    end
 
    # A subclass of DBRC designed to handle .dbrc files in XML format.  The

data/test/tc_dbrc.rb

@@ -31,7 +31,7 @@ class TC_DBRC < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.1.2", DBRC::VERSION)
+      assert_equal("1.1.3", DBRC::VERSION)
    end
 
    def test_bad_dbrc_properties
@@ -66,6 +66,21 @@ class TC_DBRC < Test::Unit::TestCase
       assert_kind_of(String, @dbrc.db)
    end
 
+   def test_host_alias
+      assert_respond_to(@dbrc, :host)
+      assert_equal(true, @dbrc.method(:host) == @dbrc.method(:database))
+   end
+
+   def test_dbrc_dir
+      assert_respond_to(@dbrc, :dbrc_dir)
+      assert_equal(@dir, @dbrc.dbrc_dir)
+   end
+
+   def test_dbrc_file
+      assert_respond_to(@dbrc, :dbrc_file)
+      assert_equal('.dbrc', File.basename(@dbrc.dbrc_file))
+   end
+
    def test_dsn
       assert_respond_to(@dbrc, :dsn)
       assert_respond_to(@dbrc, :dsn=)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dbi-dbrc
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.1.3
 platform: x86-mswin32-60
 authors: 
 - Daniel Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-18 00:00:00 -06:00
+date: 2008-07-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency