dbi-dbrc 1.1.7-x86-mingw32

data/dbi-dbrc.gemspec

@@ -0,0 +1,37 @@
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name       = 'dbi-dbrc'
+  spec.version    = '1.1.7'
+  spec.author     = 'Daniel Berger'
+  spec.email      = 'djberg96@gmail.com'
+  spec.license    = 'Artistic 2.0'
+  spec.summary    = 'A simple way to avoid hard-coding passwords with DBI'
+  spec.homepage   = 'http://www.rubyforge.org/projects/shards'
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.test_files = Dir['test/test*.rb']
+
+  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+  spec.rubyforge_project = 'shards'
+
+  spec.add_dependency('sys-admin', '>= 1.5.2')
+  spec.add_development_dependency('test-unit')
+
+  if Config::CONFIG['host_os'] =~ /mswin|msdos|win32|mingw|cygwin/i
+    spec.add_dependency('win32-file', '>= 0.6.6')
+    spec.add_dependency('win32-dir', '>= 0.3.7')
+    spec.add_dependency('win32-process', '>= 0.6.2')
+    spec.platform = Gem::Platform::CURRENT
+  end
+
+  spec.description = <<-EOF
+    The dbi-dbrc library provides an interface for storing database
+    connection information, including passwords, in a locally secure
+    file only accessible by you, or root. This allows you to avoid
+    hard coding login and password information in your programs
+    that require such information.
+
+    This library can also be used to store login and password information
+    for logins on remote hosts, not just databases.
+  EOF
+end

data/examples/plain/test.rb

@@ -0,0 +1,21 @@
+###########################################################################
+# test.rb
+#
+# This script is provided for those without TestUnit installed and/or for
+# general futzing.
+###########################################################################
+if File.basename(Dir.pwd) == "plain"
+   Dir.chdir "../.."
+   $LOAD_PATH.unshift Dir.pwd + "/lib"
+   Dir.chdir "examples/plain"
+end
+
+require "pp"
+require "dbi/dbrc"
+include DBI
+
+puts "VERSION: " + DBRC::VERSION
+
+db = DBRC.new("foo","user1",Dir.pwd)
+
+pp db

data/examples/xml/test_xml.rb

@@ -0,0 +1,28 @@
+#######################################################################
+# test_xml.rb
+#
+# Simple test script that uses the DBRC::XML subclass.
+#######################################################################
+if File.basename(Dir.pwd) == "xml"
+   Dir.chdir "../.."
+   $LOAD_PATH.unshift Dir.pwd + "/lib"
+   Dir.chdir "examples/xml"
+end
+
+require "dbi/dbrc"
+require "pp"
+include DBI
+
+puts "VERSION: " + DBRC::XML::VERSION
+
+# Use the .dbrc file in this directory
+db1 = DBRC::XML.new("foo",nil,Dir.pwd) # Get first entry found for 'foo'
+db2 = DBRC::XML.new("foo","user1",Dir.pwd) # Specify user
+
+puts "First entry found for 'foo': "
+pp db1
+puts "=" * 20
+
+puts "Entry for 'foo' with user 'bar': "
+pp db2
+puts "=" * 20

data/examples/yml/test_yml.rb

@@ -0,0 +1,28 @@
+#######################################################################
+# test_xml.rb
+#
+# Simple test script that uses the DBRC::XML subclass.
+#######################################################################
+if File.basename(Dir.pwd) == "yml"
+   Dir.chdir "../.."
+   $LOAD_PATH.unshift Dir.pwd + "/lib"
+   Dir.chdir "examples/yml"
+end
+
+require "dbi/dbrc"
+require "pp"
+include DBI
+
+puts "VERSION: " + DBRC::YML::VERSION
+
+# Use the .dbrc file in this directory
+db1 = DBRC::YML.new("foo",nil,Dir.pwd) # Get first entry found for 'foo'
+db2 = DBRC::YML.new("foo","user1",Dir.pwd) # Specify user
+
+puts "First entry found for 'foo': "
+pp db1
+puts "=" * 20
+
+puts "Entry for 'foo' with user 'bar': "
+pp db2
+puts "=" * 20

data/lib/dbi/dbrc.rb

