dbi-dbrc 1.1.9 → 1.5.0

data/Rakefile

@@ -1,45 +1,26 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-CLEAN.include("**/*.gem", "**/*.rbc")
+CLEAN.include("**/*.gem", "**/*.rbc", "**/*.lock")
 
 namespace :gem do
-  desc "Remove any gem files."
-  task :clean do
-    Dir['*.gem'].each{ |f| File.delete(f) }
-  end
-
   desc "Create the dbi-dbrc gem"
   task :create => [:clean] do
+    require 'rubygems/package'
     spec = eval(IO.read('dbi-dbrc.gemspec'))
-    Gem::Builder.new(spec).build
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec, true)
   end
 
   desc "Install the dbi-dbrc gem"
   task :install => [:create] do
     gem = Dir["*.gem"].first
-    sh "gem install #{gem}"
+    sh "gem install -l #{gem}"
   end
 end
 
-namespace :test do
-  Rake::TestTask.new(:all) do |t|
-    t.warning = true
-    t.verbose = true
-  end
-
-  Rake::TestTask.new(:xml) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_dbi_dbrc_xml.rb']
-  end
-
-  Rake::TestTask.new(:yml) do |t|
-    t.warning = true
-    t.verbose = true
-    t.test_files = FileList['test/test_dbi_dbrc_yml.rb']
-  end
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => 'test:all'
+task :default => :spec

data/certs/djberg96_pub.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+-----END CERTIFICATE-----

data/dbi-dbrc.gemspec

@@ -2,25 +2,34 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'dbi-dbrc'
-  spec.version    = '1.1.9'
+  spec.version    = '1.5.0'
   spec.author     = 'Daniel Berger'
   spec.email      = 'djberg96@gmail.com'
-  spec.license    = 'Artistic 2.0'
+  spec.license    = 'Apache-2.0'
   spec.summary    = 'A simple way to avoid hard-coding passwords with DBI'
   spec.homepage   = 'https://github.com/djberg96/dbi-dbrc'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.test_files = Dir['test/test*.rb']
+  spec.cert_chain = Dir['certs/*']
 
-  spec.extra_rdoc_files  = ['README', 'CHANGES', 'MANIFEST']
-  spec.rubyforge_project = 'shards'
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('fakefs', '~> 1.3')
 
-  spec.add_dependency('sys-admin', '>= 1.5.2')
-  spec.add_development_dependency('test-unit')
+  spec.metadata = {
+    'homepage_uri'      => 'https://github.com/djberg96/dbi-dbrc',
+    'bug_tracker_uri'   => 'https://github.com/djberg96/dbi-dbrc/issues',
+    'changelog_uri'     => 'https://github.com/djberg96/dbi-dbrc/blob/main/CHANGES',
+    'documentation_uri' => 'https://github.com/djberg96/dbi-dbrc/wiki',
+    'source_code_uri'   => 'https://github.com/djberg96/dbi-dbrc',
+    'wiki_uri'          => 'https://github.com/djberg96/dbi-dbrc/wiki'
+  }
 
   if File::ALT_SEPARATOR
-    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.add_dependency('sys-admin')
+    spec.add_dependency('win32-file-attributes')
+    spec.add_dependency('win32-dir')
+    spec.add_dependency('win32-process')
     spec.platform = Gem::Platform::CURRENT
     spec.platform.cpu = 'universal'
   end

data/examples/yml/test_yml.rb

@@ -1,12 +1,12 @@
 #######################################################################
-# test_xml.rb
+# test_yml.rb
 #
-# Simple test script that uses the DBRC::XML subclass.
+# Simple test script that uses the DBRC::YML subclass.
 #######################################################################
 if File.basename(Dir.pwd) == "yml"
-   Dir.chdir "../.."
-   $LOAD_PATH.unshift Dir.pwd + "/lib"
-   Dir.chdir "examples/yml"
+  Dir.chdir "../.."
+  $LOAD_PATH.unshift Dir.pwd + "/lib"
+  Dir.chdir "examples/yml"
 end
 
 require "dbi/dbrc"

data/lib/dbi-dbrc.rb

@@ -0,0 +1 @@
+require_relative 'dbi/dbrc'

data/lib/dbi/dbrc.rb

