berkeley_library-util 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f343b3b9dc12a94f77d0a672e3d61f90ccb637f4217238b9a5b7358d658c860
-  data.tar.gz: 94ce31eb5eeb374fda410f3b984ce26ca4e070635415b2aa8afa38c33a9ceefa
+  metadata.gz: 95474321e18bf12390800d829d0fd62e043e5d5e3a17a75df968944698a10328
+  data.tar.gz: 98d7b23d5be9bb910b707f53bafa517b51994f9e2fab5b963342027f54c26e84
 SHA512:
-  metadata.gz: 25a2f1d770068ed5d54e70c359dc574958c2438f872ae466c07c9dbf9dfd8c4c033aca4cbadec1f45c8cb886ba5cdf3b626e1ab5131d3bebba94325975dc70b3
-  data.tar.gz: 22607a4573f7f85cdbde5dcb997d7b3b5fc0480262faad923ac3b01bcc6cca0c301c4746eeb9195ff8054b6b00ac56a030a0c566348278086b48603172c1823b
+  metadata.gz: 835494737587ecf7b19aa9b88d1ba500f3919c830f6b3dbae1a45d10c42e0cc5520c6f401bcc678cdc2feae4e747caedaf8960804bbc98ecd2981b7157cc0ec1
+  data.tar.gz: 770fb93344dc72807d6bfed3d8d1c70e811546bd8698b4bb627dba0206a763b17f0d34f44bf30368837d4a2b7daf64e598d7917b626ee70f978f5095cb8afcdd

data/.gitignore

@@ -35,6 +35,7 @@ Gemfile.lock
 /test/tmp/
 /test/version_tmp/
 /tmp/
+/vendor
 
 # Used by dotenv library to load environment variables.
 # .env
@@ -218,7 +219,8 @@ flycheck_*.el
 .LSOverride
 
 # Icon must end with two \r
-Icon
+Icon
+
 
 # Thumbnails
 ._*

data/.ruby-version

@@ -1 +1 @@
-~> 3.3
+3.3

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.3.0 (2026-02-04)
+
+- Add `URIs::HeadCheck`, an OkComputer check that performs a HEAD request
+  to verify the availability of a URL, with optional basic authentication.
+- updates Requester to support timeouts values passed to RestClient
+- Bumping to 0.3.0 to reflect changes to `Requester` and the addition of `URIs::HeadCheck`.
+
 # 0.2.0 (2025-07-24)
 
 - Update to support Ruby 3.3+.

data/berkeley_library-util.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ci_reporter_rspec', '~> 1.0'
   spec.add_development_dependency 'colorize', '~> 1.0'
   spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'okcomputer', '~> 1.19'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'rubocop', '~> 1.78.0'

data/lib/berkeley_library/util/arrays.rb

@@ -63,8 +63,8 @@ module BerkeleyLibrary
       #   @yieldparam target [Object] the value to compare against
       #   @return [Array<Integer>, nil] the indices in `in_array` of each value in `for_array`,
       #     or `nil` if not all values could be found
-      def find_indices(for_array:, in_array:, &block)
-        return find_indices_matching(for_array, in_array, &block) if block_given?
+      def find_indices(for_array:, in_array:, &)
+        return find_indices_matching(for_array, in_array, &) if block_given?
 
         find_all_indices(for_array, in_array)
       end
@@ -89,10 +89,10 @@ module BerkeleyLibrary
       #   @param in_array [Array] the array to search
       #   @param start_index [Integer] the index to start with
       #   @return [Enumerator] a new enumerator
-      def find_index(*args, in_array:, start_index: 0, &block)
+      def find_index(*args, in_array:, start_index: 0, &)
         raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 0..1" if args.size > 1
         return Enumerator.new { |y| find_index(in_array: in_array, start_index: start_index, &y) } if args.empty? && !block_given?
-        return unless (relative_index = in_array[start_index..].find_index(*args, &block))
+        return unless (relative_index = in_array[start_index..].find_index(*args, &))
 
         relative_index + start_index
       end

