dor-services 6.8.0 → 7.0.0

data/lib/dor/models/concerns/itemizable.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'uri'
-
-module Dor
-  module Itemizable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'contentMetadata', type: Dor::ContentMetadataDS, label: 'Content Metadata', control_group: 'M'
-    end
-
-    DIFF_FILENAME = 'cm_inv_diff'
-
-    # Deletes all cm_inv_diff files in the workspace for the Item
-    def clear_diff_cache
-      raise ArgumentError, 'Missing Dor::Config.stacks.local_workspace_root' if Dor::Config.stacks.local_workspace_root.nil?
-
-      druid = DruidTools::Druid.new(pid, Dor::Config.stacks.local_workspace_root)
-      diff_pattern = File.join(druid.temp_dir, DIFF_FILENAME + '.*')
-      FileUtils.rm_f Dir.glob(diff_pattern)
-    end
-    deprecation_deprecate clear_diff_cache: 'No longer used by any DLSS code and will be removed without replacement'
-
-    # Retrieves file difference manifest for contentMetadata from SDR
-    #
-    # @param [Symbol] subset keyword for file attributes :shelve, :preserve, :publish. Default is :all.
-    # @param [String] version
-    # @return [Moab::FileInventoryDifference] XML contents of cm_inv_diff manifest
-    def get_content_diff(subset = :all, version = nil)
-      raise Dor::ParameterError, 'Missing Dor::Config.stacks.local_workspace_root' if Dor::Config.stacks.local_workspace_root.nil?
-
-      raise Dor::Exception, 'Missing contentMetadata datastream' if !respond_to?(:contentMetadata) || contentMetadata.nil?
-
-      Sdr::Client.get_content_diff(pid, contentMetadata.content, subset.to_s, version)
-    end
-    deprecation_deprecate get_content_diff: 'Use Sdr::Client.get_content_diff instead'
-  end
-end

data/lib/dor/models/concerns/preservable.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Preservable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'provenanceMetadata', type: ProvenanceMetadataDS, label: 'Provenance Metadata'
-    end
-
-    # This is invoked by Robots::DorRepo::Accession::ProvenanceMetadata in common-accessioning
-    # as well as Argo's ItemsController#fix_missing_provenance
-    def build_provenanceMetadata_datastream(workflow_id, event_text)
-      workflow_provenance = create_workflow_provenance(workflow_id, event_text)
-      ds = datastreams['provenanceMetadata']
-      ds.label ||= 'Provenance Metadata'
-      ds.ng_xml = workflow_provenance
-      ds.save
-    end
-
-    def sdr_ingest_transfer(agreement_id)
-      SdrIngestService.transfer(self, agreement_id)
-    end
-    deprecation_deprecate sdr_ingest_transfer: 'Use SdrIngestService.transfer instead'
-
-    private
-
-    # @return [Nokogiri::Document]
-    def create_workflow_provenance(workflow_id, event_text)
-      builder = Nokogiri::XML::Builder.new do |xml|
-        xml.provenanceMetadata(objectId: pid) do
-          xml.agent(name: 'DOR') do
-            xml.what(object: pid) do
-              xml.event(who: "DOR-#{workflow_id}", when: Time.new.iso8601) do
-                xml.text(event_text)
-              end
-            end
-          end
-        end
-      end
-      builder.doc
-    end
-  end
-end

