dor-services 6.8.0 → 7.0.0

data/lib/dor/services/version_service.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  # Open and close versions
-  class VersionService
-    def self.open(work, opts = {})
-      new(work).open(opts)
-    end
-
-    def self.close(work, opts = {})
-      new(work).close(opts)
-    end
-
-    def initialize(work)
-      @work = work
-    end
-
-    # Increments the version number and initializes versioningWF for the object
-    # @param [Hash] opts optional params
-    # @option opts [Boolean] :assume_accessioned If true, does not check whether object has been accessioned.
-    # @option opts [Boolean] :create_workflows_ds If false, create_workflow() will not initialize the workflows datastream.
-    # @option opts [Hash] :vers_md_upd_info If present, used to add to the events datastream and set the desc and significance on the versionMetadata datastream
-    # @raise [Dor::Exception] if the object hasn't been accessioned, or if a version is already opened
-    def open(opts = {})
-      # During local development, we need a way to open a new version even if the object has not been accessioned.
-      raise(Dor::Exception, 'Object net yet accessioned') unless
-        opts[:assume_accessioned] || Dor::Config.workflow.client.lifecycle('dor', work.pid, 'accessioned')
-      raise Dor::VersionAlreadyOpenError, 'Object already opened for versioning' if open?
-      raise Dor::Exception, 'Object currently being accessioned' if Dor::Config.workflow.client.active_lifecycle('dor', work.pid, 'submitted')
-
-      sdr_version = Sdr::Client.current_version work.pid
-
-      vmd_ds = work.versionMetadata
-      vmd_ds.sync_then_increment_version sdr_version
-      vmd_ds.save unless work.new_record?
-
-      k = :create_workflows_ds
-      if opts.key?(k)
-        # During local development, Hydrus (or another app w/ local Fedora) does not want to initialize workflows datastream.
-        CreateWorkflowService.create_workflow(work, name: 'versioningWF', create_ds: opts[k])
-      else
-        CreateWorkflowService.create_workflow(work, name: 'versioningWF')
-      end
-
-      vmd_upd_info = opts[:vers_md_upd_info]
-      return unless vmd_upd_info
-
-      work.events.add_event('open', vmd_upd_info[:opening_user_name], "Version #{vmd_ds.current_version_id} opened")
-      vmd_ds.update_current_version(description: vmd_upd_info[:description], significance: vmd_upd_info[:significance].to_sym)
-      work.save
-    end
-
-    # Sets versioningWF:submit-version to completed and initiates accessionWF for the object
-    # @param [Hash] opts optional params
-    # @option opts [String] :description describes the version change
-    # @option opts [Symbol] :significance which part of the version tag to increment
-    #  :major, :minor, :admin (see Dor::VersionTag#increment)
-    # @option opts [String] :version_num version number to archive rows with. Otherwise, current version is used
-    # @option opts [Boolean] :start_accesion set to true if you want accessioning to start (default), false otherwise
-    # @raise [Dor::Exception] if the object hasn't been opened for versioning, or if accessionWF has
-    #   already been instantiated or the current version is missing a tag or description
-    def close(opts = {})
-      unless opts.empty?
-        work.versionMetadata.update_current_version opts
-        work.versionMetadata.save
-      end
-
-      raise Dor::Exception, 'latest version in versionMetadata requires tag and description before it can be closed' unless work.versionMetadata.current_version_closeable?
-      raise Dor::Exception, 'Trying to close version on an object not opened for versioning' unless open?
-      raise Dor::Exception, 'accessionWF already created for versioned object' if Dor::Config.workflow.client.active_lifecycle('dor', work.pid, 'submitted')
-
-      Dor::Config.workflow.client.close_version 'dor', work.pid, opts.fetch(:start_accession, true) # Default to creating accessionWF when calling close_version
-    end
-
-    # @return [Boolean] true if 'opened' lifecycle is active, false otherwise
-    def open?
-      return true if Dor::Config.workflow.client.active_lifecycle('dor', work.pid, 'opened')
-
-      false
-    end
-
-    attr_reader :work
-  end
-end

data/lib/dor/utils/sdr_client.rb

