dor-services 6.8.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85d61e2ff2890b4d25489c7dd7ecdd696d29b6dc1fc71939045cdb5ce801d914
-  data.tar.gz: 27b4b9d65371523af32aa306670d783e8da0abc9f04e44d3a001ad99ba2b7f6f
+  metadata.gz: af6de5f57ae4ad7e16df5978e27c65131671d88f32e0c006d5ea1389015c53a0
+  data.tar.gz: 5c478ce40e0e5a77ea9baecc8f2403d5b3d204629b7dfe315793e1ca0a6d86d8
 SHA512:
-  metadata.gz: f44b068a8964f6873fd493d3ef274cc98dd8faa9ba619ade56197892d3783a82ab83a9dae62edfd3cc5c7ef6c183f37ae8ed012ad2544941d31e51498d7e260d
-  data.tar.gz: cf2d94e214f0d002d64d01003cb52e8952167fa310c641f3809a4bcc8dd7235924d6461ca7cb42644b8c7e12c5f95a36c215ba69e1839f6703d555692e0ba9df
+  metadata.gz: 9ff7af6435417ea9e9b94e21ff2d986cc6fb36b31a2753a493301bc8ca0ab2dca1a7573e9999d151da645a7faaa235ee841882903221cd45eabb3cfb0ea05c01
+  data.tar.gz: 895a93feab7403be4f38c31708280e6978397c4641a758d815610fc767ea212059356243b32f9d649e34ec998d60a0c5d25a6427446f72cb0e9f14e10b1d78a2

data/config/config_defaults.yml

@@ -12,25 +12,11 @@
 :solr:
   :url:
   :opts: {}
-:solrizer: {} # deprecated
 :metadata:
   :catalog:
     :url:
     :user:
     :pass:
-:sdr:
-  :local_workspace_root: /dor/workspace
-  :local_export_home: /dor/export
-  :datastreams:
-    :rightsMetadata: optional
-    :descMetadata: required
-    :sourceMetadata: optional
-    :identityMetadata: required
-    :provenanceMetadata: required
-    :relationshipMetadata: required
-    :technicalMetadata: required
-    :contentMetadata: required
-  :rest_url: ""
 :stacks:
   :local_workspace_root: /dor
   :host:
@@ -54,16 +40,3 @@
   :shift_age: weekly
 :dor_services:
   :url:
-:dor_indexing_app:
-  :url:
-:indexing_svc:
-  :log: 'log/indexing_svc.log'
-  :log_date_format_str: '%Y-%m-%d %H:%M:%S.%L'
-  :log_rotation_interval: 'daily'
-:goobi:
-  :url:
-  :dpg_workflow_name: 'goobiWF'
-  :default_goobi_workflow_name: 'Example_Workflow'
-  :max_tries: 3
-  :max_sleep_seconds: 20
-  :base_sleep_seconds: 2

data/config/dev_console_env.rb.example

@@ -44,21 +44,4 @@ Dor::Config.configure do
     local_workspace_root '/dor/workspace'
     local_export_home    '/dor/export'
   end
-
-  sdr do
-    local_workspace_root '/dor/workspace'
-    local_export_home    '/dor/export'
-    datastreams do
-      contentMetadata      'required'
-      descMetadata         'required'
-      identityMetadata     'required'
-      provenanceMetadata   'required'
-      relationshipMetadata 'required'
-      rightsMetadata 'optional'
-      sourceMetadata 'optional'
-    end
-  end
-
-  accessioning_robot_sleep_time 30
-
 end

data/lib/dor-services.rb

@@ -4,28 +4,18 @@ require 'active_fedora'
 require 'active_fedora/version'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/object/blank'
-require 'dor/utils/sdr_client'
+require 'deprecation'
 
 module Dor
   extend ActiveSupport::Autoload
   @@registered_classes = {}
   mattr_reader :registered_classes
-  INDEX_VERSION_FIELD = 'dor_services_version_ssi'
 
   class << self
     def configure(*args, &block)
       Dor::Config.configure *args, &block
     end
 
