dor-services 6.0.5 → 6.1.0

data/lib/dor/services/registration_service.rb

@@ -15,9 +15,7 @@ module Dor
         return Dor::SuriService.mint_id unless pid
 
         existing_pid = SearchService.query_by_id(pid).first
-        unless existing_pid.nil?
-          raise Dor::DuplicateIdError.new(existing_pid), "An object with the PID #{pid} has already been registered."
-        end
+        raise Dor::DuplicateIdError.new(existing_pid), "An object with the PID #{pid} has already been registered." unless existing_pid.nil?
 
         pid
       end
@@ -27,7 +25,7 @@ module Dor
       # @raise [Dor::DuplicateIdError]
       def check_source_id(source_id_string)
         return '' if source_id_string == ''
-        unless SearchService.query_by_id("#{source_id_string}").first.nil?
+        unless SearchService.query_by_id(source_id_string.to_s).first.nil?
           raise Dor::DuplicateIdError.new(source_id_string), "An object with the source ID '#{source_id_string}' has already been registered."
         end
 
@@ -49,13 +47,11 @@ module Dor
       # @option params [Array<String>] :initiate_workflow workflow_ids
       # @option params [Array] :tags
       def register_object(params = {})
-        [:object_type, :label].each do |required_param|
+        %i[object_type label].each do |required_param|
           raise Dor::ParameterError, "#{required_param.inspect} must be specified in call to #{name}.register_object" unless params[required_param]
         end
         metadata_source = params[:metadata_source]
-        if params[:label].length < 1 && %w[label none].include?(metadata_source)
-          raise Dor::ParameterError, "label cannot be empty to call #{name}.register_object"
-        end
+        raise Dor::ParameterError, "label cannot be empty to call #{name}.register_object" if params[:label].length < 1 && %w[label none].include?(metadata_source)
 
         object_type = params[:object_type]
         item_class = Dor.registered_classes[object_type]
@@ -78,16 +74,12 @@ module Dor
         rights = nil
         if params[:rights]
           rights = params[:rights]
-          unless rights == 'default' || RightsMetadataDS.valid_rights_type?(rights)
-            raise Dor::ParameterError, "Unknown rights setting '#{rights}' when calling #{name}.register_object"
-          end
+          raise Dor::ParameterError, "Unknown rights setting '#{rights}' when calling #{name}.register_object" unless rights == 'default' || RightsMetadataDS.valid_rights_type?(rights)
         end
 
-        if (other_ids.key?(:uuid) || other_ids.key?('uuid')) == false
-          other_ids[:uuid] = UUIDTools::UUID.timestamp_create.to_s
-        end
+        other_ids[:uuid] = UUIDTools::UUID.timestamp_create.to_s if (other_ids.key?(:uuid) || other_ids.key?('uuid')) == false
         apo_object = Dor.find(params[:admin_policy])
-        new_item = item_class.new(:pid => pid)
+        new_item = item_class.new(pid: pid)
         new_item.label = label.length > 254 ? label[0, 254] : label
         idmd = new_item.identityMetadata
         idmd.sourceId = source_id_string
@@ -115,25 +107,13 @@ module Dor
           new_item.set_read_rights(rights) unless rights == 'default' # already defaulted to default!
         end
         # create basic mods from the label
-        if metadata_source == 'label'
-          ds = new_item.build_datastream('descMetadata')
-          builder = Nokogiri::XML::Builder.new { |xml|
-            xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) {
-              xml.titleInfo {
-                xml.title label
-              }
-            }
-          }
-          ds.content = builder.to_xml
-        end
+        build_desc_metadata_from_label(new_item, label) if metadata_source == 'label'
 
         workflow_priority = params[:workflow_priority] ? params[:workflow_priority].to_i : 0
 
-        Array(params[:seed_datastream]).each { |datastream_name| new_item.build_datastream(datastream_name) }
+        seed_datastreams(Array(params[:seed_datastream]), new_item)
         Array(params[:initiate_workflow]).each { |workflow_id| new_item.create_workflow(workflow_id, !new_item.new_record?, workflow_priority) }
 
-        new_item.assert_content_model
-
         new_item.class.ancestors.select { |x| x.respond_to?(:to_class_uri) && x != ActiveFedora::Base }.each do |parent_class|
           new_item.add_relationship(:has_model, parent_class.to_class_uri)
         end
