preservation-client 2.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2b61bc152d52b868d7274c7e29753dca42e4547f04c836766922bad0eca4ed9
-  data.tar.gz: 36f04a3919075d95729a6b74108f4acb9c5bb68f6625e4fc0e6b5a19f16fc52d
+  metadata.gz: 295c6b5719f6730587b25339215cb69a2a0577c83bb703cc0bc17bb0372b64e3
+  data.tar.gz: 26c60ca8f89488ed4d8e9ee301fb1632727ddb852ddaf4f2db796cf97f0a51f3
 SHA512:
-  metadata.gz: 7750ce3cd4ef6df3ffe47dfb8b1f693894dff7dc9ad776ade1d703447c8dc52ce00464ac780d9870c93dfbf5dddbe9bd5b7a6977aeebb80876112aa31e5773b4
-  data.tar.gz: 3a280db80ba0163894c8510238af78337866e853f09d3a528e097046d7f7c44d5f8f69805d5d67e993eafb76fc0cff9f3d53ca63ed1549941b3d72ceb7ff69fb
+  metadata.gz: 9d715a4987ea8c1091ba263eed8975feb66ab15e58669011860376a43ce7c80f7bbf771701f4416e9309fe7fb1dfa08e7986c0d7bf556bab939eab419e4c3fae
+  data.tar.gz: 2f27d27f5c0c02b0a9fb18943e5c25228e6e6d0f5ca24e190da9d7de20146f8f80d437f1351f659a627178ea52933c185aea811dcad6eff82586d6977ff6e733

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/.rubocop.yml

@@ -24,6 +24,5 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*'
 
-
 Style/WordArray:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,11 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-12-03 15:41:39 -0800 using RuboCop version 0.74.0.
+# on 2020-01-27 18:06:55 -0800 using RuboCop version 0.77.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: 3
+# Offense count: 2
 Metrics/AbcSize:
   Max: 34
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7

data/.travis.yml

@@ -3,12 +3,16 @@ cache: bundler
 rvm:
   - 2.5.3
   - 2.6.4
+  - 2.7.1
 
 env:
-  - "RAILS_VERSION=5.2.3"
-  - "RAILS_VERSION=6.0.0"
+  jobs:
+    - RAILS_VERSION=5.2.3
+    - RAILS_VERSION=6.0.0
+  global:
+    - CC_TEST_REPORTER_ID=02e8afad8d0b699828dd69b6f45b598e7317b2d9828ea23380c3a97113068a0c
 
-before_install: gem install bundler -v 2.0.2
+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

data/README.md

@@ -37,7 +37,7 @@ end
 private
 
 def client
-  @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url)
+  @client ||= Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
 end
 ```
 
@@ -47,7 +47,7 @@ OR
 require 'preservation/client'
 
 def initialize
-  Preservation::Client.configure(url: Settings.preservation_catalog.url)
+  Preservation::Client.configure(url: Settings.preservation_catalog.url, token: Settings.preservation_catalog.token)
 end
 
 def do_the_thing
@@ -55,7 +55,9 @@ def do_the_thing
 end
 ```
 
-Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**.
+Note that the client may **not** be used without first having been configured, and both the `url` and `token` keywords are **required**.
+
+See https://github.com/sul-dlss/preservation_catalog#api for info on obtaining a valid API token.
 
 Note that the preservation service is behind a firewall.
 
@@ -86,6 +88,10 @@ 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
+
 ### 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,16 +17,22 @@ 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'
+    TOKEN_HEADER = 'Authorization'
 
     include Singleton
 
@@ -42,8 +48,10 @@ module Preservation
 
     class << self
       # @param [String] url
-      def configure(url:)
+      # @param [String] token a bearer token for HTTP authentication
+      def configure(url:, token:)
         instance.url = url
+        instance.token = token
 
         # Force connection to be re-established when `.configure` is called
         instance.connection = nil
@@ -54,7 +62,7 @@ module Preservation
       delegate :objects, :update, to: :instance
     end
 
-    attr_writer :url, :connection
+    attr_writer :url, :connection, :token
     delegate :update, to: :catalog
 
     private
@@ -63,6 +71,10 @@ module Preservation
       @url || raise(Error, 'url has not yet been configured')
     end
 
+    def token
+      @token || raise(Error, 'auth token has not been configured')
+    end
+
     def connection
       @connection ||= Faraday.new(url) do |builder|
         builder.use ErrorFaradayMiddleware
@@ -70,6 +82,7 @@ module Preservation
         builder.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
         builder.adapter Faraday.default_adapter
         builder.headers[:user_agent] = user_agent
+        builder.headers[TOKEN_HEADER] = "Bearer #{token}"
       end
     end
 

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,15 @@ module Preservation
         file(druid, 'metadata', filepath, version)
       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 +93,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 = '2.2.0'
+    VERSION = '3.3.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,46 +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
-        resp = connection.send(method, req_url, params)
+        req_url = "#{api_version}/#{path}"
+        resp =
+          case method
+          when :delete, :get
+            connection.public_send(method, req_url, params)
+          when :patch, :post, :put
+            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/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: 2.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-15 00:00:00.000000000 Z
+date: 2020-07-02 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
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A thin client for getting info from SDR preservation.