uc3-dmp-id 0.0.74 → 0.0.76

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aafd3e027681cfa713fad3c48471dae7a192cd844546e67a55cec59ae0c2e1d8
-  data.tar.gz: deda47068b080ccbfddd35091cde8626bde787110ae5a4df6bb204f0b248ff89
+  metadata.gz: 2f769de6ae77fa371a710f13351629a90092a596131b31f82d7ad5161e792f12
+  data.tar.gz: a3da20ecdce90334053349c726f4d4ed78abe00d5b915366957963be82ccbd40
 SHA512:
-  metadata.gz: 578c94e8fc0da1b8bb36b163eca0cdd656fc1ae63cbdb02f4be104a6746d137f83b5dc6cd36424549c8f227eba20b69f7058710fb188a400fa546db28a52e08a
-  data.tar.gz: fc2e39ea16382559b2eac7459528e7cf241623dd9256497088f4c000819dda5d491a80a7f555ed6e357a510d85228884aa842c38b5175e64c15c0666dfb2df26
+  metadata.gz: f4a350af34ae4eff82a0c24c2de1e309b62ece8b268d53b23014ed05505dbe646c0a40f126a5a346c88047a30e790e52375cfed3956b879ee2ba5f2b94cf5ccc
+  data.tar.gz: 9cda04030ef741a7f1f66eb62a7124755b572ae9791f8485a5081ac72c0efcd181b36e88f409b472078655bf7c2226f28b2956f16fb31e781ed362165ca4729d

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

@@ -43,7 +43,8 @@ puts resp.inspect
 
         # Notify EZID about the removal
         _post_process(json: dmp, debug: debug)
-        dmp
+        # 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)

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

@@ -9,15 +9,22 @@ module Uc3DmpId
   class Finder
     MSG_INVALID_ARGS = 'Expected JSON to be structured as `{ "dmp": { "PK": "value"} } OR \
                         { "dmp": { "dmp_id": { "identifier": "value", "type": "value" } }`'
+    MSG_INVALID_OWNER_ID = 'Invalid :owner_orcid. Expected value to start with `https://orcid.org/`.'
+    MSG_INVALID_OWNER_ORG = 'Invalid :owner_org_ror. Expected value to start with `https://ror.org/`.'
+    MSG_INVALID_MOD_DATE = 'Invalid :modification_day. Expected value to be in the `YYYY-MM-DD` format.'
     MSG_MISSING_PK = 'No PK was provided'
     MSG_MISSING_PROV_ID = 'No Provenance identifier was provided. \
                            Expected: `{ "dmp_id": { "identifier": "value", "type": "value" }`'
 
+
     class << self
       # TODO: Replace this with ElasticSearch
-      def search_dmps(args:)
+      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?
 
-        # TODO: Need to move this to ElasticSearch!!!
+        []
       end
       # rubocop:enable Metrics/MethodLength
 
@@ -104,6 +111,89 @@ module Uc3DmpId
         by_pk(p_key: dmp['dmp']['PK'], s_key: dmp['dmp']['SK'])
       end
       # rubocop:enable Metrics/AbcSize
+
+      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)
+        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?
+
+        args = {
+          index_name: 'dmphub_owner_id_gsi',
+          key_conditions: {
+            dmphub_owner_id: {
+              attribute_value_list: [
+                "http://orcid.org/#{owner_id.to_s.downcase}",
+                "https://orcid.org/#{owner_id.to_s.downcase}"
+              ],
+              comparison_operator: 'EQ'
+            }
+          },
+          filter_expression: 'SK = :version',
+          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))
+      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)
+        regex = %r{^[a-zA-Z0-9]+$}
+        raise FinderError, MSG_INVALID_OWNER_ID if owner_org.nil? ||(owner_org.to_s.downcase =~ regex).nil?
+
+        args = {
+          index_name: 'dmphub_owner_org_gsi',
+          key_conditions: {
+            dmphub_owner_org: {
+              attribute_value_list: [
+                "http://ror.org/#{owner_org.to_s.downcase}",
+                "https://ror.org/#{owner_org.to_s.downcase}"
+              ],
+              comparison_operator: 'EQ'
+            }
+          },
+          filter_expression: 'SK = :version',
+          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))
+      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)
+        regex = %r{^[0-9]{4}(-[0-9]{2}){2}}
+        raise FinderError, MSG_INVALID_OWNER_ID if day.nil? || (day.to_s =~ regex).nil?
+
+        args = {
+          index_name: 'dmphub_modification_day_gsi',
+          key_conditions: {
+            dmphub_modification_day: {
+              attribute_value_list: [day.to_s],
+              comparison_operator: 'EQ'
+            }
+          },
+          filter_expression: 'SK = :version',
+          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))
+      end
+
+
+      # Transform the search results so that we do not include any of the DMPHub specific metadata
+      def _process_search_response(response:)
+        return [] unless response.is_a?(Array) && response.any?
+
+        results = response.each do |item|
+          dmp = item['dmp'].nil? ? JSON.parse({ dmp: item }.to_json) : item
+          Helper.cleanse_dmp_json(json: dmp)
+        end
+        results.compact.uniq
+      end
     end
   end
 end

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: {})
+      def update(provenance:, p_key:, json: {}, debug: false)
         raise UpdaterError, MSG_DMP_INVALID_DMP_ID unless p_key.is_a?(String) && !p_key.strip.empty?
 
         dmp = Helper.parse_json(json: json)
@@ -35,7 +35,8 @@ module Uc3DmpId
 
         # Send the updates to EZID, notify the provenance and download the PDF if applicable
         _post_process(json: dmp, debug: debug)
-        resp
+        # Return the new version record
+        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

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

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

metadata

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