-    # Load an object and inspect its identityMetadata to figure out what class
-    # to adapt it to. This is necessary when the object is not indexed, or the
-    # index is missing the objectType property.
-    # @param [String] pid The object's PID
-    def load_instance(pid)
-      Deprecation.warn(self, 'load_instance is deprecated, use Dor.find instead')
-      find(pid)
-    end
-
     # Load an object and inspect its identityMetadata to figure out what class
     # to adapt it to.
     # @param [String] pid The object's PID
@@ -34,27 +24,6 @@ module Dor
       Dor::Abstract.find pid, cast: true
     end
 
-    # TODO: return enumerable and lazy load_instance
-    # TODO: restrict fieldlist (fl) for non-:lightweight queries
-    def find_all(query, opts = {})
-      ActiveSupport::Deprecation.warn 'Dor.find_all is deprecated; use activefedora finders instead'
-
-      resp = SearchService.query query, opts
-      resp['response']['docs'].collect do |solr_doc|
-        find solr_doc['id']
-      end
-    end
-
-    # @deprecated
-    def ensure_models_loaded!
-      ActiveSupport::Deprecation.warn 'Dor.ensure_models_loaded! is unnecessary and has been deprecated.'
-      eager_load!
-    end
-
-    def root
-      File.dirname(__FILE__)
-    end
-
     def logger
       require 'logger'
       @logger ||= if defined?(::Rails) && ::Rails.respond_to?(:logger)
@@ -65,10 +34,6 @@ module Dor
     end
   end
 
-  def logger
-    Dor.logger
-  end
-
   require 'dor/version'
   require 'dor/config'
   require 'dor/exceptions'
@@ -116,34 +81,20 @@ module Dor
 
   # DOR Concerns
   autoload_under 'models/concerns' do
-    autoload :Identifiable
-    autoload :Itemizable
-    autoload :Processable
-    autoload :Governable
-    autoload :Describable
-    autoload :Publishable
-    autoload :Shelvable
     autoload :Embargoable
-    autoload :Preservable
-    autoload :Assembleable
-    autoload :Eventable
-    autoload :Versionable
-    autoload :Contentable
-    autoload :Discoverable
-    autoload :Geoable
-    autoload :Releaseable
-    autoload :Rightsable
   end
 
   eager_autoload do
     # ActiveFedora Classes
     autoload_under 'models' do
       autoload :Abstract
+      autoload :AdminPolicyObject
       autoload :Agreement
+      autoload :Collection
+      autoload :Etd
       autoload :Item
+      autoload :Part
       autoload :Set
-      autoload :Collection
-      autoload :AdminPolicyObject
       autoload :WorkflowObject
       autoload :WorkflowSolrDocument
     end
@@ -151,38 +102,23 @@ module Dor
 
   # Services
   autoload_under 'services' do
-    autoload :Ability
-    autoload :CleanupResetService
     autoload :CleanupService
+    autoload :CollectionService
     autoload :CreateWorkflowService
     autoload :CreativeCommonsLicenseService
-    autoload :DatastreamBuilder
-    autoload :DecommissionService
-    autoload :DigitalStacksService
-    autoload :DublinCoreService
-    autoload :FileMetadataMergeService
+    autoload :EmbargoService
     autoload :IndexingService
     autoload :MetadataService
-    autoload :MergeService
     autoload :Ontology
     autoload :OpenDataLicenseService
-    autoload :ProvenanceMetadataService
     autoload :PublicDescMetadataService
-    autoload :PublicXmlService
-    autoload :PublishMetadataService
-    autoload :RegistrationService
+    autoload :PublishedRelationshipsFilter
     autoload :ReleaseTagService
-    autoload :ResetWorkspaceService
-    autoload :SdrIngestService
     autoload :SearchService
-    autoload :SecondaryFileNameService
-    autoload :ShelvingService
     autoload :StatusService
     autoload :SuriService
     autoload :TagService
-    autoload :TechnicalMetadataService
     autoload :ThumbnailService
-    autoload :VersionService
   end
 
   # Workflow Classes
@@ -195,5 +131,5 @@ module Dor
   eager_load!
 
   require 'dor/utils/hydrus_shims'
-  require 'dor-workflow-service'
+  require 'dor/workflow/client'
 end

