uc3-dmp-id 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bdcb2754d5168bdeedf8583b91054cf62fc019d4479686da168d4ca70d83729
-  data.tar.gz: b2af99461aa7614212aae435db0db174eeb50125006d0dacc87698ecaf41b7b8
+  metadata.gz: 2d78c65551789e0b3e96488bb2c3689999a301c76a8434f945f7b855dd62d57d
+  data.tar.gz: 73fe134b92ebe24bf9595610f3ef9e7f8dc744a3494152d9e7a6e7e73675b075
 SHA512:
-  metadata.gz: 43cdce10f8bccc41fc979c67a4758fd5726206c9066acefcbc8abe65b9d36f79fc69eedb461a9ce584cf61f85ddd0dca13617d99a39e9c831eb56ea725a00eb0
-  data.tar.gz: 393d0e083ca8cfbf2039ba11861576a2eff489d48d8c541279ae30a3f9e7215d39175c49d1203456f56bb00a6a7e3da6c0211d4c3fc7e4f64f32f88e3d96accf
+  metadata.gz: 9fb32754f0e36c6292860e35327a9af48b566bae061eb0d08a8e4f94b9976144acae3b948837f7b1835e918d20d06971085091db81d5483ba494c51fd5279d68
+  data.tar.gz: 889bd0b3cbe91b95a534930b267625b38fe988381cf7b76e6fd73e53d4d73796b5abe3af8bd81ae322b1c7f1e17c9b9f3ea0f59ba00f3b9deeaecb3a15a131ed

data/README.md

@@ -1,3 +1,12 @@
 # Uc3DmpId
 
 Helper methods for working with DMP ID JSON records
+
+After you have made changes, be sure to increment the version number in `lib/uc3-dmp-id/version.rb`.
+
+To build and push this gem to RubyGems:
+- Make sure you are logged into RubyGems in your terminal window (see their docs)
+- Run `gem build uc3-dmp-id.gemspec` to build the gem
+- Run `gem push uc3-dmp-id-[version].gem` to publish to RubyGems
+
+After you have pushed a new version to RubyGems, you should rebuild and redeploy the AWS SAM application.

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

@@ -28,13 +28,13 @@ module Uc3DmpId
         related_works = modified_version.fetch('dmproadmap_related_identifiers', [])
 
         if related_works.any?
-          latest_version = _add_related_identifier(updater: updater, latest_version: latest_version,
-                                                   identifiers: related_works, note: note, logger: logger)
+          latest_version = _add_related_identifier(updater:, latest_version:,
+                                                   identifiers: related_works, note:, logger:)
         end
         return latest_version unless !funding.nil? && funding.any?
 
-        _add_funding_mod(updater: updater, latest_version: latest_version, funding: funding,
-                         note: note, logger: logger)
+        _add_funding_mod(updater:, latest_version:, funding:,
+                         note:, logger:)
       end
       # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
@@ -106,7 +106,7 @@ module Uc3DmpId
         end
 
         latest_version['dmproadmap_related_identifiers'] = [] if latest_version['dmproadmap_related_identifiers'].nil?