@@ -0,0 +1,305 @@
+require 'rbconfig'
+require 'rubygems'
+
+if Config::CONFIG['host_os'] =~ /mswin|msdos|win32|mingw|cygwin/i
+  require 'win32/dir'
+  require 'win32/file'
+  require 'win32/process'
+end
+
+require 'sys/admin'
+
+# The DBI module serves as a namespace only.
+module DBI
+
+  # The DBRC class encapsulates a database resource config file.
+  class DBRC
+
+    # This error is raised if anything fails trying to read the config file.
+    class Error < StandardError; end
+
+    # The version of the dbi-dbrc library
+    VERSION = '1.1.7'
+
+    @@windows = Config::CONFIG['host_os'] =~ /mswin|msdos|win32|mingw|cygwin/i
+
+    # 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
+    # entry that matches both the database and user name is parsed.
+    #
+    # If a directory is passed as the third argument, then DBRC will look
+    # in that directory, instead of the default directory, for the .dbrc
+    # file.
+    #
+    # 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
+    # then 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?
+        uid  = Process.uid
+        home = ENV['HOME'] || ENV['USERPROFILE']
+
+        if home.nil?
+          if @@windows
+            home ||= Sys::Admin.get_user(uid, :localaccount => true).dir
+          else
+            home ||= Sys::Admin.get_user(uid).dir
+          end
+        end
+
+        # Default to the app data directory on Windows if no home dir found
+        if @@windows && home.nil?
+          @dbrc_file = File.join(File.basename(Dir::APPDATA), '.dbrc')
+        else
+          uid = Process.uid
+          @dbrc_file = File.join(Sys::Admin.get_user(uid).dir, '.dbrc')
+        end
+      else
+        raise Error, 'bad directory' unless File.directory?(dbrc_dir)
+        @dbrc_file = File.join(dbrc_dir, '.dbrc')
+      end
+         
+      @dbrc_dir  = dbrc_dir
+      @database  = database
+      @user      = user
+      encrypted  = false # Win32 only
+
+      @driver   = nil
+      @interval = nil
+      @timeout  = nil
+      @maximum_reconnects = nil
+
+      check_file()
+         
+      # Decrypt and re-encrypt the file if we're on MS Windows and the
+      # file is encrypted.
+      begin
+        if @@windows && File.encrypted?(@dbrc_file)
+          file_was_encrypted = true
+          File.decrypt(@dbrc_file)
+        end
+         
+        parse_dbrc_config_file()
+        validate_data()
+        convert_numeric_strings()
+        create_dsn_string()
+      ensure
+        if @@windows && file_was_encrypted
+          File.encrypt(@dbrc_file)
+        end
+      end
+    end
+
+    # Inspection of the DBI::DBRC object. This is identical to the standard
+    # Ruby Object#inspect, except that the password field is filtered.
+    #
+    def inspect 
+      str = instance_variables.map{ |iv| 
+        if iv == '@password'
+          "#{iv}=[FILTERED]"
+        else
+          "#{iv}=#{instance_variable_get(iv).inspect}" 
+        end
+      }.join(', ') 
+
+      "#<#{self.class}:0x#{(self.object_id*2).to_s(16)} " << str << ">"
+    end
+
+    private
+
+    # Ensure that the user/password has been set
+    def validate_data
+      unless @user
+        raise Error, "no user found associated with #{@database}"
+      end
+
+      unless @password
+        raise Error, "password not defined for #{@user}@#{@database}"
+      end
+    end
+   
+    # Converts strings that should be numbers into actual numbers
+    def convert_numeric_strings
+      @interval   = @interval.to_i if @interval
+      @timeout    = @timeout.to_i if @timeout
+      @maximum_reconnects = @maximum_reconnects.to_i if @maximum_reconnects
+    end
+
+    # Create the dsn string if the driver is defined
+    def create_dsn_string
+      @dsn = "dbi:#{@driver}:#{@database}" if @driver
+    end
+
+    # Check ownership and permissions
+    def check_file(file=@dbrc_file)
+      File.open(file){ |f|
+        # Permissions must be set to 600 or better on Unix systems.
+        # Must be hidden on Win32 systems.
+        if @@windows
+          unless File.hidden?(file)
+            raise Error, "The .dbrc file must be hidden"
+          end
+        else
+          unless (f.stat.mode & 077) == 0
+            raise Error, "Bad .dbrc file permissions"
+          end
+        end
+
+        # Only the owner may use it
+        unless f.stat.owned?
+          raise Error, "Not owner of .dbrc file"
+        end
+      }
+    end
+
+    # Parse the text out of the .dbrc file.  This is the only method you
+    # need to redefine if writing your own config handler.
+    def parse_dbrc_config_file(file=@dbrc_file)
+       IO.foreach(file){ |line|
+          next if line =~ /^#/    # Ignore comments
+          db, user, pwd, driver, timeout, max, interval = line.split
+
+          next unless @database == db
+
+          if @user
+             next unless @user == user
+          end
+
+          @user               = user
+          @password           = pwd
+          @driver             = driver
+          @timeout            = timeout
+          @maximum_reconnects = max
+          @interval           = interval
+          return
+       }
+
+       # If we reach here it means the database and/or user wasn't found
+       if @user
+          err = "no record found for #{@user}@#{@database}"
+       else
+          err = "no record found for #{@database}"
+       end
+
+       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(:host, :database)
+  end
+
+  # A subclass of DBRC designed to handle .dbrc files in XML format.  The
+  # public methods of this class are identical to DBRC.
+  class XML < DBRC
+    require "rexml/document"
+    include REXML
+
+    private
+
+    def parse_dbrc_config_file(file=@dbrc_file)
+      doc = Document.new(File.new(file))
+      fields = %w/user password driver interval timeout maximum_reconnects/
+      doc.elements.each("/dbrc/database"){ |element|
+        next unless element.attributes["name"] == database
+        if @user
+          next unless element.elements["user"].text == @user
+        end
+        fields.each{ |field|
+          val = element.elements[field]
+          unless val.nil?
+            send("#{field}=",val.text)
+          end
+        }
+       return
+      }
+      # If we reach here it means the database and/or user wasn't found
+      raise Error, "No record found for #{@user}@#{@database}"
+    end
+  end
+
+  # A subclass of DBRC designed to handle .dbrc files in YAML format. The
+  # public methods of this class are identical to DBRC.
+  class YML < DBRC
+    require "yaml"
+
+    private
+
+    def parse_dbrc_config_file(file=@dbrc_file)
+      config = YAML.load(File.open(file))
+      config.each{ |hash|
+        hash.each{ |db,info|
+          next unless db == @database
+          next unless @user == info["user"] if @user
+          @user       = info["user"]            
+          @password   = info["password"]
+          @driver     = info["driver"]
+          @interval   = info["interval"]
+          @timeout    = info["timeout"]
+          @maximum_reconnects = info["max_reconn"]
+          return
+        }
+      }
+      # If we reach this point, it means the database wasn't found
+      raise Error, "No entry found for #{@user}@#{@database}"
+    end
+  end
+end

