dbi-dbrc 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f38085a9c7abb4c8a3e53fb239196135d317f78baa14a33f415fbaeab0b03d6
-  data.tar.gz: a591ba6877a994765c4ad4dc5eb540b149c98398fe11bfd93ff04be1dca4e562
+  metadata.gz: 813eb7a49bd78983624e1e91031b3f93d83a872a1edea9bc2a1bced57985af9a
+  data.tar.gz: f9a2a4b40d14ecdc5e36b02c8c8c14c5e5bf47cf34400f365b9e4b23b03a540c
 SHA512:
-  metadata.gz: 607d4e9c54ceb5c98cfaa7dc1df75708b151daac57cca77bb244371d43a1950107334081cb65ea112ba46da85aa9b015700ad23df863a09f7cbd628b0627d069
-  data.tar.gz: 3712726dcf66e0f4dc19c4dbe46115e1dc9ea5159a59a4e9e31bf250e643dd07f114a6b4b27585a31c7a4c34016bba22c3999592b831feaea3aeeacddb9a57f4
+  metadata.gz: b46c7b59855bfa381213fa8ce30d31dbe4646811a6fd085ec698a1d6d3504eda6838a9693355ee958fd13e5aad679b6f2f5a060050cfaa64a45ec5214e84c4ab
+  data.tar.gz: 7f222c7eda45b449a59ecff9fb6c9631ac3dd54e59f3c12a858333ba478a1fa1f4e0269bd96a4453c320a56c47826e49da2994656caa1e61bebbde78e5d54a80

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 1.7.0 - 19-Jun-2021
+* Added a DBI::DBRC::JSON subclass, and corresponding specs, so you can now
+  store information in JSON format.
+* Updated and/or removed old information from the README file.
+
 ## 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).

data/MANIFEST.md

@@ -5,6 +5,9 @@
 * dbi-dbrc.gemspec
 * certs/djberg96_pub.pem
 * lib/dbi/dbrc.rb
+* lib/dbi/dbrc/json.rb
+* lib/dbi/dbrc/xml.rb
+* lib/dbi/dbrc/yaml.rb
 * examples/plain/.dbrc
 * examples/plain/test.rb
 * examples/xml_examples/.dbrc
@@ -12,5 +15,6 @@
 * examples/yml_examples/.dbrc
 * examples/yml_examples/test_yml.rb
 * spec/dbi_dbrc_spec.rb
+* spec/dbi_dbrc_json_spec.rb
 * spec/dbi_dbrc_xml_spec.rb
 * spec/dbi_dbrc_yml_spec.rb

data/README.md

@@ -1,12 +1,20 @@
 ## Description
-This is a supplement to the dbi library, allowing you to avoid hard-coding
-passwords in your programs that make database connections. It can also
-be used as a general password storage mechanism for other types of
+This is essentially a database connection configuration library, allowing you
+to avoid hard-coding passwords in your programs, and store other generalized
+information, when making database connections.
+
+It can also be used as a general password storage manager for other types of
 connections, e.g. ssh, ftp, etc.
 
+The name was originally based on the old DBI library (which in turn was based
+on the Perl library of the same name), and was originally meant as a supplement
+to that library. The DBI library is now defunct, but it not necessary to use
+this library. But, that explains why there's an outer "DBI" namespace module.
+
 ## Requirements
-For most platforms there are no additional requirements. However, for MS
-Windows there are these additional requirements:
+* gpgme - For GPG encrypted files (which you should be doing).
+
+For MS Windows there are these additional requirements:
 
 * sys-admin
 * win32-file-attributes
@@ -33,10 +41,10 @@ puts dbrc.dsn
 ```
 
 ## Notes on the .dbrc file
-This module relies on a file in your home directory called ".dbrc", and it
-is meant to be analogous to the ".netrc" file used by programs such as
-telnet. The .dbrc file has several conditions that must be met by the
-module or it will fail:
+This module relies on a file somewhere on your filesystem (normally your home
+directory) called ".dbrc", and it is meant to be analogous to the ".netrc" file
+used by programs such as telnet. The .dbrc file has several conditions that
+must be met by the module or it will fail:
 
 * Permissions must be set to 600 (Unix only).
 * Must be hidden (MS Windows only).
@@ -54,8 +62,7 @@ You may include comments in the .dbrc file by starting the line with a
 
 A failure in any of the rules mentioned above will result in a `DBRC::Error`
 being raised. In addition, the file may also be encrypted on MS Windows
-systems, in which case the file will automatically be (temporarily)
-decrypted.
+systems, in which case the file will automatically be (temporarily) decrypted.
 
 The format for XML (using the example above) is as follows:
 
@@ -83,6 +90,23 @@ The format for YAML is as follows:
   timeout: 10
   max_reconn: 2
 ```
