berkeley_library-util 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f8cd7e16b30baef3d05f38a78b698dfbc3a603b67f3573c8a2bbec9e2cac9b3
-  data.tar.gz: ebf19dd8fee5fe57a78942432d3f08e8bc486ac1ae69ba7a7ebad070ece90331
+  metadata.gz: 57ff7fc89570ad61496f1587934e40dc18752df9cd99d766f591c4fe03fcde51
+  data.tar.gz: e0bc0403c067c04801683e12de79a569721332ac23c770a05a0a0fde41842214
 SHA512:
-  metadata.gz: 4ec9705be8f0b44019205a2bc72b5d24b982ddf463f88676e395de277cb6ff20687d3c4a5efc88de6f450a862e4351558dd9409bd35971970034c6b8e85ecea1
-  data.tar.gz: 0e77b5e7d5221ee6498ffba856d01ffa2faf216f3838bdd41db724e4207191cd97919bc1e24ba0ea5e483cc6ba83dea3672b258465ebe136bad1e5e3bd296b35
+  metadata.gz: 6f7786f78fd64266dab9e424f61c03a95dc5a7eb294990bfef1d124699d5e0f6db7b53eaa2d3ca84c77eea1e096b11a5d227c679f5994699973b6274e3d6afe0
+  data.tar.gz: a8a61db572a00d9d0ca6d41f23d2c76490196c14a6fdd8202b88d1f924fd5f9a32ebbea0e7811a4fba2a49a6fcec4ac40242cd79dfbaec8f37deaff046650436

data/.idea/util.iml

