dbi-dbrc 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ff5de96e8773faa52022e20fff1d008c360faa548ff65b9aac4a82b2a7e34b5
-  data.tar.gz: dc7c04ad5ee358f59fca1a1c6331907a62e94177cdcc0cc2912eef9e204817c1
+  metadata.gz: 4f38085a9c7abb4c8a3e53fb239196135d317f78baa14a33f415fbaeab0b03d6
+  data.tar.gz: a591ba6877a994765c4ad4dc5eb540b149c98398fe11bfd93ff04be1dca4e562
 SHA512:
-  metadata.gz: f5ca232636482744e5049a744b629f0fd7b956c511e3024d166ff633c68f3ca16fb089c2d5b126da676d09cc4cdf7ac11bc2b57a46c8b4f01846e4d982c6d9ab
-  data.tar.gz: 9296fac30f6fc8a811e5e8cc1468a97d6da9ccb9a8155caecd1e61dc177f1599087191412cdfc294403cb73d6300c0d72e46ed9ba7ecaab15e22bc8c36f65371
+  metadata.gz: 607d4e9c54ceb5c98cfaa7dc1df75708b151daac57cca77bb244371d43a1950107334081cb65ea112ba46da85aa9b015700ad23df863a09f7cbd628b0627d069
+  data.tar.gz: 3712726dcf66e0f4dc19c4dbe46115e1dc9ea5159a59a4e9e31bf250e643dd07f114a6b4b27585a31c7a4c34016bba22c3999592b831feaea3aeeacddb9a57f4

data/CHANGES.md

@@ -1,3 +1,11 @@
+## 1.6.0 - 9-Jun-2021
+* Now supports gpg encrypted files, with a 4th optional parameter where you
+  can pass gpg options (usually a password, but whatever gpgme supports).
+* Added gpgme as a dependency.
+* Updated specs for MS Windows.
+* The "home" handling is now a bit simpler, as it was originally written
+  before that method existed in core Ruby.
+
 ## 1.5.0 - 12-Apr-2021
 * Switched from test-unit to rspec, with corresponding changes in the
   gemspec and Rakefile.

data/Rakefile

@@ -8,9 +8,9 @@ namespace :gem do
   desc "Create the dbi-dbrc gem"
   task :create => [:clean] do
     require 'rubygems/package'
-    spec = eval(IO.read('dbi-dbrc.gemspec'))
+    spec = Gem::Specification.load('dbi-dbrc.gemspec')
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the dbi-dbrc gem"

data/dbi-dbrc.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'dbi-dbrc'
-  spec.version    = '1.5.0'
+  spec.version    = '1.6.0'
   spec.author     = 'Daniel Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -12,6 +12,8 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['test/test*.rb']
   spec.cert_chain = Dir['certs/*']
 
+  spec.add_dependency('gpgme', '~> 2.0')
+
   spec.add_development_dependency('rake')
   spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('fakefs', '~> 1.3')
@@ -19,7 +21,7 @@ Gem::Specification.new do |spec|
   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',
+    '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'

data/lib/dbi-dbrc.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'dbi/dbrc'

data/lib/dbi/dbrc.rb

@@ -1,34 +1,33 @@
+# frozen_string_literal: true
+
 if File::ALT_SEPARATOR
   require 'win32/dir'
   require 'win32/file/attributes'
   require 'win32/process'
-  require 'sys/admin'
 else
   require 'etc'
+  require 'gpgme'
 end
 
-
 # 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.5.0'.freeze
+    VERSION = '1.6.0'
 
     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=
+    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
@@ -36,8 +35,8 @@ module DBI
     # The password associated with the database or host.
     attr_accessor :password
 
-    alias :passwd :password
-    alias :passwd= :password=
+    alias passwd password
+    alias passwd= password=
 
     # The driver associated with the database. This is used to internally to
     # construct the DSN.
@@ -49,14 +48,14 @@ 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=
+    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=
+    alias time_out timeout
+    alias time_out= timeout=
 
     # The interval, in seconds, between each connection attempt.
     attr_accessor :interval
@@ -78,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.
     #
@@ -88,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'
@@ -99,14 +101,11 @@ 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?
-        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?
@@ -145,14 +144,21 @@ module DBI
           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
 
@@ -160,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
@@ -197,87 +198,80 @@ 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
+          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)
-      File.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
+    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
+          next if @user && @user != user
+
+          @user               = user
+          @password           = pwd
+          @driver             = driver
+          @timeout            = timeout
+          @maximum_reconnects = max
+          @interval           = interval
+          break
         end
+      ensure
+        fh.close if fh && fh.respond_to?(:close)
+      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}"
+        raise Error, "no record found for #{@user}@#{@database}" unless @user
       else
