uc3-dmp-id 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 439dc6215dd2f0961bab62a72a42e5e7bf3767b349c856e444e98276ed13065e
-  data.tar.gz: f517db3e0bf58db5c0ae7e9b66a1158dc29445fafddaab9453f6f92e4d7fb111
+  metadata.gz: ab1c5afc33fa7cf9bafbc4a62a282a0674cdbe81c47566865789db74fc411ea3
+  data.tar.gz: 16521d303406e294953b43108abb65b8e7af94d635a782e8008db91cae6e4c96
 SHA512:
-  metadata.gz: 119a39aab1d09b3c934570635563d26d5588727b708bac26ed713a93a7e011febdc20ad7c2718cc968cb0d9bc7a3e77f1580975e7a951aaeeb7316a8f565ab03
-  data.tar.gz: 4ccfb7ca8a8cca9610b1ae207f96d128dac1c1c5adc265964b4027dc85310546c4d48fc2d6614f441614999f916d39d90e61d7eb8c70ac5e7813f08d2af61dc7
+  metadata.gz: fbf1707d4052898f39ad30f06979f1218951f02bf24833669ff4743957a4e404278fe8112b791a5bef9f27d99e9081a267ee135a283467e77ea894143607ac43
+  data.tar.gz: bfc2e024b3f73980302f2d8e3a15d945a541129ed02286b6f052371489f48a97e6af4eec31e46669169157035bacc28acd89954db1e5b3ea407647f35c907b5c

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

@@ -23,7 +23,7 @@ module Uc3DmpId
 
       # Find the DMP's versions
       # -------------------------------------------------------------------------
-      def versions(p_key:)
+      def versions(p_key:, client: nil, log_writer: nil, debug: false)
         raise Uc3DmpIdFinderError, MSG_MISSING_PK if p_key.nil?
 
         args = {
@@ -33,36 +33,36 @@ module Uc3DmpId
           projection_expression: 'modified',
           scan_index_forward: false
         }
-        client = Uc3DmpDynamo::Client.new
+        client = client.nil? ? Uc3DmpDynamo::Client.new(log_writer: log_writer, debug: debug) : client
         client.query(**args)
       end
 
       # Find a DMP based on the contents of the incoming JSON
       # -------------------------------------------------------------------------
-      def by_json(json:)
+      def by_json(json:, log_writer: nil, debug: false)
         json = Validator.parse_json(json: json)&.fetch('dmp', {})
         raise Uc3DmpIdFinderError, 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?
-
-        # find_by_PK
-        resp = by_pk(p_key: p_key, s_key: json['SK']) unless p_key.nil?
-        return resp unless resp.nil?
+        client = client.nil? ? Uc3DmpDynamo::Client.new(log_writer: log_writer, debug: debug) : client
 
         # find_by_dmphub_provenance_id -> if no PK and no dmp_id result
-        by_dmphub_provenance_identifier(json: json)
+        return by_provenance_identifier(json: json, client: client, log_writer: log_writer, debug: debug) if p_key.nil?
+
+        # find_by_PK
+        by_pk(p_key: p_key, s_key: json['SK'], client: client, log_writer: log_writer, debug: debug)
       end
 
       # Find the DMP by its PK and SK
       # -------------------------------------------------------------------------
-      def by_pk(p_key:, s_key: Helper::DMP_LATEST_VERSION)
+      def by_pk(p_key:, s_key: Helper::DMP_LATEST_VERSION, client: nil, log_writer: nil, debug: false)
         raise Uc3DmpIdFinderError, MSG_MISSING_PK if p_key.nil?
 
         s_key = Helper::DMP_LATEST_VERSION if s_key.nil? || s_key.strip.empty?
 
