uc3-dmp-id 0.0.89 → 0.0.90

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 060e5579b7df045a30beb6431b0954b19e8542b42e1dacc933c9f0f025d521a8
-  data.tar.gz: b784e85e55401583d782363b0b9d99f23839db175aac2e4ccfa498b5c98481c7
+  metadata.gz: 13c2a01e8e979f1cc3a4e9fe003cb8429d742c0e5b9d217d78e2d93bd36c276c
+  data.tar.gz: 5541be19755ac0850166d14fd4e02408d02db1e35caf83cddab527729c061a54
 SHA512:
-  metadata.gz: 3bc49726eb20d814984f6bd3585510f7d45b5dd00479cc95933f6ade4e5ca2b77a191d18377b05af0d3303b3ba19f7cedb54a85abb11d77ea45a712305c0816b
-  data.tar.gz: 1c6048b78d7b9c38b16433e93b3bc64df70ccfcecda64e6cc4f223ce7253bde6868b9d53834c0d3e7e17fc46cac1569acaf76a1588bf3c5a38fb2e76154f6d72
+  metadata.gz: 0d9e65edacb5d45bef33510718f50023fb14abf271859ca07910bd2b60941ebb7219e662efcead0a818141e7e2349f5e57c81e705162685dbe7cd6d736c60238
+  data.tar.gz: f5e2103aa8360d25a73ec5af6415a3087c73afdfc63c03983cbdf798e107e1bb086f0effc7c00ca3ddd71e4859e48832e03d441a2d092ff11ab4c0f0db053fcc

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

@@ -11,7 +11,7 @@ module Uc3DmpId
     MSG_UNABLE_TO_MINT = 'Unable to mint a unique DMP ID.'
 
     class << self
-      def create(provenance:, json:, debug: false)
+      def create(provenance:, json:, logger: nil)
         raise CreatorError, MSG_NO_SHOULDER if ENV['DMP_ID_SHOULDER'].nil?
         raise CreatorError, MSG_NO_BASE_URL if ENV['DMP_ID_BASE_URL'].nil?
 
@@ -28,30 +28,29 @@ module Uc3DmpId
 
         # TODO: Swap this out with the Finder search once the Dynamo indexes are working
         # Try to find it first and Fail if found
-        result = Finder.by_json(json: json, debug: debug)
+        result = Finder.by_json(json: json, logger: logger)
         raise CreatorError, Uc3DmpId::MSG_DMP_EXISTS if result.is_a?(Hash)
         # raise CreatorError, Uc3DmpId::MSG_DMP_EXISTS unless json['PK'].nil?
 
-        client = Uc3DmpDynamo::Client.new(debug: debug)
-        p_key = _preregister_dmp_id(client: client, provenance: provenance, json: json, debug: debug)
+        client = Uc3DmpDynamo::Client.new
+        p_key = _preregister_dmp_id(client: client, provenance: provenance, json: json, logger: logger)
         raise CreatorError, MSG_UNABLE_TO_MINT if p_key.nil?
 
         # Add the DMPHub specific attributes and then save
         annotated = Helper.annotate_dmp_json(provenance: provenance, p_key: p_key, json: json['dmp'])
-        puts "CREATING DMP ID:" if debug
-        puts annotated if debug
+        logger.info(message: "Creating DMP ID: #{p_key}") if logger.respond_to?(:debug)
 
         # Create the item
-        resp = client.put_item(json: annotated, debug: debug)
+        resp = client.put_item(json: annotated, logger: logger)
         raise CreatorError, Uc3DmpId::MSG_DMP_NO_DMP_ID if resp.nil?
 
-        _post_process(json: annotated, debug: debug)
+        _post_process(json: annotated, logger: logger)
         Helper.cleanse_dmp_json(json: JSON.parse({ dmp: annotated }.to_json))
       end
 
       private
 
