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

data/CHANGES

@@ -1,3 +1,21 @@
+== 1.1.6 - 10-Sep-2009
+* Fixed validation for dbrc_dir argument.
+* Added a test for bogus dbrc_dir arguments.
+
+== 1.1.5 - 3-Sep-2009
+* License changed to Artistic 2.0.
+* Some gemspec updates, including the license and description.
+* Renamed the test files. The ts_all.rb file was removed.
+* Added win32-process as a dependency on MS Windows.
+* Added test-unit as a development dependency. Some tests were refactored
+  to use features from test-unit 2.x.
+* Added the 'test_xml' and 'test_yml' rake tasks.
+* Refactored the main test task.
+* Added explicit copyright and warranty to the README file.
+
+== 1.1.4 - 10-Nov-2008
+* Added a custom inspect method which filters the password.
+
 == 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

data/MANIFEST

@@ -10,7 +10,6 @@
 * examples/xml_examples/test_xml.rb
 * examples/yml_examples/.dbrc
 * examples/yml_examples/test_yml.rb
-* test/ts_all.rb
-* test/tc_dbrc.rb
-* test/tc_dbrc_xml.rb
-* test/tc_dbrc_yml.rb
+* test/test_dbi_dbrc.rb
+* test/test_dbi_dbrc_xml.rb
+* test/test_dbi_dbrc_yml.rb

data/README

@@ -242,11 +242,20 @@ DBRC#dsn=(dsn)
    Take a look at the XML and YML subclasses in dbrc.rb for two examples that
    you can work from.
    
+== Future Plans
+   Add DBI::DBRC::JSON.
+   
 == Known Bugs
    I'm not positive about the dsn strings for databases other than Oracle.
    If it's not correct, please let me know.
    
+== Copyright
+   (C) Copyright 2002-2009, Daniel J. Berger, all rights reserved.
+   
+= Warranty
+   This package is provided "as is" and without any express or
+   implied warranties, including, without limitation, the implied
+   warranties of merchantability and fitness for a particular purpose
+   
 == Author
    Daniel J. Berger
-   djberg96 at nospam at gmail dot com
-   imperator on IRC (irc.freenode.net)

data/Rakefile

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

data/dbi-dbrc.gemspec

@@ -0,0 +1,41 @@
+require 'rubygems'
+
+spec = Gem::Specification.new do |s|
+   s.name       = 'dbi-dbrc'
+   s.version    = '1.1.6'
+   s.author     = 'Daniel Berger'
+   s.email      = 'djberg96@gmail.com'
+   s.license    = 'Artistic 2.0'
+   s.summary    = 'A simple way to avoid hard-coding passwords with DBI'
+   s.homepage   = 'http://www.rubyforge.org/projects/shards'
+   s.platform   = Gem::Platform::RUBY
+   s.files      = Dir['**/*'].reject{ |f| f.include?('CVS') }
+   s.test_files = Dir['test/test*.rb']
+   s.has_rdoc   = true
+
+   s.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
+   s.rubyforge_project = 'shards'
+
+   s.add_dependency('sys-admin', '>= 1.5.2')
+   s.add_development_dependency('test-unit')
+
+   if Config::CONFIG['host_os'] =~ /mswin|win32|dos/i
+      s.add_dependency('win32-file', '>= 0.4.2')
+      s.add_dependency('win32-dir', '>= 0.3.0')
+      s.add_dependency('win32-process', '>= 0.6.1')
+      s.platform = Gem::Platform::CURRENT
+   end
+
+   s.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
+
+Gem::Builder.new(spec).build

data/lib/dbi/dbrc.rb

@@ -1,8 +1,9 @@
 require 'rbconfig'
 
-if Config::CONFIG['host_os'].match('mswin')
+if Config::CONFIG['host_os'] =~ /mswin|win32|dos/i
    require 'win32/file'
    require 'win32/dir'
+   require 'win32/process'
 end
 
 require 'sys/admin'
@@ -14,11 +15,12 @@ module DBI
    class DBRC
 
       # This error is raised if anything fails trying to read the config file.
-      # the error that is raised. 
       class Error < StandardError; end
 
-      # The version of this library
-      VERSION = '1.1.3'
+      # The version of the dbi-dbrc library
+      VERSION = '1.1.6'
+
+      @@windows = Config::CONFIG['host_os'] =~ /mswin|win32|dos/i
 
       # The database or host to be connected to.
       attr_accessor :database
@@ -86,24 +88,26 @@ module DBI
       #
       def initialize(database, user=nil, dbrc_dir=nil)
          if dbrc_dir.nil?
