dbi-dbrc 1.4.1 → 1.5.0

data/spec/spec_helper.rb

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

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: dbi-dbrc
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,10 +35,10 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 
+date:
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,19 +52,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: |2
       The dbi-dbrc library provides an interface for storing database
       connection information, including passwords, in a locally secure
@@ -77,44 +91,43 @@ description: |2
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
-- test
-- test/test_dbi_dbrc_xml.rb
-- test/test_dbi_dbrc.rb
-- test/test_dbi_dbrc_yml.rb
+- 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
+- README.md
+- Rakefile
+- MANIFEST.md
+- certs
+- certs/djberg96_pub.pem
 - examples
-- examples/xml
-- examples/xml/test_xml.rb
 - examples/plain
 - examples/plain/test.rb
+- examples/xml
+- examples/xml/test_xml.rb
 - examples/yml
 - examples/yml/test_yml.rb
-- README
-- Rakefile
-- MANIFEST
 - lib
 - lib/dbi
 - lib/dbi/dbrc.rb
 - lib/dbi-dbrc.rb
-- dbi-dbrc.gemspec
-- certs
-- certs/djberg96_pub.pem
+- Gemfile
+- CHANGES.md
 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/master/CHANGES
+  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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,18 +135,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A simple way to avoid hard-coding passwords with DBI
-test_files:
-- test/test_dbi_dbrc_xml.rb
-- test/test_dbi_dbrc.rb
-- test/test_dbi_dbrc_yml.rb
+test_files: []

data/README