-      def _preregister_dmp_id(client:, provenance:, json:, debug: false)
+      def _preregister_dmp_id(client:, provenance:, json:, logger: nil)
         # Use the specified DMP ID if the provenance has permission
         existing = json.fetch('dmp', {}).fetch('dmp_id', {})
         seed_id = json.fetch('dmp', {})['dmproadmap_external_system_identifier']
@@ -72,7 +71,7 @@ module Uc3DmpId
         # Something went wrong and it was unable to identify a unique id
         raise CreatorError, MSG_UNABLE_TO_MINT if counter >= 10
 
-        puts "Uc3DmpId::Creator._pregister_dmp_id - registering DMP ID: #{dmp_id}" if debug
+        logger.debug(message: "Preregistration DMP ID: #{dmp_id}") if logger.respond_to?(:debug)
         url = ENV['DMP_ID_BASE_URL'].gsub(%r{https?://}, '')
         "#{Helper::PK_DMP_PREFIX}#{url.end_with?('/') ? url : "#{url}/"}#{dmp_id}"
       end
@@ -81,14 +80,14 @@ module Uc3DmpId
       # Once the DMP has been created, we need to register it's DMP ID and download any
       # PDF if applicable
       # -------------------------------------------------------------------------
-      def _post_process(json:, debug: false)
+      def _post_process(json:, logger: nil)
         return false unless json.is_a?(Hash)
 
         # We are creating, so this is always true
         json['dmphub_updater_is_provenance'] = true
         # Publish the change to the EventBridge
         publisher = Uc3DmpEventBridge::Publisher.new
-        publisher.publish(source: 'DmpCreator', dmp: json, debug: debug)
+        publisher.publish(source: 'DmpCreator', dmp: json, logger: logger)
         true
       end
     end

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

@@ -9,15 +9,15 @@ module Uc3DmpId
       # Delete/Tombstone a record in the table
       # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # -------------------------------------------------------------------------
-      def tombstone(provenance:, p_key:, debug: false)
+      def tombstone(provenance:, p_key:, logger: nil)
         raise DeleterError, MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
         # Fail if the provenance is not defined
         raise DeleterError, MSG_DMP_FORBIDDEN unless provenance.is_a?(Hash) && !provenance['PK'].nil?
 
         # Fetch the latest version of the DMP ID by it's PK
-        client = Uc3DmpDynamo::Client.new(debug: debug)
-        dmp = Finder.by_pk(p_key: p_key, client: client, debug: debug)
+        client = Uc3DmpDynamo::Client.new
+        dmp = Finder.by_pk(p_key: p_key, client: client, logger: logger)
         raise DeleterError, MSG_DMP_NOT_FOUND unless dmp.is_a?(Hash) && !dmp['dmp'].nil?
 
         # Only allow this if the provenance is the owner of the DMP!
@@ -29,25 +29,25 @@ module Uc3DmpId
         dmp['dmp']['SK'] = Helper::DMP_TOMBSTONE_VERSION
         dmp['dmp']['dmphub_tombstoned_at'] = Time.now.iso8601
         dmp['dmp']['title'] = "OBSOLETE: #{dmp['title']}"
-        puts "Tombstoning DMP #{p_key}" if debug
+        logger.info(message: "Tomstoning DMP ID: #{p_key}") if logger.respond_to?(:debug)
 
         # Create the Tombstone version
-        resp = client.put_item(json: dmp, debug: debug)
+        resp = client.put_item(json: dmp, logger: logger)
         raise DeleterError, MSG_DMP_NO_TOMBSTONE if resp.nil?
 
         # Delete the Latest version
-        resp = client.delete_item(p_key: p_key, s_key: Helper::SK_DMP_PREFIX, debug: debug)
+        resp = client.delete_item(p_key: p_key, s_key: Helper::SK_DMP_PREFIX, logger: logger)
 
 # TODO: We should do a check here to see if it was successful!
 puts resp.inspect
 
         # Notify EZID about the removal
-        _post_process(json: dmp, debug: debug)
+        _post_process(json: dmp, logger: logger)
         # Return the tombstoned record
         Helper.cleanse_dmp_json(json: JSON.parse({ dmp: dmp }.to_json))
       rescue Aws::Errors::ServiceError => e
-        Responder.log_error(source: source, message: e.message,
-                            details: ([@provenance] << e.backtrace).flatten)
+        puts "ERROR in Uc3DmpId::Deleter - #{e.message}"
+        puts e.backtrace
         { status: 500, error: Messages::MSG_SERVER_ERROR }
       end
       # rubocop:enable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -56,14 +56,14 @@ puts resp.inspect
 
       # Once the DMP has been tombstoned, we need to notify EZID
       # -------------------------------------------------------------------------
-      def _post_process(json:, debug: false)
+      def _post_process(json:, logger: nil)
         return false unless json.is_a?(Hash)
 
         # Indicate whether or not the updater is the provenance system
         json['dmphub_updater_is_provenance'] = true
         # Publish the change to the EventBridge
         publisher = Uc3DmpEventBridge::Publisher.new
-        publisher.publish(source: 'DmpDeleter', dmp: json, debug: debug)
+        publisher.publish(source: 'DmpDeleter', dmp: json, logger: logger)
         true
       end
     end

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

@@ -19,10 +19,10 @@ module Uc3DmpId
 
     class << self
       # TODO: Replace this with ElasticSearch
-      def search_dmps(args:, debug: false)
-        return _by_owner(owner_org: args['owner_orcid'], debug: debug) unless args['owner_orcid'].nil?
-        return _by_owner_org(owner_org: args['owner_org_ror'], debug: debug) unless args['owner_org_ror'].nil?
-        return _by_mod_day(day: args['modification_day'], debug: debug) unless args['modification_day'].nil?
+      def search_dmps(args:, logger: nil)
+        return _by_owner(owner_org: args['owner_orcid'], logger: logger) unless args['owner_orcid'].nil?
+        return _by_owner_org(owner_org: args['owner_org_ror'], logger: logger) unless args['owner_org_ror'].nil?
+        return _by_mod_day(day: args['modification_day'], logger: logger) unless args['modification_day'].nil?
 
         []
       end
@@ -30,63 +30,65 @@ module Uc3DmpId
 
       # Find a DMP based on the contents of the incoming JSON
       # -------------------------------------------------------------------------
-      def by_json(json:, debug: false)
+      def by_json(json:, logger: nil)
         json = Helper.parse_json(json: json)&.fetch('dmp', {})
         raise FinderError, MSG_INVALID_ARGS if json.nil? || (json['PK'].nil? && json['dmp_id'].nil?)
 
         p_key = json['PK']
         # Translate the incoming :dmp_id into a PK
         p_key = Helper.dmp_id_to_pk(json: json.fetch('dmp_id', {})) if p_key.nil?
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
 
         # TODO: Re-enable this once we figure out Dynamo indexes
         # find_by_dmphub_provenance_id -> if no PK and no dmp_id result
-        # return by_provenance_identifier(json: json, client: client, debug: debug) if p_key.nil?
+        # return by_provenance_identifier(json: json, client: client, logger: logger) if p_key.nil?
 
         # find_by_PK
-        p_key.nil? ? nil : by_pk(p_key: p_key, s_key: json['SK'], client: client, debug: debug)
+        p_key.nil? ? nil : by_pk(p_key: p_key, s_key: json['SK'], client: client, logger: logger)
       end
 
       # Find the DMP by its PK and SK
       # -------------------------------------------------------------------------
-      def by_pk(p_key:, s_key: Helper::DMP_LATEST_VERSION, client: nil, debug: false)
+      def by_pk(p_key:, s_key: Helper::DMP_LATEST_VERSION, client: nil, logger: nil)
         raise FinderError, MSG_MISSING_PK if p_key.nil?
 
         s_key = Helper::DMP_LATEST_VERSION if s_key.nil? || s_key.to_s.strip.empty?
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
         resp = client.get_item(
           key: {
             PK: Helper.append_pk_prefix(p_key: p_key),
             SK: s_key
-          }
+          },
+          logger: logger
         )
         return resp unless resp.is_a?(Hash)
 
         dmp = resp['dmp'].nil? ? JSON.parse({ dmp: resp }.to_json) : resp
         return nil if dmp['dmp']['PK'].nil?
 
-        dmp = Versioner.append_versions(p_key: dmp['dmp']['PK'], dmp: dmp, client: client, debug: debug)
+        dmp = Versioner.append_versions(p_key: dmp['dmp']['PK'], dmp: dmp, client: client, logger: logger)
         Helper.cleanse_dmp_json(json: dmp)
       end
 
       # Fetch just the PK to see if a record exists
       # -------------------------------------------------------------------------
-      def exists?(p_key:, s_key: Helper::DMP_LATEST_VERSION, client: nil)
+      def exists?(p_key:, s_key: Helper::DMP_LATEST_VERSION, client: nil, logger: nil)
         raise FinderError, MSG_MISSING_PK if p_key.nil?
 
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
         client.pk_exists?(
           key: {
             PK: Helper.append_pk_prefix(p_key: p_key),
             SK: s_key
-          }
+          },
+          logger: logger
         )
       end
 
       # Attempt to find the DMP item by the provenance system's identifier
       # -------------------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize
-      def by_provenance_identifier(json:, client: nil, debug: false)
+      def by_provenance_identifier(json:, client: nil, logger: nil)
         raise FinderError, MSG_MISSING_PROV_ID if json.nil? || json.fetch('dmp_id', {})['identifier'].nil?
 
         args = {
@@ -100,8 +102,8 @@ module Uc3DmpId
           filter_expression: 'SK = :version',
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
-        resp = client.query(args: args)
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
+        resp = client.query(args: args, logger: logger)
         return resp unless resp.is_a?(Hash)
 
         dmp = resp['dmp'].nil? ? JSON.parse({ dmp: resp }.to_json) : resp
@@ -115,7 +117,7 @@ module Uc3DmpId
       private
 
       # Fetch the DMP IDs for the specified owner's ORCID (the owner is the :dmphub_owner_id on the DMP ID record)
-      def _by_owner(owner_id:, debug: false)
+      def _by_owner(owner_id:, logger: nil)
         regex = %r{^([0-9A-Z]{4}-){3}[0-9A-Z]{4}$}
         raise FinderError, MSG_INVALID_OWNER_ID if owner_id.nil? || (owner_id.to_s.downcase =~  regex).nil?
 
@@ -134,12 +136,12 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         puts "Querying _by_owner with #{args}" if debug
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
-        _process_search_response(response: client.query(args: args))
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
+        _process_search_response(response: client.query(args: args, logger: logger))
       end
 
       # Fetch the DMP IDs for the specified organization/institution (the org is the :dmphub_owner_org on the DMP ID record)
-      def _by_owner_org(owner_org:, debug: false)
+      def _by_owner_org(owner_org:, logger: nil)
         regex = %r{^[a-zA-Z0-9]+$}
         raise FinderError, MSG_INVALID_OWNER_ID if owner_org.nil? ||(owner_org.to_s.downcase =~ regex).nil?
 
@@ -158,12 +160,12 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         puts "Querying _by_owner_org with #{args}" if debug
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
-        _process_search_response(response: client.query(args: args))
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
+        _process_search_response(response: client.query(args: args, logger: logger))
       end
 
       # Fetch the DMP IDs modified on the specified date (the date is the :dmphub_modification_day on the DMP ID record)
-      def _by_mod_day(day:, debug: false)
+      def _by_mod_day(day:, logger: nil)
         regex = %r{^[0-9]{4}(-[0-9]{2}){2}}
         raise FinderError, MSG_INVALID_OWNER_ID if day.nil? || (day.to_s =~ regex).nil?
 
@@ -179,8 +181,8 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         puts "Querying _by_mod_day with #{args}" if debug
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
-        _process_search_response(response: client.query(args: args))
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
+        _process_search_response(response: client.query(args: args, logger: logger))
       end
 
 

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

@@ -9,7 +9,7 @@ module Uc3DmpId
       # --------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      def splice_for_owner(owner:, updater:, base:, mods:, debug: false)
+      def splice_for_owner(owner:, updater:, base:, mods:, logger: nil)
         return base if owner.nil? || updater.nil? || mods.nil?
         return mods if base.nil?
 
@@ -39,9 +39,7 @@ module Uc3DmpId
         spliced['dmproadmap_related_identifiers'] = mod_relateds
         spliced['dmproadmap_related_identifiers'] << other_relateds if other_relateds.any?
 
-        puts 'JSON after splicing in changes from provenance' if debug
-        puts spliced if debug
-
+        logger.debug(message: "JSON after splicing in changes from provenance", details: spliced) if logger.respond_to?(:debug)
         spliced
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
@@ -50,7 +48,7 @@ module Uc3DmpId
       # Splice changes from the other system onto the system of provenance and other system's changes
       # --------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize
-      def splice_for_others(owner:, updater:, base:, mods:, debug: false)
+      def splice_for_others(owner:, updater:, base:, mods:, logger: nil)
         return base if owner.nil? || updater.nil? || base.nil? || mods.nil?
 
         spliced = Helper.deep_copy_dmp(obj: base)
@@ -71,9 +69,7 @@ module Uc3DmpId
           updater: updater, base: base_relateds, mods: mod_relateds
         )
 
-        puts 'JSON after splicing in changes from non-provenance' if debug
-        puts spliced if debug
-
+        logger.debug(message: "JSON after splicing in changes from non-provenance", details: spliced) if logger.respond_to?(:debug)
         spliced
       end
       # rubocop:enable Metrics/AbcSize

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

@@ -9,7 +9,7 @@ module Uc3DmpId
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # -------------------------------------------------------------------------
-      def update(provenance:, p_key:, json: {}, debug: false)
+      def update(provenance:, p_key:, json: {}, logger: nil)
         raise UpdaterError, MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
         dmp = Helper.parse_json(json: json)
@@ -17,45 +17,44 @@ module Uc3DmpId
 
         # Add the DMPHub specific attributes
         annotated = Helper.annotate_dmp_json(provenance: provenance, p_key: p_key, json: dmp['dmp'])
-
-puts 'Annotated:'
-puts annotated
+        logger.debug(message: "Incoming JSON after annotation", details: annotated) if logger.respond_to?(:debug)
 
         # fetch the existing latest version of the DMP ID
-        client = Uc3DmpDynamo::Client.new(debug: debug)
-        existing = Finder.by_pk(p_key: p_key, client: client, debug: debug)
+        client = Uc3DmpDynamo::Client.new(logger: logger)
+        existing = Finder.by_pk(p_key: p_key, client: client, logger: logger)
+        logger.debug(message: "Existing latest record", details: existing) if logger.respond_to?(:debug)
+
         errs = _updateable?(provenance: provenance, p_key: p_key, json: annotated)
         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: existing, dmp_b: dmp)
 
         # Generate a new version of the DMP. This involves versioning the current latest version
-        new_version = Versioner.new_version(provenance: provenance, p_key: p_key, client: client, debug: debug,
+        new_version = Versioner.new_version(provenance: provenance, p_key: p_key, client: client, logger: logger,
                                             dmp: dmp, latest_version: existing)
-
-puts 'New version:'
-puts new_version
-
+        logger.debug(message: "New version", details: new_version) if logger.respond_to?(:debug)
         raise UpdaterError, MSG_DMP_UNABLE_TO_VERSION if new_version.nil?
 
         # Save the changes as the new latest version
-        resp = client.put_item(json: new_version, debug: debug)
+        resp = client.put_item(json: new_version, logger: logger)
         raise UpdaterError, MSG_DMP_UNABLE_TO_VERSION if resp.nil?
 
         # Send the updates to EZID, notify the provenance and download the PDF if applicable
-        _post_process(json: dmp, debug: debug)
+        _post_process(json: dmp, 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: new_version }.to_json))
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
-      def attach_narrative(provenance:, p_key:, url:, debug: false)
+      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?
 
         # fetch the existing latest version of the DMP ID
-        client = Uc3DmpDynamo::Client.new(debug: debug)
-        dmp = Finder.by_pk(p_key: p_key, client: client, debug: debug)
+        client = Uc3DmpDynamo::Client.new(logger: logger)
+        dmp = Finder.by_pk(p_key: p_key, client: client, logger: logger)
+        logger.info(message: "Existing latest record", details: dmp) if logger.respond_to?(:debug)
 
         errs = _updateable?(provenance: provenance, p_key: p_key, json: dmp['dmp'])
         raise UpdaterError, errs if errs.is_a?(Array) && errs.any?