-        err = "no record found for #{@database}"
+        raise Error, "no record found for #{@database}" unless @database
       end
-
-      raise Error, err
     end
-
   end
 
   # A subclass of DBRC designed to handle .dbrc files in XML format.  The
   # public methods of this class are identical to DBRC.
   class DBRC::XML < DBRC
     require 'rexml/document' # Good enough for small files
-    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|
+    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
 
@@ -288,23 +282,25 @@ module DBI
 
     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["maximum_reconnects"]
-          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

data/spec/dbi_dbrc_spec.rb

@@ -43,19 +43,26 @@ RSpec.describe DBI::DBRC do
   end
 
   example "version" do
-    expect(described_class::VERSION).to eq('1.5.0')
+    expect(described_class::VERSION).to eq('1.6.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)
+      allow(FakeFS::File).to receive(:hidden?).and_return(false)
       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
+    before do
+      if File::ALT_SEPARATOR
+        allow(FakeFS::File).to receive(:hidden?).and_return(true)
+        allow(FakeFS::File).to receive(:encrypted?).and_return(false)
+      end
+    end
+
+    example "constructor raises an error if the permissions are invalid", :unix => true do
       File.chmod(0555, dbrc)
       expect{ described_class.new(db_foo, user1) }.to raise_error(described_class::Error)
     end
@@ -111,6 +118,10 @@ RSpec.describe DBI::DBRC do
 
   context "instance methods" do
     before do
+      if File::ALT_SEPARATOR
+        allow(FakeFS::File).to receive(:hidden?).and_return(true)
+        allow(FakeFS::File).to receive(:encrypted?).and_return(false)
+      end
       @dbrc = DBI::DBRC.new(db_foo)
     end
 

data/spec/dbi_dbrc_xml_spec.rb

@@ -55,6 +55,12 @@ RSpec.describe DBI::DBRC::XML, :xml => true do
 
   before do
     allow(Dir).to receive(:home).and_return(home)
+
+    if File::ALT_SEPARATOR
+      allow(FakeFS::File).to receive(:hidden?).and_return(true)
+      allow(FakeFS::File).to receive(:encrypted?).and_return(false)
+    end
+
     FileUtils.mkdir_p(home)
     File.open(dbrc, 'w'){ |fh| fh.write(xml) }
     File.chmod(0600, dbrc)

data/spec/dbi_dbrc_yml_spec.rb

@@ -49,6 +49,12 @@ RSpec.describe DBI::DBRC::YML, :yml => true do
 
   before do
     allow(Dir).to receive(:home).and_return(home)
+
+    if File::ALT_SEPARATOR
+      allow(FakeFS::File).to receive(:hidden?).and_return(true)
+      allow(FakeFS::File).to receive(:encrypted?).and_return(false)
+    end
+
     FileUtils.mkdir_p(home)
     File.open(dbrc, 'w'){ |fh| fh.write(yml) }
     File.chmod(0600, dbrc)

data/spec/spec_helper.rb

@@ -2,4 +2,5 @@ require 'rspec'
 
 RSpec.configure do |config|
   config.filter_run_excluding(:windows) if RbConfig::CONFIG['host_os'] !~ /mswin|win32|dos|mingw|cygwin/i
+  config.filter_run_excluding(:unix) if RbConfig::CONFIG['host_os'] =~ /mswin|win32|dos|mingw|cygwin/i
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbi-dbrc
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,8 +35,22 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date:
+date: 2021-06-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -93,37 +107,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- dbi-dbrc.gemspec
-- spec
-- spec/spec_helper.rb
-- spec/dbi_dbrc_yml_spec.rb
-- spec/dbi_dbrc_spec.rb
-- spec/dbi_dbrc_xml_spec.rb
+- CHANGES.md
+- Gemfile
+- MANIFEST.md
 - README.md
 - Rakefile
-- MANIFEST.md
-- certs
 - certs/djberg96_pub.pem
-- examples
-- examples/plain
+- dbi-dbrc.gemspec
 - examples/plain/test.rb
-- examples/xml
 - examples/xml/test_xml.rb
-- examples/yml
 - examples/yml/test_yml.rb
-- lib
-- lib/dbi
-- lib/dbi/dbrc.rb
 - lib/dbi-dbrc.rb
-- Gemfile
-- CHANGES.md
+- lib/dbi/dbrc.rb
+- spec/dbi_dbrc_spec.rb
+- spec/dbi_dbrc_xml_spec.rb
+- spec/dbi_dbrc_yml_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/djberg96/dbi-dbrc
 licenses:
 - Apache-2.0
 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
+  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