@@ -1,265 +0,0 @@
-== Description
-   This is a supplement to the dbi module, 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
-   connections, e.g. ssh, ftp, etc.
-
-== Requirements
-   MS Windows users have these additional requirements:
-
-   * sys-admin
-   * win32-file-attributes
-   * win32-dir
-   * win32-process
-
-== Installation
-   gem install dbi-dbrc
-
-== Synopsis
-   require 'dbi/dbrc'
-   include DBI
-
-   dbrc = DBRC.new('mydb')
-
-   or
-
-   dbrc = DBRC.new('mydb', 'someUser')
-
-   puts dbrc.db
-   puts dbrc.user
-   puts dbrc.driver
-   puts dbrc.timeout
-   puts dbrc.max_reconn
-   puts dbrc.interval
-   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:
-
-   * Permissions must be set to 600 (Unix only).
-   * Must be hidden (MS Windows only).
-   * Must be owned by the current user.
-   * Must have database, user and password. Other fields are optional.
-   * Must be in the following space-separated format (in the 'plain' version):
-
-   database user password driver timeout maximum_reconnects interval
-
-   e.g. mydb     dan    mypass     oracle   10        2         30
-
-   You may include comments in the .dbrc file by starting the line with a
-   "#" symbol.
-
-   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.
-
-   The format for XML (using the example above) is as follows:
-
-   <dbrc>
-     <database name="mydb">
-       <user>dan</user>
-       <password>mypass</password>
-       <driver>oracle</driver>
-       <interval>30</interval>
-       <timeout>10</timeout>
-       <maximum_reconnects>2</maximum_reconnects>
-     </database>
-   </dbrc>
-
-   The format for YAML is as follows:
-
-   - mydb:
-      user: dan
-      password: mypass
-      driver: oracle
-      interval: 30
-      timeout: 10
-      max_reconn: 2
-   
-== Constants
-VERSION
-   The current version of this library, returned as a String.
-    
-== Class Methods
-DBRC.new(db, user=nil, dir=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
-   passed, the module will look for the first database entry in the .dbrc
-   file that matches.
-
-   The second argument, a user name, is optional. If it is passed, the
-   module will look for the first entry in the .dbrc file where both the
-   database *and* user name match.
-
-   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.
-    
-   MS Windows users should read the "Notes" section for how your home directory
-   is determined.
-    
-== Instance Methods
-DBRC#database
-   The name of the database. Note that the same entry can appear more than
-   once, presumably because you have multiple user id's for the same
-   database.
-    
-DBRC#db
-   An alias for DBRC#database.
-    
-DBRC#database=(database)
-   Sets the database to +database+.  This is generally discouraged because
-   it does not automatically reset the dsn.
-    
-DBRC#db=(database)
-   An alias for DBRC#database=.
-   
-DBRC#user
-   A valid user name for that database.
-    
-DBRC#user=(user)
-   Sets the user name to +user+.
-    
-DBRC#password
-   The password for that user.
-    
-DBRC#passwd
-   An alias for DBRC#password.
-    
-DBRC#password=(password)
-   Sets the password to +password+.
-
-DBRC#passwd=(password)
-   An alias for DBRC#password=.
-    
-DBRC#driver
-   The driver type for that database (Oracle, MySql, etc).
-    
-DBRC#driver=(driver)
-   Sets the driver to +driver+.  This use is discouraged because it does
-   not reset the dsn.
-    
-DBRC#timeout
-   The timeout period for a connection before the attempt is dropped.
-   
-DBRC#time_out
-   An alias for DBRC#timeout, provided purely for the sake of backwards
-   compatability.
-    
-DBRC#timeout=(int)
-   Sets the timeout value to +int+.
-   
-DBRC#maximum_reconnects
-   The maximum number of reconnect attempts that should be made for the the
-   database.  Presumablly, you would use this with a "retry" within a rescue
-   block.
-
-DBRC#max_reconn
-   An alias for DBRC#maximum_reconnects.
-   
-DBRC#maximum_reconnects=(max)
-   Sets the maximum number of reconnect attempts to +max+.
-
-DBRC#max_reconn=(max)
-   An alias for DBRC#maximum_reconnects.
-    
-DBRC#interval
-   The number of seconds to wait before attempting to reconnect to the database
-   again should a network/database glitch occur.
-    
-DBRC#interval=(int)
-   Sets the interval seconds between connection attempts.
-    
-DBRC#dsn
-   Returns a string in "dbi:<driver>:<database>" format.
-    
-DBRC#dsn=(dsn)
-   Sets the dsn string to +dsn+.  This method is discouraged because it does
-   not automatically reset the driver or database.
-    
-== Canonical Example
-   # This is a basic template for how I do things:
-
-   require 'dbi/dbrc'
-   require 'timeout'
-
-   db = DBI::DBRC.new("somedb")
-   n = db.max_reconn
-
-   begin
-     Timeout.timeout(db.timeout){
-       DBI.connect(db.dsn, db.user, db.passwd)
-     }
-   rescue DBI::Error
-     n -= 1
-     if n > 0
-       sleep db.interval
-       retry
-     end
-     raise
-   rescue TimeoutError
-     # handle timeout error
-   end
-
-== Notes for MS Windows Users
-   The 'home' directory for Win32 users is determined by ENV['USERPROFILE'].
-   If that is not set, 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.
-
-   I was going to require that the .dbrc file be encrypted on MS Windows,
-   but that may require an official "certificate", assigned to you by a third
-   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
-   obfuscation (for passwords).
-
-== Adding your own configuration
-   If you want to add your own type of configuration file, you can still use
-   the dbi-dbrc library. All you need to do is:
-
-   * subclass DBRC
-   * redefine the +parse_dbrc_config_file+ method (a private method).
-
-   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-2019, Daniel J. Berger, all rights reserved.
-
-== License
-   Apache-2.0
-   
-= 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

data/test/test_dbi_dbrc.rb

@@ -1,199 +0,0 @@
-#########################################################################
-# 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 'dbi/dbrc'
-require 'test-unit'
-include DBI
-
-class TC_DBI_DBRC < Test::Unit::TestCase
-  def self.startup
-    @@windows = File::ALT_SEPARATOR
-  end
-
-  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
-
-    if @@windows && File.respond_to?(:set_attr)
-      File.set_attr(@file, File::HIDDEN)
-    else
-      File.chmod(0600, @file)
-    end
-
-    @dbrc = DBRC.new(@db1, nil, @dir)
-  end
-
-  def test_version
-    assert_equal('1.4.1', DBRC::VERSION)
-    assert_true(DBRC::VERSION.frozen?)
-  end
-
-  def test_bad_dbrc_properties
-    if @@windows
-      File.unset_attr(@file, File::HIDDEN)
-      assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
-    else
-      File.chmod(0555,@file)
-      assert_raises(DBRC::Error){ DBRC.new(@db1, @user1, @dir) }
-    end
-  end
-
-  def test_constructor
-    assert_raises(ArgumentError){ DBRC.new }
-    assert_nothing_raised{ DBRC.new(@db1, @user1, @dir) }
-    assert_nothing_raised{ DBRC.new(@db1, nil, @dir) }
-  end
-
-  def test_bad_database
-    assert_raise(DBRC::Error){ DBRC.new(@db_bad, nil, @dir) }
-  end
-
-  def test_bad_user
-    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
-    assert_respond_to(@dbrc, :database)
-    assert_respond_to(@dbrc, :database=)
-    assert_respond_to(@dbrc, :db)
-    assert_respond_to(@dbrc, :db=)
-    assert_kind_of(String, @dbrc.db)
-  end
-
-  def test_host_alias
-    assert_respond_to(@dbrc, :host)
-    assert_equal(true, @dbrc.method(:host) == @dbrc.method(:database))
-  end
-
-  def test_dbrc_dir
-    assert_respond_to(@dbrc, :dbrc_dir)
-    assert_equal(@dir, @dbrc.dbrc_dir)
-  end
-
-  def test_dbrc_file
-    assert_respond_to(@dbrc, :dbrc_file)
-    assert_equal('.dbrc', File.basename(@dbrc.dbrc_file))
-  end
-
-  def test_dsn
-    assert_respond_to(@dbrc, :dsn)
-    assert_respond_to(@dbrc, :dsn=)
-  end
-
-  def test_user
-    assert_respond_to(@dbrc, :user)
-    assert_respond_to(@dbrc, :user=)
-    assert_kind_of(String, @dbrc.user)
-  end
-
-  def test_password
-    assert_respond_to(@dbrc, :password)
-    assert_respond_to(@dbrc, :password=)
-    assert_respond_to(@dbrc, :passwd)
-    assert_respond_to(@dbrc, :passwd=)
-    assert_kind_of(String, @dbrc.password)
-  end
-
-  def test_driver
-    assert_respond_to(@dbrc, :driver)
-    assert_respond_to(@dbrc, :driver=)
-    assert_kind_of(String, @dbrc.driver)
-  end
-
-  def test_interval
-    assert_respond_to(@dbrc, :interval)
-    assert_respond_to(@dbrc, :interval=)
-    assert_kind_of(Numeric, @dbrc.interval)
-  end
-
-  def test_timeout
-    assert_respond_to(@dbrc, :timeout)
-    assert_respond_to(@dbrc, :timeout=)
-    assert_respond_to(@dbrc, :time_out)
-    assert_respond_to(@dbrc, :time_out=)
-    assert_kind_of(Numeric, @dbrc.timeout)
-  end
-
-  def test_max_reconn
-    assert_respond_to(@dbrc, :max_reconn)
-    assert_respond_to(@dbrc, :max_reconn=)
-    assert_respond_to(@dbrc, :maximum_reconnects)
-    assert_respond_to(@dbrc, :maximum_reconnects=)
-    assert_kind_of(Numeric, @dbrc.maximum_reconnects)
-  end
-
-  def test_sample_values
-    assert_equal("foo", @dbrc.database)
-    assert_equal("user1", @dbrc.user)
-    assert_equal("pwd1", @dbrc.passwd)
-    assert_equal("Oracle", @dbrc.driver)
-    assert_equal(60, @dbrc.interval)
-    assert_equal(40, @dbrc.timeout)
-    assert_equal(3, @dbrc.max_reconn)
-    assert_equal("dbi:Oracle:foo", @dbrc.dsn)
-  end
-
-  # Same database, different user
-  def test_duplicate_database
-    db = DBRC.new("foo", "user2", @dir)
-    assert_equal("user2", db.user)
-    assert_equal("pwd2", db.passwd)
-    assert_equal("OCI8", db.driver)
-    assert_equal(60, db.interval)
-    assert_equal(60, db.timeout)
-    assert_equal(4, db.max_reconn)
-    assert_equal("dbi:OCI8:foo", db.dsn)
-  end
-
-  # Different database, different user
-  def test_different_database
-    db = DBRC.new("bar", "user1", @dir)
-    assert_equal("user1", db.user)
-    assert_equal("pwd3", db.passwd)
-    assert_equal("Oracle", db.driver)
-    assert_equal(30, db.interval)
-    assert_equal(30, db.timeout)
-    assert_equal(2, db.max_reconn)
-    assert_equal("dbi:Oracle:bar", db.dsn)
-  end
-
-  # A database with only a couple fields defined
-  def test_nil_values
-    db = DBRC.new("baz", "user3", @dir)
-    assert_equal("user3", db.user)
-    assert_equal("pwd4", db.passwd)
-    assert_nil(db.driver)
-    assert_nil(db.interval)
-    assert_nil(db.timeout)
-    assert_nil(db.max_reconn)
-    assert_nil(db.dsn)
-  end
-
-  def teardown
-    @dir      = nil
-    @db1      = nil
-    @db2      = nil
-    @user1    = nil
-    @user2    = nil
-    @db_bad   = nil
-    @user_bad = nil
-    @dbrc     = nil
-  end
-
-  def self.shutdown
-    @@windows = nil
-  end
-end