dor-services-client 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ebc90d8d21ff990c42ec2836981cc9f9f58ecb0381a563b02beaa9f7f1c4192
-  data.tar.gz: a6c3e9486eb2b3bd734eec127721d8f17bbee913718e5038fa37b9910be0c2c2
+  metadata.gz: 86fea009a88a5fd765b3777f475a259d821988c26dfd9b5c25e9d041768f9280
+  data.tar.gz: f58cd9c866860b514e098966daf09b0606c43b4b980f2a169a983a434d0b65c5
 SHA512:
-  metadata.gz: 21e178424afe1d89adb1f2aa6f372eac45d3e5a04da66839494acb95780d370e50b09c26e43efe7d9093cb57940dab8c5306ee62b4a57763f9f4e558c88fc63a
-  data.tar.gz: 907c84790debd06e77586f9f636fcbdc9c2d621a266c54aeee920a2de7ef468c3de43b15eee0e9624a53e5c0f2b31bbac84de5612d1488c992a930e57c693493
+  metadata.gz: 2bde6be34744ecfc81a254e1e386130a7e1b6ba999cfed8189ad97d7652f407230b5e08299914c2118a59e10e42662099cb59cac28f48409b1352ddc647a4484
+  data.tar.gz: 803356f6b3acf1564014f305a1fcd696d2a9e6cb8763a4a6f2c5d4b9e174bf30a5405e32bab13ec969530501f1f124e8448851f46f9553924b02ba0a04c7630f

data/README.md

@@ -62,11 +62,14 @@ object_client.publish
 # Copy metadata from Symphony into descMetadata
 object_client.refresh_metadata
 object_client.notify_goobi
-object_client.current_version
-object_client.open_new_version(**params)
-object_client.close_version(**params)
-# Return the Dublin Core XML representation
+object_client.version.current
+object_client.version.openeable?(**params)
+object_client.version.open(**params)
+object_client.version.close(**params)
+# Get the Dublin Core XML representation
 object_client.metadata.dublin_core
+# Get the public descriptive XML representation
+object_client.metadata.descriptive
 object_client.files.retrieve(filename: filename_string)
 object_client.files.preserved_content(filename: filename_string, version: version_string)
 object_client.files.list

data/dor-services-client.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'moab-versioning', '~> 4.0'
   spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'zeitwerk', '~> 2.1'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'

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

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
-require 'dor/services/client/files'
-require 'dor/services/client/release_tags'
-require 'dor/services/client/sdr'
-require 'dor/services/client/workflow'
-require 'dor/services/client/workspace'
-require 'dor/services/client/metadata'
+require 'deprecation'
 
 module Dor
   module Services
     class Client
       # API calls that are about a repository object
       class Object < VersionedService
+        extend Deprecation
+
         attr_reader :object_identifier
 
         # @param object_identifier [String] the pid for the object
@@ -46,6 +43,10 @@ module Dor
           @release_tags ||= ReleaseTags.new(connection: connection, version: api_version, object_identifier: object_identifier)
         end
 
+        def version
+          @version ||= ObjectVersion.new(connection: connection, version: api_version, object_identifier: object_identifier)
+        end
+
         # Publish a new object
         # @raise [NotFoundResponse] when the response is a 404 (object not found)
         # @raise [UnexpectedResponse] when the response is not successful.
@@ -98,47 +99,20 @@ module Dor
           raise_exception_based_on_response!(resp)
         end
 
-        # Get the current_version for a DOR object. This comes from Dor::VersionMetadataDS
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] the version identifier
         def current_version
-          resp = connection.get do |req|
-            req.url "#{object_path}/versions/current"
-          end
-          return resp.body if resp.success?
-
-          raise_exception_based_on_response!(resp)
+          version.current
         end
+        deprecation_deprecate current_version: 'use version.current instead'
 
-        # Open new version for an object
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [MalformedResponse] when the response is not parseable.
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] the current version
         def open_new_version(**params)
-          version = open_new_version_response(**params)
-          raise MalformedResponse, "Version of #{object_identifier} is empty" if version.empty?
-
-          version
+          version.open(**params)
         end
+        deprecation_deprecate open_new_version: 'use version.open instead'
 
-        # Close current version for an object
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raise [UnexpectedResponse] when the response is not successful.
-        # @return [String] a message confirming successful closing
         def close_version(**params)
-          resp = connection.post do |req|
-            req.url close_version_path
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
-          end
-          return resp.body if resp.success?
-
-          raise_exception_based_on_response!(resp)
+          version.close(**params)
         end
+        deprecation_deprecate close_version: 'use version.close instead'
 
         private
 
@@ -150,30 +124,6 @@ module Dor
           raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
                 "#{response.reason_phrase}: #{response.status} (#{response.body})"
         end