@@ -1,28 +1,31 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
   <component name="NewModuleRootManager" inherit-compiler-output="true">
     <exclude-output />
     <content url="file://$MODULE_DIR$" />
     <orderEntry type="jdk" jdkName="RVM: ruby-2.7.4" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="actionpack (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="actionview (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="activesupport (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionpack (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="actionview (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="addressable (v2.8.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.3.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="amazing_print (v1.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="berkeley_library-logging (v0.2.6, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="builder (v3.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundle-audit (v0.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.14, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.31, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="bundler-audit (v0.9.0.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter (v2.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ci_reporter_rspec (v1.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="colorize (v0.8.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.9, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.1.10, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.5, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crass (v1.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.4.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="docile (v1.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="domain_name (v0.5.20190701, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="dotenv (v2.7.6, RVM: ruby-2.7.4) [gem]" level="application" />
@@ -30,55 +33,55 @@
     <orderEntry type="library" scope="PROVIDED" name="hashdiff (v1.0.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-accept (v1.7.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="http-cookie (v1.0.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.8.10, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.11.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.12.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.10.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="lograge (v0.12.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="loofah (v2.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2021.0901, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.14.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types (v3.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mime-types-data (v3.2022.0105, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.15.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="netrc (v0.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.12.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.7, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.13.5, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="oj (v3.13.11, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ougai (v1.9.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.21.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="parser (v3.0.2.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v4.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="racc (v1.5.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="public_suffix (v4.0.7, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.6.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack-test (v1.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-dom-testing (v2.0.3, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rails-html-sanitizer (v1.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="railties (v6.1.4.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.0.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="railties (v7.0.2.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v13.0.6, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.1.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="request_store (v1.5.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="regexp_parser (v2.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="request_store (v1.5.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rest-client (v2.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.5, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.10.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.10.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.10.1, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.10.2, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.10.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.11.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rake (v0.6.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v2.4.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-prof (v0.17.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.11.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov (v0.21.2, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="simplecov-html (v0.12.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.2.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.3, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="thor (v1.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov-rcov (v0.3.1, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="simplecov_json_formatter (v0.1.4, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thor (v1.2.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="typesafe_enum (v0.3.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.4, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unf (v0.1.4, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unf_ext (v0.0.8.1, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.1.0, RVM: ruby-2.7.4) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="webmock (v3.14.0, RVM: ruby-2.7.4) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.4.2, RVM: ruby-2.7.4) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="zeitwerk (v2.5.4, RVM: ruby-2.7.4) [gem]" level="application" />
   </component>
   <component name="RModuleSettingsStorage">
     <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
@@ -95,7 +98,7 @@
           </RakeTaskImpl>
           <RakeTaskImpl description="Run all specs in spec directory, with coverage" fullCommand="coverage" id="coverage" />
           <RakeTaskImpl description="Run tests, check test coverage, check code style, check for vulnerabilities, build gem" fullCommand="default" id="default" />
-          <RakeTaskImpl description="Build berkeley_library-util.gemspec as berkeley_library-util-0.1.0.gem" fullCommand="gem" id="gem" />
+          <RakeTaskImpl description="Build berkeley_library-util.gemspec as berkeley_library-util-0.1.1.gem" fullCommand="gem" id="gem" />
           <RakeTaskImpl description="Run RuboCop with auto-correct, and output results to console" fullCommand="ra" id="ra" />
           <RakeTaskImpl description="Run rubocop with HTML output" fullCommand="rubocop" id="rubocop" />
           <RakeTaskImpl id="rubocop">

data/CHANGES.md

@@ -1,6 +1,22 @@
+# 0.1.4 (2022-07-20)
+
+- Adds `URIs#safe_parse_uri`, which returns `nil` for invalid URLs (unlike `URIs#uri_or_nil`, which
+  raises `URI::InvalidURIError` for non-nil, non-parseable URLs)
+- Updates documentation for `URIs#uri_or_nil` and `Validator#uri_or_nil` to clarify that
+  `nil` is an acceptable argument.
+
+# 0.1.3 (2022-05-11)
+
+- Adds `URIs#get_response`, which returns a complete `RestClient::Response` rather than just
+  the response body.
+
+# 0.1.2 (2022-05-05)
+
+- Adds `BerkeleyLibrary::Files`, which contains file and IO utility methods
+
 # 0.1.1 (2021-09-23)
 
-- `URIs.append` now handles bare URLs with empty paths, with the caveat that
+- `URIs#append` now handles bare URLs with empty paths, with the caveat that
   a root path `/` will always be added, even if there are no path elements to append.
 
 # 0.1.0 (2021-09-23)

data/README.md

@@ -19,3 +19,7 @@ Routines for modifying paths separated by forward slashes,
 ## [BerkeleyLibrary::Util::URIs](lib/berkeley_library/util/uris.rb)
 
 Routines for constructing, validating, and retrieving the content from URIs.
+
+## [BerkeleyLibrary::Util::Files](lib/berkeley_library/util/files.rb)
+
+Routines for working with file paths and IO objects.

data/lib/berkeley_library/util/files.rb

@@ -0,0 +1,37 @@
+module BerkeleyLibrary
+  module Util
+    module Files
+      class << self
+        include Files
+      end
+
+      def file_exists?(path)
+        (path.respond_to?(:exist?) && path.exist?) ||
+          (path.respond_to?(:to_str) && File.exist?(path))
+      end
+
+      def parent_exists?(path)
+        path.respond_to?(:parent) && path.parent.exist? ||
+          path.respond_to?(:to_str) && Pathname.new(path).parent.exist?
+      end
+
+      # Returns true if `obj` is close enough to an IO object for Nokogiri
+      # to parse as one.
+      #
+      # @param obj [Object] the object that might be an IO
+      # @see https://github.com/sparklemotion/nokogiri/blob/v1.11.1/lib/nokogiri/xml/sax/parser.rb#L81 Nokogiri::XML::SAX::Parser#parse
+      def reader_like?(obj)
+        obj.respond_to?(:read) && obj.respond_to?(:close)
+      end
+
+      # Returns true if `obj` is close enough to an IO object for Nokogiri
+      # to write to.
+      #
+      # @param obj [Object] the object that might be an IO
+      def writer_like?(obj)
+        obj.respond_to?(:write) && obj.respond_to?(:close)
+      end
+
+    end
+  end
+end

data/lib/berkeley_library/util/module_info.rb

@@ -5,11 +5,9 @@ module BerkeleyLibrary
       AUTHOR = 'David Moles'.freeze
       AUTHOR_EMAIL = 'dmoles@berkeley.edu'.freeze
       SUMMARY = 'Miscellaneous Ruby utilities for the UC Berkeley Library'.freeze
-      DESCRIPTION = <<~DESC.gsub(/\s+/, ' ').strip
-        A collection of miscellaneous Ruby routines for the UC Berkeley Library.
-      DESC
+      DESCRIPTION = 'A collection of miscellaneous Ruby routines for the UC Berkeley Library.'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.1.1'.freeze
+      VERSION = '0.1.4'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/util'.freeze
     end
   end

data/lib/berkeley_library/util/uris/requester.rb

@@ -10,7 +10,7 @@ module BerkeleyLibrary
         class << self
           include BerkeleyLibrary::Logging
 
-          # Performs a GET request.
+          # Performs a GET request and returns the response body as a string.
           #
           # @param uri [URI, String] the URI to GET
           # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
@@ -18,13 +18,29 @@ module BerkeleyLibrary
           # @return [String] the body as a string.
           # @raise [RestClient::Exception] in the event of an error.
           def get(uri, params: {}, headers: {})
-            url_str = url_str_with_params(uri, params)
-            resp = get_or_raise(url_str, headers)
+            resp = make_get_request(uri, params, headers)
             resp.body
           end
 
+          # Performs a GET request and returns the response.
+          #
+          # @param uri [URI, String] the URI to GET
+          # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
+          # @param headers [Hash] the request headers.
+          # @return [RestClient::Response] the body as a string.
+          def get_response(uri, params: {}, headers: {})
+            make_get_request(uri, params, headers)
+          rescue RestClient::Exception => e
+            e.response
+          end
+
           private
 
+          def make_get_request(uri, params, headers)
+            url_str = url_str_with_params(uri, params)
+            get_or_raise(url_str, headers)
+          end
+
           def url_str_with_params(uri, params)
             raise ArgumentError, 'uri cannot be nil' unless (url_str = Validator.url_str_or_nil(uri))
 
@@ -40,6 +56,7 @@ module BerkeleyLibrary
             uri.to_s
           end
 
+          # @return [RestClient::Response]
           def get_or_raise(url_str, headers)
             resp = RestClient.get(url_str, headers)
             begin
@@ -47,6 +64,7 @@ module BerkeleyLibrary
 
               raise(exception_for(resp, status))
             ensure
+              # noinspection RubyMismatchedReturnType
               logger.info("GET #{url_str} returned #{status}")
             end
           end

data/lib/berkeley_library/util/uris/validator.rb

@@ -6,10 +6,11 @@ module BerkeleyLibrary
       module Validator
         class << self
 
-          # Returns the specified URL as a URI.
-          # @param url [String, URI] the URL.
-          # @return [URI] the URI.
-          # @raise [URI::InvalidURIError] if `url` cannot be parsed as a URI.
+          # Returns the specified URL as a URI, or `nil` if the URI is `nil`.
+          # @param url [String, URI, nil] the URL.
+          # @return [URI] the URI, or `nil`.
+          # @raise [URI::InvalidURIError] if `url` is not `nil` and cannot be
+          #   parsed as a URI.
           def uri_or_nil(url)
             return unless url
 

data/lib/berkeley_library/util/uris.rb

@@ -1,3 +1,4 @@
+require 'berkeley_library/logging'
 require 'berkeley_library/util/uris/appender'
 require 'berkeley_library/util/uris/requester'
 require 'berkeley_library/util/uris/validator'
@@ -5,6 +6,8 @@ require 'berkeley_library/util/uris/validator'
 module BerkeleyLibrary
   module Util
     module URIs
+      include BerkeleyLibrary::Logging
+
       class << self
         include URIs
       end
@@ -32,13 +35,36 @@ module BerkeleyLibrary
         Requester.get(uri, params: params, headers: headers)
       end
 
-      # Returns the specified URL as a URI.
-      # @param url [String, URI] the URL.
-      # @return [URI] the URI.
-      # @raise [URI::InvalidURIError] if `url` cannot be parsed as a URI.
+      # Performs a GET request and returns the response.
+      #
+      # @param uri [URI, String] the URI to GET
+      # @param params [Hash] the query parameters to add to the URI. (Note that the URI may already include query parameters.)
+      # @param headers [Hash] the request headers.
+      # @return [RestClient::Response] the body as a string.
+      def get_response(uri, params: {}, headers: {})
+        Requester.get_response(uri, params: params, headers: headers)
+      end
+
+      # Returns the specified URL as a URI, or `nil` if the URL is `nil`.
+      # @param url [String, URI, nil] the URL.
+      # @return [URI] the URI, or `nil`.
+      # @raise [URI::InvalidURIError] if `url` is not `nil` and cannot be
+      #   parsed as a URI.
       def uri_or_nil(url)
         Validator.uri_or_nil(url)
       end
+
+      # Returns the specified URL as a URI, or `nil` if the URL cannot
+      # be parsed.
+      # @param url [Object, nil] the URL.
+      # @return [URI, nil] the URI, or `nil`.
+      def safe_parse_uri(url)
+        # noinspection RubyMismatchedArgumentType
+        uri_or_nil(url)
+      rescue URI::InvalidURIError => e
+        logger.warn("Error parsing URL #{url.inspect}", e)
+        nil
+      end
     end
   end
 end

data/spec/berkeley_library/util/files_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+module BerkeleyLibrary
+  module Util
+    describe Files do
+      let(:basename) { File.basename(__FILE__, '.rb') }
+
+      attr_reader :tmpdir
+
+      before { @tmpdir = Dir.mktmpdir(basename) }
+      after { FileUtils.remove_entry(tmpdir) }
+
+      describe :file_exists? do
+        it 'returns true for files that exist' do
+          path = Pathname.new(tmpdir).join('exists').tap { |p| FileUtils.touch(p) }
+          expect(path.exist?).to eq(true) # just to be sure
+          path_str = path.to_s
+
+          expect(Files.file_exists?(path)).to eq(true)
+          expect(Files.file_exists?(path_str)).to eq(true)
+        end
+
+        it 'returns false for files that do not exist' do
+          path = Pathname.new(tmpdir).join('not-exists')
+          expect(path.exist?).to eq(false) # just to be sure
+          path_str = path.to_s
+
+          expect(Files.file_exists?(path)).to eq(false)
+          expect(Files.file_exists?(path_str)).to eq(false)
+        end
+      end
+
+      describe :parent_exists? do
+        it 'returns true for paths whose parent exists' do
+          parent = Pathname.new(tmpdir).join('parent').tap(&:mkdir)
+          expect(parent.exist?).to eq(true) # just to be sure
+          path = parent.join('child')
+          path_str = path.to_s
+
+          expect(Files.parent_exists?(path)).to eq(true)
+          expect(Files.parent_exists?(path_str)).to eq(true)
+        end
+
+        it 'returns false for paths whose parent does not' do
+          parent = Pathname.new(tmpdir).join('parent')
+          expect(parent.exist?).to eq(false) # just to be sure
+          path = parent.join('child')
+          path_str = path.to_s
+
+          expect(Files.parent_exists?(path)).to eq(false)
+          expect(Files.parent_exists?(path_str)).to eq(false)
+        end
+      end
+
+      describe :reader_like? do
+        it 'returns true for a readable file' do
+          filename = File.join(tmpdir, 'out')
+          FileUtils.touch(filename)
+
+          File.open(filename, 'rb') do |out|
+            expect(Files.reader_like?(out)).to eq(true)
+          end
+        end
+
+        it 'returns true for a StringIO' do
+          out = StringIO.new
+          expect(Files.reader_like?(out)).to eq(true)
+        end
+
+        it 'returns true for a Tempfile' do
+          out = Tempfile.new('out')
+          begin
+            expect(Files.reader_like?(out)).to eq(true)
+          ensure
+            out.close
+            out.unlink
+          end
+        end
+
+        it 'returns false for something that is not reader-like' do
+          expect(Files.reader_like?('not an IO')).to eq(false)
+        end
+      end
+
+      describe :writer_like? do
+        it 'returns true for a writable file' do
+          filename = File.join(tmpdir, 'out')
+
+          File.open(filename, 'wb') do |out|
+            expect(Files.writer_like?(out)).to eq(true)
+          end
+        end
+
+        it 'returns true for a StringIO' do
+          out = StringIO.new
+          expect(Files.writer_like?(out)).to eq(true)
+        end
+
+        it 'returns true for a Tempfile' do
+          out = Tempfile.new('out')
+          begin
+            expect(Files.writer_like?(out)).to eq(true)
+          ensure
+            out.close
+            out.unlink
+          end
+        end
+
+        it 'returns false for something that is not writer-like' do
+          expect(Files.writer_like?('not an IO')).to eq(false)
+        end
+      end
+    end
+  end
+end

data/spec/berkeley_library/util/uris_spec.rb

@@ -138,18 +138,76 @@ module BerkeleyLibrary::Util
       end
     end
 
-    describe :get do
-      it 'makes a GET request' do
-        url = 'https://example.org/'
-        params = { p1: 1, p2: 2 }
-        headers = { 'X-help' => 'I am trapped in a unit test' }
-
-        url_with_query = "#{url}?#{URI.encode_www_form(params)}"
-        expected_body = 'Help! I am trapped in a unit test'
-        stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
-
-        result = URIs.get(url, params: params, headers: headers)
-        expect(result).to eq(expected_body)
+    describe 'requests' do
+      let(:url) { 'https://example.org/' }
+      let(:params) { { p1: 1, p2: 2 } }
+      let(:headers) { { 'X-help' => 'I am trapped in a unit test' } }
+      let(:url_with_query) { "#{url}?#{URI.encode_www_form(params)}" }
+      let(:expected_body) { 'Help! I am trapped in a unit test' }
+
+      describe :get do
+        it 'makes a GET request' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
+
+          result = URIs.get(url, params: params, headers: headers)
+          expect(result).to eq(expected_body)
+        end
+
+        it 'raises an error in the event of a 404' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(status: 404, body: expected_body)
+
+          expect { URIs.get(url, params: params, headers: headers) }.to raise_error(RestClient::NotFound)
+        end
+      end
+
+      describe :get_response do
+        it 'makes a GET request' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(body: expected_body)
+
+          response = URIs.get_response(url, params: params, headers: headers)
+          expect(response.body).to eq(expected_body)
+          expect(response.code).to eq(200)
+        end
+
+        it 'returns the response even for errors' do
+          stub_request(:get, url_with_query).with(headers: headers).to_return(status: 404, body: expected_body)
+
+          response = URIs.get_response(url, params: params, headers: headers)
+          expect(response.body).to eq(expected_body)
+          expect(response.code).to eq(404)
+        end
+      end
+    end
+
+    describe :safe_parse_uri do
+      it 'returns a URI unchanged' do
+        uri = URI.parse('http://example.org/')
+        expect(URIs.safe_parse_uri(uri)).to be(uri)
+      end
+
+      it 'converts a string to a URI' do
+        url = 'http://example.org/'
+        expect(URIs.safe_parse_uri(url)).to eq(URI.parse(url))
+      end
+
+      it 'returns nil for nil' do
+        expect(URIs.safe_parse_uri(nil)).to be_nil
+      end
+
+      context 'invalid URL strings' do
+        it 'returns nil' do
+          bad_url = 'not a uri'
+          expect(URIs.safe_parse_uri(bad_url)).to be_nil
+        end
+
+        it 'logs a warning' do
+          logger = instance_double(Ougai::Logger)
+          allow(BerkeleyLibrary::Logging).to receive(:logger).and_return(logger)
+
+          bad_url = 'not a uri'
+          expect(logger).to receive(:warn).with(/#{bad_url}/, kind_of(URI::InvalidURIError))
+          expect(URIs.safe_parse_uri(bad_url)).to be_nil
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-24 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -260,6 +260,7 @@ files:
 - berkeley_library-util.gemspec
 - lib/berkeley_library/util.rb
 - lib/berkeley_library/util/arrays.rb
+- lib/berkeley_library/util/files.rb
 - lib/berkeley_library/util/module_info.rb
 - lib/berkeley_library/util/paths.rb
 - lib/berkeley_library/util/stringios.rb
@@ -277,6 +278,7 @@ files:
 - rakelib/spec.rake
 - spec/.rubocop.yml
 - spec/berkeley_library/util/arrays_spec.rb
+- spec/berkeley_library/util/files_spec.rb
 - spec/berkeley_library/util/paths_spec.rb
 - spec/berkeley_library/util/stringios_spec.rb
 - spec/berkeley_library/util/strings_spec.rb
@@ -311,6 +313,7 @@ summary: Miscellaneous Ruby utilities for the UC Berkeley Library
 test_files:
 - spec/.rubocop.yml
 - spec/berkeley_library/util/arrays_spec.rb
+- spec/berkeley_library/util/files_spec.rb
 - spec/berkeley_library/util/paths_spec.rb
 - spec/berkeley_library/util/stringios_spec.rb
 - spec/berkeley_library/util/strings_spec.rb