dor-services 5.4.2 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f647df9fcf225b255d735ada30da8bc2341fec8d
-  data.tar.gz: f658e61c9dee49e0d9393fa458f48dd3f9079577
+  metadata.gz: 38084c1790b717b6ad1dacf15e9e6112eb3117bb
+  data.tar.gz: 7980a4ed6fb6fd68d600398871e329a193e7102f
 SHA512:
-  metadata.gz: f973016488d017947ceb2009c2695e63faf856197169d4488c84a32c34142d0d52aa8a83be6f4ef3b6fed75d4f1c16f6ef0608bf3325337f86ee6f23ed96cbb1
-  data.tar.gz: f6df2fce0ada1ed23bf924d3ee234e88b5fca0ebc16d6dd79746de7121fc79fc7fc8256bb425552dfb1cb23cb5d37a03ef572b59cac8b0bb2d8306a6e590103d
+  metadata.gz: f7f0f82b7290f1e32e655be2378ce21a5ce9bd33c293a0125fc6e4065e6c6c4b594b463f2f5f5d408e5e76228b96e364a0f90571eb5bfc1bf847247973be400c
+  data.tar.gz: 9d95ba69a57d954498f7c22d66c596f18681b9e70962a15e90f944dcb000bc7764503ae685dcd094714d4cd8e94b3a110f1ada4b8b0db0e688e36bd8af00f725

data/lib/dor-services.rb

@@ -2,6 +2,7 @@ require 'active_fedora'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'modsulator'
 require 'nokogiri-pretty'
+require 'dor/utils/sdr_client'
 
 module Dor
   @@registered_classes = {}

data/lib/dor/config.rb

@@ -25,15 +25,6 @@ module Dor
       ensure
         $-v = temp_v
       end
-      params = { :dor_services_url => result.dor_services.url }
-
-      if result.workflow.logfile && result.workflow.shift_age
-        params[:logger] = Logger.new(result.workflow.logfile, result.workflow.shift_age)
-      elsif result.workflow.logfile
-        params[:logger] = Logger.new(result.workflow.logfile)
-      end
-      params[:timeout] = result.workflow.timeout if result.workflow.timeout
-      Dor::WorkflowService.configure result.workflow.url, params
       result
     end
 
@@ -84,6 +75,19 @@ module Dor
         :stomp => {
           :connection => Confstruct.deferred { |c| Stomp::Connection.new c.user, c.password, c.host, c.port, true, 5, { 'client-id' => c.client_id }},
           :client => Confstruct.deferred { |c| Stomp::Client.new c.user, c.password, c.host, c.port }
+        },
+        :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

data/lib/dor/datastreams/workflow_definition_ds.rb

@@ -70,7 +70,7 @@ class WorkflowDefinitionDs < ActiveFedora::OmDatastream
     end
   end
 
-  # Creates the xml used by Dor::WorkflowService.create_workflow
+  # Creates the xml used by Dor::WorkflowService#create_workflow
   # @return [String] An object's initial workflow as defined by the <workflow-def> in content
   def initial_workflow
     doc = Nokogiri::XML('<workflow/>')

data/lib/dor/datastreams/workflow_ds.rb

@@ -17,7 +17,7 @@ module Dor
     end
 
     def get_workflow(wf, repo = 'dor')
-      xml = Dor::WorkflowService.get_workflow_xml(repo, pid, wf)
+      xml = Dor::Config.workflow.client.get_workflow_xml(repo, pid, wf)
       xml = Nokogiri::XML(xml)
       return nil if xml.xpath('workflow').length == 0
       Workflow::Document.new(xml.to_s)
@@ -34,12 +34,12 @@ module Dor
     # service directly
     def content(refresh = false)
       @content = nil if refresh
