preservation-client 3.2.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346519c8c530b30507578d91469ffd1f50cf08fe3b6b5f5e46905f35e6d870ab
-  data.tar.gz: 38afa1c113b86737ac3593101b3bfc1133de42bc58398de19250636bbdbefc05
+  metadata.gz: 859dd579bd9f390d624b4017952f76cd4f7ee652e24cd1a3e6a26ad997df921f
+  data.tar.gz: 210a26faa77c81accc7e694306e6b51f6ed61a6f2e4bf130a01f0e759b835792
 SHA512:
-  metadata.gz: 81c98f1a410de28f6c8bf90dff39c5537670aa4c8ce4625779d21bd8fbbe3c6341a0930f0fc8572a417d6fd1bd5cba4d69586deb402cf8d9d70e695114138306
-  data.tar.gz: 38e22150bc23cf59501893becb24a39c98eb51d8ac12b5acad80f0a8ad108381a6d9cf88a5f1120a32e9388cfc36c0d1e1dfea5c6cf8b3cf42de74e2c6bda5d7
+  metadata.gz: 1a69642114e5eae5c81bbbc5928e521b29fea8680005579ea7538ed9b9cbefc89c7ff6ce948cfcd4652e29d2f648f4643784ea2b0dbfb6dc3766a3f174db4c91
+  data.tar.gz: 5338f001b55fc8823164b9a11798cda7dc6910178a76b87dbdd529d86bf7e483e5ed1c3565b80d15c70533b645c4d72e6bcdfdf840f11a7ccef0c49694284979

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.7.1
+        environment:
+          CC_TEST_REPORTER_ID: 02e8afad8d0b699828dd69b6f45b598e7317b2d9828ea23380c3a97113068a0c
+          RAILS_ENV: test
+    steps:
+      - checkout
+      - run:
+          name: Install Bundler
+          command: gem install bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - run:
+          name: Lint using rubocop
+          command: bundle exec rubocop
+      - run:
+          name: Setup Code Climate test-reporter
+          command: |
+            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+            chmod +x ./cc-test-reporter
+            ./cc-test-reporter before-build
+      - run:
+          name: rspec
+          command: bundle exec rspec
+      - run:
+          name: upload test coverage report to Code Climate
+          command: ./cc-test-reporter after-build --coverage-input-type simplecov --exit-code $?

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/preservation-client.svg)](https://badge.fury.io/rb/preservation-client)
-[![Build Status](https://travis-ci.org/sul-dlss/preservation-client.svg?branch=master)](https://travis-ci.org/sul-dlss/preservation-client)
+[![CircleCI](https://circleci.com/gh/sul-dlss/preservation-client.svg?style=svg)](https://circleci.com/gh/sul-dlss/preservation-client)
 [![Maintainability](https://api.codeclimate.com/v1/badges/00d2d8957226777105b3/maintainability)](https://codeclimate.com/github/sul-dlss/preservation-client/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/00d2d8957226777105b3/test_coverage)](https://codeclimate.com/github/sul-dlss/preservation-client/test_coverage)
 
@@ -92,6 +92,10 @@ Note that the preservation service is behind a firewall.
 
 - `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
+
 ### 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'

data/lib/preservation/client/objects.rb

@@ -71,10 +71,20 @@ module Preservation
         file(druid, 'metadata', filepath, version)
       end
 
+      # calls the endpoint to queue a ValidateMoab job for a specific druid
+      # typically called by a preservationIngestWF robot
+      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' or 'ab123cd4567'
+      # @return [String] "ok" when job queued
+      # @raise [Preservation::Client::NotFoundError] when druid is not found
+      def validate_moab(druid:)
+        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

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '3.2.1'
+    VERSION = '3.5.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -25,14 +25,14 @@ module Preservation
 
         errmsg = ResponseErrorFormatter
                  .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound
         errmsg = "#{object_id} not found in Preservation at #{connection.url_prefix}#{req_url}"
-        raise Preservation::Client::NotFoundError, errmsg
+        raise NotFoundError, errmsg
       rescue Faraday::Error => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} for #{object_id} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       end
 
       # @param path [String] path to be appended to connection url (no leading slash)
@@ -83,18 +83,20 @@ module Preservation
             request_json = params.to_json if params&.any?
             connection.public_send(method, req_url, request_json, 'Content-Type' => 'application/json')
           end
+
         return resp.body if resp.success?
 
         errmsg = ResponseErrorFormatter.format(response: resp, client_method_name: caller_locations.first.label)
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        raise UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::NotFoundError, errmsg
+        raise NotFoundError, errmsg
       rescue Faraday::Error => e
         errmsg = "Preservation::Client.#{caller_locations.first.label} " \
           "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
-        raise Preservation::Client::UnexpectedResponseError, errmsg
+        exception_class = e.response[:status] == 423 ? LockedError : UnexpectedResponseError
+        raise exception_class, errmsg
       end
     end
   end

data/lib/preservation/client.rb

@@ -17,13 +17,18 @@ module Preservation
   class Client
     class Error < StandardError; end
 
-    # Error that is raised when the remote server returns a 404 Not Found
+    # Error raised when server returns 404 Not Found
     class NotFoundError < Error; end
 
-    # Error that is raised when the remote server returns some unexpected response
-    # e.g. 4xx or 5xx status
+    # Error raised when server returns 423 Locked
+    class LockedError < Error; end
+
+    # Error raised when server returns an unexpected response
+    # e.g., 4xx or 5xx status not otherwise handled
     class UnexpectedResponseError < Error; end
 
+    # Error raised when Faraday gem fails to connect, e.g., on SSL errors or
+    # timeouts
     class ConnectionFailedError < Error; end
 
     DEFAULT_API_VERSION = 'v1'

data/preservation-client.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 4.2', '< 7'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 8'
   spec.add_dependency 'faraday', '>= 0.15', '< 2.0'
   spec.add_dependency 'moab-versioning', '~> 4.3'
   spec.add_dependency 'zeitwerk', '~> 2.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2022-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -19,7 +19,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -184,12 +184,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.

data/.travis.yml

@@ -1,25 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-  - 2.6.4
-  - 2.7.1
-
-env:
-  jobs:
-    - RAILS_VERSION=5.2.3
-    - RAILS_VERSION=6.0.0
-  global:
-    - CC_TEST_REPORTER_ID=02e8afad8d0b699828dd69b6f45b598e7317b2d9828ea23380c3a97113068a0c
-
-before_install: gem install bundler -v 2.1.2
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
-
-notifications:
-  email: false