Look for cred/config files in user's home dir

Replaces the s-p-u install directory as a place to check for
cred/smtp/email files.

Author: ldss-jm

README.md

@@ -115,17 +115,17 @@ Sierra::DB.write_results('output.csv', format: 'csv')
 Sierra::DB.write_results('output.xlsx', format: 'xlsx') # Requires WIN32OLE so probably Windows-only.
 
 # Send results as attachment
-details =  {:from    => '[email protected]',
-            :to      => '[email protected]',
-            :cc      => '[email protected]',
-            :subject => 'that query',
-            :body    => 'Attached.'}
+details =  {from:    '[email protected]',
+            to:      '[email protected]',
+            cc:      '[email protected]',
+            subject: 'that query',
+            body:    'Attached.'}
 Sierra::DB.mail_results('output.tsv', mail_details: details)
 ```
 
 ### Retrieve arbitrary views
 
-Retrieve arbitrary views as arrays of hashes via ```Sierra::DB.db[:view_name]```.
+Retrieve arbitrary views as arrays of hashes via `Sierra::DB.db[:view_name]`.
 
 ```ruby
 Sierra::DB.db[:request_rule].first
@@ -135,17 +135,17 @@ Sierra::DB.db[:request_rule].first
 ## SETUP
 
 * git clone <https://github.com/UNC-Libraries/sierra-postgres-utilities>
-* cd sierra-postgres-utilities
-* bundle install
-* bundle exec rake install
+* `cd sierra-postgres-utilities`
+* `bundle install`
+* `bundle exec rake install`
 * supply the Sierra postgres credentials per the below
 * optionally supply smtp server address
 
-When possible, it is recommended that you also install the ```sequel_pg``` gem which makes database access significantly faster. See <https://github.com/jeremyevans/sequel_pg> for installation details / requirements.
+When possible, it is recommended that you also install the `sequel_pg` gem which makes database access significantly faster. See <https://github.com/jeremyevans/sequel_pg> for installation details / requirements.
 
 ### Credentials
 
-Create a yaml file in the base directory like so:
+Create a yaml/text file like so:
 
 ```yaml
 host: myhost.example.com
@@ -155,11 +155,18 @@ user: myusername
 password: mypassword
 ```
 
-Store the creds in a file ```sierra_prod.secret``` in the
-current working directory or the base directory of sierra_postgres_utilities.
-Creds from this file will be used as the default connection.
+You may need to quote values (e.g. password) if they contain special characters.
 
-Alternately, specify a credential file location as an environment variable, e.g.:
+By default, sierra_postgres_utilities will try to read credentials from:
+- a file `sierra_prod.secret` in the current working directory
+- failing that, a file `sierra_prod.secret` in the user's home directory
+
+For casual use, we recommend keeping the credentials in your home directory,
+in a file called `sierra_prod.secret`.
+
+#### Credentials via environment variables
+
+Alternately, you can specify a credential file location as an environment variable, e.g.:
 
 ```bash
 SIERRA_INIT_CREDS=my/path/file.yaml irb
@@ -173,10 +180,13 @@ ENV['SIERRA_INIT_CREDS'] = 'my/path/file.yaml'
 require 'sierra_postgres_utilities'
 ```
 
+This still relies on credentials being stored in a file. The path to the
+credential file, not the credentials themselves, is set as an env variable.
+
 ### SMTP connection / email address storage
 
 Define an smtp connection (that does not require authentication) if you'll use this to send emails.
