uc3-dmp-id 0.1.67 → 0.1.69

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c2deeeeb8ad969be7b2f9e16463dd1877735078692146d69a481d9cb8a8e2ba
-  data.tar.gz: e8dd8cd23aa8613a78114a7c211cdbd79a5fb07bdd056cb1617b20218bbf36d8
+  metadata.gz: c4355f81f314520bd52003c27e4593e670322a0efe7d400e647edb4dac10dfd3
+  data.tar.gz: af81b71d4a6a1ad0c415afc7f2b7f69e916feab5e9cdbf99079ffc9e30cc1397
 SHA512:
-  metadata.gz: c0ec1f87093fb330703a54e81f7e5374cce198652b16f2185f93438729bdbbf3ea084efc513f9a91abb7724aef2d773984adc9c9cbde50f64b29fa2f122e273e
-  data.tar.gz: 2976f80563a048fb5270fd77880171e7cb21d455142022b60f0d9390a4b5226fb515cb553a484885518e0d2407f4a059c9b1f9cbf65c4c31fb3c7a0c1054b276
+  metadata.gz: ced1e2298a918308e0948326645ffdfeb0519c07d611dfd8909f70138bbf32a485926d9b1752b9fe556a71466bca2b8cc44f25e904891559ca929f69aeaf2483
+  data.tar.gz: c96ddbefb0409be5da359ef0158efa3d876fd2f28856c6bc4a12b9591651013b1a13f478af454129497f1e86515274bcad5f60da89fd7b0824b60196d5b65974

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

@@ -17,43 +17,22 @@ module Uc3DmpId
     MSG_MISSING_PROV_ID = 'No Provenance identifier was provided. \
                            Expected: `{ "dmp_id": { "identifier": "value", "type": "value" }`'
 
-    ORCID_DOMAIN = 'https://orcid.org/'
-    ROR_DOMAIN = 'https://ror.org/'
-    SORT_OPTIONS = %w[title modified]
-    SORT_DIRECTIONS = %w[asc desc]
-    MAX_PAGE_SIZE = 100
-    DEFAULT_PAGE_SIZE = 25
-    DEFAULT_SORT_OPTION = 'modified'
-    DEFAULT_SORT_DIR = 'desc'
-
     class << self
       # TODO: Replace this with ElasticSearch
       def search_dmps(args:, logger: nil)
-        # Fetch the DMPs for each of the possible filter options
-        client = Uc3DmpDynamo::Client.new(table: ENV['DYNAMO_INDEX_TABLE'])
-        owner = args['owner']
-        org = args['org']
-        funder = args['funder']
-
-        owner_pks = owner.nil? ? [] : _by_owner(owner: owner, client:, logger:)
-        org_pks = org.nil? ? [] : _by_org(org: org, client:, logger:)
-        funder_pks = funder.nil? ? [] : _by_funder(funder: funder, client:, logger:)
-        # pks = [owner_pks, org_pks, funder_pks].reject(&:empty?)
-        logger&.debug(
-          message: 'PKs found',
-          details: { owner: owner_pks, org: org_pks, funder: funder_pks }
-        )
-        # return [] if pks.nil? || pks.empty?
-
-        # Only use the DMPs that fit all of the filter criteria
-        # dmps = pks.reduce(:&).flatten.uniq
-        # return [] if dmps.nil? || dmps.empty?
+        client = Uc3DmpDynamo::Client.new
+        return _by_owner(owner_org: args['owner_orcid'], client:, logger:) unless args['owner_orcid'].nil?
 
-        pks = [owner_pks, org_pks, funder_pks].flatten.uniq
+        unless args['owner_org_ror'].nil?
+          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:,
+                             logger:)
+        end
 
-        # Fetch full DMP records for the results
-        client = Uc3DmpDynamo::Client.new(table: ENV['DYNAMO_TABLE'])
-        pks.map { |p_key| by_pk(p_key:, client:, logger:, cleanse: true) }
+        []
       end
 
       # Find a DMP based on the contents of the incoming JSON
@@ -155,65 +134,74 @@ module Uc3DmpId
 
       private
 
