osf:hasOsfAddon supplementary metadata [ENG-6188]

CenterForOpenScience · Oct 18, 2024 · 04d9b87 · 04d9b87
1 parent df1b9f3
commit 04d9b87
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 1 deletion.
diff --git a/osf/metadata/osf_gathering.py b/osf/metadata/osf_gathering.py
@@ -228,15 +228,19 @@ def pls_get_magic_metadata_basket(osf_item) -> gather.Basket:
 OSFMAP_MONTHLY_SUPPLEMENT = {
     OSF.Project: {
         OSF.usage: None,
+        OSF.hasOsfAddon: None,
     },
     OSF.ProjectComponent: {
         OSF.usage: None,
+        OSF.hasOsfAddon: None,
     },
     OSF.Registration: {
         OSF.usage: None,
+        OSF.hasOsfAddon: None,
     },
     OSF.RegistrationComponent: {
         OSF.usage: None,
+        OSF.hasOsfAddon: None,
     },
     OSF.Preprint: {
         OSF.usage: None,
@@ -1116,3 +1120,17 @@ def gather_last_month_usage(focus):
         yield (_usage_report_ref, OSF.viewSessionCount, _usage_report.view_session_count)
         yield (_usage_report_ref, OSF.downloadCount, _usage_report.download_count)
         yield (_usage_report_ref, OSF.downloadSessionCount, _usage_report.download_session_count)
+
+
+@gather.er(OSF.hasOsfAddon)
+def gather_addons(focus):
+    # note: when gravyvalet exists, use `iterate_addons_for_resource`
+    # from osf.external.gravy_valet.request_helpers and get urls like
+    # "https://addons.osf.example/v1/addon-imps/..." instead of a urn
+    for _addon_settings in focus.dbmodel.get_addons():
+        if not _addon_settings.config.added_default:  # skip always-on addons
+            _addon_ref = rdflib.URIRef(f'urn:osf.io/addons/{_addon_settings.short_name}')
+            yield (OSF.hasOsfAddon, _addon_ref)
+            yield (_addon_ref, RDF.type, OSF.AddonImplementation)
+            yield (_addon_ref, DCTERMS.identifier, _addon_settings.short_name)
+            yield (_addon_ref, SKOS.prefLabel, _addon_settings.config.full_name)
diff --git a/osf_tests/metadata/expected_metadata_files/project_monthly_supplement.turtle b/osf_tests/metadata/expected_metadata_files/project_monthly_supplement.turtle
@@ -2,6 +2,7 @@
 @prefix dcterms: <http://purl.org/dc/terms/> .
 @prefix foaf: <http://xmlns.com/foaf/0.1/> .
 @prefix osf: <https://osf.io/vocab/2022/> .
+@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
 @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
 
 <http://localhost:5000/w2ibb> osf:usage [ dcterms:temporal "2123-05"^^xsd:gYearMonth ;

diff --git a/osf_tests/metadata/expected_metadata_files/project_supplement.turtle b/osf_tests/metadata/expected_metadata_files/project_supplement.turtle
@@ -1 +1,9 @@
-# correctly empty (for now)
+@prefix dcterms: <http://purl.org/dc/terms/> .
+@prefix osf: <https://osf.io/vocab/2022/> .
+@prefix skos: <http://www.w3.org/2004/02/skos/core#> .
+
+<http://localhost:5000/w2ibb> osf:hasOsfAddon <urn:osf.io/addons/gitlab> ;
+
+<urn:osf.io/addons/gitlab> a osf:AddonImplementation ;
+    dcterms:identifier "gitlab" ;
+    skos:prefLabel "GitLab" .
diff --git a/osf_tests/metadata/test_osf_gathering.py b/osf_tests/metadata/test_osf_gathering.py
@@ -55,6 +55,8 @@ def setUpTestData(cls):
         )
         # project (with components):
         cls.project = factories.ProjectFactory(creator=cls.user__admin, is_public=True)
+        cls.project.add_addon('box', auth=None)
+        cls.project.add_addon('gitlab', auth=None)
         cls.project.add_contributor(cls.user__readwrite, permissions=permissions.WRITE)
         cls.project.add_contributor(cls.user__readonly, permissions=permissions.READ, visible=False)
         cls.component = factories.ProjectFactory(parent=cls.project, creator=cls.user__admin, is_public=True)
@@ -786,3 +788,20 @@ def test_gather_last_month_usage(self):
                 (_usage_bnode, OSF.downloadCount, Literal(43)),
                 (_usage_bnode, OSF.downloadSessionCount, Literal(11)),
             })
+
+    def test_gather_addons(self):
+        # registration (without non-default addon)
+        assert_triples(osf_gathering.gather_addons(self.registrationfocus), set())
+        # project (with non-default addons)
+        _box_ref = rdflib.URIRef('urn:osf.io/addons/box')
+        _gitlab_ref = rdflib.URIRef('urn:osf.io/addons/gitlab')
+        assert_triples(osf_gathering.gather_addons(self.projectfocus), {
+            (self.projectfocus.iri, OSF.hasOsfAddon, _box_ref),
+            (_box_ref, RDF.type, OSF.AddonImplementation),
+            (_box_ref, DCTERMS.identifier, Literal('box')),
+            (_box_ref, SKOS.prefLabel, Literal('Box')),
+            (self.projectfocus.iri, OSF.hasOsfAddon, _gitlab_ref),
+            (_gitlab_ref, RDF.type, OSF.AddonImplementation),
+            (_gitlab_ref, DCTERMS.identifier, Literal('gitlab')),
+            (_gitlab_ref, SKOS.prefLabel, Literal('GitLab')),
+        })
diff --git a/osf_tests/metadata/test_serialized_metadata.py b/osf_tests/metadata/test_serialized_metadata.py
@@ -199,6 +199,7 @@ def setUp(self):
             category='doi',
             value=f'10.70102/FK2osf.io/{self.project._id}',
         )
+        self.project.add_addon('gitlab', auth=None)
         self.file = create_test_file(
             self.project,
             self.user,