dor-services-client 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98ce334358d0f3233121f562d96610339aa762e7758d3805a78fce94af96ae15
-  data.tar.gz: 72ca530a50cb19d8f37c9923942bcc222b4a19367ce760c638e1c9635adafbfa
+  metadata.gz: 6f1b9bc16853637725f55982999f804c6733175541a56e7902135e4f34e47180
+  data.tar.gz: 595126a2daaf676dd90f05bd990c12c52deca3d3f6ff93fd0ab9270adbd9fb85
 SHA512:
-  metadata.gz: 689c2c25b4409e7a84cd9dfe5ac956027e1c41acfd95abc6643da2f97256b714a89d48699a0a85f683eb01811c5b8f9a3f65e1a6dd9c75417213f77362562397
-  data.tar.gz: d40443664b067ce06f4050695746fc9e6f8099d756b3c9c664699b1474e61253169a31701bd54565c95aa5ead3c4463f8ee10b57ac816dcb913b06696eaf3c5f
+  metadata.gz: 8ce268a47a767ec0008e3f54430d259049cd5527d769ec7b821e8b5cac4e8e87f381dc89091272776bd4d80c7607ec5824b0dc8440414ae567f336e53944281e
+  data.tar.gz: e707b6b477457b37b08542fe7cd570222dcf088eefdabb35546a95c2d4061cb8b03602e6149b62f520a8611df3788eded6b8dc29fc36b8908be183798e624312

data/.rubocop_todo.yml

@@ -1,19 +1,19 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-12-18 09:21:53 -0800 using RuboCop version 0.60.0.
+# on 2019-09-03 08:11:02 -0500 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: 1
+# Offense count: 2
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
     - 'lib/dor/services/client.rb'
 
-# Offense count: 17
+# Offense count: 151
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:

data/.travis.yml

@@ -16,3 +16,6 @@ before_script:
   - ./cc-test-reporter before-build
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+
+notifications:
+  email: false

data/README.md

@@ -49,7 +49,7 @@ Note that the client may **not** be used without first having been configured, a
 
 ## API Coverage
 
-Dor::Services:Client provides a number of methods to simplify connecting to the RESTful HTTP API of dor-services-app. In this section we list all of the available methods, reflecting how much of the API the client covers:
+Dor::Services:Client provides a number of methods to simplify connecting to the RESTful HTTP API of dor-services-app. In this section we list all of the available methods, reflecting how much of the API the client covers. For details see the [API docs](https://www.rubydoc.info/github/sul-dlss/dor-services-client/master/Dor/Services/Client)
 
 ```ruby
 # For registering a non-existent object
@@ -58,8 +58,13 @@ objects_client.register(params: {})
 
 # For performing operations on a known, registered object
 object_client = Dor::Services::Client.object(object_identifier)
+
+# Publish an object
 object_client.publish
 
+# Update the MARC record
+object_client.update_marc_record
+
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_metadata
 
@@ -80,6 +85,13 @@ object_client.metadata.dublin_core
 
 # Get the public descriptive XML representation
 object_client.metadata.descriptive
+
+# Return the Cocina metadata
+object_client.find
+
+# Query for an objects collections
+object_client.collections
+
 object_client.files.retrieve(filename: filename_string)
 object_client.files.preserved_content(filename: filename_string, version: version_string)
 object_client.files.list
@@ -92,6 +104,9 @@ object_client.sdr.signature_catalog
 # Create and remove workspaces
 object_client.workspace.create(source: object_path_string)
 object_client.workspace.cleanup
+
+# Update embargo
+object_client.embargo.update(embargo_date: date_string, requesting_user: username_string)
 ```
 
 ## Development

data/dor-services-client.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.2', '< 7'
+  spec.add_dependency 'cocina-models', '~> 0.1.0'
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'moab-versioning', '~> 4.0'
   spec.add_dependency 'nokogiri', '~> 1.8'
@@ -32,5 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.61.0'
+  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'webmock'
 end

data/lib/dor/services/client.rb

@@ -6,6 +6,7 @@ require 'active_support/core_ext/object/blank'
 require 'faraday'
 require 'singleton'
 require 'zeitwerk'
+require 'cocina/models'
 
 class DorServicesClientInflector < Zeitwerk::Inflector
   def camelize(basename, _abspath)

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are queries about a particular object.
+      # This attempts to parallel the Valkyrie QueryService interface
+      # (e.g. https://github.com/samvera/valkyrie/blob/master/lib/valkyrie/persistence/memory/query_service.rb)
+      class Collections < 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
+
+        # Get a list of the collections. (Similar to Valkyrie's find_inverse_references_by)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # @return [Array<Cocina::Models::DRO>]
+        def collections
+          resp = connection.get do |req|
+            req.url "#{query_path}/collections"
+          end
+
+          return response_to_models(resp) if resp.success?
+
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp)
+        end
+
+        private
+
+        def response_to_models(resp)
+          JSON.parse(resp.body)['collections'].map { |data| Cocina::Models::DRO.new(data.symbolize_keys) }
+        end
+
+        def object_path
+          "#{api_version}/objects/#{object_identifier}"
+        end
+
+        def query_path
+          "#{object_path}/queries"
+        end
+
+        attr_reader :object_identifier
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: tru
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about managing embargo on a repository object
+      class Embargo < 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
+
+        # @param [String] embargo_date The date to update the embargo to (ISO 8601)
+        # @param [String] requesting_user Who is making this change.
+        #
+        # @example
+        #   client.update(embargo_date: '2099-10-20', requesting_user: 'jane')
+        #
+        # @raise [UnexpectedResponse] on an unsuccessful response from the server
+        #
+        # @return [NilClass] when the update is successful
+        def update(embargo_date:, requesting_user:)
+          resp = connection.patch do |req|
+            req.url path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = {
+              embargo_date: embargo_date,
+              requesting_user: requesting_user
+            }.to_json
+          end
+          return if resp.success?
+
+          raise UnexpectedResponse, ResponseErrorFormatter.format(response: resp, object_identifier: object_identifier)
+        end
+
+        private
+
+        attr_reader :object_identifier
+
+        def path
+          "#{api_version}/objects/#{object_identifier}/embargo"
+        end
+      end
+    end
+  end
+end

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

