dor-services-client 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78cb3df1e3d97be3b57b992d7059683524baa1e55deedcc8e5e46ee2a6918a2b
-  data.tar.gz: 7a76faaefd3472f4b3c5151903e664a776a9decdcef97a2c3c59588779afad2f
+  metadata.gz: df42df85af44b22aa3cc0e5ae6ca8516b3aed6ebc4ab35f661f48380cc4daecf
+  data.tar.gz: d02b757c73b9875c60cb2f5edcd37e1d97fb1e30920d4119bf3eb6eaac5dd507
 SHA512:
-  metadata.gz: e3c57d81c115e47088341f60aa23d35a63576231b925a03857c6fba965ee7ee1e30e993a56f6615ffd9834a36d94166b2a471f7c5a71a50202b16b2ff1020a4a
-  data.tar.gz: f45e7147388edd1eeac604eb02a1899aa4215f79e6396c3815b9ed902c517731189ac3968868ac19a510b89c979fb3a972eeaf77be3d8f1ea53ce2f9a6b610ab
+  metadata.gz: ea9d7a9ffa4bead67be72b12a9cc8432a88466b32e859a99be4c90a5d66cc9a103eaa2baa1bb7e21c42d68eb23072ae2b3c8be0e047e85da66ab33f83fbcbbc6
+  data.tar.gz: eece297309acdb8979391c1f3d462c979a4d7c1d04f8888b32b9b39d332b979f39113bbdef425f55d5dfb81bb20d229b6e342a42c4e67a3234db0c4a11df44c3

data/.rubocop_todo.yml

@@ -1,19 +1,24 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-09-03 08:11:02 -0500 using RuboCop version 0.61.1.
+# on 2020-02-13 15:40:30 -0800 using RuboCop version 0.61.1.
 # 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
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/dor/services/client/marcxml.rb'
+
+# Offense count: 1
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/dor/services/client.rb'
 
-# Offense count: 151
+# Offense count: 256
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/README.md

@@ -132,11 +132,12 @@ object_client.collections
 object_client.files.retrieve(filename: filename_string)
 object_client.files.list
 
-# Set and list an object's release tags
+# Create and list release tags for an object
 object_client.release_tags.create(release: release, what: what, to: to, who: who)
 object_client.release_tags.list
 
-# Get the events for the object
+# Create and list events for an object
+object_client.events.create(type: type, data: data)
 object_client.events.list
 
 # Create, remove, and reset workspaces

data/lib/dor/services/client/collections.rb

@@ -23,7 +23,7 @@ module Dor
 
           return response_to_models(resp) if resp.success?
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         private

data/lib/dor/services/client/embargo.rb

@@ -31,7 +31,7 @@ module Dor
           end
           return if resp.success?
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         private

data/lib/dor/services/client/events.rb

@@ -15,7 +15,24 @@ module Dor
           @object_identifier = object_identifier
         end
 
-        # @return [Array<Events>] The events for an object
+        # @param type [String] a type for the event, e.g., publish, shelve
+        # @param data [Hash] an unstructured hash of event data
+        # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def create(type:, data:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/events"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { event_type: type, data: data }.to_json
+          end
+
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          true
+        end
+
+        # @return [Array<Event>,NilClass] The events for an object or nil if 404
         # @raise [UnexpectedResponse] on an unsuccessful response from the server
         def list
           resp = connection.get do |req|
@@ -24,7 +41,7 @@ module Dor
           return response_to_models(resp) if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         private

data/lib/dor/services/client/marcxml.rb

@@ -19,9 +19,11 @@ module Dor
           end
 
           return resp.body if resp.success? && resp.body.present?
-          raise NotFoundResponse if resp.success? && resp.body.blank?
 
-          raise_exception_based_on_response!(resp)
+          # This method needs its own exception handling logic due to how the endpoint service (SearchWorks) operates
+          raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if resp.success? && resp.body.blank?
+
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
         end
 
         # Gets MARCXML corresponding to a barcode or catkey
@@ -39,7 +41,12 @@ module Dor
             req.params['catkey'] = catkey unless catkey.nil?
           end
 
