uc3-dmp-id 0.1.79 → 0.1.80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d05302ee8b8190c77e7efc0ad602ad0de2a74739b1653672d707b1fda95eec16
-  data.tar.gz: 3cca6911d51d58ff974308f8647bab075fb9bf717092bce45f3cbe2a151c7712
+  metadata.gz: 9e69e96c9dc20009c9a8ae00a332cff2348e529ffbfce306418a781977bf13b0
+  data.tar.gz: c3d4e37d7fefef7d98aa6606e5063a6539270c31d7916af1f964b99065b80724
 SHA512:
-  metadata.gz: e19a514c8233bdf9abc32c375b636611181738f6f64818431d0b3e26b1fd40c3817b5dcf1cfc8e1a270e3c521ad67636dd50baaec7638af9a162ebb864b26975
-  data.tar.gz: 3b09fdc606348c0c3dddcc7536563920c2971d475981c1b11a89a7147157db712d416d52eafec3689ec0e004be3d845acdf83cbb2113b2df08aca58936421915
+  metadata.gz: 92b6adb8619e99a00dcd61876c429d55757a6bb79841ffb5ddffbf04c0cc2fe10003464a8a3274b0886c639c2f527e241ca3b714c1b9e31c16d2fc125938d559
+  data.tar.gz: 6f6519e59f7c708be73fe721a7b68013e17dd523ebd42e33d5b6aedc7755a5364d3dafbf4df4534a10d3d34c320aa79b17e122e15eea0c3a8477032b3c454e89

data/lib/uc3-dmp-id/finder.rb

@@ -172,6 +172,7 @@ module Uc3DmpId
       def _by_org(org:, client: nil, logger: nil)
         regex = /^[a-zA-Z0-9]+$/
         id = "#{ROR_DOMAIN}#{org.strip}" unless (org.to_s =~ regex).nil?
+        return [] if id.nil?
 
         resp = client.get_item(key: { PK: 'AFFILIATION_INDEX', SK: id }, logger:)
         return [] unless resp.is_a?(Hash)
@@ -184,7 +185,8 @@ module Uc3DmpId
       def _by_funder(funder:, client: nil, logger: nil)
         regex = /^[a-zA-Z0-9]+$/
         id = "#{ROR_DOMAIN}/#{funder.strip}" unless (funder.to_s =~ regex).nil?
-        id = "#{DOI_DOMAIN}#{org.strip}" if id.nil? && !(org.to_s =~ Helper::DOI_REGEX).nil?
+        id = "#{DOI_DOMAIN}#{funder.strip}" if id.nil? && !(funder.to_s =~ Helper::DOI_REGEX).nil?
+        return [] if id.nil?
 
         resp = client.get_item(key: { PK: 'FUNDER_INDEX', SK: id }, logger:)
         return [] unless resp.is_a?(Hash)

data/lib/uc3-dmp-id/updater.rb

@@ -16,9 +16,9 @@ module Uc3DmpId
       def update(provenance:, p_key:, json: {}, logger: nil)
         raise UpdaterError, Helper::MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
-        mods = Helper.parse_json(json:).fetch('dmp', {})
+        payload = Helper.parse_json(json:).fetch('dmp', {})
         p_key = Helper.append_pk_prefix(p_key:)
-        logger.debug(message: "Incoming modifications for PK #{p_key}", details: mods) if logger.respond_to?(:debug)
+        logger.debug(message: "Incoming modifications for PK #{p_key}", details: payload) if logger.respond_to?(:debug)
 
         # Fetch the latest version of the DMP ID
         client = Uc3DmpDynamo::Client.new
@@ -28,29 +28,31 @@ module Uc3DmpId
 
         # Verify that the DMP ID is updateable with the info passed in
         errs = _updateable?(provenance:, p_key:, latest_version: latest_version['dmp'],
-                            mods: mods['dmp'])
+                            mods: payload['dmp'])
         logger.error(message: errs.join(', ')) if logger.respond_to?(:error) && errs.is_a?(Array) && errs.any?
         raise UpdaterError, errs if errs.is_a?(Array) && errs.any?
         # Don't continue if nothing has changed!
-        raise UpdaterError, Helper::MSG_NO_CHANGE if Helper.eql?(dmp_a: latest_version, dmp_b: mods)
+        raise UpdaterError, Helper::MSG_NO_CHANGE if Helper.eql?(dmp_a: latest_version, dmp_b: payload)
 
         # Version the DMP ID record (if applicable).
         owner = latest_version['dmphub_provenance_id']
         updater = provenance['PK']
         version = Versioner.generate_version(client:, latest_version:, owner:,
                                              updater:, logger:)
+        logger&.debug(message: 'New Version', details: version)
         raise UpdaterError, Helper::MSG_DMP_UNABLE_TO_VERSION if version.nil?
         # Bail if the system trying to make the update is not the creator of the DMP ID
         raise UpdaterError, Helper::MSG_DMP_FORBIDDEN if owner != updater
 
         # Handle any changes to the dmphub_modifications section
-        version = _process_harvester_mods(client:, p_key:, json: version, logger:)
+        version = _process_harvester_mods(client:, p_key:, json: payload, version:, logger:)
+        logger&.debug(message: 'Version after process_harvester_mods', details: version)
+        raise UpdaterError, Helper::MSG_SERVER_ERROR if version.nil?
 
-        # Remove the version info because we don't want to save it on the record
+        # Remove the version info any any lingering modification blocks
         version.delete('dmphub_versions')
+        version.delete('dmphub_modifications')
 
-        # Splice the assertions
-        version = _process_modifications(owner:, updater:, version:, mods:, logger:)
         # Set the :modified timestamps
         now = Time.now.utc
         version['modified'] = now.iso8601
