berkeley_library-util 0.1.0

data/spec/berkeley_library/util/uris_spec.rb

@@ -0,0 +1,133 @@
+require 'spec_helper'
+
+module BerkeleyLibrary::Util
+  describe URIs do
+    describe :append do
+      it 'appends paths' do
+        original_uri = URI('https://example.org/foo/bar')
+        new_uri = URIs.append(original_uri, 'qux', 'corge', 'garply')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply'))
+      end
+
+      it 'does not modify the original URI' do
+        original_uri = URI('https://example.org/foo/bar')
+        original_url = original_uri.to_s
+        new_uri = URIs.append(original_uri, 'qux', 'corge', 'garply')
+        expect(new_uri).not_to be(original_uri)
+        expect(original_uri.to_s).to eq(original_url)
+      end
+
+      it 'removes extraneous slashes' do
+        original_uri = URI('https://example.org/foo/bar')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply'))
+      end
+
+      it 'preserves queries' do
+        original_uri = URI('https://example.org/foo/bar?baz=qux')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?baz=qux'))
+      end
+
+      it 'preserves fragments' do
+        original_uri = URI('https://example.org/foo/bar#baz')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply#baz'))
+      end
+
+      it 'accepts a query string if no previous query present' do
+        original_uri = URI('https://example.org/foo/bar#baz')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply?grault=xyzzy')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?grault=xyzzy#baz'))
+      end
+
+      it 'allows the ? to be passed separately' do
+        original_uri = URI('https://example.org/foo/bar#baz')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply', '?', 'grault=xyzzy')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?grault=xyzzy#baz'))
+      end
+
+      it 'appends query parameters with &' do
+        original_uri = URI('https://example.org/foo/bar#baz')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply?grault=xyzzy', '&plugh=flob')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?grault=xyzzy&plugh=flob#baz'))
+      end
+
+      it 'appends query parameters to original URI query' do
+        original_uri = URI('https://example.org/foo/bar/qux/corge/garply?grault=xyzzy')
+        new_uri = URIs.append(original_uri, '&plugh=flob')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply?grault=xyzzy&plugh=flob'))
+      end
+
+      it 'treats & as a path element if no query is present' do
+        original_uri = URI('https://example.org/foo/bar#baz')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', 'garply', '&plugh=flob')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux/corge/garply/&plugh=flob#baz'))
+      end
+
+      it 'accepts a fragment if no previous fragment present' do
+        original_uri = URI('https://example.org/foo/bar?baz=qux')
+        new_uri = URIs.append(original_uri, '/qux', '/corge/', '//garply#grault')
+        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
+        original_uri = URI('https://example.org/foo/bar')
+        expect { URIs.append(original_uri, 'baz?qux=corge', 'grault?plugh=xyzzy') }.to raise_error(URI::InvalidComponentError)
+      end
+
+      it 'rejects appending multiple fragments' do
+        original_uri = URI('https://example.org/foo/bar')
+        expect { URIs.append(original_uri, 'baz#qux', 'grault#plugh') }.to raise_error(URI::InvalidComponentError)
+      end
+
+      it 'rejects queries after fragments' do
+        original_uri = URI('https://example.org/foo/bar')
+        expect { URIs.append(original_uri, 'baz#qux', '?grault=plugh') }.to raise_error(URI::InvalidComponentError)
+      end
+
+      it 'correctly handles fragments in mid-path-segment' do
+        original_uri = URI('https://example.org/foo/bar')
+        new_uri = URIs.append(original_uri, 'qux#corge')
+        expect(new_uri).to eq(URI('https://example.org/foo/bar/qux#corge'))
+      end
+
+      it 'correctly handles fragments in query start' do
+        original_uri = URI('https://example.org/foo/bar')
+        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 'correctly handles fragments in mid-query' do
+        original_uri = URI('https://example.org/foo/bar')
+        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
+    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)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# ------------------------------------------------------------
+# Simplecov
+
+require 'colorize'
+require 'simplecov' if ENV['COVERAGE']
+
+# ------------------------------------------------------------
+# RSpec
+
+require 'webmock/rspec'
+
+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.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end
+
+# ------------------------------------------------------------
+# Code under test
+
+require 'berkeley_library/util'
+
+FileUtils.mkdir_p('log')
+BerkeleyLibrary::Logging.logger = BerkeleyLibrary::Logging::Loggers.new_readable_logger('log/test.log')

metadata

@@ -0,0 +1,321 @@
+--- !ruby/object:Gem::Specification
+name: berkeley_library-util
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Moles
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: berkeley_library-logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: typesafe_enum
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: A collection of miscellaneous Ruby routines for the UC Berkeley Library.
+email: dmoles@berkeley.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/util.iml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".simplecov"
+- ".yardopts"
+- CHANGES.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- berkeley_library-util.gemspec
+- lib/berkeley_library/util.rb
+- lib/berkeley_library/util/arrays.rb
+- lib/berkeley_library/util/module_info.rb
+- lib/berkeley_library/util/paths.rb
+- lib/berkeley_library/util/stringios.rb
+- lib/berkeley_library/util/strings.rb
+- lib/berkeley_library/util/sys_exits.rb
+- lib/berkeley_library/util/times.rb
+- lib/berkeley_library/util/uris.rb
+- 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/coverage.rake
+- rakelib/gem.rake
+- rakelib/rubocop.rake
+- rakelib/spec.rake
+- spec/.rubocop.yml
+- spec/berkeley_library/util/arrays_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
+homepage: https://github.com/BerkeleyLibrary/util
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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/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