-          raise_exception_based_on_marcxml_response!(resp)
+          # This method needs its own exception handling logic due to how the endpoint service (Symphony) operates
+          #
+          # DOR Services App does not respond with a 404 when no match in Symphony.
+          # Rather, it responds with a 500 containing "Record not found in Symphony" in the body.
+          raise NotFoundResponse, ResponseErrorFormatter.format(response: resp) if !resp.success? && resp.body.match?(/Record not found in Symphony/)
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
 
           resp.body
         end
@@ -50,14 +57,6 @@ module Dor
           raise ArgumentError, 'Barcode or catkey must be provided' if barcode.nil? && catkey.nil?
           raise ArgumentError, 'Both barcode and catkey may not be provided' if !barcode.nil? && !catkey.nil?
         end
-
-        def raise_exception_based_on_marcxml_response!(resp)
-          # DOR Services App does not respond with a 404 when no match in Symphony.
-          # Rather, it responds with a 500 containing "Record not found in Symphony" in the body.
-          raise NotFoundResponse if !resp.success? && resp.body.match?(/Record not found in Symphony/)
-
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
-        end
       end
     end
   end

data/lib/dor/services/client/metadata.rb

@@ -31,7 +31,7 @@ module Dor
           end
           return if resp.success?
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         # @return [String, NilClass] The Dublin Core XML representation of the object or nil if response is 404
@@ -43,7 +43,7 @@ module Dor
           return resp.body if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         # @return [String, NilClass] The descriptive metadata XML representation of the object or nil if response is 404
@@ -55,7 +55,7 @@ module Dor
           return resp.body if resp.success?
           return if resp.status == 404
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+          raise_exception_based_on_response!(resp, object_identifier)
         end
 
         private

data/lib/dor/services/client/objects.rb

@@ -40,7 +40,7 @@ module Dor
           end
           return resp.body if resp.success?
 
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
+          raise_exception_based_on_response!(resp)
         end
       end
     end

data/lib/dor/services/client/release_tags.rb

@@ -16,8 +16,9 @@ module Dor
         # @param what [String]
         # @param to [String]
         # @param who [String]
-        # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
         # rubocop:disable Metrics/MethodLength
         def create(release:, what:, to:, who:)
           params = {
@@ -31,13 +32,14 @@ module Dor
             req.headers['Content-Type'] = 'application/json'
             req.body = params.to_json
           end
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
 
           true
         end
         # rubocop:enable Metrics/MethodLength
 
         # List new release tags for the object
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return [Hash] (see Dor::ReleaseTags::IdentityMetadata.released_for)
         def list
@@ -45,9 +47,9 @@ module Dor
             req.url "#{api_version}/objects/#{object_identifier}/release_tags"
           end
 
-          return JSON.parse(resp.body) if resp.success?
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
 
-          raise_exception_based_on_response!(resp)
+          JSON.parse(resp.body)
         end
 
         private

data/lib/dor/services/client/version.rb

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.12.0'
+      VERSION = '4.13.0'
     end
   end
 end

data/lib/dor/services/client/versioned_service.rb

@@ -19,9 +19,9 @@ module Dor
 
         attr_reader :connection, :api_version
 
-        def raise_exception_based_on_response!(response)
+        def raise_exception_based_on_response!(response, object_identifier = nil)
           raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
-                ResponseErrorFormatter.format(response: response)
+                ResponseErrorFormatter.format(response: response, object_identifier: object_identifier)
         end
       end
     end

data/lib/dor/services/client/workspace.rb

@@ -20,7 +20,7 @@ module Dor
             req.url workspace_path
             req.params['source'] = source
           end
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
         end
 
         # Cleans up a workspace
@@ -30,7 +30,7 @@ module Dor
           resp = connection.delete do |req|
             req.url workspace_path
           end
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
         end
 
         # After an object has been copied to preservation the workspace can be
@@ -41,7 +41,7 @@ module Dor
           resp = connection.post do |req|
             req.url "#{workspace_path}/reset"
           end
-          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp) unless resp.success?
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
         end
 
         private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,7 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app