preservation-client 6.1.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1788f528479f4730cfe4fbf27ba42045edcd8cf6accb69dfec2fe53d43b9fc9b
-  data.tar.gz: b37d9db65f4b7239692f49a8ce64397450c4567c15019218df8fb5bace198ccc
+  metadata.gz: 9ea7074b6f7968d89b5fad106ff66fe8d15b5fa1d9995396bcafb05c348bb764
+  data.tar.gz: 0b724aabce34538335e7e1ec55fe62ad799d7d3c97c49e6e980f597ca3c05161
 SHA512:
-  metadata.gz: 3f2abb7844a26ecf8ab8901db3e613d26bf576c80b78f053ad3e3a3433e3c716f2795a090953087a1aad06ff454c992df394414971d119daa9d2716e905e6538
-  data.tar.gz: 0bbb46c34445482b3cadea06f6495454e9739b96e589933361a0aac900c23e40c11b96f65f3d740dc6881dde8b8ee3198f4508087b8d074dbfac8671b0084b37
+  metadata.gz: 0435faf772dfec04d6c53c9a9c7bf5700598b1bc0b9bbb77497bb65e2e81c819474ff421cfeef5bcbcb24bafe1436546513424e1e0f81e49432bd57fd56efd35
+  data.tar.gz: 403420c16c0f3224fe64b5a70c5ae1e80f4e80470a6a93e392abb375a8de60acced13630ebf51a49ea118874a73b101217cef8076a50ff61e7385340846f457f

data/.circleci/config.yml

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

data/.rubocop.yml

@@ -167,7 +167,7 @@ RSpec/IdenticalEqualityAssertion: # new in 2.4
   Enabled: true
 RSpec/SubjectDeclaration: # new in 2.5
   Enabled: true
-RSpec/FactoryBot/SyntaxMethods: # new in 2.7
+FactoryBot/SyntaxMethods: # new in 2.7
   Enabled: true
 RSpec/Rails/AvoidSetupHook: # new in 2.4
   Enabled: true
@@ -216,9 +216,98 @@ RSpec/ClassCheck: # new in 2.13
   Enabled: true
 RSpec/NoExpectationExample: # new in 2.13
   Enabled: true
-RSpec/Capybara/SpecificFinders: # new in 2.13
+Capybara/SpecificFinders: # new in 2.13
   Enabled: true
-RSpec/Capybara/SpecificMatcher: # new in 2.12
+Capybara/SpecificMatcher: # new in 2.12
   Enabled: true
 RSpec/Rails/HaveHttpStatus: # new in 2.12
   Enabled: true
+
+Gemspec/DevelopmentDependencies: # new in 1.44
+  Enabled: true
+Lint/DuplicateMagicComment: # new in 1.37
+  Enabled: true
+Lint/DuplicateMatchPattern: # new in 1.50
+  Enabled: true
+Lint/UselessRescue: # new in 1.43
+  Enabled: true
+Metrics/CollectionLiteralLength: # new in 1.47
+  Enabled: true
+Style/ArrayIntersect: # new in 1.40
+  Enabled: true
+Style/ComparableClamp: # new in 1.44
+  Enabled: true
+Style/ConcatArrayLiterals: # new in 1.41
+  Enabled: true
+Style/DataInheritance: # new in 1.49
+  Enabled: true
+Style/DirEmpty: # new in 1.48
+  Enabled: true
+Style/ExactRegexpMatch: # new in 1.51
+  Enabled: true
+Style/FileEmpty: # new in 1.48
+  Enabled: true
+Style/MapToSet: # new in 1.42
+  Enabled: true
+Style/MinMaxComparison: # new in 1.42
+  Enabled: true
+Style/OperatorMethodCall: # new in 1.37
+  Enabled: true
+Style/RedundantArrayConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantConstantBase: # new in 1.40
+  Enabled: true
+Style/RedundantDoubleSplatHashBraces: # new in 1.41
+  Enabled: true
+Style/RedundantEach: # new in 1.38
+  Enabled: true
+Style/RedundantFilterChain: # new in 1.52
+  Enabled: true
+Style/RedundantHeredocDelimiterQuotes: # new in 1.45
+  Enabled: true
+Style/RedundantLineContinuation: # new in 1.49
+  Enabled: true
+Style/RedundantRegexpConstructor: # new in 1.52
+  Enabled: true
+Style/RedundantStringEscape: # new in 1.37
+  Enabled: true
+Capybara/MatchStyle: # new in 2.17
+  Enabled: true
+Capybara/NegationMatcher: # new in 2.14
+  Enabled: true
+Capybara/SpecificActions: # new in 2.14
+  Enabled: true
+FactoryBot/AssociationStyle: # new in 2.23
+  Enabled: true
+FactoryBot/ConsistentParenthesesStyle: # new in 2.14
+  Enabled: true
+FactoryBot/FactoryAssociationWithStrategy: # new in 2.23
+  Enabled: true
+FactoryBot/FactoryNameStyle: # new in 2.16
+  Enabled: true
+FactoryBot/RedundantFactoryOption: # new in 2.23
+  Enabled: true
+RSpec/BeEmpty: # new in 2.20
+  Enabled: true
+RSpec/ContainExactly: # new in 2.19
+  Enabled: true
+RSpec/DuplicatedMetadata: # new in 2.16
+  Enabled: true
+RSpec/IndexedLet: # new in 2.20
+  Enabled: true
+RSpec/MatchArray: # new in 2.19
+  Enabled: true
+RSpec/PendingWithoutReason: # new in 2.16
+  Enabled: true
+RSpec/RedundantAround: # new in 2.19
+  Enabled: true
+RSpec/SkipBlockInsideExample: # new in 2.19
+  Enabled: true
+RSpec/SortMetadata: # new in 2.14
+  Enabled: true
+RSpec/Rails/InferredSpecType: # new in 2.14
+  Enabled: true
+RSpec/Rails/MinitestAssertions: # new in 2.17
+  Enabled: true
+RSpec/Rails/TravelAround: # new in 2.19
+  Enabled: true