-      @content ||= Dor::WorkflowService.get_workflow_xml 'dor', pid, nil
-    rescue Dor::WorkflowException => e
+      @content ||= Dor::Config.workflow.client.get_workflow_xml 'dor', pid, nil
+    rescue Dor::WorkflowException
       xml = Nokogiri::XML(%(<?xml version="1.0" encoding="UTF-8" standalone="yes"?>\n<workflows objectId="#{pid}"/>))
       digital_object.datastreams.keys.each do |dsid|
         next unless dsid =~ /WF$/
-        ds_content = Nokogiri::XML(Dor::WorkflowService.get_workflow_xml 'dor', pid, dsid)
+        ds_content = Nokogiri::XML(Dor::Config.workflow.client.get_workflow_xml('dor', pid, dsid))
         xml.root.add_child(ds_content.root)
       end
       @content ||= xml.to_xml

data/lib/dor/models/governable.rb

@@ -10,7 +10,7 @@ module Dor
     end
 
     def initiate_apo_workflow(name)
-      initialize_workflow(name, !self.new_object?)
+      create_workflow(name, !self.new_object?)
     end
 
     # Returns the default lane_id from the item's APO.  Will return 'default' if the item does not have

data/lib/dor/models/itemizable.rb

@@ -10,7 +10,6 @@ module Dor
     end
 
     DIFF_FILENAME = 'cm_inv_diff'
-    DIFF_QUERY = DIFF_FILENAME.tr('_', '-')
 
     # Deletes all cm_inv_diff files in the workspace for the Item
     def clear_diff_cache
@@ -31,25 +30,13 @@ module Dor
       if Dor::Config.stacks.local_workspace_root.nil?
         raise Dor::ParameterError, 'Missing Dor::Config.stacks.local_workspace_root'
       end
-      unless %w(all shelve preserve publish).include?(subset.to_s)
-        raise Dor::ParameterError, "Invalid subset value: #{subset}"
-      end
 
-      # fetch content metadata inventory difference from SDR
-      if Dor::Config.sdr.rest_client.nil?
-        raise Dor::ParameterError, 'Missing Dor::Config.sdr.rest_client'
-      end
-      sdr_client = Dor::Config.sdr.rest_client
       current_content = datastreams['contentMetadata'].content
       if current_content.nil?
         raise Dor::Exception, 'Missing contentMetadata datastream'
       end
-      query_string = { :subset => subset.to_s }
-      query_string[:version] = version.to_s unless version.nil?
-      query_string = URI.encode_www_form(query_string)
-      sdr_query = "objects/#{pid}/#{DIFF_QUERY}?#{query_string}"
-      response = sdr_client[sdr_query].post(current_content, :content_type => 'application/xml')
-      response
+
+      Sdr::Client.get_content_diff(druid, current_content, subset, version)
     end
   end
 end

data/lib/dor/models/processable.rb

@@ -100,7 +100,7 @@ module Dor
     end
 
     def milestones
-      Dor::WorkflowService.get_milestones('dor', pid)
+      Dor::Config.workflow.client.get_milestones('dor', pid)
     end
 
     # @return [Hash{Symbol => Object}] including :current_version, :status_code and :status_time
@@ -214,7 +214,7 @@ module Dor
       priority = workflows.current_priority if priority == 0
       opts = { :create_ds => create_ds, :lane_id => default_workflow_lane }
       opts[:priority] = priority if priority > 0
-      Dor::WorkflowService.create_workflow(Dor::WorkflowObject.initial_repo(name), pid, name, Dor::WorkflowObject.initial_workflow(name), opts)
+      Dor::Config.workflow.client.create_workflow(Dor::WorkflowObject.initial_repo(name), pid, name, Dor::WorkflowObject.initial_workflow(name), opts)
       workflows.content(true) # refresh the copy of the workflows datastream
     end
 

data/lib/dor/models/releaseable.rb

@@ -20,7 +20,7 @@ module Dor
 
       # Save item to dor so the robots work with the latest data
       save
-      initialize_workflow('releaseWF')
+      create_workflow('releaseWF')
     end
 
     # Generate XML structure for inclusion to Purl

data/lib/dor/models/shelvable.rb

