dbi-dbrc 1.2.0 → 1.6.0

data/Rakefile

@@ -1,24 +1,16 @@
 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
-    spec = eval(IO.read('dbi-dbrc.gemspec'))
-    if Gem::VERSION < "2.0"
-      Gem::Builder.new(spec).build
-    else
-      require 'rubygems/package'
-      Gem::Package.build(spec)
-    end
+    require 'rubygems/package'
+    spec = Gem::Specification.load('dbi-dbrc.gemspec')
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
   end
 
   desc "Install the dbi-dbrc gem"
@@ -28,23 +20,7 @@ namespace :gem do
   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,21 +2,33 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'dbi-dbrc'
-  spec.version    = '1.2.0'
+  spec.version    = '1.6.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.add_dependency('gpgme', '~> 2.0')
 
-  spec.add_dependency('sys-admin')
-  spec.add_development_dependency('test-unit')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec', '~> 3.9')
+  spec.add_development_dependency('fakefs', '~> 1.3')
+
+  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.md',
+    '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('sys-admin')
     spec.add_dependency('win32-file-attributes')
     spec.add_dependency('win32-dir')
     spec.add_dependency('win32-process')

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,3 @@
+# frozen_string_literal: true
+
+require_relative 'dbi/dbrc'

data/lib/dbi/dbrc.rb

@@ -1,34 +1,43 @@
+# frozen_string_literal: true
+
 if File::ALT_SEPARATOR
   require 'win32/dir'
   require 'win32/file/attributes'
   require 'win32/process'
+else
+  require 'etc'
+  require 'gpgme'
 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.2.0'
+    VERSION = '1.6.0'
 
-    @@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 +48,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
 
@@ -62,7 +77,7 @@ module DBI
     # 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
+    # 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.
     #
@@ -72,6 +87,9 @@ module DBI
     # storage mechanism. In that case simply treat the 'database' as the
     # host name, and ignore the DBI::DBRC#dsn and DBI::DBRC#driver methods.
     #
+    # On unixy systems you can GPG encrypt the file, and this library will
+    # decrypt it for you based on the +gpg_options+ that you pass.
+    #
     # Examples:
     #
     #   # Find the first match for 'some_database'
@@ -83,23 +101,15 @@ module DBI
     #   # 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)
+    #   # Pass along a GPG password to decrypt the file.
+    #   DBI::DBRC.new('some_database', 'foo_usr', '/usr/local', :gpg_options => {:password => 'xxx'})
+    #
+  def initialize(database, user = nil, dbrc_dir = Dir.home, gpg_options = 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, 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 +117,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,19 +139,26 @@ 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
 
-        parse_dbrc_config_file()
-        validate_data()
-        convert_numeric_strings()
-        create_dsn_string()
-      ensure
-        if @@windows && file_was_encrypted
-          File.encrypt(@dbrc_file)
+        if gpg_options
+          require 'gpgme'
+          require 'stringio'
+          crypto = GPGME::Crypto.new(gpg_options)
+          stringio = crypto.decrypt(File.open(@dbrc_file))
+          parse_dbrc_config_file(StringIO.new(stringio.read))
+        else
+          parse_dbrc_config_file
         end
+
+        validate_data
+        convert_numeric_strings
+        create_dsn_string
+      ensure
+        File.encrypt(@dbrc_file) if WINDOWS && file_was_encrypted
       end
     end
 
@@ -148,28 +166,23 @@ module DBI
     # Ruby Object#inspect, except that the password field is filtered.
     #
     def inspect
-      str = instance_variables.map{ |iv|
+      str = instance_variables.map do |iv|
         if iv == '@password'
           "#{iv}=[FILTERED]"
         else
           "#{iv}=#{instance_variable_get(iv).inspect}"
         end
-      }.join(', ')
+      end.join(', ')
 
-      "#<#{self.class}:0x#{(self.object_id*2).to_s(16)} " << str << ">"
+      "#<#{self.class}:0x#{(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
+      raise Error, "no user found associated with #{@database}" unless @user
+      raise Error, "password not defined for #{@user}@#{@database}" unless @password
     end
 
     # Converts strings that should be numbers into actual numbers
@@ -185,39 +198,33 @@ module DBI
     end
 
     # Check ownership and permissions
-    def check_file(file=@dbrc_file)
-      File.open(file){ |f|
+    def check_file(file = @dbrc_file)
+      File.open(file) do |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
+        if WINDOWS
+          raise Error, 'The .dbrc file must be hidden' unless File.hidden?(file)
         else
-          unless (f.stat.mode & 077) == 0
-            raise Error, "Bad .dbrc file permissions"
-          end
+          raise Error, 'Bad .dbrc file permissions' unless (f.stat.mode & 0o77) == 0
         end
 
         # Only the owner may use it
-        unless f.stat.owned?
-          raise Error, "Not owner of .dbrc file"
-        end
-      }
+        raise Error, 'Not owner of .dbrc file' unless f.stat.owned?
+      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
+    def parse_dbrc_config_file(file = @dbrc_file)
+      begin
+        fh = file.is_a?(StringIO) ? file : File.open(file)
+
+        fh.each_line do |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
+          next if @user && @user != user
 
           @user               = user
           @password           = pwd
@@ -225,83 +232,75 @@ module DBI
           @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
+          break
+        end
+      ensure
+        fh.close if fh && fh.respond_to?(:close)
+      end
 
-       raise Error, err
+      if @user
+        raise Error, "no record found for #{@user}@#{@database}" unless @user
+      else
+        raise Error, "no record found for #{@database}" unless @database
+      end
     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
+  class DBRC::XML < DBRC
+    require 'rexml/document' # Good enough for small files
 
     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|
+    def parse_dbrc_config_file(file = @dbrc_file)
+      file = file.is_a?(StringIO) ? file : File.new(file)
+      doc = REXML::Document.new(file)
+
+      fields = %w[user password driver interval timeout maximum_reconnects]
+
+      doc.elements.each('/dbrc/database') do |element|
+        next unless element.attributes['name'] == database
+        next if @user && @user != element.elements['user'].text
+
+        fields.each do |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}"
+          send("#{field}=", val.text) unless val.nil?
+        end
+
+        break
+      end
+
+      raise Error, "No record found for #{@user}@#{@database}" unless @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"
+  class DBRC::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|
+    def parse_dbrc_config_file(file = @dbrc_file)
+      fh = file.is_a?(StringIO) ? file : File.open(file)
+      config = YAML.safe_load(fh)
+
+      config.each do |hash|
+        hash.each do |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}"
+          next if @user && @user != info['user']
+          @user = info['user']
+          @password = info['password']
+          @driver = info['driver']
+          @interval = info['interval']
+          @timeout = info['timeout']
+          @maximum_reconnects = info['maximum_reconnects']
+          break
+        end
+      end
+
+      raise Error, "No entry found for #{@user}@#{@database}" unless @user && @database
     end
   end
 end