data/lib/dor/models/concerns/processable.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require 'equivalent-xml'
-
-module Dor
-  module Processable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'workflows',
-                   type: Dor::WorkflowDs,
-                   label: 'Workflows',
-                   control_group: 'E',
-                   autocreate: true
-    end
-
-    STEPS = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('STEPS', 'Dor::StatusService::STEPS')
-
-    # The ContentMetadata and DescMetadata robot are allowed to build the
-    # datastream by reading a file from the /dor/workspace that matches the
-    # datastream name. This allows assembly or pre-assembly to prebuild the
-    # datastreams from templates or using other means
-    # (like the assembly-objectfile gem) and then have those datastreams picked
-    # up and added to the object during accessionWF.
-    #
-    # This method builds that datastream using the content of a file if such a file
-    # exists and is newer than the object's current datastream (see above); otherwise,
-    # builds the datastream by calling build_fooMetadata_datastream.
-    # @param [String] datastream name of a datastream (e.g. "fooMetadata")
-    # @param [Boolean] force overwrite existing datastream
-    # @param [Boolean] is_required
-    # @return [ActiveFedora::Datastream]
-    def build_datastream(datastream, force = false, is_required = false)
-      ds = datastreams[datastream]
-      builder = Dor::DatastreamBuilder.new(object: self,
-                                           datastream: ds,
-                                           force: force,
-                                           required: is_required)
-      builder.build
-
-      ds
-    end
-    deprecation_deprecate build_datastream: 'Use Dor::DatastreamBuilder instead'
-
-    def cleanup
-      CleanupService.cleanup(self)
-    end
-    deprecation_deprecate cleanup: 'Use CleanupService.cleanup instead'
-
-    # @return [Hash{Symbol => Object}] including :current_version, :status_code and :status_time
-    def status_info
-      StatusService.status_info(self)
-    end
-    deprecation_deprecate status_info: 'Use StatusService.status_info instead'
-
-    # @param [Boolean] include_time
-    # @return [String] single composed status from status_info
-    def status(include_time = false)
-      StatusService.status(self, include_time)
-    end
-    deprecation_deprecate status: 'Use StatusService.status instead'
-
-    def milestones
-      StatusService.new(self).milestones
-    end
-    deprecation_deprecate status_info: 'Use StatusService#milestones instead'
-
-    # Initilizes workflow for the object in the workflow service
-    #  It will set the priorty of the new workflow to the current_priority if it is > 0
-    #  It will set lane_id from the item's APO default workflow lane
-    # @param [String] name of the workflow to be initialized
-    # @param [Boolean] create_ds create a 'workflows' datastream in Fedora for the object
-    # @param [Integer] priority the workflow's priority level
-    def create_workflow(name, create_ds = true, priority = 0)
-      CreateWorkflowService.create_workflow(self, name: name, create_ds: create_ds, priority: priority)
-    end
-    deprecation_deprecate create_workflow: 'Use Dor::Services::Client.object(object_identifier).workflow.create(wf_name:) instead'
-
-    def initialize_workflow(name, create_ds = true, priority = 0)
-      warn 'WARNING: initialize_workflow is deprecated, use create_workflow instead'
-      create_workflow(name, create_ds, priority)
-    end
-  end
-end

