preservation-client 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40602017c072b2c6acf9ac778a53171a10102477e0783f42c18006b6783d3cc2
-  data.tar.gz: 8069794031fff97a91cfb4a8e43dab2f4112f01659d9157aa2347c1cbf06d70e
+  metadata.gz: 4a3cb6037f122064b3cdf68406c4115c396b37cd91a54c4ea81e2f47dbff1cf9
+  data.tar.gz: 2ab77f39a12d58589282865ff8f764f455b384f91d83a3eec334fe9c7943a100
 SHA512:
-  metadata.gz: a3caae88635c58bc4ff0fdee436cad522c3442855dbc9cde2ccdda6570a9ac310f27645e6171438cc29b102c69bcb9b94d5d75e06cec443b333d3cf885c5795e
-  data.tar.gz: 459b15285b9231257d0c28da3ba22a8f40942aed7f334f8aa8dc1aa83a6bfafd3137eb214a799cdd71fac4c6760df45987b1c1b45d7b5910de227cba407b1df9
+  metadata.gz: 6f57b21ddc5a6f4ed4935be2b5a156b08fe616c99972b7321c7af63c988190b8d75fd2f100714cfce70f61b457f388d8adfa896e151510c9672d42eed26ca6f4
+  data.tar.gz: b5bb602b1d94216dc7de1b2fe6a871be1f9e410c7261471794f1500f3217e0f2c380c4ab1170dadcd53244dd87aa59042c9f79ae17477d544f24a9cb29333306

data/.rubocop_todo.yml

@@ -1,11 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-09-25 11:19:34 -0700 using RuboCop version 0.74.0.
+# on 2019-12-03 15:41:39 -0800 using RuboCop version 0.74.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: 2
+# Offense count: 3
 Metrics/AbcSize:
-  Max: 31
+  Max: 34

data/.travis.yml

@@ -1,8 +1,3 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=02e8afad8d0b699828dd69b6f45b598e7317b2d9828ea23380c3a97113068a0c
-
-dist: bionic
 language: ruby
 cache: bundler
 rvm:

data/README.md