data/lib/dor/config.rb

@@ -32,25 +32,10 @@ module Dor
       result
     end
 
-    def autoconfigure(url, cert_file = Config.ssl.cert_file, key_file = Config.ssl.key_file, key_pass = Config.ssl.key_pass)
-      client = make_rest_client(url, cert_file, key_file, key_pass)
-      config = Confstruct::Configuration.symbolize_hash JSON.parse(client.get(accept: 'application/json'))
-      configure(config)
-    end
-    deprecation_deprecate :autoconfigure
-
     def sanitize
       dup
     end
 
-    def make_rest_client(url, cert = Config.ssl.cert_file, key = Config.ssl.key_file, pass = Config.ssl.key_pass)
-      params = {}
-      params[:ssl_client_cert] = OpenSSL::X509::Certificate.new(File.read(cert)) if cert
-      params[:ssl_client_key]  = OpenSSL::PKey::RSA.new(File.read(key), pass) if key
-      RestClient::Resource.new(url, params)
-    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
@@ -78,13 +63,9 @@ module Dor
         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
+            @wfs ||= Dor::Workflow::Client.new(url: c.url, logger: c.client_logger, timeout: c.timeout)
           end,
           client_logger: Confstruct.deferred do |c|
                            if c.logfile && c.shift_age
@@ -101,16 +82,6 @@ module Dor
     set_callback :configure, :after do |config|
       configure_client!(config)
 
-      if config.solrizer.present?
-        stack = Kernel.caller.dup
-        stack.shift while stack[0] =~ %r{(active_support/callbacks|dor/config|dor-services)\.rb}
-        ActiveSupport::Deprecation.warn 'Dor::Config -- solrizer configuration is deprecated. Please use solr instead.', stack
-
-        config.solrizer.each do |k, v|
-          config.solr[k] ||= v
-        end
-      end
-
       if config.solr.url.present?
         ActiveFedora::SolrService.register
         ActiveFedora::SolrService.instance.instance_variable_set :@conn, make_solr_connection

data/lib/dor/datastreams/content_metadata_ds.rb

@@ -127,6 +127,14 @@ module Dor
     ### END: READ ONLY METHODS
     ### DATSTREAM WRITING METHODS
 
+    def unshelve_and_unpublish
+      ng_xml.xpath('/contentMetadata/resource//file').each_with_index do |file_node, index|
+        ng_xml_will_change! if index == 0
+        file_node['publish'] = 'no'
+        file_node['shelve'] = 'no'
+      end
+    end
+
     # @param [Object] file
     # @param [String] resource_name
     # @return [Nokogiri::XML::Node] the added XML node

data/lib/dor/datastreams/desc_metadata_ds.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
+require 'stanford-mods'
+
 module Dor