@@ -25,8 +25,7 @@ module Dor
     # retrieve the differences between the current contentMetadata and the previously ingested version
     # (filtering to select only the files that should be shelved to stacks)
     def get_shelve_diff
-      inventory_diff_xml = get_content_diff(:shelve)
-      inventory_diff = Moab::FileInventoryDifference.parse(inventory_diff_xml)
+      inventory_diff = get_content_diff(:shelve)
       shelve_diff = inventory_diff.group_difference('content')
       shelve_diff
     end

data/lib/dor/models/versionable.rb

@@ -1,5 +1,3 @@
-require 'dor/utils/sdr_client'
-
 module Dor
   module Versionable
     extend ActiveSupport::Concern
@@ -12,15 +10,15 @@ module Dor
     # 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, initialize_workflow() will not initialize the workflows datastream.
+    # @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 = {})
       # During local development, we need a way to open a new version even if the object has not been accessioned.
       raise(Dor::Exception, 'Object net yet accessioned') unless
-        opts[:assume_accessioned] || Dor::WorkflowService.get_lifecycle('dor', pid, 'accessioned')
+        opts[:assume_accessioned] || Dor::Config.workflow.client.get_lifecycle('dor', pid, 'accessioned')
       raise Dor::Exception, 'Object already opened for versioning' if new_version_open?
-      raise Dor::Exception, 'Object currently being accessioned' if Dor::WorkflowService.get_active_lifecycle('dor', pid, 'submitted')
+      raise Dor::Exception, 'Object currently being accessioned' if Dor::Config.workflow.client.get_active_lifecycle('dor', pid, 'submitted')
 
       sdr_version = Sdr::Client.current_version pid
 
@@ -32,9 +30,9 @@ module Dor
       k = :create_workflows_ds
       if opts.key?(k)
         # During local development, Hydrus (or another app w/ local Fedora) does not want to initialize workflows datastream.
-        initialize_workflow('versioningWF', opts[k])
+        create_workflow('versioningWF', opts[k])
       else
-        initialize_workflow('versioningWF')
+        create_workflow('versioningWF')
       end
 
       vmd_upd_info = opts[:vers_md_upd_info]
@@ -65,20 +63,20 @@ module Dor
 
       raise Dor::Exception, 'latest version in versionMetadata requires tag and description before it can be closed' unless datastreams['versionMetadata'].current_version_closeable?
       raise Dor::Exception, 'Trying to close version on an object not opened for versioning' unless new_version_open?
-      raise Dor::Exception, 'accessionWF already created for versioned object' if Dor::WorkflowService.get_active_lifecycle('dor', pid, 'submitted')
+      raise Dor::Exception, 'accessionWF already created for versioned object' if Dor::Config.workflow.client.get_active_lifecycle('dor', pid, 'submitted')
 
-      Dor::WorkflowService.close_version 'dor', pid, opts.fetch(:start_accession, true)  # Default to creating accessionWF when calling close_version
+      Dor::Config.workflow.client.close_version 'dor', pid, opts.fetch(:start_accession, true)  # Default to creating accessionWF when calling close_version
     end
 
     # @return [Boolean] true if 'opened' lifecycle is active, false otherwise
     def new_version_open?
-      return true if Dor::WorkflowService.get_active_lifecycle('dor', pid, 'opened')
+      return true if Dor::Config.workflow.client.get_active_lifecycle('dor', pid, 'opened')
       false
     end
 
     # @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::WorkflowService.get_lifecycle('dor', pid, 'submitted') && !new_version_open? && Dor::WorkflowService.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
+      if Dor::Config.workflow.client.get_lifecycle('dor', pid, 'submitted') && !new_version_open? && Dor::Config.workflow.client.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
         false
       else
         true

data/lib/dor/models/workflow_object.rb

@@ -45,7 +45,7 @@ module Dor
 
     def to_solr(solr_doc = {}, *args)
       super solr_doc, *args
-      solr_doc["#{definition.name}_archived_isi"] = Dor::WorkflowService.count_archived_for_workflow(definition.name)
+      solr_doc["#{definition.name}_archived_isi"] = Dor::Config.workflow.client.count_archived_for_workflow(definition.name)
       solr_doc
     end
 

data/lib/dor/services/cleanup_reset_service.rb

@@ -18,7 +18,7 @@ module Dor
       last_version = druid_obj.current_version.to_i
 
       # if the current version is still open, avoid this versioned directory
-      if Dor::WorkflowService.get_lifecycle('dor', druid, 'accessioned').nil?
+      if Dor::Config.workflow.client.get_lifecycle('dor', druid, 'accessioned').nil?
         last_version -= 1
       end
       last_version

data/lib/dor/services/cleanup_service.rb

@@ -69,8 +69,8 @@ module Dor
 
     def self.remove_active_workflows(druid)
       %w(dor sdr).each do |repo|
-        dor_wfs = Dor::WorkflowService.get_workflows(druid, repo)
-        dor_wfs.each { |wf| Dor::WorkflowService.delete_workflow(repo, druid, wf) }
+        dor_wfs = Dor::Config.workflow.client.get_workflows(druid, repo)
+        dor_wfs.each { |wf| Dor::Config.workflow.client.delete_workflow(repo, druid, wf) }
       end
     end
 

data/lib/dor/services/merge_service.rb

@@ -68,7 +68,7 @@ module Dor
           unshelve
           unpublish
           Dor::CleanupService.cleanup_by_druid @current_secondary.pid
-          Dor::WorkflowService.archive_active_workflow 'dor', @current_secondary.pid
+          Dor::Config.workflow.client.archive_active_workflow 'dor', @current_secondary.pid
         rescue => e
           @logger.error "Unable to decomission #{@current_secondary.pid} with primary object #{@primary.pid}: #{e.inspect}"
           @logger.error e.backtrace.join("\n")

data/lib/dor/services/registration_service.rb

@@ -127,7 +127,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.initialize_workflow(workflow_id, !new_item.new_object?, workflow_priority)}
+        Array(params[:initiate_workflow]).each { |workflow_id| new_item.create_workflow(workflow_id, !new_item.new_object?, workflow_priority)}
 
         new_item.assert_content_model
 

data/lib/dor/services/sdr_ingest_service.rb

@@ -36,7 +36,7 @@ module Dor
       bagger.create_tagfiles
       verify_bag_structure(bag_dir)
       # Now bootstrap SDR workflow. but do not create the workflows datastream
-      dor_item.initialize_workflow('sdrIngestWF', false)
+      dor_item.create_workflow('sdrIngestWF', false)
     rescue Exception => e
       raise LyberCore::Exceptions::ItemError.new(druid, 'Export failure', e)
     end
@@ -44,12 +44,7 @@ module Dor
     # @param [String] druid The object identifier
     # @return [Moab::SignatureCatalog] the catalog of all files previously ingested
     def self.get_signature_catalog(druid)
-      sdr_client = Dor::Config.sdr.rest_client
-      url = "objects/#{druid}/manifest/signatureCatalog.xml"
-      response = sdr_client[url].get
-      Moab::SignatureCatalog.parse(response)
-    rescue RestClient::ResourceNotFound
-      Moab::SignatureCatalog.new(:digital_object_id => druid, :version_id => 0)
+      Sdr::Client.get_signature_catalog(druid)
     end
 
     # @param [Dor::Item] dor_item The representation of the digital object

data/lib/dor/services/technical_metadata_service.rb

@@ -48,8 +48,7 @@ module Dor
     # @param [Dor::Item] dor_item The DOR item being processed by the technical metadata robot
     # @return [FileGroupDifference] The differences between two versions of a group of files
     def self.get_content_group_diff(dor_item)