@@ -1,4 +1,4 @@
-[![Gem Version](https://badge.fury.io/rb/preservaton-client.svg)](https://badge.fury.io/rb/preservation-client)
+[![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)
 [![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)
@@ -51,6 +51,13 @@ Note that the preservation service is behind a firewall.
 - Preservation::Client.objects.current_version('oo000oo0000')  (can also be 'druid:oo000oo0000')
 - Preservation::Client.objects.checksums(druids: druids) - will return raw csv
 - Preservation::Client.objects.checksums(druids: druids, format: 'json') - will return json
+- Preservation::Client.objects.content(druid: 'oo000oo0000', filepath: 'my_file.pdf') - will return contents of my_file.pdf in most recent version of Moab object
+- Preservation::Client.objects.content(druid: 'oo000oo0000', filepath: 'my_file.pdf', version: '1') - will return contents of my_file.pdf in version 1 of Moab object
+- Preservation::Client.objects.manifest(druid: 'oo000oo0000', filepath: 'versionInventory.xml') - will return contents of versionInventory.xml in most recent version of Moab object
+- Preservation::Client.objects.manifest(druid: 'oo000oo0000', filepath: 'versionInventory.xml', version: '3') - will return contents of versionInventory.xml in version 3 of Moab object
+- Preservation::Client.objects.metadata(druid: 'oo000oo0000', filepath: 'identityMetadata.xml') - will return contents of identityMetadata.xml in most recent version of Moab object
+- Preservation::Client.objects.metadata(druid: 'oo000oo0000', filepath: 'identityMetadata.xml', version: '8') - will return contents of identityMetadata.xml in version 8 of Moab object
+- Preservation::Client.objects.signature_catalog(druid: 'oo000oo0000') - will return contents of latest version of signatureCatalog.xml from Moab object
 
 ## Development
 

data/lib/preservation/client/objects.rb

@@ -4,19 +4,60 @@ 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)
+      end
 
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @return [Integer] the current version of the Preserved Object
       def current_version(druid)
-        resp_body = get_json("objects/#{druid}.json", druid, 'current_version')
+        resp_body = get_json("objects/#{druid}.json", druid)
         resp_body[:current_version]
       end
 
-      # @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
-      def checksums(druids: [], resp_format: 'csv')
-        post('objects/checksums', { druids: druids, format: resp_format }, 'checksums')
+      # retrieve a content file from a Moab object
+      # @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)
+      end
+
+      # retrieve a manifest file from a Moab object
+      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
+      # @param [String] filepath - the path of the file relative to the moab manifest directory
+      # @param [String] version - the version of the file requested (defaults to nil for latest version)
+      def manifest(druid:, filepath:, version: nil)
+        file(druid, 'manifest', filepath, version)
+      end
+
+      # retrieve a metadata file from a Moab object
+      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
+      # @param [String] filepath - the path of the file relative to the moab metadata directory
+      # @param [String] version - the version of the file requested (defaults to nil for latest version)
+      def metadata(druid:, filepath:, version: nil)
+        file(druid, 'metadata', filepath, version)
+      end
+
+      # convenience method for retrieving latest signatureCatalog.xml file from a Moab object
+      # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
+      def signature_catalog(druid)
+        manifest(druid: druid, filepath: 'signatureCatalog.xml')
+      end
+
+      private
+
+      # get a file from a Moab object
+      # @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)
+      # @return the retrieved file
+      def file(druid, category, filepath, version = nil)
+        get("objects/#{druid}/file", category: category, filepath: filepath, version: version)
       end
     end
   end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '0.2.2'
+    VERSION = '0.3.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -14,7 +14,7 @@ module Preservation
       attr_reader :connection, :api_version
 
       # @param path [String] path to be appended to connection url (no leading slash)
-      def get_json(path, object_id, caller_method_name)
+      def get_json(path, object_id)
         req_url = api_version.present? ? "#{api_version}/#{path}" : path
         resp = connection.get do |req|
           req.url req_url
@@ -28,7 +28,7 @@ module Preservation
           raise Preservation::Client::NotFoundError, errmsg
         else
           errmsg = ResponseErrorFormatter
-                   .format(response: resp, object_id: object_id, client_method_name: caller_method_name)
+                   .format(response: resp, object_id: object_id, client_method_name: caller_locations.first.label)
           raise Preservation::Client::UnexpectedResponseError, errmsg
         end
       rescue Faraday::ResourceNotFound => e
@@ -41,13 +41,31 @@ module Preservation
 
       # @param path [String] path to be appended to connection url (no leading slash)
       # @param params [Hash] optional params
-      def post(path, params, caller_method_name)
+      def get(path, params)
+        get_path = api_version.present? ? "#{api_version}/#{path}" : path
+        resp = connection.get get_path, params
+        return resp.body if resp.success?
+
+        errmsg = ResponseErrorFormatter
+                 .format(response: resp, client_method_name: caller_locations.first.label)
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      rescue Faraday::ResourceNotFound => e
+        errmsg = "HTTP GET to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        raise Preservation::Client::NotFoundError, errmsg
+      rescue Faraday::ParsingError, Faraday::RetriableResponse => e
+        errmsg = "HTTP GET to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      end
+
+      # @param path [String] path to be appended to connection url (no leading slash)
+      # @param params [Hash] optional params
+      def post(path, params)
         post_path = api_version.present? ? "#{api_version}/#{path}" : path
         resp = connection.post post_path, params
         return resp.body if resp.success?
 
         errmsg = ResponseErrorFormatter
-                 .format(response: resp, client_method_name: caller_method_name)
+                 .format(response: resp, client_method_name: caller_locations.first.label)
         raise Preservation::Client::UnexpectedResponseError, errmsg
       rescue Faraday::ResourceNotFound => e
         errmsg = "HTTP POST to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport