dor-services-client 4.15.0 → 4.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 863e395fd563509f80c135875c0ab84a47e035502e8f9296737d9a7e1e963dc4
-  data.tar.gz: e21da87ef16016b30fbccb04ad34ce3fb26152d4fe639cfd79dc4f293a4643eb
+  metadata.gz: ddcb66b9e16f3e1f95ed1062d8a0841a6e806398eb103ce5738a72367529fff5
+  data.tar.gz: '090397a1d9d160f9b510dc4d1e343d4d9034726dfb4cc51e1355643d1cf05ffa'
 SHA512:
-  metadata.gz: 109d72ef302813ec49ec7a9fdbf8cfa293b4f42b3e4f9eac18653275a1e56fa4d78e882118f6a454c0d23f81bb9efb54615abd23fa89f086db91293307de1325
-  data.tar.gz: 1d0140b61e980c77e378a37233d0b43f4d06fe6742d9265f47211706c1e6a34e983b20d7821d0135b0eda2ba1b9344cba5d400e7d8e2993043ef9276b62730d2
+  metadata.gz: d5711db29593514d07bebe7fc4a68e4cb4ae702408a2b0f43d8cfa20f0abbd5a5b0ff97562656f074ef3945009ab765647614d01fbb8c174fa9ed207bded6d76
+  data.tar.gz: eae97208ee219e18531542d227469726f9c992760e3d92f7687b19f5629b116ac18a7b3c51dfc6650a32cbf5f07bfaa6384ba577f529b19b49726ddf968e67b0

data/.rspec

@@ -1,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/README.md

@@ -135,6 +135,10 @@ object_client.members
 object_client.files.retrieve(filename: filename_string)
 object_client.files.list
 
+# Create and list administrative tags for an object
+object_client.administrative_tags.create(tags: ['Tag : One', 'Tag : Two'])
+object_client.administrative_tags.list
+
 # 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

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # Interact with administrative tags endpoint for a given object
+      class AdministrativeTags < VersionedService
+        # @param object_identifier [String] the pid for the object
+        def initialize(connection:, version:, object_identifier:)
+          super(connection: connection, version: version)
+          @object_identifier = object_identifier
+        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)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        def create(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 }.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]
+        def list
+          resp = connection.get do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/administrative_tags"
+          end
+
+          raise_exception_based_on_response!(resp, object_identifier) unless resp.success?
+
+          JSON.parse(resp.body)
+        end
+
+        private
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

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

@@ -35,6 +35,10 @@ module Dor
           @release_tags ||= ReleaseTags.new(parent_params)
         end
 
+        def administrative_tags
+          @administrative_tags ||= AdministrativeTags.new(parent_params)
+        end
+
         def version
           @version ||= ObjectVersion.new(parent_params)
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.15.0'
+      VERSION = '4.16.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 4.15.0
+  version: 4.16.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -207,6 +207,7 @@ files:
 - bin/setup
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
+- lib/dor/services/client/administrative_tags.rb
 - lib/dor/services/client/async_result.rb
 - lib/dor/services/client/background_job_results.rb
 - lib/dor/services/client/collections.rb
@@ -244,7 +245,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