berkeley_library-util 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17e4e3e2e6e03e0dda795450e724650a0a7f7ae44db3b7a558bc371d8bed1b7
-  data.tar.gz: 106ff7e21c1e9568f4bdabc116023c292878f4fd629e5ee3ada934b2c2a10b43
+  metadata.gz: 71143c349265481e222ad5c0330ad1f995697139d114f9b9a2615c8d9cb8ea4b
+  data.tar.gz: 3ad66018de9e3ff7efe0d5637c9c79ea616da7510aff3c6f8f9bc07ed83cbb59
 SHA512:
-  metadata.gz: b4fbde8aa9e43a7ad7c414b92b488c5d2af1ae29c7f28a7ecd8f6ceb308e42c3c27a2256994362b15cba5133ec00feb32d5fe76f0b774577b292be6c2ba08528
-  data.tar.gz: 23c41cbed1b0befc458c8989792c45cf7429905b06e2deec72a88478f8eb7676a6e3be96dae5fa308239bb4f70b19acae421593711c20dd22d305f55262b0f64
+  metadata.gz: f0563b8e84cdeff86055d4423ddf57a6559c7e9a80527b643fe9cf4c10db2a62cbd8e122fc0045da56778b00ac6486ebff8ab00a5452721f385a93e9f8fc6e12
+  data.tar.gz: c19e2f817542e98ec80b9e05faf6bdaad821ab8f6589638c3790611de8231cd7bbf2a68f3d0a520fb7b96a8b0c16ac06685ae547ad6c5b7023468bea50ec4f01

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.1.7 (2023-03-15)
+
+- Allow passing `log: false` to `Requester` methods (and corresponding `URIs` convenience
+  methods) to suppress logging of each request URL and response code.
+- Allow constructing `Requester` instances with delayed execution
+- Fix documentation for `get_response` and `head_response` in `URIs` and `Requester`
+
 # 0.1.6 (2023-03-09)
 
 - Fix issue in `Requester` where query parameters would not be appended properly

data/lib/berkeley_library/util/module_info.rb

@@ -7,7 +7,7 @@ module BerkeleyLibrary
       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.1.6'.freeze
+      VERSION = '0.1.7'.freeze
       HOMEPAGE = 'https://github.com/BerkeleyLibrary/util'.freeze
     end
   end

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

@@ -39,6 +39,14 @@ module BerkeleyLibrary
           end
         end
 
+        # Returns the new URI as a string.
+        #
+        # @return [String] a new URI appending the joined path elements, as a string.
+        # @raise URI::InvalidComponentError if appending the specified elements would create an invalid URI
+        def to_url_str
+          to_uri.to_s
+        end
+
         private
 
         def handle_element(element, elem_index)

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

@@ -6,19 +6,23 @@ require 'berkeley_library/logging'
 module BerkeleyLibrary
   module Util
     module URIs
-      module Requester
-        class << self
-          include BerkeleyLibrary::Logging
+      class Requester
+        include BerkeleyLibrary::Logging
+
+        # ------------------------------------------------------------
+        # Class methods
 
+        class << self
           # 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.)
           # @param headers [Hash] the request headers.
           # @return [String] the body as a string.
+          # @param log [Boolean] whether to log each request URL and response code
           # @raise [RestClient::Exception] in the event of an unsuccessful request.
-          def get(uri, params: {}, headers: {})
-            resp = make_request(:get, uri, params, headers)
+          def get(uri, params: {}, headers: {}, log: true)
+            resp = make_request(:get, uri, params, headers, log)
             resp.body
           end
 
@@ -29,9 +33,10 @@ module BerkeleyLibrary
           # @param uri [URI, String] the URI to HEAD
           # @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.
+          # @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: {})
-            head_response(uri, params: params, headers: headers).code
+          def head(uri, params: {}, headers: {}, log: true)
+            head_response(uri, params: params, headers: headers, log: log).code
           end
 
           # Performs a GET request and returns the response, even in the event of
@@ -40,9 +45,10 @@ module BerkeleyLibrary
           # @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.
+          # @param log [Boolean] whether to log each request URL and response code
           # @return [RestClient::Response] the body as a string.
-          def get_response(uri, params: {}, headers: {})
-            make_request(:get, uri, params, headers)
+          def get_response(uri, params: {}, headers: {}, log: true)
+            make_request(:get, uri, params, headers, log)
           rescue RestClient::Exception => e
             e.response
           end
@@ -53,56 +59,105 @@ module BerkeleyLibrary
           # @param uri [URI, String] the URI to HEAD
           # @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 head_response(uri, params: {}, headers: {})
