preservation-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d54508719f54afb0229364f2e9deee3a765d14359b5b27bf3424470193d68c
-  data.tar.gz: 48642fbe62b2f68bf896ada3629a8e9e662e6e4e65a988fbcd49c0188f5f7487
+  metadata.gz: cb9503d9df7485a439b8f65ae7eb319dab3386e6cf316edc4c9d7f04793a8880
+  data.tar.gz: 39c772d761d5309ca4f8bf7910b044fdc6b11c079a9ccadb61e48b62e522f136
 SHA512:
-  metadata.gz: 8a10daad6e088616be9af53476d244c7fc7fc3a027db67f0197c0f19248962108f035ac70fda19386e9ac75babd234ea874741b4d90604346a44e6b49106e57b
-  data.tar.gz: 6991d66c54291b48ad76e5ac37b14200d965b4ec3e0bb5903bd2f9250619e6fd9ca2c53d6d579009e1db2a548a05649982d42d45b2cb86877ddb295290fa61c7
+  metadata.gz: d41e1ab66f52b1746a972983512321637de9081578cee2810214fe9d454337342d6903bef283172c4be934005cbc3109201ccfed3d19a9ab265f3a6c8684ab0d
+  data.tar.gz: 88d29967a9630ba8b693a4b551f6460233e8994b06365b1c6101f06c4239ed2d3e0ddb33ac2cd494931130aacd372135b5875e3e29b5eae6e39b54b1acef6583

data/README.md

@@ -94,6 +94,9 @@ Note that the preservation service is behind a firewall.
 
 - `client.objects.shelve_content_diff(druid: 'oo000oo0000', content_metadata: '<contentMetadata>...</contentMetadata>')` - returns Moab::FileGroupDifference containing differences between passed content metadata and latest version for subset 'shelve'
 
+### 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.rb

@@ -7,20 +7,8 @@ require 'faraday'
 require 'singleton'
 require 'zeitwerk'
 
-# Provides version exception to camels-case conversion
-class PreservationClientInflector < Zeitwerk::Inflector
-  def camelize(basename, _abspath)
-    case basename
-    when 'version'
-      'VERSION'
-    else
-      super
-    end
-  end
-end
-
 loader = Zeitwerk::Loader.new
-loader.inflector = PreservationClientInflector.new
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
 loader.push_dir(File.absolute_path("#{__FILE__}/../.."))
 loader.setup
 
@@ -38,7 +26,7 @@ module Preservation
 
     class ConnectionFailedError < Error; end
 
-    DEFAULT_API_VERSION = '' # should be v1 once PreservationCatalog has versioned API
+    DEFAULT_API_VERSION = 'v1'
 
     include Singleton
 
@@ -47,6 +35,11 @@ module Preservation
       @objects ||= Objects.new(connection: connection, api_version: DEFAULT_API_VERSION)
     end
 
+    # @return [Preservation::Client::Catalog] an instance of the `Client::Catalog` class
+    def catalog
+      @catalog ||= Catalog.new(connection: connection, api_version: DEFAULT_API_VERSION)
+    end
+
     class << self
       # @param [String] url
       def configure(url:)
@@ -58,10 +51,11 @@ module Preservation
         self
       end
 
-      delegate :objects, to: :instance
+      delegate :objects, :update, to: :instance
     end
 
     attr_writer :url, :connection
+    delegate :update, to: :catalog
 
     private
 
@@ -73,7 +67,7 @@ module Preservation
       @connection ||= Faraday.new(url) do |builder|
         builder.use ErrorFaradayMiddleware
         builder.use Faraday::Request::UrlEncoded
-
+        builder.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
         builder.adapter Faraday.default_adapter
         builder.headers[:user_agent] = user_agent
       end