data/test/test_dbi_dbrc.rb

@@ -0,0 +1,201 @@
+#########################################################################
+# test_dbi_dbrc.rb
+#
+# Test suite for the base class of DBI::DBRC. This test case should be
+# run via the 'rake test' task.
+#########################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'dbi/dbrc'
+require 'test/unit'
+include DBI
+
+class TC_DBI_DBRC < Test::Unit::TestCase
+   def self.startup
+      @@windows = File::ALT_SEPARATOR
+   end
+
+   def setup
+      @dir      = File.join(Dir.pwd, 'examples/plain')
+      @file     = File.join(@dir, '.dbrc')
+      @db1      = 'foo'
+      @db2      = 'bar'
+      @user1    = 'user1'
+      @user2    = 'user2'
+      @db_bad   = 'blah'  # Doesn't exist
+      @user_bad = 'user8' # Doesn't exist
+     
+      if @@windows && File.respond_to?(:set_attr)
+         File.set_attr(@file, File::HIDDEN)
+      else
+         File.chmod(0600, @file)
+      end
+      
+      @dbrc = DBRC.new(@db1, nil, @dir)
+   end
+
+   def test_version
+      assert_equal('1.1.7', DBRC::VERSION)
+   end
+
+   def test_bad_dbrc_properties
+      if @@windows
+         File.unset_attr(@file, File::HIDDEN)
+         assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
+      else
+         File.chmod(0555,@file)
+         assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
+      end
+   end
+
+   def test_constructor
+      assert_raises(ArgumentError){ DBRC.new }
+      assert_nothing_raised{ DBRC.new(@db1, @user1, @dir) }
+      assert_nothing_raised{ DBRC.new(@db1, nil, @dir) }
+   end
+
+   def test_bad_database
+      assert_raise(DBRC::Error){ DBRC.new(@db_bad, nil, @dir) }
+   end
+
+   def test_bad_user
+      assert_raise(DBRC::Error){ DBRC.new(@db1, @user_bad, @dir) }
+   end
+
+   def test_bad_dir
+      assert_raise(DBI::DBRC::Error){ DBI::DBRC.new(@db1, @user1, '/bogusXX') }
+   end
+
+   def test_database
+      assert_respond_to(@dbrc, :database)
+      assert_respond_to(@dbrc, :database=)
+      assert_respond_to(@dbrc, :db)
+      assert_respond_to(@dbrc, :db=)
+      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=)
+   end
+
+   def test_user
+      assert_respond_to(@dbrc, :user)
+      assert_respond_to(@dbrc, :user=)
+      assert_kind_of(String, @dbrc.user)
+   end
+
+   def test_password
+      assert_respond_to(@dbrc, :password)
+      assert_respond_to(@dbrc, :password=)
+      assert_respond_to(@dbrc, :passwd)
+      assert_respond_to(@dbrc, :passwd=)
+      assert_kind_of(String, @dbrc.password)
+   end
+
+   def test_driver
+      assert_respond_to(@dbrc, :driver)
+      assert_respond_to(@dbrc, :driver=)
+      assert_kind_of(String, @dbrc.driver)
+   end
+
+   def test_interval
+      assert_respond_to(@dbrc, :interval)
+      assert_respond_to(@dbrc, :interval=)
+      assert_kind_of(Fixnum, @dbrc.interval)
+   end
+
+   def test_timeout
+      assert_respond_to(@dbrc, :timeout)
+      assert_respond_to(@dbrc, :timeout=)
+      assert_respond_to(@dbrc, :time_out)
+      assert_respond_to(@dbrc, :time_out=)
+      assert_kind_of(Fixnum, @dbrc.timeout)
+   end
+
+   def test_max_reconn
+      assert_respond_to(@dbrc, :max_reconn)
+      assert_respond_to(@dbrc, :max_reconn=)
+      assert_respond_to(@dbrc, :maximum_reconnects)
+      assert_respond_to(@dbrc, :maximum_reconnects=)
+      assert_kind_of(Fixnum, @dbrc.maximum_reconnects)
+   end
+
+   def test_sample_values
+      assert_equal("foo", @dbrc.database)
+      assert_equal("user1", @dbrc.user)
+      assert_equal("pwd1", @dbrc.passwd)
+      assert_equal("Oracle", @dbrc.driver)
+      assert_equal(60, @dbrc.interval)
+      assert_equal(40, @dbrc.timeout)
+      assert_equal(3, @dbrc.max_reconn)
+      assert_equal("dbi:Oracle:foo", @dbrc.dsn)
+   end
+
+   # Same database, different user
+   def test_duplicate_database
+      db = DBRC.new("foo", "user2", @dir) 
+      assert_equal("user2", db.user)
+      assert_equal("pwd2", db.passwd)
+      assert_equal("OCI8", db.driver)
+      assert_equal(60, db.interval)
+      assert_equal(60, db.timeout)
+      assert_equal(4, db.max_reconn)
+      assert_equal("dbi:OCI8:foo", db.dsn)
+   end
+
+   # Different database, different user
+   def test_different_database
+      db = DBRC.new("bar", "user1", @dir)
+      assert_equal("user1", db.user)
+      assert_equal("pwd3", db.passwd)
+      assert_equal("Oracle", db.driver)
+      assert_equal(30, db.interval)
+      assert_equal(30, db.timeout)
+      assert_equal(2, db.max_reconn)
+      assert_equal("dbi:Oracle:bar", db.dsn)
+   end
+
+   # A database with only a couple fields defined
+   def test_nil_values
+      db = DBRC.new("baz", "user3", @dir) 
+      assert_equal("user3", db.user)
+      assert_equal("pwd4", db.passwd)
+      assert_nil(db.driver)
+      assert_nil(db.interval)
+      assert_nil(db.timeout)
+      assert_nil(db.max_reconn)
+      assert_nil(db.dsn)
+   end
+
+   def teardown
+      @dir      = nil
+      @db1      = nil
+      @db2      = nil
+      @user1    = nil
+      @user2    = nil
+      @db_bad   = nil
+      @user_bad = nil
+      @dbrc     = nil
+   end
+
+   def self.shutdown
+      @@windows = nil
+   end
+end