dor-services 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cddc117f7297f0e5610b46e5ef181dba30fb0fcd57d7a4f21309cd68a5d5eee8
-  data.tar.gz: 203483f92135bffbb04b40be6e4673153863eb305518f87922b8a7027797abe8
+  metadata.gz: '07199060c4d04ee110cd61aff79d908be4d75a4c9dc2393519b5a591490b15ea'
+  data.tar.gz: 8b7d431a98aafbad4ea03501ef1bbbc89ca0eee839f4b3d653ff4c97f0dd2c64
 SHA512:
-  metadata.gz: 14cdd9ea0fa92d23c000de0f992209d9ceff820e143716b0c479ffde26c26c822c73f51f8d799e0ce6820f50beced8e2f0c69f0aca3266227a0341782f1a50ca
-  data.tar.gz: 4056a91b565637a56a126c35998ddbf1f1a8653821587d1a4ddba823a33df82b3a626a6747b0bc6bd6b8bd0cd6efb4e42c82178a698fbca300b33e9782198d37
+  metadata.gz: 06ed4c473c5616f84d1beb3b877e0d4d5d860c0a4b13ecc9b91fbc519708392d78bca9a5cdcda31b63e1a9f17f994cd5c1e58f84d15eb72c4e6f05aebbbe46c8
+  data.tar.gz: 7ae86baac69973b6b1fd00ac04b7a9a6e4c4bb8dabc29979656897ff19c7dfc5f51ce8bc77f6683707afb391a27609c770f792b48d0cbe5b2795077db2425441

data/lib/dor-services.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_fedora'
 require 'active_fedora/version'
 require 'active_support/core_ext/module/attribute_accessors'
@@ -8,10 +10,9 @@ module Dor
   extend ActiveSupport::Autoload
   @@registered_classes = {}
   mattr_reader :registered_classes
-  INDEX_VERSION_FIELD = 'dor_services_version_ssi'.freeze
+  INDEX_VERSION_FIELD = 'dor_services_version_ssi'
 
   class << self
-
     def configure(*args, &block)
       Dor::Config.configure *args, &block
     end
@@ -57,10 +58,10 @@ module Dor
     def logger
       require 'logger'
       @logger ||= if defined?(::Rails) && ::Rails.respond_to?(:logger)
-          Rails.logger
-        else
-          Logger.new(STDOUT)
-        end
+                    Rails.logger
+                  else
+                    Logger.new(STDOUT)
+                  end
     end
   end
 

data/lib/dor/certificate_authenticated_rest_resource_factory.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'dor/rest_resource_factory'
 # Creates RestClient::Resources with client ssl keys for various connections
 module Dor
   class CertificateAuthenticatedRestResourceFactory < RestResourceFactory
-
     private
 
     # @return [Hash] options for creating a RestClient::Resource

data/lib/dor/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'confstruct/configuration'
 require 'rsolr'
 require 'yaml'
@@ -11,7 +13,7 @@ module Dor
 
     def initialize(*args)
       super *args
-      run_callbacks(:initialize) { }
+      run_callbacks(:initialize) {}
     end
 
     # Call the super method with callbacks and with $VERBOSE temporarily disabled
@@ -48,7 +50,6 @@ module Dor
     end
     deprecation_deprecate :make_rest_client
 