-        assertion = _generate_assertion(updater: updater, note: note,
+        assertion = _generate_assertion(updater:, note:,
                                         mods: JSON.parse({ dmproadmap_related_identifiers: additions }.to_json))
         if logger.respond_to?(:debug)
           logger.debug(message: 'Adding change to :dmphub_modifications.',
@@ -151,7 +151,7 @@ module Uc3DmpId
         latest_version['dmphub_modifications'] = [] if latest_version['dmphub_modifications'].nil?
         mod = JSON.parse({ funding: fund }.to_json)
         mod['funding']['funding_status'] = 'granted'
-        assertion = _generate_assertion(updater: updater, mods: mod, note: note)
+        assertion = _generate_assertion(updater:, mods: mod, note:)
         if logger.respond_to?(:debug)
           logger.debug(message: 'Adding change to :dmphub_modifications.',
                        details: assertion)
@@ -200,7 +200,7 @@ module Uc3DmpId
           provenance: updater.gsub('PROVENANCE#', ''),
           timestamp: Time.now.utc.iso8601,
           status: 'pending',
-          note: note
+          note:
         }
         mods.each_pair { |key, val| assertion[key] = val }
         JSON.parse(assertion.to_json)

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

@@ -23,23 +23,23 @@ module Uc3DmpId
         raise CreatorError, Helper::MSG_DMP_FORBIDDEN unless provenance.is_a?(Hash) && !provenance['PK'].nil?
 
         # Validate the incoming JSON first
-        json = Helper.parse_json(json: json)
-        errs = Validator.validate(mode: 'author', json: json)
+        json = Helper.parse_json(json:)
+        errs = Validator.validate(mode: 'author', json:)
         raise CreatorError, errs.join(', ') if errs.is_a?(Array) && errs.any? && errs.first != Validator::MSG_VALID_JSON
 
         # Try to find it by the :dmp_id first and Fail if found
         dmp_id = Helper.dmp_id_to_pk(json: json.fetch('dmp', {})['dmp_id'])
-        result = Finder.exists?(p_key: dmp_id, logger: logger) unless dmp_id.nil?
+        result = Finder.exists?(p_key: dmp_id, logger:) unless dmp_id.nil?
         raise CreatorError, Helper::MSG_DMP_EXISTS if result.is_a?(Hash)
 
         # raise CreatorError, Uc3DmpId::MSG_DMP_EXISTS unless json['PK'].nil?
 
         client = Uc3DmpDynamo::Client.new
-        p_key = _preregister_dmp_id(client: client, provenance: provenance, json: json, logger: logger)
+        p_key = _preregister_dmp_id(client:, provenance:, json:, 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'])
+        annotated = Helper.annotate_dmp_json(provenance:, p_key:, json: json['dmp'])
         logger.info(message: "Creating DMP ID: #{p_key}") if logger.respond_to?(:debug)
 
         # Set the :created and :modified timestamps
@@ -48,10 +48,10 @@ module Uc3DmpId
         annotated['modified'] = now
 
         # Create the item
-        resp = client.put_item(json: annotated, logger: logger)
+        resp = client.put_item(json: annotated, logger:)
         raise CreatorError, Helper::MSG_DMP_NO_DMP_ID if resp.nil?
 
-        _post_process(json: annotated, logger: logger)
+        _post_process(json: annotated, logger:)
         Helper.cleanse_dmp_json(json: JSON.parse({ dmp: annotated }.to_json))
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
@@ -75,7 +75,7 @@ module Uc3DmpId
         counter = 0
         while dmp_id == '' && counter <= 10
           prefix = "#{ENV.fetch('DMP_ID_SHOULDER', nil)}#{SecureRandom.hex(2).upcase}#{SecureRandom.hex(2)}"
-          dmp_id = prefix unless Finder.exists?(client: client, p_key: prefix)
+          dmp_id = prefix unless Finder.exists?(client:, p_key: prefix)
           counter += 1
         end
         # Something went wrong and it was unable to identify a unique id
@@ -94,7 +94,7 @@ module Uc3DmpId
 
         # Publish the change to the EventBridge
         publisher = Uc3DmpEventBridge::Publisher.new
-        publisher.publish(source: 'DmpCreator', event_type: 'EZID update', dmp: json, logger: logger)
+        publisher.publish(source: 'DmpCreator', event_type: 'EZID update', dmp: json, logger:)
 
         # Determine if there are any related identifiers that we should try to fetch a citation for
         citable_identifiers = Helper.citable_related_identifiers(dmp: json)
@@ -108,7 +108,7 @@ module Uc3DmpId
         }
         logger.debug(message: 'Fetching citations', details: citable_identifiers) if logger.respond_to?(:debug)
         publisher.publish(source: 'DmpCreator', dmp: json, event_type: 'Citation Fetch', detail: citer_detail,
-                          logger: logger)
+                          logger:)
         true
       end
     end

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