-
-        # Make request to server to open a new version
-        # @param params [Hash] optional params (see dor-services-app)
-        # @raise [NotFoundResponse] when the response is a 404 (object not found)
-        # @raises [UnexpectedResponse] on an unsuccessful response from the server
-        # @returns [String] the plain text from the server
-        def open_new_version_response(**params)
-          resp = connection.post do |req|
-            req.url open_new_version_path
-            req.headers['Content-Type'] = 'application/json'
-            req.body = params.to_json if params.any?
-          end
-          return resp.body if resp.success?
-
-          raise_exception_based_on_response!(resp)
-        end
-
-        def open_new_version_path
-          "#{object_path}/versions"
-        end
-
-        def close_version_path
-          "#{object_path}/versions/current/close"
-        end
       end
     end
   end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Dor
+  module Services
+    class Client
+      # API calls that are about versions
+      class ObjectVersion < 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 the current version for a DOR object. This comes from Dor::VersionMetadataDS
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] the version identifier
+        def current
+          resp = connection.get do |req|
+            req.url "#{object_path}/versions/current"
+          end
+          return resp.body if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        # Determines if a new version can be opened for a DOR object.
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [Boolean] true if a new version can be opened
+        # rubocop:disable Metrics/MethodLength
+        def openeable?(**params)
+          resp = connection.get do |req|
+            req.url "#{object_path}/versions/openeable"
+            req.params = params
+          end
+
+          raise_exception_based_on_response!(resp) unless resp.success?
+
+          if resp.body == 'true'
+            true
+          elsif resp.body == 'false'
+            false
+          else
+            raise MalformedResponse, "Expected true or false, not #{resp.body}"
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # Open new version for an object
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [MalformedResponse] when the response is not parseable.
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] the current version
+        def open(**params)
+          version = open_new_version_response(**params)
+          raise MalformedResponse, "Version of #{object_identifier} is empty" if version.empty?
+
+          version
+        end
+
+        # Close current version for an object
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raise [UnexpectedResponse] when the response is not successful.
+        # @return [String] a message confirming successful closing
+        def close(**params)
+          resp = connection.post do |req|
+            req.url close_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
+          return resp.body if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        private
+
+        attr_reader :object_identifier
+
+        def object_path
+          "#{api_version}/objects/#{object_identifier}"
+        end
+
+        def raise_exception_based_on_response!(response)
+          raise (response.status == 404 ? NotFoundResponse : UnexpectedResponse),
+                "#{response.reason_phrase}: #{response.status} (#{response.body})"
+        end
+
+        # Make request to server to open a new version
+        # @param params [Hash] optional params (see dor-services-app)
+        # @raise [NotFoundResponse] when the response is a 404 (object not found)
+        # @raises [UnexpectedResponse] on an unsuccessful response from the server
+        # @returns [String] the plain text from the server
+        def open_new_version_response(**params)
+          resp = connection.post do |req|
+            req.url open_new_version_path
+            req.headers['Content-Type'] = 'application/json'
+            req.body = params.to_json if params.any?
+          end
+          return resp.body if resp.success?
+
+          raise_exception_based_on_response!(resp)
+        end
+
+        def open_new_version_path
+          "#{object_path}/versions"
+        end
+
+        def close_version_path
+          "#{object_path}/versions/current/close"
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Dor
   module Services
     class Client
-      VERSION = '1.8.0'
+      VERSION = '1.9.0'
     end
   end
 end

data/lib/dor/services/client.rb

@@ -1,15 +1,26 @@
 # frozen_string_literal: true
 
-require 'dor/services/client/version'
-require 'singleton'
-require 'faraday'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/module/delegation'
-require 'dor/services/client/versioned_service'
-require 'dor/services/client/object'
-require 'dor/services/client/objects'
-require 'dor/services/client/workflows'
-require 'dor/services/client/error_faraday_middleware'
+require 'faraday'
+require 'singleton'
+require 'zeitwerk'
+
+class DorServicesClientInflector < Zeitwerk::Inflector
+  def camelize(basename, _abspath)
+    case basename
+    when 'sdr'
+      'SDR'
+    else
+      super
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.new
+loader.inflector = DorServicesClientInflector.new
+loader.push_dir('lib')
+loader.setup
 
 module Dor
   module Services
@@ -88,6 +99,7 @@ module Dor
         @url || raise(Error, 'url has not yet been configured')
       end
 
+      # rubocop:disable  Metrics/AbcSize
       def connection
         @connection ||= Faraday.new(url) do |conn|
           conn.use ErrorFaradayMiddleware
@@ -101,6 +113,7 @@ module Dor
           conn.headers[token_header] = "Bearer #{token}" if token
         end
       end
+      # rubocop:enable  Metrics/AbcSize
 
       def user_agent
         "dor-services-client #{Dor::Services::Client::VERSION}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services-client
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Justin Coyne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -87,6 +87,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +196,7 @@ files:
 - lib/dor/services/client/files.rb
 - lib/dor/services/client/metadata.rb
 - lib/dor/services/client/object.rb
+- lib/dor/services/client/object_version.rb
 - lib/dor/services/client/objects.rb
 - lib/dor/services/client/release_tags.rb
 - lib/dor/services/client/sdr.rb