-            make_request(:head, uri, params, 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)
+            make_request(:head, uri, params, headers, log)
           rescue RestClient::Exception => e
             e.response
           end
 
           private
 
-          # @return [RestClient::Response]
-          def make_request(method, uri, params, headers)
-            url_str = url_str_with_params(uri, params)
-            req_resp_or_raise(method, url_str, headers)
+          def make_request(method, url, params, headers, log)
+            Requester.new(method, url, params: params, headers: headers, log: log).make_request
           end
+        end
+
+        # ------------------------------------------------------------
+        # Constants
+
+        SUPPORTED_METHODS = %i[get head].freeze
 
-          def url_str_with_params(url, params)
-            raise ArgumentError, 'url cannot be nil' unless (uri = Validator.uri_or_nil(url))
+        # ------------------------------------------------------------
+        # Attributes
 
-            elements = [].tap do |ee|
-              ee << uri
-              next if params.empty?
+        attr_reader :method, :url_str, :headers, :log
 
-              ee << (uri.query ? '&' : '?')
-              ee << URI.encode_www_form(params)
-            end
+        # ------------------------------------------------------------
+        # Initializer
 
-            uri = Appender.new(*elements).to_uri
-            uri.to_s
+        # Initializes a new Requester.
+        #
+        # @param method [:get, :head] the HTTP method to use
+        # @param url [String, URI] the URL or URI to request
+        # @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.
+        # @param log [Boolean] whether to log each request URL and response code
+        # @raise URI::InvalidURIError if the specified URL is invalid
+        def initialize(method, url, params: {}, headers: {}, log: true)
+          raise ArgumentError, "#{method} not supported" unless SUPPORTED_METHODS.include?(method)
+          raise ArgumentError, 'url cannot be nil' unless (uri = Validator.uri_or_nil(url))
+
+          @method = method
+          @url_str = url_str_with_params(uri, params)
+          @headers = headers
+          @log = log
+        end
+
+        # ------------------------------------------------------------
+        # Public instance methods
+
+        # @return [RestClient::Response]
+        def make_request
+          execute_request.tap do |resp|
+            log_response(resp)
           end
+        rescue RestClient::Exception => e
+          log_response(e.response)
+          raise
+        end
+
+        # ------------------------------------------------------------
+        # Private methods
 
-          # @return [RestClient::Response]
-          def req_resp_or_raise(method, url_str, headers)
-            resp = RestClient::Request.execute(method: method, url: url_str, headers: headers)
-            begin
-              return resp if (status = resp.code) == 200
-
-              raise(exception_for(resp, status))
-            ensure
-              # noinspection RubyMismatchedReturnType
-              logger.info("#{method.to_s.upcase} #{url_str} returned #{status}")
-            end
+        private
+
+        def log_response(response)
+          return unless log
+
+          logger.info("#{method.to_s.upcase} #{url_str} returned #{response.code}")
+        end
+
+        def url_str_with_params(uri, params)
+          elements = [uri]
+          if params.any?
+            elements << (uri.query ? '&' : '?')
+            elements << URI.encode_www_form(params)
+          end
+
+          Appender.new(*elements).to_url_str
+        end
+
+        def execute_request
+          RestClient::Request.execute(method: method, url: url_str, headers: headers).tap do |response|
+            # Not all failed RestClient requests throw exceptions
+            raise(exception_for(response)) unless response.code == 200
           end
+        end
 
-          def exception_for(resp, status)
-            RestClient::RequestFailed.new(resp, status).tap do |ex|
-              status_message = RestClient::STATUSES[status] || '(Unknown)'
-              ex.message = "#{status} #{status_message}"
-            end
+        def exception_for(resp)
+          status = resp.code
+          ex_class_for(status).new(resp, status).tap do |ex|
+            status_message = RestClient::STATUSES[status] || '(Unknown)'
+            ex.message = "#{status} #{status_message}"
           end
         end
+
+        def ex_class_for(status)
+          RestClient::Exceptions::EXCEPTIONS_MAP[status] || RestClient::RequestFailed
+        end
+
       end
     end
   end

data/lib/berkeley_library/util/uris.rb

@@ -31,10 +31,11 @@ module BerkeleyLibrary
       # @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.
+      # @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: {})
-        Requester.get(uri, params: params, headers: headers)
+      def get(uri, params: {}, headers: {}, log: true)
+        Requester.get(uri, params: params, headers: headers, log: log)
       end
 
       # Performs a HEAD request and returns the response status as an integer.
@@ -44,9 +45,10 @@ module BerkeleyLibrary
       # @param uri [URI, String] the URI to HEAD
       # @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.