-        client = Uc3DmpDynamo::Client.new
+        client = client.nil? ? Uc3DmpDynamo::Client.new(log_writer: log_writer, debug: debug) : client
         resp = client.get_item(
           key: {
             PK: Helper.append_pk_prefix(dmp: p_key),
@@ -71,13 +71,13 @@ module Uc3DmpId
         )
         return nil if resp.nil? || resp.fetch('dmp', {})['PK'].nil?
 
-        _append_versions(p_key: resp['dmp']['PK'], dmp: resp)
+        _append_versions(p_key: resp['dmp']['PK'], dmp: resp, client: client)
       end
 
       # Attempt to find the DMP item by the provenance system's identifier
       # -------------------------------------------------------------------------
       # rubocop:disable Metrics/AbcSize
-      def by_dmphub_provenance_identifier(json:)
+      def by_provenance_identifier(json:, client: nil, log_writer: nil, debug: false)
         raise Uc3DmpIdFinderError, MSG_MISSING_PROV_ID if json.nil? || json.fetch('dmp_id', {})['identifier'].nil?
 
         args = {
@@ -90,7 +90,7 @@ module Uc3DmpId
           filter_expression: 'SK = :version',
           expression_attribute_values: { ':version': KeyHelper::DMP_LATEST_VERSION }
         }
-        client = Uc3DmpDynamo::Client.new
+        client = client.nil? ? Uc3DmpDynamo::Client.new(log_writer: log_writer, debug: debug) : client
         resp = client.query(**args)
         return resp if resp.nil? || resp['dmp'].nil?
 
@@ -103,10 +103,10 @@ module Uc3DmpId
 
       # Build the dmphub_versions array and attach it to the dmp
       # rubocop:disable Metrics/AbcSize
-      def _append_versions(p_key:, dmp:)
+      def _append_versions(p_key:, dmp:, client: nil, log_writer: log_writer, debug: false)
         return dmp if p_key.nil? || !dmp.is_a?(Hash) || dmp['dmp'].nil?
 
-        results = find_dmp_versions(p_key: p_key)
+        results = versions(p_key: p_key, client: client, log_writer: log_writer, debug: debug)
         return dmp unless results.length > 1
 
         versions = results.map do |version|

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

@@ -22,6 +22,30 @@ module Uc3DmpId
     DMP_TOMBSTONE_VERSION = "#{SK_DMP_PREFIX}tombstone"
 
     class << self
+      # 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
+      end
+
+      # Strip off the PK prefix
+      # -------------------------------------------------------------------------------------
+      def remove_pk_prefix(p_key:)
+        p_key.is_a?(String) ? p_key.gsub(PK_DMP_PREFIX, '') : p_key
+      end
+
+      # Append the SK prefix for the object
+      # -------------------------------------------------------------------------------------
+      def append_sk_prefix(s_key:)
+        s_key.is_a?(String) ? "#{SK_DMP_PREFIX}#{remove_pk_prefix(s_key: s_key)}" : nil
+      end
+
+      # Strip off the SK prefix
+      # -------------------------------------------------------------------------------------
+      def remove_sk_prefix(s_key:)
+        s_key.is_a?(String) ? s_key.gsub(SK_DMP_PREFIX, '') : s_key
+      end
+
       # Return the base URL for a DMP ID
       def dmp_id_base_url
         url = ENV.fetch('DMP_ID_BASE_URL', 'https://dmptool-dev.cdlib.org/dmps/')

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

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

data/lib/uc3-dmp-id.rb

@@ -13,6 +13,13 @@ require 'uc3-dmp-id/validator'
 require 'uc3-dmp-id/versioner'
 
 module Uc3DmpId
-
+  MSG_DMP_EXISTS = 'DMP already exists. Try :update instead.'
+  MSG_DMP_UNKNOWN = 'DMP does not exist. Try :create instead.'
+  MSG_DMP_NOT_FOUND = 'DMP does not exist.'
+  MSG_DMP_FORBIDDEN = 'You do not have permission.'
+  MSG_DMP_NO_DMP_ID = 'A DMP ID could not be registered at this time.'
+  MSG_DMP_INVALID_DMP_ID = 'Invalid DMP ID format.'
+  MSG_DMP_NO_HISTORICALS = 'You cannot modify a historical version of the DMP.'
+  MSG_DMP_UNABLE_TO_VERSION = 'Unable to version this DMP.'
 end
 # rubocop:enable Naming/FileName

metadata

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