preservation-client 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d036c5889b48b53bcd21a9d86edbbcb1bfe0dee6664532d52ae4358ccb4253
-  data.tar.gz: 1f69f80a51334169011dbff4b2f612465d12733f38c0ba064ec1eee9d030bfc9
+  metadata.gz: c3e72f59fd17b0ef985fb4ede247f9c598aa729a57aee3df6cf3b03bb58df68d
+  data.tar.gz: 5b91b5227bfbeca9e0e1df2162fc66ef19ca871570ea9709a076d697b4b3295e
 SHA512:
-  metadata.gz: 0b48324d321045fd466bf52a766dea050ea0cb82bfef4d5456bea54fd80e48d917ea698e5d3729628c7d004fba90b8425dc383f741b0d376e96de1d99904571c
-  data.tar.gz: c23a295b93adc88877a125535c21126c865462bc49a6241e8f7511feb0fd6b4fb6e79e3f7af6f6a574e472bcdc82a9a085ad187e931e66638dab3887e04fba95
+  metadata.gz: fb5818a17c85a4cc2695ea369f7eae4fd499a7cced7334522d9e508f5cd0c11be78161d7547d1b5c28a33c0c99fef3dff6dedf9caf914b546b610c99be43fa23
+  data.tar.gz: a91fb05d81e242b25a0ffafd7f146e201b1774d7cc49d8d2c58d2cbbca2406303411d51e64908b9e022b8a4488b86da07b98fc2a22771b92a71128812b9fa0cb

data/README.md

@@ -25,6 +25,8 @@ Or install it yourself as:
 
 ## Usage
 
+Preservation::Client is a singleton object, and thus can be used as a class or an instance.
+
 ```ruby
 require 'preservation/client'
 
@@ -39,13 +41,28 @@ def client
 end
 ```
 
+OR
+
+```ruby
+require 'preservation/client'
+
+def initialize
+  Preservation::Client.configure(url: Settings.preservation_catalog.url)
+end
+
+def do_the_thing
+  current_version_as_integer = Preservation::Client.current_version('druid:oo000oo0000')
+end
+```
+
 Note that the client may **not** be used without first having been configured, and the `url` keyword is **required**.
 
 Note that the preservation service is behind a firewall.
 
 ## API Coverage
 
-druids may be with or without the "druid:" prefix - 'oo000oo0000' or 'druid:oo000oo0000'
+- druids may be with or without the "druid:" prefix - 'oo000oo0000' or 'druid:oo000oo0000'
+- methods can be called as `client_instance.objects.method` or `Preservation::Client.objects.method`
 
 ### Get the current version of a preserved object (Moab)
 
@@ -67,8 +84,7 @@ druids may be with or without the "druid:" prefix - 'oo000oo0000' or 'druid:oo00
 - `client.objects.metadata(druid: 'oo000oo0000', filepath: 'identityMetadata.xml')` - returns contents of identityMetadata.xml in most recent version of Moab object
   - You may specify the version:
     - `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, or new Moab::SignatureCatalog for Moab if none yet exists
-
+- `client.objects.signature_catalog('oo000oo0000')` - returns latest Moab::SignatureCatalog from Moab
 
 ### Get difference information between passed contentMetadata.xml and files in the Moab
 

data/lib/preservation/client/objects.rb

@@ -71,16 +71,10 @@ module Preservation
       end
 
       # convenience method for retrieving latest Moab::SignatureCatalog from a Moab object,
-      #  or a newly minted Moab::SignatureCatalog if it doesn't yet exist
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
-      # @return [Moab::SignatureCatalog] the catalog of all files previously ingested
+      # @return [Moab::SignatureCatalog] the manifest of all files previously ingested
       def signature_catalog(druid)
         Moab::SignatureCatalog.parse manifest(druid: druid, filepath: 'signatureCatalog.xml')
-      rescue Preservation::Client::UnexpectedResponseError => e
-        return Moab::SignatureCatalog.new(digital_object_id: druid, version_id: 0) if
-          e.message.match?('404 File Not Found')
-
-        raise
       end
 
       private

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '0.5.0'
+    VERSION = '1.0.0'
   end
 end

data/lib/preservation/client/versioned_api_service.rb

@@ -34,7 +34,7 @@ module Preservation
       rescue Faraday::ResourceNotFound => e
         errmsg = "HTTP GET to #{connection.url_prefix}#{req_url} failed with #{e.class}: #{e.message}"
         raise Preservation::Client::NotFoundError, errmsg
-      rescue Faraday::ParsingError, Faraday::RetriableResponse => e
+      rescue Faraday::Error => e
         errmsg = "HTTP GET to #{connection.url_prefix}#{req_url} failed with #{e.class}: #{e.message}"
         raise Preservation::Client::UnexpectedResponseError, errmsg
       end
@@ -42,36 +42,32 @@ module Preservation
       # @param path [String] path to be appended to connection url (no leading slash)
       # @param params [Hash] optional params
       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
+        http_response(:get, path, params)
       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
+        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
+      def http_response(method, path, params)
+        req_path = api_version.present? ? "#{api_version}/#{path}" : path
+        resp = connection.send(method, req_path, params)
         return resp.body if resp.success?
 
-        errmsg = ResponseErrorFormatter
-                 .format(response: resp, client_method_name: caller_locations.first.label)
+        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 POST to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+        errmsg = "HTTP #{method.to_s.upcase} to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
         raise Preservation::Client::NotFoundError, errmsg
-      rescue Faraday::ParsingError, Faraday::RetriableResponse => e
-        errmsg = "HTTP POST to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
+      rescue Faraday::Error => e
+        errmsg = "HTTP #{method.to_s.upcase} to #{connection.url_prefix}#{path} failed with #{e.class}: #{e.message}"
         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: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport