dor-services 6.0.0 → 6.0.1

data/lib/dor/services/metadata_handlers/catalog_handler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 
 handler = Class.new do

data/lib/dor/services/metadata_service.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'cache'
 
 module Dor
-  class MetadataError < Exception ; end
+  class MetadataError < Exception; end
 
   #  class MetadataHandler
   #
@@ -16,7 +18,6 @@ module Dor
   #  end
 
   class MetadataService
-
     class << self
       @@cache = Cache.new(nil, nil, 250, 300)
 
@@ -64,6 +65,7 @@ module Dor
       def handler_for(prefix)
         handler = handlers[prefix.to_sym]
         raise MetadataError, "Unkown metadata prefix: #{prefix}" if handler.nil?
+
         handler
       end
 
@@ -72,9 +74,7 @@ module Dor
       def handlers
         @handlers ||= {}
       end
-
     end
-
   end
 end
 

data/lib/dor/services/public_desc_metadata_service.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 module Dor
   class PublicDescMetadataService
     attr_reader :object
-    
+
     NOKOGIRI_DEEP_COPY = 1
 
     def initialize(object)
       @object = object
     end
-    
+
     def doc
       @doc ||= object.descMetadata.ng_xml.dup(NOKOGIRI_DEEP_COPY)
     end
@@ -18,7 +20,7 @@ module Dor
       add_access_conditions! if include_access_conditions
       add_constituent_relations!
       strip_comments!
-      
+
       new_doc = Nokogiri::XML(doc.to_xml) { |x| x.noblanks }
       new_doc.encoding = 'UTF-8'
       new_doc.to_xml
@@ -35,30 +37,36 @@ module Dor
     # @note this method modifies the passed in doc
     def add_access_conditions!
       # clear out any existing accessConditions
-      doc.xpath('//mods:accessCondition', 'mods' => 'http://www.loc.gov/mods/v3').each {|n| n.remove}
+      doc.xpath('//mods:accessCondition', 'mods' => 'http://www.loc.gov/mods/v3').each { |n| n.remove }
       rights = object.datastreams['rightsMetadata'].ng_xml
 
       rights.xpath('//use/human[@type="useAndReproduction"]').each do |use|
         txt = use.text.strip
         next if txt.empty?
+
         doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', txt, :type => 'useAndReproduction')
       end
       rights.xpath('//copyright/human[@type="copyright"]').each do |cr|
         txt = cr.text.strip
         next if txt.empty?
+
         doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', txt, :type => 'copyright')
       end
       rights.xpath("//use/machine[#{ci_compare('type', 'creativecommons')}]").each do |lic_type|
         next if lic_type.text =~ /none/i
+
         lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'creativecommons')}]").text.strip
         next if lic_text.empty?
+
         new_text = "CC #{lic_type.text}: #{lic_text}"
         doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', new_text, :type => 'license')
       end
       rights.xpath("//use/machine[#{ci_compare('type', 'opendatacommons')}]").each do |lic_type|
         next if lic_type.text =~ /none/i
+
         lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'opendatacommons')}]").text.strip
         next if lic_text.empty?
+
         new_text = "ODC #{lic_type.text}: #{lic_text}"
         doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', new_text, :type => 'license')
       end
@@ -69,8 +77,8 @@ module Dor
     # @return [Void]
     def add_constituent_relations!
       object.public_relationships.search('//rdf:RDF/rdf:Description/fedora:isConstituentOf',
-                                       'fedora' => 'info:fedora/fedora-system:def/relations-external#',
-                                       'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' ).each do |parent|
+                                         'fedora' => 'info:fedora/fedora-system:def/relations-external#',
+                                         'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#').each do |parent|
         # fetch the parent object to get title
         druid = parent['rdf:resource'].gsub(/^info:fedora\//, '')
         parent_item = Dor.find(druid)
@@ -106,8 +114,8 @@ module Dor
     # @note this method modifies the passed in doc
     def add_collection_reference!
       collections = object.public_relationships.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection',
-                                       'fedora' => 'info:fedora/fedora-system:def/relations-external#',
-                                       'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')
+                                                       'fedora' => 'info:fedora/fedora-system:def/relations-external#',
+                                                       'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')
       return if collections.empty?
 
       remove_related_item_nodes_for_collections!

data/lib/dor/services/public_xml_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   class PublicXmlService
     attr_reader :object
@@ -35,7 +37,7 @@ module Dor
     # @return [String] The XML release node as a string, with ReleaseDigest as the root document
     def release_xml
       @release_xml ||= begin