data/lib/berkeley_library/util/module_info.rb

@@ -2,12 +2,12 @@ module BerkeleyLibrary
   module Util
     class ModuleInfo
       NAME = 'berkeley_library-util'.freeze
-      AUTHORS = ['David Moles', 'maría a. matienzo'].freeze
-      AUTHOR_EMAILS = ['dmoles@berkeley.edu', 'matienzo@berkeley.edu'].freeze
+      AUTHORS = ['David Moles', 'maría a. matienzo', 'Jason Raitz'].freeze
+      AUTHOR_EMAILS = ['dmoles@berkeley.edu', 'matienzo@berkeley.edu', 'raitz@berkeley.edu'].freeze
       SUMMARY = 'Miscellaneous Ruby utilities for the UC Berkeley Library'.freeze
       DESCRIPTION = 'A collection of miscellaneous Ruby routines for the UC Berkeley Library.'.freeze
       LICENSE = 'MIT'.freeze
-      VERSION = '0.2.0'.freeze
+      VERSION = '0.3.0'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/util'.freeze
     end
   end

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

@@ -0,0 +1,27 @@
+require 'berkeley_library/util/uris'
+
+module BerkeleyLibrary
+  module Util
+    # :nocov:
+    if defined?(::OkComputer)
+      class HeadCheck < ::OkComputer::HttpCheck
+
+        def perform_request
+          headers = {}
+          if basic_auth_options.any?
+            user, password = basic_auth_options
+            headers['Authorization'] = "Basic #{Base64.strict_encode64("#{user}:#{password}")}"
+          end
+
+          options = { headers: headers, log: false }
+          options[:timeout] = request_timeout.to_i if request_timeout
+
+          URIs.head_response(url, **options)
+        rescue StandardError => e
+          raise OkComputer::HttpCheck::ConnectionFailed, e
+        end
+      end
+    end
+    # :nocov:
+  end
+end

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

@@ -13,9 +13,11 @@ module BerkeleyLibrary
           # @param log [Boolean] whether to log each request URL and response code
           # @param max_retries [Integer] the maximum number of times to retry after a 429 or 503 with Retry-After
           # @param max_retry_delay [Integer] the maximum retry delay (in seconds) to accept in a Retry-After header
+          # @param timeout [Integer] the request timeout in seconds (RestClient will use this to set both open and read timeouts)
           # @raise [RestClient::Exception] in the event of an unsuccessful request.
-          def get(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS)
-            resp = make_request(:get, uri, params, headers, log, max_retries, max_retry_delay)
+          def get(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS,
+                  timeout: DEFAULT_TIMEOUT_SECONDS)
+            resp = make_request(:get, uri, params, headers, log, max_retries, max_retry_delay, timeout)
             resp.body
           end
 
@@ -28,8 +30,10 @@ module BerkeleyLibrary
           # @param headers [Hash] the request headers.
           # @param log [Boolean] whether to log each request URL and response code
           # @return [Integer] the response code as an integer.
-          def head(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS)
-            head_response(uri, params: params, headers: headers, log: log, max_retries: max_retries, max_retry_delay: max_retry_delay).code
+          def head(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS,
+                   timeout: DEFAULT_TIMEOUT_SECONDS)
+            head_response(uri, params: params, headers: headers, log: log, max_retries: max_retries, max_retry_delay: max_retry_delay,
+                               timeout: timeout).code
           end
 
           # Performs a GET request and returns the response, even in the event of
@@ -40,8 +44,9 @@ module BerkeleyLibrary
           # @param headers [Hash] the request headers.
           # @param log [Boolean] whether to log each request URL and response code
           # @return [RestClient::Response] the response
-          def get_response(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS)
-            make_request(:get, uri, params, headers, log, max_retries, max_retry_delay)
+          def get_response(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS,
+                           timeout: DEFAULT_TIMEOUT_SECONDS)
+            make_request(:get, uri, params, headers, log, max_retries, max_retry_delay, timeout)
           rescue RestClient::Exception => e
             e.response
           end