data/lib/preservation/client/catalog.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Preservation
+  class Client
+    # API calls that are about the catalog
+    class Catalog < VersionedApiService
+      # @param [String] druid the object identifierx
+      # @param [Integer] version the version of the object
+      # @param [Integer] size the size of the object
+      # @param [String] storage_location the location of storage
+      def update(druid:, version:, size:, storage_location:)
+        http_args = {
+          druid: druid,
+          incoming_version: version,
+          incoming_size: size,
+          storage_location: storage_location,
+          checksums_validated: true
+        }
+
+        request(druid: druid, version: version, http_args: http_args)
+      end
+
+      private
+
+      def request(druid:, version:, http_args:)
+        result = if version == 1
+                   connection.post "/#{api_version}/catalog", http_args
+                 else
+                   connection.patch "/#{api_version}/catalog/#{druid}", http_args
+                 end
+        unless result.success?
+          raise UnexpectedResponseError, "response was not successful. Received status #{result.status}"
+        end
+
+        true
+      rescue Faraday::ClientError => e
+        raise UnexpectedResponseError, e
+      end
+    end
+  end
+end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -2,8 +2,6 @@
 
 module Preservation
   class Client
-    DEFAULT_API_VERSION = 'v1'
-
     # @abstract API calls to a versioned endpoint
     class VersionedApiService
       def initialize(connection:, api_version: DEFAULT_API_VERSION)
@@ -25,19 +23,15 @@ module Preservation
         end
         return JSON.parse(resp.body).with_indifferent_access if resp.success?
 
-        if resp.status == 404
-          errmsg = "#{object_id} not found in Preservation at #{connection.url_prefix}#{req_url}"
-          raise Preservation::Client::NotFoundError, errmsg
-        else
-          errmsg = ResponseErrorFormatter
-                   .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
-          raise Preservation::Client::UnexpectedResponseError, errmsg
-        end
-      rescue Faraday::ResourceNotFound => e
-        errmsg = "HTTP GET to #{connection.url_prefix}#{req_url} failed with #{e.class}: #{e.message}"
+        errmsg = ResponseErrorFormatter
+                 .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      rescue Faraday::ResourceNotFound
+        errmsg = "#{object_id} not found in Preservation at #{connection.url_prefix}#{req_url}"
         raise Preservation::Client::NotFoundError, errmsg
       rescue Faraday::Error => e
-        errmsg = "HTTP GET to #{connection.url_prefix}#{req_url} failed with #{e.class}: #{e.message}"
+        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
       end
 
@@ -57,19 +51,19 @@ module Preservation
       # @param path [String] path to be appended to connection url (no leading slash)
       # @param params [Hash] optional params
       def http_response(method, path, params)
-        req_path = api_version.present? ? "#{api_version}/#{path}" : path
-        resp = connection.send(method, req_path, params)
+        req_url = api_version.present? ? "#{api_version}/#{path}" : path
+        resp = connection.send(method, req_url, params)
         return resp.body if resp.success?
 
         errmsg = ResponseErrorFormatter.format(response: resp, client_method_name: caller_locations.first.label)
-        raise Preservation::Client::NotFoundError, errmsg if resp.status == 404
-
         raise Preservation::Client::UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound => e
-        errmsg = "HTTP #{method.to_s.upcase} to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        errmsg = "Preservation::Client.#{caller_locations.first.label} " \
+          "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
         raise Preservation::Client::NotFoundError, errmsg
       rescue Faraday::Error => e
-        errmsg = "HTTP #{method.to_s.upcase} to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        errmsg = "Preservation::Client.#{caller_locations.first.label} " \
+          "got #{e.response[:status]} from Preservation at #{req_url}: #{e.response[:body]}"
         raise Preservation::Client::UnexpectedResponseError, errmsg
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2019-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -191,6 +191,7 @@ files:
 - bin/console
 - bin/setup
 - lib/preservation/client.rb
+- lib/preservation/client/catalog.rb
 - lib/preservation/client/error_faraday_middleware.rb
 - lib/preservation/client/objects.rb
 - lib/preservation/client/response_error_formatter.rb