preservation-client 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95721382a355768cd08ee0280fd57dc9d7e7db65190202babb259c4dce2fe48d
-  data.tar.gz: 198bd4efcd107026bbb864eb6ba5dc3ff058573139628bb90d864d97234700d7
+  metadata.gz: bd5473aaca131902c39dfed9a2f64f040f05fe058f88240a837bca61513e0aed
+  data.tar.gz: 0d4cabcf05268572e99869d5bb0919d94b7118d5ebf52a5de9a9acd50b1f1ca8
 SHA512:
-  metadata.gz: cdacd347e69f8b5df8ffdebe692a7557e69de103ae2aeed8a9b1de80753f0665bd85123a7d6badaefad975852185223a444685b075f29cb4d07c38feb008f1fe
-  data.tar.gz: ca8eb24ba43070a39e4b5ab625e31f48c07b7078123d5d6b5edf6cd0e908128230ac132ba8b20ccf0bf98b9968fb43cb219aea041a777a9e5fb724d1c13198b5
+  metadata.gz: c773deeb4f5106de43b9a8a87287ca6a87c3437419bbc25b2f208aee43c3f0de4c76a5835919aeecb2decc0f1458d5043337a9786f3ac5a71b4b5f2acf6de1d6
+  data.tar.gz: 95f6a7d7b736354ed67ab3dac8e5260d3cddd3dfa48486758e6ed926bc67f2101cdb61cf2ff60a6c0056f419eaa93b43d696ab58724c84faa01990ef51051ce3

data/.github/pull_request_template.md

@@ -0,0 +1,4 @@
+## Why was this change made?
+
+
+## Was the documentation (README, API, wiki, consul, etc.) updated?

data/.rubocop.yml

@@ -8,6 +8,7 @@ Layout/EmptyLinesAroundClassBody:
 
 Metrics/BlockLength:
   Exclude:
+    - 'preservation-client.gemspec'
     - 'spec/**/*'
 
 Metrics/LineLength:
@@ -23,3 +24,6 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'lib/preservation/client.rb'
+
+Style/WordArray:
+  Enabled: false

data/README.md

@@ -48,7 +48,9 @@ Note that the preservation service is behind a firewall.
 
 ## API Coverage
 
-TBD
+- 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
 
 ## Development
 

data/lib/preservation/client/objects.rb

@@ -3,7 +3,7 @@
 module Preservation
   class Client
     # API calls that are about Preserved Objects
-    class Objects < VersionedService
+    class Objects < VersionedApiService
 
       # @param [String] druid - with or without prefix: 'druid:ab123cd4567' OR 'ab123cd4567'
       # @return [Integer] the current version of the Preserved Object
@@ -11,6 +11,13 @@ module Preservation
         resp_body = get_json("objects/#{druid}.json", druid, 'current_version')
         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')
+      end
     end
   end
 end

data/lib/preservation/client/version.rb

@@ -2,6 +2,6 @@
 
 module Preservation
   class Client
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/preservation/client/{versioned_service.rb → versioned_api_service.rb}

@@ -3,7 +3,7 @@
 module Preservation
   class Client
     # @abstract API calls to a versioned endpoint
-    class VersionedService
+    class VersionedApiService
       def initialize(connection:, api_version:)
         @connection = connection
         @api_version = api_version
@@ -13,6 +13,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)
         resp = connection.get do |req|
           req.url api_version.present? ? "#{api_version}/#{path}" : path
@@ -31,6 +32,24 @@ module Preservation
         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, caller_method_name)
+        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)
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      rescue Faraday::ResourceNotFound => e
+        errmsg = "HTTP POST 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}"
+        raise Preservation::Client::UnexpectedResponseError, errmsg
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: preservation-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Naomi Dushay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2019-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -164,6 +164,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -180,7 +181,7 @@ files:
 - lib/preservation/client/objects.rb
 - lib/preservation/client/response_error_formatter.rb
 - lib/preservation/client/version.rb
-- lib/preservation/client/versioned_service.rb
+- lib/preservation/client/versioned_api_service.rb
 - preservation-client.gemspec
 homepage: https://github.com/sul-dlss/preservation-client
 licenses: []