dor-services-client 4.19.0 → 4.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3b14b9a11f5aaa8b7fac752631804445230b55b4d13e107ba477077700c8e3
-  data.tar.gz: cede3650b7cb865e6dc7ffb6ac9ebb3480e750df79fbb11ab41a45028d9d37f3
+  metadata.gz: 1c4981195f7d4860155b7e39a639d2d83a7203b3c69bef9155388ef1fa32a885
+  data.tar.gz: e091247d8646103a5f61afefbf18259f2d2d7153fea8886b908110b060907e3f
 SHA512:
-  metadata.gz: 74b37a4fa5ff0c6e3edbd363c80899f173c2e026d2747d688c3c570f14dcff61cebe9d179537fd4c33064317f7e6378f3862cf6dc8a01e7cc9e6250ac6fb5975
-  data.tar.gz: 835054c296a661d4a4a27f75fd8f15cd8aa52e2f40fc810bcc1e3fa21c76669b30c238b545420cf979591488994cb66aa9919442f5cf1682cf319f1319119db5
+  metadata.gz: ed6cffd6319bde37a13754b49a6e5b9ddcd234d126e8f0a6c3464464798f563796deba3a31c3f8d06bd691cfdca0dfa9f46b7f1948359ad56917519d60834e02
+  data.tar.gz: 4d044417251b88e091a1c5b45cefa4a0d3c53391f71fd83684aa025b64e2405d3fceef66c1fdbd682f1943159c71767f82518bf390897eeec8c512df74012cd7

data/README.md

@@ -138,8 +138,11 @@ object_client.members
 object_client.files.retrieve(filename: filename_string)
 object_client.files.list
 
-# Create and list administrative tags for an object
+# Create, update, destroy, and list administrative tags for an object
 object_client.administrative_tags.create(tags: ['Tag : One', 'Tag : Two'])
+object_client.administrative_tags.replace(tags: ['Tag : One', 'Tag : Two']) # like #create but removes current tags first
+object_client.administrative_tags.update(current: 'Current : Tag', new: 'Replacement : Tag')
+object_client.administrative_tags.destroy(tag: 'Delete : Me')
 object_client.administrative_tags.list
 
 # Create and list release tags for an object

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

@@ -12,6 +12,7 @@ module Dor
         end
 
         # Creates one or more administrative tags for an object
+        #
         # @param tags [Array<String>]
         # @return [Boolean] true if successful
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
@@ -27,7 +28,25 @@ module Dor
           true
         end
 
+        # Replaces one or more administrative tags for an object
+        #
+        # @param tags [Array<String>]
+        # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def replace(tags:)
+          resp = connection.post do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/administrative_tags"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { administrative_tags: tags, replace: true }.to_json
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          true
+        end
+
         # List administrative tags for an object
+        #
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] if the request is unsuccessful.
         # @return [Hash]
@@ -41,6 +60,39 @@ module Dor
           JSON.parse(resp.body)
         end
 
+        # Updates an administrative tag for an object
+        #
+        # @param current [String] current tag to update
+        # @param new [String] new tag to replace current tag
+        # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object or current tag not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def update(current:, new:)
+          resp = connection.put do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/administrative_tags/#{CGI.escape(current)}"
+            req.headers['Content-Type'] = 'application/json'
+            req.body = { administrative_tag: new }.to_json
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          true
+        end
+
+        # Destroys an administrative tag for an object
+        #
+        # @param tag [String] a tag to destroy
+        # @return [Boolean] true if successful
+        # @raise [NotFoundResponse] when the response is a 404 (object or current tag not found)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def destroy(tag:)
+          resp = connection.delete do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/administrative_tags/#{CGI.escape(tag)}"
+          end
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          true
+        end
+
         private
 
         attr_reader :object_identifier

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.19.0'
+      VERSION = '4.20.0'
     end
   end
 end

metadata

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