-
     def make_solr_connection(add_opts = {})
       opts = Dor::Config.solr.opts.merge(add_opts).merge(
         :url => Dor::Config.solr.url
@@ -58,41 +59,41 @@ module Dor
 
     set_callback :initialize, :after do |config|
       config.deep_merge!({
-        :fedora => {
-          :client => Confstruct.deferred { |c| CertificateAuthenticatedRestResourceFactory.create(:fedora) },
-          :safeurl => Confstruct.deferred { |c|
-            begin
-              fedora_uri = URI.parse(config.fedora.url)
-              fedora_uri.user = fedora_uri.password = nil
-              fedora_uri.to_s
-            rescue URI::InvalidURIError
-              nil
-            end
-          }
-        },
-        :dor_services => {
-          :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:dor_services) }
-        },
-        :purl_services => {
-          :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:purl_services) }
-        },
-        :sdr => {
-          :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:sdr) }
-        },
-        :workflow => {
-          :client => Confstruct.deferred do |c|
-            Dor::WorkflowService.configure c.url, logger: c.client_logger, timeout: c.timeout, dor_services_url: config.dor_services.url
-            Dor::WorkflowService
-          end,
-          :client_logger => Confstruct.deferred do |c|
-            if c.logfile && c.shift_age
-              Logger.new(c.logfile, c.shift_age)
-            elsif c.logfile
-              Logger.new(c.logfile)
-            end
-          end
-        }
-      })
+                           :fedora => {
+                             :client => Confstruct.deferred { |c| CertificateAuthenticatedRestResourceFactory.create(:fedora) },
+                             :safeurl => Confstruct.deferred { |c|
+                               begin
+                                 fedora_uri = URI.parse(config.fedora.url)
+                                 fedora_uri.user = fedora_uri.password = nil
+                                 fedora_uri.to_s
+                               rescue URI::InvalidURIError
+                                 nil
+                               end
+                             }
+                           },
+                           :dor_services => {
+                             :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:dor_services) }
+                           },
+                           :purl_services => {
+                             :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:purl_services) }
+                           },
+                           :sdr => {
+                             :rest_client => Confstruct.deferred { |c| RestResourceFactory.create(:sdr) }
+                           },
+                           :workflow => {
+                             :client => Confstruct.deferred do |c|
+                               Dor::WorkflowService.configure c.url, logger: c.client_logger, timeout: c.timeout, dor_services_url: config.dor_services.url
+                               Dor::WorkflowService
+                             end,
+                             :client_logger => Confstruct.deferred do |c|
+                                                 if c.logfile && c.shift_age
+                                                   Logger.new(c.logfile, c.shift_age)
+                                                 elsif c.logfile
+                                                   Logger.new(c.logfile)
+                                                 end
+                                               end
+                           }
+                         })
       true
     end
 

data/lib/dor/datastreams/administrative_metadata_ds.rb

@@ -1,124 +1,124 @@
+# frozen_string_literal: true
+
 module Dor
-class AdministrativeMetadataDS < ActiveFedora::OmDatastream
-
-  set_terminology do |t|
-    t.root :path => 'administrativeMetadata', :index_as => [:not_searchable]
-    t.metadata_format :path => 'descMetadata/format'
-    t.admin_metadata_format :path => 'descMetadata/format', :index_as => [:symbol]
-    t.metadata_source :path => 'descMetadata/source', :index_as => [:symbol]
-    t.descMetadata do
-      t.source
-      t.format
-    end
-    # Placeholders for existing defined stanzas to be fleshed out as needed
-    t.contact :index_as => [:not_searchable]
-    t.rights :index_as => [:not_searchable]
-    t.relationships :index_as => [:not_searchable]
-    t.registration :index_as => [:not_searchable] do
-      t.agreementId
-      t.itemTag
-      t.workflow_id :path => 'workflow/@id', :index_as => [:symbol]
-      t.default_collection :path => 'collection/@id'
-    end
-    t.workflow :path => 'registration/workflow'
-    t.deposit :index_as => [:not_searchable]
+  class AdministrativeMetadataDS < ActiveFedora::OmDatastream
+    set_terminology do |t|
+      t.root :path => 'administrativeMetadata', :index_as => [:not_searchable]
+      t.metadata_format :path => 'descMetadata/format'
+      t.admin_metadata_format :path => 'descMetadata/format', :index_as => [:symbol]
+      t.metadata_source :path => 'descMetadata/source', :index_as => [:symbol]
+      t.descMetadata do
+        t.source
+        t.format
+      end
+      # Placeholders for existing defined stanzas to be fleshed out as needed
+      t.contact :index_as => [:not_searchable]
+      t.rights :index_as => [:not_searchable]
+      t.relationships :index_as => [:not_searchable]
+      t.registration :index_as => [:not_searchable] do
+        t.agreementId
+        t.itemTag
+        t.workflow_id :path => 'workflow/@id', :index_as => [:symbol]
+        t.default_collection :path => 'collection/@id'
+      end
+      t.workflow :path => 'registration/workflow'
+      t.deposit :index_as => [:not_searchable]
 