@@ -19,7 +19,7 @@ module Uc3DmpId
 
         # Fetch the latest version of the DMP ID by it's PK
         client = Uc3DmpDynamo::Client.new
-        dmp = Finder.by_pk(p_key: p_key, client: client, cleanse: false, logger: logger)
+        dmp = Finder.by_pk(p_key:, client:, cleanse: false, logger:)
         raise DeleterError, Helper::MSG_DMP_NOT_FOUND unless dmp.is_a?(Hash) && !dmp['dmp'].nil?
 
         # Only allow this if the provenance is the owner of the DMP!
@@ -38,16 +38,16 @@ module Uc3DmpId
         dmp['dmp']['dmphub_tombstoned_at'] = now
 
         # Create the Tombstone version
-        resp = client.put_item(json: dmp['dmp'], logger: logger)
+        resp = client.put_item(json: dmp['dmp'], logger:)
         raise DeleterError, Helper::MSG_DMP_NO_TOMBSTONE if resp.nil?
 
         # Delete the Latest version
-        client.delete_item(p_key: p_key, s_key: Helper::DMP_LATEST_VERSION, logger: logger)
+        client.delete_item(p_key:, s_key: Helper::DMP_LATEST_VERSION, logger:)
 
         # TODO: We should do a check here to see if it was successful!
 
         # Notify EZID about the removal
-        _post_process(json: dmp, logger: logger)
+        _post_process(json: dmp, logger:)
 
         # Return the tombstoned record
         Helper.cleanse_dmp_json(json: dmp)
@@ -66,7 +66,7 @@ module Uc3DmpId
 
         # Publish the change to the EventBridge
         publisher = Uc3DmpEventBridge::Publisher.new
-        publisher.publish(source: 'DmpDeleter', event_type: 'EZID update', dmp: json, logger: logger)
+        publisher.publish(source: 'DmpDeleter', event_type: 'EZID update', dmp: json, logger:)
         true
       end
     end

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

@@ -20,15 +20,15 @@ module Uc3DmpId
       # TODO: Replace this with ElasticSearch
       def search_dmps(args:, logger: nil)
         client = Uc3DmpDynamo::Client.new
-        return _by_owner(owner_org: args['owner_orcid'], client: client, logger: logger) unless args['owner_orcid'].nil?
+        return _by_owner(owner_org: args['owner_orcid'], client:, logger:) unless args['owner_orcid'].nil?
 
         unless args['owner_org_ror'].nil?
-          return _by_owner_org(owner_org: args['owner_org_ror'], client: client,
-                               logger: logger)
+          return _by_owner_org(owner_org: args['owner_org_ror'], client:,
+                               logger:)
         end
         unless args['modification_day'].nil?
-          return _by_mod_day(day: args['modification_day'], client: client,
-                             logger: logger)
+          return _by_mod_day(day: args['modification_day'], client:,
+                             logger:)
         end
 
         []
@@ -38,20 +38,20 @@ module Uc3DmpId
       # -------------------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize
       def by_json(json:, client: nil, cleanse: true, logger: nil)