@@ -54,15 +59,18 @@ module BerkeleyLibrary
           # @param headers [Hash] the request headers.
           # @param log [Boolean] whether to log each request URL and response code
           # @return [RestClient::Response] the response
-          def head_response(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS)
-            make_request(:head, uri, params, headers, log, max_retries, max_retry_delay)
+          def head_response(uri, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS,
+                            timeout: DEFAULT_TIMEOUT_SECONDS)
+            make_request(:head, uri, params, headers, log, max_retries, max_retry_delay, timeout)
           rescue RestClient::Exception => e
-            e.response
+            return e.response if e.response
+
+            raise
           end
 
           private
 
-          def make_request(method, url, params, headers, log, max_retries, max_retry_delay)
+          def make_request(method, url, params, headers, log, max_retries, max_retry_delay, timeout)
             Requester.new(
               method,
               url,
@@ -70,7 +78,8 @@ module BerkeleyLibrary
               headers: headers,
               log: log,
               max_retries: max_retries,
-              max_retry_delay: max_retry_delay
+              max_retry_delay: max_retry_delay,
+              timeout: timeout
             ).make_request
           end
 

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

@@ -20,11 +20,12 @@ module BerkeleyLibrary
         RETRY_STATUSES = [429, 503].freeze
         MAX_RETRY_DELAY_SECONDS = 10
         MAX_RETRIES = 3
+        DEFAULT_TIMEOUT_SECONDS = 10
 
         # ------------------------------------------------------------
         # Attributes
 
-        attr_reader :method, :url_str, :headers, :log, :max_retries, :max_retry_delay
+        attr_reader :method, :url_str, :headers, :log, :max_retries, :max_retry_delay, :timeout
 
         # ------------------------------------------------------------
         # Initializer
@@ -38,9 +39,11 @@ module BerkeleyLibrary
         # @param log [Boolean] whether to log each request URL and response code
         # @param max_retries [Integer] the maximum number of times to retry after a 429 or 503 with Retry-After
         # @param max_retry_delay [Integer] the maximum retry delay (in seconds) to accept in a Retry-After header
+        # @param timeout [Integer] the request timeout in seconds (RestClient will use this to set both open and read timeouts)
         # @raise URI::InvalidURIError if the specified URL is invalid
         # rubocop:disable Metrics/ParameterLists
-        def initialize(method, url, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS)
+        def initialize(method, url, params: {}, headers: {}, log: true, max_retries: MAX_RETRIES, max_retry_delay: MAX_RETRY_DELAY_SECONDS,
+                       timeout: DEFAULT_TIMEOUT_SECONDS)
           raise ArgumentError, "#{method} not supported" unless SUPPORTED_METHODS.include?(method)
           raise ArgumentError, 'url cannot be nil' unless (uri = Validator.uri_or_nil(url))
 
@@ -50,6 +53,7 @@ module BerkeleyLibrary
           @log = log
           @max_retries = max_retries
           @max_retry_delay = max_retry_delay
+          @timeout = timeout
         end
 
         # rubocop:enable Metrics/ParameterLists
@@ -73,7 +77,7 @@ module BerkeleyLibrary
         private
 
         def log_response(response)
-          return unless log
+          return unless log && response&.code
 
           logger.info("#{method.to_s.upcase} #{url_str} returned #{response.code}")
         end
@@ -90,6 +94,8 @@ module BerkeleyLibrary
 
         def execute_request(retries_remaining = max_retries)
           try_execute_request
+        rescue RestClient::Exceptions::Timeout
+          raise
         rescue RestClient::Exception => e
           response = e.response
           raise unless (retry_delay = retry_delay_from(response))
@@ -99,7 +105,7 @@ module BerkeleyLibrary
         end
 
         def try_execute_request