-          builder = Nokogiri::XML::Builder.new do |xml|
+        builder = Nokogiri::XML::Builder.new do |xml|
           xml.releaseData {
             object.released_for.each do |project, released_value|
               xml.release(released_value['release'], :to => project)
@@ -65,14 +67,15 @@ module Dor
     # @return [Nokogiri::XML::Document] sanitized for public consumption
     def public_content_metadata
       return Nokogiri::XML::Document.new unless object.datastreams['contentMetadata']
+
       @public_content_metadata ||= begin
         result = object.datastreams['contentMetadata'].ng_xml.clone
 
         # remove any resources or attributes that are not destined for the public XML
         result.xpath('/contentMetadata/resource[not(file[(@deliver="yes" or @publish="yes")]|externalFile)]').each(&:remove)
-        result.xpath('/contentMetadata/resource/file[not(@deliver="yes" or @publish="yes")]'                ).each(&:remove)
-        result.xpath('/contentMetadata/resource/file').xpath('@preserve|@shelve|@publish|@deliver'          ).each(&:remove)
-        result.xpath('/contentMetadata/resource/file/checksum'                                              ).each(&:remove)
+        result.xpath('/contentMetadata/resource/file[not(@deliver="yes" or @publish="yes")]').each(&:remove)
+        result.xpath('/contentMetadata/resource/file').xpath('@preserve|@shelve|@publish|@deliver').each(&:remove)
+        result.xpath('/contentMetadata/resource/file/checksum').each(&:remove)
 
         # support for dereferencing links via externalFile element(s) to the source (child) item - see JUMBO-19
         result.xpath('/contentMetadata/resource/externalFile').each do |externalFile|

data/lib/dor/services/registration_service.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 require 'uuidtools'
 
 module Dor
   class RegistrationService
-
     class << self
-
       # @TODO: Why isn't all this logic in, for example, Dor::Item.create? or Dor::Base.create? or Dor::Creatable.create?
       # @TODO: these duplicate checks could be combined into 1 query
 
@@ -13,10 +13,12 @@ module Dor
       # @raise [Dor::DuplicateIdError]
       def unduplicated_pid(pid = nil)
         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
+
         pid
       end
 
@@ -28,6 +30,7 @@ module Dor
         unless SearchService.query_by_id("#{source_id_string}").first.nil?
           raise Dor::DuplicateIdError.new(source_id_string), "An object with the source ID '#{source_id_string}' has already been registered."
         end
+
         source_id_string
       end
 
@@ -50,9 +53,10 @@ module Dor
           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 && (metadata_source == 'label' || metadata_source == 'none')
+        if params[:label].length < 1 && %w[label none].include?(metadata_source)
           raise Dor::ParameterError, "label cannot be empty to call #{name}.register_object"
         end
+
         object_type = params[:object_type]
         item_class = Dor.registered_classes[object_type]
         raise Dor::ParameterError, "Unknown item type: '#{object_type}'" if item_class.nil?
@@ -108,7 +112,7 @@ module Dor
         if rights && %w(item collection).include?(object_type)
           rights_xml = apo_object.defaultObjectRights.ng_xml
           new_item.datastreams['rightsMetadata'].content = rights_xml.to_s
-          new_item.set_read_rights(rights) unless rights == 'default'    # already defaulted to default!
+          new_item.set_read_rights(rights) unless rights == 'default' # already defaulted to default!
         end
         # create basic mods from the label
         if metadata_source == 'label'
@@ -126,7 +130,7 @@ module Dor
         workflow_priority = params[:workflow_priority] ? params[:workflow_priority].to_i : 0
 
         Array(params[:seed_datastream]).each { |datastream_name| new_item.build_datastream(datastream_name) }
-        Array(params[:initiate_workflow]).each { |workflow_id| new_item.create_workflow(workflow_id, !new_item.new_record?, workflow_priority)}
+        Array(params[:initiate_workflow]).each { |workflow_id| new_item.create_workflow(workflow_id, !new_item.new_record?, workflow_priority) }
 
         new_item.assert_content_model
 
@@ -157,21 +161,21 @@ 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? }
 
@@ -185,6 +189,7 @@ module Dor
 
       def ids_to_hash(ids)
         return nil if ids.nil?
+
         Hash[Array(ids).map { |id| id.split(':', 2) }]
       end
     end

data/lib/dor/services/reset_workspace_service.rb

@@ -1,11 +1,12 @@
+# frozen_string_literal: true
+
 module Dor
   # Rename the druid trees  at the end of the accessionWF in order to be cleaned/deleted later.
   class ResetWorkspaceService
-
     def self.reset_workspace_druid_tree(druid, version, workspace_root)
       druid_tree_path = DruidTools::Druid.new(druid, workspace_root).pathname.to_s
 
-      raise "The archived directory #{druid_tree_path}_v#{version} already existed." if  File.exist?("#{druid_tree_path}_v#{version}")
+      raise "The archived directory #{druid_tree_path}_v#{version} already existed." if File.exist?("#{druid_tree_path}_v#{version}")
 
       if File.exist?(druid_tree_path)
         FileUtils.mv(druid_tree_path, "#{druid_tree_path}_v#{version}")
@@ -16,7 +17,7 @@ module Dor
       id = druid.split(':').last
       bag_dir = File.join(export_root, id)
 
-      raise "The archived bag #{bag_dir}_v#{version} already existed." if  File.exist?("#{bag_dir}_v#{version}")
+      raise "The archived bag #{bag_dir}_v#{version} already existed." if File.exist?("#{bag_dir}_v#{version}")
 
       FileUtils.mv(bag_dir, "#{bag_dir}_v#{version}") if File.exist?(bag_dir)
 
@@ -24,6 +25,5 @@ module Dor
         FileUtils.mv("#{bag_dir}.tar", "#{bag_dir}_v#{version}.tar")
       end
     end
-
   end
 end

data/lib/dor/services/sdr_ingest_service.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'moab/stanford'
 
 module Dor
   # Note: This should probably live in common-accessioning robot sdr-ingest-transfer
   #  as that is the only robot that uses it.  See also preservable concern.
   class SdrIngestService
-
     # @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
@@ -95,6 +96,7 @@ module Dor
     # @param [Integer] found The version number that is actually in the file
     def self.verify_version_id(pathname, expected, found)
       raise "Version mismatch in #{pathname}, expected #{expected}, found #{found}" unless expected == found
+
       true
     end
 
@@ -165,8 +167,8 @@ module Dor
     # @return [Boolean] true if file exists, raises exception if not
     def self.verify_pathname(pathname)
       raise "#{pathname.basename} not found at #{pathname}" unless pathname.exist?
+
       true
     end
-
   end
 end

data/lib/dor/services/search_service.rb

@@ -1,14 +1,14 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'active_support/core_ext'
 
 module Dor
   class SearchService
-
-    RISEARCH_TEMPLATE = "select $object from <#ri> where $object <dc:identifier> '%s'".freeze
+    RISEARCH_TEMPLATE = "select $object from <#ri> where $object <dc:identifier> '%s'"
     @@index_version = nil
 
     class << self
-
       def index_version
         Dor::VERSION
       end