+
+The format for JSON is as follows:
+
+```json
+[
+  {
+    "foo": {
+      "user": "dan",
+      "password": "mypass",
+      "driver": "oracle",
+      "interval": 30,
+      "timeout": 10,
+      "maximum_reconnects": 2
+    }
+  }
+]
+```
    
 ## Constants
 `VERSION`
@@ -90,7 +114,7 @@ The format for YAML is as follows:
 The current version of this library, returned as a String.
     
 ## Class Methods
-`DBRC.new(db, user=nil, dir=nil)`
+`DBRC.new(db, user = nil, dir = nil, gpg_options = nil)`
 
 The constructor takes one to three arguments. The first argument is the
 database name. This *must* be provided. If only the database name is
@@ -105,6 +129,10 @@ The third argument, also optional, specifies the directory where DBRC will
 look for the .dbrc file. By default, it looks in the pwuid (present
 working user id) home directory. The rules for a .dbrc file still apply.
 
+The fourth argument, if present, are options that are forwarded to the
+`GPGME::Crypto.new` constructor for GPG encrypted files. Typically this
+would at least be the :password option, but YMMV.
+
 MS Windows users should read the "Notes" section for how your home directory
 is determined.
     
@@ -209,7 +237,7 @@ not automatically reset the driver or database.
 ## Canonical Example
 ```ruby
 # This is a basic template for how I do things:
-
+require 'dbi'
 require 'dbi/dbrc'
 require 'timeout'
 
@@ -233,10 +261,6 @@ end
 ```
 
 ## Notes for MS Windows Users
-The `home` directory for Win32 users is determined by `ENV['USERPROFILE']`.
-If that is not set then `ENV['HOME']` is used. If that is not set, then
-the directory found by the sys-admin library is used.
-
 To make your file hidden, right click on the .dbrc file in your Explorer
 window, select "Properties" and check the "Hidden" checkbox.
 
@@ -246,18 +270,9 @@ party, which is a bit much to expect. However, if the file is encrypted,
 DBRC will attempt to decrypt it, parse it, and encrypt it again when done
 parsing.
 
-## Notes on running the test suite
-I cannot guarantee that the .dbrc files under the `examples`
-subdirectories maintain the appropriate properties. This can cause
-failures for the test suite (which uses these files).
-
-The only solution is to perform a `chmod 600 .dbrc` (on Unix) or set
-the properties to 'hidden' (on MS Windows) manually, for the file in
-question.
-   
 ## Summary
-These "methods" don't really do anything. They're simply meant as a
-convenience mechanism for you dbi connections, plus a little bit of
+These methods don't really "do" anything. They're simply meant as a
+convenience mechanism for your database connections, plus a little bit of
 obfuscation (for passwords).
 
 ## Adding your own configuration
@@ -271,7 +286,7 @@ 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.
+None at this time.
    
 ## Known Bugs
 I'm not positive about the dsn strings for databases other than Oracle.

data/dbi-dbrc.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'dbi-dbrc'
-  spec.version    = '1.6.0'
+  spec.version    = '1.7.0'
   spec.author     = 'Daniel Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'

data/lib/dbi/dbrc.rb

@@ -17,7 +17,7 @@ module DBI
     class Error < StandardError; end
 
     # The version of the dbi-dbrc library
-    VERSION = '1.6.0'
+    VERSION = '1.7.0'
 
     WINDOWS = File::ALT_SEPARATOR # :no-doc:
 
@@ -104,7 +104,7 @@ module DBI
     #   # 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)
+    def initialize(database, user = nil, dbrc_dir = Dir.home, gpg_options = nil)
       if dbrc_dir.nil?
         # Default to the app data directory on Windows, or root on Unix, if
         # no home dir can be found.
@@ -245,62 +245,8 @@ module DBI
       end
     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
-
-    private
-
-    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]
-          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 DBRC::YML < DBRC
-    require 'yaml'
-
-    private
-
-    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 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
+
+require_relative 'dbrc/xml'
+require_relative 'dbrc/yaml'
+require_relative 'dbrc/json'

data/lib/dbi/dbrc/json.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../dbrc'
+
+# The DBI module serves as namespace only.
+module DBI
+  # A subclass of DBRC designed to handle .dbrc files in JSON format. The
+  # public methods of this class are identical to DBRC.
+  class DBRC::JSON < DBRC
+    require 'json'
+
+    private
+
+    def parse_dbrc_config_file(file = @dbrc_file)
+      begin
+        fh = file.is_a?(StringIO) ? file : File.open(file)
+        config = ::JSON.parse(fh.read)
+
+        config.each do |hash|
+          db = hash.keys.first
+          next unless db == @database
+          next if @user && @user != hash[db]['user']
+          @user = hash[db]['user']
+          @password = hash[db]['password']
+          @driver = hash[db]['driver']
+          @interval = hash[db]['interval']
+          @timeout = hash[db]['timeout']
+          @maximum_reconnects = hash[db]['maximum_reconnects']
+          break
+        end
+      ensure
+        fh.close if fh && fh.respond_to?(:close)
+      end
+
+      raise Error, "No entry found for #{@user}@#{@database}" unless @user && @database
+    end
+  end
+end