-    t.accessioning :index_as => [:not_searchable] do
-      t.workflow_id :path => 'workflow/@id', :index_as => [:symbol]
-    end
+      t.accessioning :index_as => [:not_searchable] do
+        t.workflow_id :path => 'workflow/@id', :index_as => [:symbol]
+      end
 
-    t.preservation :index_as => [:not_searchable]
-    t.dissemination :index_as => [:not_searchable] do
-      t.harvester
-      t.releaseDelayLimit
-    end
-    t.defaults do
-      t.initiate_workflow :path => 'initiateWorkflow' do
-        t.lane :path => { :attribute => 'lane' }
+      t.preservation :index_as => [:not_searchable]
+      t.dissemination :index_as => [:not_searchable] do
+        t.harvester
+        t.releaseDelayLimit
       end
-      t.shelving :path => 'shelving' do
-        t.path :path => { :attribute => 'path'}
+      t.defaults do
+        t.initiate_workflow :path => 'initiateWorkflow' do
+          t.lane :path => { :attribute => 'lane' }
+        end
+        t.shelving :path => 'shelving' do
+          t.path :path => { :attribute => 'path' }
+        end
       end
     end
-  end
 
-  define_template :default_collection do |xml|
-    xml.administrativeMetadata {
-      xml.registration {
-        xml.collection(:id => '')
+    define_template :default_collection do |xml|
+      xml.administrativeMetadata {
+        xml.registration {
+          xml.collection(:id => '')
+        }
       }
-    }
-  end
+    end
 
-  define_template :agreementId do |xml|
-    xml.administrativeMetadata {
-      xml.registration {
-        xml.agreementId
+    define_template :agreementId do |xml|
+      xml.administrativeMetadata {
+        xml.registration {
+          xml.agreementId
+        }
       }
-    }
-  end
-
-  define_template :metadata_format do |xml|
-    xml.descMetadata {
-      xml.format
-    }
-  end
+    end
 
-  define_template :metadata_source do |xml|
-    xml.administrativeMetadata {
+    define_template :metadata_format do |xml|
       xml.descMetadata {
-        xml.source
+        xml.format
       }
-    }
-  end
+    end
 
-  define_template :registration do |xml|
-    xml.administrativeMetadata {
-      xml.registration {
-        xml.workflow(:id => '')
+    define_template :metadata_source do |xml|
+      xml.administrativeMetadata {
+        xml.descMetadata {
+          xml.source
+        }
       }
-    }
-  end
+    end
 
-  define_template :default_collection do |xml|
-    xml.administrativeMetadata {
-      xml.registration {
-        xml.collection
+    define_template :registration do |xml|
+      xml.administrativeMetadata {
+        xml.registration {
+          xml.workflow(:id => '')
+        }
       }
-    }
-  end
+    end
 
-  def self.xml_template
-    Nokogiri::XML::Builder.new do |xml|
-      xml.administrativeMetadata { }
-    end.doc
-  end
+    define_template :default_collection do |xml|
+      xml.administrativeMetadata {
+        xml.registration {
+          xml.collection
+        }
+      }
+    end
 
-  #################################################################################
-  # Convenience methods to get and set properties
-  # Hides complexity/verbosity of OM TermOperators for simple, non-repeating values
-  #################################################################################
+    def self.xml_template
+      Nokogiri::XML::Builder.new do |xml|
+        xml.administrativeMetadata {}
+      end.doc
+    end
 
-  def default_workflow_lane=(lane)
-    defaults.initiate_workflow.lane = lane
-  end
+    #################################################################################
+    # Convenience methods to get and set properties
+    # Hides complexity/verbosity of OM TermOperators for simple, non-repeating values
+    #################################################################################
 
-  def default_workflow_lane
-    defaults.initiate_workflow.lane.first
-  end
+    def default_workflow_lane=(lane)
+      defaults.initiate_workflow.lane = lane
+    end
 
-  def default_shelving_path=(path)
-    defaults.shelving.path = path
-  end
+    def default_workflow_lane
+      defaults.initiate_workflow.lane.first
+    end
 
-  def default_shelving_path
-    defaults.shelving.path.first
-  end
+    def default_shelving_path=(path)
+      defaults.shelving.path = path
+    end
 
-  # maintain AF < 8 indexing behavior
-  def prefix
-    ''
-  end
+    def default_shelving_path
+      defaults.shelving.path.first
+    end
 
-end
+    # maintain AF < 8 indexing behavior
+    def prefix
+      ''
+    end
+  end
 end

data/lib/dor/datastreams/content_metadata_ds.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Dor
   class ContentMetadataDS < ActiveFedora::OmDatastream
-
     set_terminology do |t|
       t.root        :path => 'contentMetadata',          :index_as => [:not_searchable]
       t.contentType :path => '/contentMetadata/@type',   :index_as => [:not_searchable]
@@ -27,7 +28,7 @@ module Dor
             t.type_ :path => { :attribute => 'type' }
           end
         end
-        t.shelved_file(:path => 'file', :attributes => {:shelve => 'yes'}, :index_as => [:not_searchable]) do
+        t.shelved_file(:path => 'file', :attributes => { :shelve => 'yes' }, :index_as => [:not_searchable]) do
           t.id_ :path => { :attribute => 'id' }, :index_as => [:displayable, :stored_searchable]
         end
       end
@@ -45,6 +46,7 @@ module Dor
       len  = node.length
       raise "#{xpath} not found" if len < 1
       raise "#{xpath} duplicated: #{len} found" if len != 1
+
       node.first
     end
 
@@ -105,15 +107,15 @@ module Dor
           file_roles << file['role'] if file['role']
         end
       end
-      solr_doc['content_type_ssim'              ] = doc.root['type']
-      solr_doc['content_file_mimetypes_ssim'    ] = mime_types.to_a
-      solr_doc['content_file_count_itsi'        ] = counts['content_file']
+      solr_doc['content_type_ssim'] = doc.root['type']
+      solr_doc['content_file_mimetypes_ssim'] = mime_types.to_a
+      solr_doc['content_file_count_itsi'] = counts['content_file']
       solr_doc['shelved_content_file_count_itsi'] = counts['shelved_file']
-      solr_doc['resource_count_itsi'            ] = counts['resource']
-      solr_doc['preserved_size_dbtsi'           ] = preserved_size # double (trie) to support very large sizes
-      solr_doc['shelved_size_dbtsi'             ] = shelved_size # double (trie) to support very large sizes
-      solr_doc['resource_types_ssim'            ] = resource_type_counts.keys if resource_type_counts.size > 0
-      solr_doc['content_file_roles_ssim'        ] = file_roles.to_a if file_roles.size > 0
+      solr_doc['resource_count_itsi'] = counts['resource']
+      solr_doc['preserved_size_dbtsi'] = preserved_size # double (trie) to support very large sizes
+      solr_doc['shelved_size_dbtsi'] = shelved_size # double (trie) to support very large sizes
+      solr_doc['resource_types_ssim'] = resource_type_counts.keys if resource_type_counts.size > 0
+      solr_doc['content_file_roles_ssim'] = file_roles.to_a if file_roles.size > 0
       resource_type_counts.each do |key, count|
         solr_doc["#{key}_resource_count_itsi"] = count
       end
@@ -131,24 +133,26 @@ module Dor
     def add_file(file, resource_name)
       resource_nodes = ng_xml.search('//resource[@id=\'' + resource_name + '\']')
       raise 'resource doesnt exist.' if resource_nodes.length == 0
+
       self.ng_xml_will_change!
 
       node = resource_nodes.first
       file_node = Nokogiri::XML::Node.new('file', ng_xml)
       file_node['id'] = file[:name]
-      file_node['shelve'  ] = file[:shelve  ] ? file[:shelve  ] : ''
-      file_node['publish' ] = file[:publish ] ? file[:publish ] : ''
-      file_node['preserve'] = file[:preserve] ? file[:preserve] : ''
+      file_node['shelve'] = file[:shelve] || ''
+      file_node['publish'] = file[:publish] || ''
+      file_node['preserve'] = file[:preserve] || ''
       node.add_child(file_node)
 
       [:md5, :sha1].each do |algo|
         next unless file[algo]
+
         checksum_node = Nokogiri::XML::Node.new('checksum', ng_xml)
         checksum_node['type'] = algo.to_s
         checksum_node.content = file[algo]
         file_node.add_child(checksum_node)
       end
-      file_node['size'    ] = file[:size     ] if file[:size     ]
+      file_node['size'] = file[:size] if file[:size]
       file_node['mimetype'] = file[:mime_type] if file[:mime_type]
       file_node['role'] = file[:role] if file[:role]
       file_node
@@ -186,6 +190,7 @@ module Dor
     # @return [Nokogiri::XML::Node] the new resource that was added to the contentMetadata
     def add_resource(files, resource_name, position, type = 'file')
       raise "resource #{resource_name} already exists" if ng_xml.search('//resource[@id=\'' + resource_name + '\']').length > 0
+
       self.ng_xml_will_change!
       max = ng_xml.search('//resource').map { |node| node['sequence'].to_i }.max
       # renumber all of the resources that will come after the newly added one
@@ -200,12 +205,13 @@ module Dor
       node['type']     = type
       files.each do |file|
         file_node = Nokogiri::XML::Node.new('file', ng_xml)
-        %w(shelve publish preserve).each {|x| file_node[x] = file[x.to_sym] ? file[x.to_sym] : '' }
+        %w(shelve publish preserve).each { |x| file_node[x] = file[x.to_sym] || '' }
         file_node['id'] = file[:name]
         node.add_child(file_node)
 
         [:md5, :sha1].each { |algo|
           next if file[algo].nil?
+
           checksum_node = Nokogiri::XML::Node.new('checksum', ng_xml)
           checksum_node['type'] = algo.to_s
           checksum_node.content = file[algo]
@@ -227,6 +233,7 @@ module Dor
       loop do
         res = ng_xml.search('//resource[@sequence=\'' + position.to_s + '\']')
         break if res.length == 0
+
         res['sequence'] = position.to_s
         position += 1
       end
@@ -245,8 +252,8 @@ module Dor
     def update_attributes(file_name, publish, shelve, preserve, attributes = {})
       self.ng_xml_will_change!
       file_node = ng_xml.search('//file[@id=\'' + file_name + '\']').first
-      file_node['publish' ] = publish
-      file_node['shelve'  ] = shelve
+      file_node['publish'] = publish
+      file_node['shelve'] = shelve
       file_node['preserve'] = preserve
       attributes.each do |key, value|
         file_node[key] = value
@@ -261,6 +268,7 @@ module Dor
       file_node['id'] = file[:name]
       [:md5, :sha1].each { |algo|
         next if file[algo].nil?
+
         checksum_node = ng_xml.search('//file[@id=\'' + old_file_id + '\']/checksum[@type=\'' + algo.to_s + '\']').first
         if checksum_node.nil?
           checksum_node = Nokogiri::XML::Node.new('checksum', ng_xml)
@@ -321,6 +329,7 @@ module Dor
       position = node['sequence'].to_i
       new_position = new_position.to_i # tolerate strings as a Legacy behavior
       return node if position == new_position
+
       # otherwise, is the resource being moved earlier in the sequence or later?
       up = new_position > position
       others = new_position..(up ? position - 1 : position + 1) # a range