@@ -67,9 +69,9 @@ module Uc3DmpId
         logger.info(message: "Updated DMP ID: #{p_key}") if logger.respond_to?(:debug)
 
         # Append the :dmphub_versions Array
-        json = JSON.parse({ dmp: version }.to_json)
-        json = Versioner.append_versions(p_key:, dmp: json, client:, logger:)
-        Helper.cleanse_dmp_json(json:)
+        out = JSON.parse({ dmp: version }.to_json)
+        out = Versioner.append_versions(p_key:, dmp: out, client:, logger:)
+        Helper.cleanse_dmp_json(json: out)
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -130,24 +132,6 @@ module Uc3DmpId
       end
       # rubocop:enable Metrics/AbcSize
 
-      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def _process_modifications(owner:, updater:, version:, mods:, logger: nil)
-        return version unless mods.is_a?(Hash) && !updater.nil?
-        return mods unless version.is_a?(Hash) && !owner.nil?
-
-        logger.debug(message: 'Modifications before merge.', details: mods) if logger.respond_to?(:debug)
-        keys_to_retain = version.keys.select do |key|
-          (key.start_with?('dmphub_') && !%w[dmphub_modifications dmphub_versions].include?(key)) ||
-            key.start_with?('PK') || key.start_with?('SK') || key.start_with?('dmproadmap_related_identifiers')
-        end
-        keys_to_retain.each do |key|
-          mods[key] = version[key]
-        end
-        logger.debug(message: 'Modifications after merge.', details: mods) if logger.respond_to?(:debug)
-        mods
-      end
-      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-
       # Once the DMP has been updated, we need to update it's DOI metadata
       # -------------------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
@@ -191,32 +175,65 @@ module Uc3DmpId
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       # Fetch any Harvester modifications to the JSON
-      def _process_harvester_mods(client:, p_key:, json:, logger: nil)
-        return json if json.fetch('dmphub_modifications', []).empty?
+      def _process_harvester_mods(client:, p_key:, json:, version:, logger: nil)
+        logger&.debug(message: 'Incoming modifications', details: json)
+        return version if json.fetch('dmphub_modifications', []).empty?
 
         # Fetch the `"SK": "HARVESTER_MODS"` record
         client = Uc3DmpDynamo::Client.new if client.nil?
         resp = client.get_item(
           key: { PK: Helper.append_pk_prefix(p_key:), SK: Helper::SK_HARVESTER_MODS }, logger:
         )
-        return json unless resp.is_a?(Hash) && resp['related_works'].is_a?(Hash)
+        return version unless resp.is_a?(Hash) && resp['related_works'].is_a?(Hash)
 
+        logger&.debug(message: 'Original HARVESTER_MODS record', details: resp)
         # The `dmphub_modifications` array will ONLY ever have things the harvester mods know about
         # so just find them and update the status accordingly
-        mods = resp.dup
+        original = resp.dup
+        json['dmproadmap_related_identifiers'] = [] if json['dmproadmap_related_identifiers'].nil?
+
         json['dmphub_modifications'].each do |entry|
-          next if entry.fetch('dmproadmap_related_identifiers', []).empty?
+          next if entry.is_a?(Hash) && entry.fetch('dmproadmap_related_identifiers', []).empty?
 
           entry['dmproadmap_related_identifiers'].each do |related|
-            next if mods['related_works'][related.identifier].nil?
-
-            mods['related_works'][related.identifier]['status'] = related['status']
+            # Detrmine if the HARVESTER_MODS record even knows about the mod
+            related_id = related.respond_to?(:identifier) ? related.identifier : related['identifier']
+            related_domain = related.respond_to?(:domain) ? related.domain : related['domain']
+            key = "#{related_domain.end_with?('/') ? related_domain : "#{related_domain}/"}#{related_id}"
+            key_found = original['related_works'].has_key?(key)
+            logger&.debug(message: "No matching HARVEST_MOD found for #{key}") unless key_found
+            next unless key_found
+
+            # Update the status in the HARVESTER_MODS record
+            logger&.debug(message: "Updating status for #{key} from #{original['related_works'][key]['status']} to #{related['status']}")
+            original['related_works'][key]['status'] = related['status']
+
+            existing = version['dmproadmap_related_identifiers'].select do |ri|
+              ri['identifier'] == key
+            end
+
+            # Add it if it was approved and doesn't exist in dmproadmap_related_identifiers
+            if related['status'] == 'approved' && existing.empty?
+              version['dmproadmap_related_identifiers'] << JSON.parse({
+                identifier: key,
+                work_type: related['work_type'],
+                type: related['type'],
+                descriptor: related['descriptor'],
+                citation: related['citation']
+              }.to_json)
+            elsif related['status'] == 'rejected' && existing.any?
+              # otherwise remove it
+              version['dmproadmap_related_identifiers'] = version['dmproadmap_related_identifiers'].reject { |ri| ri == existing.first }
+            end
           end
         end
 
-        client.put_item(json: mods, logger:)
-        json.delete('dmphub_modifications')
-        json
+        logger&.debug(message: 'Updating HARVESTER_MODS with:', details: original)
+        resp = client.put_item(json: original, logger:)
+        logger&.error(message: 'Unable to update HARVESTER_MODS', details: original) if resp.nil?
+
+        logger&.debug(message: 'Returning updated VERSION:', details: version)
+        version
       end
     end
   end

data/lib/uc3-dmp-id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uc3DmpId
-  VERSION = '0.1.79'
+  VERSION = '0.1.80'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-id
 version: !ruby/object:Gem::Version
-  version: 0.1.79
+  version: 0.1.80
 platform: ruby
 authors:
 - Brian Riley