dbi-dbrc 1.1.9 → 1.5.0

data/spec/dbi_dbrc_xml_spec.rb

@@ -0,0 +1,95 @@
+########################################################################
+# dbi_dbrc_xml_spec.rb
+#
+# Test suite for the XML 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::XML, :xml => 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(:xml){
+    %q{
+      <dbrc>
+         <database name="foo">
+            <user>user1</user>
+            <password>pwd1</password>
+            <driver>Oracle</driver>
+            <interval>60</interval>
+            <timeout>40</timeout>
+            <maximum_reconnects>3</maximum_reconnects>
+         </database>
+         <database name="foo">
+            <user>user2</user>
+            <password>pwd2</password>
+            <driver>OCI8</driver>
+            <interval>60</interval>
+            <timeout>60</timeout>
+            <maximum_reconnects>4</maximum_reconnects>
+         </database>
+         <database name="bar">
+            <user>user1</user>
+            <password>pwd3</password>
+            <driver>Oracle</driver>
+            <interval>30</interval>
+            <timeout>30</timeout>
+            <maximum_reconnects>2</maximum_reconnects>
+         </database>
+         <database name="baz">
+            <user>user3</user>
+            <password>pwd4</password>
+         </database>
+      </dbrc>
+    }.lstrip
+  }
+
+  before do
+    allow(Dir).to receive(:home).and_return(home)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(xml) }
+    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_yml_spec.rb

@@ -0,0 +1,89 @@
+########################################################################
+# dbi_dbrc_yml_spec.rb
+#
+# Test suite for the YAML 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::YML, :yml => 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(:yml){
+    %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)
+    FileUtils.mkdir_p(home)
+    File.open(dbrc, 'w'){ |fh| fh.write(yml) }
+    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/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,100 +1,149 @@
 --- !ruby/object:Gem::Specification
 name: dbi-dbrc
 version: !ruby/object:Gem::Version
-  version: 1.1.9
-  prerelease: 
+  version: 1.5.0
 platform: ruby
 authors:
 - Daniel Berger
-autorequire: 
+autorequire:
 bindir: bin
-cert_chain: []
-date: 2013-01-10 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----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-----
+date:
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sys-admin
+  name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! "    The dbi-dbrc library provides an interface for storing database\n
-  \   connection information, including passwords, in a locally secure\n    file only
-  accessible by you, or root. This allows you to avoid\n    hard coding login and
-  password information in your programs\n    that require such information.\n\n    This
-  library can also be used to store login and password information\n    for logins
-  on remote hosts, not just databases.\n"
+        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
+      file only accessible by you, or root. This allows you to avoid
+      hard coding login and password information in your programs
+      that require such information.
+
+      This library can also be used to store login and password information
+      for logins on remote hosts, not just databases.
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
-- CHANGES
 - 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/plain
 - 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
-- MANIFEST
-- Rakefile
-- README
-- test/test_dbi_dbrc.rb
-- test/test_dbi_dbrc_xml.rb
-- test/test_dbi_dbrc_yml.rb
+- lib/dbi-dbrc.rb
+- Gemfile
+- CHANGES.md
 homepage: https://github.com/djberg96/dbi-dbrc
 licenses:
-- Artistic 2.0
-post_install_message: 
+- 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
+  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:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: shards
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+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.rb
-- test/test_dbi_dbrc_xml.rb
-- test/test_dbi_dbrc_yml.rb
+test_files: []

data/README

@@ -1,260 +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
-   * sys-admin
-   * win32-file (MS Windows only)
-   * win32-dir (MS Windows only)
-   * win32-process (MS Windows only)
-
-== 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-2013, Daniel J. Berger, all rights reserved.
-   
-= 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