preservation-client 4.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eee0269825cc3a5d9d0829cb77182adbc808bca2fe5d7dab6a7fc835d387e1d
-  data.tar.gz: b6bf9a6c5b2999beaece87a2501a31e8c436258f9dc44bd8c5eadf6e8fc9e520
+  metadata.gz: 37cef3d8d379f6c4f512f3612539aaf3df7a39ded00a94ef6a89ff1f0a37d77a
+  data.tar.gz: ed4a9e507f33b27bbc553ea134167c2f96d09f09ae04d0a68cd106061031ac40
 SHA512:
-  metadata.gz: '0855b28859c90a6a5f65d648434dc2895f2da1eb69cbebac0b0ebad90a451c71cd1122a3664ea073b64aa96fe945c26a358e8d756569d47b1180f56d79198ded'
-  data.tar.gz: b50c7d13f330e7cd5fcd3b651adc7570ced9db6c40c658d8f14f6f3dafc3d5e250f0ddf4088e3888a7e39e28c91406996770b21a718779b08e9e8688a2233ffb
+  metadata.gz: 064c59c79d1866cb8b1d75fe0e47caf15329f0e49704d2ed676ac4908214e84c535d13fbe65f2328083e4ed64b120bd8b8f27d5bc87cbbb03245bb4d4550d8a3
+  data.tar.gz: 193e07cbc0ba2b36fdd25a1aca99655b4996ad74e05c676d116f43dab640f1b80f99045be012f491b4165eb4a5c15810ef5063fb78302181a7d8e181f0514c7a

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2.1
 orbs:
-  ruby-rails: sul-dlss/ruby-rails@2.0.0
+  ruby-rails: sul-dlss/ruby-rails@3.1.2
 workflows:
   build:
     jobs:

data/.github/pull_request_template.md

@@ -1,12 +1,9 @@
-## Why was this change made?
+## Why was this change made? 🤔
 
 
 
-## How was this change tested?
-
-
-
-## Which documentation and/or configurations were updated?
+## How was this change tested? 🤨
 