-            if Config::CONFIG['host_os'].match('mswin')
-               home = ENV['USERPROFILE'] || ENV['HOME']
-               file = nil
-               
-               if home
-                  file = File.join(home, '.dbrc')
+            uid  = Process.uid
+            home = ENV['HOME'] || ENV['USERPROFILE']
+
+            if home.nil?
+               if @@windows
+                  home ||= Sys::Admin.get_user(uid, :localaccount => true).dir
                else
-                  file = File.join(File.basename(Dir::APPDATA), '.dbrc')
+                  home ||= Sys::Admin.get_user(uid).dir
                end
-               
-               @dbrc_file = file
+            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
-               @dbrc_file = File.join(
-                  Sys::Admin.get_user(Process.uid).dir,
-                  '.dbrc'
-               )
+               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
          
@@ -120,7 +124,7 @@ module DBI
          check_file()
          
          # If on Win32 and the file is encrypted, decrypt it.
-         if Config::CONFIG['host_os'].match("mswin") && File.encrypted?(@dbrc_file)
+         if @@windows && File.encrypted?(@dbrc_file)
             encrypted = true
             File.decrypt(@dbrc_file)
          end
@@ -131,11 +135,26 @@ module DBI
          create_dsn_string()
          
          # If on Win32 and the file was encrypted, re-encrypt it
-         if Config::CONFIG['host_os'].match("mswin") && encrypted
+         if @@windows && encrypted
             File.encrypt(@dbrc_file)
          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
@@ -167,7 +186,7 @@ module DBI
 
             # Permissions must be set to 600 or better on Unix systems.
             # Must be hidden on Win32 systems.
-            if Config::CONFIG['host_os'].match("mswin")
+            if @@windows
                unless File.hidden?(file)
                   raise Error, "The .dbrc file must be hidden"
                end

data/test/{tc_dbrc.rb → test_dbi_dbrc.rb}

@@ -1,27 +1,32 @@
 #########################################################################
-# tc_dbrc.rb
+# 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_DBRC < Test::Unit::TestCase
-   def setup
-      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
+class TC_DBI_DBRC < Test::Unit::TestCase
+   def self.startup
+      @@windows = File::ALT_SEPARATOR
+   end
 
-      @dir      = "../examples/plain"
+   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
+      @db1      = 'foo'
+      @db2      = 'bar'
+      @user1    = 'user1'
+      @user2    = 'user2'
+      @db_bad   = 'blah'  # Doesn't exist
+      @user_bad = 'user8' # Doesn't exist
      
-      if File::ALT_SEPARATOR
+      if @@windows && File.respond_to?(:set_attr)
          File.set_attr(@file, File::HIDDEN)
       else
          File.chmod(0600, @file)
@@ -31,11 +36,11 @@ class TC_DBRC < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal("1.1.3", DBRC::VERSION)
+      assert_equal('1.1.6', DBRC::VERSION)
    end
 
    def test_bad_dbrc_properties
-      if File::ALT_SEPARATOR
+      if @@windows
          File.unset_attr(@file, File::HIDDEN)
          assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
       else
@@ -51,11 +56,15 @@ class TC_DBRC < Test::Unit::TestCase
    end
 
    def test_bad_database
-      assert_raises(DBRC::Error){ DBRC.new(@db_bad, nil, @dir) }
+      assert_raise(DBRC::Error){ DBRC.new(@db_bad, nil, @dir) }
    end
 
    def test_bad_user
-      assert_raises(DBRC::Error){ DBRC.new(@db1, @user_bad, @dir) }
+      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
@@ -184,10 +193,9 @@ class TC_DBRC < Test::Unit::TestCase
       @db_bad   = nil
       @user_bad = nil
       @dbrc     = nil
-      if File::ALT_SEPARATOR
-         File.set_attr(@file, File::HIDDEN)
-      else
-         File.chmod(0600, @file)
-      end
+   end
+
+   def self.shutdown
+      @@windows = nil
    end
 end

data/test/{tc_dbrc_xml.rb → test_dbi_dbrc_xml.rb}

@@ -1,20 +1,22 @@
 ########################################################################
-# tc_dbrc_xml.rb
+# test_dbi_dbrc_xml.rb
 #
 # Test suite for the XML specific version of DBI::DBRC. This test case
 # should be run via the 'rake test' task.
 ########################################################################
-require "dbi/dbrc"
-require "test/unit"
-require "rexml/document"
+require 'rubygems'
+gem 'test-unit'
+
+require 'dbi/dbrc'
+require 'test/unit'
+require 'rexml/document'
 include REXML
 include DBI
 
-class TC_DBRC_XML < Test::Unit::TestCase
+class TC_DBI_DBRC_XML < Test::Unit::TestCase
    def setup
-      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
-      @dir      = "../examples/xml"
-      @file     = File.join(@dir, ".dbrc")
+      @dir      = File.join(Dir.pwd, 'examples/xml')
+      @file     = File.join(@dir, '.dbrc')
       @db1      = "foo"
       @db2      = "bar"
       @user1    = "user1"