data/lib/dbi/dbrc/xml.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../dbrc'
+
+# The DBI module serves as a namespace only.
+module DBI
+  # 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
+
+    private
+
+    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]
+          send("#{field}=", val.text) unless val.nil?
+        end
+
+        break
+      end
+
+      raise Error, "No record found for #{@user}@#{@database}" unless @user && @database
+    end
+  end
+end

data/lib/dbi/dbrc/yaml.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../dbrc'
+
+# The DBI module serves as namespace only.
+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 DBRC::YML < DBRC
+    require 'yaml'
+
+    private
+
+    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 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
+
+DBI::DBRC::YAML = DBI::DBRC::YML # Alias

data/spec/dbi_dbrc_json_spec.rb

@@ -0,0 +1,109 @@
+########################################################################
+# dbi_dbrc_json_spec.rb
+#
+# Test suite for the JSON specific version of DBI::DBRC. This test case
+# should be run via the 'rake test' task.
+########################################################################
+require 'dbi/dbrc'
+require 'rspec'
+require 'pp' # Need this to avoid fakefs error
+require 'fakefs/spec_helpers'
+
+RSpec.describe DBI::DBRC::JSON, :json => true do
+  include FakeFS::SpecHelpers
+
+  let(:home) { File.join(Dir.pwd, 'home', 'someone') }
+  let(:dbrc) { File.join(home, '.dbrc') }
+
+  let(:db_foo){ 'foo' }
+  let(:user1) { 'user1' }
+
+  let(:json){
+    %q{
+    [
+      {
+        "foo": {
+          "user": "user1",
+          "password": "pwd1",
+          "driver": "Oracle",
+          "interval": 60,
+          "timeout": 40,
+          "maximum_reconnects": 3
+        }
+      },
+      {
+        "foo": {
+          "user": "user2",
+          "password": "pwd2",
+          "driver": "OCI8",
+          "interval": 60,
+          "timeout": 60,
+          "maximum_reconnects": 4
+        }
+      },
+      {
+        "bar": {
+          "user": "user1",
+          "password": "pwd3",
+          "driver": "Oracle",
+          "interval": 30,
+          "timeout": 30,
+          "maximum_reconnects": 2
+        }
+      },
+      {
+        "baz": {
+          "user": "user3",
+          "password": "pwd4"
+        }
+      }
+    ]
+    }
+}
+
+  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(json) }
+    File.chmod(0600, dbrc)
+
+    # FakeFS doesn't implement this yet
+    allow_any_instance_of(FakeFS::File::Stat).to receive(:owned?).and_return(true)
+  end
+
+  context "instance methods" do
+    before do
+      @dbrc = described_class.new(db_foo, user1)
+    end
+
+    example "database method returns expected value" do
+      expect(@dbrc.database).to eq('foo')
+    end
+
+    example "password method returns expected value" do
+      expect(@dbrc.password).to eq('pwd1')
+    end
+
+    example "driver method returns expected value" do
+      expect(@dbrc.driver).to eq('Oracle')
+    end
+
+    example "interval method returns expected value" do
+      expect(@dbrc.interval).to eq(60)
+    end
+
+    example "timeout method returns expected value" do
+      expect(@dbrc.timeout).to eq(40)
+    end
+
+    example "maximum_reconnects method returns expected value" do
+      expect(@dbrc.maximum_reconnects).to eq(3)
+    end
+  end
+end

data/spec/dbi_dbrc_spec.rb

@@ -43,7 +43,7 @@ RSpec.describe DBI::DBRC do
   end
 
   example "version" do
-    expect(described_class::VERSION).to eq('1.6.0')
+    expect(described_class::VERSION).to eq('1.7.0')
     expect(described_class::VERSION).to be_frozen
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbi-dbrc
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Daniel Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gpgme
@@ -119,6 +119,10 @@ files:
 - examples/yml/test_yml.rb
 - lib/dbi-dbrc.rb
 - lib/dbi/dbrc.rb
+- lib/dbi/dbrc/json.rb
+- lib/dbi/dbrc/xml.rb
+- lib/dbi/dbrc/yaml.rb
+- spec/dbi_dbrc_json_spec.rb
 - spec/dbi_dbrc_spec.rb
 - spec/dbi_dbrc_xml_spec.rb
 - spec/dbi_dbrc_yml_spec.rb