@@ -161,28 +141,28 @@ module Dor
         end
 
         dor_params = {
-          :pid => params[:pid],
-          :admin_policy => params[:admin_policy],
-          :content_model => params[:model],
-          :label => params[:label],
-          :object_type => params[:object_type],
-          :other_ids => ids_to_hash(other_ids),
-          :parent => params[:parent],
-          :source_id => ids_to_hash(params[:source_id]),
-          :tags => params[:tag] || [],
-          :seed_datastream => params[:seed_datastream],
-          :initiate_workflow => Array(params[:initiate_workflow]) + Array(params[:workflow_id]),
-          :rights => params[:rights],
-          :metadata_source => params[:metadata_source],
-          :collection => params[:collection],
-          :workflow_priority => params[:workflow_priority]
+          pid: params[:pid],
+          admin_policy: params[:admin_policy],
+          content_model: params[:model],
+          label: params[:label],
+          object_type: params[:object_type],
+          other_ids: ids_to_hash(other_ids),
+          parent: params[:parent],
+          source_id: ids_to_hash(params[:source_id]),
+          tags: params[:tag] || [],
+          seed_datastream: params[:seed_datastream],
+          initiate_workflow: Array(params[:initiate_workflow]) + Array(params[:workflow_id]),
+          rights: params[:rights],
+          metadata_source: params[:metadata_source],
+          collection: params[:collection],
+          workflow_priority: params[:workflow_priority]
         }