-Create ```smtp.secret``` in the working directory:
+Create `smtp.secret` in the working directory or home directory:
 
 ```yaml
 address: smtp.example.com

lib/sierra_postgres_utilities/db/connection.rb

@@ -113,7 +113,7 @@ def self.creds_from_file(file)
           creds = YAML.load_file(file)
         rescue Errno::ENOENT
           begin
-            creds = YAML.load_file(File.join(base_dir, file))
+            creds = YAML.load_file(File.join(Dir.home, file))
           rescue Errno::ENOENT
             puts 'WARN: Connection credentials invalid or not found.'
           end

lib/sierra_postgres_utilities/db/query.rb

@@ -82,7 +82,6 @@ def self.headers
       # (see #write_results)
       def self.write_results(outfile, results: self.results, headers: nil,
                              include_headers: true, format: :tsv)
-        puts 'writing results'
         headers ||= self.headers
         headers = '' unless include_headers
 
@@ -112,7 +111,13 @@ def self.write_csv(outfile, results, headers, col_sep: ',')
         outfile = File.open(outfile, 'wb') unless outfile.respond_to?(:read)
         csv = CSV.new(outfile, col_sep: col_sep)
         csv << headers unless headers.empty?
+
+        query_completed = false
         results.each do |record|
+          unless query_completed
+            puts 'writing results'
+            query_completed = true
+          end
           csv << record.values
         end
         outfile.close
@@ -146,6 +151,7 @@ def self.write_xlsx(outfile, results, headers)
         # write data
         i = 1
         results.each do |result|
+          puts 'writing results' if i == 1
           i += 1
           worksheet.Range("A#{i}:#{end_col}#{i}").value = result.values
         end
@@ -164,7 +170,7 @@ def self.emails(file = 'email.secret')
           begin
             YAML.load_file(file)
           rescue Errno::ENOENT
-            YAML.load_file(File.join(Connection.base_dir, file))
+            YAML.load_file(File.join(Dir.home, file))
           rescue TypeError
             YAML.load(file)
           end
@@ -183,7 +189,7 @@ def self.smtp(file = 'smtp.secret')
           begin
             YAML.load_file(file)
           rescue Errno::ENOENT
-            YAML.load_file(File.join(Connection.base_dir, file))
+            YAML.load_file(File.join(Dir.home, file))
           rescue TypeError
             YAML.load(file)
           end
@@ -195,6 +201,7 @@ def self.smtp=(hsh)
 
       # (see #mail_results)
       def self.send_mail(outfile, mail_details, remove_file: false)
+        smtp = Sierra::DB::Query.smtp
         Mail.defaults do
           delivery_method :smtp, address: smtp['address'], port: smtp['port']
         end

lib/sierra_postgres_utilities/version.rb

@@ -1,3 +1,3 @@
 module Sierra
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.3.3'.freeze
 end

spec/spec_data/b1841152a.mrc

@@ -1 +1 @@
-00469cam  2200169Ia 4500001000800000005001700008008004100025020001500066040001300081100002500094245005300119260003200172300002100204907001500225915004600240935001300286867113419820807000000.0820807s1981    enk           000 1 eng d  a0094643407  aNOCcNOC1 aFassnidge, Virginia.10aSomething else :ba novel /cVirginia Fassnidge.  aLondon :bConstable,c1981.  a152 p. ;c23 cm.  a.b18411526  9Baseline 09_20139Under Authority Control  aADH-2114
+00614cam a2200205Ia 4500001000800000005001700008008004100025020001500066040001800081100007200099245005300171260003200224300002300256336002600279337002800305338002700333907001500360915002000375935001300395867113419820807000000.0820807s1981    enk           000 1 eng d  a0094643407  aNOCbengcNOC1 aFassnidge, Virginia.0http://id.loc.gov/authorities/names/n8712893810aSomething else :ba novel /cVirginia Fassnidge.  aLondon :bConstable,c1981.  a152 pages ;c23 cm  atextbtxt2rdacontent  aunmediatedbn2rdamedia  avolumebnc2rdacarrier  a.b18411526  9MARCIVE20190805  aADH-2114

spec/spec_data/b1841152a.xml

@@ -1,5 +1,5 @@
 <record>
-  <leader>00469cam  2200169Ia 4500</leader>
+  <leader>00614cam a2200205Ia 4500</leader>
   <controlfield tag='001'>8671134</controlfield>
   <controlfield tag='005'>19820807000000.0</controlfield>
   <controlfield tag='008'>820807s1981    enk           000 1 eng d</controlfield>
@@ -8,10 +8,12 @@
   </datafield>
   <datafield tag='040' ind1=' ' ind2=' '>
     <subfield code='a'>NOC</subfield>
+    <subfield code='b'>eng</subfield>
     <subfield code='c'>NOC</subfield>
   </datafield>
   <datafield tag='100' ind1='1' ind2=' '>
     <subfield code='a'>Fassnidge, Virginia.</subfield>
+    <subfield code='0'>http://id.loc.gov/authorities/names/n87128938</subfield>
   </datafield>
   <datafield tag='245' ind1='1' ind2='0'>
     <subfield code='a'>Something else :</subfield>
@@ -24,15 +26,29 @@
     <subfield code='c'>1981.</subfield>
   </datafield>
   <datafield tag='300' ind1=' ' ind2=' '>
-    <subfield code='a'>152 p. ;</subfield>
-    <subfield code='c'>23 cm.</subfield>
+    <subfield code='a'>152 pages ;</subfield>
+    <subfield code='c'>23 cm</subfield>
+  </datafield>
+  <datafield tag='336' ind1=' ' ind2=' '>
+    <subfield code='a'>text</subfield>
+    <subfield code='b'>txt</subfield>
+    <subfield code='2'>rdacontent</subfield>
+  </datafield>
+  <datafield tag='337' ind1=' ' ind2=' '>
+    <subfield code='a'>unmediated</subfield>
+    <subfield code='b'>n</subfield>
+    <subfield code='2'>rdamedia</subfield>
+  </datafield>
+  <datafield tag='338' ind1=' ' ind2=' '>
+    <subfield code='a'>volume</subfield>
+    <subfield code='b'>nc</subfield>
+    <subfield code='2'>rdacarrier</subfield>
   </datafield>
   <datafield tag='907' ind1=' ' ind2=' '>
     <subfield code='a'>.b18411526</subfield>
   </datafield>
   <datafield tag='915' ind1=' ' ind2=' '>
-    <subfield code='9'>Baseline 09_2013</subfield>
-    <subfield code='9'>Under Authority Control</subfield>
+    <subfield code='9'>MARCIVE20190805</subfield>
   </datafield>
   <datafield tag='935' ind1=' ' ind2=' '>
     <subfield code='a'>ADH-2114</subfield>