-        json = Helper.parse_json(json: json)&.fetch('dmp', {})
+        json = Helper.parse_json(json:)&.fetch('dmp', {})
         raise FinderError, MSG_INVALID_ARGS if !json.is_a?(Hash) || (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 : client
+        client = Uc3DmpDynamo::Client.new if client.nil?
 
         # 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, 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, cleanse: cleanse, logger: logger)
+        p_key.nil? ? nil : by_pk(p_key:, s_key: json['SK'], client:, cleanse:, logger:)
       end
       # rubocop:enable Metrics/AbcSize
 
@@ -62,20 +62,20 @@ module Uc3DmpId
         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 : client
+        client = Uc3DmpDynamo::Client.new if client.nil?
         resp = client.get_item(
           key: {
-            PK: Helper.append_pk_prefix(p_key: p_key),
-            SK: Helper.append_sk_prefix(s_key: s_key)
+            PK: Helper.append_pk_prefix(p_key:),
+            SK: Helper.append_sk_prefix(s_key:)
           },
-          logger: 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, logger: logger) if cleanse
+        dmp = Versioner.append_versions(p_key: dmp['dmp']['PK'], dmp:, client:, logger:) if cleanse
         cleanse ? Helper.cleanse_dmp_json(json: dmp) : dmp
       end
       # rubocop:enable Metrics/AbcSize
@@ -85,13 +85,13 @@ module Uc3DmpId
       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 : client
+        client = Uc3DmpDynamo::Client.new if client.nil?
         client.pk_exists?(
           key: {
-            PK: Helper.append_pk_prefix(p_key: p_key),
-            SK: Helper.append_sk_prefix(s_key: s_key)
+            PK: Helper.append_pk_prefix(p_key:),
+            SK: Helper.append_sk_prefix(s_key:)
           },
-          logger: logger
+          logger:
         )
       end
 
@@ -115,15 +115,15 @@ module Uc3DmpId
           filter_expression: 'SK = :version',
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
-        client = client.nil? ? Uc3DmpDynamo::Client.new : client
-        resp = client.query(args: args, logger: logger)
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        resp = client.query(args:, 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?
 
         # If we got a hit, fetch the DMP and return it.
-        by_pk(p_key: dmp['dmp']['PK'], s_key: dmp['dmp']['SK'], cleanse: cleanse, logger: logger)
+        by_pk(p_key: dmp['dmp']['PK'], s_key: dmp['dmp']['SK'], cleanse:, logger:)
       end
       # rubocop:enable Metrics/AbcSize
 
@@ -149,8 +149,8 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         logger.info(message: "Querying _by_owner with #{args}") if logger.respond_to?(:info)
-        client = client.nil? ? Uc3DmpDynamo::Client.new : client
-        _process_search_response(response: client.query(args: args, logger: logger))
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        _process_search_response(response: client.query(args:, logger:))
       end
 
       # Fetch the DMP IDs for the specified organization/institution (the org is the :dmphub_owner_org
@@ -174,8 +174,8 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         logger.info(message: "Querying _by_owner_org with #{args}") if logger.respond_to?(:info)
-        client = client.nil? ? Uc3DmpDynamo::Client.new : client
-        _process_search_response(response: client.query(args: args, logger: logger))
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        _process_search_response(response: client.query(args:, logger:))
       end
 
       # Fetch the DMP IDs modified on the specified date (the date is the :dmphub_modification_day on the DMP ID record)
@@ -195,8 +195,8 @@ module Uc3DmpId
           expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
         logger.info(message: "Querying _by_mod_day with #{args}") if logger.respond_to?(:info)
-        client = client.nil? ? Uc3DmpDynamo::Client.new : client
-        _process_search_response(response: client.query(args: args, logger: logger))
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        _process_search_response(response: client.query(args:, logger:))
       end
 
       # Transform the search results so that we do not include any of the DMPHub specific metadata

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

@@ -7,17 +7,17 @@ module Uc3DmpId
   # Helper functions for working with DMP IDs
   class Helper
     PK_DMP_PREFIX = 'DMP#'
-    PK_DMP_REGEX = %r{DMP#[a-zA-Z0-9\-_.]+/[a-zA-Z0-9]{2}\.[a-zA-Z0-9./:]+}.freeze
+    PK_DMP_REGEX = %r{DMP#[a-zA-Z0-9\-_.]+/[a-zA-Z0-9]{2}\.[a-zA-Z0-9./:]+}
 
     SK_DMP_PREFIX = 'VERSION#'
-    SK_DMP_REGEX = /VERSION#\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}/.freeze
+    SK_DMP_REGEX = /VERSION#\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2}/
 
     # TODO: Verify the assumed structure of the DOI is valid
-    DOI_REGEX = %r{[0-9]{2}\.[0-9]{4,}/[a-zA-Z0-9/_.-]+}.freeze
-    URL_REGEX = %r{(https?://)?([a-zA-Z0-9\-_]\.)+[a-zA-Z0-9\-_]{2,3}(:[0-9]+)?/?}.freeze
+    DOI_REGEX = %r{[0-9]{2}\.[0-9]{4,}/[a-zA-Z0-9/_.-]+}
+    URL_REGEX = %r{(https?://)?([a-zA-Z0-9\-_]\.)+[a-zA-Z0-9\-_]{2,3}(:[0-9]+)?/?}
 
-    DMP_LATEST_VERSION = "#{SK_DMP_PREFIX}latest"
-    DMP_TOMBSTONE_VERSION = "#{SK_DMP_PREFIX}tombstone"
+    DMP_LATEST_VERSION = "#{SK_DMP_PREFIX}latest".freeze
+    DMP_TOMBSTONE_VERSION = "#{SK_DMP_PREFIX}tombstone".freeze
 
     DEFAULT_API_URL = 'https://api.dmphub.uc3dev.cdlib.net/dmps/'
     DEFAULT_LANDING_PAGE_URL = 'https://dmphub.uc3dev.cdlib.net/dmps/'
@@ -41,7 +41,7 @@ module Uc3DmpId
       # Append the PK prefix for the object
       # -------------------------------------------------------------------------------------
       def append_pk_prefix(p_key:)
-        p_key.is_a?(String) ? "#{PK_DMP_PREFIX}#{remove_pk_prefix(p_key: p_key)}" : nil
+        p_key.is_a?(String) ? "#{PK_DMP_PREFIX}#{remove_pk_prefix(p_key:)}" : nil
       end
 
       # Strip off the PK prefix
@@ -53,7 +53,7 @@ module Uc3DmpId
       # Append the SK prefix for the object
       # -------------------------------------------------------------------------------------
       def append_sk_prefix(s_key:)
-        s_key.is_a?(String) ? "#{SK_DMP_PREFIX}#{remove_sk_prefix(s_key: s_key)}" : nil
+        s_key.is_a?(String) ? "#{SK_DMP_PREFIX}#{remove_sk_prefix(s_key:)}" : nil
       end
 
       # Strip off the SK prefix
@@ -82,7 +82,7 @@ module Uc3DmpId
         return with_protocol ? value : value.gsub(%r{https?://}, '') if value.start_with?('http')
 
         dmp_id = dmp_id.gsub('doi:', '')
-        dmp_id = dmp_id.start_with?('/') ? dmp_id[1..dmp_id.length] : dmp_id
+        dmp_id = dmp_id[1..dmp_id.length] if dmp_id.start_with?('/')
         base_domain = with_protocol ? dmp_id_base_url : dmp_id_base_url.gsub(%r{https?://}, '')
         "#{base_domain}#{dmp_id}"
       end
@@ -95,7 +95,7 @@ module Uc3DmpId
         p_key = param if param.start_with?(dmp_id_base_url) || param.start_with?(base_domain)
         p_key = CGI.unescape(p_key.nil? ? param : p_key)
         p_key = format_dmp_id(value: p_key)
-        append_pk_prefix(p_key: p_key)
+        append_pk_prefix(p_key:)
       end
 
       # Append the :PK prefix to the :dmp_id
@@ -115,7 +115,7 @@ module Uc3DmpId
 
         {
           type: 'doi',
-          identifier: format_dmp_id(value: remove_pk_prefix(p_key: p_key), with_protocol: true)
+          identifier: format_dmp_id(value: remove_pk_prefix(p_key:), with_protocol: true)
         }
       end
 
@@ -180,7 +180,7 @@ module Uc3DmpId
       # Add DMPHub specific fields to the DMP ID JSON
       # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def annotate_dmp_json(provenance:, p_key:, json:)
-        json = parse_json(json: json)
+        json = parse_json(json:)
         bool_vals = [1, '1', true, 'true', 'yes']
         return json if provenance.nil? || p_key.nil? || !json.is_a?(Hash)
 
@@ -189,14 +189,14 @@ module Uc3DmpId
         return json if id != p_key && !json['PK'].nil?
 
         annotated = deep_copy_dmp(obj: json)
-        annotated['PK'] = json['PK'] || append_pk_prefix(p_key: p_key)
+        annotated['PK'] = json['PK'] || append_pk_prefix(p_key:)
         annotated['SK'] = DMP_LATEST_VERSION
 
         # Ensure that the :dmp_id matches the :PK
         annotated['dmp_id'] = JSON.parse(pk_to_dmp_id(p_key: remove_pk_prefix(p_key: annotated['PK'])).to_json)
 
-        owner_id = extract_owner_id(json: json)
-        owner_org = extract_owner_org(json: json)
+        owner_id = extract_owner_id(json:)
+        owner_org = extract_owner_org(json:)
 
         # Set the :dmproadmap_featured flag appropriately
         featured = annotated.fetch('dmproadmap_featured', 'no')
@@ -219,7 +219,7 @@ module Uc3DmpId
           annotated['dmphub_provenance_identifier'] = annotated.fetch('dmproadmap_links', {})['get']
         else
           annotated['dmphub_provenance_identifier'] = format_provenance_id(
-            provenance: provenance, value: json.fetch('dmp_id', {})['identifier']
+            provenance:, value: json.fetch('dmp_id', {})['identifier']
           )
         end
         annotated

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

@@ -16,18 +16,18 @@ module Uc3DmpId
       def update(provenance:, p_key:, json: {}, note: nil, 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: json).fetch('dmp', {})
-        p_key = Helper.append_pk_prefix(p_key: p_key)
+        mods = 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)
 
         # Fetch the latest version of the DMP ID
         client = Uc3DmpDynamo::Client.new
-        latest_version = Finder.by_pk(p_key: p_key, client: client, logger: logger, cleanse: false)
-        latest_version = latest_version['dmp'].nil? ? latest_version : latest_version.fetch('dmp', {})
+        latest_version = Finder.by_pk(p_key:, client:, logger:, cleanse: false)
+        latest_version = latest_version.fetch('dmp', {}) unless latest_version['dmp'].nil?
         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'],
+        errs = _updateable?(provenance:, 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?
@@ -37,35 +37,35 @@ module Uc3DmpId
         # 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)
+        version = Versioner.generate_version(client:, latest_version:, owner:,
+                                             updater:, 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')
 
         # Splice the assertions
-        version = _process_modifications(owner: owner, updater: updater, version: version, mods: mods, note: note,
-                                         logger: logger)
+        version = _process_modifications(owner:, updater:, version:, mods:, note:,
+                                         logger:)
         # Set the :modified timestamps
         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)
+        resp = client.put_item(json: version, logger:)
         raise UpdaterError, Helper::MSG_DMP_UNABLE_TO_VERSION if resp.nil?
 
         # Send the updates to EZID
-        _post_process(provenance: provenance, json: version, logger: logger)
+        _post_process(provenance:, json: version, logger:)
 
         # Return the new version record
         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: p_key, dmp: json, client: client, logger: logger)
-        Helper.cleanse_dmp_json(json: json)
+        json = Versioner.append_versions(p_key:, dmp: json, client:, logger:)
+        Helper.cleanse_dmp_json(json:)
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
       # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
@@ -77,21 +77,21 @@ module Uc3DmpId
         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)
+        client = Uc3DmpDynamo::Client.new(logger:)
+        dmp = Finder.by_pk(p_key:, client:, logger:, cleanse: false)
         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 = Helper.annotate_dmp_json(provenance:, p_key:, json: dmp['dmp'])
         annotated['dmproadmap_related_identifiers'] = [] if annotated['dmproadmap_related_identifiers'].nil?
         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)
+        resp = client.put_item(json: annotated, logger:)
         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)
@@ -111,8 +111,9 @@ module Uc3DmpId
         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 [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 [Helper::MSG_DMP_UNKNOWN] unless latest_version.is_a?(Hash) && latest_version['PK'] == p_key
+        [Helper::MSG_DMP_UNKNOWN] unless latest_version.is_a?(Hash) && latest_version['PK'] == p_key
       end
       # rubocop:enable Metrics/AbcSize
 
@@ -123,14 +124,14 @@ module Uc3DmpId
 
         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)
+                    Asserter.splice(latest_version: version, modified_version: mods, 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)
+                    Asserter.add(updater:, latest_version: version, modified_version: mods, note:,
+                                 logger:)
                   end
 
-        _merge_versions(latest_version: version, mods: updated, logger: logger)
+        _merge_versions(latest_version: version, mods: updated, logger:)
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -172,7 +173,7 @@ module Uc3DmpId
           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
+        publisher.publish(source: 'DmpUpdater', event_type: 'EZID update', dmp: json, 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)
@@ -189,7 +190,7 @@ module Uc3DmpId
                        details: citable_identifiers)
         end
         publisher.publish(source: 'DmpUpdater', dmp: json, event_type: 'Citation Fetch', detail: citer_detail,
-                          logger: logger)
+                          logger:)
         true
       end
       # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

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

@@ -23,11 +23,11 @@ module Uc3DmpId
       # 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)
+        json = Helper.parse_json(json:)
         return [MSG_EMPTY_JSON] if json.nil? || !VALIDATION_MODES.include?(mode)
 
         # Load the appropriate JSON schema for the mode
-        schema = _load_schema(mode: mode)
+        schema = _load_schema(mode:)
         return [MSG_NO_SCHEMA] if schema.nil?
 
         # Validate the JSON

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

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

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

@@ -18,13 +18,13 @@ module Uc3DmpId
 
         args = {
           key_conditions: {
-            PK: { attribute_value_list: [Helper.append_pk_prefix(p_key: p_key)], comparison_operator: 'EQ' }
+            PK: { attribute_value_list: [Helper.append_pk_prefix(p_key:)], comparison_operator: 'EQ' }
           },
           projection_expression: 'modified',
           scan_index_forward: false
         }
-        client = client.nil? ? Uc3DmpDynamo::Client.new : client
-        client.query(args: args, logger: logger)
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        client.query(args:, logger:)
       end
 
       # Generate a snapshot of the current latest version of the DMP ID using the existing :modified as
@@ -57,8 +57,8 @@ module Uc3DmpId
         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)
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        resp = client.put_item(json: prior, logger:)
         return nil if resp.nil?
 
         msg = "#{SOURCE} created version PK: #{prior['PK']} SK: #{prior['SK']}"
@@ -74,7 +74,7 @@ module Uc3DmpId
         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, logger: logger)
+        results = get_versions(p_key:, client:, logger:)
         return json unless results.length > 1
 
         # TODO: we may want to include milliseconds in the future if we get increased volume so that
@@ -82,7 +82,7 @@ module Uc3DmpId
         versions = results.map do |ver|
           next if ver['modified'].nil?
 
-          base_url = "#{Helper.landing_page_url}#{Helper.remove_pk_prefix(p_key: p_key)}"
+          base_url = "#{Helper.landing_page_url}#{Helper.remove_pk_prefix(p_key:)}"
           {
             timestamp: ver['modified'],
             url: dmp['dmp']['modified'] == ver['modified'] ? base_url : "#{base_url}?version=#{ver['modified']}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uc3-dmp-id
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brian Riley
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2023-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -91,7 +91,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'false'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,15 +100,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: DMPTool gem that provides support for DMP ID records
 test_files: []