+      # @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: {})
-        Requester.head(uri, params: params, headers: headers)
+      def head(uri, params: {}, headers: {}, log: true)
+        Requester.head(uri, params: params, headers: headers, log: log)
       end
 
       # Performs a GET request and returns the response, even in the event of
@@ -55,9 +57,10 @@ module BerkeleyLibrary
       # @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)
+      # @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)
       end
 
       # Performs a HEAD request and returns the response, even in the event of
@@ -66,9 +69,10 @@ module BerkeleyLibrary
       # @param uri [URI, String] the URI to HEAD
       # @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 head_response(uri, params: {}, headers: {})
-        Requester.head_response(uri, params: params, headers: 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)
       end
 
       # Returns the specified URL as a URI, or `nil` if the URL is `nil`.

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

@@ -145,6 +145,112 @@ module BerkeleyLibrary
             expect { Requester.head(nil) }.to raise_error(ArgumentError)
           end
         end
+
+        describe 'logging' do
+          attr_reader :logger
+
+          before do
+            @logger = instance_double(BerkeleyLibrary::Logging::Logger)
+            allow(BerkeleyLibrary::Logging).to receive(:logger).and_return(logger)
+          end
+
+          context 'GET' do
+            it 'logs request URLs and response codes for successful GET requests' do
+              url = 'https://example.org/'
+              expected_body = 'Help! I am trapped in a unit test'
+              stub_request(:get, url).to_return(body: expected_body)
+
+              expect(logger).to receive(:info).with(/#{url}.*200/)
+              Requester.send(:get, url)
+            end
+
+            it 'can suppress logging for successful GET requests' do
+              url = 'https://example.org/'
+              expected_body = 'Help! I am trapped in a unit test'
+              stub_request(:get, url).to_return(body: expected_body)
+
+              expect(logger).not_to receive(:info)
+              Requester.send(:get, url, log: false)
+            end
+
+            it 'logs request URLs and response codes for failed GET requests' do
+              url = 'https://example.org/'
+              status = 500
+              stub_request(:get, url).to_return(status: status)
+
+              expect(logger).to receive(:info).with(/#{url}.*#{status}/)
+              expect { Requester.send(:get, url) }.to raise_error(RestClient::InternalServerError)
+            end
+
+            it 'can suppress logging for failed GET requests' do
+              url = 'https://example.org/'
+              stub_request(:get, url).to_return(status: 500)
+
+              expect(logger).not_to receive(:info)
+              expect { Requester.send(:get, url, log: false) }.to raise_error(RestClient::InternalServerError)
+            end
+          end
+
+          context 'HEAD' do
+            it 'logs request URLs and response codes for successful HEAD requests' do
+              url = 'https://example.org/'
+              expected_body = 'Help! I am trapped in a unit test'
+              stub_request(:head, url).to_return(body: expected_body)
+
+              expect(logger).to receive(:info).with(/#{url}.*200/)
+              Requester.send(:head, url)
+            end
+
+            it 'can suppress logging for successful HEAD requests' do
+              url = 'https://example.org/'
+              expected_body = 'Help! I am trapped in a unit test'
+              stub_request(:head, url).to_return(body: expected_body)
+
+              expect(logger).not_to receive(:info)
+              Requester.send(:head, url, log: false)
+            end
+
+            it 'logs request URLs and response codes for failed HEAD requests' do
+              url = 'https://example.org/'
+              status = 500
+              stub_request(:head, url).to_return(status: status)
+
+              expect(logger).to receive(:info).with(/#{url}.*#{status}/)
+              expect(Requester.send(:head, url)).to eq(status)
+            end
+
+            it 'can suppress logging for failed HEAD requests' do
+              url = 'https://example.org/'
+              status = 500
+              stub_request(:head, url).to_return(status: status)
+
+              expect(logger).not_to receive(:info)
+              expect(Requester.send(:head, url, log: false)).to eq(status)
+            end
+          end
+        end
+
+        describe :new do
+          it 'rejects invalid URIs' do
+            url = 'not a uri'
+            Requester::SUPPORTED_METHODS.each do |method|
+              expect { Requester.new(method, url) }.to raise_error(URI::InvalidURIError)
+            end
+          end
+
+          it 'rejects nil URIs' do
+            Requester::SUPPORTED_METHODS.each do |method|
+              expect { Requester.new(method, nil) }.to raise_error(ArgumentError)
+            end
+          end
+
+          it 'rejects unsupported methods' do
+            url = 'https://example.org/'
+            %i[put patch post].each do |method|
+              expect { Requester.new(method, url) }.to raise_error(ArgumentError)
+            end
+          end
+        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.6
+  version: 0.1.7
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging