berkeley_library-util 0.1.4 → 0.1.6

data/spec/berkeley_library/util/uris_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 module BerkeleyLibrary::Util
   describe URIs do
     describe :append do
+      it 'rejects a nil URI' do
+        expect { URIs.append(nil, 'foo') }.to raise_error(ArgumentError)
+      end
+
       it 'appends paths' do
         original_uri = URI('https://example.org/foo/bar')
         new_uri = URIs.append(original_uri, 'qux', 'corge', 'garply')
@@ -16,16 +20,14 @@ module BerkeleyLibrary::Util
         expect(new_uri).to eq(expected_uri)
       end
 
-      # TODO: make this work
-      xit "doesn't append to a bare URI when there's nothing to append" do
+      it 'returns a bare URI when there\'s nothing to append' do
         original_url = 'https://example.org'
         new_uri = URIs.append(original_url)
         expected_uri = URI(original_url)
         expect(new_uri).to eq(expected_uri)
       end
 
-      # TODO: make this work
-      xit "doesn't append to a bare URI when there's only a query string" do
+      it 'appends to a bare URI even when there\'s only a query string' do
         original_url = 'https://example.org'
         new_uri = URIs.append(original_url, '?foo=bar')
         expected_uri = URI("#{original_url}?foo=bar")
@@ -94,29 +96,67 @@ module BerkeleyLibrary::Util
         expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?baz=qux#grault'))
       end
 
-      it 'rejects a query string if the original URI already has one' do
-        original_uri = URI('https://example.org/foo/bar?baz=qux')
-        expect { URIs.append(original_uri, '/qux?corge') }.to raise_error(URI::InvalidComponentError)
-      end
-
       it 'rejects a fragment if the original URI already has one' do
         original_uri = URI('https://example.org/foo/bar#baz')
         expect { URIs.append(original_uri, '/qux#corge') }.to raise_error(URI::InvalidComponentError)
       end
 
-      it 'rejects appending multiple queries' do
+      # Per RFC3986, "3.4. Query"
+      it 'allows queries containing ?' do
         original_uri = URI('https://example.org/foo/bar')
-        expect { URIs.append(original_uri, 'baz?qux=corge', 'grault?plugh=xyzzy') }.to raise_error(URI::InvalidComponentError)
+        expected_url = "#{original_uri}/baz?qux=corge?grault?plugh=xyzzy"
+        expected_uri = URI.parse(expected_url)
+
+        uri1 = URIs.append(original_uri, 'baz?qux=corge', '?grault?plugh=xyzzy')
+        expect(uri1).to eq(expected_uri)
+
+        uri2 = URIs.append(original_uri, 'baz?qux=corge?grault?plugh=xyzzy')
+        expect(uri2).to eq(expected_uri)
       end
 
-      it 'rejects appending multiple fragments' do
+      # Per RFC3986, "3.4. Query"
+      it 'allows queries containing /' do
+        original_uri = URI('https://example.org/foo/bar')
+        expected_url = "#{original_uri}/baz?qux=corge/grault/plugh=xyzzy"
+        expected_uri = URI.parse(expected_url)
+
+        uri1 = URIs.append(original_uri, 'baz?qux=corge', '/grault/plugh=xyzzy')
+        expect(uri1).to eq(expected_uri)
+
+        uri2 = URIs.append(original_uri, 'baz?qux=corge/grault/plugh=xyzzy')
+        expect(uri2).to eq(expected_uri)
+      end
+
+      it 'rejects fragments containing #' do
         original_uri = URI('https://example.org/foo/bar')
         expect { URIs.append(original_uri, 'baz#qux', 'grault#plugh') }.to raise_error(URI::InvalidComponentError)
+        expect { URIs.append(original_uri, 'baz#qux#plugh') }.to raise_error(URI::InvalidComponentError)
       end
 
-      it 'rejects queries after fragments' do
+      # Per RFC3986, "3.5. Fragment"
+      it 'allows fragments containing ?' do
         original_uri = URI('https://example.org/foo/bar')
-        expect { URIs.append(original_uri, 'baz#qux', '?grault=plugh') }.to raise_error(URI::InvalidComponentError)
+        expected_url = "#{original_uri}/baz#qux?grault=plugh"
+        expected_uri = URI.parse(expected_url)
+
+        uri1 = URIs.append(original_uri, 'baz#qux', '?grault=plugh')
+        expect(uri1).to eq(expected_uri)
+
+        uri2 = URIs.append(original_uri, 'baz#qux?grault=plugh')
+        expect(uri2).to eq(expected_uri)
+      end
+
+      # Per RFC3986, "3.5. Fragment"
+      it 'allows fragments containing /' do
+        original_uri = URI('https://example.org/foo/bar')
+        expected_url = "#{original_uri}/baz#qux/grault=plugh"
+        expected_uri = URI.parse(expected_url)
+
+        uri1 = URIs.append(original_uri, 'baz#qux', '/grault=plugh')
+        expect(uri1).to eq(expected_uri)
+
+        uri2 = URIs.append(original_uri, 'baz#qux/grault=plugh')
+        expect(uri2).to eq(expected_uri)
       end
 
       it 'correctly handles fragments in mid-path-segment' do
@@ -136,6 +176,28 @@ module BerkeleyLibrary::Util
         new_uri = URIs.append(original_uri, '?qux=corge', '&grault=plugh#xyzzy')
         expect(new_uri).to eq(URI('https://example.org/foo/bar?qux=corge&grault=plugh#xyzzy'))
       end
