uc3-dmp-id 0.1.86 → 0.1.88

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4058648219af1d94417a32457d48fe2d7b1139679785909b34d7af398be5dea7
-  data.tar.gz: eb8048888ab4bd00dd44053fe9eb06fa4e4104a54b15a7b908ca35f193770732
+  metadata.gz: 8d752505298a89f722b0706279af48bd76aed33e86a123f853332d8cda583e84
+  data.tar.gz: 8b7777cf441c79a236ccbf5b7f01ad30509b8b012633e82bc6b46f1e5821a709
 SHA512:
-  metadata.gz: 49fecf88078de154046ea0a9fa21ba1c96ece0a6aa2a9632c38d5dbadabcef9a672305ffb370934f6028f2bbf50b1740710b8187f39f6f0857e8921304e95d51
-  data.tar.gz: de4ff71ab78e95c9e0404ff1d66a9e0d8d01128fe9d6f04b0499450ad4630adbbf0095f53e093f617040eee426c4ffada6b54f9dd3caff7b524f3a2a9345176f
+  metadata.gz: 81243b26a046da78451dcc5e744f62d51798f49607751c0d0633e92a149ba857bb26b7a50036c1aac2a44ef80be695556cab0f7b76d4f934f77299c9bceddec3
+  data.tar.gz: d8b5539c4c8108ef8f34303676cff0f8cecb7442451e9e2bacbc0b0dcd3ae88590c5221deee4b91cabc5269a473f4e43f5b2967d05888f08fa0f9eff8b1010d8

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

@@ -53,7 +53,7 @@ module Uc3DmpId
         annotated['registered'] = annotated['created'] if annotated['registered'].nil?
 
         # Create the item
-        annotated.delete('dmphub_modifications')
+        annotated['dmphub_modifications'] = []
         resp = client.put_item(json: annotated, logger:)
         raise CreatorError, Helper::MSG_DMP_NO_DMP_ID if resp.nil?
 

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

@@ -17,22 +17,36 @@ 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/'
+    DOI_DOMAIN = 'https://doi.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)
-        client = Uc3DmpDynamo::Client.new
-        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:,
-                               logger:)
-        end
-        unless args['modification_day'].nil?
-          return _by_mod_day(day: args['modification_day'], client:,
-                             logger:)
-        end
+        # 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:)
+        # There may be multiple Org ids, so query them all
+        org_pks = org.nil? ? [] : org.split('|').map { |o| _by_org(org: o, client:, logger:) }
+        org_pks = org_pks.flatten.uniq
+        funder_pks = funder.nil? ? [] : _by_funder(funder: funder, client:, logger:)
+        logger&.debug(
+          message: 'PKs found',
+          details: { owner: owner_pks, org: org_pks, funder: funder_pks }
+        )
 
-        []
+        [owner_pks, org_pks, funder_pks].flatten.uniq
       end
 
       # Find a DMP based on the contents of the incoming JSON
@@ -134,74 +148,68 @@ 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:, 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?
+      # 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?
 
-        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:))
+        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 (the org is the :dmphub_owner_org
-      # on the DMP ID record)
-      def _by_owner_org(owner_org:, client: nil, logger: nil)
+      # Fetch the DMP IDs for the specified organization/institution
+      def _by_org(org:, client: nil, logger: nil)
         regex = /^[a-zA-Z0-9]+$/
-        raise FinderError, MSG_INVALID_OWNER_ID if owner_org.nil? || (owner_org.to_s.downcase =~ regex).nil?
+        id = "#{ROR_DOMAIN}#{org.strip}" unless (org.to_s =~ regex).nil?
+        return [] if id.nil?
+
+        resp = client.get_item(key: { PK: 'AFFILIATION_INDEX', SK: id }, logger:)
+        return [] unless resp.is_a?(Hash)
+
+        logger&.debug(message: "DMPs for AFFILIATION #{id}", details: resp)
+        resp.fetch('dmps', [])
+      end
 
+      # Fetch the DMP IDs for the specified funder
+      def _by_funder(funder:, client: nil, logger: nil)
+        regex = /^[a-zA-Z0-9]+$/
+        id = "#{ROR_DOMAIN}/#{funder.strip}" unless (funder.to_s =~ regex).nil?
+        id = "#{DOI_DOMAIN}#{funder.strip}" if id.nil? && !(funder.to_s =~ Helper::DOI_REGEX).nil?
+        return [] if id.nil?
+
+        resp = client.get_item(key: { PK: 'FUNDER_INDEX', SK: id }, logger:)
+        return [] unless resp.is_a?(Hash)
+
+        logger&.debug(message: "DMPs for FUNDER #{id}", details: resp)
+        resp.fetch('dmps', [])
+      end
+
+      # Fetch the DMP IDs that are marked as featured
+      def _by_featured(client: nil, logger: nil)
         args = {
-          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 }
+          filter_expression: 'featured = :featured AND SK = :sk',
+          expression_attribute_values: { ':sk': 'METADATA', ':featured': 1 }
         }
-        logger.info(message: "Querying _by_owner_org with #{args}") if logger.respond_to?(:info)
+        logger&.debug(message: 'Fetch relevant DMPs _by_featured - scan args', details: args)
         client = Uc3DmpDynamo::Client.new if client.nil?
-        _process_search_response(response: client.query(args:, logger:))
+        _process_search_response(response: client.scan(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:, 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?
-
+      # Return all of the publicly visible DMPs
+      def _publicly_visible(client: nil, logger: nil)
         args = {
-          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 }
+          filter_expression: 'visibility = :visibility AND SK = :sk',
+          expression_attribute_values: { ':sk': 'METADATA', ':visibility': 'public' }
         }
-        logger.info(message: "Querying _by_mod_day with #{args}") if logger.respond_to?(:info)
+        logger&.debug(message: 'Fetch relevant DMPs _publicly_visible - scan args', details: args)
         client = Uc3DmpDynamo::Client.new if client.nil?
-        _process_search_response(response: client.query(args:, logger:))
+        _process_search_response(response: client.scan(args:))
       end
 
       # Transform the search results so that we do not include any of the DMPHub specific metadata
@@ -212,8 +220,6 @@ 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)
         end
         results.compact.uniq
       end

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

@@ -254,8 +254,8 @@ module Uc3DmpId
 
         # Set the :modified timestamps
         now = Time.now.utc
-        version['modified'] = now.iso8601
-        version['dmphub_modification_day'] = now.strftime('%Y-%m-%d')
+        payload['modified'] = now.iso8601
+        payload['dmphub_modification_day'] = now.strftime('%Y-%m-%d')
 
         # Retain all the other attributes on the original version unless they are
         # in the list of exclusions OR the incoming payload already has a value for it

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

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

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

@@ -58,7 +58,7 @@ module Uc3DmpId
 
         # Create the prior version record ()
         client = Uc3DmpDynamo::Client.new if client.nil?
-        prior.delete('dmphub_modifications')
+        prior['dmphub_modifications'] = []
         resp = client.put_item(json: prior, logger:)
         return nil if resp.nil?
 

metadata

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