@@ -22,7 +24,7 @@ class TC_DBRC_XML < Test::Unit::TestCase
       @db_bad   = "blah"  # Doesn't exist
       @user_bad = "user8" # Doesn't exist
 
-      if File::ALT_SEPARATOR
+      if File::ALT_SEPARATOR && File.respond_to?(:set_attr)
          File.set_attr(@file, File::HIDDEN)
       else
          File.chmod(0600, @file)

data/test/{tc_dbrc_yml.rb → test_dbi_dbrc_yml.rb}

@@ -1,18 +1,19 @@
 #########################################################################
-# tc_dbrc_yml.rb
+# test_dbi_dbrc_yml.rb
 #
 # Test suite for the YAML specific version of DBI::DBRC. You should run
 # this test case via the 'rake test' task.
 #########################################################################
-require "dbi/dbrc"
-require "test/unit"
+require 'rubygems'
+gem 'test-unit'
+
+require 'dbi/dbrc'
+require 'test/unit'
 include DBI
 
-class TC_DBRC_YML < Test::Unit::TestCase
+class TC_DBI_DBRC_YML < Test::Unit::TestCase
    def setup
-      Dir.chdir('test') if File.basename(Dir.pwd) != 'test'
-      
-      @dir      = "../examples/yml"
+      @dir      = File.join(Dir.pwd, 'examples/yml')
       @file     = File.join(@dir, '.dbrc')
       @db1      = "foo"
       @db2      = "bar"
@@ -21,7 +22,7 @@ class TC_DBRC_YML < Test::Unit::TestCase
       @db_bad   = "blah"  # Doesn't exist
       @user_bad = "user8" # Doesn't exist
 
-      if File::ALT_SEPARATOR
+      if File::ALT_SEPARATOR && File.respond_to?(:set_attr)
          File.set_attr(@file, File::HIDDEN)
       else
          File.chmod(0600, @file)
@@ -155,11 +156,5 @@ class TC_DBRC_YML < Test::Unit::TestCase
       @db_bad   = nil
       @user_bad = nil
       @dbrc     = nil
-
-      if File::ALT_SEPARATOR
-         File.set_attr(@file, File::HIDDEN)
-      else
-         File.chmod(0600, @file)
-      end
    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dbi-dbrc
 version: !ruby/object:Gem::Version 
-  version: 1.1.3
+  version: 1.1.6
 platform: x86-mswin32-60
 authors: 
 - Daniel Berger
@@ -9,13 +9,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-21 00:00:00 -06:00
+date: 2009-09-10 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sys-admin
   type: :runtime
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :development
+  version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
@@ -42,7 +52,17 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.3.0
     version: 
-description: A simple way to avoid hard-coding passwords with DBI
+- !ruby/object:Gem::Dependency 
+  name: win32-process
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+    version: 
+description: "      The dbi-dbrc library provides an interface for storing database\n      connection information, including passwords, in a locally secure\n      file only accessible by you, or root. This allows you to avoid\n      hard coding login and password information in your programs\n      that require such information.\n\n      This library can also be used to store login and password information\n      for logins on remote hosts, not just databases.\n"
 email: djberg96@gmail.com
 executables: []
 
@@ -53,23 +73,22 @@ extra_rdoc_files:
 - CHANGES
 - MANIFEST
 files: 
-- examples/plain
+- CHANGES
+- dbi-dbrc.gemspec
 - examples/plain/test.rb
-- examples/xml
 - examples/xml/test_xml.rb
-- examples/yml
 - examples/yml/test_yml.rb
-- lib/dbi
 - lib/dbi/dbrc.rb
-- test/tc_dbrc.rb
-- test/tc_dbrc_xml.rb
-- test/tc_dbrc_yml.rb
-- test/ts_all.rb
-- README
-- CHANGES
 - MANIFEST
+- Rakefile
+- README
+- test/test_dbi_dbrc.rb
+- test/test_dbi_dbrc_xml.rb
+- test/test_dbi_dbrc_yml.rb
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/shards
+licenses: 
+- Artistic 2.0
 post_install_message: 
 rdoc_options: []
 
@@ -90,9 +109,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: shards
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A simple way to avoid hard-coding passwords with DBI
 test_files: 
-- test/ts_all.rb
+- test/test_dbi_dbrc.rb
+- test/test_dbi_dbrc_xml.rb
+- test/test_dbi_dbrc_yml.rb

data/test/ts_all.rb

@@ -1,6 +0,0 @@
-$LOAD_PATH.unshift(Dir.pwd)
-$LOAD_PATH.unshift(Dir.pwd + "/test")
-
-require "tc_dbrc"
-require "tc_dbrc_yml"
-require "tc_dbrc_xml"