-          RestClient::Request.execute(method: method, url: url_str, headers: headers).tap do |response|
+          RestClient::Request.execute(method: method, url: url_str, headers: headers, timeout: timeout).tap do |response|
             # Not all failed RestClient requests throw exceptions
             raise(exception_for(response)) unless response.code == 200
           end

data/lib/berkeley_library/util/uris.rb

@@ -34,8 +34,8 @@ module BerkeleyLibrary
       # @param log [Boolean] whether to log each request URL and response code
       # @return [String] the body as a string.
       # @raise [RestClient::Exception] in the event of an unsuccessful request.
-      def get(uri, params: {}, headers: {}, log: true)
-        Requester.get(uri, params: params, headers: headers, log: log)
+      def get(uri, params: {}, headers: {}, log: true, timeout: Requester::DEFAULT_TIMEOUT_SECONDS)
+        Requester.get(uri, params: params, headers: headers, log: log, timeout: timeout)
       end
 
       # Performs a HEAD request and returns the response status as an integer.
@@ -47,8 +47,8 @@ module BerkeleyLibrary
       # @param headers [Hash] the request headers.
       # @param log [Boolean] whether to log each request URL and response code
       # @return [Integer] the response code as an integer.
-      def head(uri, params: {}, headers: {}, log: true)
-        Requester.head(uri, params: params, headers: headers, log: log)
+      def head(uri, params: {}, headers: {}, log: true, timeout: Requester::DEFAULT_TIMEOUT_SECONDS)
+        Requester.head(uri, params: params, headers: headers, log: log, timeout: timeout)
       end
 
       # Performs a GET request and returns the response, even in the event of
@@ -59,8 +59,8 @@ module BerkeleyLibrary
       # @param headers [Hash] the request headers.
       # @param log [Boolean] whether to log each request URL and response code
       # @return [RestClient::Response] the response
-      def get_response(uri, params: {}, headers: {}, log: true)
-        Requester.get_response(uri, params: params, headers: headers, log: log)
+      def get_response(uri, params: {}, headers: {}, log: true, timeout: Requester::DEFAULT_TIMEOUT_SECONDS)
+        Requester.get_response(uri, params: params, headers: headers, log: log, timeout: timeout)
       end
 
       # Performs a HEAD request and returns the response, even in the event of
@@ -71,8 +71,8 @@ module BerkeleyLibrary
       # @param headers [Hash] the request headers.
       # @param log [Boolean] whether to log each request URL and response code
       # @return [RestClient::Response] the response
-      def head_response(uri, params: {}, headers: {}, log: true)
-        Requester.head_response(uri, params: params, headers: headers, log: log)
+      def head_response(uri, params: {}, headers: {}, log: true, timeout: Requester::DEFAULT_TIMEOUT_SECONDS)
+        Requester.head_response(uri, params: params, headers: headers, log: log, timeout: timeout)
       end
 
       # Returns the specified URL as a URI, or `nil` if the URL is `nil`.

data/lib/berkeley_library/util.rb

@@ -1 +1 @@
-Dir.glob(File.expand_path('util/*.rb', __dir__)).sort.each(&method(:require))
+Dir.glob(File.expand_path('util/*.rb', __dir__)).each(&method(:require))