+  # Descriptive metadata
   class DescMetadataDS < ActiveFedora::OmDatastream
     MODS_NS = 'http://www.loc.gov/mods/v3'
     MODS_HEADER_CONFIG = {
@@ -61,6 +64,22 @@ module Dor
       update_values(%i[title_info main_title] => val)
     end
 
+    # intended for read-access, "as SearchWorks would see it", mostly for to_solr()
+    # @param [Nokogiri::XML::Document] content Nokogiri descMetadata document (overriding internal data)
+    # @param [boolean] ns_aware namespace awareness toggle for from_nk_node()
+    def stanford_mods(content = nil, ns_aware = true)
+      @stanford_mods ||= begin
+        m = Stanford::Mods::Record.new
+        desc = content.nil? ? ng_xml : content
+        m.from_nk_node(desc.root, ns_aware)
+        m
+      end
+    end
+
+    def full_title
+      stanford_mods.sw_title_display
+    end
+
     # maintain AF < 8 indexing behavior
     def prefix
       ''

data/lib/dor/datastreams/identity_metadata_ds.rb

@@ -1,9 +1,14 @@
 # frozen_string_literal: true
 
 module Dor
+  # Object identity and source metadata
   class IdentityMetadataDS < ActiveFedora::OmDatastream
     include SolrDocHelper
 
+    # ids for previous and current catkeys
+    CATKEY_TYPE_ID = 'catkey'
+    PREVIOUS_CATKEY_TYPE_ID = 'previous_catkey'
+
     set_terminology do |t|
       t.root(path: 'identityMetadata')
       t.objectId   index_as: [:symbol]
@@ -42,6 +47,7 @@ module Dor
       node = find_by_terms(:sourceId).first
       node ? [node['source'], node.text].join(':') : nil
     end
+    alias source_id sourceId
 
     # @param  [String, Nil] value The value to set or a nil/empty string to delete sourceId node
     # @return [String, Nil] The same value, as per Ruby convention for assignment operators
@@ -61,11 +67,18 @@ module Dor
       node['source'] = parts[0]
       node.content = parts[1]
     end
+    alias source_id= sourceId=
 
     def tags
       ng_xml.search('//tag').collect(&:content)
     end
 
+    # helper method to get just the content type tag
+    def content_type_tag
+      content_tag = tags.select { |tag| tag.include?('Process : Content Type') }
+      content_tag.size == 1 ? content_tag[0].split(':').last.strip : ''
+    end
+
     def otherId(type = nil)
       result = find_by_terms(:otherId).to_a
       if type.nil?
@@ -84,6 +97,58 @@ module Dor
       node
     end
 
+    def add_other_Id(type, val)
+      raise 'There is an existing entry for ' + type + ', consider using update_other_Id().' if otherId(type).length > 0
+
+      add_otherId(type + ':' + val)
+    end
+
+    def update_other_Id(type, new_val, val = nil)
+      ng_xml.search('//otherId[@name=\'' + type + '\']')
+            .select { |node| val.nil? || node.content == val }
+            .each { ng_xml_will_change! }
+            .each { |node| node.content = new_val }
+            .any?
+    end
+
+    def remove_other_Id(type, val = nil)
+      ng_xml.search('//otherId[@name=\'' + type + '\']')
+            .select { |node| val.nil? || node.content == val }
+            .each { ng_xml_will_change! }
+            .each(&:remove)
+            .any?
+    end
+
+    # Convenience method to get the current catkey
+    # @return [String] current catkey value (or nil if none found)
+    def catkey
+      otherId(CATKEY_TYPE_ID).first
+    end
+
+    # Convenience method to set the catkey
+    # @param  [String] val the new source identifier
+    # @return [String] same value, as per Ruby assignment convention
+    def catkey=(val)
+      # if there was already a catkey in the record, store that in the "previous" spot (assuming there is no change)
+      add_otherId("#{PREVIOUS_CATKEY_TYPE_ID}:#{catkey}") if val != catkey && !catkey.blank?
+
+      if val.blank? # if we are setting the catkey to blank, remove the node from XML
+        remove_other_Id(CATKEY_TYPE_ID)
+      elsif catkey.blank? # if there is no current catkey, then add it
+        add_other_Id(CATKEY_TYPE_ID, val)
+      else # if there is a current catkey, update the current catkey to the new value
+        update_other_Id(CATKEY_TYPE_ID, val)
+      end
+
+      val
+    end
+
+    # Convenience method to get the previous catkeys (will be an array)
+    # @return [Array] previous catkey values (empty array if none found)
+    def previous_catkeys
+      otherId(PREVIOUS_CATKEY_TYPE_ID)
+    end
+
     def to_solr(solr_doc = {}, *args)
       solr_doc = super(solr_doc, *args)
 

data/lib/dor/datastreams/rights_metadata_ds.rb

@@ -120,7 +120,6 @@ module Dor
     end
 
     # @param rights [string] archetypical rights to assign: 'world', 'stanford', 'none', 'dark', etc
-    # Moved from Governable
     # slight misnomer: also sets discover rights!
     # TODO: convert xpath reads to dra_object calls
     def set_read_rights(rights)
@@ -216,5 +215,18 @@ module Dor
     def prefix
       ''
     end
-  end # class
+
+    def rights
+      xml = ng_xml
+      if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
+        'Stanford'
+      elsif xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length == 1
+        'World'
+      elsif xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
+        'Dark'
+      else
+        'None'
+      end
+    end
+  end
 end