data/.rubocop_todo.yml

@@ -1,19 +1,13 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-10-04 18:22:01 UTC using RuboCop version 1.36.0.
+# on 2023-06-20 05:20:15 UTC using RuboCop version 1.52.1.
 # 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: 2
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/preservation/client/versioned_api_service.rb'
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, Max.
-Metrics/CyclomaticComplexity:
-  Exclude:
-    - 'lib/preservation/client/versioned_api_service.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    preservation-client (6.1.0)
+    preservation-client (7.0.0)
       activesupport (>= 4.2, < 8)
       faraday (~> 2.0)
       moab-versioning (>= 5.0.0, < 7)
@@ -10,91 +10,99 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.2)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    base64 (0.1.1)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.0)
+    concurrent-ruby (1.2.2)
     crack (0.4.5)
       rexml
     diff-lcs (1.5.0)
     docile (1.4.0)
     druid-tools (3.0.0)
-    faraday (2.7.4)
+    faraday (2.7.10)
       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)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.17.0)
+    minitest (5.19.0)
     moab-versioning (6.1.0)
       druid-tools (>= 1.0.0)
       json
       nokogiri
       nokogiri-happymapper
-    nokogiri (1.14.1-x86_64-darwin)
+    nokogiri (1.15.4-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.14.1-x86_64-linux)
+    nokogiri (1.15.4-x86_64-linux)
       racc (~> 1.4)
     nokogiri-happymapper (0.9.0)
       nokogiri (~> 1.5)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     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)
+    public_suffix (5.0.3)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.2)
-    rexml (3.2.5)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.3)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.44.1)
+    rspec-support (3.12.1)
+    rubocop (1.56.1)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       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)
+      rubocop-ast (>= 1.28.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-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.18.1)
+    rubocop-rspec (2.23.2)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
-    ruby-progressbar (1.11.0)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -105,15 +113,17 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
-    webmock (3.18.1)
+    webmock (3.19.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.6.6)
+    zeitwerk (2.6.11)
 
 PLATFORMS
   x86_64-darwin-19
   x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -129,4 +139,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.4.6
+   2.4.13

data/README.md

@@ -31,7 +31,7 @@ Preservation::Client is a singleton object, and thus can be used as a class or a
 require 'preservation/client'
 
 def do_the_thing
-  current_version_as_integer = client.current_version('druid:oo000oo0000')
+  current_version_as_integer = client.objects.current_version('druid:oo000oo0000')
 end
 
 private
@@ -51,7 +51,7 @@ def initialize
 end
 
 def do_the_thing
-  current_version_as_integer = Preservation::Client.current_version('druid:oo000oo0000')
+  current_version_as_integer = Preservation::Client.objects.current_version('druid:oo000oo0000')
 end
 ```
 
@@ -72,8 +72,7 @@ Note that the preservation service is behind a firewall.
 
 ### Retrieve file signature (checksum) information
 
-- `client.objects.checksums(druids: druids)` - returns info as raw csv
-- `client.objects.checksums(druids: druids, format: 'json')` - returns info as json
+- `client.objects.checksum(druid: 'oo000oo0000')` - returns info as array of hashes
 
 ### Retrieve individual files from preservation
 

data/lib/preservation/client/objects.rb

@@ -8,11 +8,10 @@ module Preservation
   class Client
     # API calls that are about Preserved Objects
     class Objects < VersionedApiService
-      # @param [Array] druids - required list of druids with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
-      # @param [String] resp_format - desired format of the HTTP response (default csv, json also possible)
-      # @return body of HTTP response from Preservation API - the checksums and filesize for each druid
-      def checksums(druids: [], resp_format: 'csv')
-        post('objects/checksums', druids: druids, format: resp_format)
+      # @param [String] druid - with or without prefix: 'druid:bb123cd4567' OR 'bb123cd4567'
+      # @return [Hash] the checksums and filesize for the druid
+      def checksum(druid:)
+        get_json("objects/#{druid}/checksum", druid)
       end
 
       # @param [String] druid - with or without prefix: 'druid:bb123cd4567' OR 'bb123cd4567'

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '6.1.0'
+    VERSION = '7.0.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -21,7 +21,7 @@ module Preservation
           req.headers['Content-Type'] = 'application/json'
           req.headers['Accept'] = 'application/json'
         end
-        return JSON.parse(resp.body).with_indifferent_access if resp.success?
+        return with_indifferent_access_for(JSON.parse(resp.body)) if resp.success?
 
         errmsg = ResponseErrorFormatter
                  .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
@@ -109,6 +109,16 @@ module Preservation
           UnexpectedResponseError
         end
       end
+
+      def with_indifferent_access_for(obj)
+        if obj.is_a?(Array)
+          obj.map { |member| with_indifferent_access_for(member) }
+        elsif obj.is_a?(Hash)
+          obj.with_indifferent_access
+        else
+          obj
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -255,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.