-      inventory_diff_xml = dor_item.get_content_diff('all')
-      inventory_diff = Moab::FileInventoryDifference.parse(inventory_diff_xml)
+      inventory_diff = dor_item.get_content_diff('all')
       inventory_diff.group_difference('content')
     end
 
@@ -77,11 +76,7 @@ module Dor
     # @return [String] The technicalMetadata datastream from the previous version of the digital object (fetched from SDR storage)
     #   The data is updated to the latest format.
     def self.get_sdr_technical_metadata(druid)
-      begin
-        sdr_techmd = get_sdr_metadata(druid, 'technicalMetadata')
-      rescue RestClient::ResourceNotFound
-        return nil
-      end
+      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
@@ -103,9 +98,7 @@ module Dor
     # @param [String] dsname The identifier of the metadata datastream
     # @return [String] The datastream contents from the previous version of the digital object (fetched from SDR storage)
     def self.get_sdr_metadata(druid, dsname)
-      sdr_client = Dor::Config.sdr.rest_client
-      url = "objects/#{druid}/metadata/#{dsname}.xml"
-      sdr_client[url].get
+      Sdr::Client.get_sdr_metadata(druid, dsname)
     end
 
     # @param [DruidTools::Druid] druid A wrapper class for the druid identifier.  Used to generate paths

data/lib/dor/utils/sdr_client.rb

@@ -1,12 +1,11 @@
+require 'moab'
 module Sdr
-  module Client
+  class Client
     class << self
-
       # @param [String] druid id of the object you want the version of
       # @return [Integer] the current version from SDR
       def current_version(druid)
-        sdr_client = Dor::Config.sdr.rest_client
-        xml = sdr_client["objects/#{druid}/current_version"].get
+        xml = client["objects/#{druid}/current_version"].get
 
         begin
           doc = Nokogiri::XML xml
@@ -17,6 +16,45 @@ module Sdr
         end
       end
 
+      # @param [String] dsname The identifier of the metadata datastream
+      # @return [String] The datastream contents from the previous version of the digital object (fetched from SDR storage)
+      def get_sdr_metadata(druid, dsname)
+        client["objects/#{druid}/metadata/#{dsname}.xml"].get
+      rescue RestClient::ResourceNotFound
+        return nil
+      end
+
+      # @param [String] druid The object identifier
+      # @return [Moab::SignatureCatalog] the catalog of all files previously ingested
+      def get_signature_catalog(druid)
+        response = client["objects/#{druid}/manifest/signatureCatalog.xml"].get
+        Moab::SignatureCatalog.parse(response)
+      rescue RestClient::ResourceNotFound
+        Moab::SignatureCatalog.new(:digital_object_id => druid, :version_id => 0)
+      end
+
+      def get_content_diff(druid, current_content, subset = :all, version = nil)
+        unless %w(all shelve preserve publish).include?(subset.to_s)
+          raise Dor::ParameterError, "Invalid subset value: #{subset}"
+        end
+
+        query_string = { :subset => subset.to_s }
+        query_string[:version] = version.to_s unless version.nil?
+        query_string = URI.encode_www_form(query_string)
+        sdr_query = "objects/#{druid}/cm-inv-diff?#{query_string}"
+        response = client[sdr_query].post(current_content, :content_type => 'application/xml')
+        Moab::FileInventoryDifference.parse(response)
+      end
+
+      def client
+        if Dor::Config.sdr.url
+          Dor::Config.sdr.rest_client
+        elsif Dor::Config.dor_services.url
+          Dor::Config.dor_services.rest_client['v1/sdr']
+        else
+          raise Dor::ParameterError, 'Missing Dor::Config.sdr and/or Dor::Config.dor_services configuration'
+        end
+      end
     end
   end
 end

data/lib/dor/version.rb

@@ -1,3 +1,3 @@
 module Dor
-  VERSION = '5.4.2'
+  VERSION = '5.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services
 version: !ruby/object:Gem::Version
-  version: 5.4.2
+  version: 5.5.0
 platform: ruby
 authors:
 - Michael Klein
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-25 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora