uc3-dmp-id 0.0.140 → 0.1.0

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

@@ -6,6 +6,7 @@ require 'time'
 module Uc3DmpId
   class UpdaterError < StandardError; end
 
+  # Class that handles updating a DMP ID
   class Updater
     class << self
       # Update a DMP ID
@@ -13,7 +14,7 @@ module Uc3DmpId
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # -------------------------------------------------------------------------
       def update(provenance:, p_key:, json: {}, note: nil, logger: nil)
-        raise UpdaterError, MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
+        raise UpdaterError, Helper::MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
         mods = Helper.parse_json(json: json).fetch('dmp', {})
         p_key = Helper.append_pk_prefix(p_key: p_key)
@@ -26,18 +27,19 @@ module Uc3DmpId
         logger.debug(message: "Latest version for PK #{p_key}", details: latest_version) if logger.respond_to?(:debug)
 
         # Verify that the DMP ID is updateable with the info passed in
-        errs = _updateable?(provenance: provenance, p_key: p_key, latest_version: latest_version['dmp'], mods: mods['dmp'])
-        logger.error(message: errs.join(', ')) if errs.is_a?(Array) && errs.any?
+        errs = _updateable?(provenance: provenance, p_key: p_key, latest_version: latest_version['dmp'],
+                            mods: mods['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, 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: mods)
 
         # Version the DMP ID record (if applicable).
         owner = latest_version['dmphub_provenance_id']
         updater = provenance['PK']
-        version = Versioner.generate_version(client: client, latest_version: latest_version, owner: owner, updater: updater,
-                                             logger: logger)
-        raise UpdaterError, MSG_DMP_UNABLE_TO_VERSION if version.nil?
+        version = Versioner.generate_version(client: client, latest_version: latest_version, owner: owner,
+                                             updater: updater, logger: logger)
+        raise UpdaterError, Helper::MSG_DMP_UNABLE_TO_VERSION if version.nil?
 
         # Remove the version info because we don't want to save it on the record
         version.delete('dmphub_versions')
@@ -45,105 +47,132 @@ module Uc3DmpId
         # Splice the assertions
         version = _process_modifications(owner: owner, updater: updater, version: version, mods: mods, note: note,
                                          logger: logger)
-
         # Set the :modified timestamps
-        now = Time.now.utc.iso8601
-        version['modified'] = now
+        now = Time.now.utc
+        version['modified'] = now.iso8601
+        version['dmphub_modification_day'] = now.strftime('%Y-%m-%d')
 
         # Save the changes
         resp = client.put_item(json: version, logger: logger)
-        raise UpdaterError, MSG_DMP_UNABLE_TO_VERSION if resp.nil?
+        raise UpdaterError, Helper::MSG_DMP_UNABLE_TO_VERSION if resp.nil?
 
         # Send the updates to EZID
         _post_process(provenance: provenance, json: version, logger: logger)
 
         # Return the new version record
         logger.info(message: "Updated DMP ID: #{p_key}") if logger.respond_to?(:debug)
-        Helper.cleanse_dmp_json(json: JSON.parse({ dmp: version }.to_json))
+
+        # Append the :dmphub_versions Array
+        json = JSON.parse({ dmp: version }.to_json)
+        json = Versioner.append_versions(p_key: p_key, dmp: json, client: client, logger: logger)
+        Helper.cleanse_dmp_json(json: json)
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
       # Save a DMP ID's corresponding narrative PDF document to S3 and add the download URL for that
       # document to the DMP ID's :dmpraodmap_related_identifiers array as an `is_metadata_for` relation
+      # rubocop:disable Metrics/AbcSize
       def attach_narrative(provenance:, p_key:, url:, logger: nil)
-        raise UpdaterError, MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
+        raise UpdaterError, Helper::MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
         # fetch the existing latest version of the DMP ID
         client = Uc3DmpDynamo::Client.new(logger: logger)
         dmp = Finder.by_pk(p_key: p_key, client: client, logger: logger, cleanse: false)
-        logger.info(message: "Existing latest record", details: dmp) if logger.respond_to?(:debug)
-        raise UpdaterError, MSG_DMP_FORBIDDEN unless provenance.is_a?(Hash) && !provenance['PK'].nil? &&
-                                                     provenance['Pk'] == dmp['dmphub_provenance_id']
+        logger.info(message: 'Existing latest record', details: dmp) if logger.respond_to?(:debug)
+        raise UpdaterError, Helper::MSG_DMP_FORBIDDEN unless provenance.is_a?(Hash) && !provenance['PK'].nil? &&
+                                                             provenance['PK'] == dmp['dmp']['dmphub_provenance_id']
 
         # Add the download URl for the PDF as a related identifier on the DMP ID record
         annotated = Helper.annotate_dmp_json(provenance: provenance, p_key: p_key, json: dmp['dmp'])
         annotated['dmproadmap_related_identifiers'] = [] if annotated['dmproadmap_related_identifiers'].nil?
-        annotated['dmproadmap_related_identifiers'] << {
+        annotated['dmproadmap_related_identifiers'] << JSON.parse({
           descriptor: 'is_metadata_for', work_type: 'output_management_plan', type: 'url', identifier: url
-        }
+        }.to_json)
 
         # Save the changes without creating a new version!
         resp = client.put_item(json: annotated, logger: logger)
-        raise UpdaterError, MSG_DMP_UNABLE_TO_VERSION if resp.nil?
+        raise UpdaterError, Helper::MSG_DMP_UNABLE_TO_VERSION if resp.nil?
 
         logger.info(message: "Added DMP ID narrative for PK: #{p_key}, Narrative: #{url}") if logger.respond_to?(:debug)
         true
       end
+      # rubocop:enable Metrics/AbcSize
 
       private
 
       # Check to make sure the incoming JSON is valid, the DMP ID requested matches the DMP ID in the JSON
+      # rubocop:disable Metrics/AbcSize
       def _updateable?(provenance:, p_key:, latest_version: {}, mods: {})
         # Validate the incoming JSON first
         errs = Validator.validate(mode: 'author', json: JSON.parse({ dmp: mods }.to_json))
         return errs.join(', ') if errs.is_a?(Array) && errs.any? && errs.first != Validator::MSG_VALID_JSON
         # Fail if the provenance is not defined
-        return [MSG_DMP_FORBIDDEN] unless provenance.is_a?(Hash) && !provenance['PK'].nil?
+        return [Helper::MSG_DMP_FORBIDDEN] unless provenance.is_a?(Hash) && !provenance['PK'].nil?
         # Verify that the JSON is for the same DMP in the PK
-        return [MSG_DMP_FORBIDDEN] unless Helper.dmp_id_to_pk(json: mods.fetch('dmp_id', {})) == p_key
+        return [Helper::MSG_DMP_FORBIDDEN] unless Helper.dmp_id_to_pk(json: mods.fetch('dmp_id', {})) == p_key
         # Bail out if the DMP ID could not be found or the PKs do not match for some reason
-        return [MSG_DMP_UNKNOWN] if latest_version.nil? || latest_version.fetch['PK'] != p_key
+        return [Helper::MSG_DMP_UNKNOWN] unless latest_version.is_a?(Hash) && latest_version['PK'] == p_key
       end
+      # rubocop:enable Metrics/AbcSize
 
+      # rubocop:disable Metrics/ParameterLists
       def _process_modifications(owner:, updater:, version:, mods:, note: nil, logger: nil)
         return version unless mods.is_a?(Hash) && !updater.nil?
         return mods unless version.is_a?(Hash) && !owner.nil?
 
-        # Splice together any assertions that may have been made while the user was editing the DMP ID
-        updated = Asserter.splice(latest_version: version, modified_version: mods, logger: logger) if owner == updater
+        updated = if owner == updater
+                    # Splice together any assertions that may have been made while the user was editing the DMP ID
+                    Asserter.splice(latest_version: version, modified_version: mods, logger: logger)
+                  else
+                    # Attach the incoming changes as an assertion to the DMP ID since the updater is NOT the owner
+                    Asserter.add(updater: updater, latest_version: version, modified_version: mods, note: note,
+                                 logger: logger)
+                  end
 
-        # Attach the incoming changes as an assertion to the DMP ID since the updater is NOT the owner
-        updated = Asserter.add(updater: updater, dmp: version, mods: mods, note: note, logger: logger) if owner != updater
-
-        merge_versions(latest_version: version, mods: updated, logger: logger)
+        _merge_versions(latest_version: version, mods: updated, logger: logger)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # We are replacing the latest version with the modifcations but want to retain the PK, SK and any dmphub_ prefixed
       # entries in the metadata so that we do not lose creation timestamps, provenance ids, etc.
-      def merge_versions(latest_version:, mods:, logger: nil)
-        logger.debug(message: 'Modifications before merge.', details: mods)
+      # rubocop:disable Metrics/AbcSize
+      def _merge_versions(latest_version:, mods:, logger: nil)
+        return mods unless latest_version.is_a?(Hash)
+
+        logger.debug(message: 'Modifications before merge.', details: mods) if logger.respond_to?(:debug)
         keys_to_retain = latest_version.keys.select do |key|
-          (key.start_with?('dmphub_') && !%w[dmphub_assertions].include?(key)) ||
+          (key.start_with?('dmphub_') && !%w[dmphub_modifications dmphub_versions].include?(key)) ||
             key.start_with?('PK') || key.start_with?('SK')
         end
         keys_to_retain.each do |key|
           mods[key] = latest_version[key]
         end
-        logger.debug(message: 'Modifications after merge.', details: mods)
+        logger.debug(message: 'Modifications after merge.', details: mods) if logger.respond_to?(:debug)
         mods
       end
+      # rubocop:enable Metrics/AbcSize
 
       # Once the DMP has been updated, we need to update it's DOI metadata
       # -------------------------------------------------------------------------
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def _post_process(provenance:, json:, logger: nil)
-        return false unless json.is_a?(Hash)
+        return false unless json.is_a?(Hash) && provenance.is_a?(Hash) && !provenance['PK'].nil? &&
+                            !json['dmphub_provenance_id'].nil?
+
+        publishable = provenance['PK'] == json['dmphub_provenance_id']
+        return true unless publishable
+
+        # TODO: we will want to send and related_identifiers in :dmphub_modifications as well!!!
 
-        # Indicate whether or not the updater is the provenance system
-        json['dmphub_updater_is_provenance'] = provenance['PK'] == json['dmphub_provenance_id']
-        # Publish the change to the EventBridge
         publisher = Uc3DmpEventBridge::Publisher.new
-        publisher.publish(source: 'DmpUpdater', event_type: 'EZID update', dmp: json, logger: logger)
+        # Publish the change to the EventBridge if the updater is the owner of the DMP ID
+        if publishable && logger.respond_to?(:debug)
+          logger.debug(message: 'Sending event for EZID publication',
+                       details: json)
+        end
+        publisher.publish(source: 'DmpUpdater', event_type: 'EZID update', dmp: json, logger: logger) if publishable
 
         # Determine if there are any related identifiers that we should try to fetch a citation for
         citable_identifiers = Helper.citable_related_identifiers(dmp: json)
@@ -155,10 +184,16 @@ module Uc3DmpId
           SK: json['SK'],
           dmproadmap_related_identifiers: citable_identifiers
         }
-        logger.debug(message: "Fetching citations", details: citable_identifiers)
-        publisher.publish(source: 'DmpUpdater', dmp: json, event_type: 'Citation Fetch', detail: citer_detail, logger: logger)
+        if logger.respond_to?(:debug)
+          logger.debug(message: 'Sending event to fetch citations',
+                       details: citable_identifiers)
+        end
+        publisher.publish(source: 'DmpUpdater', dmp: json, event_type: 'Citation Fetch', detail: citer_detail,
+                          logger: logger)
         true
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+      # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     end
   end
 end

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

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require 'json-schema'
+
 module Uc3DmpId
   class Uc3DmpIdValidatorError < StandardError; end
 
+  # Method that compares incoming JSON against our JSON Schema and provides detailed errors
   class Validator
     # Valid Validation modes are:
     #   - :author --> system of provenance is attempting to create or update
@@ -18,8 +21,7 @@ module Uc3DmpId
 
     class << self
       # Validate the specified DMP's :json against the schema for the specified :mode
-      #
-      # ------------------------------------------------------------------------------------
+      # rubocop:disable Metrics/AbcSize
       def validate(mode:, json:)
         json = Helper.parse_json(json: json)
         return [MSG_EMPTY_JSON] if json.nil? || !VALIDATION_MODES.include?(mode)
@@ -36,6 +38,7 @@ module Uc3DmpId
       rescue JSON::Schema::ValidationError => e
         ["#{MSG_INVALID_JSON} - #{e.message}"]
       end
+      # rubocop:enable Metrics/AbcSize
 
       # ------------------------------------------------------------------------------------
       # METHODS BELOW ARE ONLY MEANT TO BE INVOKED FROM WITHIN THIS MODULE
@@ -45,10 +48,13 @@ module Uc3DmpId
       # ------------------------------------------------------------------------------------
       def _load_schema(mode:)
         # Instatiate the matching schema
-        schema = "Uc3DmpId::Schemas::#{mode.to_s.downcase.capitalize}".split('::').inject(Object) { |o,c| o.const_get c }
+        schema = "Uc3DmpId::Schemas::#{mode.to_s.downcase.capitalize}".split('::').inject(Object) do |o, c|
+          o.const_get c
+        end
         schema.respond_to?(:load) ? schema.load : nil
+      rescue NameError
+        nil
       end
-
     end
   end
 end

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

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

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

@@ -6,11 +6,11 @@ require 'time'
 module Uc3DmpId
   class VersionerError < StandardError; end
 
+  # Logic to handle the versioning of DMP IDs and to retrieve the versions for a PK
   class Versioner
     SOURCE = 'Uc3DmpId::Versioner'
 
     class << self
-
       # Find the DMP ID's versions
       # -------------------------------------------------------------------------
       def get_versions(p_key:, client: nil, logger: nil)
@@ -29,11 +29,12 @@ module Uc3DmpId
 
       # Generate a snapshot of the current latest version of the DMP ID using the existing :modified as
       # the new SK.
-      # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength,
+      # rubocop:disable Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
       def generate_version(client:, latest_version:, owner:, updater:, logger: nil)
         # Only create a version if the Updater is not the Owner OR the changes have happened on a different day
         mod_time = Time.parse(latest_version.fetch('modified', Time.now.utc.iso8601))
-        now = Time.now
+        now = Time.now.utc
         if mod_time.nil? || !(now - mod_time).is_a?(Float)
           logger.error(message: "#{SOURCE} unable to determine mod time: #{mod_time}") if logger.respond_to?(:debug)
           return latest_version
@@ -42,9 +43,11 @@ module Uc3DmpId
         # Only allow a new version if the owner and updater are the same and it has been at least one hour since
         # the last version was created
         same_hour = (now - mod_time).round <= 3600
-        if owner != updater || (owner == updater && same_hour)
+        if owner == updater && same_hour
           logger.debug(message: "#{SOURCE} same owner and updater? #{owner == updater}") if logger.respond_to?(:debug)
-          logger.debug(message: "#{SOURCE} already updated within the past hour? #{same_hour}") if logger.respond_to?(:debug)
+          if logger.respond_to?(:debug)
+            logger.debug(message: "#{SOURCE} already updated within the past hour? #{same_hour}")
+          end
           return latest_version
         end
 
@@ -52,6 +55,7 @@ module Uc3DmpId
         # We essentially make a snapshot of the record before making changes
         prior = Helper.deep_copy_dmp(obj: latest_version)
         prior['SK'] = "#{Helper::SK_DMP_PREFIX}#{latest_version['modified'] || Time.now.utc.iso8601}"
+
         # Create the prior version record ()
         client = client.nil? ? Uc3DmpDynamo::Client.new : client
         resp = client.put_item(json: prior, logger: logger)
@@ -61,7 +65,8 @@ module Uc3DmpId
         logger.info(message: msg, details: prior) if logger.respond_to?(:debug)
         latest_version
       end
-      # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength,
+      # rubocop:enable Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
 
       # Build the :dmphub_versions array and attach it to the DMP JSON
       # rubocop:disable Metrics/AbcSize
@@ -72,11 +77,15 @@ module Uc3DmpId
         results = get_versions(p_key: p_key, client: client, logger: logger)
         return json unless results.length > 1
 
+        # TODO: we may want to include milliseconds in the future if we get increased volume so that
+        #       we don't end up with duplicate URLs if versions are made within the same second
         versions = results.map do |ver|
           next if ver['modified'].nil?
+
+          base_url = "#{Helper.landing_page_url}#{Helper.remove_pk_prefix(p_key: p_key)}"
           {
             timestamp: ver['modified'],
-            url: "#{Helper.landing_page_url}#{Helper.remove_pk_prefix(p_key: p_key)}?version=#{ver['modified']}"
+            url: dmp['dmp']['modified'] == ver['modified'] ? base_url : "#{base_url}?version=#{ver['modified']}"
           }
         end
         json['dmp']['dmphub_versions'] = JSON.parse(versions.to_json)

data/lib/uc3-dmp-id.rb

@@ -18,17 +18,7 @@ require 'uc3-dmp-id/versioner'
 require 'uc3-dmp-id/schemas/amend'
 require 'uc3-dmp-id/schemas/author'
 
+# Support for working with DMP IDs
 module Uc3DmpId
-  MSG_DMP_EXISTS = 'DMP already exists. Try :update instead.'
-  MSG_DMP_FORBIDDEN = 'You do not have permission.'
-  MSG_DMP_INVALID_DMP_ID = 'Invalid DMP ID format.'
-  MSG_DMP_NO_DMP_ID = 'A DMP ID could not be registered at this time.'
-  MSG_DMP_NO_HISTORICALS = 'You cannot modify a historical version of the DMP.'
-  MSG_NO_OWNER_ORG = 'Could not determine ownership of the DMP ID.'
-  MSG_DMP_NO_TOMBSTONE = 'Unable to tombstone the DMP ID at this time.'
-  MSG_DMP_NO_UPDATE = 'Unable to update the DMP ID at this time.'
-  MSG_DMP_NOT_FOUND = 'DMP does not exist.'
-  MSG_DMP_UNABLE_TO_VERSION = 'Unable to version this DMP.'
-  MSG_DMP_UNKNOWN = 'DMP does not exist. Try :create instead.'
 end
 # rubocop:enable Naming/FileName

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-id
 version: !ruby/object:Gem::Version
-  version: 0.0.140
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,62 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 11.1.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 11.1.3
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 3.9.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.50.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.50.2
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.20.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.20.0
 description: Helpers for working with JSON that represents a DMP ID
 email:
 - brian.riley@ucop.edu