berkeley_library-util 0.1.5 → 0.1.7

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(uri, params)
-            raise ArgumentError, 'uri cannot be nil' unless (url_str = Validator.url_str_or_nil(uri))
+        # ------------------------------------------------------------
+        # Attributes
 
-            elements = [].tap do |ee|
-              ee << url_str
-              next if params.empty?
+        attr_reader :method, :url_str, :headers, :log
 
-              ee << '?' unless url_str.include?('?')
-              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`.
@@ -115,7 +119,7 @@ module BerkeleyLibrary
 
       def should_escape?(b, mode)
         return false if unreserved?(b)
-        return false if ALLOWED_BYTES_BY_MODE[mode]&.include?(b)
+        return false if ALLOWED_BYTES_BY_MODE[mode].include?(b)
 
         true
       end

data/rakelib/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+require:
+  - rubocop-rake

data/spec/.rubocop.yml

@@ -1,5 +1,8 @@
 inherit_from: ../.rubocop.yml
 
+require:
+  - rubocop-rspec
+
 AllCops:
   # Exclude generated files
   Exclude:
@@ -38,3 +41,89 @@ Metrics/MethodLength:
 # Sometimes we're testing the operator
 Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: false
+
+############################################################
+# rubocop-rspec
+
+# believe me, it wasn't by choice
+RSpec/AnyInstance:
+  Enabled: false
+
+# we meant to do that
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+# more words != more readable
+RSpec/ContextWording:
+  Enabled: false
+
+# explicit >>> implicit
+RSpec/DescribedClass:
+  Enabled: false
+
+# more punctuation != more readable
+RSpec/DescribeSymbol:
+  Enabled: false
+
+# setup cost / time >>> failure granularity
+RSpec/ExampleLength:
+  Max: 15
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+# we meant to do that
+RSpec/ExpectInHook:
+  Enabled: false
+
+# your naming scheme is not in possession of all the facts
+RSpec/FilePath:
+  Enabled: false
+
+# explicit >>> implicit
+RSpec/InstanceVariable:
+  Enabled: false
+
+# maybe when 'all' has a corresponding 'none' matcher
+RSpec/IteratedExpectation:
+  Enabled: false
+
+# we meant to do that
+RSpec/MessageSpies:
+  Enabled: false
+
+# too late now
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+# setup cost / time >>> failure granularity
+RSpec/MultipleExpectations:
+  Enabled: false
+
+# cure is worse than the disease
+RSpec/NestedGroups:
+  Enabled: false
+
+# more quotation marks != more readable
+RSpec/SharedExamples:
+  Enabled: false
+
+# we meant to do that
+RSpec/StubbedMock:
+  Enabled: false
+
+# we meant to do that
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+############################################################
+# rubocop-rspec
+
+# enable newer rubocop-rspec cops
+
+RSpec/IdenticalEqualityAssertion: # new in 2.4
+  Enabled: true
+
+RSpec/Rails/AvoidSetupHook: # new in 2.4
+  Enabled: true

data/spec/berkeley_library/util/arrays_spec.rb

@@ -113,12 +113,13 @@ module BerkeleyLibrary::Util
         ]
         sources.each do |source|
           expect(Arrays.find_indices(for_array: source, in_array: target)).to be_nil
+          expect(Arrays.find_indices(for_array: source, in_array: target) { |s, t| t == s.to_s }).to be_nil
         end
       end
 
       it 'takes a comparison block' do
         sub = %i[a c e]
-        expect(Arrays.find_indices(for_array: sub, in_array: target) { |source, target| target == source.to_s }).to eq([0, 2, 4])
+        expect(Arrays.find_indices(for_array: sub, in_array: target) { |s, t| t == s.to_s }).to eq([0, 2, 4])
       end
     end
 
@@ -145,6 +146,10 @@ module BerkeleyLibrary::Util
         expect(Arrays.find_index(in_array: arr, start_index: 2) { |x| x < 4 }).to be_nil
       end
 
+      it 'raises ArgumentError if given extra arguments' do
+        expect { Arrays.find_index(1, 2, 3, in_array: [1, 2, 3]) }.to raise_error(ArgumentError)
+      end
+
       # rubocop:disable Lint/Void
       it 'returns an enumerator if given no arguments' do
         e = Arrays.find_index(in_array: arr)
@@ -327,6 +332,10 @@ module BerkeleyLibrary::Util
         expect(Arrays.invert([0, 2, 3])).to eq([0, nil, 1, 2])
       end
 
+      it 'returns nil if given nil' do
+        expect(Arrays.invert(nil)).to be_nil
+      end
+
       it 'fails if values are not ints' do
         # noinspection RubyYardParamTypeMatch
         expect { Arrays.invert(%i[a b c]) }.to raise_error(TypeError)

data/spec/berkeley_library/util/files_spec.rb

@@ -8,6 +8,7 @@ module BerkeleyLibrary
       attr_reader :tmpdir
 
       before { @tmpdir = Dir.mktmpdir(basename) }
+
       after { FileUtils.remove_entry(tmpdir) }
 
       describe :file_exists? do

data/spec/berkeley_library/util/stringios_spec.rb

@@ -16,6 +16,13 @@ module BerkeleyLibrary
           end
         end
 
+        it 'reads from the end if given a negative index' do
+          bytes.reverse.each_with_index do |b, i|
+            end_offset = i + 1
+            expect(StringIOs.getbyte(sio, -end_offset)).to eq(b)
+          end
+        end
+
         it 'resets the current offset' do
           StringIOs.getbyte(sio, bytes.size / 2)
           expect(sio.pos).to eq(0)

data/spec/berkeley_library/util/strings_spec.rb

@@ -41,6 +41,10 @@ module BerkeleyLibrary
           expect(Strings.diff_index(s, s)).to be_nil
         end
 
+        it 'returns nil for non-strings' do
+          expect(Strings.diff_index(2, ['2'])).to be_nil
+        end
+
         it 'returns the index for different strings' do
           s1 = 'elvis aaron presley'
           s2 = 'elvis nikita presley'

data/spec/berkeley_library/util/times_spec.rb

@@ -33,6 +33,10 @@ module BerkeleyLibrary
           # noinspection RubyYardParamTypeMatch
           expect { Times.ensure_utc(Object.new) }.to raise_error(ArgumentError)
         end
+
+        it 'returns nil for nil' do
+          expect(Times.ensure_utc(nil)).to be_nil
+        end
       end
     end
   end

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

@@ -97,6 +97,17 @@ module BerkeleyLibrary
             expect(result).to eq(expected_status)
           end
 
+          it 'appends query parameters to URL with existing params' do
+            url = 'https://example.org/endpoint?foo=bar'
+            params = { p1: 1, p2: 2 }
+            url_with_query = "#{url}&#{URI.encode_www_form(params)}"
+            expected_status = 203
+            stub_request(:head, url_with_query).to_return(status: expected_status)
+
+            result = Requester.head(url, params: params)
+            expect(result).to eq(expected_status)
+          end
+
           it 'sends request headers' do
             url = 'https://example.org/'
             headers = { 'X-help' => 'I am trapped in a unit test' }
@@ -129,6 +140,116 @@ module BerkeleyLibrary
             result = Requester.head(url1)
             expect(result).to eq(expected_status)
           end
+
+          it 'rejects a nil URI' do
+            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