data/lib/dor/models/concerns/publishable.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require 'dor/datastreams/content_metadata_ds'
-require 'fileutils'
-
-module Dor
-  module Publishable
-    extend Deprecation
-    extend ActiveSupport::Concern
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    # Compute the thumbnail for this object following the rules at https://consul.stanford.edu/display/chimera/The+Rules+of+Thumb
-    # Used by PublicXmlService
-    # @return [String] the computed thumb filename, with the druid prefix and a slash in front of it, e.g. oo000oo0001/filenamewith space.jp2
-    def thumb
-      ThumbnailService.new(self).thumb
-    end
-    deprecation_deprecate :thumb
-
-    # Return a URI encoded version of the thumb image for use by indexers (leaving the extension of the filename)
-    # @return [String] URI encoded version of the thumb with the druid prefix, e.g. oo000oo0001%2Ffilenamewith%20space.jp2
-    def encoded_thumb
-      thumb_image = thumb # store the result locally, so we don't have to compute each time we use it below
-      return unless thumb_image
-
-      thumb_druid = thumb_image.split('/').first # the druid (before the first slash)
-      thumb_filename = thumb_image.split(/#{pid_regex}[\/]/).last # everything after the druid
-      "#{thumb_druid}%2F#{ERB::Util.url_encode(thumb_filename)}"
-    end
-    deprecation_deprecate :encoded_thumb
-
-    # Return a full qualified thumbnail image URL if the thumb is computable
-    # @return [String] fully qualified image URL for the computed thumbnail, e.g. https://stacks.stanford.edu/image/iiif/oo000oo0001%2Ffilenamewith%20space/full
-    def thumb_url
-      return unless encoded_thumb
-
-      thumb_basename = File.basename(encoded_thumb, File.extname(encoded_thumb)) # strip the extension for URL generation
-      "https://#{Dor::Config.stacks.host}/image/iiif/#{thumb_basename}/full/!400,400/0/default.jpg"
-    end
-    deprecation_deprecate :thumb_url
-
-    # strips away the relationships that should not be shown in public desc metadata
-    # @return [Nokogiri::XML]
-    def public_relationships
-      include_elements = ['fedora:isMemberOf', 'fedora:isMemberOfCollection', 'fedora:isConstituentOf']
-      rels_doc = Nokogiri::XML(datastreams['RELS-EXT'].content)
-      rels_doc.xpath('/rdf:RDF/rdf:Description/*', 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#').each do |rel|
-        unless include_elements.include?([rel.namespace.prefix, rel.name].join(':'))
-          rel.next_sibling.remove if rel.next_sibling.content.strip.empty?
-          rel.remove
-        end
-      end
-      rels_doc
-    end
-
-    # Generate the public .xml for a PURL page.
-    # @return [xml] The public xml for the item
-    def public_xml
-      PublicXmlService.new(self).to_xml
-    end
-    deprecation_deprecate public_xml: 'Use PublicXmlService#to_xml instead'
-
-    # Copies this object's public_xml to the Purl document cache if it is world discoverable
-    #  otherwise, it prunes the object's metadata from the document cache
-    def publish_metadata
-      PublishMetadataService.publish(self)
-    end
-    deprecation_deprecate publish_metadata: 'use Dor::PublishMetadataService.publish(obj) instead or use publish_metadata_remotely'
-
-    # Call dor services app to have it publish the metadata
-    def publish_metadata_remotely
-      Dor::Services::Client.object(pid).publish
-    end
-    deprecation_deprecate publish_metadata_remotely: 'Use Dor::Services::Client.object(object_identifier).publish instead'
-  end
-end

data/lib/dor/models/concerns/releaseable.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-
-require 'open-uri'
-require 'retries'
-
-module Dor
-  module Releaseable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    # Add release tags to an item and initialize the item release workflow
-    # Each tag should be of the form !{:tag => 'Fitch : Batch2', :what => 'self', :to => 'Searchworks', :who => 'petucket', :release => true}
-    # @param release_tags [Hash, Array<Hash>] hash of a single release tag or an array of many such hashes
-    # @raise [ArgumentError] Raised if the tags are improperly supplied
-    def add_release_nodes_and_start_releaseWF(release_tags)
-      release_tags = [release_tags] unless release_tags.is_a?(Array)
-
-      # Add in each tag
-      release_tags.each do |r_tag|
-        add_release_node(r_tag[:release], r_tag)
-      end
-
-      # Save item to dor so the robots work with the latest data
-      save
-      create_workflow('releaseWF')
-    end
-    deprecation_deprecate add_release_nodes_and_start_releaseWF: 'No longer used by any DLSS code'
-
-    # Called in Dor::UpdateMarcRecordService (in dor-services-app too)
-    # Determine projects in which an item is released
-    # @param [Boolean] skip_live_purl set true to skip requesting from purl backend
-    # @return [Hash{String => Boolean}] all namespaces, keys are Project name Strings, values are Boolean
-    def released_for(skip_live_purl = false)
-      releases.released_for(skip_live_purl: skip_live_purl)
-    end
-
-    # Helper method to get the release tags as a nodeset
-    # @return [Nokogiri::XML::NodeSet] all release tags and their attributes
-    delegate :release_tags, to: :releases
-    deprecation_deprecate release_tags: 'use ReleaseTagService#release_tags instead'
-
-    # Take a hash of tags as obtained via Dor::Item.release_tags and returns the newest tag for each namespace
-    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    # @return [Hash] a hash of latest tags for each to value
-    def get_newest_release_tag(tags)
-      releases.newest_release_tag(tags)
-    end
-    deprecation_deprecate get_newest_release_tag: 'use ReleaseTagService#newest_release_tag instead'
-
-    def releases
-      @releases ||= ReleaseTagService.for(self)
-    end
-
-    # Determine if the supplied tag is a valid release tag that meets all requirements
-    #
-    # @param attrs [hash] A hash of attributes for the tag, must contain: :when, a ISO 8601 timestamp; :who, to identify who or what added the tag; and :to, a string identifying the release target
-    # @raise [RuntimeError]  Raises an error of the first fault in the release tag
-    # @return [Boolean] Returns true if no errors found
-    def valid_release_attributes_and_tag(tag, attrs = {})
-      raise ArgumentError, ':when is not iso8601' if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
-
-      %i[who to what].each do |check_attr|
-        raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
-      end
-
-      what_correct = false
-      %w(self collection).each do |allowed_what_value|
-        what_correct = true if attrs[:what] == allowed_what_value
-      end
-      raise ArgumentError, ':what must be self or collection' unless what_correct
-      raise ArgumentError, 'the value set for this tag is not a boolean' if !!tag != tag # rubocop:disable Style/DoubleNegation
-
-      true
-    end
-    deprecation_deprecate valid_release_attributes_and_tag: 'No longer used by any DLSS code'
-
-    # Add a release node for the item
-    # Will use the current time if timestamp not supplied. You can supply a timestap for correcting history, etc if desired
-    # Timestamp will be calculated by the function
-    #
-    # @param release [Boolean] True or false for the release node
-    # @param attrs [hash]  A hash of any attributes to be placed onto the tag
-    # @return [Nokogiri::XML::Element] the tag added if successful
-    # @raise [ArgumentError] Raised if attributes are improperly supplied
-    #
-    # @example
-    #  item.add_release_node(true,{:what=>'self',:to=>'Searchworks',:who=>'petucket'})
-    def add_release_node(release, attrs = {})
-      allowed_release_attributes = %i[what to who when] # any other release attributes sent in will be rejected and not stored
-      identity_metadata_ds = identityMetadata
-      attrs.delete_if { |key, _value| !allowed_release_attributes.include?(key) }
-      attrs[:when] = Time.now.utc.iso8601 if attrs[:when].nil? # add the timestamp
-      valid_release_attributes(release, attrs)
-      identity_metadata_ds.add_value(:release, release.to_s, attrs)
-    end
-    deprecation_deprecate add_release_node: 'No longer used by any DLSS code'
-
-    # Determine if the supplied tag is a valid release node that meets all requirements
-    #
-    # @param tag [Boolean] True or false for the release node
-    # @param attrs [hash] A hash of attributes for the tag, must contain :when, a ISO 8601 timestamp and :who to identify who or what added the tag, :to,
-    # @raise [ArgumentError]  Raises an error of the first fault in the release tag
-    # @return [Boolean] Returns true if no errors found
-    def valid_release_attributes(tag, attrs = {})
-      raise ArgumentError, ':when is not iso8601' if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
-
-      %i[who to what].each do |check_attr|
-        raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
-      end
-      raise ArgumentError, ':what must be self or collection' unless %w(self collection).include? attrs[:what]
-      raise ArgumentError, 'the value set for this tag is not a boolean' unless [true, false].include? tag
-
-      true
-    end
-    deprecation_deprecate valid_release_attributes: 'No longer used by any DLSS code'
-  end
-end

data/lib/dor/models/concerns/rightsable.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Rightsable
-    extend ActiveSupport::Concern
-
-    included do
-      has_metadata name: 'rightsMetadata', type: Dor::RightsMetadataDS, label: 'Rights metadata'
-    end
-
-    def build_rightsMetadata_datastream(ds)
-      content_ds = admin_policy_object.datastreams['defaultObjectRights']
-      ds.dsLabel = 'Rights Metadata'
-      ds.ng_xml = content_ds.ng_xml.clone
-    end
-
-    def world_doc
-      Nokogiri::XML::Builder.new do |xml|
-        xml.access(type: 'read') do
-          xml.machine { xml.world }
-        end
-      end.doc
-    end
-  end
-end

data/lib/dor/models/concerns/shelvable.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Shelvable
-    extend Deprecation
-    extend ActiveSupport::Concern
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    # Push file changes for shelve-able files into the stacks
-    def shelve
-      ShelvingService.shelve(self)
-    end
-    deprecation_deprecate shelve: 'Use ShelvingService.shelve(work) instead'
-  end
-end

data/lib/dor/models/concerns/versionable.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  module Versionable
-    extend ActiveSupport::Concern
-    extend Deprecation
-    self.deprecation_horizon = 'dor-services version 7.0.0'
-
-    included do
-      has_metadata name: 'versionMetadata', type: Dor::VersionMetadataDS, label: 'Version Metadata', autocreate: true
-    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_new_version(opts = {})
-      VersionService.open(self, opts)
-    end
-    deprecation_deprecate open_new_version: 'Use Dor::Services::Client.object(object_identifier).open_new_version(**params) instead'
-
-    def current_version
-      versionMetadata.current_version_id
-    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_version(opts = {})
-      VersionService.close(self, opts)
-    end
-    deprecation_deprecate close_version: 'Use Dor::Services::Client.object(object_identifier).close_version(**params) instead'
-
-    # @return [Boolean] true if 'opened' lifecycle is active, false otherwise
-    def new_version_open?
-      VersionService.new(self).open?
-    end
-    deprecation_deprecate new_version_open?: 'Use VersionService.open? instead'
-
-    # This is used by Argo and the MergeService
-    # @return [Boolean] true if the object is in a state that allows it to be modified.
-    #  States that will allow modification are: has not been submitted for accessioning, has an open version or has sdr-ingest set to hold
-    def allows_modification?
-      if Dor::Config.workflow.client.lifecycle('dor', pid, 'submitted') &&
-         !VersionService.new(self).open? &&
-         Dor::Config.workflow.client.workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
-        false
-      else
-        true
-      end
-    end
-
-    # Following chart of processes on this consul page: https://consul.stanford.edu/display/chimera/Versioning+workflows
-    def start_version
-      open_new_version
-    end
-    deprecation_deprecate start_version: 'Use Dor::Services::Client.object(object_identifier).open_new_version(**params) instead'
-
-    def submit_version
-      close_version
-    end
-    deprecation_deprecate submit_version: 'Use Dor::Services::Client.object(object_identifier).close_version(**params) instead'
-  end
-end