@@ -17,12 +17,12 @@ module Dor
         client = Config.fedora.client['risearch']
         client.options[:timeout] = opts.delete(:timeout)
         query_params = {
-          :type   => 'tuples',
-          :lang   => 'itql',
+          :type => 'tuples',
+          :lang => 'itql',
           :format => 'CSV',
-          :limit  => '1000',
+          :limit => '1000',
           :stream => 'on',
-          :query  => query
+          :query => query
         }.merge(opts)
         result = client.post(query_params)
         result.split(/\n/)[1..-1].collect { |pid| pid.chomp.sub(/^info:fedora\//, '') }
@@ -50,6 +50,7 @@ module Dor
         params[:start] ||= 0
         resp = solr.get 'select', params: params
         return resp unless block_given?
+
         cont = true
         while cont && resp['response']['docs'].length > 0
           cont = yield(resp)
@@ -92,8 +93,6 @@ module Dor
           r['response']['docs'].first[:id]
         end
       end
-
     end
-
   end
 end

data/lib/dor/services/suri_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rest-client'
 require 'active_fedora'
 
@@ -13,7 +15,7 @@ module Dor
       if Config.suri.mint_ids
         # Post with no body
         resource = RestClient::Resource.new("#{Config.suri.url}/suri2/namespaces/#{Config.suri.id_namespace}",
-                                  :user => Config.suri.user, :password => Config.suri.pass)
+                                            :user => Config.suri.user, :password => Config.suri.pass)
         ids = resource["identifiers?quantity=#{quantity}"].post('').chomp.split(/\n/).collect { |id| "#{Config.suri.id_namespace}:#{id.strip}" }
       else
         repo = ActiveFedora::Base.respond_to?(:connection_for_pid) ? ActiveFedora::Base.connection_for_pid(0) : ActiveFedora.fedora.connection
@@ -32,6 +34,5 @@ module Dor
       #   Rails.logger.error("Unable to mint id from suri: #{e.to_s}")
       #   raise e
     end
-
   end
 end

data/lib/dor/services/technical_metadata_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'moab/stanford'
 require 'jhove_service'
@@ -5,7 +7,6 @@ require 'dor-services'
 
 module Dor
   class TechnicalMetadataService
-
     # @param [Dor::Item] dor_item The DOR item being processed by the technical metadata robot
     # @return [Boolean] True if technical metadata is correctly added or updated
     def self.add_update_technical_metadata(dor_item)
@@ -71,6 +72,7 @@ module Dor
     def self.get_old_technical_metadata(dor_item)
       sdr_techmd = get_sdr_technical_metadata(dor_item.pid)
       return sdr_techmd unless sdr_techmd.nil?
+
       get_dor_technical_metadata(dor_item)
     end
 
@@ -81,6 +83,7 @@ module Dor
       sdr_techmd = get_sdr_metadata(druid, 'technicalMetadata')
       return sdr_techmd if sdr_techmd =~ /<technicalMetadata/
       return ::JhoveService.new.upgrade_technical_metadata(sdr_techmd) if sdr_techmd =~ /<jhove/
+
       nil
     end
 
@@ -90,9 +93,11 @@ module Dor
     def self.get_dor_technical_metadata(dor_item)
       ds = 'technicalMetadata'
       return nil unless dor_item.datastreams.keys.include?(ds) && !dor_item.datastreams[ds].new?
+
       dor_techmd = dor_item.datastreams[ds].content
       return dor_techmd if dor_techmd =~ /<technicalMetadata/
       return ::JhoveService.new.upgrade_technical_metadata(dor_techmd) if dor_techmd =~ /<jhove/
+
       nil
     end
 
@@ -108,6 +113,7 @@ module Dor
     # @return [String] The technicalMetadata datastream for the new files of the new digital object version
     def self.get_new_technical_metadata(druid, new_files)
       return nil if new_files.nil? || new_files.empty?
+
       workspace = DruidTools::Druid.new(druid, Dor::Config.sdr.local_workspace_root)
       content_dir = workspace.find_filelist_parent('content', new_files)
       temp_dir = workspace.temp_dir
@@ -124,7 +130,7 @@ module Dor
     # @return [Pathname] Save the new_files list to a text file and return that file's name
     def self.write_fileset(temp_dir, new_files)
       fileset_pathname = Pathname(temp_dir).join('jhove_fileset.txt')
-      fileset_pathname.open('w') {|f| f.puts(new_files) }
+      fileset_pathname.open('w') { |f| f.puts(new_files) }
       fileset_pathname
     end
 
@@ -163,6 +169,7 @@ module Dor
     def self.get_file_nodes(technical_metadata)
       file_hash = {}
       return file_hash if technical_metadata.nil?
+
       current_file = []
       path = nil
       in_file = false
@@ -188,16 +195,15 @@ module Dor
     # @param [Hash<String,Nokogiri::XML::Node>] merged_nodes The complete set of technicalMetadata nodes for the digital object, indexed by filename
     # @return [String] The finalized technicalMetadata datastream contents for the new object version
     def self.build_technical_metadata(druid, merged_nodes)
-      techmd_root = <<-EOF
-<technicalMetadata objectId='#{druid}' datetime='#{Time.now.utc.iso8601}'
-    xmlns:jhove='http://hul.harvard.edu/ois/xml/ns/jhove'
-    xmlns:mix='http://www.loc.gov/mix/v10'
-    xmlns:textmd='info:lc/xmlns/textMD-v3'>
+      techmd_root = +<<~EOF
+        <technicalMetadata objectId='#{druid}' datetime='#{Time.now.utc.iso8601}'
+            xmlns:jhove='http://hul.harvard.edu/ois/xml/ns/jhove'
+            xmlns:mix='http://www.loc.gov/mix/v10'
+            xmlns:textmd='info:lc/xmlns/textMD-v3'>
       EOF
       doc = techmd_root
-      merged_nodes.keys.sort.each {|path| doc << merged_nodes[path] }
+      merged_nodes.keys.sort.each { |path| doc << merged_nodes[path] }
       doc + '</technicalMetadata>'
     end
-
   end
 end