-      # Fetch the DMP IDs for the specified person's ORCID (or email)
-      def _by_owner(owner:, client: nil, logger: nil)
-        orcid_regex = /^([0-9a-zA-Z]{4}-){3}[0-9a-zA-Z]{4}$/
-        email_regex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/
-        orcid = owner.to_s.strip
-        return [] if (orcid =~ orcid_regex).nil? && (orcid =~ email_regex).nil?
+      # 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:, client: nil, logger: nil)
+        regex = /^([0-9A-Z]{4}-){3}[0-9A-Z]{4}$/
+        raise FinderError, MSG_INVALID_OWNER_ID if owner_id.nil? || (owner_id.to_s =~ regex).nil?
 
-        orcid = "#{ORCID_DOMAIN}#{orcid}" unless (orcid =~ orcid_regex).nil?
-        resp = client.get_item(key: { PK: 'PERSON_INDEX', SK: orcid }, logger:)
-        return [] unless resp.is_a?(Hash)
-
-        logger&.debug(message: "DMPs for PERSON #{orcid}", details: resp)
-        resp.fetch('dmps', [])
-      end
-
-      # Fetch the DMP IDs for the specified organization/institution
-      def _by_org(org:, client: nil, logger: nil)
-        regex = /^[a-zA-Z0-9]+$/
-        ror = "#{ROR_DOMAIN}/#{org.strip}" unless (org.to_s =~ regex).nil?
-
-        resp = client.get_item(key: { PK: 'AFFILIATION_INDEX', SK: ror }, logger:)
-        return [] unless resp.is_a?(Hash)
-
-        logger&.debug(message: "DMPs for AFFILIATION #{ror}", details: resp)
-        resp.fetch('dmps', [])
+        args = {
+          index_name: 'dmphub_owner_id_gsi',
+          key_conditions: {
+            dmphub_owner_id: {
+              attribute_value_list: [
+                "http://orcid.org/#{owner_id}",
+                "https://orcid.org/#{owner_id}"
+              ],
+              comparison_operator: 'IN'
+            }
+          },
+          filter_expression: 'SK = :version',
+          expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
+        }
+        logger.info(message: "Querying _by_owner with #{args}") if logger.respond_to?(:info)
+        client = Uc3DmpDynamo::Client.new if client.nil?
+        _process_search_response(response: client.query(args:, logger:))
       end
 
-      # Fetch the DMP IDs for the specified funder
-      def _by_funder(funder:, client: nil, logger: nil)
+      # 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:, client: nil, logger: nil)
         regex = /^[a-zA-Z0-9]+$/
-        ror = "#{ROR_DOMAIN}/#{funder.strip}" unless (funder.to_s =~ regex).nil?
-
-        resp = client.get_item(key: { PK: 'FUNDER_INDEX', SK: ror }, logger:)
-        return [] unless resp.is_a?(Hash)
-
-        logger&.debug(message: "DMPs for FUNDER #{ror}", details: resp)
-        resp.fetch('dmps', [])
-      end
+        raise FinderError, MSG_INVALID_OWNER_ID if owner_org.nil? || (owner_org.to_s.downcase =~ regex).nil?
 