-        dor_params.delete_if { |k, v| v.nil? }
+        dor_params.delete_if { |_k, v| v.nil? }
 
         dor_obj = register_object(dor_params)
         pid = dor_obj.pid
         location = URI.parse(Dor::Config.fedora.safeurl.sub(/\/*$/, '/')).merge("objects/#{pid}").to_s
-        dor_params.dup.merge({ :location => location, :pid => pid })
+        dor_params.dup.merge(location: location, pid: pid)
       end
 
       private
@@ -192,6 +172,23 @@ module Dor
 
         Hash[Array(ids).map { |id| id.split(':', 2) }]
       end
+
+      def seed_datastreams(names, item)
+        names.each do |datastream_name|
+          item.build_datastream(datastream_name)
+        end
+      end
+
+      def build_desc_metadata_from_label(new_item, label)
+        builder = Nokogiri::XML::Builder.new do |xml|
+          xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) do
+            xml.titleInfo do
+              xml.title label
+            end
+          end
+        end
+        new_item.descMetadata.content = builder.to_xml
+      end
     end
   end
 end

data/lib/dor/services/release_tag_service.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+module Dor
+  class ReleaseTagService
+    # Determine projects in which an item is released
+    # @param [Dor::Item] item to get the release tags for
+    # @return [Hash{String => Boolean}] all namespaces, keys are Project name Strings, values are Boolean
+    def self.for(item)
+      new(item)
+    end
+
+    def initialize(item)
+      @item = item
+    end
+
+    # Called in Dor::UpdateMarcRecordService (in dor-services-app too)
+    # Determine projects in which an item is released
+    # @return [Hash{String => Boolean}] all namespaces, keys are Project name Strings, values are Boolean
+    def released_for(skip_live_purl:)
+      released_hash = {}
+
+      # Get the most recent self tag for all targets and retain their result since most recent self always trumps any other non self tags
+      latest_self_tags = newest_release_tag self_release_tags(release_nodes)
+      latest_self_tags.each do |key, payload|
+        released_hash[key] = { 'release' => payload['release'] }
+      end
+
+      # With Self Tags resolved we now need to deal with tags on all sets this object is part of.
+      # Get all release tags on the item and strip out the what = self ones, we've already processed all the self tags on this item.
+      # This will be where we store all tags that apply, regardless of their timestamp:
+      potential_applicable_release_tags = tags_for_what_value(release_tags_for_item_and_all_governing_sets, 'collection')
+      administrative_tags = item.tags # Get admin tags once here and pass them down
+
+      # We now have the keys for all potential releases, we need to check the tags: the most recent timestamp with an explicit true or false wins.
+      # In a nil case, the lack of an explicit false tag we do nothing.
+      (potential_applicable_release_tags.keys - released_hash.keys).each do |key| # don't bother checking if already added to the release hash, they were added due to a self tag so that has won
+        latest_tag = latest_applicable_release_tag_in_array(potential_applicable_release_tags[key], administrative_tags)
+        next if latest_tag.nil? # Otherwise, we have a valid tag, record it
+
+        released_hash[key] = { 'release' => latest_tag['release'] }
+      end
+
+      # See what the application is currently released for on Purl.  If released in purl but not listed here, it needs to be added as a false
+      add_tags_from_purl(released_hash) unless skip_live_purl
+      released_hash
+    end
+
+    # Take an item and get all of its release tags and all tags on collections it is a member of it
+    # @return [Hash] a hash of all tags
+    def release_tags_for_item_and_all_governing_sets
+      return_tags = release_nodes || {}
+      item.collections.each do |collection|
+        next if collection.id == item.id # recursive, so parents of parents are found, but we need to avoid an infinite loop if the collection references itself (i.e. bad data)
+
+        return_tags = Releases.combine_two_release_tag_hashes(return_tags, collection.releases.release_tags_for_item_and_all_governing_sets)
+      end
+      return_tags
+    end
+
+    private
+
+    # Helper method to get the release nodes as a nodeset
+    # @return [Nokogiri::XML::NodeSet] of all release tags and their attributes
+    def release_nodes
+      release_tags = item.identityMetadata.ng_xml.xpath('//release')
+      return_hash = {}
+      release_tags.each do |release_tag|
+        hashed_node = release_tag_node_to_hash(release_tag)
+        if !return_hash[hashed_node[:to]].nil?
+          return_hash[hashed_node[:to]] << hashed_node[:attrs]
+        else
+          return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
+        end
+      end
+      return_hash
+    end
+
+    # Helper method to get the release tags as a nodeset
+    # @return [Nokogiri::XML::NodeSet] all release tags and their attributes
+    def release_tags
+      release_tags = identityMetadata.ng_xml.xpath('//release')
+      return_hash = {}
+      release_tags.each do |release_tag|
+        hashed_node = release_tag_node_to_hash(release_tag)
+        if !return_hash[hashed_node[:to]].nil?
+          return_hash[hashed_node[:to]] << hashed_node[:attrs]
+        else
+          return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
+        end
+      end
+      return_hash
+    end
+
+    # Convert one release element into a Hash
+    # @param rtag [Nokogiri::XML::Element] the release tag element
+    # @return [Hash{:to, :attrs => String, Hash}] in the form of !{:to => String :attrs = Hash}
+    def release_tag_node_to_hash(rtag)
+      to = 'to'
+      release = 'release'
+      when_word = 'when' # TODO: Make to and when_word load from some config file instead of hardcoded here
+      attrs = rtag.attributes
+      return_hash = { to: attrs[to].value }
+      attrs.tap { |a| a.delete(to) }
+      attrs[release] = rtag.text.casecmp('true') == 0 # save release as a boolean
+      return_hash[:attrs] = attrs
+
+      # convert all the attrs beside :to to strings, they are currently Nokogiri::XML::Attr
+      (return_hash[:attrs].keys - [to]).each do |a|
+        return_hash[:attrs][a] = return_hash[:attrs][a].to_s if a != release
+      end
+
+      return_hash[:attrs][when_word] = Time.parse(return_hash[:attrs][when_word]) # convert when to a datetime
+      return_hash
+    end
+
+    # Take a hash of tags as obtained via Dor::Item.release_tags and returns all self tags
+    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @return [Hash] a hash of self tags for each to value
+    def self_release_tags(tags)
+      tags_for_what_value(tags, 'self')
+    end
+
+    # Take a hash of tags and return all tags with the matching what target
+    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @param what_target [String] the target for the 'what' key, self or collection
+    # @return [Hash] a hash of self tags for each to value
+    def tags_for_what_value(tags, what_target)
+      return_hash = {}
+      tags.keys.each do |key|
+        self_tags = tags[key].select { |tag| tag['what'].casecmp(what_target) == 0 }
+        return_hash[key] = self_tags if self_tags.size > 0
+      end
+      return_hash
+    end
+
+    # Take two hashes of tags and combine them, will not overwrite but will enforce uniqueness of the tags
+    # @param hash_one [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @param hash_two [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @return [Hash] the combined hash with uniquiness enforced
+    def self.combine_two_release_tag_hashes(hash_one, hash_two)
+      hash_two.keys.each do |key|
+        hash_one[key] = hash_two[key] if hash_one[key].nil?
+        hash_one[key] = (hash_one[key] + hash_two[key]).uniq unless hash_one[key].nil?
+      end
+      hash_one
+    end
+    private_class_method :combine_two_release_tag_hashes
+
+    # 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 newest_release_tag(tags)
+      Hash[tags.map { |key, val| [key, newest_release_tag_in_an_array(val)] }]
+    end
+
+    # Takes an array of release tags and returns the most recent one
+    # @param array_of_tags [Array] an array of hashes, each hash a release tag
+    # @return [Hash] the most recent tag
+    def newest_release_tag_in_an_array(array_of_tags)
+      latest_tag_in_array = array_of_tags[0] || {}
+      array_of_tags.each do |tag|
+        latest_tag_in_array = tag if tag['when'] > latest_tag_in_array['when']
+      end
+      latest_tag_in_array
+    end
+
+    # Takes a tag and returns true or false if it applies to the specific item
+    # @param release_tag [Hash] the tag in a hashed form
+    # @param admin_tags [Array] the administrative tags on an item, if not supplied it will attempt to retrieve them
+    # @return [Boolean] true or false if it applies (not true or false if it is released, that is the release_tag data)
+    def does_release_tag_apply(release_tag, admin_tags = false)
+      # Is the tag global or restricted
+      return true if release_tag['tag'].nil? # no specific tag specificied means this tag is global to all members of the collection
+
+      admin_tags ||= item.tags # We use false instead of [], since an item can have no admin_tags at which point we'd be passing this var as [] and would not attempt to retrieve it
+      admin_tags.include?(release_tag['tag'])
+    end
+
+    # Takes an array of release tags and returns the most recent one that applies to this item
+    # @param release_tags [Array] an array of release tags in hashed form
+    # @param admin_tags [Array] the administrative tags on an on item
+    # @return [Hash] the tag, or nil if none applicable
+    def latest_applicable_release_tag_in_array(release_tags, admin_tags)
+      newest_tag = newest_release_tag_in_an_array(release_tags)
+      return newest_tag if does_release_tag_apply(newest_tag, admin_tags)
+
+      # The latest tag wasn't applicable, slice it off and try again
+      # This could be optimized by reordering on the timestamp and just running down it instead of constantly resorting, at least if we end up getting numerous release tags on an item
+      release_tags.slice!(release_tags.index(newest_tag))
+
+      return latest_applicable_release_tag_in_array(release_tags, admin_tags) if release_tags.size > 0 # Try again after dropping the inapplicable
+
+      nil # We're out of tags, no applicable ones
+    end
+
+    # This function calls purl and gets a list of all release tags currently in purl.  It then compares to the list you have generated.
+    # Any tag that is on purl, but not in the newly generated list is added to the new list with a value of false.
+    # @param new_tags [Hash{String => Boolean}] all new tags in the form of !{"Project" => Boolean}
+    # @return [Hash] same form as new_tags, with all missing tags not in new_tags, but in current_tag_names, added in with a Boolean value of false
+    def add_tags_from_purl(new_tags)
+      missing_tags = release_tags_from_purl.map(&:downcase) - new_tags.keys.map(&:downcase)
+      missing_tags.each do |missing_tag|
+        new_tags[missing_tag.capitalize] = { 'release' => false }
+      end
+      new_tags
+    end
+
+    # Get a list of all release nodes found in a purl document
+    # Fetches purl xml for a druid
+    # @raise [OpenURI::HTTPError]
+    # @return [Nokogiri::HTML::Document] parsed XML for the druid or an empty document if no purl is found
+    def xml_from_purl
+      url = form_purl_url
+      handler = proc do |exception, attempt_number, total_delay|
+        # We assume a 404 means the document has never been published before and thus has no purl
+        Dor.logger.warn "[Attempt #{attempt_number}] GET #{url} -- #{exception.class}: #{exception.message}; #{total_delay} seconds elapsed."
+        raise exception unless exception.is_a? OpenURI::HTTPError
+        return Nokogiri::HTML::Document.new if exception.io.status.first == '404' # ["404", "Not Found"] from OpenURI::Meta.status
+      end
+
+      with_retries(max_retries: 3, base_sleep_seconds: 3, max_sleep_seconds: 5, handler: handler) do |attempt|
+        # If you change the method used for opening the webpage, you can change the :rescue param to handle the new method's errors
+        Dor.logger.info "[Attempt #{attempt}] GET #{url}"
+        return Nokogiri::HTML(OpenURI.open_uri(url))
+      end
+    end
+
+    # Take the and create the entire purl url that will usable for the open method in open-uri, returns http
+    # @return [String] the full url
+    def form_purl_url
+      'https://' + Dor::Config.stacks.document_cache_host + "/#{item.remove_druid_prefix}.xml"
+    end
+
+    # Pull all release nodes from the public xml obtained via the purl query
+    # @param doc [Nokogiri::HTML::Document] The druid of the object you want
+    # @return [Array] An array containing all the release tags
+    def release_tags_from_purl_xml(doc)
+      nodes = doc.xpath('//html/body/publicobject/releasedata').children
+      # We only want the nodes with a name that isn't text
+      nodes.reject { |n| n.name.nil? || n.name.casecmp('text') == 0 }.map { |n| n.attr('to') }.uniq
+    end
+
+    # Pull all release nodes from the public xml obtained via the purl query
+    # @return [Array] An array containing all the release tags
+    def release_tags_from_purl
+      release_tags_from_purl_xml(xml_from_purl)
+    end
+
+    attr_reader :item
+  end
+end

data/lib/dor/services/reset_workspace_service.rb

@@ -21,9 +21,7 @@ module Dor
 
       FileUtils.mv(bag_dir, "#{bag_dir}_v#{version}") if File.exist?(bag_dir)
 
-      if File.exist?("#{bag_dir}.tar")
-        FileUtils.mv("#{bag_dir}.tar", "#{bag_dir}_v#{version}.tar")
-      end
+      FileUtils.mv("#{bag_dir}.tar", "#{bag_dir}_v#{version}.tar") if File.exist?("#{bag_dir}.tar")
     end
   end
 end

data/lib/dor/services/sdr_ingest_service.rb

@@ -9,7 +9,7 @@ module Dor
     # @param [Dor::Item] dor_item The representation of the digital object
     # @param [String] agreement_id  depreciated, included for backward compatability with common-accessoning
     # @return [void] Create the Moab/bag manifests for new version, export data to BagIt bag, kick off the SDR preservation workflow
-    def self.transfer(dor_item, agreement_id = nil)
+    def self.transfer(dor_item, _agreement_id = nil)
       druid = dor_item.pid
       workspace = DruidTools::Druid.new(druid, Dor::Config.sdr.local_workspace_root)
       signature_catalog = get_signature_catalog(druid)
@@ -26,9 +26,7 @@ module Dor
         content_dir = workspace.find_filelist_parent('content', new_file_list)
       end
       content_group = version_inventory.group('content')
-      unless content_group.nil? || content_group.files.empty?
-        signature_catalog.normalize_group_signatures(content_group, content_dir)
-      end
+      signature_catalog.normalize_group_signatures(content_group, content_dir) unless content_group.nil? || content_group.files.empty?
       # export the bag (in tar format)
       bag_dir = Pathname(Dor::Config.sdr.local_export_home).join(druid.sub('druid:', ''))
       bagger = Moab::Bagger.new(version_inventory, signature_catalog, bag_dir)
@@ -74,7 +72,7 @@ module Dor
     #   If not found, return nil unless it is a required datastream in which case raise exception
     def self.get_datastream_content(dor_item, ds_name, required)
       ds = (ds_name == 'relationshipMetadata' ? 'RELS-EXT' : ds_name)
-      if dor_item.datastreams.keys.include?(ds) && !dor_item.datastreams[ds].new?
+      if dor_item.datastreams.key?(ds) && !dor_item.datastreams[ds].new?
         return dor_item.datastreams[ds].content
       elsif required == 'optional'
         return nil
@@ -130,7 +128,7 @@ module Dor
       if content_metadata
         Stanford::ContentInventory.new.inventory_from_cm(content_metadata, druid, 'preserve', version_id)
       else
-        Moab::FileInventory.new(:type => 'version', :digital_object_id => druid, :version_id => version_id)
+        Moab::FileInventory.new(type: 'version', digital_object_id: druid, version_id: version_id)
       end
     end
 
@@ -144,7 +142,7 @@ module Dor
     # @param [Pathname] metadata_dir The location of the the object's metadata files
     # @return [Moab::FileGroup] Traverse the metadata directory and generate a metadata group
     def self.get_metadata_file_group(metadata_dir)
-      file_group = Moab::FileGroup.new(:group_id => 'metadata').group_from_directory(metadata_dir)
+      file_group = Moab::FileGroup.new(group_id: 'metadata').group_from_directory(metadata_dir)
       file_group
     end