preservation-client 3.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5935f4397931242b724daedc842b1fdbdb8d84de5a0a61c0bd08b00064c4396
-  data.tar.gz: d9ffeef6b17897ebad03ddab8508c62caaa247a35ce380e4ba5b543cf8244a04
+  metadata.gz: 58f0246c9149fecf296ee74e4a533001fcc7d2d9c60cb656418a5bab7d0b7b14
+  data.tar.gz: 16c837b542784185434845ebe4543791cc323ff37c6eb697537b466d272797d8
 SHA512:
-  metadata.gz: 5afaae843e9fd36aac08b07d514e307993864222a60210e94537f3cfa25f278bd7eccbdc7af6c1bc90b9987ca0bce3e78330092408acc3bf125e6f9685fea28f
-  data.tar.gz: 4177db6c38c34714601a481ef8c6b4b89de04ce607ef766db3af6f136fd497675679a17080c1404fddc5c91a29d85ce2af1e18e09d5d0abcb9b10b47f3e1355d
+  metadata.gz: b554bb4b533d2aaef5041b60b56f60f2726a303201e28b717428ac0682760bb19771bc7a0abc4c75ae1e601df5ec393d6d47af4d6d50c2864c0bc0b593f2b492
+  data.tar.gz: c25a0c266e67fc4535db19df660571eb5fe2c6b097379c876127452780f39df9375091f87be32784c7b82f0e3fe381e573d6261ae154693381d182944f7a2c23

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/.github/pull_request_template.md

@@ -1,4 +1,12 @@
 ## Why was this change made?
 
 
-## Was the documentation (README, API, wiki, consul, etc.) updated?
+
+## How was this change tested?
+
+
+
+## Which documentation and/or configurations were updated?
+
+
+

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)
 
@@ -88,6 +88,14 @@ 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
+
 ### 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.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/lib/preservation/client/objects.rb

@@ -50,8 +50,9 @@ module Preservation
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @param [String] filepath - the path of the file relative to the moab content directory
       # @param [String] version - the version of the file requested (defaults to nil for latest version)
-      def content(druid:, filepath:, version: nil)
-        file(druid, 'content', filepath, version)
+      # @param [Proc] on_data a block, if provided is called to do streaming responses
+      def content(druid:, filepath:, version: nil, on_data: nil)
+        file(druid, 'content', filepath, version, on_data: on_data)
       end
 
       # retrieve a manifest file from a Moab object
@@ -70,6 +71,24 @@ 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
+
       # 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
@@ -83,10 +102,11 @@ module Preservation
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @param [String] category - one of 'manifest', 'metadata' or 'content'
       # @param [String] filepath - the path of the file relative to the moab category directory
-      # @param [String] version - the version of the file requested (defaults to nil for latest version)
+      # @param [String] version - the version of the file requested
+      # @param [Proc] on_data a block, if provided is called to do streaming responses
       # @return the retrieved file
-      def file(druid, category, filepath, version = nil)
-        get("objects/#{druid}/file", category: category, filepath: filepath, version: version)
+      def file(druid, category, filepath, version, on_data: nil)
+        get("objects/#{druid}/file", { category: category, filepath: filepath, version: version }, on_data: on_data)
       end
     end
   end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '3.1.0'
+    VERSION = '3.4.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -15,7 +15,7 @@ module Preservation
 
       # @param path [String] path to be appended to connection url (no leading slash)
       def get_json(path, object_id)
-        req_url = api_version.present? ? "#{api_version}/#{path}" : path
+        req_url = "#{api_version}/#{path}"
         resp = connection.get do |req|
           req.url req_url
           req.headers['Content-Type'] = 'application/json'
@@ -25,53 +25,78 @@ 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)
-      # @param params [Hash] optional params
-      def get(path, params)
-        http_response(:get, path, params)
+      # @param params [Hash] optional request parameters
+      # @param on_data [Proc] a callback to use when a streaming response is desired.
+      def get(path, params, on_data:)
+        return http_response(:get, path, params) unless on_data
+
+        connection.get("#{api_version}/#{path}", params) do |req|
+          req.options.on_data = on_data
+        end
       end
 
       # @param path [String] path to be appended to connection url (no leading slash)
-      # @param params [Hash] optional params
+      # @param params [Hash] optional request parameters
       def post(path, params)
         http_response(:post, path, params)
       end
 
-      # @param method [Symbol] :get or :post
       # @param path [String] path to be appended to connection url (no leading slash)
-      # @param params [Hash] optional params
+      # @param params [Hash] optional request parameters
+      def patch(path, params)
+        http_response(:patch, path, params)
+      end
+
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
+      def put(path, params)
+        http_response(:put, path, params)
+      end
+
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
+      def delete(path, params)
+        http_response(:delete, path, params)
+      end
+
+      # @param method [Symbol] a symbol representing an HTTP method: :get, :post, :patch, :put, :delete
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional request parameters
       def http_response(method, path, params)
-        req_url = api_version.present? ? "#{api_version}/#{path}" : path
+        req_url = "#{api_version}/#{path}"
         resp =
           case method
-          when :get
-            connection.get(req_url, params)
-          when :post
+          when :delete, :get
+            connection.public_send(method, req_url, params)
+          when :patch, :post, :put
             request_json = params.to_json if params&.any?
-            connection.post(req_url, request_json, 'Content-Type' => 'application/json')
+            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/preservation-client.gemspec

@@ -35,9 +35,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.77.0'
-  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0' # For CodeClimate
   spec.add_development_dependency 'webmock'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Naomi Dushay
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-29 00:00:00.000000000 Z
+date: 2021-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,16 +110,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -152,16 +152,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: webmock
   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
@@ -210,7 +210,7 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/sul-dlss/preservation-client
   source_code_uri: https://github.com/sul-dlss/preservation-client.
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,8 +225,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.19
+signing_key:
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.
 test_files: []

data/.travis.yml

@@ -1,21 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.3
-  - 2.6.4
-
-env:
-  - "RAILS_VERSION=5.2.3"
-  - "RAILS_VERSION=6.0.0"
-
-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