diff --git a/NEWS.md b/NEWS.md index 7ef2525ff..07d6b90f1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -14,6 +14,7 @@ * Add access types to eholdings/providers/{id}/packages response ([MODKBEKBJ-839](https://folio-org.atlassian.net/browse/MODKBEKBJ-839)) * Sanitize HTML content for the package description field ([MODKBEKBJ-860](https://folio-org.atlassian.net/browse/MODKBEKBJ-860)) * Validate blank package url and remove invalid format checks ([MODKBEKBJ-863](https://folio-org.atlassian.net/browse/MODKBEKBJ-863)) +* Add managed and custom subjects to package detail record ([MODKBEKBJ-853](https://folio-org.atlassian.net/browse/MODKBEKBJ-853)) ### Bug fixes * Fix offset handling when retrieving holdings from HoldingsIQ. ([MODKBEKBJ-825](https://folio-org.atlassian.net/browse/MODKBEKBJ-825)) diff --git a/ramls/examples/packages/packages_packageId_get_200_response.json b/ramls/examples/packages/packages_packageId_get_200_response.json index 2b039efb1..bc1f606ac 100644 --- a/ramls/examples/packages/packages_packageId_get_200_response.json +++ b/ramls/examples/packages/packages_packageId_get_200_response.json @@ -15,6 +15,13 @@ "providerId": 123355, "providerName": "API DEV CORPORATE CUSTOMER", "selectedCount": 0, + "subjects": [ + { + "id": 35408, + "name": "Technology", + "isCustom": false + } + ], "titleCount": 0, "vendorId": 123355, "vendorName": "API DEV CORPORATE CUSTOMER", diff --git a/ramls/types/packages/packageDataAttributes.json b/ramls/types/packages/packageDataAttributes.json index 23276bc8d..423a77b6a 100644 --- a/ramls/types/packages/packageDataAttributes.json +++ b/ramls/types/packages/packageDataAttributes.json @@ -121,6 +121,15 @@ "example": 0, "type": "integer" }, + "subjects": { + "description": "Managed and custom subjects associated with the package. Returned only in the single package response", + "items": { + "$ref": "packageSubject.json", + "type": "object" + }, + "readonly": true, + "type": "array" + }, "tags": { "$ref": "../../raml-util/schemas/tags.schema", "description": "Package tags", diff --git a/ramls/types/packages/packageSubject.json b/ramls/types/packages/packageSubject.json new file mode 100644 index 000000000..892f4cf52 --- /dev/null +++ b/ramls/types/packages/packageSubject.json @@ -0,0 +1,25 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Package Subject Schema", + "description": "Managed or custom subject associated with a package", + "javaType": "org.folio.rest.jaxrs.model.PackageSubject", + "type": "object", + "additionalProperties": false, + "properties": { + "id": { + "description": "Subject id", + "example": 26224, + "type": "integer" + }, + "name": { + "description": "Subject name", + "example": "Science", + "type": "string" + }, + "isCustom": { + "description": "Whether this subject is custom or managed", + "example": false, + "type": "boolean" + } + } +} diff --git a/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java b/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java index 8ae6abd12..2dce13569 100644 --- a/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java +++ b/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java @@ -51,6 +51,8 @@ private PackageDataAttributes convertAttributes(PackageData packageData) { .withProviderName(packageData.getVendorName()) .withProxiedUrl(packageData.getProxiedUrl()) .withSelectedCount(packageData.getSelectedCount()) + // subjects are returned only in the single package response, see PackageConverter + .withSubjects(null) .withTitleCount(packageData.getTitleCount()) .withUrl(packageData.getPackageUrl()) .withVisibility(mapItemsNullable(packageData.getVisibilityDetails(), this::convertVisibility)); diff --git a/src/main/java/org/folio/rest/converter/packages/PackageConverter.java b/src/main/java/org/folio/rest/converter/packages/PackageConverter.java index fffdb06e2..07e922d5c 100644 --- a/src/main/java/org/folio/rest/converter/packages/PackageConverter.java +++ b/src/main/java/org/folio/rest/converter/packages/PackageConverter.java @@ -10,6 +10,7 @@ import java.util.Objects; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.Proxy; +import org.folio.holdingsiq.model.SubjectAssociation; import org.folio.holdingsiq.model.Titles; import org.folio.holdingsiq.model.TokenInfo; import org.folio.holdingsiq.model.VendorById; @@ -20,6 +21,7 @@ import org.folio.rest.jaxrs.model.Package; import org.folio.rest.jaxrs.model.PackageCollectionItem; import org.folio.rest.jaxrs.model.PackageRelationship; +import org.folio.rest.jaxrs.model.PackageSubject; import org.folio.rest.jaxrs.model.Provider; import org.folio.rest.jaxrs.model.ProxyDto; import org.folio.rest.jaxrs.model.RelationshipData; @@ -63,6 +65,7 @@ public Package convert(PackageResult result) { .getAttributes() .withProxy(convertToProxy(packageData.getProxy())) .withPackageToken(tokenInfoConverter.convert(packageData.getPackageToken())) + .withSubjects(convertSubjects(packageData.getSubjectAssociations())) .withTags(result.getTags()); addTitlesRelationship(result, packageResult, packageData); @@ -115,6 +118,26 @@ private void addAccessTypeRelationship(PackageResult result, Package packageData } } + /** + * Custom subjects without explicit assignment are hierarchy placeholders and are not shown on the package record. + */ + private @Nullable List convertSubjects(@Nullable List subjects) { + if (subjects == null) { + return null; + } + return subjects.stream() + .filter(subject -> !Boolean.TRUE.equals(subject.isCustom()) || Boolean.TRUE.equals(subject.explicitAssignment())) + .map(this::convertSubject) + .toList(); + } + + private PackageSubject convertSubject(SubjectAssociation subject) { + return new PackageSubject() + .withId(subject.id()) + .withName(subject.name()) + .withIsCustom(subject.isCustom()); + } + private @Nullable ProxyDto convertToProxy(@Nullable Proxy proxy) { return proxy != null ? new ProxyDto().withId(proxy.getId()).withInherited(proxy.getInherited()) : null; } diff --git a/src/test/java/org/folio/rest/converter/packages/PackageConverterTest.java b/src/test/java/org/folio/rest/converter/packages/PackageConverterTest.java new file mode 100644 index 000000000..6a40c7f12 --- /dev/null +++ b/src/test/java/org/folio/rest/converter/packages/PackageConverterTest.java @@ -0,0 +1,78 @@ +package org.folio.rest.converter.packages; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertNull; + +import java.util.List; +import org.folio.holdingsiq.model.CoverageDates; +import org.folio.holdingsiq.model.PackageData; +import org.folio.holdingsiq.model.SubjectAssociation; +import org.folio.rest.jaxrs.model.Package; +import org.folio.rest.jaxrs.model.PackageSubject; +import org.folio.rmapi.result.PackageResult; +import org.folio.spring.config.TestConfig; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.core.convert.ConversionService; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit.jupiter.SpringExtension; + +@ExtendWith(SpringExtension.class) +@ContextConfiguration(classes = TestConfig.class) +class PackageConverterTest { + + @Autowired + private ConversionService conversionService; + + @Test + void shouldKeepManagedAndExplicitCustomSubjectsAndDropCustomPlaceholders() { + var packageData = packageDataBuilder() + .subjectAssociations(List.of( + new SubjectAssociation(1, 3, "Science", false, false, "Science", null), + new SubjectAssociation(2, 3, "Biology", true, false, "Science -- Biology", 1), + new SubjectAssociation(3, 3, "Genetics", true, true, "Science -- Biology -- Genetics", 2), + new SubjectAssociation(4, 3, "Botany", true, true, "Science -- Botany", 1))) + .build(); + + var subjects = convert(packageData).getData().getAttributes().getSubjects(); + + assertEquals(List.of( + new PackageSubject().withId(1).withName("Science").withIsCustom(false), + new PackageSubject().withId(3).withName("Genetics").withIsCustom(true), + new PackageSubject().withId(4).withName("Botany").withIsCustom(true)), subjects); + } + + @Test + void shouldTreatNullIsCustomAsManaged() { + var packageData = packageDataBuilder() + .subjectAssociations(List.of(new SubjectAssociation(1, 3, "Science", null, null, null, null))) + .build(); + + var subjects = convert(packageData).getData().getAttributes().getSubjects(); + + assertEquals(1, subjects.size()); + } + + @Test + void shouldReturnNullSubjectsWhenNoSubjectAssociations() { + var packageData = packageDataBuilder().build(); + + assertNull(convert(packageData).getData().getAttributes().getSubjects()); + } + + private PackageData.PackageDataBuilder packageDataBuilder() { + return PackageData.builder() + .packageId(1) + .vendorId(2) + .contentType("EJournal") + .customCoverage(CoverageDates.builder().beginCoverage("").endCoverage("").build()); + } + + private Package convert(PackageData packageData) { + var result = conversionService.convert(new PackageResult(packageData), Package.class); + assertNotNull(result); + return result; + } +} diff --git a/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id-with-provider.json b/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id-with-provider.json index 371fe06af..abe077560 100644 --- a/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id-with-provider.json +++ b/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id-with-provider.json @@ -27,6 +27,13 @@ "inherited": true }, "selectedCount": 6, + "subjects": [ + { + "id": 35408, + "name": "Technology", + "isCustom": false + } + ], "tags": { "tagList": [] }, diff --git a/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id.json b/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id.json index 958086721..3778467d5 100644 --- a/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id.json +++ b/src/test/resources/responses/kb-ebsco/packages/expected-package-by-id.json @@ -27,6 +27,13 @@ "inherited": true }, "selectedCount": 6, + "subjects": [ + { + "id": 35408, + "name": "Technology", + "isCustom": false + } + ], "tags": { "tagList": [] }, diff --git a/src/test/resources/responses/rmapi/packages/get-custom-package-by-id-response.json b/src/test/resources/responses/rmapi/packages/get-custom-package-by-id-response.json index 590843736..7a5031d6a 100644 --- a/src/test/resources/responses/rmapi/packages/get-custom-package-by-id-response.json +++ b/src/test/resources/responses/rmapi/packages/get-custom-package-by-id-response.json @@ -14,6 +14,26 @@ } ], "selectedCount": 6, + "subjectAssociations": [ + { + "id": 35408, + "parentId": 35407, + "schemaId": 3, + "name": "Technology", + "isCustom": false, + "subjectHierarchy": "Applied Sciences -- Technology", + "explicitAssignment": true + }, + { + "id": 35410, + "parentId": 35408, + "schemaId": 3, + "name": "Robotics", + "isCustom": true, + "subjectHierarchy": "Applied Sciences -- Technology -- Robotics", + "explicitAssignment": false + } + ], "isTokenNeeded": false, "contentType": "AggregatedFullText", "customCoverage": {