@@ -68,9 +67,10 @@ puts new_version
         }
 
         # Save the changes without creating a new version!
-        resp = client.put_item(json: annotated, debug: debug)
+        resp = client.put_item(json: annotated, logger: logger)
         raise UpdaterError, 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
 
@@ -90,14 +90,14 @@ puts new_version
 
       # Once the DMP has been updated, we need to register it's DMP ID and download any PDF if applicable
       # -------------------------------------------------------------------------
-      def _post_process(json:, debug: false)
+      def _post_process(json:, logger: nil)
         return false unless json.is_a?(Hash)
 
         # 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', dmp: json, debug: debug)
+        publisher.publish(source: 'DmpUpdater', dmp: json, logger: logger)
         true
       end
     end

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

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

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

@@ -6,11 +6,13 @@ module Uc3DmpId
   class VersionerError < StandardError; end
 
   class Versioner
+    SOURCE = 'Uc3DmpId::Versioner'
+
     class << self
 
       # Find the DMP ID's versions
       # -------------------------------------------------------------------------
-      def get_versions(p_key:, client: nil, debug: false)
+      def get_versions(p_key:, client: nil, logger: nil)
         return [] unless p_key.is_a?(String) && !p_key.strip.empty?
 
         args = {
@@ -20,8 +22,8 @@ module Uc3DmpId
           projection_expression: 'modified',
           scan_index_forward: false
         }
-        client = client.nil? ? Uc3DmpDynamo::Client.new(debug: debug) : client
-        client.query(args: args, debug: debug)
+        client = client.nil? ? Uc3DmpDynamo::Client.new : client
+        client.query(args: args, logger: logger)
       end
 
       # Create a new version of the DMP. This involves:
@@ -29,10 +31,10 @@ module Uc3DmpId
       #    - Saving the new `VERSION=yyyy-mm-ddThh:mm:ss+zz:zz` item
       #    - Splicing in the current changes onto the existing `VERSION#latest` item
       #    - Returning the spliced `VERSION#latest` back to this method
-      def new_version(provenance:, p_key:, client: nil, dmp:, latest_version: {}, debug: false)
+      def new_version(provenance:, p_key:, client: nil, dmp:, latest_version: {}, logger: nil)
         return nil unless p_key.is_a?(String) && !p_key.strip.empty? && _versionable?(dmp: dmp)
 