@@ -1,94 +0,0 @@
-# frozen_string_literal: true
-
-require 'moab'
-module Sdr
-  class Client
-    extend Deprecation
-
-    class << self
-      # @param [String] druid id of the object you want the version of
-      # @return [Integer] the current version from SDR
-      def current_version(druid)
-        xml = client["objects/#{druid}/current_version"].get
-
-        begin
-          doc = Nokogiri::XML xml
-          raise if doc.root.name != 'currentVersion'
-
-          return Integer(doc.text)
-        rescue StandardError
-          raise "Unable to parse XML from SDR current_version API call: #{xml}"
-        end
-      end
-
-      # @param [String] dsname The identifier of the metadata datastream
-      # @return [String] The datastream contents from the previous version of the digital object (fetched from SDR storage)
-      def get_sdr_metadata(druid, dsname)
-        Deprecation.warn(self, 'Sdr::Client.get_sdr_metadata is deprecated and will be removed in dor-services 7. ' \
-                           'Use Dor::Services::Client.object(object_identifier).sdr.metadatra(datastream:) instead')
-
-        client["objects/#{druid}/metadata/#{dsname}.xml"].get
-      rescue RestClient::ResourceNotFound
-        nil
-      end
-
-      # @param [String] druid The object identifier
-      # @return [Moab::SignatureCatalog] the catalog of all files previously ingested
-      def get_signature_catalog(druid)
-        Deprecation.warn(self, 'Sdr::Client.get_signature_catalog is deprecated and will be removed in dor-services 7. ' \
-                           'Use Dor::Services::Client.object(object_identifier).sdr.signature_catalog instead')
-
-        response = client["objects/#{druid}/manifest/signatureCatalog.xml"].get
-        Moab::SignatureCatalog.parse(response)
-      rescue RestClient::ResourceNotFound
-        Moab::SignatureCatalog.new(digital_object_id: druid, version_id: 0)
-      end
-
-      # Retrieves file difference manifest for contentMetadata from SDR
-      #
-      # @param [String] druid The object identifier
-      # @param [String] current_content The contentMetadata xml
-      # @param [String] subset ('all') The keyword for file attributes 'shelve', 'preserve', 'publish'.
-      # @param [Integer, NilClass] version (nil)
-      # @return [Moab::FileInventoryDifference] the differences for the given content and subset (i.e.: cm_inv_diff manifest)
-      def get_content_diff(druid, current_content, subset = 'all', version = nil)
-        Deprecation.warn(self, 'Sdr::Client.get_content_diff is deprecated and will be removed in dor-services 7. ' \
-                           'Use Dor::Services::Client.object(object_identifier).sdr.content_diff(current_content:, subset:, version:) instead')
-
-        unless subset.is_a? String
-          Deprecation.warn(self, "subset parameter must be a string. You provided '#{subset.inspect}'. This will be an error in version 7")
-          subset = subset.to_s
-        end
-        raise Dor::ParameterError, "Invalid subset value: #{subset}" unless %w(all shelve preserve publish).include?(subset)
-
-        query_string = { subset: subset }
-        query_string[:version] = version.to_s unless version.nil?
-        query_string = URI.encode_www_form(query_string)
-        sdr_query = "objects/#{druid}/cm-inv-diff?#{query_string}"
-        response = client[sdr_query].post(current_content, content_type: 'application/xml')
-        Moab::FileInventoryDifference.parse(response)
-      end
-
-      # This was used by Argo but is no longer used anywhere
-      def get_preserved_file_content(druid, filename, version)
-        Deprecation.warn(self, 'Sdr::Client.get_preserved_file_content is deprecated and will be removed in dor-services 7. ' \
-                           'Use Dor::Services::Client.object(object_identifier).files.preserved_content(filename:, version:) instead')
-
-        client["objects/#{druid}/content/#{URI.encode(filename)}?version=#{version}"].get
-      end
-
-      def client
-        if Dor::Config.sdr.url
-          # dor-services-app takes this path
-          Dor::Config.sdr.rest_client
-        elsif Dor::Config.dor_services.url
-          # Anything that is not dor-servics-app should be through here.
-          Deprecation.warn(self, 'you are using dor-services to invoke calls to dor-services-app.  Use dor-services-client instead.')
-          Dor::Config.dor_services.rest_client['v1/sdr']
-        else
-          raise Dor::ParameterError, 'Missing Dor::Config.sdr and/or Dor::Config.dor_services configuration'
-        end
-      end
-    end
-  end
-end