@@ -1,10 +1,12 @@
 if File::ALT_SEPARATOR
   require 'win32/dir'
-  require 'win32/file'
+  require 'win32/file/attributes'
   require 'win32/process'
+  require 'sys/admin'
+else
+  require 'etc'
 end
 
-require 'sys/admin'
 
 # The DBI module serves as a namespace only.
 module DBI
@@ -16,19 +18,27 @@ module DBI
     class Error < StandardError; end
 
     # The version of the dbi-dbrc library
-    VERSION = '1.1.9'
+    VERSION = '1.5.0'.freeze
 
-    @@windows = File::ALT_SEPARATOR
+    WINDOWS = File::ALT_SEPARATOR # :no-doc:
 
     # The database or host to be connected to.
     attr_accessor :database
 
+    alias :db :database
+    alias :db= :database=
+    alias :host :database
+    alias :host= :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
 
+    alias :passwd :password
+    alias :passwd= :password=
+
     # The driver associated with the database. This is used to internally to
     # construct the DSN.
     attr_accessor :driver
@@ -39,9 +49,15 @@ module DBI
     # The maximum number of reconnects a program should make before giving up.
     attr_accessor :maximum_reconnects
 
+    alias :max_reconn :maximum_reconnects
+    alias :max_reconn= :maximum_reconnects=
+
     # The timeout, in seconds, for each connection attempt.
     attr_accessor :timeout
 
+    alias :time_out :timeout
+    alias :time_out= :timeout=
+
     # The interval, in seconds, between each connection attempt.
     attr_accessor :interval
 
@@ -85,21 +101,16 @@ module DBI
     #
     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
+        if WINDOWS
+          home = Sys::Admin.get_user(Process.uid, :localaccount => true).dir
+        else
+          home = Dir.home(Etc.getpwuid.name)
         end
 
         # Default to the app data directory on Windows, or root on Unix, if
         # no home dir can be found.
         if home.nil?
-          if @@windows
+          if WINDOWS
             home = Dir::APPDATA
           else
             home = '/'
@@ -107,6 +118,7 @@ module DBI
         end
 
         @dbrc_file = File.join(home, '.dbrc')
+        dbrc_dir = home
       else
         raise Error, 'bad directory' unless File.directory?(dbrc_dir)
         @dbrc_file = File.join(dbrc_dir, '.dbrc')
@@ -128,7 +140,7 @@ module DBI
       # Decrypt and re-encrypt the file if we're on MS Windows and the
       # file is encrypted.
       begin
-        if @@windows && File.encrypted?(@dbrc_file)
+        if WINDOWS && File.encrypted?(@dbrc_file)
           file_was_encrypted = true
           File.decrypt(@dbrc_file)
         end
@@ -138,7 +150,7 @@ module DBI
         convert_numeric_strings()
         create_dsn_string()
       ensure
-        if @@windows && file_was_encrypted
+        if WINDOWS && file_was_encrypted
           File.encrypt(@dbrc_file)
         end
       end
@@ -189,7 +201,7 @@ module DBI
       File.open(file){ |f|
         # Permissions must be set to 600 or better on Unix systems.
         # Must be hidden on Win32 systems.
-        if @@windows
+        if WINDOWS
           unless File.hidden?(file)
             raise Error, "The .dbrc file must be hidden"
           end
@@ -209,50 +221,41 @@ module DBI
     # 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
+      File.foreach(file){ |line|
+        next if line =~ /^#/    # Ignore comments
+        db, user, pwd, driver, timeout, max, interval = line.split
 
-          next unless @database == db
+        next unless @database == db
 
-          if @user
-             next unless @user == user
-          end
+        if @user
+          next unless @user == user
+        end
 
-          @user               = user
-          @password           = pwd
-          @driver             = driver
-          @timeout            = timeout
-          @maximum_reconnects = max
-          @interval           = interval
-          return
-       }
+        @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
+      # 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
+      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"
+  class DBRC::XML < DBRC
+    require 'rexml/document' # Good enough for small files
     include REXML
 
     private
@@ -280,8 +283,8 @@ module DBI
 
   # 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"
+  class DBRC::YML < DBRC
+    require 'yaml'
 
     private
 
@@ -296,7 +299,7 @@ module DBI
           @driver     = info["driver"]
           @interval   = info["interval"]
           @timeout    = info["timeout"]
-          @maximum_reconnects = info["max_reconn"]
+          @maximum_reconnects = info["maximum_reconnects"]
           return
         }
       }