-        client = Uc3DmpDynamo::Client.new(debug: debug) if client.nil?
+        client = Uc3DmpDynamo::Client.new(logger: logger) if client.nil?
         latest_version = Finder.by_p_key(client: client, p_key: p_key) unless latest_version.is_a?(Hash) &&
                                                                               !latest_version['PK'].nil?
 
@@ -44,11 +46,9 @@ module Uc3DmpId
         prior = _generate_version(client: client, latest_version: latest, owner: owner, updater: updater)
         return nil if prior.nil?
 
-        args = { owner: owner, updater: updater, base: prior, mods: dmp, debug: debug }
-        puts 'DMP ID update prior to splicing changes' if debug
-        puts dmp if debug
+        args = { owner: owner, updater: updater, base: prior, mods: dmp, logger: logger }
+        logger.debug(message: "#{SOURCE} record prior to splicing", details: dmp) if logger.respond_to?(:debug)
 
-        args = { owner: owner, updater: updater, base: prior, mods: dmp, debug: debug }
         # If the system of provenance is making the change then just use the
         # new version as the base and then splice in any mods made by others
         # args = args.merge({ base: new_version, mods: original_version })
@@ -56,16 +56,18 @@ module Uc3DmpId
         # Otherwise use the original version as the base and then update the
         # metadata owned by the updater system
         new_version = Splicer.splice_for_others(args) if new_version.nil?
+
+        logger.debug(message: "#{SOURCE} record after splicing", details: new_version) if logger.respond_to?(:debug)
         new_version
       end
 
       # Build the :dmphub_versions array and attach it to the DMP JSON
       # rubocop:disable Metrics/AbcSize
-      def append_versions(p_key:, dmp:, client: nil, debug: false)
+      def append_versions(p_key:, dmp:, client: nil, logger: nil)
         json = Helper.parse_json(json: dmp)
         return json unless p_key.is_a?(String) && !p_key.strip.empty? && json.is_a?(Hash) && !json['dmp'].nil?
 
-        results = get_versions(p_key: p_key, client: client, debug: debug)
+        results = get_versions(p_key: p_key, client: client, logger: logger)
         return json unless results.length > 1
 
         versions = results.map do |ver|
@@ -92,28 +94,26 @@ module Uc3DmpId
 
       # Generate a version
       # rubocop:disable Metrics/AbcSize,  Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity
-      def _generate_version(client:, latest_version:, owner:, updater:, debug: false)
+      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('dmphub_updated_at', Time.now.iso8601))
         now = Time.now
-
-puts "_generate_version -- mod_time: #{mod_time} --> !(now - mod_time).is_a?(Float)"
-
+        logger.debug(message: "#{SOURCE} generating version - mod_time: #{mod_time}") if logger.respond_to?(:debug)
         return latest_version if mod_time.nil? || !(now - mod_time).is_a?(Float)
 
         same_hour = (now - mod_time).round <= 3600
-
-puts "_generate_version -- owner is updater? #{owner == updater}, same hour? #{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)
         return latest_version if owner != updater || (owner == updater && same_hour)
 
         latest_version['SK'] = "#{Helper::SK_DMP_PREFIX}#{latest_version['dmphub_updated_at'] || Time.now.iso8601}"
-
         # Create the prior version record
-        resp = client.put_item(json: latest_version, debug: debug)
+        resp = client.put_item(json: latest_version, logger: logger)
         return nil if resp.nil?
 
         puts "Created new version #{latest_version['PK']} - #{latest_version['SK']}" if debug
+        msg = "#{SOURCE} created version PK: #{latest_version['PK']} SK: #{latest_version['SK']}"
+        logger.info(message: msg, details: latest_version) if logger.respond_to?(:debug)
         latest_version
       end
       # rubocop:enable Metrics/AbcSize,  Metrics/CyclomaticComplexity,  Metrics/PerceivedComplexity

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-id
 version: !ruby/object:Gem::Version
-  version: 0.0.89
+  version: 0.0.90
 platform: ruby
 authors:
 - Brian Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json