-      # Fetch the DMP IDs that are marked as featured
-      def _by_featured(client: nil, logger: nil)
         args = {
-          filter_expression: 'featured = :featured AND SK = :sk',
-          expression_attribute_values: { ':sk': 'METADATA', ':featured': 1 }
+          index_name: 'dmphub_owner_org_gsi',
+          key_conditions: {
+            dmphub_owner_org: {
+              attribute_value_list: [
+                "https://ror.org/#{owner_org.to_s.downcase}",
+                "http://ror.org/#{owner_org.to_s.downcase}"
+              ],
+              comparison_operator: 'IN'
+            }
+          },
+          filter_expression: 'SK = :version',
+          expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
-        logger&.debug(message: 'Fetch relevant DMPs _by_featured - scan args', details: args)
+        logger.info(message: "Querying _by_owner_org with #{args}") if logger.respond_to?(:info)
         client = Uc3DmpDynamo::Client.new if client.nil?
-        _process_search_response(response: client.scan(args:))
+        _process_search_response(response: client.query(args:, logger:))
       end
 
-      # Return all of the publicly visible DMPs
-      def _publicly_visible(client: nil, logger: nil)
+      # 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:, client: nil, logger: nil)
+        regex = /^[0-9]{4}(-[0-9]{2}){2}/
+        raise FinderError, MSG_INVALID_OWNER_ID if day.nil? || (day.to_s =~ regex).nil?
+
         args = {
-          filter_expression: 'visibility = :visibility AND SK = :sk',
-          expression_attribute_values: { ':sk': 'METADATA', ':visibility': 'public' }
+          index_name: 'dmphub_modification_day_gsi',
+          key_conditions: {
+            dmphub_modification_day: {
+              attribute_value_list: [day.to_s],
+              comparison_operator: 'IN'
+            }
+          },
+          filter_expression: 'SK = :version',
+          expression_attribute_values: { ':version': Helper::DMP_LATEST_VERSION }
         }
-        logger&.debug(message: 'Fetch relevant DMPs _publicly_visible - scan args', details: args)
+        logger.info(message: "Querying _by_mod_day with #{args}") if logger.respond_to?(:info)
         client = Uc3DmpDynamo::Client.new if client.nil?
-        _process_search_response(response: client.scan(args:))
+        _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
@@ -224,8 +212,8 @@ module Uc3DmpId
           next if item.nil?
 
           dmp = item['dmp'].nil? ? JSON.parse({ dmp: item }.to_json) : item
-          # dmp = _remove_narrative_if_private(json: dmp)
-          # Helper.cleanse_dmp_json(json: dmp)
+          dmp = _remove_narrative_if_private(json: dmp)
+          Helper.cleanse_dmp_json(json: dmp)
         end
         results.compact.uniq
       end

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

@@ -44,13 +44,15 @@ module Uc3DmpId
         raise UpdaterError, Helper::MSG_DMP_FORBIDDEN if owner != updater
 
         # Handle any changes to the dmphub_modifications section
-        version = _process_harvester_mods(client:, p_key:, json: version, logger:)
+        version = _process_harvester_mods(client:, p_key:, json: mods, logger:)
 
         # 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:, updater:, version:, mods:, logger:)
+        logger&.debug(message: 'Mods after process_modifications', details: mods)
+
         # Set the :modified timestamps
         now = Time.now.utc
         version['modified'] = now.iso8601
@@ -192,6 +194,7 @@ module Uc3DmpId
 
       # Fetch any Harvester modifications to the JSON
       def _process_harvester_mods(client:, p_key:, json:, logger: nil)
+        logger&.debug(message: 'Incoming modifications', details: json)
         return json if json.fetch('dmphub_modifications', []).empty?
 
         # Fetch the `"SK": "HARVESTER_MODS"` record
@@ -201,6 +204,7 @@ module Uc3DmpId
         )
         return json unless resp.is_a?(Hash) && resp['related_works'].is_a?(Hash)
 
+        logger&.debug(message: 'Original HARVESTER_MODS record', details: resp)
         # The `dmphub_modifications` array will ONLY ever have things the harvester mods know about
         # so just find them and update the status accordingly
         mods = resp.dup
@@ -208,14 +212,18 @@ module Uc3DmpId
           next if entry.fetch('dmproadmap_related_identifiers', []).empty?
 
           entry['dmproadmap_related_identifiers'].each do |related|
-            next if mods['related_works'][related.identifier].nil?
+            related_id = mods['related_works'][related.identifier] if related.respond_to?(:identifier)
+            related_id = mods['related_works'][related['identifier']] if related_id.nil?
+            next if related_id.nil?
 
-            mods['related_works'][related.identifier]['status'] = related['status']
+            mods['related_works'][related_id]['status'] = related['status']
           end
         end
 
+        logger&.debug(message: 'Updating HARVESTER_MODS with:', details: mods)
         client.put_item(json: mods, logger:)
         json.delete('dmphub_modifications')
+        logger&.debug(message: 'After deleting dmphub_modifications:', details: json)
         json
       end
     end

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

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

metadata

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