data/spec/berkeley_library/util/uris/head_check_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'okcomputer'
+require 'berkeley_library/util/uris/head_check'
+require 'base64'
+
+module BerkeleyLibrary
+  module Util
+    RSpec.describe HeadCheck do
+      let(:url) { 'http://example.com' }
+      let(:check) { described_class.new(url) }
+      let(:mock_response) { instance_double(RestClient::Response) }
+
+      before do
+        allow(BerkeleyLibrary::Util::URIs).to receive(:head_response).and_return(mock_response)
+      end
+
+      describe '#perform_request' do
+        context 'without basic auth' do
+          it 'does not add Authorization header' do
+            check.perform_request
+            expect(BerkeleyLibrary::Util::URIs).not_to have_received(:head_response).with(anything, hash_including('Authorization' => anything), anything)
+          end
+
+          it 'calls URIs.head_response with the correct URL' do
+            check.perform_request
+            expect(BerkeleyLibrary::Util::URIs).to have_received(:head_response).with(URI(url), headers: {}, log: false, timeout: 5)
+          end
+        end
+
+        context 'with basic auth' do
+          let(:user) { 'user' }
+          let(:password) { 'pass' }
+
+          # Stub the configuration on the instance directly
+          before do
+            allow(check).to receive(:basic_auth_options).and_return([user, password])
+          end
+
+          it 'adds the Authorization header' do
+            expected_headers = { 'Authorization' => "Basic #{Base64.strict_encode64("#{user}:#{password}")}" }
+
+            check.perform_request
+            expect(BerkeleyLibrary::Util::URIs).to have_received(:head_response).with(URI(url), headers: expected_headers, log: false, timeout: 5)
+          end
+        end
+
+        context 'when URIs.head_response raises an error' do
+          let(:error_message) { 'Something went wrong' }
+
+          before do
+            allow(BerkeleyLibrary::Util::URIs).to receive(:head_response).and_raise(StandardError, error_message)
+          end
+
+          it 'raises an OkComputer::HttpCheck::ConnectionFailed error' do
+            expect { check.perform_request }.to raise_error(OkComputer::HttpCheck::ConnectionFailed, error_message)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/berkeley_library/util/uris/requester_spec.rb

@@ -305,6 +305,13 @@ module BerkeleyLibrary
                   requester = Requester.new(:get, url)
                   expect { requester.make_request }.to raise_error(RestClient::ServiceUnavailable)
                 end
+
+                it "raises #{RestClient::Exceptions::Timeout} when the request times out" do
+                  url = 'http://example.edu/timeout'
+                  stub_request(:get, url).to_raise(RestClient::Exceptions::Timeout)
+
+                  expect { Requester.get(url, timeout: 10) }.to raise_error(RestClient::Exceptions::Timeout)
+                end
               end
             end
           end
@@ -374,6 +381,13 @@ module BerkeleyLibrary
             end
           end
 
+          it "raises #{RestClient::Exceptions::Timeout} when the request times out" do
+            url = 'http://example.edu/timeout'
+            stub_request(:head, url).to_raise(RestClient::Exceptions::Timeout)
+
+            expect { Requester.head(url, timeout: 10) }.to raise_error(RestClient::Exceptions::Timeout)
+          end
+
           it 'handles redirects' do
             url1 = 'https://example.org/'
             url2 = 'https://example.edu/'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David Moles
 - maría a. matienzo
+- Jason Raitz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-24 00:00:00.000000000 Z
+date: 2026-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -95,6 +96,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: okcomputer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -211,6 +226,7 @@ description: A collection of miscellaneous Ruby routines for the UC Berkeley Lib
 email:
 - dmoles@berkeley.edu
 - matienzo@berkeley.edu
+- raitz@berkeley.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -248,6 +264,7 @@ files:
 - lib/berkeley_library/util/uris.rb
 - lib/berkeley_library/util/uris/appender.rb
 - lib/berkeley_library/util/uris/exceptions.rb
+- lib/berkeley_library/util/uris/head_check.rb
 - lib/berkeley_library/util/uris/requester.rb
 - lib/berkeley_library/util/uris/requester/class_methods.rb
 - lib/berkeley_library/util/uris/validator.rb
@@ -263,6 +280,7 @@ files:
 - spec/berkeley_library/util/stringios_spec.rb
 - spec/berkeley_library/util/strings_spec.rb
 - spec/berkeley_library/util/times_spec.rb
+- spec/berkeley_library/util/uris/head_check_spec.rb
 - spec/berkeley_library/util/uris/requester_spec.rb
 - spec/berkeley_library/util/uris/validator_spec.rb
 - spec/berkeley_library/util/uris_spec.rb