+⚡ ⚠ If this change has cross service impact, run ***[integration test create_preassembly_image_spec.rb](https://github.com/sul-dlss/infrastructure-integration-test)*** on stage as it tests preservation, and/or test in stage environment, in addition to specs.⚡
 
 

data/.gitignore

@@ -8,6 +8,4 @@
 # rspec failure tracking
 .rspec_status
 
-Gemfile.lock
-
 .pry_history

data/.rubocop.yml

@@ -6,6 +6,21 @@ require:
 
 AllCops:
   TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  DisplayCopNames: true
+  Include:
+    - './Rakefile' # rake only
+    - '**/*.rb'
+    - '**/*.rake' # rake only
+  Exclude:
+    # autogenerated files (that we don't change) should go here
+    - 'bin/**/*'
+    - 'config/environments/*.rb' # rails only
+    - 'config/routes.rb' # rails only
+    - 'db/**/*' # rails only
+    - 'spec/spec_helper.rb'
+    - 'spec/rails_helper.rb' # rails only
+    - 'vendor/**/*' # gems only (?)
 
 Layout/EmptyLinesAroundClassBody:
   Enabled: false
@@ -24,6 +39,20 @@ Layout/LineLength:
 Metrics/MethodLength:
   Max: 25
 
+# do try to keep examples short (can you split out the setup from the test?)
+RSpec/ExampleLength:
+  Enabled: false
+
+# most tests should test a single thing
+RSpec/MultipleExpectations:
+  Max: 5 # default 1
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Max: 5 # default: 3
+
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
@@ -31,8 +60,6 @@ Style/Documentation:
 Style/WordArray:
   Enabled: false
 
-Gemspec/DateAssignment: # new in 1.10
-  Enabled: true
 Gemspec/RequireMFA: # new in 1.23
   Enabled: true
 Layout/LineEndStringConcatenationIndentation: # new in 1.18
@@ -144,3 +171,54 @@ RSpec/FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
+Gemspec/DeprecatedAttributeAssignment: # new in 1.30
+  Enabled: true
+Layout/LineContinuationLeadingSpace: # new in 1.31
+  Enabled: true
+Layout/LineContinuationSpacing: # new in 1.31
+  Enabled: true
+Lint/ConstantOverwrittenInRescue: # new in 1.31
+  Enabled: true
+Lint/NonAtomicFileOperation: # new in 1.31
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Style/EnvHome: # new in 1.29
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/MapCompactWithConditionalBlock: # new in 1.30
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+RSpec/BeEq: # new in 2.9.0
+  Enabled: true
+RSpec/BeNil: # new in 2.9.0
+  Enabled: true
+RSpec/ChangeByZero: # new in 2.11.0
+  Enabled: true
+RSpec/VerifiedDoubleReference: # new in 2.10.0
+  Enabled: true
+
+Lint/RequireRangeParentheses: # new in 1.32
+  Enabled: true
+Style/EmptyHeredoc: # new in 1.32
+  Enabled: true
+Style/MagicCommentFormat: # new in 1.35
+  Enabled: true
+RSpec/ClassCheck: # new in 2.13
+  Enabled: true
+RSpec/NoExpectationExample: # new in 2.13
+  Enabled: true
+RSpec/Capybara/SpecificFinders: # new in 2.13
+  Enabled: true
+RSpec/Capybara/SpecificMatcher: # new in 2.12
+  Enabled: true
+RSpec/Rails/HaveHttpStatus: # new in 2.12
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,92 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-01-14 04:40:44 UTC using RuboCop version 1.24.1.
+# on 2022-10-04 18:22:01 UTC using RuboCop version 1.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'preservation-client.gemspec'
-
 # Offense count: 2
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/preservation/client/versioned_api_service.rb'
 
 # Offense count: 1
-# Configuration parameters: IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/preservation/client/versioned_api_service.rb'
-
-# Offense count: 1
-# Configuration parameters: Prefixes.
-# Prefixes: when, with, without
-RSpec/ContextWording:
-  Exclude:
-    - 'spec/preservation/client_spec.rb'
-
-# Offense count: 2
-# Configuration parameters: Max, CountAsOne.
-RSpec/ExampleLength:
-  Exclude:
-    - 'spec/preservation/client/objects_spec.rb'
-    - 'spec/preservation/client_spec.rb'
-
-# Offense count: 1
-RSpec/IdenticalEqualityAssertion:
-  Exclude:
-    - 'spec/preservation/client_spec.rb'
-
-# Offense count: 4
-# Configuration parameters: Max.
-RSpec/MultipleExpectations:
-  Exclude:
-    - 'spec/preservation/client/objects_spec.rb'
-    - 'spec/preservation/client/response_error_formatter_spec.rb'
-    - 'spec/preservation/client_spec.rb'
-
-# Offense count: 66
-# Configuration parameters: AllowSubject, Max.
-RSpec/MultipleMemoizedHelpers:
-  Exclude:
-    - 'spec/preservation/client/catalog_spec.rb'
-    - 'spec/preservation/client/objects_spec.rb'
-    - 'spec/preservation/client/response_error_formatter_spec.rb'
-    - 'spec/preservation/client/versioned_api_service_spec.rb'
-
-# Offense count: 10
-# Configuration parameters: IgnoreSharedExamples.
-RSpec/NamedSubject:
-  Exclude:
-    - 'spec/preservation/client/versioned_api_service_spec.rb'
-
-# Offense count: 10
-# Configuration parameters: Max.
-RSpec/NestedGroups:
-  Exclude:
-    - 'spec/preservation/client/catalog_spec.rb'
-    - 'spec/preservation/client/versioned_api_service_spec.rb'
-
-# Offense count: 4
-# Cop supports --auto-correct.
-RSpec/ScatteredLet:
-  Exclude:
-    - 'spec/preservation/client/objects_spec.rb'
-
-# Offense count: 24
-RSpec/SubjectStub:
-  Exclude:
-    - 'spec/preservation/client/objects_spec.rb'
-
-# Offense count: 4
-# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
-RSpec/VerifiedDoubles:
-  Exclude:
-    - 'spec/preservation/client/response_error_formatter_spec.rb'

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    preservation-client (5.1.0)
+      activesupport (>= 4.2, < 8)
+      faraday (~> 2.0)
+      moab-versioning (>= 5.0.0, < 7)
+      zeitwerk (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    druid-tools (3.0.0)
+    faraday (2.7.2)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    hashdiff (1.0.1)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    minitest (5.17.0)
+    moab-versioning (5.2.0)
+      druid-tools (>= 1.0.0)
+      json
+      nokogiri
+      nokogiri-happymapper
+    nokogiri (1.14.0-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.0-x86_64-linux)
+      racc (~> 1.4)
+    nokogiri-happymapper (0.9.0)
+      nokogiri (~> 1.5)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.43.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.0)
+      rubocop (~> 1.33)
+      rubocop-capybara
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  preservation-client!
+  pry-byebug
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  rubocop (~> 1.24)
+  rubocop-rake
+  rubocop-rspec (~> 2.1)
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.4.4

data/README.md

@@ -88,10 +88,6 @@ Note that the preservation service is behind a firewall.
     - `client.objects.metadata(druid: 'oo000oo0000', filepath: 'identityMetadata.xml', version: '8')` - returns contents of identityMetadata.xml in version 8 of Moab object
 - `client.objects.signature_catalog('oo000oo0000')` - returns latest Moab::SignatureCatalog from Moab
 
-### Retrieve the primary moab storage location
-
-- `client.objects.primary_moab_location(druid: 'ooo000oo0000')` - returns the path to the storage location for the primary moab
-
 ### Validate the Moab
 
 - `client.objects.validate_moab(druid: 'ooo000oo0000')` - validates that the Moab object, used by preservationWF to ensure we have a valid Moab before replicating to various preservation endpoints
@@ -99,6 +95,7 @@ Note that the preservation service is behind a firewall.
 ### Get difference information between passed contentMetadata.xml and files in the Moab
 
 - `client.objects.content_inventory_diff(druid: 'oo000oo0000', content_metadata: '<contentMetadata>...</contentMetadata>')` - returns Moab::FileInventoryDifference containing differences between passed content metadata and latest version for subset 'all'
+
   - you may specify the subset (all|shelve|preserve|publish) and/or the version:
     - `client.objects.content_inventory_diff(druid: 'oo000oo0000', subset: 'publish', version: '1', content_metadata: '<contentMetadata>...</contentMetadata>')`
 
@@ -107,6 +104,7 @@ Note that the preservation service is behind a firewall.
 ### Alert the catalog that an object has been changed and needs to be updated
 
 - `client.update(druid: 'oo000oo0000', version: 3, size: 2342, storage_location: 'some/storage/location')` - returns true if it worked
+
 ## Development
 
 After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/preservation/client/objects.rb

@@ -80,15 +80,6 @@ module Preservation
         get("objects/#{druid}/validate_moab", {}, on_data: nil)
       end
 
-      # retrieve the storage location for the primary moab of the given druid
-      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' or 'ab123cd4567'
-      # @return [String] the storage location of the primary moab for the given druid
-      # @raise [Preservation::Client::NotFoundError] when druid is not found
-      # @raise [Preservation::Client::LockedError] when druid is in locked state (not available for versioning)
-      def primary_moab_location(druid:)
-        get("objects/#{druid}/primary_moab_location", {}, on_data: nil)
-      end
-
       # convenience method for retrieving latest Moab::SignatureCatalog from a Moab object,
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @return [Moab::SignatureCatalog] the manifest of all files previously ingested

data/lib/preservation/client/response_error_formatter.rb

@@ -4,9 +4,9 @@ module Preservation
   class Client
     # Format HTTP response-related errors
     class ResponseErrorFormatter
-      DEFAULT_BODY = 'Response from preservation-catalog did not contain a body. '\
-                     'Check honeybadger for preservation-catalog for backtraces, '\
-                     'and look into adding a `rescue_from` in preservation-catalog '\
+      DEFAULT_BODY = 'Response from preservation-catalog did not contain a body. ' \
+                     'Check honeybadger for preservation-catalog for backtraces, ' \
+                     'and look into adding a `rescue_from` in preservation-catalog ' \
                      'to provide more details to the client in the future.'
 
       def self.format(response:, object_id: nil, client_method_name: nil)

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '4.0.0'
+    VERSION = '5.1.0'
   end
 end

data/preservation-client.gemspec

@@ -27,11 +27,11 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.7' # 3.0 except for dor-services-app
+  spec.required_ruby_version = '>= 3.0'
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 8'
   spec.add_dependency 'faraday', '~> 2.0'
-  spec.add_dependency 'moab-versioning', '~> 5.0'
+  spec.add_dependency 'moab-versioning', '>= 5.0.0', '< 7'
   spec.add_dependency 'zeitwerk', '~> 2.1'
 
   spec.add_development_dependency 'bundler', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Naomi Dushay
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2023-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,16 +48,22 @@ dependencies:
   name: moab-versioning
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -213,6 +219,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -233,7 +240,7 @@ metadata:
   homepage_uri: https://github.com/sul-dlss/preservation-client
   source_code_uri: https://github.com/sul-dlss/preservation-client.
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -241,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -249,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.2.32
-signing_key:
+signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.
 test_files: []