data/spec/dbi_dbrc_spec.rb

@@ -0,0 +1,236 @@
+#########################################################################
+# dbi_dbrc_spec.rb
+#
+# Specs for the base class of DBI::DBRC. This test case should be
+# run via the 'rake spec' task.
+#########################################################################
+require 'dbi/dbrc'
+require 'fileutils'
+require 'spec_helper'
+require 'pp' # Requiring this ahead of fakefs to address a superclass issue.
+require 'fakefs/spec_helpers'
+
+RSpec.describe DBI::DBRC do
+  include FakeFS::SpecHelpers
+
+  let(:windows) { File::ALT_SEPARATOR }
+  let(:home) { File.join(Dir.pwd, 'home', 'someone') }
+  let(:dbrc) { File.join(home, '.dbrc') }
+
+  let(:plain) {
+    %q{
+      foo      user1    pwd1     Oracle   40       3     60
+      foo      user2    pwd2     OCI8     60       4     60
+      bar      user1    pwd3     Oracle   30       2     30
+      baz      user3    pwd4
+    }.lstrip
+  }
+
+  let(:db_foo){ 'foo' }
+  let(:db_bar){ 'bar' }
+  let(:db_baz){ 'baz' }
+  let(:user1) { 'user1' }
+  let(:user2) { 'user2' }
+
+  before do
+    allow(Dir).to receive(:home).and_return(home)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(plain) }
+    File.chmod(0600, dbrc)
+
+    # FakeFS doesn't implement this yet
+    allow_any_instance_of(FakeFS::File::Stat).to receive(:owned?).and_return(true)
+  end
+
+  example "version" do
+    expect(described_class::VERSION).to eq('1.5.0')
+    expect(described_class::VERSION).to be_frozen
+  end
+
+  context "windows", :windows => true do
+    example "constructor raises an error unless the .dbrc file is hidden" do
+      File.unset_attr(plain, File::HIDDEN)
+      expect{ described_class.new(db_foo, user1) }.to raise_error(described_class::Error)
+    end
+  end
+
+  context "constructor" do
+    example "constructor raises an error if the permissions are invalid" do
+      File.chmod(0555, dbrc)
+      expect{ described_class.new(db_foo, user1) }.to raise_error(described_class::Error)
+    end
+
+    example "constructor raises an error if no database is provided" do
+      expect{ described_class.new }.to raise_error(ArgumentError)
+    end
+
+    example "constructor works as expected with or without user" do
+      expect{ described_class.new(db_foo, user1) }.not_to raise_error
+      expect{ described_class.new(db_foo, nil) }.not_to raise_error
+    end
+
+    example "constructor fails if the database entry doesn't exist" do
+      expect{ described_class.new('bogus', user1) }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor fails if the user entry doesn't exist" do
+      expect{ described_class.new(db_foo, 'nobody') }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor fails if the .dbrc file isn't found in the specified directory" do
+      expect{ described_class.new(db_foo, user1, '/bogusXX') }.to raise_error(DBI::DBRC::Error)
+    end
+
+    example "constructor returns expected values for the same database with different users" do
+      dbrc1 = described_class.new(db_foo, user1)
+      dbrc2 = described_class.new(db_foo, user2)
+      expect(dbrc1.database).to eq(dbrc2.database)
+      expect(dbrc1.user).to eq('user1')
+      expect(dbrc2.user).to eq('user2')
+    end
+
+    example "constructor returns expected values for the same user with different database" do
+      dbrc1 = described_class.new(db_foo, user1)
+      dbrc2 = described_class.new(db_bar, user1)
+      expect(dbrc1.user).to eq(dbrc2.user)
+      expect(dbrc1.database).to eq('foo')
+      expect(dbrc2.database).to eq('bar')
+    end
+
+    example "constructor works as expected if some optional fields are not defined" do
+      dbrc = described_class.new(db_baz)
+      expect(dbrc.user).to eq("user3")
+      expect(dbrc.passwd).to eq("pwd4")
+      expect(dbrc.driver).to be_nil
+      expect(dbrc.interval).to be_nil
+      expect(dbrc.timeout).to be_nil
+      expect(dbrc.max_reconn).to be_nil
+      expect(dbrc.dsn).to be_nil
+    end
+  end
+
+  context "instance methods" do
+    before do
+      @dbrc = DBI::DBRC.new(db_foo)
+    end
+
+    example "basic database getter method and aliases" do
+      expect(@dbrc).to respond_to(:database)
+      expect(@dbrc.method(:database)).to eq(@dbrc.method(:db))
+      expect(@dbrc.method(:database)).to eq(@dbrc.method(:host))
+    end
+
+    example "basic database setter method and alias" do
+      expect(@dbrc).to respond_to(:database=)
+      expect(@dbrc.method(:database=)).to eq(@dbrc.method(:db=))
+    end
+
+    example "database method returns expected value" do
+      expect(@dbrc.database).to eq('foo')
+    end
+
+    example "basic dbrc_dir check" do
+      expect(@dbrc).to respond_to(:dbrc_dir)
+    end
+
+    example "dbrc_dir returns the expected value" do
+      expect(@dbrc.dbrc_dir).to eq(home)
+    end
+
+    example "basic dbrc_file check" do
+      expect(@dbrc).to respond_to(:dbrc_file)
+    end
+
+    example "dbrc_file returns the expected value" do
+      expect(File.basename(@dbrc.dbrc_file)).to eq('.dbrc')
+    end
+
+    example "basic dsn getter check" do
+      expect(@dbrc).to respond_to(:dsn)
+    end
+
+    example "dsn method returns the expected value" do
+      expect(@dbrc.dsn).to eq('dbi:Oracle:foo')
+    end
+
+    example "basic dsn setter check" do
+      expect(@dbrc).to respond_to(:dsn=)
+    end
+
+    example "user getter basic check" do
+      expect(@dbrc).to respond_to(:user)
+    end
+
+    example "user method returns expected value" do
+      expect(@dbrc.user).to eq('user1')
+    end
+
+    example "user setter basic check" do
+      expect(@dbrc).to respond_to(:user=)
+    end
+
+    example "password getter basic check and alias" do
+      expect(@dbrc).to respond_to(:password)
+      expect(@dbrc.method(:password)).to eq(@dbrc.method(:passwd))
+    end
+
+    example "password method returns expected value" do
+      expect(@dbrc.password).to eq("pwd1")
+    end
+
+    example "password setter basic check and alias" do
+      expect(@dbrc).to respond_to(:password=)
+      expect(@dbrc.method(:password=)).to eq(@dbrc.method(:passwd=))
+    end
+
+    example "driver getter basic check" do
+      expect(@dbrc).to respond_to(:driver)
+    end
+
+    example "driver method returns expected value" do
+      expect(@dbrc.driver).to eq("Oracle")
+    end
+
+    example "driver setter basic check" do
+      expect(@dbrc).to respond_to(:driver=)
+    end
+
+    example "interval getter basic check" do
+      expect(@dbrc).to respond_to(:interval)
+    end
+
+    example "interval method returns expected value" do
+      expect(@dbrc.interval).to eq(60)
+    end
+
+    example "interval setter basic check" do
+      expect(@dbrc).to respond_to(:interval=)
+    end
+
+    example "timeout getter basic check" do
+      expect(@dbrc).to respond_to(:timeout)
+      expect(@dbrc.method(:timeout)).to eq(@dbrc.method(:time_out))
+    end
+
+    example "timeout method returns expected value" do
+      expect(@dbrc.timeout).to eq(40)
+    end
+
+    example "timeout setter basic check" do
+      expect(@dbrc).to respond_to(:timeout=)
+    end
+
+    example "max_reconn getter basic check" do
+      expect(@dbrc).to respond_to(:max_reconn)
+      expect(@dbrc.method(:max_reconn)).to eq(@dbrc.method(:maximum_reconnects))
+    end
+
+    example "max_reconn method returns expected value" do
+      expect(@dbrc.max_reconn).to eq(3)
+    end
+
+    example "max_reconn setter basic check" do
+      expect(@dbrc).to respond_to(:max_reconn=)
+    end
+  end
+end