+
+      it 'rejects invalid characters' do
+        original_uri = URI('https://example.org/')
+        expect { URIs.append(original_uri, '精力善用') }.to raise_error(URI::InvalidComponentError)
+      end
+
+      it 'accepts percent-encoded path segments' do
+        original_uri = URI('https://example.org/')
+        encoded_segment = URIs.path_escape('精力善用')
+        new_uri = URIs.append(original_uri, encoded_segment, 'foo.html')
+        expected_url = "https://example.org/#{encoded_segment}/foo.html"
+        expect(new_uri).to eq(URI(expected_url))
+      end
+
+      it 'accepts path segments with allowed punctuation' do
+        original_uri = URI('https://example.org/')
+        path = 'foo/bar/baz@qux&corge=garply+grault$waldo/fred'
+        new_uri = URIs.append(original_uri, path, 'plugh')
+        expected_url = "#{original_uri}#{path}/plugh"
+        expect(new_uri).to eq(URI(expected_url))
+      end
+
     end
 
     describe 'requests' do
@@ -177,6 +239,42 @@ module BerkeleyLibrary::Util
           expect(response.code).to eq(404)
         end
       end
+
+      describe :head do
+        it 'makes a HEAD request' do
+          expected_status = 200
+          stub_request(:head, url_with_query).with(headers: headers).to_return(status: expected_status)
+
+          result = URIs.head(url, params: params, headers: headers)
+          expect(result).to eq(expected_status)
+        end
+
+        it 'returns the status even for unsuccessful requests' do
+          expected_status = 404
+          stub_request(:head, url_with_query).with(headers: headers).to_return(status: expected_status)
+
+          result = URIs.head(url, params: params, headers: headers)
+          expect(result).to eq(expected_status)
+        end
+      end
+
+      describe :head_response do
+        it 'makes a HEAD request' do
+          stub_request(:head, url_with_query).with(headers: headers).to_return(body: expected_body)
+
+          response = URIs.head_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(:head, url_with_query).with(headers: headers).to_return(status: 404, body: expected_body)
+
+          response = URIs.head_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
@@ -210,5 +308,50 @@ module BerkeleyLibrary::Util
         end
       end
     end
+
+    describe :path_escape do
+      let(:in_out) do
+        {
+          '' => '',
+          'corge' => 'corge',
+          'foo+bar' => 'foo+bar',
+          'qux/quux' => 'qux%2Fquux',
+          'foo bar baz' => 'foo%20bar%20baz',
+          'Corge-Grault.Fred_Waldo~Plugh' => 'Corge-Grault.Fred_Waldo~Plugh',
+          '25%' => '25%25',
+          "\t !\"#$%&'()*+,/:;<=>?@[\\]^`{|}☺" => '%09%20%21%22%23$%25&%27%28%29%2A+%2C%2F:%3B%3C=%3E%3F@%5B%5C%5D%5E%60%7B%7C%7D%E2%98%BA',
+          '精力善用' => '%E7%B2%BE%E5%8A%9B%E5%96%84%E7%94%A8'
+        }
+      end
+
+      it 'escapes a path segment' do
+        aggregate_failures do
+          in_out.each do |in_str, out_str|
+            expect(URIs.path_escape(in_str)).to eq(out_str)
+          end
+        end
+      end
+
+      it 'rejects non-strings' do
+        str = in_out.keys.last
+        expect { URIs.path_escape(str.bytes) }.to raise_error(ArgumentError)
+      end
+
+      it 'rejects non-UTF-8 strings' do
+        str = in_out.keys.last
+        expect { URIs.path_escape(str.encode(Encoding::Shift_JIS)) }.to raise_error(ArgumentError)
+      end
+
+      it 'accepts non-UTF-8 strings converted to UTF-8' do
+        in_str = in_out.keys.last
+        out_str = in_out[in_str]
+
+        # OK, we're really just testing String#encode here, but
+        # it's useful for documentation
+        in_str_sjis = in_str.encode(Encoding::Shift_JIS)
+        in_str_utf8 = in_str_sjis.encode(Encoding::UTF_8)
+        expect(URIs.path_escape(in_str_utf8)).to eq(out_str)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -13,8 +13,8 @@ RSpec.configure do |config|
   config.color = true
   config.tty = true
   config.formatter = :documentation
-  config.before(:each) { WebMock.disable_net_connect!(allow_localhost: true) }
-  config.after(:each) { WebMock.allow_net_connect! }
+  config.before { WebMock.disable_net_connect!(allow_localhost: true) }
+  config.after { WebMock.allow_net_connect! }
   config.mock_with :rspec do |mocks|
     mocks.verify_partial_doubles = true
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berkeley_library-util
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - David Moles
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: berkeley_library-logging
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: bundle-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: ci_reporter_rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,42 +128,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -206,20 +192,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.21'
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -271,7 +243,7 @@ files:
 - lib/berkeley_library/util/uris/appender.rb
 - lib/berkeley_library/util/uris/requester.rb
 - lib/berkeley_library/util/uris/validator.rb
-- rakelib/bundle.rake
+- rakelib/.rubocop.yml
 - rakelib/coverage.rake
 - rakelib/gem.rake
 - rakelib/rubocop.rake
@@ -290,7 +262,8 @@ files:
 homepage: https://github.com/BerkeleyLibrary/util
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -310,15 +283,4 @@ rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 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
-- spec/berkeley_library/util/times_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
-- spec/spec_helper.rb
+test_files: []

data/rakelib/bundle.rake

@@ -1,8 +0,0 @@
-namespace :bundle do
-  desc 'Updates the ruby-advisory-db then runs bundle-audit'
-  task :audit do
-    require 'bundler/audit/cli'
-    Bundler::Audit::CLI.start ['update']
-    Bundler::Audit::CLI.start %w[check --ignore CVE-2015-9284]
-  end
-end