dor-services-client 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea5ea717e4665296b50157a4e94dbd7e75071ed04e09d4e5aa10b4846f8d9faa
-  data.tar.gz: 8684e0c7b9585bfe8b5e9a2c1a6a27ebc1c8ceba1a441b9d5c3991531637ca41
+  metadata.gz: 5556939287e5a39750be249f7b5ce28ec900db9ba4a23f05eafd8756de12a76e
+  data.tar.gz: 9a7e832e1fc627b07e45694539f1b99e1eea17952511be10ed06717c12aa0765
 SHA512:
-  metadata.gz: 6248f504d3c8013e5983447c6e93678701da26ebf458899ab0b3a7027788395f215f4fc5a8f7e2b8501f0fd6400d20a762f7e5fd32b4fa97d04dac8885870400
-  data.tar.gz: d73dd8829103a0ae859f332b99773ef187cd89fbabfb0e87380f6c08ad2e4358927071b91678133407514321527c710a33b930e411533d07562474c0e9ed2a03
+  metadata.gz: 4275122ffdc7a3ff0d93cfea54eb124e17998e9731bd9ab94843fdc9b4a635b6d86d29b71bf857218f577a744b4e730a55f775e78d17b0b6391ba077128b0081
+  data.tar.gz: a1f01b4bc11b2756261a2e9bd79118856202057d93e6c05f4d4b980e4230bd3bc37ffbc90a1f08e701b1a6c14d9218881930633053c1e5c129acad5eee2f467b

data/README.md

@@ -126,6 +126,9 @@ object_client.files.retrieve(filename: filename_string)
 object_client.files.list
 object_client.release_tags.create(release: release, what: what, to: to, who: who)
 
+# Get the events for the object
+object_client.events.list
+
 # Create, remove, and reset workspaces
 object_client.workspace.create(source: object_path_string)
 object_client.workspace.cleanup

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support/json' # required for serializing time as iso8601
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about retrieving metadata
+      class Events < VersionedService
+        Event = Struct.new(:event_type, :data)
+
+        # @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
+
+        # @return [Array<Events>] The events for an object
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        def list
+          resp = connection.get do |req|
+            req.url "#{api_version}/objects/#{object_identifier}/events"
+          end
+          return response_to_models(resp) if resp.success?
+          return if resp.status == 404
+
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+        end
+
+        private
+
+        attr_reader :object_identifier
+
+        def response_to_models(resp)
+          JSON.parse(resp.body).map { |data| Event.new(event_type: data['event_type'], data: data['data']) }
+        end
+      end
+    end
+  end
+end

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

@@ -19,10 +19,11 @@ module Dor
         # @option opts [Hash] :rights Data for access rights metadata
         # @option opts [Hash] :content Data for structural metadata
         # @option opts [Hash] :technical Data for technical metadata
+        # @option opts [Hash] :provenance Data for provenance metadata
         # @example:
         #  legacy_update(descriptive: { updated: '2001-12-20', content: '<descMetadata />' })
         def legacy_update(opts)
-          opts = opts.slice(:descriptive, :rights, :content, :technical)
+          opts = opts.slice(:descriptive, :rights, :content, :technical, :provenance)
           resp = connection.patch do |req|
             req.url "#{base_path}/legacy"
             req.headers['Content-Type'] = 'application/json'

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

@@ -19,6 +19,10 @@ module Dor
           @metadata ||= Metadata.new(parent_params)
         end
 
+        def events
+          @events ||= Events.new(parent_params)
+        end
+
         def files
           @files ||= Files.new(parent_params)
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '4.3.0'
+      VERSION = '4.4.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2020-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -212,6 +212,7 @@ files:
 - lib/dor/services/client/collections.rb
 - lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb
+- lib/dor/services/client/events.rb
 - lib/dor/services/client/files.rb
 - lib/dor/services/client/marcxml.rb
 - lib/dor/services/client/metadata.rb