@@ -16,27 +16,52 @@ module Dor
         end
 
         def sdr
-          @sdr ||= SDR.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @sdr ||= SDR.new(parent_params)
         end
 
         def metadata
-          @metadata ||= Metadata.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @metadata ||= Metadata.new(parent_params)
         end
 
         def files
-          @files ||= Files.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @files ||= Files.new(parent_params)
         end
 
         def workspace
-          @workspace ||= Workspace.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @workspace ||= Workspace.new(parent_params)
         end
 
         def release_tags
-          @release_tags ||= ReleaseTags.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @release_tags ||= ReleaseTags.new(parent_params)
         end
 
         def version
-          @version ||= ObjectVersion.new(connection: connection, version: api_version, object_identifier: object_identifier)
+          @version ||= ObjectVersion.new(parent_params)
+        end
+
+        def embargo
+          @embargo ||= Embargo.new(parent_params)
+        end
+
+        # Retrieves the Cocina model
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [Cocina::Models::DRO] the returned model
+        def find
+          resp = connection.get do |req|
+            req.url object_path
+          end
+
+          return Cocina::Models::DRO.from_json(resp.body) if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        # Get a list of the collections. (Similar to Valkyrie's find_inverse_references_by)
+        # @raise [UnexpectedResponse] if the request is unsuccessful.
+        # @return [Array<Cocina::Models::DRO>]
+        def collections
+          Collections.new(parent_params).collections
         end
 
         # Publish a new object
@@ -52,7 +77,7 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        # Update the marc record for the give object
+        # Update the marc record for the given object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
         # @return [boolean] true on success
@@ -105,6 +130,10 @@ module Dor
 
         private
 
+        def parent_params
+          { connection: connection, version: api_version, object_identifier: object_identifier }
+        end
+
         def object_path
           "#{api_version}/objects/#{object_identifier}"
         end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '2.4.0'
+      VERSION = '2.5.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: cocina-models
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.61.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +206,8 @@ files:
 - bin/setup
 - dor-services-client.gemspec
 - lib/dor/services/client.rb
+- lib/dor/services/client/collections.rb
+- lib/dor/services/client/embargo.rb
 - lib/dor/services/client/error_faraday_middleware.rb
 - lib/dor/services/client/files.rb
 - lib/dor/services/client/metadata.rb
@@ -209,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A client for dor-services-app