berkeley_library-util 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b313922bbe999c373d0094a01734c05aa0e31606aeef894bb0503293a8c78e65
-  data.tar.gz: f7e67788b3b88035ff9feac00386d45cf5e35b92c5a25a40d311fe8df16e3056
+  metadata.gz: c52542412eba63da568f64ede565f97e941321d108f42e89920341df02a268b2
+  data.tar.gz: 3a56f6a5dd154c44d3d94e601f3093a8c4aca81e05fb3f7e18cd70ca6389f930
 SHA512:
-  metadata.gz: 711daf87bdb397f89302d6ee5c9f00464863947e2d7bd5d24736de48acbe987096b59d814638d4ad2e897f5bf48fc2d1e5037b753c0405c597c6feda39ba1a81
-  data.tar.gz: dfb544c71430fbda524e3ca4b8ca32d5387fb55683cd6a2eefebaceb6152416afb5d72dae03dc5a2636b3dde4f4be8a5e49695a358a4a4348ff16dc38f3cadf9
+  metadata.gz: 0ff8d42319d6faa217bb540d7276a7dd48499a9660242a3c875496594105a16a6bd63190ea234781b8950d269548d4400cabcf87292a161eb16cf8f5a3d205b8
+  data.tar.gz: ebfbe371422bbbb59587d583409200968742511013aa49df1f2922df5c9880102c3014ebe7622a7be663cd327a5a742f69c622e8369a912929edad1cc4a0b4fe

data/CHANGES.md

@@ -1,10 +1,15 @@
+# 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/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.2'.freeze
+      VERSION = '0.1.3'.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.rb

@@ -32,6 +32,16 @@ module BerkeleyLibrary
         Requester.get(uri, params: params, headers: headers)
       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: {})
+        Requester.get_response(uri, params: params, headers: headers)
+      end
+
       # Returns the specified URL as a URI.
       # @param url [String, URI] the URL.
       # @return [URI] the URI.

data/spec/berkeley_library/util/uris_spec.rb

@@ -138,18 +138,44 @@ 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
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging