diff --git a/NEWS.md b/NEWS.md index 4cb91cc13..d8bc54c7f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -8,6 +8,10 @@ ### Features * Migrate Package Endpoints to HoldingsIQ v2 API ([MODKBEKBJ-804](https://folio-org.atlassian.net/browse/MODKBEKBJ-804)) +* Migrate Title and Resource Endpoints to HoldingsIQ v2 API ([MODKBEKBJ-830](https://folio-org.atlassian.net/browse/MODKBEKBJ-830)) +* Add filter[zdbid] and filter[access] to titles and package resources search ([MODKBEKBJ-834](https://folio-org.atlassian.net/browse/MODKBEKBJ-834)) +* Add visibility per category, packageType, isPrimaryPackage and isOrderedThroughEbsco to resources ([MODKBEKBJ-831](https://folio-org.atlassian.net/browse/MODKBEKBJ-831)) +* Support updating resource visibility per category (PF, FTF, MARC) with `visibility`, `visibilityData` remains as a fallback applied to all categories ([MODKBEKBJ-831](https://folio-org.atlassian.net/browse/MODKBEKBJ-831)) * Add additional fields to POST /eholdings/packages endpoint ([MODKBEKBJ-823](https://folio-org.atlassian.net/browse/MODKBEKBJ-823)) * Update visibility hidden reason handling ([MODKBEKBJ-823](https://folio-org.atlassian.net/browse/MODKBEKBJ-823)) * Remove HTML validation for package's custom display name field ([MODKBEKBJ-855](https://folio-org.atlassian.net/browse/MODKBEKBJ-855)) diff --git a/ramls/examples/resources/resources_resourceId_get_200_response.json b/ramls/examples/resources/resources_resourceId_get_200_response.json index 54d0d31f9..5b010433a 100644 --- a/ramls/examples/resources/resources_resourceId_get_200_response.json +++ b/ramls/examples/resources/resources_resourceId_get_200_response.json @@ -55,7 +55,10 @@ "embargoValue": 7 }, "isPackageCustom": false, + "packageType": "Variable", + "isPrimaryPackage": false, "isSelected": true, + "isOrderedThroughEbsco": false, "isTokenNeeded": true, "locationId": 17545807, "managedEmbargoPeriod": { @@ -71,6 +74,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "" + }, + { + "category": "FTF", + "hidden": true, + "reason": "" + }, + { + "category": "MARC", + "hidden": true, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2010-01-01", diff --git a/ramls/examples/titles/titles_titleId_get_200_response.json b/ramls/examples/titles/titles_titleId_get_200_response.json index 63dc4bb55..6e14c3b85 100644 --- a/ramls/examples/titles/titles_titleId_get_200_response.json +++ b/ramls/examples/titles/titles_titleId_get_200_response.json @@ -21,6 +21,21 @@ "subject": "Social Services", "type": "TLI" } + ], + "titleRelationships": [ + { + "id": 42, + "type": "CONTINUED_BY", + "date": "2020-01-01T00:00:00Z", + "source": { + "titleId": 100130, + "name": "A call to action: Changing the culture of drinking at U.S. colleges" + }, + "target": { + "titleId": 4444, + "name": "Continued Title" + } + } ] }, "id": "100130", diff --git a/ramls/packages.raml b/ramls/packages.raml index cc35b438c..be3e97a52 100644 --- a/ramls/packages.raml +++ b/ramls/packages.raml @@ -10,14 +10,14 @@ documentation: content: Implements the eholdings interface using EBSCO KB as backend. traits: - queriable: !include traits/queriable.raml - packageQueriable: !include traits/packageQueriable.raml + queryable: !include traits/packagesQueryable.raml sortable: !include traits/sortable.raml pageable: !include traits/pageable.raml - packageFilterable: !include traits/packageFilterable.raml + packagesFilterable: !include traits/packagesFilterable.raml taggable: !include traits/taggable.raml accessible: !include traits/accessible.raml - packageResourcesFilterable: !include traits/packageResourcesFilterable.raml + resourcesQueryable: !include traits/resourcesQueryable.raml + resourcesFilterable: !include traits/resourcesFilterable.raml types: packageCollection: !include types/packages/packageCollection.json @@ -35,7 +35,7 @@ types: displayName: Packages get: description: Retrieve a collection of packages based on the search query. - is: [packageQueriable, packageFilterable, taggable, accessible, + is: [queryable, packagesFilterable, taggable, accessible, sortable: {defaultValue: 'relevance', possibleValues: 'name, relevance'}, pageable: {maxCountValue: 100, defaultCountValue: 25}] queryParameters: @@ -237,7 +237,7 @@ types: /resources: get: description: Include all resources belonging to a specific package - is: [taggable, accessible, packageResourcesFilterable, + is: [taggable, accessible, resourcesQueryable, resourcesFilterable, sortable: {defaultValue: 'relevance', possibleValues: 'name, relevance'}, pageable: {maxCountValue: 100, defaultCountValue: 25}] responses: diff --git a/ramls/providers.raml b/ramls/providers.raml index 4f7b4d012..06a7f8a61 100644 --- a/ramls/providers.raml +++ b/ramls/providers.raml @@ -19,11 +19,10 @@ types: jsonapiError: !include types/jsonapiError.json traits: - queriable: !include traits/queriable.raml sortable: !include traits/sortable.raml pageable: !include traits/pageable.raml - packageFilterable: !include traits/packageFilterable.raml - packageQueriable: !include traits/packageQueriable.raml + packagesFilterable: !include traits/packagesFilterable.raml + packagesQueryable: !include traits/packagesQueryable.raml taggable: !include traits/taggable.raml accessible: !include traits/accessible.raml includable: !include traits/includePackages.raml @@ -33,9 +32,16 @@ traits: description: Collection of available providers in eholdings. get: description: Get a list of providers based on the search query. - is: [queriable, taggable, + is: [taggable, sortable: {defaultValue: 'relevance', possibleValues: 'name, relevance'}, pageable: {maxCountValue: 100, defaultCountValue: 25}] + queryParameters: + q: + displayName: Search query + type: string + description: String used to search to retrieve a collection + example: ABC-CLIO + required: false responses: 200: description: OK @@ -129,7 +135,7 @@ traits: /packages: get: description: Search within a list of packages associated with a given provider. - is: [packageQueriable, taggable, accessible, packageFilterable, + is: [packagesQueryable, taggable, accessible, packagesFilterable, sortable: {defaultValue: 'relevance', possibleValues: 'name, relevance'}, pageable: {maxCountValue: 100, defaultCountValue: 25}] queryParameters: diff --git a/ramls/resources.raml b/ramls/resources.raml index fa580cf06..57a0a5d52 100644 --- a/ramls/resources.raml +++ b/ramls/resources.raml @@ -85,11 +85,12 @@ types: displayName: Nested provider, package or title type: string description: | - Include provider, package or title in response + Comma-separated list of what to include in response Possible values are - provider - package - title + - relationships (title relationships in the resource attributes) example: provider required: false responses: diff --git a/ramls/titles.raml b/ramls/titles.raml index 4b01f5b7b..881fdcf15 100644 --- a/ramls/titles.raml +++ b/ramls/titles.raml @@ -5,6 +5,7 @@ version: v1 mediaType: "application/vnd.api+json" traits: + queryable: !include traits/titlesQueryable.raml sortable: !include traits/sortable.raml pageable: !include traits/pageable.raml filterable: !include traits/titlesFilterable.raml @@ -24,7 +25,7 @@ types: description: Collection of available titles in eholdings. get: description: Get a set of titles matching the given search criteria. - is: [taggable, accessible, filterable, includable, + is: [queryable, taggable, accessible, filterable, includable, sortable: {defaultValue: 'relevance', possibleValues: 'name, relevance'}, pageable: {maxCountValue: 100, defaultCountValue: 25}] responses: diff --git a/ramls/traits/includeResources.raml b/ramls/traits/includeResources.raml index 0f6bfc50b..bc9cb4fe3 100644 --- a/ramls/traits/includeResources.raml +++ b/ramls/traits/includeResources.raml @@ -3,7 +3,9 @@ queryParameters: displayName: Related Resources type: string description: | - Include related resource objects, each representing a partnering of this title with a package. + Comma-separated list of what to include: + `resources` - related resource objects, each representing a partnering of this title with a package; + `relationships` - title relationships (single title only). Any bogus value, like `include=deciduousTrees`, will be silently ignored. example: resources required: false diff --git a/ramls/traits/packageFilterable.raml b/ramls/traits/packagesFilterable.raml similarity index 100% rename from ramls/traits/packageFilterable.raml rename to ramls/traits/packagesFilterable.raml diff --git a/ramls/traits/packageQueriable.raml b/ramls/traits/packagesQueryable.raml similarity index 100% rename from ramls/traits/packageQueriable.raml rename to ramls/traits/packagesQueryable.raml diff --git a/ramls/traits/queriable.raml b/ramls/traits/queriable.raml deleted file mode 100644 index 7b2bfb5ef..000000000 --- a/ramls/traits/queriable.raml +++ /dev/null @@ -1,7 +0,0 @@ -queryParameters: - q: - displayName: Search query - type: string - description: String used to search to retrieve a collection - example: ABC-CLIO - required: false diff --git a/ramls/traits/packageResourcesFilterable.raml b/ramls/traits/resourcesFilterable.raml similarity index 86% rename from ramls/traits/packageResourcesFilterable.raml rename to ramls/traits/resourcesFilterable.raml index a6b3fa975..7b6d25fb9 100644 --- a/ramls/traits/packageResourcesFilterable.raml +++ b/ramls/traits/resourcesFilterable.raml @@ -12,6 +12,14 @@ queryParameters: Filter to narrow down results based on content type. Possible values are all, audiobook, book, bookseries, database, journal, newsletter, newspaper, proceedings, report, streamingaudio, streamingvideo,thesisdissertation, website, unspecified. required: false + filter[access]: + displayName: Package access + type: string + description: | + Limits the results based on Package Free Access. + Possible values: public, controlled + example: public + required: false filter[name]: displayName: Query by Title Name type: string @@ -35,4 +43,4 @@ queryParameters: type: string description: String to search publishers to get a collection of titles example: academic - required: false + required: false \ No newline at end of file diff --git a/ramls/traits/resourcesQueryable.raml b/ramls/traits/resourcesQueryable.raml new file mode 100644 index 000000000..c21cff9f6 --- /dev/null +++ b/ramls/traits/resourcesQueryable.raml @@ -0,0 +1,18 @@ +queryParameters: + q: + displayName: Search query + type: string + description: String used to search to retrieve a collection + example: ABC-CLIO + required: false + q[field]: + displayName: Search field + type: string + description: | + Field to search. + name - Searches on Title Names. + publisher - Searches on Title Publishers. + subject - Searches on Title Subjects. + isxn - Searches on Title ISxNs. + zdbid - Searches on Title ZBD IDs. + default: name \ No newline at end of file diff --git a/ramls/traits/titlesFilterable.raml b/ramls/traits/titlesFilterable.raml index 8b6bb6f2d..4f240405e 100644 --- a/ramls/traits/titlesFilterable.raml +++ b/ramls/traits/titlesFilterable.raml @@ -36,6 +36,14 @@ queryParameters: description: String to search publishers to get a collection of titles example: academic required: false + filter[access]: + displayName: Package access + type: string + description: | + Limits the results based on Package Free Access. + Possible values: public, controlled + example: public + required: false filter[packageIds]: displayName: Query by package Ids type: string[] diff --git a/ramls/traits/titlesQueryable.raml b/ramls/traits/titlesQueryable.raml new file mode 100644 index 000000000..6065f6884 --- /dev/null +++ b/ramls/traits/titlesQueryable.raml @@ -0,0 +1,23 @@ +queryParameters: + q: + displayName: Search query + type: string + description: String used to search to retrieve a collection. Not needed when filter[tags] or filter[access-type] is used. + example: ABC-CLIO + q[field]: + displayName: Search field + type: string + description: | + Field to search. + name - Searches on Title Names. + publisher - Searches on Title Publishers. + subject - Searches on Title Subjects. + isxn - Searches on Title ISxNs. + zdbid - Searches on Title ZBD IDs. + default: name + q[type]: + displayName: Search type + type: string + description: | + Type of search to be performed. + Possible values: exactphrase, advanced, any, contains, exactmatch, beginswith, proximity \ No newline at end of file diff --git a/ramls/types/packages/packageDataAttributes.json b/ramls/types/packages/packageDataAttributes.json index 423a77b6a..7a263193f 100644 --- a/ramls/types/packages/packageDataAttributes.json +++ b/ramls/types/packages/packageDataAttributes.json @@ -147,7 +147,7 @@ "visibility": { "description": "Visibility details", "items": { - "$ref": "packageVisibility.json", + "$ref": "../visibility.json", "type": "object" }, "type": "array" diff --git a/ramls/types/packages/packagePutDataAttributes.json b/ramls/types/packages/packagePutDataAttributes.json index 78eaa942f..711e3a7ab 100644 --- a/ramls/types/packages/packagePutDataAttributes.json +++ b/ramls/types/packages/packagePutDataAttributes.json @@ -87,7 +87,7 @@ "visibility": { "description": "Visibility details", "items": { - "$ref": "packageVisibility.json", + "$ref": "../visibility.json", "type": "object" }, "type": "array" diff --git a/ramls/types/resources/resourceDataAttributes.json b/ramls/types/resources/resourceDataAttributes.json index 2869e0729..544bf108f 100644 --- a/ramls/types/resources/resourceDataAttributes.json +++ b/ramls/types/resources/resourceDataAttributes.json @@ -99,11 +99,29 @@ "description": "Defines if package is custom", "example": false }, + "packageType": { + "type": "string", + "readonly": true, + "description": "Package type", + "example": "Complete" + }, + "isPrimaryPackage": { + "type": "boolean", + "readonly": true, + "description": "Defines if the package is the primary package of the provider", + "example": false + }, "isSelected": { "type": "boolean", "description": "Defines if this item is selected. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.", "example": false }, + "isOrderedThroughEbsco": { + "type": "boolean", + "readonly": true, + "description": "Defines if the resource is ordered through EBSCO", + "example": false + }, "titleHasSelectedResources": { "type": "boolean", "description": "Indicates if the title that contains this resource has selected resources", @@ -115,6 +133,12 @@ "description": "Defines if token is needed", "example": false }, + "customCoverageOwnership": { + "type": "string", + "readonly": true, + "description": "Custom coverage ownership of the resource", + "example": "customer" + }, "locationId": { "type": "integer", "readonly": true, @@ -161,6 +185,15 @@ "description": "Visibility data. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.", "$ref": "../visibilityData.json" }, + "visibility": { + "type": "array", + "readonly": true, + "description": "Visibility per category (PF, FTF, MARC). visibilityData is hidden when at least one category is hidden", + "items": { + "type": "object", + "$ref": "../visibility.json" + } + }, "managedCoverages": { "type": "array", "readonly": true, @@ -214,6 +247,15 @@ "type": "string", "description": "User defined field 5", "maxLength": 100 + }, + "titleRelationships": { + "type": "array", + "description": "Title relationships. Returned only when requested with include=relationships", + "items": { + "type": "object", + "$ref": "../titles/titleRelationship.json" + }, + "readonly": true } } } diff --git a/ramls/types/resources/resourcePutDataAttributes.json b/ramls/types/resources/resourcePutDataAttributes.json index 79080dd5e..5a2b1f3d5 100644 --- a/ramls/types/resources/resourcePutDataAttributes.json +++ b/ramls/types/resources/resourcePutDataAttributes.json @@ -88,9 +88,17 @@ }, "visibilityData": { "type": "object", - "description": "Visibility data. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.", + "description": "Visibility data applied to all categories (PF, FTF, MARC). Ignored when visibility is set. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.", "$ref": "../visibilityData.json" }, + "visibility": { + "type": "array", + "description": "Visibility per category (PF, FTF, MARC); only the sent categories are changed. Takes precedence over visibilityData. Note that this attribute can be updated both for CUSTOM AND MANAGED RESOURCES.", + "items": { + "type": "object", + "$ref": "../visibility.json" + } + }, "managedCoverages": { "type": "array", "readonly": true, diff --git a/ramls/types/titles/relatedTitle.json b/ramls/types/titles/relatedTitle.json new file mode 100644 index 000000000..eff769576 --- /dev/null +++ b/ramls/types/titles/relatedTitle.json @@ -0,0 +1,20 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Related Title Schema", + "description": "Title referenced by a title relationship", + "type": "object", + "javaType": "org.folio.rest.jaxrs.model.RelatedTitle", + "additionalProperties": false, + "properties": { + "titleId": { + "type": "integer", + "description": "Title id", + "example": 4444 + }, + "name": { + "type": "string", + "description": "Title name", + "example": "A Tale of Two Cities (continued)" + } + } +} diff --git a/ramls/types/titles/titleData.json b/ramls/types/titles/titleData.json index 1cd0d0984..8ff04aafc 100644 --- a/ramls/types/titles/titleData.json +++ b/ramls/types/titles/titleData.json @@ -85,6 +85,14 @@ "type": "object", "description": "Title tags", "$ref": "../../raml-util/schemas/tags.schema" + }, + "titleRelationships": { + "type": "array", + "description": "Title relationships. Returned only when requested with include=relationships", + "items": { + "type": "object", + "$ref": "titleRelationship.json" + } } }, "required": [ @@ -92,5 +100,3 @@ "publicationType" ] } - - diff --git a/ramls/types/titles/titleRelationship.json b/ramls/types/titles/titleRelationship.json new file mode 100644 index 000000000..3426d3946 --- /dev/null +++ b/ramls/types/titles/titleRelationship.json @@ -0,0 +1,35 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "title": "Title Relationship Schema", + "description": "Relationship between two titles", + "type": "object", + "javaType": "org.folio.rest.jaxrs.model.TitleRelationship", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Relationship id", + "example": 42 + }, + "type": { + "type": "string", + "description": "Relationship type, e.g. ABSORBED_BY, CONTINUED_BY, PARENT_OF", + "example": "CONTINUED_BY" + }, + "date": { + "type": "string", + "description": "Relationship date in ISO-8601 format", + "example": "2020-01-01T00:00:00Z" + }, + "source": { + "type": "object", + "description": "Title the relationship starts from", + "$ref": "relatedTitle.json" + }, + "target": { + "type": "object", + "description": "Title the relationship points to", + "$ref": "relatedTitle.json" + } + } +} diff --git a/ramls/types/packages/packageVisibility.json b/ramls/types/visibility.json similarity index 76% rename from ramls/types/packages/packageVisibility.json rename to ramls/types/visibility.json index a33e5d7fa..7b3ecfdc9 100644 --- a/ramls/types/packages/packageVisibility.json +++ b/ramls/types/visibility.json @@ -1,8 +1,8 @@ { "$schema": "http://json-schema.org/draft-04/schema#", - "title": "Visibility details schema", - "description": "Visibility details schema", - "javaType": "org.folio.rest.jaxrs.model.PackageVisibility", + "title": "Visibility Schema", + "description": "Visibility of a package or resource in one category", + "javaType": "org.folio.rest.jaxrs.model.Visibility", "type": "object", "additionalProperties": false, "properties": { diff --git a/src/main/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverter.java b/src/main/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverter.java new file mode 100644 index 000000000..c0df8bd59 --- /dev/null +++ b/src/main/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverter.java @@ -0,0 +1,30 @@ +package org.folio.rest.converter.common.attr; + +import java.util.List; +import org.folio.holdingsiq.model.Visibility; +import org.folio.rest.jaxrs.model.VisibilityData; +import org.springframework.core.convert.converter.Converter; +import org.springframework.stereotype.Component; + +/** + * Converts the per-category visibility of HoldingsIQ to the single visibility flag of the eHoldings API: + * the resource is hidden when it is hidden in at least one category, and visible when it is visible in all of them. + */ +@Component +public class ResourceVisibilityConverter implements Converter, VisibilityData> { + + private static final String HIDDEN_BY_EP_REASON = "Hidden by EP"; + private static final String SET_BY_SYSTEM_REASON = "Set by system"; + + @Override + public VisibilityData convert(List visibilityDetails) { + var hiddenCategory = visibilityDetails.stream() + .filter(Visibility::hidden) + .findFirst(); + return new VisibilityData() + .withIsHidden(hiddenCategory.isPresent()) + .withReason(hiddenCategory + .map(visibility -> HIDDEN_BY_EP_REASON.equals(visibility.reason()) ? SET_BY_SYSTEM_REASON : "") + .orElse("")); + } +} diff --git a/src/main/java/org/folio/rest/converter/common/attr/VisibilityDetailsMapper.java b/src/main/java/org/folio/rest/converter/common/attr/VisibilityDetailsMapper.java new file mode 100644 index 000000000..f65098bba --- /dev/null +++ b/src/main/java/org/folio/rest/converter/common/attr/VisibilityDetailsMapper.java @@ -0,0 +1,19 @@ +package org.folio.rest.converter.common.attr; + +import org.folio.rest.jaxrs.model.Visibility; + +/** + * Maps the per-category visibility of HoldingsIQ to the eHoldings API visibility of packages and resources. + */ +public final class VisibilityDetailsMapper { + + private VisibilityDetailsMapper() { + } + + public static Visibility toApiVisibility(org.folio.holdingsiq.model.Visibility visibility) { + return new Visibility() + .withCategory(Visibility.Category.fromValue(visibility.category().toUpperCase())) + .withHidden(visibility.hidden()) + .withReason(visibility.reason()); + } +} diff --git a/src/main/java/org/folio/rest/converter/common/attr/VisibilityInfoConverter.java b/src/main/java/org/folio/rest/converter/common/attr/VisibilityInfoConverter.java deleted file mode 100644 index b4a70b92b..000000000 --- a/src/main/java/org/folio/rest/converter/common/attr/VisibilityInfoConverter.java +++ /dev/null @@ -1,23 +0,0 @@ -package org.folio.rest.converter.common.attr; - -import java.util.Objects; -import org.folio.holdingsiq.model.VisibilityInfo; -import org.folio.rest.jaxrs.model.VisibilityData; -import org.jspecify.annotations.Nullable; -import org.springframework.core.convert.converter.Converter; -import org.springframework.stereotype.Component; - -@Component -public class VisibilityInfoConverter implements Converter { - - @Override - public VisibilityData convert(@Nullable VisibilityInfo visibilityData) { - if (Objects.isNull(visibilityData)) { - return null; - } - org.folio.rest.jaxrs.model.VisibilityData visibility = new org.folio.rest.jaxrs.model.VisibilityData(); - visibility.setIsHidden(visibilityData.getIsHidden()); - visibility.setReason(visibilityData.getReason().equals("Hidden by EP") ? "Set by system" : ""); - return visibility; - } -} diff --git a/src/main/java/org/folio/rest/converter/packages/CommonPackagePutRequestConverter.java b/src/main/java/org/folio/rest/converter/packages/CommonPackagePutRequestConverter.java index 87ee71063..1ebc6c1a9 100644 --- a/src/main/java/org/folio/rest/converter/packages/CommonPackagePutRequestConverter.java +++ b/src/main/java/org/folio/rest/converter/packages/CommonPackagePutRequestConverter.java @@ -9,7 +9,6 @@ import org.folio.holdingsiq.model.Proxy; import org.folio.holdingsiq.model.Visibility; import org.folio.rest.jaxrs.model.PackagePutDataAttributes; -import org.folio.rest.jaxrs.model.PackageVisibility; import org.folio.service.sanitizer.Sanitizer; public abstract class CommonPackagePutRequestConverter { @@ -44,7 +43,7 @@ protected PackagePut.PackagePutBuilder convertCommonAttributes(PackagePutDataAtt return builder; } - protected Visibility convertVisibility(PackageVisibility pv) { + protected Visibility convertVisibility(org.folio.rest.jaxrs.model.Visibility pv) { var reason = Boolean.TRUE.equals(pv.getHidden()) ? HIDDEN_BY_CUSTOMER : null; return new Visibility(pv.getCategory().value(), pv.getHidden(), reason); } 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 2dce13569..f8426eb8a 100644 --- a/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java +++ b/src/main/java/org/folio/rest/converter/packages/PackageCollectionItemConverter.java @@ -7,12 +7,11 @@ import org.folio.holdingsiq.model.AlternateName; import org.folio.holdingsiq.model.PackageData; -import org.folio.holdingsiq.model.Visibility; +import org.folio.rest.converter.common.attr.VisibilityDetailsMapper; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.PackageAltName; import org.folio.rest.jaxrs.model.PackageCollectionItem; import org.folio.rest.jaxrs.model.PackageDataAttributes; -import org.folio.rest.jaxrs.model.PackageVisibility; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @@ -55,14 +54,7 @@ private PackageDataAttributes convertAttributes(PackageData packageData) { .withSubjects(null) .withTitleCount(packageData.getTitleCount()) .withUrl(packageData.getPackageUrl()) - .withVisibility(mapItemsNullable(packageData.getVisibilityDetails(), this::convertVisibility)); - } - - private PackageVisibility convertVisibility(Visibility visibility) { - return new PackageVisibility() - .withCategory(PackageVisibility.Category.fromValue(visibility.category().toUpperCase())) - .withHidden(visibility.hidden()) - .withReason(visibility.reason()); + .withVisibility(mapItemsNullable(packageData.getVisibilityDetails(), VisibilityDetailsMapper::toApiVisibility)); } private Coverage convertCustomCoverage(PackageData packageData) { 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 07e922d5c..2eb0dc871 100644 --- a/src/main/java/org/folio/rest/converter/packages/PackageConverter.java +++ b/src/main/java/org/folio/rest/converter/packages/PackageConverter.java @@ -10,8 +10,8 @@ import java.util.Objects; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.Proxy; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.model.SubjectAssociation; -import org.folio.holdingsiq.model.Titles; import org.folio.holdingsiq.model.TokenInfo; import org.folio.holdingsiq.model.VendorById; import org.folio.rest.jaxrs.model.AccessType; @@ -38,12 +38,12 @@ public class PackageConverter implements Converter { private final Converter packageCollectionItemConverter; private final Converter vendorConverter; - private final Converter resourcesConverter; + private final Converter resourcesConverter; private final Converter tokenInfoConverter; public PackageConverter(Converter packageCollectionItemConverter, Converter vendorConverter, - Converter resourcesConverter, + Converter resourcesConverter, Converter tokenInfoConverter) { this.packageCollectionItemConverter = packageCollectionItemConverter; this.vendorConverter = vendorConverter; @@ -75,18 +75,18 @@ public Package convert(PackageResult result) { } private void addTitlesRelationship(PackageResult result, Package packageDto, PackageData packageData) { - Titles titles = result.getTitles(); - if (titles != null) { + var resources = result.getResources(); + if (resources != null) { packageDto.getData() .withRelationships(new PackageRelationship() .withResources(new HasManyRelationship() .withMeta(new MetaDataIncluded() .withIncluded(true)) - .withData(convertResourcesRelationship(packageData, titles)))); + .withData(convertResourcesRelationship(packageData, resources)))); packageDto .getIncluded() - .addAll(Objects.requireNonNull(resourcesConverter.convert(titles)).getData()); + .addAll(Objects.requireNonNull(resourcesConverter.convert(resources)).getData()); } } @@ -142,10 +142,10 @@ private PackageSubject convertSubject(SubjectAssociation subject) { return proxy != null ? new ProxyDto().withId(proxy.getId()).withInherited(proxy.getInherited()) : null; } - private List convertResourcesRelationship(PackageData packageData, Titles titles) { - return mapItems(titles.getTitleList(), - title -> new RelationshipData() - .withId(packageData.getVendorId() + "-" + packageData.getPackageId() + "-" + title.getTitleId()) + private List convertResourcesRelationship(PackageData packageData, Resources resources) { + return mapItems(resources.getTitles(), + resource -> new RelationshipData() + .withId(packageData.getVendorId() + "-" + packageData.getPackageId() + "-" + resource.getTitleId()) .withType(RESOURCES_TYPE)); } } diff --git a/src/main/java/org/folio/rest/converter/resources/CommonResourceConverter.java b/src/main/java/org/folio/rest/converter/resources/CommonResourceConverter.java index eb8465a50..d5b60c370 100644 --- a/src/main/java/org/folio/rest/converter/resources/CommonResourceConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/CommonResourceConverter.java @@ -1,19 +1,22 @@ package org.folio.rest.converter.resources; +import static org.folio.common.ListUtils.mapItemsNullable; + import java.util.Collections; import java.util.Comparator; import java.util.List; import java.util.Objects; import org.folio.holdingsiq.model.Contributor; import org.folio.holdingsiq.model.CoverageDates; -import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.EmbargoPeriod; import org.folio.holdingsiq.model.Identifier; import org.folio.holdingsiq.model.ProxyUrl; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.Subject; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.VisibilityInfo; +import org.folio.holdingsiq.model.Visibility; import org.folio.rest.converter.common.ConverterConsts; +import org.folio.rest.converter.common.attr.VisibilityDetailsMapper; +import org.folio.rest.converter.titles.TitleRelationshipMapper; import org.folio.rest.jaxrs.model.AlternateTitle; import org.folio.rest.jaxrs.model.Contributors; import org.folio.rest.jaxrs.model.Coverage; @@ -32,7 +35,7 @@ public class CommonResourceConverter { private final Converter, List> identifiersConverter; private final Converter, List> subjectsConverter; private final Converter embargoPeriodConverter; - private final Converter visibilityInfoConverter; + private final Converter, VisibilityData> visibilityConverter; private final Converter, List> coverageDatesConverter; private final Converter, List> alternateTitleConverter; @@ -42,39 +45,43 @@ public CommonResourceConverter( Converter, List> identifiersConverter, Converter, List> subjectsConverter, Converter embargoPeriodConverter, - Converter visibilityInfoConverter, + Converter, VisibilityData> visibilityConverter, Converter, List> coverageDatesConverter, Converter, List> alternateTitleConverter) { this.contributorsConverter = contributorsConverter; this.identifiersConverter = identifiersConverter; this.subjectsConverter = subjectsConverter; this.embargoPeriodConverter = embargoPeriodConverter; - this.visibilityInfoConverter = visibilityInfoConverter; + this.visibilityConverter = visibilityConverter; this.coverageDatesConverter = coverageDatesConverter; this.alternateTitleConverter = alternateTitleConverter; } @SuppressWarnings("checkstyle:MethodLength") - public ResourceDataAttributes createResourceDataAttributes(Title title, CustomerResources resource) { + public ResourceDataAttributes createResourceDataAttributes(Resource resource) { return new ResourceDataAttributes() - .withAlternateTitles(alternateTitleConverter.convert(Objects.requireNonNullElse(title.getAlternateTitleList(), + .withAlternateTitles(alternateTitleConverter.convert(Objects.requireNonNullElse(resource.getAlternateTitleList(), Collections.emptyList()))) - .withDescription(title.getDescription()) - .withEdition(title.getEdition()) - .withIsPeerReviewed(title.getIsPeerReviewed()) - .withIsTitleCustom(title.getIsTitleCustom()) - .withPublisherName(title.getPublisherName()) - .withTitleId(title.getTitleId()) - .withContributors(contributorsConverter.convert(title.getContributorsList())) - .withIdentifiers(identifiersConverter.convert(title.getIdentifiersList())) - .withName(title.getTitleName()) - .withPublicationType(ConverterConsts.PUBLICATION_TYPES.get(title.getPubType().toLowerCase())) - .withSubjects(subjectsConverter.convert(title.getSubjectsList())) + .withDescription(resource.getDescription()) + .withEdition(resource.getEdition()) + .withIsPeerReviewed(resource.getIsPeerReviewed()) + .withIsTitleCustom(resource.getIsTitleCustom()) + .withPublisherName(resource.getPublisherName()) + .withTitleId(resource.getTitleId()) + .withContributors(contributorsConverter.convert(resource.getContributorsList())) + .withIdentifiers(identifiersConverter.convert(resource.getIdentifiersList())) + .withName(resource.getTitleName()) + .withPublicationType(ConverterConsts.PUBLICATION_TYPES.get(resource.getPubType().toLowerCase())) + .withSubjects(subjectsConverter.convert(resource.getSubjectsList())) .withCoverageStatement(resource.getCoverageStatement()) .withCustomEmbargoPeriod(embargoPeriodConverter.convert(resource.getCustomEmbargoPeriod())) .withIsPackageCustom(resource.getIsPackageCustom()) + .withPackageType(resource.getPackageType()) + .withIsPrimaryPackage(resource.getIsPrimaryPackage()) .withIsSelected(resource.getIsSelected()) + .withIsOrderedThroughEbsco(resource.getIsOrderedThroughEbsco()) .withIsTokenNeeded(resource.getIsTokenNeeded()) + .withCustomCoverageOwnership(resource.getCustomCoverageOwnership()) .withLocationId(resource.getLocationId()) .withManagedEmbargoPeriod(embargoPeriodConverter.convert(resource.getManagedEmbargoPeriod())) .withPackageId(resource.getVendorId() + "-" + resource.getPackageId()) @@ -82,7 +89,8 @@ public ResourceDataAttributes createResourceDataAttributes(Title title, Customer .withUrl(resource.getUrl()) .withProviderId(resource.getVendorId()) .withProviderName(resource.getVendorName()) - .withVisibilityData(visibilityInfoConverter.convert(resource.getVisibilityData())) + .withVisibilityData(visibilityConverter.convert(resource.getVisibilityDetails())) + .withVisibility(mapItemsNullable(resource.getVisibilityDetails(), VisibilityDetailsMapper::toApiVisibility)) .withManagedCoverages(coverageDatesConverter.convert(resource.getManagedCoverageList())) .withCustomCoverages(coverageDatesConverter.convert( resource.getCustomCoverageList().stream() @@ -93,7 +101,8 @@ public ResourceDataAttributes createResourceDataAttributes(Title title, Customer .withUserDefinedField2(resource.getUserDefinedFields().getUserDefinedField2()) .withUserDefinedField3(resource.getUserDefinedFields().getUserDefinedField3()) .withUserDefinedField4(resource.getUserDefinedFields().getUserDefinedField4()) - .withUserDefinedField5(resource.getUserDefinedFields().getUserDefinedField5()); + .withUserDefinedField5(resource.getUserDefinedFields().getUserDefinedField5()) + .withTitleRelationships(TitleRelationshipMapper.toApiRelationships(resource.getTitleRelationships())); } public @Nullable ProxyUrlDto convertProxy(@Nullable ProxyUrl proxy) { diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceBulkFetchCollectionItemConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceBulkFetchCollectionItemConverter.java index 43f6bedb4..972ebc392 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceBulkFetchCollectionItemConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceBulkFetchCollectionItemConverter.java @@ -3,17 +3,18 @@ import java.util.Comparator; import java.util.List; import org.folio.holdingsiq.model.CoverageDates; -import org.folio.holdingsiq.model.CustomerResources; -import org.folio.holdingsiq.model.Title; +import org.folio.holdingsiq.model.Resource; import org.folio.rest.converter.common.ConverterConsts; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.ResourceBulkFetchCollectionItem; import org.folio.rest.jaxrs.model.ResourceBulkFetchDataAttributes; +import org.folio.rest.util.IdParser; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @Component -public class ResourceBulkFetchCollectionItemConverter implements Converter { +public class ResourceBulkFetchCollectionItemConverter + implements Converter { private final Converter, List> coverageDatesConverter; @@ -22,18 +23,17 @@ public ResourceBulkFetchCollectionItemConverter(Converter, L } @Override - public ResourceBulkFetchCollectionItem convert(Title title) { - CustomerResources resource = title.getCustomerResourcesList().getFirst(); + public ResourceBulkFetchCollectionItem convert(Resource resource) { return new ResourceBulkFetchCollectionItem() - .withId(resource.getVendorId() + "-" + resource.getPackageId() + "-" + resource.getTitleId()) + .withId(IdParser.getResourceId(resource)) .withType(ResourceBulkFetchCollectionItem.Type.RESOURCES) .withAttributes(new ResourceBulkFetchDataAttributes() - .withName(title.getTitleName()) + .withName(resource.getTitleName()) .withProviderId(resource.getVendorId()) .withProviderName(resource.getVendorName()) .withPackageId(resource.getVendorId() + "-" + resource.getPackageId()) - .withTitleId(title.getTitleId()) - .withPublicationType(ConverterConsts.PUBLICATION_TYPES.get(title.getPubType().toLowerCase())) + .withTitleId(resource.getTitleId()) + .withPublicationType(ConverterConsts.PUBLICATION_TYPES.get(resource.getPubType().toLowerCase())) .withManagedCoverages(coverageDatesConverter.convert(resource.getManagedCoverageList())) .withCustomCoverages(coverageDatesConverter.convert( resource.getCustomCoverageList().stream() diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionBulkFetchConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionBulkFetchConverter.java index d8cbbe9d3..cb1b7ffc1 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionBulkFetchConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionBulkFetchConverter.java @@ -3,7 +3,7 @@ import static org.folio.common.ListUtils.mapItems; import java.util.List; -import org.folio.holdingsiq.model.Title; +import org.folio.holdingsiq.model.Resource; import org.folio.rest.jaxrs.model.FailedResourceIds; import org.folio.rest.jaxrs.model.FailedResourcesInformation; import org.folio.rest.jaxrs.model.ResourceBulkFetchCollection; @@ -17,19 +17,18 @@ public class ResourceCollectionBulkFetchConverter implements Converter { - private final Converter converter; + private final Converter converter; - public ResourceCollectionBulkFetchConverter(Converter converter) { + public ResourceCollectionBulkFetchConverter(Converter converter) { this.converter = converter; } @Override public ResourceBulkFetchCollection convert(ResourceBulkResult resourceBulkResult) { - List titleList = mapItems(resourceBulkResult.titles().getTitleList(), - converter::convert); + List items = mapItems(resourceBulkResult.resources(), converter::convert); return new ResourceBulkFetchCollection() - .withIncluded(titleList) + .withIncluded(items) .withJsonapi(RestConstants.JSONAPI) .withMeta(new FailedResourcesInformation() .withFailed(new FailedResourceIds() diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionConverters.java b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionConverters.java index d44ee9e58..9b07e01b4 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionConverters.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionConverters.java @@ -3,14 +3,14 @@ import static org.folio.common.ListUtils.mapItems; import java.util.List; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resource; +import org.folio.holdingsiq.model.Resources; import org.folio.rest.jaxrs.model.MetaTotalResults; import org.folio.rest.jaxrs.model.ResourceCollection; import org.folio.rest.jaxrs.model.ResourceCollectionItem; import org.folio.rest.util.RestConstants; -import org.folio.rmapi.result.TitleCollectionResult; -import org.folio.rmapi.result.TitleResult; +import org.folio.rmapi.result.ResourceItemCollectionResult; +import org.folio.rmapi.result.ResourceItemResult; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @@ -20,42 +20,43 @@ private ResourceCollectionConverters() { } @Component - public static class FromTitles implements Converter { + public static class FromResources implements Converter { - private final Converter converter; + private final Converter converter; - public FromTitles(Converter converter) { + public FromResources(Converter converter) { this.converter = converter; } @Override - public ResourceCollection convert(Titles titles) { - List titleList = mapItems(titles.getTitleList(), converter::convert); + public ResourceCollection convert(Resources resources) { + List items = mapItems(resources.getTitles(), converter::convert); return new ResourceCollection() .withJsonapi(RestConstants.JSONAPI) - .withMeta(new MetaTotalResults().withTotalResults(titles.getTotalResults())) - .withData(titleList); + .withMeta(new MetaTotalResults().withTotalResults(resources.getTotalResults())) + .withData(items); } } @Component - public static class FromTitleCollectionResult implements Converter { + public static class FromResourceItemCollectionResult + implements Converter { - private final Converter converter; + private final Converter converter; - public FromTitleCollectionResult(Converter converter) { + public FromResourceItemCollectionResult(Converter converter) { this.converter = converter; } @Override - public ResourceCollection convert(TitleCollectionResult col) { - List titleList = mapItems(col.getTitleResults(), converter::convert); + public ResourceCollection convert(ResourceItemCollectionResult col) { + List items = mapItems(col.items(), converter::convert); return new ResourceCollection() .withJsonapi(RestConstants.JSONAPI) - .withMeta(new MetaTotalResults().withTotalResults(col.getTotalResults())) - .withData(titleList); + .withMeta(new MetaTotalResults().withTotalResults(col.totalResults())) + .withData(items); } } } diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionItemConverters.java b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionItemConverters.java index 4df42467d..0b37573ce 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionItemConverters.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionItemConverters.java @@ -5,14 +5,14 @@ import static org.folio.rest.converter.resources.ResourceConverterUtils.createEmptyRelationship; import java.util.List; -import org.folio.holdingsiq.model.CustomerResources; -import org.folio.holdingsiq.model.Title; +import org.folio.holdingsiq.model.Resource; import org.folio.repository.accesstypes.DbAccessType; import org.folio.repository.tag.DbTag; import org.folio.rest.jaxrs.model.AccessType; import org.folio.rest.jaxrs.model.ResourceCollectionItem; import org.folio.rest.jaxrs.model.Tags; -import org.folio.rmapi.result.TitleResult; +import org.folio.rest.util.IdParser; +import org.folio.rmapi.result.ResourceItemResult; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @@ -21,46 +21,45 @@ public final class ResourceCollectionItemConverters { private ResourceCollectionItemConverters() { } @Component - public static class FromTitle implements Converter { + public static class FromResource implements Converter { private final CommonResourceConverter commonResourceConverter; - public FromTitle(CommonResourceConverter commonResourceConverter) { + public FromResource(CommonResourceConverter commonResourceConverter) { this.commonResourceConverter = commonResourceConverter; } @Override - public ResourceCollectionItem convert(Title title) { - CustomerResources resource = title.getCustomerResourcesList().getFirst(); + public ResourceCollectionItem convert(Resource resource) { return new ResourceCollectionItem() - .withId(resource.getVendorId() + "-" + resource.getPackageId() + "-" + resource.getTitleId()) + .withId(IdParser.getResourceId(resource)) .withType(ResourceCollectionItem.Type.RESOURCES) .withRelationships(createEmptyRelationship()) - .withAttributes(commonResourceConverter.createResourceDataAttributes(title, resource)); + .withAttributes(commonResourceConverter.createResourceDataAttributes(resource)); } } @Component - public static class FromTitleResult implements Converter { + public static class FromResourceItemResult implements Converter { - private final Converter titleConverter; + private final Converter resourceConverter; private final Converter, Tags> tagsConverter; private final Converter accessTypeConverter; - public FromTitleResult(Converter titleConverter, - Converter, Tags> tagsConverter, - Converter accessTypeConverter) { - this.titleConverter = titleConverter; + public FromResourceItemResult(Converter resourceConverter, + Converter, Tags> tagsConverter, + Converter accessTypeConverter) { + this.resourceConverter = resourceConverter; this.tagsConverter = tagsConverter; this.accessTypeConverter = accessTypeConverter; } @Override - public ResourceCollectionItem convert(TitleResult titleResult) { - ResourceCollectionItem result = requireNonNull(titleConverter.convert(titleResult.getTitle())); - result.getAttributes().setTags(tagsConverter.convert(emptyIfNull(titleResult.getResourceTagList()))); - if (titleResult.getResourceAccessType() != null) { - result.getIncluded().add(accessTypeConverter.convert(titleResult.getResourceAccessType())); + public ResourceCollectionItem convert(ResourceItemResult itemResult) { + ResourceCollectionItem result = requireNonNull(resourceConverter.convert(itemResult.getResource())); + result.getAttributes().setTags(tagsConverter.convert(emptyIfNull(itemResult.getTagList()))); + if (itemResult.getAccessType() != null) { + result.getIncluded().add(accessTypeConverter.convert(itemResult.getAccessType())); } return result; } diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionResultConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionResultConverter.java index d0b1b6635..eb3924650 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceCollectionResultConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceCollectionResultConverter.java @@ -5,9 +5,9 @@ import java.util.Collections; import java.util.Comparator; import java.util.List; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.ResourceId; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.repository.holdings.DbHoldingInfo; import org.folio.repository.resources.DbResource; import org.folio.rest.jaxrs.model.MetaTotalResults; @@ -22,11 +22,11 @@ @Component public class ResourceCollectionResultConverter implements Converter { - private final Converter resourceCollectionItemConverter; + private final Converter resourceCollectionItemConverter; private final Converter holdingCollectionItemConverter; public ResourceCollectionResultConverter( - Converter resourceCollectionItemConverter, + Converter resourceCollectionItemConverter, Converter holdingCollectionItemConverter) { this.resourceCollectionItemConverter = resourceCollectionItemConverter; this.holdingCollectionItemConverter = holdingCollectionItemConverter; @@ -35,15 +35,15 @@ public ResourceCollectionResultConverter( @Override public ResourceCollection convert(ResourceCollectionResult resourceCollectionResult) { - final Titles titles = resourceCollectionResult.titles(); - final List resources = resourceCollectionResult.titlesList(); + final Resources resources = resourceCollectionResult.resources(); + final List dbResources = resourceCollectionResult.dbResources(); final List holdings = resourceCollectionResult.holdings(); - final List resourceCollectionItems = mapItems(titles.getTitleList(), - title -> mapResourceCollectionItem(resources, resourceCollectionItemConverter.convert(title), - createResourceId(title))); + final List resourceCollectionItems = mapItems(resources.getTitles(), + resource -> mapResourceCollectionItem(dbResources, resourceCollectionItemConverter.convert(resource), + createResourceId(resource))); final List holdingCollectionItems = mapItems(holdings, - dbHolding -> mapResourceCollectionItem(resources, holdingCollectionItemConverter.convert(dbHolding), + dbHolding -> mapResourceCollectionItem(dbResources, holdingCollectionItemConverter.convert(dbHolding), createResourceId(dbHolding))); resourceCollectionItems.addAll(holdingCollectionItems); @@ -51,7 +51,7 @@ public ResourceCollection convert(ResourceCollectionResult resourceCollectionRes return new ResourceCollection() .withJsonapi(RestConstants.JSONAPI) - .withMeta(new MetaTotalResults().withTotalResults(titles.getTotalResults())) + .withMeta(new MetaTotalResults().withTotalResults(resources.getTotalResults())) .withData(resourceCollectionItems); } @@ -69,10 +69,8 @@ private ResourceCollectionItem mapResourceCollectionItem(List resour return item; } - private ResourceId createResourceId(Title title) { - return new ResourceId(title.getCustomerResourcesList().getFirst().getVendorId(), - title.getCustomerResourcesList().getFirst().getPackageId(), - title.getTitleId()); + private ResourceId createResourceId(Resource resource) { + return new ResourceId(resource.getVendorId(), resource.getPackageId(), resource.getTitleId()); } private ResourceId createResourceId(DbHoldingInfo holding) { diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceItemCollectionResultConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceItemCollectionResultConverter.java new file mode 100644 index 000000000..ccc2c028d --- /dev/null +++ b/src/main/java/org/folio/rest/converter/resources/ResourceItemCollectionResultConverter.java @@ -0,0 +1,19 @@ +package org.folio.rest.converter.resources; + +import static org.folio.common.ListUtils.mapItems; + +import org.folio.holdingsiq.model.Resources; +import org.folio.rmapi.result.ResourceItemCollectionResult; +import org.folio.rmapi.result.ResourceItemResult; +import org.springframework.core.convert.converter.Converter; +import org.springframework.stereotype.Component; + +@Component +public class ResourceItemCollectionResultConverter implements Converter { + + @Override + public ResourceItemCollectionResult convert(Resources resources) { + return new ResourceItemCollectionResult(mapItems(resources.getTitles(), ResourceItemResult::new), + resources.getFacets(), resources.getTotalResults()); + } +} diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceRequestConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceRequestConverter.java index 63da0fab2..00ea9ea5c 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceRequestConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceRequestConverter.java @@ -4,12 +4,11 @@ import java.util.List; import org.folio.holdingsiq.model.CoverageDates; -import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.EmbargoPeriod; import org.folio.holdingsiq.model.Proxy; import org.folio.holdingsiq.model.ProxyUrl; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.ResourcePut; -import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.UserDefinedFields; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.ProxyDto; @@ -20,37 +19,35 @@ @Component public class ResourceRequestConverter { - public org.folio.holdingsiq.model.ResourcePut convertToRmApiResourcePutRequest(ResourcePutRequest entity, - Title oldTitle) { + public ResourcePut convertToRmApiResourcePutRequest(ResourcePutRequest entity, Resource oldResource) { ResourcePutDataAttributes attributes = entity.getData().getAttributes(); //Map common attributes for custom/managed resources to RM API fields - ResourcePut.ResourcePutBuilder builder = convertCommonAttributesToResourcePutRequest(attributes, oldTitle); + ResourcePut.ResourcePutBuilder builder = convertCommonAttributesToResourcePutRequest(attributes, oldResource); return builder.build(); } - public ResourcePut convertToRmApiCustomResourcePutRequest(ResourcePutRequest entity, Title oldTitle) { + public ResourcePut convertToRmApiCustomResourcePutRequest(ResourcePutRequest entity, Resource oldResource) { ResourcePutDataAttributes attributes = entity.getData().getAttributes(); //Map common attributes for custom/managed resources to RM API fields - ResourcePut.ResourcePutBuilder builder = convertCommonAttributesToResourcePutRequest(attributes, oldTitle); + ResourcePut.ResourcePutBuilder builder = convertCommonAttributesToResourcePutRequest(attributes, oldResource); //Map attributes specific to custom resources to RM API fields - builder.titleName(oldTitle.getTitleName()); - builder.publisherName(oldTitle.getPublisherName()); - builder.edition(oldTitle.getEdition()); - builder.description(oldTitle.getDescription()); + builder.titleName(oldResource.getTitleName()); + builder.publisherName(oldResource.getPublisherName()); + builder.edition(oldResource.getEdition()); + builder.description(oldResource.getDescription()); - builder.identifiersList(oldTitle.getIdentifiersList()); - builder.contributorsList(oldTitle.getContributorsList()); + builder.identifiersList(oldResource.getIdentifiersList()); + builder.contributorsList(oldResource.getContributorsList()); return builder.build(); } private ResourcePut.ResourcePutBuilder convertCommonAttributesToResourcePutRequest( - ResourcePutDataAttributes attributes, Title oldTitle) { + ResourcePutDataAttributes attributes, Resource oldResource) { var builder = ResourcePut.builder(); - var oldResource = oldTitle.getCustomerResourcesList().getFirst(); builder.isSelected(valueOrDefault(attributes.getIsSelected(), oldResource.getIsSelected())); convertProxy(builder, attributes.getProxy(), oldResource.getProxy()); - convertHidden(attributes, oldResource, builder); + convertHidden(attributes, builder); if (Boolean.TRUE == oldResource.getIsPackageCustom()) { builder.url(valueOrDefault(attributes.getUrl(), oldResource.getUrl())); } @@ -65,21 +62,21 @@ private ResourcePut.ResourcePutBuilder convertCommonAttributesToResourcePutReque // but below, we set the same values as we conduct a GET for pubType and isPeerReviewed because otherwise // RM API gives a bad request error if those values are set to null. All the other fields are retained as // is by RM API because they cannot be updated. - builder.pubType(oldTitle.getPubType()); - builder.isPeerReviewed(oldTitle.getIsPeerReviewed()); + builder.pubType(oldResource.getPubType()); + builder.isPeerReviewed(oldResource.getIsPeerReviewed()); convertUserDefinedFields(attributes, builder, oldResource); return builder; } - private void convertHidden(ResourcePutDataAttributes attributes, CustomerResources oldResource, - ResourcePut.ResourcePutBuilder builder) { - var oldHidden = oldResource.getVisibilityData() != null ? oldResource.getVisibilityData().getIsHidden() : null; - var isHidden = attributes.getVisibilityData() != null && attributes.getVisibilityData().getIsHidden() != null - ? attributes.getVisibilityData().getIsHidden() : oldHidden; - - builder.isHidden(isHidden); + /** + * Sends visibility only when the request sets it; HoldingsIQ keeps the current visibility when it is omitted. + * The per-category visibility takes precedence over the single visibility flag. + */ + private void convertHidden(ResourcePutDataAttributes attributes, ResourcePut.ResourcePutBuilder builder) { + var isHidden = attributes.getVisibilityData() != null ? attributes.getVisibilityData().getIsHidden() : null; + builder.visibilityDetails(ResourceVisibility.toVisibilityDetails(attributes.getVisibility(), isHidden)); } private void convertProxy(ResourcePut.ResourcePutBuilder builder, @Nullable ProxyDto newProxy, ProxyUrl oldProxy) { @@ -93,7 +90,7 @@ private void convertProxy(ResourcePut.ResourcePutBuilder builder, @Nullable Prox builder.proxy(rmApiProxy); } - private void convertCoverageDates(ResourcePutDataAttributes attributes, CustomerResources oldResource, + private void convertCoverageDates(ResourcePutDataAttributes attributes, Resource oldResource, ResourcePut.ResourcePutBuilder builder) { var coverageDates = attributes.getCustomCoverages() != null ? convertToRmApiCustomCoverageList(attributes.getCustomCoverages()) @@ -114,7 +111,7 @@ private void convertEmbargoPeriod(ResourcePutDataAttributes attributes, Resource } private void convertUserDefinedFields(ResourcePutDataAttributes attributes, ResourcePut.ResourcePutBuilder builder, - CustomerResources oldResource) { + Resource oldResource) { builder.userDefinedFields(UserDefinedFields.builder() .userDefinedField1( valueOrDefault(attributes.getUserDefinedField1(), oldResource.getUserDefinedFields().getUserDefinedField1())) diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceResultConverter.java b/src/main/java/org/folio/rest/converter/resources/ResourceResultConverter.java index 5c141eb72..aef1ef342 100644 --- a/src/main/java/org/folio/rest/converter/resources/ResourceResultConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/ResourceResultConverter.java @@ -1,8 +1,6 @@ package org.folio.rest.converter.resources; import static java.util.Objects.requireNonNull; -import static org.apache.commons.collections4.IterableUtils.matchesAny; -import static org.folio.common.ListUtils.mapItems; import static org.folio.rest.converter.resources.ResourceConverterUtils.createEmptyRelationship; import static org.folio.rest.util.RestConstants.PACKAGES_TYPE; import static org.folio.rest.util.RestConstants.PROVIDERS_TYPE; @@ -10,8 +8,7 @@ import java.util.ArrayList; import java.util.List; -import java.util.function.Function; -import org.folio.holdingsiq.model.CustomerResources; +import org.apache.commons.lang3.BooleanUtils; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.VendorById; import org.folio.rest.jaxrs.model.AccessType; @@ -23,10 +20,11 @@ import org.folio.rest.jaxrs.model.Resource; import org.folio.rest.jaxrs.model.ResourceCollectionItem; import org.folio.rest.jaxrs.model.Title; +import org.folio.rest.util.IdParser; import org.folio.rest.util.RestConstants; +import org.folio.rmapi.ResourceMapper; import org.folio.rmapi.result.ResourceResult; import org.folio.rmapi.result.TitleResult; -import org.jspecify.annotations.Nullable; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @@ -35,8 +33,6 @@ @SuppressWarnings("java:S6813") public class ResourceResultConverter implements Converter> { - @Autowired - private Converter resourceCollectionItemConverter; @Autowired private CommonResourceConverter commonResourceConverter; @Autowired @@ -48,55 +44,37 @@ public class ResourceResultConverter implements Converter convert(ResourceResult resourceResult) { - var rmapiTitle = resourceResult.getTitle(); - PackageData packageData = resourceResult.getPackageData(); - VendorById vendor = resourceResult.getVendor(); - AccessType accessType = resourceResult.getAccessType(); - boolean includeTitle = resourceResult.isIncludeTitle(); - - List customerResourcesList = rmapiTitle.getCustomerResourcesList(); - boolean titleHasSelectedResources = matchesAny(customerResourcesList, CustomerResources::getIsSelected); - return mapItems(customerResourcesList, - convertToResource(rmapiTitle, titleHasSelectedResources, includeTitle, vendor, packageData, accessType)); - } - - private Function convertToResource(org.folio.holdingsiq.model.Title rmapiTitle, - boolean titleHasSelectedResources, - boolean includeTitle, - VendorById vendor, PackageData packageData, - AccessType accessType) { - return resource -> { - Resource resultResource = new Resource() - .withData(new ResourceCollectionItem() - .withId(resource.getVendorId() + "-" + resource.getPackageId() + "-" + resource.getTitleId()) - .withType(ResourceCollectionItem.Type.RESOURCES) - .withAttributes(commonResourceConverter.createResourceDataAttributes(rmapiTitle, resource)) - .withRelationships(createEmptyRelationship()) - ) - .withIncluded(null) - .withJsonapi(RestConstants.JSONAPI); + var rmapiResource = resourceResult.getResource(); + Resource resultResource = new Resource() + .withData(new ResourceCollectionItem() + .withId(IdParser.getResourceId(rmapiResource)) + .withType(ResourceCollectionItem.Type.RESOURCES) + .withAttributes(commonResourceConverter.createResourceDataAttributes(rmapiResource)) + .withRelationships(createEmptyRelationship()) + ) + .withIncluded(null) + .withJsonapi(RestConstants.JSONAPI); - resultResource.getData().getAttributes().setTitleHasSelectedResources(titleHasSelectedResources); - includedResources(rmapiTitle, includeTitle, vendor, packageData, accessType, resultResource); - return resultResource; - }; + // the resource is the only package of its title in the response, so it decides whether a resource is selected + resultResource.getData().getAttributes() + .setTitleHasSelectedResources(BooleanUtils.isTrue(rmapiResource.getIsSelected())); + includedResources(resourceResult, resultResource); + return List.of(resultResource); } - private void includedResources(org.folio.holdingsiq.model.Title rmapiTitle, boolean includeTitle, - @Nullable VendorById vendor, @Nullable PackageData packageData, - @Nullable AccessType accessType, Resource resultResource) { + private void includedResources(ResourceResult resourceResult, Resource resultResource) { resultResource.setIncluded(new ArrayList<>()); - if (includeTitle) { - includeTitle(rmapiTitle, resultResource); + if (resourceResult.isIncludeTitle()) { + includeTitle(resourceResult.getResource(), resultResource); } - if (vendor != null) { - includeVendor(vendor, resultResource); + if (resourceResult.getVendor() != null) { + includeVendor(resourceResult.getVendor(), resultResource); } - if (packageData != null) { - includePackage(packageData, resultResource); + if (resourceResult.getPackageData() != null) { + includePackage(resourceResult.getPackageData(), resultResource); } - if (accessType != null) { - includeAccessType(accessType, resultResource); + if (resourceResult.getAccessType() != null) { + includeAccessType(resourceResult.getAccessType(), resultResource); } } @@ -132,7 +110,9 @@ private void includeVendor(VendorById vendor, Resource resultResource) { .withType(PROVIDERS_TYPE))); } - private void includeTitle(org.folio.holdingsiq.model.Title rmapiTitle, Resource resultResource) { + private void includeTitle(org.folio.holdingsiq.model.Resource rmapiResource, Resource resultResource) { + // relationships are part of the resource attributes, so they are not repeated in the included title + var rmapiTitle = ResourceMapper.toTitle(rmapiResource).toBuilder().titleRelationships(null).build(); Title title = requireNonNull(titlesConverter.convert(new TitleResult(rmapiTitle, false))); resultResource.getIncluded().add(title.getData()); resultResource.getData() diff --git a/src/main/java/org/folio/rest/converter/resources/ResourceVisibility.java b/src/main/java/org/folio/rest/converter/resources/ResourceVisibility.java new file mode 100644 index 000000000..36d7cccdd --- /dev/null +++ b/src/main/java/org/folio/rest/converter/resources/ResourceVisibility.java @@ -0,0 +1,44 @@ +package org.folio.rest.converter.resources; + +import static org.apache.commons.collections4.CollectionUtils.isNotEmpty; + +import java.util.List; +import org.folio.holdingsiq.model.Visibility; +import org.jspecify.annotations.Nullable; + +/** + * Maps the visibility of the eHoldings API to the per-category visibility of HoldingsIQ v2. A per-category list is + * sent as is; the single visibility flag is written to the PF, FTF and MARC categories. + */ +public final class ResourceVisibility { + + static final String HIDDEN_BY_CUSTOMER = "Hidden by Customer"; + + private static final List CATEGORIES = List.of("PF", "FTF", "MARC"); + + private ResourceVisibility() { + } + + /** + * Returns {@code null} when the request sets no visibility, so that HoldingsIQ keeps the current one. + */ + public static @Nullable List toVisibilityDetails( + @Nullable List visibility, @Nullable Boolean hidden) { + if (isNotEmpty(visibility)) { + return visibility.stream() + .map(item -> toVisibility(item.getCategory().value(), item.getHidden())) + .toList(); + } + if (hidden == null) { + return null; + } + return CATEGORIES.stream() + .map(category -> toVisibility(category, hidden)) + .toList(); + } + + // the reason is only sent for a hidden category + private static Visibility toVisibility(String category, boolean hidden) { + return Visibility.builder().category(category).hidden(hidden).reason(hidden ? HIDDEN_BY_CUSTOMER : null).build(); + } +} diff --git a/src/main/java/org/folio/rest/converter/resources/TitleConverter.java b/src/main/java/org/folio/rest/converter/resources/TitleConverter.java index 251c1d334..8b15c4d80 100644 --- a/src/main/java/org/folio/rest/converter/resources/TitleConverter.java +++ b/src/main/java/org/folio/rest/converter/resources/TitleConverter.java @@ -4,14 +4,14 @@ import static org.folio.rest.converter.resources.ResourceConverterUtils.createEmptyRelationship; import java.util.List; -import org.folio.holdingsiq.model.CustomerResources; +import org.folio.holdingsiq.model.Title; import org.folio.rest.jaxrs.model.ResourceCollectionItem; -import org.jspecify.annotations.NonNull; +import org.folio.rmapi.ResourceMapper; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Component; @Component -public class TitleConverter implements Converter> { +public class TitleConverter implements Converter> { private final CommonResourceConverter commonResourceConverter; @@ -20,13 +20,13 @@ public TitleConverter(CommonResourceConverter commonResourceConverter) { } @Override - public List<@NonNull ResourceCollectionItem> convert(org.folio.holdingsiq.model.Title rmapiTitle) { - List customerResourcesList = rmapiTitle.getCustomerResourcesList(); - return mapItems(customerResourcesList, + public List convert(Title rmapiTitle) { + return mapItems(rmapiTitle.getCustomerResourcesList(), resource -> new ResourceCollectionItem() .withId(resource.getVendorId() + "-" + resource.getPackageId() + "-" + resource.getTitleId()) .withType(ResourceCollectionItem.Type.RESOURCES) - .withAttributes(commonResourceConverter.createResourceDataAttributes(rmapiTitle, resource)) + .withAttributes(commonResourceConverter.createResourceDataAttributes( + ResourceMapper.toResource(rmapiTitle, resource))) .withRelationships(createEmptyRelationship())); } } diff --git a/src/main/java/org/folio/rest/converter/titles/TitleCollectionResultConverter.java b/src/main/java/org/folio/rest/converter/titles/TitleCollectionResultConverter.java deleted file mode 100644 index e23a02144..000000000 --- a/src/main/java/org/folio/rest/converter/titles/TitleCollectionResultConverter.java +++ /dev/null @@ -1,24 +0,0 @@ -package org.folio.rest.converter.titles; - -import static org.folio.common.ListUtils.mapItems; - -import java.util.List; -import org.folio.holdingsiq.model.Titles; -import org.folio.rmapi.result.TitleCollectionResult; -import org.folio.rmapi.result.TitleResult; -import org.springframework.core.convert.converter.Converter; -import org.springframework.stereotype.Component; - -@Component -public class TitleCollectionResultConverter implements Converter { - - @Override - public TitleCollectionResult convert(Titles titles) { - List titleResults = mapItems(titles.getTitleList(), title -> new TitleResult(title, false)); - - return TitleCollectionResult.builder() - .titleResults(titleResults) - .facets(titles.getFacets()) - .totalResults(titles.getTotalResults()).build(); - } -} diff --git a/src/main/java/org/folio/rest/converter/titles/TitlePutRequestConverter.java b/src/main/java/org/folio/rest/converter/titles/TitlePutRequestConverter.java index 15d011641..05134e20b 100644 --- a/src/main/java/org/folio/rest/converter/titles/TitlePutRequestConverter.java +++ b/src/main/java/org/folio/rest/converter/titles/TitlePutRequestConverter.java @@ -33,8 +33,8 @@ public TitlePutRequestConverter( public ResourcePut convertToRmApiCustomResourcePutRequest(TitlePutRequest entity, CustomerResources oldResource) { ResourcePut.ResourcePutBuilder builder = ResourcePut.builder(); + // visibility is left out: HoldingsIQ keeps the current visibility of all categories when it is omitted builder.proxy(convertProxy(oldResource)); - builder.isHidden(oldResource.getVisibilityData().getIsHidden()); builder.coverageStatement(oldResource.getCoverageStatement()); builder.customEmbargoPeriod(oldResource.getCustomEmbargoPeriod()); builder.customCoverageList(oldResource.getCustomCoverageList()); diff --git a/src/main/java/org/folio/rest/converter/titles/TitleRelationshipMapper.java b/src/main/java/org/folio/rest/converter/titles/TitleRelationshipMapper.java new file mode 100644 index 000000000..ae1e1e47c --- /dev/null +++ b/src/main/java/org/folio/rest/converter/titles/TitleRelationshipMapper.java @@ -0,0 +1,38 @@ +package org.folio.rest.converter.titles; + +import static org.folio.common.ListUtils.mapItems; + +import java.util.List; +import org.folio.rest.jaxrs.model.RelatedTitle; +import org.folio.rest.jaxrs.model.TitleRelationship; +import org.jspecify.annotations.Nullable; + +/** + * Maps HoldingsIQ title relationships to the eHoldings API; they are present only when requested. + */ +public final class TitleRelationshipMapper { + + private TitleRelationshipMapper() { + } + + public static @Nullable List toApiRelationships( + @Nullable List relationships) { + return relationships == null ? null : mapItems(relationships, TitleRelationshipMapper::toApiRelationship); + } + + private static TitleRelationship toApiRelationship(org.folio.holdingsiq.model.TitleRelationship relationship) { + return new TitleRelationship() + .withId(relationship.resourceRelationshipId()) + .withType(relationship.type()) + .withDate(relationship.date()) + .withSource(toApiRelatedTitle(relationship.source())) + .withTarget(toApiRelatedTitle(relationship.target())); + } + + private static @Nullable RelatedTitle toApiRelatedTitle( + org.folio.holdingsiq.model.@Nullable RelatedTitle relatedTitle) { + return relatedTitle == null + ? null + : new RelatedTitle().withTitleId(relatedTitle.titleId()).withName(relatedTitle.name()); + } +} diff --git a/src/main/java/org/folio/rest/converter/titles/TitleResultConverter.java b/src/main/java/org/folio/rest/converter/titles/TitleResultConverter.java index 90ac3ab97..634924795 100644 --- a/src/main/java/org/folio/rest/converter/titles/TitleResultConverter.java +++ b/src/main/java/org/folio/rest/converter/titles/TitleResultConverter.java @@ -4,6 +4,7 @@ import static java.util.Comparator.comparingInt; import static java.util.Comparator.nullsLast; import static java.util.Objects.nonNull; +import static java.util.Objects.requireNonNull; import static org.apache.commons.collections4.IterableUtils.matchesAny; import static org.folio.common.ListUtils.mapItems; import static org.folio.rest.converter.titles.TitleConverterUtils.createEmptyResourcesRelationships; @@ -35,6 +36,7 @@ import org.folio.rest.jaxrs.model.TitleSubject; import org.folio.rest.util.IdParser; import org.folio.rest.util.RestConstants; +import org.folio.rmapi.ResourceMapper; import org.folio.rmapi.result.ResourceResult; import org.folio.rmapi.result.TitleResult; import org.springframework.beans.factory.annotation.Autowired; @@ -95,6 +97,7 @@ private TitleAttributes convertAttributes(TitleResult titleResult, org.folio.hol .withEdition(rmapiTitle.getEdition()) .withDescription(rmapiTitle.getDescription()) .withIsPeerReviewed(rmapiTitle.getIsPeerReviewed()) + .withTitleRelationships(TitleRelationshipMapper.toApiRelationships(rmapiTitle.getTitleRelationships())) .withTags(titleResult.getTags()); } @@ -128,8 +131,15 @@ private void includeTagsIfNeeded(Title title, TitleResult titleResult) { } private List extractResourceCollectionItems(org.folio.holdingsiq.model.Title rmapiTitle) { - ResourceResult resourceResult = new ResourceResult(rmapiTitle, null, null, false); - return mapItems(resourcesConverter.convert(resourceResult), Resource::getData); + List customerResources = rmapiTitle.getCustomerResourcesList(); + boolean titleHasSelectedResources = matchesAny(customerResources, CustomerResources::getIsSelected); + return mapItems(customerResources, customerResource -> { + var resourceResult = new ResourceResult(ResourceMapper.toResource(rmapiTitle, customerResource), null, null, + false); + ResourceCollectionItem item = requireNonNull(resourcesConverter.convert(resourceResult)).getFirst().getData(); + item.getAttributes().setTitleHasSelectedResources(titleHasSelectedResources); + return item; + }); } private List convertResourcesRelationship(List customerResources) { diff --git a/src/main/java/org/folio/rest/impl/EholdingsPackagesImpl.java b/src/main/java/org/folio/rest/impl/EholdingsPackagesImpl.java index 615a6c408..be6ea78ba 100644 --- a/src/main/java/org/folio/rest/impl/EholdingsPackagesImpl.java +++ b/src/main/java/org/folio/rest/impl/EholdingsPackagesImpl.java @@ -36,6 +36,7 @@ import org.folio.rest.jaxrs.model.ResourceCollection; import org.folio.rest.jaxrs.resource.EholdingsPackages; import org.folio.rest.model.filter.AccessTypeFilter; +import org.folio.rest.model.filter.LegacySearchParams; import org.folio.rest.model.filter.PackageRecordFilter; import org.folio.rest.model.filter.ResourceFilter; import org.folio.rest.model.filter.TagFilter; @@ -175,13 +176,15 @@ public void deleteEholdingsPackagesByPackageId(String packageId, Map filterTags, - List filterAccessType, String filterSelected, - String filterType, String filterName, String filterIsxn, - String filterSubject, String filterPublisher, String sort, - int page, - int count, Map okapiHeaders, + List filterAccessType, String query, String queryField, + String filterSelected, String filterType, String filterAccess, + String filterName, String filterIsxn, String filterSubject, + String filterPublisher, String sort, int page, int count, + Map okapiHeaders, Handler> asyncResultHandler, Context vertxContext) { + var search = LegacySearchParams.resolve(query, queryField, filterName, filterIsxn, filterSubject, + filterPublisher); var filter = ResourceFilter.builder() .packageId(packageId) @@ -189,10 +192,9 @@ public void getEholdingsPackagesResourcesByPackageId(String packageId, List fetchAccessType(entity, context) .thenCompose(accessType -> processResourceUpdate(entity, parsedResourceId, context) - .thenCompose(resourceResult -> { - context.getTitlesService().updateCache(resourceResult); - return updateAccessType(resourceId, resourceResult, accessType, context); + .thenCompose(resource -> { + context.getTitlesService().updateCache(resource); + return updateAccessType(resourceId, resource, accessType, context); }) )) .addErrorMapper(InputValidationException.class, error422InputValidationMapper()) @@ -187,8 +177,8 @@ public void deleteEholdingsResourcesByResourceId(String resourceId, Map context.getResourcesService().retrieveResource(parsedResourceId) - .thenCompose(title -> { - if (BooleanUtils.isNotTrue(title.getCustomerResourcesList().getFirst().getIsPackageCustom())) { + .thenCompose(resource -> { + if (BooleanUtils.isNotTrue(resource.getIsPackageCustom())) { throw new InputValidationException(RESOURCE_CANNOT_BE_DELETED_TITLE, RESOURCE_CANNOT_BE_DELETED_DETAIL); } return context.getResourcesService().deleteResource(parsedResourceId); @@ -237,18 +227,17 @@ private Function> processResourcePost ResourcePostDataAttributes attributes) { var titleId = parseTitleId(attributes.getTitleId()); PackageId packageId = parsePackageId(attributes.getPackageId()); - return context -> (CompletableFuture) getObjectsForPostResource(titleId, packageId, context.getTitlesService(), - context.getPackagesService()) + ResourceId resourceId = new ResourceId(packageId.providerIdPart(), packageId.packageIdPart(), titleId); + return context -> getObjectsForPostResource(resourceId, context) .thenCompose(result -> { Title title = result.title(); - postValidator.validateRelatedObjects(result.packageData(), title, result.titles()); - ResourceSelectedPayload postRequest = + postValidator.validateRelatedObjects(result.packageData(), result.titleInPackage()); + var postRequest = new ResourceSelectedPayload(true, title.getTitleName(), title.getPubType(), attributes.getUrl()); - ResourceId resourceId = new ResourceId(packageId.providerIdPart(), packageId.packageIdPart(), titleId); return context.getResourcesService().postResource(postRequest, resourceId); }) - .thenCompose(title -> CompletableFuture.completedFuture( - new ResourceResult(title, null, null, false))); + .thenCompose(resource -> CompletableFuture.completedFuture( + new ResourceResult(resource, null, null, false))); } private CompletableFuture fetchAccessType(ResourcePutRequest entity, @@ -262,12 +251,13 @@ private CompletableFuture fetchAccessType(ResourcePutRequest entity, } } - private CompletableFuture updateAccessType(String recordId, Title titleResult, + private CompletableFuture updateAccessType(String recordId, + org.folio.holdingsiq.model.Resource resource, AccessType accessType, RmApiTemplateContext context) { return updateRecordMapping(accessType, recordId, context) .thenApply(a -> { - ResourceResult resourceResult = new ResourceResult(titleResult, null, null, false); + ResourceResult resourceResult = new ResourceResult(resource, null, null, false); resourceResult.setAccessType(accessType); return resourceResult; }); @@ -280,8 +270,10 @@ private CompletableFuture updateRecordMapping(AccessType accessType, Strin } private CompletableFuture loadRelatedEntities(ResourceResult result, RmApiTemplateContext context) { - CustomerResources resource = result.getTitle().getCustomerResourcesList().getFirst(); - RecordKey recordKey = RecordKey.builder().recordId(getResourceId(resource)).recordType(RecordType.RESOURCE).build(); + RecordKey recordKey = RecordKey.builder() + .recordId(getResourceId(result.getResource())) + .recordType(RecordType.RESOURCE) + .build(); return CompletableFuture.allOf( relatedEntitiesLoader.loadAccessType(result, recordKey, context), relatedEntitiesLoader.loadTags(result, recordKey, context)) @@ -312,22 +304,36 @@ private CompletableFuture deleteTags(String resourceId, RmApiTemplateConte .thenCompose(v -> CompletableFuture.completedFuture(null)); } - private CompletionStage getObjectsForPostResource( - int titleId, PackageId packageId, - TitlesHoldingsIQService titlesService, - PackagesHoldingsIQService packagesService) { - CompletableFuture titleFuture = titlesService.retrieveTitle(titleId); - CompletableFuture<PackageData> packageFuture = packagesService.retrievePackage(packageId.packageIdPart()); - return CompletableFuture.allOf(titleFuture, packageFuture) - .thenCompose(o -> { - FilterQuery filterByName = FilterQuery.builder() - .name(titleFuture.join().getTitleName()) - .build(); - return titlesService.retrieveTitles(packageId.providerIdPart(), packageId.packageIdPart(), - filterByName, searchProperties.titlesSearchType(), Sort.RELEVANCE, 1, MAX_TITLE_COUNT); - }) - .thenCompose(titles -> CompletableFuture.completedFuture( - new ObjectsForPostResourceResult(titleFuture.join(), packageFuture.join(), titles))); + private CompletableFuture<ObjectsForPostResourceResult> getObjectsForPostResource(ResourceId resourceId, + RmApiTemplateContext context) { + var titleFuture = context.getTitlesService().retrieveTitle(resourceId.titleIdPart()); + var packageFuture = context.getPackagesService() + .retrievePackage(new PackageId(resourceId.providerIdPart(), resourceId.packageIdPart())); + var titleInPackageFuture = isTitleInPackage(resourceId, context.getResourcesService()); + return CompletableFuture.allOf(titleFuture, packageFuture, titleInPackageFuture) + .thenApply(o -> new ObjectsForPostResourceResult( + titleFuture.join(), + packageFuture.join(), + titleInPackageFuture.join()) + ); + } + + /** + * Checks whether the title is already in the package: HoldingsIQ returns 404 for a title that is not in it. + */ + private CompletableFuture<Boolean> isTitleInPackage(ResourceId resourceId, + ResourcesHoldingsIQService resourcesService) { + return resourcesService.retrieveResource(resourceId) + .handle((resource, throwable) -> { + if (throwable == null) { + return true; + } + var cause = throwable instanceof CompletionException ? throwable.getCause() : throwable; + if (cause instanceof ResourceNotFoundException) { + return false; + } + throw new CompletionException(cause); + }); } private CompletableFuture<Void> updateStoredResource(DbResource resource, String tenant) { @@ -348,17 +354,17 @@ private CompletableFuture<Void> updateResourceTags(DbResource resource, String t } } - private CompletableFuture<Title> processResourceUpdate(ResourcePutRequest entity, ResourceId parsedResourceId, - RmApiTemplateContext context) { + private CompletableFuture<org.folio.holdingsiq.model.Resource> processResourceUpdate( + ResourcePutRequest entity, ResourceId parsedResourceId, RmApiTemplateContext context) { return context.getResourcesService().retrieveResource(parsedResourceId) - .thenCompose(title -> { + .thenCompose(resource -> { ResourcePut resourcePutBody; - boolean isTitleCustom = title.getIsTitleCustom(); + boolean isTitleCustom = resource.getIsTitleCustom(); resourcePutBodyValidator.validate(entity, isTitleCustom); if (isTitleCustom) { - resourcePutBody = converter.convertToRmApiCustomResourcePutRequest(entity, title); + resourcePutBody = converter.convertToRmApiCustomResourcePutRequest(entity, resource); } else { - resourcePutBody = converter.convertToRmApiResourcePutRequest(entity, title); + resourcePutBody = converter.convertToRmApiResourcePutRequest(entity, resource); } return context.getResourcesService().updateResource(parsedResourceId, resourcePutBody); }) diff --git a/src/main/java/org/folio/rest/impl/EholdingsTitlesImpl.java b/src/main/java/org/folio/rest/impl/EholdingsTitlesImpl.java index e7e7a303f..7eaad2eaf 100644 --- a/src/main/java/org/folio/rest/impl/EholdingsTitlesImpl.java +++ b/src/main/java/org/folio/rest/impl/EholdingsTitlesImpl.java @@ -40,6 +40,7 @@ import org.folio.rest.jaxrs.model.TitlePutRequest; import org.folio.rest.jaxrs.resource.EholdingsTitles; import org.folio.rest.model.filter.AccessTypeFilter; +import org.folio.rest.model.filter.LegacySearchParams; import org.folio.rest.model.filter.TagFilter; import org.folio.rest.model.filter.TitleFilter; import org.folio.rest.util.ErrorUtil; @@ -61,6 +62,7 @@ public class EholdingsTitlesImpl implements EholdingsTitles { private static final String GET_TITLE_NOT_FOUND_MESSAGE = "Title not found"; private static final String INCLUDE_RESOURCES_VALUE = "resources"; + private static final String INCLUDE_RELATIONSHIPS_VALUE = "relationships"; @Autowired private Converter<TitlePostRequest, TitlePost> titlePostRequestConverter; @@ -90,21 +92,24 @@ public EholdingsTitlesImpl() { @Override @Validate @HandleValidationErrors - public void getEholdingsTitles(List<String> filterTags, List<String> filterAccessType, String filterSelected, - String filterType, String filterName, String filterIsxn, String filterSubject, - String filterPublisher, - List<String> filterPackageIds, String include, String sort, int page, int count, - Map<String, String> okapiHeaders, Handler<AsyncResult<Response>> asyncResultHandler, - Context vertxContext) { + public void getEholdingsTitles(String query, String queryField, String queryType, List<String> filterTags, + List<String> filterAccessType, String filterSelected, String filterType, + String filterName, String filterIsxn, String filterSubject, String filterPublisher, + String filterAccess, List<String> filterPackageIds, String include, String sort, + int page, int count, Map<String, String> okapiHeaders, + Handler<AsyncResult<Response>> asyncResultHandler, Context vertxContext) { + var search = LegacySearchParams.resolve(query, queryField, filterName, filterIsxn, filterSubject, + filterPublisher); + var filter = TitleFilter.builder() + .query(search.query()) + .queryField(search.queryField()) + .queryType(queryType) .filterTags(filterTags) .filterAccessType(filterAccessType) .filterSelected(filterSelected) .filterType(filterType) - .filterName(filterName) - .filterIsxn(filterIsxn) - .filterSubject(filterSubject) - .filterPublisher(filterPublisher) + .filterAccess(filterAccess) .filterPackageIds(filterPackageIds) .sort(sort) .page(page) @@ -144,7 +149,7 @@ public void getEholdingsTitlesByTitleId(String titleId, String include, Map<Stri templateFactory.createTemplate(okapiHeaders, asyncResultHandler) .requestAction(context -> - context.getTitlesService().retrieveTitle(titleIdLong) + retrieveTitle(titleIdLong, isIncluded(include, INCLUDE_RELATIONSHIPS_VALUE), context) .thenCompose(title -> completedFuture(toTitleResult(title, shouldIncludeResources(include)))) .thenCompose(result -> loadTags(result, context)) ) @@ -190,9 +195,7 @@ private CompletableFuture<Titles> fetchTitlesByFilter(TitleFilter filter, RmApiT return filteredEntitiesLoader.fetchTitlesByAccessTypeFilter(AccessTypeFilter.from(filter), context); } else { return context.getTitlesService() - .retrieveTitles(filter.createFilterQuery(), searchProperties.titlesSearchType(), - filter.resolveSort(), filter.getPage(), filter.getCount() - ); + .retrieveTitles(filter.toClientFilter(searchProperties), filter.toPageable()); } } @@ -208,8 +211,21 @@ private TitleResult toTitleResult(org.folio.holdingsiq.model.Title title, boolea return new TitleResult(title, includeResource); } + private CompletableFuture<org.folio.holdingsiq.model.Title> retrieveTitle(int titleId, + boolean includeRelationships, + RmApiTemplateContext context) { + var titlesService = context.getTitlesService(); + return includeRelationships + ? titlesService.retrieveTitleWithRelationships(titleId) + : titlesService.retrieveTitle(titleId); + } + private boolean shouldIncludeResources(String include) { - return INCLUDE_RESOURCES_VALUE.equalsIgnoreCase(include); + return isIncluded(include, INCLUDE_RESOURCES_VALUE); + } + + private boolean isIncluded(String include, String value) { + return ListUtils.parseByComma(include).stream().anyMatch(value::equalsIgnoreCase); } private CompletableFuture<TitleResult> loadTags(TitleResult result, diff --git a/src/main/java/org/folio/rest/model/filter/Filter.java b/src/main/java/org/folio/rest/model/filter/Filter.java index 9a4770265..0ff175767 100644 --- a/src/main/java/org/folio/rest/model/filter/Filter.java +++ b/src/main/java/org/folio/rest/model/filter/Filter.java @@ -2,11 +2,14 @@ import static org.apache.commons.collections4.CollectionUtils.isNotEmpty; import static org.apache.commons.collections4.IterableUtils.matchesAll; +import static org.folio.rest.util.RestConstants.FILTER_FREE_ACCESS_MAPPING; import static org.folio.rest.util.RestConstants.FILTER_SELECTED_MAPPING; import java.util.List; import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.StringUtils; +import org.folio.holdingsiq.model.FilterFreeAccess; +import org.folio.holdingsiq.model.FilterSelected; import org.folio.holdingsiq.model.Pageable; import org.folio.holdingsiq.model.Sort; import org.folio.repository.RecordType; @@ -54,7 +57,11 @@ && matchesAll(primary, StringUtils::isNotBlank) } // Shared utility for resolveFilterSelected (used by 3 implementations) - static String mapFilterSelected(String filterSelected) { - return filterSelected == null ? null : FILTER_SELECTED_MAPPING.get(filterSelected).getValue(); + static FilterSelected mapFilterSelected(String filterSelected) { + return filterSelected == null ? null : FILTER_SELECTED_MAPPING.get(filterSelected); + } + + static FilterFreeAccess mapFilterAccess(String filterAccess) { + return filterAccess == null ? null : FILTER_FREE_ACCESS_MAPPING.get(filterAccess); } } diff --git a/src/main/java/org/folio/rest/model/filter/FilterRules.java b/src/main/java/org/folio/rest/model/filter/FilterRules.java new file mode 100644 index 000000000..b6c20a609 --- /dev/null +++ b/src/main/java/org/folio/rest/model/filter/FilterRules.java @@ -0,0 +1,43 @@ +package org.folio.rest.model.filter; + +import static org.folio.rest.util.RestConstants.FILTER_FREE_ACCESS_MAPPING; +import static org.folio.rest.util.RestConstants.FILTER_SELECTED_MAPPING; + +import java.util.function.Predicate; +import org.apache.commons.lang3.StringUtils; +import org.folio.holdingsiq.model.SearchType; +import org.folio.holdingsiq.model.Sort; + +/** + * Validation rules shared by the package, title and resource filter validators. A missing optional parameter is + * always valid. + */ +final class FilterRules { + + private FilterRules() { + } + + static boolean isSortValid(String sort) { + return Sort.contains(sort.toUpperCase()); + } + + static boolean isQueryValid(String query) { + return query == null || !StringUtils.isBlank(query); + } + + static boolean isQueryTypeValid(String queryType) { + return optional(SearchType::contains).test(queryType); + } + + static boolean isFilterSelectedValid(String filterSelected) { + return optional(FILTER_SELECTED_MAPPING::containsKey).test(filterSelected); + } + + static boolean isFilterAccessValid(String filterAccess) { + return optional(FILTER_FREE_ACCESS_MAPPING::containsKey).test(filterAccess); + } + + static Predicate<String> optional(Predicate<String> rule) { + return value -> value == null || rule.test(value); + } +} diff --git a/src/main/java/org/folio/rest/model/filter/FilterValidator.java b/src/main/java/org/folio/rest/model/filter/FilterValidator.java index 89251eb4b..b1f477b66 100644 --- a/src/main/java/org/folio/rest/model/filter/FilterValidator.java +++ b/src/main/java/org/folio/rest/model/filter/FilterValidator.java @@ -1,26 +1,17 @@ package org.folio.rest.model.filter; +import java.util.ArrayList; +import java.util.List; import java.util.Optional; -import java.util.function.Function; -import java.util.function.Predicate; +import java.util.stream.Collectors; +import org.folio.rest.exception.QueryParamsValidationException; import org.jspecify.annotations.NonNull; -public sealed interface FilterValidator<F extends Filter> permits PackageFilterValidator { +public sealed interface FilterValidator<F extends Filter> permits PackageFilterValidator, TitleFilterValidator, + ResourceFilterValidator { void validate(@NonNull F filter); - default Optional<String> validate(@NonNull F filter, - @NonNull Function<F, String> paramExtractor, - @NonNull Predicate<String> validator, - @NonNull String errorMessage) { - var param = paramExtractor.apply(filter); - if (validator.test(param)) { - return Optional.empty(); - } else { - return Optional.of(errorMessage); - } - } - default <P> Optional<String> validate(@NonNull F filter, @NonNull FilterValidatorLogic<F, P> logic) { var param = logic.extractor().apply(filter); if (logic.validator().test(param)) { @@ -29,4 +20,21 @@ default <P> Optional<String> validate(@NonNull F filter, @NonNull FilterValidato return Optional.of(logic.errorMessage()); } } + + /** + * Runs all validators and throws with every failure message. Filters by tags or access types are not validated, + * they are resolved from the database. + */ + default void validateAll(@NonNull F filter, @NonNull List<FilterValidatorLogic<F, ?>> validators) { + if (filter.isTagsFilter() || filter.isAccessTypeFilter()) { + return; + } + var failMessages = validators.stream() + .map(logic -> validate(filter, logic)) + .flatMap(Optional::stream) + .collect(Collectors.toCollection(ArrayList::new)); + if (!failMessages.isEmpty()) { + throw new QueryParamsValidationException(failMessages); + } + } } diff --git a/src/main/java/org/folio/rest/model/filter/FilterValidators.java b/src/main/java/org/folio/rest/model/filter/FilterValidators.java index 86f920126..89632b881 100644 --- a/src/main/java/org/folio/rest/model/filter/FilterValidators.java +++ b/src/main/java/org/folio/rest/model/filter/FilterValidators.java @@ -1,42 +1,13 @@ package org.folio.rest.model.filter; -import static java.util.Arrays.asList; -import static org.apache.commons.collections4.IterableUtils.countMatches; -import static org.apache.commons.collections4.IterableUtils.matchesAny; -import static org.apache.commons.lang3.StringUtils.isNumeric; -import static org.folio.rest.util.RestConstants.FILTER_SELECTED_MAPPING; -import static org.folio.rest.util.RestConstants.SUPPORTED_PACKAGE_FILTER_TYPE_VALUES; -import static org.folio.rest.util.RestConstants.SUPPORTED_TITLE_FILTER_TYPE_VALUES; - import jakarta.validation.ValidationException; -import java.util.Collection; -import java.util.List; -import java.util.Objects; import org.apache.commons.collections4.CollectionUtils; -import org.apache.commons.lang3.StringUtils; -import org.folio.holdingsiq.model.PackageSearchField; -import org.folio.holdingsiq.model.SearchType; import org.folio.holdingsiq.model.Sort; -import org.folio.rest.util.IdParser; public final class FilterValidators { static final String INVALID_QUERY_PARAMETER_MESSAGE = "Search parameter cannot be empty"; static final String INVALID_SORT_PARAMETER_MESSAGE = "Invalid Query Parameter for sort"; - static final String INVALID_QUERY_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for qType"; - static final String INVALID_QUERY_FIELD_PARAMETER_MESSAGE = "Invalid Query Parameter for qField"; - static final String INVALID_FILTER_CUSTOM_PARAMETER_MESSAGE = - "Invalid Query Parameter for filter[custom]: only 'true' is supported"; - static final String INVALID_FILTER_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[type]"; - static final String INVALID_FILTER_SELECTED_PARAMETER_MESSAGE = - "Invalid Query Parameter for filter[selected]"; - static final String INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE = - "Invalid Query Parameter for filter[packageIds]"; - static final String CONFLICTING_KEYWORD_SEARCH_PARAMETERS_MESSAGE = "Conflicting filter parameters"; - static final String MISSING_KEYWORD_SEARCH_PARAMETERS_MESSAGE = - "All of filter[name], filter[isxn], filter[subject] and filter[publisher] cannot be missing."; - static final String INVALID_KEYWORD_SEARCH_PARAMETERS_MESSAGE = - "Value of required parameter filter[name], filter[isxn], filter[subject] or filter[publisher] is missing."; private FilterValidators() { } @@ -50,47 +21,6 @@ public static void validateProvider(ProviderFilter filter) { validateQuery(filter.getQuery()); } - public static void validatePackage(PackageRecordFilter filter) { - if (CollectionUtils.isNotEmpty(filter.getFilterTags()) - || CollectionUtils.isNotEmpty(filter.getFilterAccessType())) { - return; - } - validateSort(filter.getSort()); - validateQuery(filter.getQuery()); - validateQueryType(filter.getQueryType()); - validateQueryField(filter.getQueryField()); - validateFilterType(filter.getFilterType(), SUPPORTED_PACKAGE_FILTER_TYPE_VALUES); - validateFilterCustom(filter.getFilterCustom()); - validateFilterSelected(filter.getFilterSelected()); - validateProviderId(filter.getProviderId()); - } - - public static void validateResource(ResourceFilter filter) { - if (CollectionUtils.isNotEmpty(filter.getFilterTags()) - || CollectionUtils.isNotEmpty(filter.getFilterAccessType())) { - return; - } - validateSort(filter.getSort()); - validatePackageId(filter.getPackageId()); - validateFilterType(filter.getFilterType(), SUPPORTED_TITLE_FILTER_TYPE_VALUES); - validateFilterSelected(filter.getFilterSelected()); - validateKeywordSearch(filter.getFilterName(), filter.getFilterIsxn(), - filter.getFilterSubject(), filter.getFilterPublisher(), true); - } - - public static void validateTitle(TitleFilter filter) { - if (CollectionUtils.isNotEmpty(filter.getFilterTags()) - || CollectionUtils.isNotEmpty(filter.getFilterAccessType())) { - return; - } - validateSort(filter.getSort()); - validateFilterType(filter.getFilterType(), SUPPORTED_TITLE_FILTER_TYPE_VALUES); - validateFilterSelected(filter.getFilterSelected()); - validateFilterPackageIds(filter.getFilterPackageIds()); - validateKeywordSearch(filter.getFilterName(), filter.getFilterIsxn(), - filter.getFilterSubject(), filter.getFilterPublisher(), false); - } - private static void validateSort(String sort) { if (!Sort.contains(sort.toUpperCase())) { throw new ValidationException(INVALID_SORT_PARAMETER_MESSAGE); @@ -102,74 +32,4 @@ private static void validateQuery(String query) { throw new ValidationException(INVALID_QUERY_PARAMETER_MESSAGE); } } - - private static void validateQueryType(String queryType) { - if (!SearchType.contains(queryType.toUpperCase())) { - throw new ValidationException(INVALID_QUERY_TYPE_PARAMETER_MESSAGE); - } - } - - private static void validateQueryField(String queryField) { - if (!PackageSearchField.contains(queryField.toUpperCase())) { - throw new ValidationException(INVALID_QUERY_FIELD_PARAMETER_MESSAGE); - } - } - - private static void validateFilterType(String filterType, Collection<String> supportedValues) { - if (filterType != null && !supportedValues.contains(filterType)) { - throw new ValidationException(INVALID_FILTER_TYPE_PARAMETER_MESSAGE); - } - } - - private static void validateFilterCustom(String filterCustom) { - if (filterCustom != null && !Boolean.parseBoolean(filterCustom)) { - throw new ValidationException(INVALID_FILTER_CUSTOM_PARAMETER_MESSAGE); - } - } - - private static void validateFilterSelected(String filterSelected) { - if (filterSelected != null && !FILTER_SELECTED_MAPPING.containsKey(filterSelected)) { - throw new ValidationException(INVALID_FILTER_SELECTED_PARAMETER_MESSAGE); - } - } - - private static void validateFilterPackageIds(List<String> packageIds) { - if (packageIds != null && !packageIds.isEmpty()) { - packageIds.forEach(id -> { - if (!isNumeric(id)) { - throw new ValidationException(INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE); - } - }); - } - } - - private static void validateKeywordSearch(String filterName, String filterIsxn, - String filterSubject, String filterPublisher, - boolean allowNullFilters) { - List<String> searchParameters = asList(filterName, filterIsxn, filterSubject, filterPublisher); - - long nonNullFilters = countMatches(searchParameters, Objects::nonNull); - - if (nonNullFilters > 1) { - throw new ValidationException(CONFLICTING_KEYWORD_SEARCH_PARAMETERS_MESSAGE); - } - if (nonNullFilters < 1 && !allowNullFilters) { - throw new ValidationException(MISSING_KEYWORD_SEARCH_PARAMETERS_MESSAGE); - } - if (matchesAny(searchParameters, StringUtils.EMPTY::equals)) { - throw new ValidationException(INVALID_KEYWORD_SEARCH_PARAMETERS_MESSAGE); - } - } - - private static void validateProviderId(String providerId) { - if (providerId != null) { - IdParser.parseProviderId(providerId); - } - } - - private static void validatePackageId(String packageId) { - if (packageId != null) { - IdParser.parsePackageId(packageId); - } - } } diff --git a/src/main/java/org/folio/rest/model/filter/LegacySearchParams.java b/src/main/java/org/folio/rest/model/filter/LegacySearchParams.java new file mode 100644 index 000000000..147e98e64 --- /dev/null +++ b/src/main/java/org/folio/rest/model/filter/LegacySearchParams.java @@ -0,0 +1,31 @@ +package org.folio.rest.model.filter; + +import org.jspecify.annotations.Nullable; + +/** + * Maps the deprecated {@code filter[name|isxn|subject|publisher]} parameters onto {@code q} and {@code q[field]}. + * An explicit {@code q} always wins. Kept until the UI switches to {@code q}. + */ +public record LegacySearchParams(@Nullable String query, @Nullable String queryField) { + + public static LegacySearchParams resolve(@Nullable String query, @Nullable String queryField, + @Nullable String filterName, @Nullable String filterIsxn, + @Nullable String filterSubject, @Nullable String filterPublisher) { + if (query != null) { + return new LegacySearchParams(query, queryField); + } + if (filterName != null) { + return new LegacySearchParams(filterName, "name"); + } + if (filterIsxn != null) { + return new LegacySearchParams(filterIsxn, "isxn"); + } + if (filterSubject != null) { + return new LegacySearchParams(filterSubject, "subject"); + } + if (filterPublisher != null) { + return new LegacySearchParams(filterPublisher, "publisher"); + } + return new LegacySearchParams(null, queryField); + } +} diff --git a/src/main/java/org/folio/rest/model/filter/PackageFilterValidator.java b/src/main/java/org/folio/rest/model/filter/PackageFilterValidator.java index 2e82a7aae..c168076ab 100644 --- a/src/main/java/org/folio/rest/model/filter/PackageFilterValidator.java +++ b/src/main/java/org/folio/rest/model/filter/PackageFilterValidator.java @@ -1,26 +1,21 @@ package org.folio.rest.model.filter; +import static org.folio.rest.model.filter.FilterRules.optional; import static org.folio.rest.model.filter.FilterValidatorLogic.of; -import static org.folio.rest.util.RestConstants.FILTER_FREE_ACCESS_MAPPING; -import static org.folio.rest.util.RestConstants.FILTER_SELECTED_MAPPING; import static org.folio.rest.util.RestConstants.FILTER_VISIBILITY_MAPPING; -import static org.folio.rest.util.RestConstants.SUPPORTED_PACKAGE_FILTER_TYPE_VALUES; import java.util.List; -import java.util.Optional; import java.util.regex.Pattern; +import org.folio.holdingsiq.model.PackageFilterType; import org.folio.holdingsiq.model.PackageSearchField; -import org.folio.holdingsiq.model.SearchType; -import org.folio.holdingsiq.model.Sort; -import org.folio.rest.exception.QueryParamsValidationException; import org.jspecify.annotations.NonNull; public final class PackageFilterValidator implements FilterValidator<PackageRecordFilter> { static final String INVALID_QUERY_PARAMETER_MESSAGE = "Invalid Query Parameter for q: cannot be empty"; static final String INVALID_SORT_PARAMETER_MESSAGE = "Invalid Query Parameter for sort"; - static final String INVALID_QUERY_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for qType"; - static final String INVALID_QUERY_FIELD_PARAMETER_MESSAGE = "Invalid Query Parameter for qField"; + static final String INVALID_QUERY_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for q[type]"; + static final String INVALID_QUERY_FIELD_PARAMETER_MESSAGE = "Invalid Query Parameter for q[field]"; static final String INVALID_FILTER_CUSTOM_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[custom]: only 'true' is supported"; static final String INVALID_FILTER_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[type]"; @@ -34,21 +29,21 @@ public final class PackageFilterValidator implements FilterValidator<PackageReco private static final Pattern SUBJECT_ID_PATTERN = Pattern.compile("\\d{1,9}"); private static final List<FilterValidatorLogic<PackageRecordFilter, ?>> VALIDATORS = List.of( - of(PackageRecordFilter::getSort, PackageFilterValidator::isSortValid, INVALID_SORT_PARAMETER_MESSAGE), - of(PackageRecordFilter::getQueryType, PackageFilterValidator::isQueryTypeValid, + of(PackageRecordFilter::getSort, FilterRules::isSortValid, INVALID_SORT_PARAMETER_MESSAGE), + of(PackageRecordFilter::getQueryType, FilterRules::isQueryTypeValid, INVALID_QUERY_TYPE_PARAMETER_MESSAGE), - of(PackageRecordFilter::getQueryField, PackageFilterValidator::isQueryFieldValid, + of(PackageRecordFilter::getQueryField, optional(PackageSearchField::contains), INVALID_QUERY_FIELD_PARAMETER_MESSAGE), - of(PackageRecordFilter::getQuery, PackageFilterValidator::isQueryValid, INVALID_QUERY_PARAMETER_MESSAGE), - of(PackageRecordFilter::getFilterType, PackageFilterValidator::isFilterTypeValid, + of(PackageRecordFilter::getQuery, FilterRules::isQueryValid, INVALID_QUERY_PARAMETER_MESSAGE), + of(PackageRecordFilter::getFilterType, optional(PackageFilterType::contains), INVALID_FILTER_TYPE_PARAMETER_MESSAGE), - of(PackageRecordFilter::getFilterCustom, PackageFilterValidator::isFilterCustomValid, + of(PackageRecordFilter::getFilterCustom, optional(Boolean::parseBoolean), INVALID_FILTER_CUSTOM_PARAMETER_MESSAGE), - of(PackageRecordFilter::getFilterSelected, PackageFilterValidator::isFilterSelectedValid, + of(PackageRecordFilter::getFilterSelected, FilterRules::isFilterSelectedValid, INVALID_FILTER_SELECTED_PARAMETER_MESSAGE), - of(PackageRecordFilter::getFilterVisibility, PackageFilterValidator::isFilterVisibilityValid, + of(PackageRecordFilter::getFilterVisibility, optional(FILTER_VISIBILITY_MAPPING::containsKey), INVALID_FILTER_VISIBILITY_PARAMETER_MESSAGE), - of(PackageRecordFilter::getFilterFreeAccess, PackageFilterValidator::isFilterFreeAccessValid, + of(PackageRecordFilter::getFilterFreeAccess, FilterRules::isFilterAccessValid, INVALID_FILTER_FREE_ACCESS_PARAMETER_MESSAGE), of(PackageRecordFilter::getFilterSubject, PackageFilterValidator::isFilterSubjectValid, INVALID_FILTER_SUBJECT_PARAMETER_MESSAGE) @@ -56,17 +51,7 @@ public final class PackageFilterValidator implements FilterValidator<PackageReco @Override public void validate(@NonNull PackageRecordFilter filter) { - if (filter.isTagsFilter() || filter.isAccessTypeFilter()) { - return; - } - var failMessages = VALIDATORS.stream() - .map(logic -> validate(filter, logic)) - .filter(Optional::isPresent) - .map(Optional::get) - .toList(); - if (!failMessages.isEmpty()) { - throw new QueryParamsValidationException(failMessages); - } + validateAll(filter, VALIDATORS); } private static boolean isFilterSubjectValid(List<String> filterSubject) { @@ -75,61 +60,4 @@ private static boolean isFilterSubjectValid(List<String> filterSubject) { } return filterSubject.stream().allMatch(id -> id != null && SUBJECT_ID_PATTERN.matcher(id).matches()); } - - private static boolean isFilterFreeAccessValid(String filterFreeAccess) { - if (filterFreeAccess == null) { - return true; - } - return FILTER_FREE_ACCESS_MAPPING.containsKey(filterFreeAccess); - } - - private static boolean isFilterVisibilityValid(String filterVisibility) { - if (filterVisibility == null) { - return true; - } - return FILTER_VISIBILITY_MAPPING.containsKey(filterVisibility); - } - - private static boolean isFilterSelectedValid(String filterSelected) { - if (filterSelected == null) { - return true; - } - return FILTER_SELECTED_MAPPING.containsKey(filterSelected); - } - - private static boolean isFilterCustomValid(String filterCustom) { - if (filterCustom == null) { - return true; - } - return Boolean.parseBoolean(filterCustom); - } - - private static boolean isFilterTypeValid(String filterType) { - if (filterType == null) { - return true; - } - return SUPPORTED_PACKAGE_FILTER_TYPE_VALUES.contains(filterType); - } - - private static boolean isQueryValid(String anObject) { - return !"".equals(anObject); - } - - private static boolean isQueryFieldValid(String queryField) { - if (queryField == null) { - return true; - } - return PackageSearchField.contains(queryField); - } - - private static boolean isQueryTypeValid(String queryType) { - if (queryType == null) { - return true; - } - return SearchType.contains(queryType); - } - - private static boolean isSortValid(String sort) { - return Sort.contains(sort.toUpperCase()); - } } diff --git a/src/main/java/org/folio/rest/model/filter/PackageRecordFilter.java b/src/main/java/org/folio/rest/model/filter/PackageRecordFilter.java index 73774a18f..e18819e56 100644 --- a/src/main/java/org/folio/rest/model/filter/PackageRecordFilter.java +++ b/src/main/java/org/folio/rest/model/filter/PackageRecordFilter.java @@ -8,9 +8,9 @@ import java.util.Optional; import lombok.Builder; import lombok.Value; +import org.folio.holdingsiq.model.FilterFreeAccess; +import org.folio.holdingsiq.model.FilterSelected; import org.folio.holdingsiq.model.PackageFilter; -import org.folio.holdingsiq.model.PackageFilterFreeAccess; -import org.folio.holdingsiq.model.PackageFilterSelected; import org.folio.holdingsiq.model.PackageFilterType; import org.folio.holdingsiq.model.PackageFilterVisibility; import org.folio.holdingsiq.model.PackageSearchField; @@ -65,7 +65,7 @@ public Optional<PackageSearchField> getPackageSearchField() { return Optional.ofNullable(queryField).map(PackageSearchField::fromValue); } - public Optional<PackageFilterSelected> getPackageFilterSelected() { + public Optional<FilterSelected> getPackageFilterSelected() { return Optional.ofNullable(filterSelected).map(RestConstants.FILTER_SELECTED_MAPPING::get); } @@ -73,7 +73,7 @@ public Optional<PackageFilterType> getPackageFilterType() { return Optional.ofNullable(filterType).map(PackageFilterType::fromValue); } - public Optional<PackageFilterFreeAccess> getPackageFilterFreeAccess() { + public Optional<FilterFreeAccess> getPackageFilterFreeAccess() { return Optional.ofNullable(filterFreeAccess).map(RestConstants.FILTER_FREE_ACCESS_MAPPING::get); } diff --git a/src/main/java/org/folio/rest/model/filter/ResourceFilter.java b/src/main/java/org/folio/rest/model/filter/ResourceFilter.java index 086eda3bc..9c5559daa 100644 --- a/src/main/java/org/folio/rest/model/filter/ResourceFilter.java +++ b/src/main/java/org/folio/rest/model/filter/ResourceFilter.java @@ -5,8 +5,9 @@ import java.util.List; import lombok.Builder; import lombok.Value; -import org.folio.holdingsiq.model.FilterQuery; +import org.folio.holdingsiq.model.FilterSelected; import org.folio.holdingsiq.model.PackageId; +import org.folio.holdingsiq.model.TitleFilterType; import org.folio.repository.RecordType; import org.folio.rest.util.IdParser; @@ -14,13 +15,15 @@ @Builder public class ResourceFilter implements Filter { + private static final FilterValidator<ResourceFilter> VALIDATOR = new ResourceFilterValidator(); + String packageId; + String query; + String queryField; + String filterSelected; String filterType; - String filterName; - String filterIsxn; - String filterSubject; - String filterPublisher; + String filterAccess; String sort; int page; int count; @@ -34,26 +37,26 @@ public RecordType getRecordType() { @Override public List<String> searchCriteriaValues() { - return asList(filterIsxn, filterName, filterPublisher, filterSubject, filterSelected); + return asList(query, filterSelected); } public PackageId parsePackageId() { return IdParser.parsePackageId(packageId); } - public String resolveFilterSelected() { + public FilterSelected resolveFilterSelected() { return Filter.mapFilterSelected(filterSelected); } - public FilterQuery createFilterQuery() { - return FilterQuery.builder() - .type(filterType) - .name(filterName) - .isxn(filterIsxn) - .subject(filterSubject) - .publisher(filterPublisher) - .selected(resolveFilterSelected()) - .build(); + public org.folio.holdingsiq.model.ResourceFilter toClientFilter() { + var search = TitleSearch.of(query, queryField); + return org.folio.holdingsiq.model.ResourceFilter.builder() + .query(search.query()) + .searchField(search.searchField()) + .filterSelected(resolveFilterSelected()) + .filterType(TitleFilterType.fromValue(filterType)) + .filterPackageFreeAccess(Filter.mapFilterAccess(filterAccess)) + .build(); } public static ResourceFilterBuilder builder() { @@ -61,7 +64,7 @@ public static ResourceFilterBuilder builder() { @Override public ResourceFilter build() { ResourceFilter filter = super.build(); - FilterValidators.validateResource(filter); + VALIDATOR.validate(filter); return filter; } }; diff --git a/src/main/java/org/folio/rest/model/filter/ResourceFilterValidator.java b/src/main/java/org/folio/rest/model/filter/ResourceFilterValidator.java new file mode 100644 index 000000000..e76148ca0 --- /dev/null +++ b/src/main/java/org/folio/rest/model/filter/ResourceFilterValidator.java @@ -0,0 +1,53 @@ +package org.folio.rest.model.filter; + +import static org.folio.rest.model.filter.FilterRules.optional; +import static org.folio.rest.model.filter.FilterValidatorLogic.of; + +import java.util.List; +import org.folio.holdingsiq.model.TitleFilterType; +import org.folio.rest.util.IdParser; +import org.jspecify.annotations.NonNull; + +public final class ResourceFilterValidator implements FilterValidator<ResourceFilter> { + + static final String INVALID_QUERY_PARAMETER_MESSAGE = "Invalid Query Parameter for q: cannot be empty"; + static final String INVALID_SORT_PARAMETER_MESSAGE = "Invalid Query Parameter for sort"; + static final String INVALID_QUERY_FIELD_PARAMETER_MESSAGE = "Invalid Query Parameter for q[field]"; + static final String INVALID_FILTER_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[type]"; + static final String INVALID_FILTER_SELECTED_PARAMETER_MESSAGE = + "Invalid Query Parameter for filter[selected]"; + static final String INVALID_FILTER_ACCESS_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[access]"; + static final String INVALID_PACKAGE_ID_PARAMETER_MESSAGE = "Invalid package id"; + + private static final List<FilterValidatorLogic<ResourceFilter, ?>> VALIDATORS = List.of( + of(ResourceFilter::getSort, FilterRules::isSortValid, INVALID_SORT_PARAMETER_MESSAGE), + of(ResourceFilter::getQueryField, optional(TitleSearch.FIELDS::contains), + INVALID_QUERY_FIELD_PARAMETER_MESSAGE), + of(ResourceFilter::getQuery, FilterRules::isQueryValid, INVALID_QUERY_PARAMETER_MESSAGE), + of(ResourceFilter::getFilterType, optional(TitleFilterType::contains), + INVALID_FILTER_TYPE_PARAMETER_MESSAGE), + of(ResourceFilter::getFilterSelected, FilterRules::isFilterSelectedValid, + INVALID_FILTER_SELECTED_PARAMETER_MESSAGE), + of(ResourceFilter::getFilterAccess, FilterRules::isFilterAccessValid, + INVALID_FILTER_ACCESS_PARAMETER_MESSAGE), + of(ResourceFilter::getPackageId, ResourceFilterValidator::isPackageIdValid, + INVALID_PACKAGE_ID_PARAMETER_MESSAGE) + ); + + @Override + public void validate(@NonNull ResourceFilter filter) { + validateAll(filter, VALIDATORS); + } + + private static boolean isPackageIdValid(String packageId) { + if (packageId == null) { + return true; + } + try { + IdParser.parsePackageId(packageId); + return true; + } catch (RuntimeException e) { + return false; + } + } +} diff --git a/src/main/java/org/folio/rest/model/filter/TitleFilter.java b/src/main/java/org/folio/rest/model/filter/TitleFilter.java index 70c3c2592..2d3a19cc0 100644 --- a/src/main/java/org/folio/rest/model/filter/TitleFilter.java +++ b/src/main/java/org/folio/rest/model/filter/TitleFilter.java @@ -3,21 +3,28 @@ import static java.util.Arrays.asList; import java.util.List; +import java.util.Optional; import lombok.Builder; import lombok.Value; -import org.folio.holdingsiq.model.FilterQuery; +import org.folio.holdingsiq.model.FilterSelected; +import org.folio.holdingsiq.model.SearchType; +import org.folio.holdingsiq.model.TitleFilterType; +import org.folio.properties.common.SearchProperties; import org.folio.repository.RecordType; @Value @Builder public class TitleFilter implements Filter { + private static final FilterValidator<TitleFilter> VALIDATOR = new TitleFilterValidator(); + + String query; + String queryField; + String queryType; + String filterSelected; String filterType; - String filterName; - String filterIsxn; - String filterSubject; - String filterPublisher; + String filterAccess; List<String> filterPackageIds; String sort; int page; @@ -32,10 +39,10 @@ public RecordType getRecordType() { @Override public List<String> searchCriteriaValues() { - return asList(filterIsxn, filterName, filterPublisher, filterSubject, filterSelected); + return asList(query, filterSelected); } - public String resolveFilterSelected() { + public FilterSelected resolveFilterSelected() { return Filter.mapFilterSelected(filterSelected); } @@ -45,16 +52,21 @@ public List<Integer> resolveFilterPackageIds() { .toList(); } - public FilterQuery createFilterQuery() { - return FilterQuery.builder() - .type(filterType) - .name(filterName) - .isxn(filterIsxn) - .subject(filterSubject) - .publisher(filterPublisher) - .selected(resolveFilterSelected()) - .packageIds(resolveFilterPackageIds()) - .build(); + public Optional<SearchType> getSearchType() { + return Optional.ofNullable(queryType).map(SearchType::fromValue); + } + + public org.folio.holdingsiq.model.TitleFilter toClientFilter(SearchProperties searchProperties) { + var search = TitleSearch.of(query, queryField); + return org.folio.holdingsiq.model.TitleFilter.builder() + .query(search.query()) + .searchField(search.searchField()) + .searchType(getSearchType().orElse(SearchType.fromValue(searchProperties.titlesSearchType()))) + .filterSelected(resolveFilterSelected()) + .filterType(TitleFilterType.fromValue(filterType)) + .filterPackageIds(resolveFilterPackageIds()) + .filterPackageFreeAccess(Filter.mapFilterAccess(filterAccess)) + .build(); } public static TitleFilterBuilder builder() { @@ -62,7 +74,7 @@ public static TitleFilterBuilder builder() { @Override public TitleFilter build() { TitleFilter filter = super.build(); - FilterValidators.validateTitle(filter); + VALIDATOR.validate(filter); return filter; } }; diff --git a/src/main/java/org/folio/rest/model/filter/TitleFilterValidator.java b/src/main/java/org/folio/rest/model/filter/TitleFilterValidator.java new file mode 100644 index 000000000..77fc99e2a --- /dev/null +++ b/src/main/java/org/folio/rest/model/filter/TitleFilterValidator.java @@ -0,0 +1,58 @@ +package org.folio.rest.model.filter; + +import static org.folio.rest.model.filter.FilterRules.optional; +import static org.folio.rest.model.filter.FilterValidatorLogic.of; + +import java.util.List; +import java.util.Objects; +import org.apache.commons.lang3.StringUtils; +import org.apache.commons.lang3.math.NumberUtils; +import org.folio.holdingsiq.model.TitleFilterType; +import org.jspecify.annotations.NonNull; + +public final class TitleFilterValidator implements FilterValidator<TitleFilter> { + + static final String INVALID_QUERY_PARAMETER_MESSAGE = "Invalid Query Parameter for q: cannot be empty"; + static final String MISSING_QUERY_PARAMETER_MESSAGE = "Invalid Query Parameter for q: is required"; + static final String INVALID_SORT_PARAMETER_MESSAGE = "Invalid Query Parameter for sort"; + static final String INVALID_QUERY_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for q[type]"; + static final String INVALID_QUERY_FIELD_PARAMETER_MESSAGE = "Invalid Query Parameter for q[field]"; + static final String INVALID_FILTER_TYPE_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[type]"; + static final String INVALID_FILTER_SELECTED_PARAMETER_MESSAGE = + "Invalid Query Parameter for filter[selected]"; + static final String INVALID_FILTER_ACCESS_PARAMETER_MESSAGE = "Invalid Query Parameter for filter[access]"; + static final String INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE = + "Invalid Query Parameter for filter[packageIds]"; + + private static final List<FilterValidatorLogic<TitleFilter, ?>> VALIDATORS = List.of( + of(TitleFilter::getSort, FilterRules::isSortValid, INVALID_SORT_PARAMETER_MESSAGE), + of(TitleFilter::getQueryType, FilterRules::isQueryTypeValid, + INVALID_QUERY_TYPE_PARAMETER_MESSAGE), + of(TitleFilter::getQueryField, optional(TitleSearch.FIELDS::contains), + INVALID_QUERY_FIELD_PARAMETER_MESSAGE), + // HoldingsIQ rejects a titles search without a search term + of(TitleFilter::getQuery, Objects::nonNull, MISSING_QUERY_PARAMETER_MESSAGE), + of(TitleFilter::getQuery, FilterRules::isQueryValid, INVALID_QUERY_PARAMETER_MESSAGE), + of(TitleFilter::getFilterType, optional(TitleFilterType::contains), + INVALID_FILTER_TYPE_PARAMETER_MESSAGE), + of(TitleFilter::getFilterSelected, FilterRules::isFilterSelectedValid, + INVALID_FILTER_SELECTED_PARAMETER_MESSAGE), + of(TitleFilter::getFilterAccess, FilterRules::isFilterAccessValid, + INVALID_FILTER_ACCESS_PARAMETER_MESSAGE), + of(TitleFilter::getFilterPackageIds, TitleFilterValidator::isFilterPackageIdsValid, + INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE) + ); + + @Override + public void validate(@NonNull TitleFilter filter) { + validateAll(filter, VALIDATORS); + } + + private static boolean isFilterPackageIdsValid(List<String> packageIds) { + return packageIds == null || packageIds.stream().allMatch(TitleFilterValidator::isIntegerValue); + } + + private static boolean isIntegerValue(String value) { + return StringUtils.isNumeric(value) && NumberUtils.toInt(value, -1) >= 0; + } +} diff --git a/src/main/java/org/folio/rest/model/filter/TitleSearch.java b/src/main/java/org/folio/rest/model/filter/TitleSearch.java new file mode 100644 index 000000000..012181530 --- /dev/null +++ b/src/main/java/org/folio/rest/model/filter/TitleSearch.java @@ -0,0 +1,35 @@ +package org.folio.rest.model.filter; + +import java.util.Set; +import org.folio.holdingsiq.model.TitleSearchField; +import org.jspecify.annotations.Nullable; + +/** + * Search term and field resolved from the {@code q} and {@code q[field]} parameters; the field is one of + * {@code name}, {@code isxn}, {@code subject}, {@code publisher} or {@code zdbid}; a missing or unknown field falls + * back to {@code name}. + */ +record TitleSearch(@Nullable String query, @Nullable TitleSearchField searchField) { + + static final Set<String> FIELDS = Set.of("name", "isxn", "subject", "publisher", "zdbid"); + + static TitleSearch of(@Nullable String query, @Nullable String field) { + if (query == null) { + return new TitleSearch(null, null); + } + return new TitleSearch(query, resolveSearchField(field)); + } + + private static TitleSearchField resolveSearchField(@Nullable String field) { + if (field == null) { + return TitleSearchField.TITLE_NAME; + } + return switch (field) { + case "isxn" -> TitleSearchField.ISXN; + case "subject" -> TitleSearchField.SUBJECT; + case "publisher" -> TitleSearchField.PUBLISHER; + case "zdbid" -> TitleSearchField.ZDBID; + default -> TitleSearchField.TITLE_NAME; + }; + } +} diff --git a/src/main/java/org/folio/rest/util/IdParser.java b/src/main/java/org/folio/rest/util/IdParser.java index 1bacef21f..df314c741 100644 --- a/src/main/java/org/folio/rest/util/IdParser.java +++ b/src/main/java/org/folio/rest/util/IdParser.java @@ -9,6 +9,7 @@ import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.PackageId; import org.folio.holdingsiq.model.Packages; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.ResourceId; import org.folio.repository.holdings.DbHoldingInfo; import org.folio.repository.holdings.HoldingsId; @@ -64,6 +65,10 @@ public static String getResourceId(CustomerResources resource) { return concat(resource.getVendorId(), resource.getPackageId(), resource.getTitleId()); } + public static String getResourceId(Resource resource) { + return concat(resource.getVendorId(), resource.getPackageId(), resource.getTitleId()); + } + public static String getResourceId(HoldingsId holding) { return concat(holding.vendorId(), Long.parseLong(holding.packageId()), Long.parseLong(holding.titleId())); } diff --git a/src/main/java/org/folio/rest/util/RestConstants.java b/src/main/java/org/folio/rest/util/RestConstants.java index 1aabefabb..d5ccfa40a 100644 --- a/src/main/java/org/folio/rest/util/RestConstants.java +++ b/src/main/java/org/folio/rest/util/RestConstants.java @@ -1,9 +1,8 @@ package org.folio.rest.util; -import java.util.List; import java.util.Map; -import org.folio.holdingsiq.model.PackageFilterFreeAccess; -import org.folio.holdingsiq.model.PackageFilterSelected; +import org.folio.holdingsiq.model.FilterFreeAccess; +import org.folio.holdingsiq.model.FilterSelected; import org.folio.holdingsiq.model.PackageFilterVisibility; import org.folio.rest.jaxrs.model.JsonAPI; @@ -22,17 +21,13 @@ public final class RestConstants { public static final String TITLE_RECTYPE = "title"; public static final String RESOURCE_RECTYPE = "resource"; - public static final Map<String, PackageFilterSelected> FILTER_SELECTED_MAPPING = + public static final Map<String, FilterSelected> FILTER_SELECTED_MAPPING = Map.of( - "true", PackageFilterSelected.SELECTED, - "false", PackageFilterSelected.NOT_SELECTED, - "ebsco", PackageFilterSelected.ORDERED_THROUGH_EBSCO + "true", FilterSelected.SELECTED, + "false", FilterSelected.NOT_SELECTED, + "ebsco", FilterSelected.ORDERED_THROUGH_EBSCO ); - public static final List<String> SUPPORTED_PACKAGE_FILTER_TYPE_VALUES = - List.of("all", "aggregatedfulltext", "abstractandindex", "ebook", "ejournal", "print", "unknown", - "onlinereference", "streamingmedia", "mixedcontent"); - public static final Map<String, PackageFilterVisibility> FILTER_VISIBILITY_MAPPING = Map.of("visibleSomewhere", PackageFilterVisibility.VISIBLE_SOMEWHERE, "visibleInPF", PackageFilterVisibility.VISIBLE_IN_PF, @@ -43,14 +38,9 @@ public final class RestConstants { "hiddenInFTF", PackageFilterVisibility.HIDDEN_IN_FTF, "hiddenInMARC", PackageFilterVisibility.EXCLUDED_FROM_MARC); - public static final Map<String, PackageFilterFreeAccess> FILTER_FREE_ACCESS_MAPPING = - Map.of("public", PackageFilterFreeAccess.TRUE, - "controlled", PackageFilterFreeAccess.FALSE); - - public static final List<String> SUPPORTED_TITLE_FILTER_TYPE_VALUES = - List.of("audiobook", "book", "bookseries", "database", "journal", "newsletter", "newspaper", "proceedings", - "report", - "streamingaudio", "streamingvideo", "thesisdissertation", "website", "unspecified"); + public static final Map<String, FilterFreeAccess> FILTER_FREE_ACCESS_MAPPING = + Map.of("public", FilterFreeAccess.TRUE, + "controlled", FilterFreeAccess.FALSE); private RestConstants() { } diff --git a/src/main/java/org/folio/rest/util/template/RmApiTemplateContextBuilder.java b/src/main/java/org/folio/rest/util/template/RmApiTemplateContextBuilder.java index 1515aedbc..ae943a9c0 100644 --- a/src/main/java/org/folio/rest/util/template/RmApiTemplateContextBuilder.java +++ b/src/main/java/org/folio/rest/util/template/RmApiTemplateContextBuilder.java @@ -5,13 +5,13 @@ import org.folio.holdingsiq.model.Configuration; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.RequestContext; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.VendorById; import org.folio.holdingsiq.service.HoldingsIQService; import org.folio.holdingsiq.service.LoadService; import org.folio.holdingsiq.service.impl.HoldingsIQServiceImpl; import org.folio.holdingsiq.service.impl.LoadServiceImpl; -import org.folio.properties.common.SearchProperties; import org.folio.rest.jaxrs.model.KbCredentials; import org.folio.rmapi.PackageServiceImpl; import org.folio.rmapi.ProvidersServiceImpl; @@ -41,11 +41,9 @@ public class RmApiTemplateContextBuilder { @Autowired private VertxCache<PackageCacheKey, PackageData> packageCache; @Autowired - private VertxCache<ResourceCacheKey, Title> resourceCache; + private VertxCache<ResourceCacheKey, Resource> resourceCache; @Autowired private VertxCache<TitleCacheKey, Title> titleCache; - @Autowired - private SearchProperties searchProperties; @Autowired private Vertx vertx; @@ -72,12 +70,12 @@ public RmApiTemplateContext build() { final ProvidersServiceImpl providersService = new ProvidersServiceImpl(configuration, vertx, tenant, holdingsService, vendorCache); final PackageServiceImpl packagesService = - new PackageServiceImpl(configuration, vertx, tenant, providersService, titlesService, packageCache, - searchProperties); + new PackageServiceImpl(configuration, vertx, tenant, providersService, packageCache); final ResourcesServiceImpl resourcesService = new ResourcesServiceImpl(configuration, vertx, tenant, providersService, packagesService, resourceCache); final LoadService loadService = new LoadServiceImpl(configuration, vertx); providersService.setPackagesService(packagesService); + packagesService.setResourcesService(resourcesService); return RmApiTemplateContext.builder() .configuration(configuration) diff --git a/src/main/java/org/folio/rest/validator/ResourcePostValidator.java b/src/main/java/org/folio/rest/validator/ResourcePostValidator.java index e3418126a..ee343a22e 100644 --- a/src/main/java/org/folio/rest/validator/ResourcePostValidator.java +++ b/src/main/java/org/folio/rest/validator/ResourcePostValidator.java @@ -3,8 +3,6 @@ import org.apache.commons.lang3.BooleanUtils; import org.apache.commons.lang3.StringUtils; import org.folio.holdingsiq.model.PackageData; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.ResourcePostDataAttributes; import org.folio.rest.jaxrs.model.ResourcePostRequest; @@ -23,18 +21,13 @@ public void validate(ResourcePostRequest request) { ValidatorUtil.checkIsNotBlank("Title Id", attributes.getTitleId()); } - public void validateRelatedObjects(PackageData packageData, Title title, Titles existingTitles) { + public void validateRelatedObjects(PackageData packageData, boolean titleInPackage) { if (BooleanUtils.isNotTrue(packageData.getIsCustom())) { throw new InputValidationException("Invalid PackageId", "Packageid Cannot associate Title with a managed Package"); } - if (titleExists(title, existingTitles)) { + if (titleInPackage) { throw new InputValidationException("Invalid Title", "Package already associated with Title"); } } - - private boolean titleExists(Title title, Titles existingTitles) { - return existingTitles.getTitleList().stream() - .anyMatch(existingTitle -> existingTitle.getTitleId().equals(title.getTitleId())); - } } diff --git a/src/main/java/org/folio/rest/validator/ResourcePutBodyValidator.java b/src/main/java/org/folio/rest/validator/ResourcePutBodyValidator.java index 179db86e4..8ff49ec9d 100644 --- a/src/main/java/org/folio/rest/validator/ResourcePutBodyValidator.java +++ b/src/main/java/org/folio/rest/validator/ResourcePutBodyValidator.java @@ -6,6 +6,7 @@ import java.util.List; import lombok.RequiredArgsConstructor; +import org.apache.commons.collections4.CollectionUtils; import org.folio.properties.customlabels.CustomLabelsProperties; import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.Coverage; @@ -74,12 +75,12 @@ private void validateUserDefinedFields(ResourcePutDataAttributes attributes) { private void validateManagedResourceIfNotSelected(ResourcePutDataAttributes attributes, boolean isTitleCustom, String cvgStmt) { - Boolean isHidden = attributes.getVisibilityData() != null ? attributes.getVisibilityData().getIsHidden() : null; + boolean isHidden = isHidden(attributes); EmbargoUnit embargoUnit = attributes.getCustomEmbargoPeriod() != null ? attributes.getCustomEmbargoPeriod().getEmbargoUnit() : null; List<Coverage> customCoverages = attributes.getCustomCoverages(); if (!isTitleCustom && (isNotEmpty(cvgStmt) || nonNull(embargoUnit) - || nonNull(isHidden) && isHidden + || isHidden || nonNull(customCoverages) && !customCoverages.isEmpty() || isNotEmpty(attributes.getUserDefinedField1()) || isNotEmpty(attributes.getUserDefinedField2()) @@ -89,5 +90,11 @@ private void validateManagedResourceIfNotSelected(ResourcePutDataAttributes attr throw new InputValidationException(INVALID_IS_SELECTED_TITLE, INVALID_IS_SELECTED_DETAILS); } } -} + private boolean isHidden(ResourcePutDataAttributes attributes) { + if (CollectionUtils.isNotEmpty(attributes.getVisibility())) { + return attributes.getVisibility().stream().anyMatch(visibility -> Boolean.TRUE.equals(visibility.getHidden())); + } + return attributes.getVisibilityData() != null && Boolean.TRUE.equals(attributes.getVisibilityData().getIsHidden()); + } +} diff --git a/src/main/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidator.java b/src/main/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidator.java index 5b8297f26..3c5ebada3 100644 --- a/src/main/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidator.java +++ b/src/main/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidator.java @@ -4,7 +4,7 @@ import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.PackagePutDataAttributes; import org.folio.rest.jaxrs.model.PackagePutRequest; -import org.folio.rest.jaxrs.model.PackageVisibility; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.rest.validator.ValidatorUtil; import org.springframework.stereotype.Component; @@ -46,7 +46,7 @@ public void validate(PackagePutRequest request) { } private void validateNotSelected(PackagePutDataAttributes attributes, Boolean allowKbToAddTitles, - List<PackageVisibility> visibility, + List<Visibility> visibility, String beginCoverage, String endCoverage, String value) { Boolean isSelected = attributes.getIsSelected(); if (isSelected == null || !isSelected) { diff --git a/src/main/java/org/folio/rmapi/PackageServiceImpl.java b/src/main/java/org/folio/rmapi/PackageServiceImpl.java index 37bde47ed..d97653a5b 100644 --- a/src/main/java/org/folio/rmapi/PackageServiceImpl.java +++ b/src/main/java/org/folio/rmapi/PackageServiceImpl.java @@ -19,15 +19,16 @@ import lombok.extern.log4j.Log4j2; import org.folio.cache.VertxCache; import org.folio.holdingsiq.model.Configuration; -import org.folio.holdingsiq.model.FilterQuery; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.PackageId; import org.folio.holdingsiq.model.Packages; +import org.folio.holdingsiq.model.Pageable; +import org.folio.holdingsiq.model.ResourceFilter; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.model.Sort; -import org.folio.holdingsiq.model.Titles; -import org.folio.holdingsiq.service.TitlesHoldingsIQService; +import org.folio.holdingsiq.service.ResourcesHoldingsIQService; +import org.folio.holdingsiq.service.exception.ResourceNotFoundException; import org.folio.holdingsiq.service.impl.PackagesHoldingsIQServiceImpl; -import org.folio.properties.common.SearchProperties; import org.folio.rest.util.IdParser; import org.folio.rmapi.cache.PackageCacheKey; import org.folio.rmapi.result.PackageBulkResult; @@ -39,24 +40,41 @@ public class PackageServiceImpl extends PackagesHoldingsIQServiceImpl { private static final String INCLUDE_PROVIDER_VALUE = "provider"; private static final String INCLUDE_RESOURCES_VALUE = "resources"; + private static final Pageable INCLUDED_RESOURCES_PAGE = new Pageable(1, 25, Sort.NAME); + private final ProvidersServiceImpl providerService; - private final TitlesHoldingsIQService titlesService; private final VertxCache<PackageCacheKey, PackageData> packageCache; - private final SearchProperties searchProperties; private final Configuration configuration; private final String tenantId; + private ResourcesHoldingsIQService resourcesService; public PackageServiceImpl(Configuration config, Vertx vertx, String tenantId, ProvidersServiceImpl providerService, - TitlesHoldingsIQService titlesService, - VertxCache<PackageCacheKey, PackageData> packageCache, - SearchProperties searchProperties) { + VertxCache<PackageCacheKey, PackageData> packageCache) { super(config, vertx); this.providerService = providerService; - this.titlesService = titlesService; this.packageCache = packageCache; this.tenantId = tenantId; this.configuration = config; - this.searchProperties = searchProperties; + } + + public void setResourcesService(ResourcesHoldingsIQService resourcesService) { + this.resourcesService = resourcesService; + } + + /** + * Retrieves the package and checks it belongs to the requested provider: HoldingsIQ v2 addresses a package by its + * id alone, so a mismatched provider id would otherwise be ignored. + */ + public CompletableFuture<PackageData> retrievePackage(PackageId packageId) { + return retrievePackage(packageId.packageIdPart()).thenApply(packageData -> { + var vendorId = packageData.getVendorId(); + if (vendorId != null && vendorId != packageId.providerIdPart()) { + throw new ResourceNotFoundException( + "Package " + packageId.packageIdPart() + " not found for provider " + packageId.providerIdPart(), + 404, "Not Found", null, null); + } + return packageData; + }); } public CompletableFuture<PackageResult> retrievePackage(PackageId packageId, List<String> includedObjects) { @@ -69,15 +87,15 @@ public CompletableFuture<PackageResult> retrievePackage(PackageId packageId, Lis if (useCache) { packageFuture = retrievePackageWithCache(packageId); } else { - packageFuture = retrievePackage(packageId.packageIdPart()); + packageFuture = retrievePackage(packageId); } - CompletableFuture<Titles> titlesFuture; + CompletableFuture<Resources> resourcesFuture; if (includedObjects.contains(INCLUDE_RESOURCES_VALUE)) { - titlesFuture = titlesService.retrieveTitles(packageId.providerIdPart(), packageId.packageIdPart(), - FilterQuery.builder().build(), searchProperties.titlesSearchType(), Sort.NAME, 1, 25); + resourcesFuture = resourcesService.retrieveResources(packageId.packageIdPart(), ResourceFilter.builder().build(), + INCLUDED_RESOURCES_PAGE); } else { - titlesFuture = completedFuture(null); + resourcesFuture = completedFuture(null); } CompletableFuture<VendorResult> vendorFuture; @@ -87,9 +105,9 @@ public CompletableFuture<PackageResult> retrievePackage(PackageId packageId, Lis vendorFuture = completedFuture(new VendorResult(null, null)); } - return CompletableFuture.allOf(packageFuture, titlesFuture, vendorFuture) - .thenCompose(o -> - completedFuture(new PackageResult(packageFuture.join(), vendorFuture.join().getVendor(), titlesFuture.join()))); + return CompletableFuture.allOf(packageFuture, resourcesFuture, vendorFuture) + .thenCompose(o -> completedFuture( + new PackageResult(packageFuture.join(), vendorFuture.join().getVendor(), resourcesFuture.join()))); } public CompletableFuture<Packages> retrievePackages(List<PackageId> packageIds) { @@ -156,7 +174,7 @@ private CompletableFuture<PackageData> retrievePackageWithCache(PackageId packag .rmapiConfiguration(configuration) .tenant(tenantId) .build(); - return packageCache.getValueOrLoad(cacheKey, () -> retrievePackage(packageId.packageIdPart())); + return packageCache.getValueOrLoad(cacheKey, () -> retrievePackage(packageId)); } private interface Result<R, F> { diff --git a/src/main/java/org/folio/rmapi/ResourceMapper.java b/src/main/java/org/folio/rmapi/ResourceMapper.java new file mode 100644 index 000000000..72fa78b45 --- /dev/null +++ b/src/main/java/org/folio/rmapi/ResourceMapper.java @@ -0,0 +1,117 @@ +package org.folio.rmapi; + +import java.util.ArrayList; +import java.util.List; +import org.folio.holdingsiq.model.CustomerResources; +import org.folio.holdingsiq.model.Resource; +import org.folio.holdingsiq.model.Title; + +/** + * Maps between the flat v2 {@link Resource} (a title within one package) and the nested {@link Title} with its + * {@link CustomerResources}, for the places where nested titles and resources meet. + */ +public final class ResourceMapper { + + private ResourceMapper() { + } + + /** + * Builds the flat resource for one of the title's customer resources. Title relationships are not copied: + * they belong to the title, not to each of its resources. + */ + @SuppressWarnings("checkstyle:MethodLength") + public static Resource toResource(Title title, CustomerResources customerResource) { + return Resource.builder() + .titleId(title.getTitleId()) + .titleName(title.getTitleName()) + .publisherName(title.getPublisherName()) + .identifiersList(title.getIdentifiersList()) + .subjectsList(title.getSubjectsList()) + .isTitleCustom(title.getIsTitleCustom()) + .alternateTitleList(title.getAlternateTitleList()) + .pubType(title.getPubType()) + .description(title.getDescription()) + .edition(title.getEdition()) + .isPeerReviewed(title.getIsPeerReviewed()) + .contributorsList(title.getContributorsList()) + .packageId(customerResource.getPackageId()) + .packageName(customerResource.getPackageName()) + .packageType(customerResource.getPackageType()) + .proxy(customerResource.getProxy()) + .isPrimaryPackage(customerResource.getIsPrimaryPackage()) + .isPackageCustom(customerResource.getIsPackageCustom()) + .vendorId(customerResource.getVendorId()) + .vendorName(customerResource.getVendorName()) + .locationId(customerResource.getLocationId()) + .isSelected(customerResource.getIsSelected()) + .isOrderedThroughEbsco(customerResource.getIsOrderedThroughEbsco()) + .isTokenNeeded(customerResource.getIsTokenNeeded()) + .kbartExcluded(customerResource.getKbartExcluded()) + .kbartCoverageOwnership(customerResource.getKbartCoverageOwnership()) + .visibilityDetails(customerResource.getVisibilityDetails()) + .managedCoverageList(customerResource.getManagedCoverageList()) + .customCoverageList(customerResource.getCustomCoverageList()) + .coverageStatement(customerResource.getCoverageStatement()) + .managedEmbargoPeriod(customerResource.getManagedEmbargoPeriod()) + .customEmbargoPeriod(customerResource.getCustomEmbargoPeriod()) + .url(customerResource.getUrl()) + .consortia(customerResource.getConsortia()) + .userDefinedFields(customerResource.getUserDefinedFields()) + .build(); + } + + /** + * Builds the package-specific part of the resource. + */ + @SuppressWarnings("checkstyle:MethodLength") + public static CustomerResources toCustomerResources(Resource resource) { + return CustomerResources.builder() + .titleId(resource.getTitleId()) + .packageId(resource.getPackageId()) + .packageName(resource.getPackageName()) + .packageType(resource.getPackageType()) + .proxy(resource.getProxy()) + .isPackageCustom(resource.getIsPackageCustom()) + .vendorId(resource.getVendorId()) + .vendorName(resource.getVendorName()) + .locationId(resource.getLocationId()) + .isSelected(resource.getIsSelected()) + .isOrderedThroughEbsco(resource.getIsOrderedThroughEbsco()) + .isTokenNeeded(resource.getIsTokenNeeded()) + .visibilityDetails(resource.getVisibilityDetails()) + .managedCoverageList(resource.getManagedCoverageList()) + .customCoverageList(resource.getCustomCoverageList()) + .coverageStatement(resource.getCoverageStatement()) + .managedEmbargoPeriod(resource.getManagedEmbargoPeriod()) + .customEmbargoPeriod(resource.getCustomEmbargoPeriod()) + .url(resource.getUrl()) + .isPrimaryPackage(resource.getIsPrimaryPackage()) + .kbartExcluded(resource.getKbartExcluded()) + .kbartCoverageOwnership(resource.getKbartCoverageOwnership()) + .consortia(resource.getConsortia()) + .userDefinedFields(resource.getUserDefinedFields()) + .build(); + } + + /** + * Builds a title that contains only this resource's package in its customer resources. + */ + public static Title toTitle(Resource resource) { + return Title.builder() + .titleId(resource.getTitleId()) + .titleName(resource.getTitleName()) + .publisherName(resource.getPublisherName()) + .identifiersList(resource.getIdentifiersList()) + .subjectsList(resource.getSubjectsList()) + .isTitleCustom(resource.getIsTitleCustom()) + .alternateTitleList(resource.getAlternateTitleList()) + .pubType(resource.getPubType()) + .customerResourcesList(new ArrayList<>(List.of(toCustomerResources(resource)))) + .description(resource.getDescription()) + .edition(resource.getEdition()) + .isPeerReviewed(resource.getIsPeerReviewed()) + .contributorsList(resource.getContributorsList()) + .titleRelationships(resource.getTitleRelationships()) + .build(); + } +} diff --git a/src/main/java/org/folio/rmapi/ResourcesServiceImpl.java b/src/main/java/org/folio/rmapi/ResourcesServiceImpl.java index 2a7b42511..ad708c330 100644 --- a/src/main/java/org/folio/rmapi/ResourcesServiceImpl.java +++ b/src/main/java/org/folio/rmapi/ResourcesServiceImpl.java @@ -12,17 +12,16 @@ import java.util.Set; import java.util.concurrent.CompletableFuture; import java.util.stream.Collectors; -import javax.ws.rs.NotFoundException; import lombok.extern.log4j.Log4j2; import org.folio.cache.VertxCache; import org.folio.holdingsiq.model.Configuration; -import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.PackageId; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.ResourceId; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.service.PackagesHoldingsIQService; +import org.folio.holdingsiq.service.exception.ResourceNotFoundException; import org.folio.holdingsiq.service.impl.ResourcesHoldingsIQServiceImpl; import org.folio.rest.util.IdParser; import org.folio.rmapi.cache.ResourceCacheKey; @@ -35,16 +34,17 @@ public class ResourcesServiceImpl extends ResourcesHoldingsIQServiceImpl { private static final String INCLUDE_PROVIDER_VALUE = "provider"; private static final String INCLUDE_PACKAGE_VALUE = "package"; + private static final String INCLUDE_RELATIONSHIPS_VALUE = "relationships"; private final ProvidersServiceImpl providerService; private final PackagesHoldingsIQService packagesService; - private final VertxCache<ResourceCacheKey, Title> resourceCache; + private final VertxCache<ResourceCacheKey, Resource> resourceCache; private final Configuration configuration; private final String tenantId; public ResourcesServiceImpl(Configuration config, Vertx vertx, String tenantId, ProvidersServiceImpl providerService, PackagesHoldingsIQService packagesService, - VertxCache<ResourceCacheKey, Title> resourceCache) { + VertxCache<ResourceCacheKey, Resource> resourceCache) { super(config, vertx); this.providerService = providerService; this.packagesService = packagesService; @@ -53,6 +53,11 @@ public ResourcesServiceImpl(Configuration config, Vertx vertx, String tenantId, this.resourceCache = resourceCache; } + @Override + public CompletableFuture<Resource> retrieveResource(ResourceId resourceId) { + return super.retrieveResource(resourceId).thenApply(resource -> verifyProvider(resource, resourceId)); + } + public CompletableFuture<ResourceResult> retrieveResource(ResourceId resourceId, List<String> includes) { return retrieveResource(resourceId, includes, false); } @@ -60,28 +65,54 @@ public CompletableFuture<ResourceResult> retrieveResource(ResourceId resourceId, public CompletableFuture<ResourceResult> retrieveResource(ResourceId resourceId, List<String> includes, boolean useCache) { - var titleFuture = retrieveTitle(resourceId, useCache); + CompletableFuture<Resource> resourceFuture; + if (includes.contains(INCLUDE_RELATIONSHIPS_VALUE)) { + resourceFuture = retrieveResourceWithRelationships(resourceId); + } else { + resourceFuture = useCache ? retrieveResourceWithCache(resourceId) : retrieveResource(resourceId); + } var vendorFuture = retrieveVendor(resourceId, includes); var packageFuture = retrievePackage(resourceId, includes); boolean includeTitle = includes.contains("title"); - return CompletableFuture.allOf(titleFuture, vendorFuture, packageFuture) + return CompletableFuture.allOf(resourceFuture, vendorFuture, packageFuture) .thenCompose(o -> completedFuture( - new ResourceResult(titleFuture.join(), vendorFuture.join().getVendor(), packageFuture.join(), includeTitle))); + new ResourceResult(resourceFuture.join(), vendorFuture.join().getVendor(), packageFuture.join(), + includeTitle))); + } + + @Override + public CompletableFuture<Resource> retrieveResourceWithRelationships(ResourceId resourceId) { + return super.retrieveResourceWithRelationships(resourceId) + .thenApply(resource -> verifyProvider(resource, resourceId)); } - public CompletableFuture<Titles> retrieveResources(List<ResourceId> resourceIds) { + /** + * HoldingsIQ v2 addresses a resource by package and title ids alone, so a mismatched provider id would otherwise + * be ignored. + */ + private Resource verifyProvider(Resource resource, ResourceId resourceId) { + var vendorId = resource.getVendorId(); + if (vendorId != null && vendorId != resourceId.providerIdPart()) { + throw new ResourceNotFoundException( + "Resource " + resourceId + " not found for provider " + resourceId.providerIdPart(), + 404, "Not Found", null, null); + } + return resource; + } + + public CompletableFuture<Resources> retrieveResources(List<ResourceId> resourceIds) { return retrieveResources(resourceIds, Collections.emptyList()); } - public CompletableFuture<Titles> retrieveResources(List<ResourceId> resourceIds, List<String> includes) { + public CompletableFuture<Resources> retrieveResources(List<ResourceId> resourceIds, List<String> includes) { Set<CompletableFuture<ResourceResult>> futures = resourceIds.stream() .map(id -> retrieveResource(id, includes, true)) .collect(Collectors.toSet()); return FutureUtils.allOfSucceeded(futures, throwable -> log.warn(throwable.getMessage(), throwable)) - .thenApply(this::mapToResources); + .thenApply(results -> Resources.builder().titles(sortByTitleName(results)).build()); } public CompletableFuture<ResourceBulkResult> retrieveResourcesBulk(Set<String> resourceBulk) { @@ -100,7 +131,7 @@ public CompletableFuture<ResourceBulkResult> retrieveResourcesBulk(Set<String> r .collect(Collectors.toSet()); return FutureUtils.allOfSucceeded(futures, throwable -> log.warn(throwable.getMessage(), throwable)) - .thenApply(resourceFutures -> mapToResources(resourceFutures, failed)); + .thenApply(results -> new ResourceBulkResult(sortByTitleName(results), failed)); } private CompletableFuture<PackageData> retrievePackage(ResourceId resourceId, @@ -120,18 +151,7 @@ private CompletableFuture<VendorResult> retrieveVendor(ResourceId resourceId, return completedFuture(new VendorResult(null, null)); } - private CompletableFuture<Title> retrieveTitle(ResourceId resourceId, boolean useCache) { - if (useCache) { - return retrieveResourceWithCache(resourceId, tenantId, configuration) - .thenApply(this::validateCustomerResourcesList); - } else { - return super.retrieveResource(resourceId) - .thenApply(this::validateCustomerResourcesList); - } - } - - private CompletableFuture<Title> retrieveResourceWithCache(ResourceId resourceId, String tenantId, - Configuration configuration) { + private CompletableFuture<Resource> retrieveResourceWithCache(ResourceId resourceId) { ResourceCacheKey cacheKey = ResourceCacheKey.builder() .resourceId(resourceId) .tenant(tenantId) @@ -140,19 +160,11 @@ private CompletableFuture<Title> retrieveResourceWithCache(ResourceId resourceId return resourceCache.getValueOrLoad(cacheKey, () -> retrieveResource(resourceId)); } - private ResourceBulkResult mapToResources(List<ResourceResult> resourceFutures, List<String> failed) { - Titles titlesList = mapToResources(resourceFutures); - return new ResourceBulkResult(titlesList, failed); - } - - private Titles mapToResources(List<ResourceResult> resourceFutures) { - List<Title> titlesList = resourceFutures.stream() - .map(ResourceResult::getTitle) - .sorted(Comparator.comparing(Title::getTitleName)) + private List<Resource> sortByTitleName(List<ResourceResult> results) { + return results.stream() + .map(ResourceResult::getResource) + .sorted(Comparator.comparing(Resource::getTitleName)) .toList(); - return Titles.builder() - .titleList(titlesList) - .build(); } private ResourceId parseToResourceId(String resourceId, List<String> failed) { @@ -163,12 +175,4 @@ private ResourceId parseToResourceId(String resourceId, List<String> failed) { } return null; } - - private Title validateCustomerResourcesList(Title title) { - List<CustomerResources> customerResourcesList = title.getCustomerResourcesList(); - if (customerResourcesList == null || customerResourcesList.isEmpty()) { - throw new NotFoundException("Title is no longer in this package"); - } - return title; - } } diff --git a/src/main/java/org/folio/rmapi/TitlesServiceImpl.java b/src/main/java/org/folio/rmapi/TitlesServiceImpl.java index faec2420a..5691ee782 100644 --- a/src/main/java/org/folio/rmapi/TitlesServiceImpl.java +++ b/src/main/java/org/folio/rmapi/TitlesServiceImpl.java @@ -10,6 +10,8 @@ import lombok.extern.log4j.Log4j2; import org.folio.cache.VertxCache; import org.folio.holdingsiq.model.Configuration; +import org.folio.holdingsiq.model.CustomerResources; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.Titles; import org.folio.holdingsiq.service.impl.TitlesHoldingsIQServiceImpl; @@ -57,8 +59,12 @@ public CompletableFuture<Titles> retrieveTitles(List<Integer> titleIds) { .thenApply(this::mapToTitles); } - public void updateCache(Title title) { - var cacheKey = buildTitleCacheKey(title.getTitleId()); + /** + * Caches the title of the updated resource, keeping the other packages of the title that are already cached. + */ + public void updateCache(Resource resource) { + var cacheKey = buildTitleCacheKey(resource.getTitleId()); + var title = ResourceMapper.toTitle(resource); Title cachedTitle = titleCache.getValue(cacheKey); if (!Objects.isNull(cachedTitle)) { mergeCustomerResources(cachedTitle, title); @@ -78,16 +84,12 @@ private CompletableFuture<Title> retrieveTitleWithCache(int titleId) { } private void mergeCustomerResources(Title cachedTitle, Title title) { - var updatedCustomerResources = title.getCustomerResourcesList(); - var customerResources = cachedTitle.getCustomerResourcesList(); - - if (!updatedCustomerResources.isEmpty()) { - var updatedCustomerResourceId = updatedCustomerResources.getFirst().getPackageId(); - var oldCustomerResources = customerResources.stream() - .filter(resource -> !Objects.equals(resource.getPackageId(), updatedCustomerResourceId)) - .toList(); - updatedCustomerResources.addAll(oldCustomerResources); - } + List<CustomerResources> updatedCustomerResources = title.getCustomerResourcesList(); + var updatedCustomerResourceId = updatedCustomerResources.getFirst().getPackageId(); + var oldCustomerResources = cachedTitle.getCustomerResourcesList().stream() + .filter(resource -> !Objects.equals(resource.getPackageId(), updatedCustomerResourceId)) + .toList(); + updatedCustomerResources.addAll(oldCustomerResources); } private Titles mapToTitles(List<Title> titles) { diff --git a/src/main/java/org/folio/rmapi/result/ObjectsForPostResourceResult.java b/src/main/java/org/folio/rmapi/result/ObjectsForPostResourceResult.java index ca7110c5f..57a44ed31 100644 --- a/src/main/java/org/folio/rmapi/result/ObjectsForPostResourceResult.java +++ b/src/main/java/org/folio/rmapi/result/ObjectsForPostResourceResult.java @@ -2,6 +2,5 @@ import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; -public record ObjectsForPostResourceResult(Title title, PackageData packageData, Titles titles) { } +public record ObjectsForPostResourceResult(Title title, PackageData packageData, boolean titleInPackage) { } diff --git a/src/main/java/org/folio/rmapi/result/PackageResult.java b/src/main/java/org/folio/rmapi/result/PackageResult.java index c5df952e0..a897153f9 100644 --- a/src/main/java/org/folio/rmapi/result/PackageResult.java +++ b/src/main/java/org/folio/rmapi/result/PackageResult.java @@ -3,7 +3,7 @@ import lombok.Getter; import lombok.Setter; import org.folio.holdingsiq.model.PackageData; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.model.VendorById; import org.folio.rest.jaxrs.model.AccessType; import org.folio.rest.jaxrs.model.Tags; @@ -14,7 +14,7 @@ public class PackageResult implements Accessible, Tagable { private PackageData packageData; private VendorById vendor; - private Titles titles; + private Resources resources; private Tags tags; private AccessType accessType; @@ -22,9 +22,9 @@ public PackageResult(PackageData packageData) { this.packageData = packageData; } - public PackageResult(PackageData packageData, VendorById vendor, Titles titles) { + public PackageResult(PackageData packageData, VendorById vendor, Resources resources) { this.packageData = packageData; this.vendor = vendor; - this.titles = titles; + this.resources = resources; } } diff --git a/src/main/java/org/folio/rmapi/result/ResourceBulkResult.java b/src/main/java/org/folio/rmapi/result/ResourceBulkResult.java index 70a039339..bf4d9eff1 100644 --- a/src/main/java/org/folio/rmapi/result/ResourceBulkResult.java +++ b/src/main/java/org/folio/rmapi/result/ResourceBulkResult.java @@ -1,6 +1,6 @@ package org.folio.rmapi.result; import java.util.List; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resource; -public record ResourceBulkResult(Titles titles, List<String> failedResources) { } +public record ResourceBulkResult(List<Resource> resources, List<String> failedResources) { } diff --git a/src/main/java/org/folio/rmapi/result/ResourceCollectionResult.java b/src/main/java/org/folio/rmapi/result/ResourceCollectionResult.java index 54c1715f9..514d0ea2f 100644 --- a/src/main/java/org/folio/rmapi/result/ResourceCollectionResult.java +++ b/src/main/java/org/folio/rmapi/result/ResourceCollectionResult.java @@ -1,8 +1,9 @@ package org.folio.rmapi.result; import java.util.List; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.repository.holdings.DbHoldingInfo; import org.folio.repository.resources.DbResource; -public record ResourceCollectionResult(Titles titles, List<DbResource> titlesList, List<DbHoldingInfo> holdings) { } +public record ResourceCollectionResult(Resources resources, List<DbResource> dbResources, + List<DbHoldingInfo> holdings) { } diff --git a/src/main/java/org/folio/rmapi/result/ResourceItemCollectionResult.java b/src/main/java/org/folio/rmapi/result/ResourceItemCollectionResult.java new file mode 100644 index 000000000..230d0b958 --- /dev/null +++ b/src/main/java/org/folio/rmapi/result/ResourceItemCollectionResult.java @@ -0,0 +1,6 @@ +package org.folio.rmapi.result; + +import java.util.List; +import org.folio.holdingsiq.model.Facets; + +public record ResourceItemCollectionResult(List<ResourceItemResult> items, Facets facets, Integer totalResults) { } diff --git a/src/main/java/org/folio/rmapi/result/ResourceItemResult.java b/src/main/java/org/folio/rmapi/result/ResourceItemResult.java new file mode 100644 index 000000000..dad18907f --- /dev/null +++ b/src/main/java/org/folio/rmapi/result/ResourceItemResult.java @@ -0,0 +1,24 @@ +package org.folio.rmapi.result; + +import java.util.List; +import lombok.Getter; +import lombok.Setter; +import org.folio.holdingsiq.model.Resource; +import org.folio.repository.accesstypes.DbAccessType; +import org.folio.repository.tag.DbTag; + +/** + * A resource of a package listing together with its locally stored tags and access type. + */ +@Getter +@Setter +public class ResourceItemResult { + + private final Resource resource; + private List<DbTag> tagList; + private DbAccessType accessType; + + public ResourceItemResult(Resource resource) { + this.resource = resource; + } +} diff --git a/src/main/java/org/folio/rmapi/result/ResourceResult.java b/src/main/java/org/folio/rmapi/result/ResourceResult.java index 43fc9f0e2..5e21677cd 100644 --- a/src/main/java/org/folio/rmapi/result/ResourceResult.java +++ b/src/main/java/org/folio/rmapi/result/ResourceResult.java @@ -3,7 +3,7 @@ import lombok.Getter; import lombok.Setter; import org.folio.holdingsiq.model.PackageData; -import org.folio.holdingsiq.model.Title; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.VendorById; import org.folio.rest.jaxrs.model.AccessType; import org.folio.rest.jaxrs.model.Tags; @@ -12,15 +12,15 @@ @Setter public class ResourceResult implements Accessible, Tagable { - private Title title; + private Resource resource; private VendorById vendor; private PackageData packageData; private boolean includeTitle; private Tags tags; private AccessType accessType; - public ResourceResult(Title title, VendorById vendor, PackageData packageData, boolean includeTitle) { - this.title = title; + public ResourceResult(Resource resource, VendorById vendor, PackageData packageData, boolean includeTitle) { + this.resource = resource; this.vendor = vendor; this.packageData = packageData; this.includeTitle = includeTitle; diff --git a/src/main/java/org/folio/service/loader/FilteredEntitiesLoaderImpl.java b/src/main/java/org/folio/service/loader/FilteredEntitiesLoaderImpl.java index 739a861cb..713a5b010 100644 --- a/src/main/java/org/folio/service/loader/FilteredEntitiesLoaderImpl.java +++ b/src/main/java/org/folio/service/loader/FilteredEntitiesLoaderImpl.java @@ -24,6 +24,7 @@ import org.folio.holdingsiq.model.PackageId; import org.folio.holdingsiq.model.Packages; import org.folio.holdingsiq.model.ResourceId; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.Titles; import org.folio.holdingsiq.model.Vendors; @@ -216,9 +217,9 @@ private List<Title> filterResourcesInTitles(Titles titles, List<String> resource .collect(Collectors.toCollection(ArrayList::new)); } - private ResourceCollectionResult toResourceCollectionResult(Titles titles, List<DbResource> resourcesResult, + private ResourceCollectionResult toResourceCollectionResult(Resources resources, List<DbResource> resourcesResult, List<DbHoldingInfo> dbHoldings, Integer resourceCount) { - return new ResourceCollectionResult(titles.toBuilder().totalResults(resourceCount).build(), resourcesResult, + return new ResourceCollectionResult(resources.toBuilder().totalResults(resourceCount).build(), resourcesResult, dbHoldings); } diff --git a/src/main/java/org/folio/service/packages/PackageService.java b/src/main/java/org/folio/service/packages/PackageService.java index 770c0b5f1..8c1653767 100644 --- a/src/main/java/org/folio/service/packages/PackageService.java +++ b/src/main/java/org/folio/service/packages/PackageService.java @@ -1,6 +1,7 @@ package org.folio.service.packages; import static java.util.stream.Collectors.toMap; +import static org.folio.HttpStatus.SC_NOT_FOUND; import static org.folio.db.RowSetUtils.toUUID; import static org.folio.rest.util.IdParser.packageIdToString; @@ -9,17 +10,18 @@ import java.util.Map; import java.util.UUID; import java.util.concurrent.CompletableFuture; +import java.util.concurrent.CompletionException; import java.util.concurrent.CompletionStage; import java.util.function.Function; import lombok.RequiredArgsConstructor; +import org.apache.commons.collections4.CollectionUtils; import org.apache.commons.lang3.BooleanUtils; -import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.PackageData; import org.folio.holdingsiq.model.PackageId; import org.folio.holdingsiq.model.PackagePost; import org.folio.holdingsiq.model.PackagePut; import org.folio.holdingsiq.model.Packages; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.service.exception.ResourceNotFoundException; import org.folio.properties.common.SearchProperties; import org.folio.repository.RecordKey; @@ -33,11 +35,12 @@ import org.folio.rest.jaxrs.model.PackageTagsPutRequest; import org.folio.rest.model.filter.PackageRecordFilter; import org.folio.rest.model.filter.ResourceFilter; +import org.folio.rest.util.IdParser; import org.folio.rest.util.template.RmApiTemplateContext; import org.folio.rest.validator.packages.PackageValidationService; import org.folio.rmapi.result.PackageResult; -import org.folio.rmapi.result.TitleCollectionResult; -import org.folio.rmapi.result.TitleResult; +import org.folio.rmapi.result.ResourceItemCollectionResult; +import org.folio.rmapi.result.ResourceItemResult; import org.folio.service.loader.RelatedEntitiesLoader; import org.springframework.core.convert.converter.Converter; import org.springframework.stereotype.Service; @@ -57,7 +60,7 @@ public class PackageService { private final PackageTagsService packageTagsService; private final CustomProviderIdService customProviderIdService; private final RelatedEntitiesLoader relatedEntitiesLoader; - private final Converter<Titles, TitleCollectionResult> titleCollectionConverter; + private final Converter<Resources, ResourceItemCollectionResult> resourceItemCollectionConverter; private final SearchProperties searchProperties; public CompletableFuture<Packages> retrievePackages(Integer providerId, PackageRecordFilter filter, @@ -78,15 +81,31 @@ public CompletableFuture<Packages> getCustomProviderIdAndRetrievePackages(Packag public Function<RmApiTemplateContext, CompletableFuture<?>> retrievePackageTitles(ResourceFilter filter) { return context -> { var pkgId = filter.parsePackageId(); - return context.getTitlesService() - .retrieveTitles(pkgId.providerIdPart(), pkgId.packageIdPart(), filter.createFilterQuery(), - searchProperties.titlesSearchType(), filter.resolveSort(), filter.getPage(), filter.getCount()) - .thenApply(titleCollectionConverter::convert) + return context.getResourcesService() + .retrieveResources(pkgId.packageIdPart(), filter.toClientFilter(), filter.toPageable()) + .thenCompose(resources -> verifyPackage(resources, pkgId, context)) + .thenApply(resourceItemCollectionConverter::convert) .thenCompose(loadResourceTags(context)) .thenCompose(loadResourceAccessTypes(context)); }; } + // HoldingsIQ v2 addresses a list by its id alone and answers 200 with an empty list for a missing package, so the + // provider is checked on the returned resources and the 404 for an empty list comes from the package lookup + private CompletableFuture<Resources> verifyPackage(Resources resources, PackageId packageId, + RmApiTemplateContext context) { + if (CollectionUtils.isEmpty(resources.getTitles())) { + return context.getPackagesService().retrievePackage(packageId).thenApply(packageData -> resources); + } + var vendorId = resources.getTitles().getFirst().getVendorId(); + if (vendorId != null && vendorId != packageId.providerIdPart()) { + return CompletableFuture.failedFuture(new ResourceNotFoundException( + "Package " + packageId.packageIdPart() + " not found for provider " + packageId.providerIdPart(), + SC_NOT_FOUND, "Not Found", null, null)); + } + return CompletableFuture.completedFuture(resources); + } + public CompletableFuture<PackageResult> createCustomPackage(PackagePostRequest entity, RmApiTemplateContext context) { validationService.validateCustomPackagePostRequest(entity); @@ -120,13 +139,12 @@ public CompletableFuture<PackageResult> retrievePackageWithRelatedData(PackageId public CompletableFuture<PackageResult> updatePackage(PackageId parsedPackageId, PackagePutRequest entity, RmApiTemplateContext context) { - var packageIdPart = parsedPackageId.packageIdPart(); String accessTypeId = entity.getData().getAttributes().getAccessTypeId(); - return context.getPackagesService().retrievePackage(packageIdPart) + return context.getPackagesService().retrievePackage(parsedPackageId) .thenCompose(packageData -> packageAccessTypeService.fetchAccessType(accessTypeId, context) .thenCompose(accessType -> processUpdateRequest(entity, packageData, context) .thenCompose(voidEntity -> { - CompletableFuture<PackageData> future = context.getPackagesService().retrievePackage(packageIdPart); + CompletableFuture<PackageData> future = context.getPackagesService().retrievePackage(parsedPackageId); return handleDeletedPackage(future, parsedPackageId, context); }) .thenApply(packageById -> new PackageResult(packageById, null, null)) @@ -137,7 +155,7 @@ public CompletableFuture<PackageResult> updatePackage(PackageId parsedPackageId, public CompletableFuture<Void> deletePackage(PackageId parsedPackageId, RmApiTemplateContext context) { var packageIdPart = parsedPackageId.packageIdPart(); - return context.getPackagesService().retrievePackage(packageIdPart) + return context.getPackagesService().retrievePackage(parsedPackageId) .thenCompose(packageData -> { if (BooleanUtils.isNotTrue(packageData.getIsCustom())) { throw new InputValidationException(INVALID_PACKAGE_TITLE, INVALID_PACKAGE_DETAILS); @@ -197,7 +215,8 @@ private CompletableFuture<PackageData> handleDeletedPackage(CompletableFuture<Pa PackageId packageId, RmApiTemplateContext context) { CompletableFuture<Void> deleteFuture = new CompletableFuture<>(); return future.whenComplete((packageById, e) -> { - if (e instanceof ResourceNotFoundException) { + var cause = e instanceof CompletionException ? e.getCause() : e; + if (cause instanceof ResourceNotFoundException) { deleteAssignedResources(packageId, context).thenAccept(o -> deleteFuture.complete(null)); } else { deleteFuture.complete(null); @@ -214,44 +233,39 @@ private CompletableFuture<Void> deleteAssignedResources(PackageId packageId, RmA return CompletableFuture.allOf(deleteAccessMapping, deleteTags); } - private Function<TitleCollectionResult, CompletionStage<TitleCollectionResult>> loadResourceTags( + private Function<ResourceItemCollectionResult, CompletionStage<ResourceItemCollectionResult>> loadResourceTags( RmApiTemplateContext context) { - return titleCollection -> { - Map<String, TitleResult> resourceIdToTitle = mapResourceIdToTitleResult(titleCollection); - return packageTagsService.loadResourceTags(context.getRequestContext().getTenant(), resourceIdToTitle) - .thenApply(v -> titleCollection); + return collection -> { + Map<String, ResourceItemResult> resourceIdToItem = mapResourceIdToItem(collection); + return packageTagsService.loadResourceTags(context.getRequestContext().getTenant(), resourceIdToItem) + .thenApply(v -> collection); }; } - private Function<TitleCollectionResult, CompletionStage<TitleCollectionResult>> loadResourceAccessTypes( - RmApiTemplateContext context) { - return titleCollection -> { - Map<String, TitleResult> resourceIdToAccessType = mapResourceIdToTitleResult(titleCollection); - return relatedEntitiesLoader.loadAccessTypes(new ArrayList<>(resourceIdToAccessType.keySet()), + private Function<ResourceItemCollectionResult, CompletionStage<ResourceItemCollectionResult>> + loadResourceAccessTypes(RmApiTemplateContext context) { + return collection -> { + Map<String, ResourceItemResult> resourceIdToItem = mapResourceIdToItem(collection); + return relatedEntitiesLoader.loadAccessTypes(new ArrayList<>(resourceIdToItem.keySet()), RecordType.RESOURCE, context) .thenApply(accessTypeMap -> { - populateResourceAccessTypes(resourceIdToAccessType, accessTypeMap); - return titleCollection; + populateResourceAccessTypes(resourceIdToItem, accessTypeMap); + return collection; }); }; } - private void populateResourceAccessTypes(Map<String, TitleResult> resourceIdToTitle, + private void populateResourceAccessTypes(Map<String, ResourceItemResult> resourceIdToItem, Map<String, DbAccessType> accessTypeMap) { accessTypeMap.forEach((id, accessType) -> { - if (resourceIdToTitle.containsKey(id)) { - TitleResult titleResult = resourceIdToTitle.get(id); - titleResult.setResourceAccessType(accessType); + if (resourceIdToItem.containsKey(id)) { + resourceIdToItem.get(id).setAccessType(accessType); } }); } - private Map<String, TitleResult> mapResourceIdToTitleResult(TitleCollectionResult tc) { - return tc.getTitleResults().stream().collect(toMap(this::getResourceId, Function.identity())); - } - - private String getResourceId(TitleResult titleResult) { - CustomerResources resource = titleResult.getTitle().getCustomerResourcesList().getFirst(); - return resource.getVendorId() + "-" + resource.getPackageId() + "-" + resource.getTitleId(); + private Map<String, ResourceItemResult> mapResourceIdToItem(ResourceItemCollectionResult collection) { + return collection.items().stream() + .collect(toMap(item -> IdParser.getResourceId(item.getResource()), Function.identity())); } } diff --git a/src/main/java/org/folio/service/packages/PackageTagsService.java b/src/main/java/org/folio/service/packages/PackageTagsService.java index 1a485c26e..4267ebd0d 100644 --- a/src/main/java/org/folio/service/packages/PackageTagsService.java +++ b/src/main/java/org/folio/service/packages/PackageTagsService.java @@ -18,7 +18,7 @@ import org.folio.rest.converter.common.ConverterConsts; import org.folio.rest.jaxrs.model.PackageTagsDataAttributes; import org.folio.rest.jaxrs.model.Tags; -import org.folio.rmapi.result.TitleResult; +import org.folio.rmapi.result.ResourceItemResult; import org.springframework.stereotype.Service; /** @@ -56,13 +56,14 @@ CompletableFuture<Void> deletePackageTags(PackageId packageId, UUID credentialsI .thenCompose(v -> completedFuture(null)); } - CompletableFuture<Void> loadResourceTags(String tenant, Map<String, TitleResult> resourceIdToTitle) { - return tagRepository.findPerRecord(tenant, new ArrayList<>(resourceIdToTitle.keySet()), RecordType.RESOURCE) - .thenAccept(tagMap -> populateResourceTags(resourceIdToTitle, tagMap)); + CompletableFuture<Void> loadResourceTags(String tenant, Map<String, ResourceItemResult> resourceIdToItem) { + return tagRepository.findPerRecord(tenant, new ArrayList<>(resourceIdToItem.keySet()), RecordType.RESOURCE) + .thenAccept(tagMap -> populateResourceTags(resourceIdToItem, tagMap)); } - private void populateResourceTags(Map<String, TitleResult> resourceIdToTitle, Map<String, List<DbTag>> tagMap) { - tagMap.forEach((id, tags) -> resourceIdToTitle.get(id).setResourceTagList(tags)); + private void populateResourceTags(Map<String, ResourceItemResult> resourceIdToItem, + Map<String, List<DbTag>> tagMap) { + tagMap.forEach((id, tags) -> resourceIdToItem.get(id).setTagList(tags)); } private CompletableFuture<Void> updateStoredPackage(Tags tags, DbPackage pkg, String tenant) { diff --git a/src/main/java/org/folio/spring/config/ApplicationConfig.java b/src/main/java/org/folio/spring/config/ApplicationConfig.java index 7fe0cba86..36fad5c39 100644 --- a/src/main/java/org/folio/spring/config/ApplicationConfig.java +++ b/src/main/java/org/folio/spring/config/ApplicationConfig.java @@ -34,6 +34,7 @@ import org.folio.db.exc.translation.DBExceptionTranslator; import org.folio.db.exc.translation.DBExceptionTranslatorFactory; import org.folio.holdingsiq.model.PackageData; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.VendorById; import org.folio.holdingsiq.service.ConfigurationService; @@ -139,8 +140,8 @@ public VertxCache<TitleCacheKey, Title> titleCache(Vertx vertx, @Value("${title. } @Bean - public VertxCache<ResourceCacheKey, Title> resourceCache(Vertx vertx, - @Value("${resource.cache.expire}") long expirationTime) { + public VertxCache<ResourceCacheKey, Resource> resourceCache(Vertx vertx, + @Value("${resource.cache.expire}") long expirationTime) { return new VertxCache<>(vertx, expirationTime, "resourceCache"); } diff --git a/src/test/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverterTest.java b/src/test/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverterTest.java new file mode 100644 index 000000000..566150f01 --- /dev/null +++ b/src/test/java/org/folio/rest/converter/common/attr/ResourceVisibilityConverterTest.java @@ -0,0 +1,49 @@ +package org.folio.rest.converter.common.attr; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import java.util.List; +import org.folio.holdingsiq.model.Visibility; +import org.junit.jupiter.api.Test; + +class ResourceVisibilityConverterTest { + + private final ResourceVisibilityConverter converter = new ResourceVisibilityConverter(); + + @Test + void shouldBeVisibleWhenAllCategoriesAreVisible() { + var visibilityData = converter.convert(List.of( + new Visibility("PF", false, ""), + new Visibility("FTF", false, ""), + new Visibility("MARC", false, "") + )); + + assertFalse(visibilityData.getIsHidden()); + assertEquals("", visibilityData.getReason()); + } + + @Test + void shouldBeHiddenWhenAtLeastOneCategoryIsHidden() { + var visibilityData = converter.convert(List.of( + new Visibility("PF", false, ""), + new Visibility("FTF", true, "Hidden by customer"), + new Visibility("MARC", false, "") + )); + + assertTrue(visibilityData.getIsHidden()); + assertEquals("", visibilityData.getReason()); + } + + @Test + void shouldMapHiddenByEpReasonOfHiddenCategory() { + var visibilityData = converter.convert(List.of( + new Visibility("PF", false, ""), + new Visibility("MARC", true, "Hidden by EP") + )); + + assertTrue(visibilityData.getIsHidden()); + assertEquals("Set by system", visibilityData.getReason()); + } +} diff --git a/src/test/java/org/folio/rest/converter/packages/CustomPackagePutRequestConverterTest.java b/src/test/java/org/folio/rest/converter/packages/CustomPackagePutRequestConverterTest.java index 2d276b5df..83547e413 100644 --- a/src/test/java/org/folio/rest/converter/packages/CustomPackagePutRequestConverterTest.java +++ b/src/test/java/org/folio/rest/converter/packages/CustomPackagePutRequestConverterTest.java @@ -13,7 +13,7 @@ import org.folio.rest.jaxrs.model.ContentType; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.PackagePutDataAttributes; -import org.folio.rest.jaxrs.model.PackageVisibility; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.service.sanitizer.Sanitizer; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -86,9 +86,9 @@ void shouldCreateRequestToChangeCustomPackageVisibility() { var packagePut = converter.convert(getPackagePutRequest( new PackagePutDataAttributes() - .withVisibility(List.of(new PackageVisibility() + .withVisibility(List.of(new Visibility() .withHidden(true) - .withCategory(PackageVisibility.Category.PF))) + .withCategory(Visibility.Category.PF))) )); var visibility = packagePut.getVisibilityDetails().getFirst(); assertTrue(visibility.hidden()); @@ -100,10 +100,10 @@ void shouldIgnoreIncomingReasonAndClearReasonWhenHiddenFalse() { var packagePut = converter.convert(getPackagePutRequest( new PackagePutDataAttributes() - .withVisibility(List.of(new PackageVisibility() + .withVisibility(List.of(new Visibility() .withHidden(false) .withReason("some incoming reason") - .withCategory(PackageVisibility.Category.PF))) + .withCategory(Visibility.Category.PF))) )); var visibility = packagePut.getVisibilityDetails().getFirst(); assertFalse(visibility.hidden()); diff --git a/src/test/java/org/folio/rest/converter/packages/ManagedPackagePutRequestConverterTest.java b/src/test/java/org/folio/rest/converter/packages/ManagedPackagePutRequestConverterTest.java index 61b54b486..4c983b69b 100644 --- a/src/test/java/org/folio/rest/converter/packages/ManagedPackagePutRequestConverterTest.java +++ b/src/test/java/org/folio/rest/converter/packages/ManagedPackagePutRequestConverterTest.java @@ -12,7 +12,7 @@ import java.util.List; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.PackagePutDataAttributes; -import org.folio.rest.jaxrs.model.PackageVisibility; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.service.sanitizer.Sanitizer; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; @@ -42,9 +42,9 @@ void shouldCreateRequestToHidePackage() { var packagePut = converter.convert(getPackagePutRequest( new PackagePutDataAttributes() .withIsSelected(true) - .withVisibility(List.of(new PackageVisibility() + .withVisibility(List.of(new Visibility() .withHidden(true) - .withCategory(PackageVisibility.Category.PF))) + .withCategory(Visibility.Category.PF))) )); var visibility = packagePut.getVisibilityDetails().getFirst(); assertTrue(visibility.hidden()); @@ -56,10 +56,10 @@ void shouldIgnoreIncomingReasonAndClearReasonWhenHiddenFalse() { var packagePut = converter.convert(getPackagePutRequest( new PackagePutDataAttributes() .withIsSelected(true) - .withVisibility(List.of(new PackageVisibility() + .withVisibility(List.of(new Visibility() .withHidden(false) .withReason("some incoming reason") - .withCategory(PackageVisibility.Category.PF))) + .withCategory(Visibility.Category.PF))) )); var visibility = packagePut.getVisibilityDetails().getFirst(); assertFalse(visibility.hidden()); diff --git a/src/test/java/org/folio/rest/converter/packages/PackageResponseConverterTest.java b/src/test/java/org/folio/rest/converter/packages/PackageResponseConverterTest.java index 2aa2fbd20..46fbcfb5b 100644 --- a/src/test/java/org/folio/rest/converter/packages/PackageResponseConverterTest.java +++ b/src/test/java/org/folio/rest/converter/packages/PackageResponseConverterTest.java @@ -6,6 +6,7 @@ import org.folio.holdingsiq.model.Title; import org.folio.rest.jaxrs.model.Resource; +import org.folio.rmapi.ResourceMapper; import org.folio.rmapi.result.ResourceResult; import org.folio.spring.config.TestConfig; import org.junit.jupiter.api.Test; @@ -26,7 +27,8 @@ class PackageResponseConverterTest { void shouldReturnCustomCoverageInDescendingOrder() { var title = readJsonFile("responses/rmapi/titles/get-custom-title-with-coverage-dates-asc.json", Title.class); - var resourceResult = new ResourceResult(title, null, null, false); + var rmapiResource = ResourceMapper.toResource(title, title.getCustomerResourcesList().getFirst()); + var resourceResult = new ResourceResult(rmapiResource, null, null, false); var resource = conversionService.convert(resourceResult, Resource.class); assertNotNull(resource); diff --git a/src/test/java/org/folio/rest/converter/resources/ResourceRequestConverterTest.java b/src/test/java/org/folio/rest/converter/resources/ResourceRequestConverterTest.java index afa9b713f..a867747f9 100644 --- a/src/test/java/org/folio/rest/converter/resources/ResourceRequestConverterTest.java +++ b/src/test/java/org/folio/rest/converter/resources/ResourceRequestConverterTest.java @@ -2,22 +2,24 @@ import static java.util.Collections.emptyList; import static java.util.Collections.singletonList; +import static java.util.List.of; import static org.folio.util.ResourcesTestUtil.getResourcePutRequest; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertNull; import static org.junit.jupiter.api.Assertions.assertTrue; +import java.util.List; import org.folio.holdingsiq.model.CoverageDates; -import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.ProxyUrl; -import org.folio.holdingsiq.model.Title; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.UserDefinedFields; -import org.folio.holdingsiq.model.VisibilityInfo; +import org.folio.holdingsiq.model.Visibility; import org.folio.rest.jaxrs.model.EmbargoPeriod; import org.folio.rest.jaxrs.model.EmbargoPeriod.EmbargoUnit; import org.folio.rest.jaxrs.model.ProxyDto; import org.folio.rest.jaxrs.model.ResourcePutDataAttributes; +import org.folio.rest.jaxrs.model.Visibility.Category; import org.folio.rest.jaxrs.model.VisibilityData; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -35,27 +37,23 @@ class ResourceRequestConverterTest { private final ResourceRequestConverter resourcesConverter = new ResourceRequestConverter(); - private Title resourceData; + private Resource resourceData; @BeforeEach void setUp() { - resourceData = Title.builder() + resourceData = Resource.builder() .contributorsList(emptyList()) - .customerResourcesList(singletonList(CustomerResources.builder() - .coverageStatement(OLD_COVERAGE_STATEMENT) - .isSelected(false) - .visibilityData(VisibilityInfo.builder() - .isHidden(OLD_VISIBILITY_DATA).build()) - .customCoverageList(singletonList(CoverageDates.builder() - .beginCoverage(OLD_BEGIN_COVERAGE).endCoverage(OLD_END_COVERAGE).build())) - .customEmbargoPeriod(org.folio.holdingsiq.model.EmbargoPeriod.builder() - .embargoUnit(OLD_EMBARGO_UNIT).embargoValue(OLD_EMBARGO_VALUE).build()) - .proxy(ProxyUrl.builder().proxiedUrl(OLD_URL) - .id(OLD_PROXY_ID).inherited(true).build()) - .url(OLD_URL) - .userDefinedFields(UserDefinedFields.builder().build()) - .build() - )) + .coverageStatement(OLD_COVERAGE_STATEMENT) + .isSelected(false) + .visibilityDetails(of(new Visibility("PF", OLD_VISIBILITY_DATA, ""))) + .customCoverageList(singletonList(CoverageDates.builder() + .beginCoverage(OLD_BEGIN_COVERAGE).endCoverage(OLD_END_COVERAGE).build())) + .customEmbargoPeriod(org.folio.holdingsiq.model.EmbargoPeriod.builder() + .embargoUnit(OLD_EMBARGO_UNIT).embargoValue(OLD_EMBARGO_VALUE).build()) + .proxy(ProxyUrl.builder().proxiedUrl(OLD_URL) + .id(OLD_PROXY_ID).inherited(true).build()) + .url(OLD_URL) + .userDefinedFields(UserDefinedFields.builder().build()) .identifiersList(emptyList()) .subjectsList(emptyList()) .titleId(1) @@ -122,7 +120,48 @@ void shouldCreateRequestToUpdateIsHiddenForCustomResource() { .withIsSelected(true) .withVisibilityData(new VisibilityData() .withIsHidden(true))), resourceData); - assertTrue(resourcePut.getIsHidden()); + assertEquals(allCategories(true), resourcePut.getVisibilityDetails()); + } + + @Test + void shouldCreateRequestToUpdateVisibilityPerCategory() { + var resourcePut = resourcesConverter.convertToRmApiResourcePutRequest(getResourcePutRequest( + new ResourcePutDataAttributes() + .withIsSelected(true) + .withVisibility(of( + new org.folio.rest.jaxrs.model.Visibility().withCategory(Category.PF).withHidden(true), + new org.folio.rest.jaxrs.model.Visibility().withCategory(Category.FTF).withHidden(false), + new org.folio.rest.jaxrs.model.Visibility().withCategory(Category.MARC).withHidden(true)))), resourceData); + assertEquals(of(new Visibility("PF", true, "Hidden by Customer"), new Visibility("FTF", false, null), + new Visibility("MARC", true, "Hidden by Customer")), resourcePut.getVisibilityDetails()); + } + + @Test + void shouldCreateRequestToUpdateOnlySentVisibilityCategories() { + var resourcePut = resourcesConverter.convertToRmApiCustomResourcePutRequest(getResourcePutRequest( + new ResourcePutDataAttributes() + .withIsSelected(true) + .withVisibility(of( + new org.folio.rest.jaxrs.model.Visibility().withCategory(Category.MARC).withHidden(true)))), resourceData); + assertEquals(of(new Visibility("MARC", true, "Hidden by Customer")), resourcePut.getVisibilityDetails()); + } + + @Test + void shouldPreferVisibilityPerCategoryOverVisibilityData() { + var resourcePut = resourcesConverter.convertToRmApiResourcePutRequest(getResourcePutRequest( + new ResourcePutDataAttributes() + .withIsSelected(true) + .withVisibilityData(new VisibilityData().withIsHidden(true)) + .withVisibility(of( + new org.folio.rest.jaxrs.model.Visibility().withCategory(Category.PF).withHidden(false)))), resourceData); + assertEquals(of(new Visibility("PF", false, null)), resourcePut.getVisibilityDetails()); + } + + @Test + void shouldNotSendVisibilityWhenRequestDoesNotSetIt() { + var resourcePut = resourcesConverter.convertToRmApiResourcePutRequest(getResourcePutRequest( + new ResourcePutDataAttributes().withIsSelected(true)), resourceData); + assertNull(resourcePut.getVisibilityDetails()); } @Test @@ -150,7 +189,7 @@ void shouldCreateRequestToUpdateIsHiddenForManagedResource() { .withIsSelected(true) .withVisibilityData(new VisibilityData() .withIsHidden(false))), resourceData); - assertFalse(resourcePut.getIsHidden()); + assertEquals(allCategories(false), resourcePut.getVisibilityDetails()); } @Test @@ -196,33 +235,36 @@ void shouldCreateRequestToUpdateCustomEmbargoPeriodForCustomResource() { @Test void shouldCreateRequestToUpdateUrlForCustomResource() { - var customerResourcesBuilder = resourceData.getCustomerResourcesList().getFirst().toBuilder(); - var resources = customerResourcesBuilder.isPackageCustom(true).build(); - var title = resourceData.toBuilder().customerResourcesList(singletonList(resources)).build(); + var customResource = resourceData.toBuilder().isPackageCustom(true).build(); var resourcePut = resourcesConverter.convertToRmApiCustomResourcePutRequest(getResourcePutRequest( new ResourcePutDataAttributes() .withIsSelected(true) - .withUrl("test url")), title); + .withUrl("test url")), customResource); assertEquals("test url", resourcePut.getUrl()); } @Test void shouldCreateRequestWithOldDataExceptEmbargoWhenUpdateFieldsAreMissing() { - var customerResourcesBuilder = resourceData.getCustomerResourcesList().getFirst().toBuilder(); - var resources = customerResourcesBuilder.isPackageCustom(true).build(); - var title = resourceData.toBuilder().customerResourcesList(singletonList(resources)).build(); + var customResource = resourceData.toBuilder().isPackageCustom(true).build(); var resourcePut = resourcesConverter.convertToRmApiCustomResourcePutRequest( getResourcePutRequest(new ResourcePutDataAttributes()), - title + customResource ); assertEquals(OLD_PROXY_ID, resourcePut.getProxy().getId()); assertFalse(resourcePut.getProxy().getInherited()); assertEquals(OLD_COVERAGE_STATEMENT, resourcePut.getCoverageStatement()); assertEquals(OLD_URL, resourcePut.getUrl()); - assertEquals(OLD_VISIBILITY_DATA, resourcePut.getIsHidden()); + // visibility is not sent when not requested, so HoldingsIQ keeps the current visibility + assertNull(resourcePut.getVisibilityDetails()); assertNull(resourcePut.getCustomEmbargoPeriod()); } + + private static List<Visibility> allCategories(boolean hidden) { + var reason = hidden ? "Hidden by Customer" : null; + return of(new Visibility("PF", hidden, reason), new Visibility("FTF", hidden, reason), + new Visibility("MARC", hidden, reason)); + } } diff --git a/src/test/java/org/folio/rest/converter/titles/TitlePutRequestConverterTest.java b/src/test/java/org/folio/rest/converter/titles/TitlePutRequestConverterTest.java index 321b59274..93250bd72 100644 --- a/src/test/java/org/folio/rest/converter/titles/TitlePutRequestConverterTest.java +++ b/src/test/java/org/folio/rest/converter/titles/TitlePutRequestConverterTest.java @@ -2,22 +2,21 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; import java.util.Collections; import org.folio.holdingsiq.model.CoverageDates; import org.folio.holdingsiq.model.CustomerResources; import org.folio.holdingsiq.model.EmbargoPeriod; import org.folio.holdingsiq.model.ProxyUrl; -import org.folio.holdingsiq.model.Title; import org.folio.holdingsiq.model.UserDefinedFields; -import org.folio.holdingsiq.model.VisibilityInfo; +import org.folio.holdingsiq.model.Visibility; import org.folio.rest.converter.common.attr.ContributorsConverterPair; import org.folio.rest.converter.common.attr.IdentifiersConverterPair; import org.folio.rest.jaxrs.model.PublicationType; import org.folio.rest.jaxrs.model.TitlePutData; import org.folio.rest.jaxrs.model.TitlePutDataAttributes; import org.folio.rest.jaxrs.model.TitlePutRequest; -import org.folio.rmapi.result.ResourceResult; import org.junit.jupiter.api.Test; class TitlePutRequestConverterTest { @@ -40,11 +39,13 @@ void shouldCreateRequestToUpdatePublicationTypeForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setPublicationType(PublicationType.BOOK_SERIES); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertEquals("bookseries", resourcePut.getPubType()); //from ProxyUrl to Proxy assertEquals(OLD_PROXY_ID, resourcePut.getProxy().getId()); assertFalse(resourcePut.getProxy().getInherited()); + // visibility is left out, so HoldingsIQ keeps the current visibility of all categories + assertNull(resourcePut.getVisibilityDetails()); } @Test @@ -52,7 +53,7 @@ void shouldCreateRequestToUpdateIsPeerReviewedForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setIsPeerReviewed(false); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertFalse(resourcePut.getIsPeerReviewed()); } @@ -61,7 +62,7 @@ void shouldCreateRequestToUpdateResourceNameForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setName("test name"); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertEquals("test name", resourcePut.getTitleName()); } @@ -70,7 +71,7 @@ void shouldCreateRequestToUpdatePublisherNameForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setPublisherName("test pub name"); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertEquals("test pub name", resourcePut.getPublisherName()); } @@ -79,7 +80,7 @@ void shouldCreateRequestToUpdateEditionForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setEdition("test edition"); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertEquals("test edition", resourcePut.getEdition()); } @@ -88,33 +89,24 @@ void shouldCreateRequestToUpdateDescriptionForCustomResource() { var request = createEmptyTitlePutRequest(); request.getData().getAttributes().setDescription("test description"); var resourcePut = converter.convertToRmApiCustomResourcePutRequest(request, - createResourceData().getTitle().getCustomerResourcesList().getFirst()); + createOldResource()); assertEquals("test description", resourcePut.getDescription()); } - private ResourceResult createResourceData() { - var title = Title.builder() - .contributorsList(Collections.emptyList()) - .customerResourcesList(Collections.singletonList(CustomerResources.builder() - .coverageStatement(OLD_COVERAGE_STATEMENT) - .isSelected(false) - .visibilityData(VisibilityInfo.builder() - .isHidden(OLD_VISIBILITY_DATA).build()) - .customCoverageList(Collections.singletonList(CoverageDates.builder() - .beginCoverage(OLD_BEGIN_COVERAGE).endCoverage(OLD_END_COVERAGE).build())) - .customEmbargoPeriod(EmbargoPeriod.builder() - .embargoUnit(OLD_EMBARGO_UNIT).embargoValue(OLD_EMBARGO_VALUE).build()) - .proxy(ProxyUrl.builder().proxiedUrl(OLD_URL) - .id(OLD_PROXY_ID).inherited(true).build()) - .url(OLD_URL) - .userDefinedFields(UserDefinedFields.builder().build()) - .build() - )) - .identifiersList(Collections.emptyList()) - .subjectsList(Collections.emptyList()) - .titleId(1) + private CustomerResources createOldResource() { + return CustomerResources.builder() + .coverageStatement(OLD_COVERAGE_STATEMENT) + .isSelected(false) + .visibilityDetails(Collections.singletonList(new Visibility("PF", OLD_VISIBILITY_DATA, ""))) + .customCoverageList(Collections.singletonList(CoverageDates.builder() + .beginCoverage(OLD_BEGIN_COVERAGE).endCoverage(OLD_END_COVERAGE).build())) + .customEmbargoPeriod(EmbargoPeriod.builder() + .embargoUnit(OLD_EMBARGO_UNIT).embargoValue(OLD_EMBARGO_VALUE).build()) + .proxy(ProxyUrl.builder().proxiedUrl(OLD_URL) + .id(OLD_PROXY_ID).inherited(true).build()) + .url(OLD_URL) + .userDefinedFields(UserDefinedFields.builder().build()) .build(); - return new ResourceResult(title, null, null, false); } private TitlePutRequest createEmptyTitlePutRequest() { diff --git a/src/test/java/org/folio/rest/impl/EholdingsPackagesImplTest.java b/src/test/java/org/folio/rest/impl/EholdingsPackagesImplTest.java index 2ccb33e77..acb2e68b0 100644 --- a/src/test/java/org/folio/rest/impl/EholdingsPackagesImplTest.java +++ b/src/test/java/org/folio/rest/impl/EholdingsPackagesImplTest.java @@ -282,7 +282,7 @@ void shouldFetchResourcesByAccessTypeFilterWhenAccessTypeFilterIsGiven() { @Test void shouldRetrievePackageTitlesWhenNoTagOrAccessTypeFilterIsGiven() { - var filter = ResourceFilter.builder().packageId("19-3964").filterName("test").sort("relevance") + var filter = ResourceFilter.builder().packageId("19-3964").query("test").queryField("name").sort("relevance") .page(1).count(25).build(); Function<RmApiTemplateContext, CompletableFuture<?>> stubFunction = ctx -> completedFuture(null); when(packageService.retrievePackageTitles(filter)).thenReturn(stubFunction); @@ -359,8 +359,8 @@ private void invokeGetEholdingsPackages(PackageRecordFilter filter) { private void invokeGetResources(ResourceFilter filter) { impl.getEholdingsPackagesResourcesByPackageId(filter.getPackageId(), filter.getFilterTags(), - filter.getFilterAccessType(), filter.getFilterSelected(), filter.getFilterType(), filter.getFilterName(), - filter.getFilterIsxn(), filter.getFilterSubject(), filter.getFilterPublisher(), filter.getSort(), + filter.getFilterAccessType(), filter.getQuery(), filter.getQueryField(), filter.getFilterSelected(), + filter.getFilterType(), filter.getFilterAccess(), null, null, null, null, filter.getSort(), filter.getPage(), filter.getCount(), OKAPI_HEADERS, asyncResultHandler, null); } } diff --git a/src/test/java/org/folio/rest/impl/EholdingsPackagesIntegrationTest.java b/src/test/java/org/folio/rest/impl/EholdingsPackagesIntegrationTest.java index be5c40c0a..55a70998e 100644 --- a/src/test/java/org/folio/rest/impl/EholdingsPackagesIntegrationTest.java +++ b/src/test/java/org/folio/rest/impl/EholdingsPackagesIntegrationTest.java @@ -104,10 +104,11 @@ class EholdingsPackagesIntegrationTest extends IntegrationTestBase { "responses/rmapi/packages/get-custom-package-by-id-response.json"; private static final String RESOURCES_BY_PACKAGE_ID_STUB_FILE = "responses/rmapi/resources/get-resources-by-package-id-response.json"; + + // the resources-by-package fixture belongs to provider 295 + private static final String RESOURCES_FIXTURE_PACKAGE_ID = "295-" + STUB_PACKAGE_ID; private static final String RESOURCES_BY_PACKAGE_ID_EMPTY_STUB_FILE = "responses/rmapi/resources/get-resources-by-package-id-response-empty.json"; - private static final String RESOURCES_BY_PACKAGE_ID_EMPTY_CUSTOMER_RESOURCE_LIST_STUB_FILE = - "responses/rmapi/resources/get-resources-by-package-id-response-empty-customer-list.json"; private static final String VENDOR_BY_PACKAGE_ID_STUB_FILE = "responses/rmapi/vendors/get-vendor-by-id-for-package.json"; private static final String GET_PACKAGES_RESPONSE = @@ -128,8 +129,8 @@ class EholdingsPackagesIntegrationTest extends IntegrationTestBase { "responses/rmapi/packages/get-package-by-id-not-found-response.json"; private static final String GET_PROXIES_CUSTOMLABELS_RESPONSE = "responses/rmapi/proxiescustomlabels/get-success-response.json"; - private static final String GET_TITLE_BY_ID_RESPONSE = - "responses/rmapi/titles/get-title-by-id-response.json"; + private static final String GET_RESOURCE_BY_ID_RESPONSE = + "responses/rmapi/resources/get-resource-by-id-success-response.json"; // KB-EBSCO expected responses private static final String EXPECTED_PACKAGE_BY_ID_STUB_FILE = @@ -384,6 +385,16 @@ void shouldReturnPackagesOnGetById() { assertJsonEqual(readFile(EXPECTED_PACKAGE_BY_ID_STUB_FILE), packages); } + @Test + void shouldReturn404OnGetByIdWhenPackageBelongsToAnotherProvider() { + mockGet(matching(packageRmApi(STUB_PACKAGE_ID)), readFile(CUSTOM_PACKAGE_STUB_FILE)); + + var error = getWithStatus(packagePath((STUB_VENDOR_ID + 1) + "-" + STUB_PACKAGE_ID), SC_NOT_FOUND) + .as(JsonapiError.class); + + assertErrorContainsTitle(error, "not found"); + } + @Test void shouldReturnPackageWithTagOnGetById() { saveTag(vertx, FULL_PACKAGE_ID, PACKAGE, STUB_TAG_VALUE); @@ -534,6 +545,8 @@ void shouldReturnResourcesWhenIncludedFlagIsSetToResources() { var expectedPackage = readJsonFile(EXPECTED_PACKAGE_BY_ID_STUB_FILE, Package.class); var expectedResources = readJsonFile(EXPECTED_RESOURCES_STUB_FILE, ResourceCollection.class); + // titleRelationships are omitted when not requested; the generated model would serialize its default [] + expectedResources.getData().forEach(item -> item.getAttributes().setTitleRelationships(null)); expectedPackage.getIncluded().addAll(expectedResources.getData()); assertJsonEqual(Json.encode(expectedPackage), Json.encode(actual)); @@ -984,24 +997,56 @@ void shouldReturn400WhenPackagePostDataIsInvalid() { assertErrorContainsTitle(response.as(JsonapiError.class), "Custom Package with the provided name already exists"); } + @Test + void shouldSendZdbidAndAccessFiltersToRmApiOnGetWithResources() { + mockResourceById(RESOURCES_BY_PACKAGE_ID_STUB_FILE); + + getWithOk(resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID) + "?q=2071469-8&q[field]=zdbid&filter[access]=controlled"); + + wm.verify(1, getRequestedFor(urlPathEqualTo(packageTitlesRmApi(STUB_PACKAGE_ID))) + .withQueryParam("searchfield", WireMock.equalTo("zdbid")) + .withQueryParam("search", WireMock.equalTo("2071469-8")) + .withQueryParam("packagefreeaccess", WireMock.equalTo("false"))); + } + + @Test + void shouldMapLegacyFilterNameToSearchOnGetWithResources() { + mockResourceById(RESOURCES_BY_PACKAGE_ID_STUB_FILE); + + getWithOk(resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID) + "?filter[publisher]=academic"); + + wm.verify(1, getRequestedFor(urlPathEqualTo(packageTitlesRmApi(STUB_PACKAGE_ID))) + .withQueryParam("searchfield", WireMock.equalTo("publisher")) + .withQueryParam("search", WireMock.equalTo("academic"))); + } + + @Test + void shouldReturn400WhenFilterAccessIsInvalidOnGetWithResources() { + var error = getWithStatus(resourcesPath(FULL_PACKAGE_ID) + "?filter[access]=free", SC_BAD_REQUEST) + .as(JsonapiError.class); + + assertErrorContainsTitle(error, "Invalid Query Parameter for filter[access]"); + } + @Test void shouldReturnDefaultResourcesOnGetWithResources() { String query = "?searchfield=titlename&selection=all&resourcetype=all" - + "&searchtype=advanced&search=&offset=1&count=25&orderby=titlename"; - shouldReturnResourcesOnGetWithResources(resourcesPath(FULL_PACKAGE_ID), query); + + "&search=&offset=1&count=25&orderby=titlename"; + shouldReturnResourcesOnGetWithResources(resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID), query); } @Test void shouldReturnResourcesWithPagingOnGetWithResources() { - var resourcesUrl = resourcesPath(FULL_PACKAGE_ID) + "?page=2"; + var resourcesUrl = resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID) + "?page=2"; var query = "?searchfield=titlename&selection=all&resourcetype=all" - + "&searchtype=advanced&search=&offset=2&count=25&orderby=titlename"; + + "&search=&offset=2&count=25&orderby=titlename"; shouldReturnResourcesOnGetWithResources(resourcesUrl, query); } @Test void shouldReturnEmptyListWhenResourcesAreNotFound() { mockResourceById(RESOURCES_BY_PACKAGE_ID_EMPTY_STUB_FILE); + mockGet(matching(packageRmApi(STUB_PACKAGE_ID)), readFile(CUSTOM_PACKAGE_STUB_FILE)); var actual = getWithOk(resourcesPath(FULL_PACKAGE_ID)).as(ResourceCollection.class); assertTrue(actual.getData().isEmpty()); @@ -1014,17 +1059,17 @@ void shouldReturnResourcesWithTagsOnGetWithResources() { saveTag(vertx, "295-2545963-2172685", RESOURCE, STUB_TAG_VALUE_2); saveTag(vertx, "295-2545963-2172685", RESOURCE, STUB_TAG_VALUE_3); - String query = "?searchfield=titlename&selection=all&resourcetype=all&searchtype=advanced" + String query = "?searchfield=titlename&selection=all&resourcetype=all" + "&search=&offset=1&count=25&orderby=titlename"; mockResourceById(RESOURCES_BY_PACKAGE_ID_STUB_FILE); - var actual = getWithOk(resourcesPath(FULL_PACKAGE_ID)).asString(); + var actual = getWithOk(resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID)).asString(); var expected = readFile(EXPECTED_RESOURCES_WITH_TAGS_STUB_FILE); assertJsonEqual(expected, actual); - wm.verify(1, getRequestedFor(urlEqualTo(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + query))); + wm.verify(1, getRequestedFor(urlEqualTo(packageTitlesRmApi(STUB_PACKAGE_ID) + query))); } @Test @@ -1033,7 +1078,7 @@ void shouldReturnResourcesWithAccessTypesOnGetWithResources() { insertAccessTypeMapping(STUB_MANAGED_RESOURCE_ID, RESOURCE, accessTypes.getFirst().getId(), vertx); insertAccessTypeMapping(STUB_MANAGED_RESOURCE_ID_2, RESOURCE, accessTypes.getFirst().getId(), vertx); - mockResourceById(GET_TITLE_BY_ID_RESPONSE); + mockResourceById(GET_RESOURCE_BY_ID_RESPONSE); var resourcePath = withAccessTypeFilters(resourcesPath(FULL_PACKAGE_ID), STUB_ACCESS_TYPE_NAME); var resourceCollection = getWithOk(resourcePath).as(ResourceCollection.class); @@ -1052,7 +1097,7 @@ void shouldReturnResourcesWithAccessTypesOnGetWithResourcesWithPagination() { insertAccessTypeMapping(STUB_MANAGED_RESOURCE_ID, RESOURCE, accessTypes.get(0).getId(), vertx); insertAccessTypeMapping(STUB_MANAGED_RESOURCE_ID_2, RESOURCE, accessTypes.get(1).getId(), vertx); - mockResourceById(GET_TITLE_BY_ID_RESPONSE); + mockResourceById(GET_RESOURCE_BY_ID_RESPONSE); var resourcePath = withAccessTypeFilters(resourcesPath(FULL_PACKAGE_ID) + "?page=2&count=1", STUB_ACCESS_TYPE_NAME, STUB_ACCESS_TYPE_NAME_2); @@ -1070,10 +1115,10 @@ void shouldReturnResourcesWithAccessTypesOnGetWithResources1() { insertAccessTypeMapping("295-2545963-2099944", RESOURCE, accessTypes.get(0).getId(), vertx); insertAccessTypeMapping("295-2545963-2172685", RESOURCE, accessTypes.get(1).getId(), vertx); - mockResourceById(GET_TITLE_BY_ID_RESPONSE); + mockResourceById(GET_RESOURCE_BY_ID_RESPONSE); mockResourceById(RESOURCES_BY_PACKAGE_ID_STUB_FILE); - var resourceCollection = getWithOk(resourcesPath(FULL_PACKAGE_ID)).as(ResourceCollection.class); + var resourceCollection = getWithOk(resourcesPath(RESOURCES_FIXTURE_PACKAGE_ID)).as(ResourceCollection.class); var resources = resourceCollection.getData(); assertEquals(5, (int) resourceCollection.getMeta().getTotalResults()); @@ -1090,18 +1135,18 @@ void shouldReturnResourcesWithAccessTypesOnGetWithResources1() { } @Test - void shouldReturnFilteredResourcesWithNonEmptyCustomerResourceList() { - mockResourceById(RESOURCES_BY_PACKAGE_ID_EMPTY_CUSTOMER_RESOURCE_LIST_STUB_FILE); + void shouldReturn404OnGetWithResourcesWhenPackageBelongsToAnotherProvider() { + mockResourceById(RESOURCES_BY_PACKAGE_ID_STUB_FILE); - var resourceCollection = getWithOk(resourcesPath(FULL_PACKAGE_ID)).as(ResourceCollection.class); + var error = getWithStatus(resourcesPath("296-" + STUB_PACKAGE_ID), SC_NOT_FOUND).as(JsonapiError.class); - var metaTotalResults = resourceCollection.getMeta(); - assertEquals(3, metaTotalResults.getTotalResults()); + assertErrorContainsTitle(error, "not found"); } @Test void shouldReturn404OnGetWithResourcesWhenPackageNotFound() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), SC_NOT_FOUND); + mockResourceById(RESOURCES_BY_PACKAGE_ID_EMPTY_STUB_FILE); + mockGet(matching(packageRmApi(STUB_PACKAGE_ID)), SC_NOT_FOUND); var error = getWithStatus(resourcesPath(FULL_PACKAGE_ID), SC_NOT_FOUND).as(JsonapiError.class); @@ -1119,7 +1164,7 @@ void shouldReturn400OnGetWithResourcesWhenCountOutOfRange() { @Test void shouldReturn400OnGetWithResourcesWhenRmApi400() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), readFile(GET_PACKAGE_RESOURCES_400_RESPONSE), SC_BAD_REQUEST); var error = getWithStatus(resourcesPath(FULL_PACKAGE_ID), SC_BAD_REQUEST).as(JsonapiError.class); @@ -1129,7 +1174,7 @@ void shouldReturn400OnGetWithResourcesWhenRmApi400() { @Test void shouldReturnUnauthorizedOnGetWithResourcesWhenRmApi401() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), SC_UNAUTHORIZED); + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), SC_UNAUTHORIZED); var error = getWithStatus(resourcesPath(FULL_PACKAGE_ID), SC_FORBIDDEN).as(JsonapiError.class); @@ -1138,7 +1183,7 @@ void shouldReturnUnauthorizedOnGetWithResourcesWhenRmApi401() { @Test void shouldReturnUnauthorizedOnGetWithResourcesWhenRmApi403() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), SC_FORBIDDEN); + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), SC_FORBIDDEN); var error = getWithStatus(resourcesPath(FULL_PACKAGE_ID), SC_FORBIDDEN).as(JsonapiError.class); @@ -1289,11 +1334,11 @@ private void shouldReturnResourcesOnGetWithResources(String getUrl, String rmApi assertJsonEqual(expected, actual); - wm.verify(1, getRequestedFor(urlEqualTo(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + rmApiQuery))); + wm.verify(1, getRequestedFor(urlEqualTo(packageTitlesRmApi(STUB_PACKAGE_ID) + rmApiQuery))); } private void mockResourceById(String stubFile) { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), readFile(stubFile)); + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), readFile(stubFile)); } private void mockUpdateScenario(String initialPackage, String updatedPackage) { diff --git a/src/test/java/org/folio/rest/impl/EholdingsResourcesImplIntegrationTest.java b/src/test/java/org/folio/rest/impl/EholdingsResourcesImplIntegrationTest.java index 9b48ea848..47d4d11eb 100644 --- a/src/test/java/org/folio/rest/impl/EholdingsResourcesImplIntegrationTest.java +++ b/src/test/java/org/folio/rest/impl/EholdingsResourcesImplIntegrationTest.java @@ -1,13 +1,17 @@ package org.folio.rest.impl; +import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; +import static com.github.tomakehurst.wiremock.client.WireMock.anyUrl; import static com.github.tomakehurst.wiremock.client.WireMock.equalTo; import static com.github.tomakehurst.wiremock.client.WireMock.equalToJson; import static com.github.tomakehurst.wiremock.client.WireMock.matching; +import static com.github.tomakehurst.wiremock.client.WireMock.urlPathEqualTo; import static java.lang.String.format; import static org.folio.HttpStatus.SC_BAD_REQUEST; import static org.folio.HttpStatus.SC_INTERNAL_SERVER_ERROR; import static org.folio.HttpStatus.SC_NOT_FOUND; import static org.folio.HttpStatus.SC_NO_CONTENT; +import static org.folio.HttpStatus.SC_OK; import static org.folio.HttpStatus.SC_UNPROCESSABLE_CONTENT; import static org.folio.repository.RecordType.RESOURCE; import static org.folio.repository.accesstypes.AccessTypeMappingsTableConstants.ACCESS_TYPES_MAPPING_TABLE_NAME; @@ -33,8 +37,11 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertTrue; +import com.github.tomakehurst.wiremock.client.WireMock; import com.github.tomakehurst.wiremock.matching.EqualToJsonPattern; import io.vertx.core.json.Json; +import io.vertx.core.json.JsonArray; +import io.vertx.core.json.JsonObject; import java.util.Arrays; import java.util.Collections; import java.util.List; @@ -47,6 +54,7 @@ import org.folio.rest.jaxrs.model.ResourceTags; import org.folio.rest.jaxrs.model.ResourceTagsPutRequest; import org.folio.rest.jaxrs.model.Tags; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.util.IntegrationTestBase; import org.folio.util.ResourcesTestUtil; import org.folio.util.TagsTestUtil; @@ -57,20 +65,18 @@ class EholdingsResourcesImplIntegrationTest extends IntegrationTestBase { // RM API response files + private static final String RMAPI_GET_RESOURCE_WITH_RELATIONSHIPS = + "responses/rmapi/resources/get-resource-by-id-with-relationships-response.json"; private static final String RMAPI_GET_RESOURCE_BY_ID_SUCCESS = "responses/rmapi/resources/get-resource-by-id-success-response.json"; private static final String RMAPI_GET_RESOURCE_NOT_FOUND = "responses/rmapi/resources/get-resource-by-id-not-found-response.json"; - private static final String RMAPI_GET_RESOURCE_EMPTY_CUSTOMER_LIST = - "responses/rmapi/resources/get-resource-by-id-response-empty-customer-list.json"; private static final String RMAPI_GET_MANAGED_RESOURCE_UPDATED = "responses/rmapi/resources/get-managed-resource-updated-response.json"; private static final String RMAPI_GET_MANAGED_RESOURCE_UPDATED_NOT_SELECTED = "responses/rmapi/resources/get-managed-resource-updated-response-is-selected-false.json"; private static final String RMAPI_GET_CUSTOM_RESOURCE_UPDATED = "responses/rmapi/resources/get-custom-resource-updated-response.json"; - private static final String RMAPI_GET_RESOURCES_BY_PACKAGE_ID = - "responses/rmapi/resources/get-resources-by-package-id-response.json"; private static final String RMAPI_GET_VENDOR_FOR_RESOURCE = "responses/rmapi/vendors/get-vendor-by-id-for-resource.json"; private static final String RMAPI_GET_PACKAGE_FOR_RESOURCE = @@ -232,7 +238,7 @@ void shouldReturnResourceWithAllIncludedObjectsWhenIncludeContainsAllObjects() { @Test void shouldReturn404WhenRmApiNotFoundOnResourceGet() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), readFile(RMAPI_GET_RESOURCE_NOT_FOUND), SC_NOT_FOUND); var error = getWithStatus(STUB_MANAGED_RESOURCE_PATH, SC_NOT_FOUND).as(JsonapiError.class); @@ -241,12 +247,42 @@ void shouldReturn404WhenRmApiNotFoundOnResourceGet() { } @Test - void shouldReturn404WhenCustomerListIsEmpty() { - mockResource(RMAPI_GET_RESOURCE_EMPTY_CUSTOMER_LIST); + void shouldReturn404WhenResourceBelongsToAnotherProvider() { + mockResource(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); - var error = getWithStatus(STUB_MANAGED_RESOURCE_PATH, SC_NOT_FOUND).as(JsonapiError.class); + var wrongProviderId = (STUB_VENDOR_ID + 1) + "-" + STUB_PACKAGE_ID + "-" + STUB_MANAGED_TITLE_ID; + var error = getWithStatus(RESOURCE_BY_ID_PATH.formatted(wrongProviderId), SC_NOT_FOUND).as(JsonapiError.class); - assertErrorContainsTitle(error, "Title is no longer in this package"); + assertErrorContainsTitle(error, "Title is no longer in this package."); + } + + @Test + void shouldReturnTitleRelationshipsWhenIncluded() { + mockResource(RMAPI_GET_RESOURCE_WITH_RELATIONSHIPS); + + var resource = getWithOk(STUB_MANAGED_RESOURCE_PATH + "?include=relationships").as(Resource.class); + + wm.verify(1, WireMock.getRequestedFor( + urlPathEqualTo(resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID))) + .withQueryParam("includerelationships", equalTo("true"))); + var relationships = resource.getData().getAttributes().getTitleRelationships(); + assertEquals(1, relationships.size()); + assertEquals("CONTINUED_BY", relationships.getFirst().getType()); + assertEquals(STUB_MANAGED_TITLE_ID, relationships.getFirst().getSource().getTitleId()); + assertEquals(4444, relationships.getFirst().getTarget().getTitleId()); + } + + @Test + void shouldReturnVisibilityPerCategoryAlongsideVisibilityData() { + mockResource(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); + + var attributes = getWithOk(STUB_MANAGED_RESOURCE_PATH).as(Resource.class).getData().getAttributes(); + + assertTrue(attributes.getVisibilityData().getIsHidden()); + assertEquals(List.of("PF", "FTF", "MARC"), attributes.getVisibility().stream() + .map(visibility -> visibility.getCategory().value()) + .toList()); + assertTrue(attributes.getVisibility().stream().allMatch(Visibility::getHidden)); } @Test @@ -259,7 +295,7 @@ void shouldReturn400WhenValidationErrorOnResourceGet() { @Test void shouldReturn500WhenRmApiReturns500ErrorOnResourceGet() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), SC_INTERNAL_SERVER_ERROR); + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), SC_INTERNAL_SERVER_ERROR); var error = getWithStatus(STUB_MANAGED_RESOURCE_PATH, SC_INTERNAL_SERVER_ERROR) .as(JsonapiError.class); @@ -269,7 +305,7 @@ void shouldReturn500WhenRmApiReturns500ErrorOnResourceGet() { @Test void shouldReturnUpdatedValuesManagedResourceOnSuccessfulPut() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var actualResponse = mockUpdateResourceScenario(RMAPI_GET_MANAGED_RESOURCE_UPDATED, managedResourceEndpoint, STUB_MANAGED_RESOURCE_ID, readFile(REQUEST_PUT_MANAGED_RESOURCE)); @@ -283,7 +319,7 @@ void shouldReturnUpdatedValuesManagedResourceOnSuccessfulPut() { void shouldCreateNewAccessTypeMappingOnSuccessfulPut() { var accessTypes = insertAccessTypes(testData(credentialsId), vertx); var accessTypeId = accessTypes.getFirst().getId(); - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var requestBody = format(readFile(REQUEST_PUT_RESOURCE_WITH_ACCESS_TYPE), accessTypeId); var actualResponse = mockUpdateResourceScenario(RMAPI_GET_MANAGED_RESOURCE_UPDATED, @@ -306,7 +342,7 @@ void shouldDeleteAccessTypeMappingOnSuccessfulPut() { var accessTypeId = accessTypes.getFirst().getId(); insertAccessTypeMapping(STUB_MANAGED_RESOURCE_ID, RESOURCE, accessTypeId, vertx); - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var actualResponse = mockUpdateResourceScenario(RMAPI_GET_MANAGED_RESOURCE_UPDATED, managedResourceEndpoint, STUB_MANAGED_RESOURCE_ID, readFile(REQUEST_PUT_MANAGED_RESOURCE)); @@ -321,7 +357,7 @@ void shouldDeleteAccessTypeMappingOnSuccessfulPut() { @Test void shouldReturn400OnPutPackageWithNotExistedAccessType() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var error = putWithStatus(STUB_MANAGED_RESOURCE_PATH, readFile(REQUEST_PUT_MANAGED_RESOURCE_MISSING_ACCESS_TYPE), SC_BAD_REQUEST, CONTENT_TYPE_HEADER).as(JsonapiError.class); @@ -333,7 +369,7 @@ void shouldReturn400OnPutPackageWithNotExistedAccessType() { @Test void shouldReturn422OnPutPackageWithInvalidAccessTypeId() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var error = putWithStatus(STUB_MANAGED_RESOURCE_PATH, readFile(REQUEST_PUT_MANAGED_RESOURCE_INVALID_ACCESS_TYPE), SC_UNPROCESSABLE_CONTENT, CONTENT_TYPE_HEADER).as(Errors.class); @@ -348,7 +384,7 @@ void shouldReturn422OnPutPackageWithInvalidAccessTypeId() { @Test void shouldDeselectManagedResourceOnPutWithSelectedFalse() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); var request = readJsonFile(REQUEST_PUT_MANAGED_RESOURCE_NOT_SELECTED, ResourcePutRequest.class); request.getData().getAttributes().setIsSelected(false); @@ -357,6 +393,8 @@ void shouldDeselectManagedResourceOnPutWithSelectedFalse() { var expectedResource = readJsonFile(EXPECTED_MANAGED_RESOURCE, Resource.class); expectedResource.getData().getAttributes().setIsSelected(false); + // titleRelationships are omitted when not requested; the generated model would serialize its default [] + expectedResource.getData().getAttributes().setTitleRelationships(null); assertJsonEqual(Json.encode(expectedResource), actualResponse, false); verifyPut(matching(managedResourceEndpoint), @@ -365,7 +403,7 @@ void shouldDeselectManagedResourceOnPutWithSelectedFalse() { @Test void shouldReturnUpdatedValuesCustomResourceOnSuccessfulPut() { - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); var actualResponse = mockUpdateResourceScenario(RMAPI_GET_CUSTOM_RESOURCE_UPDATED, customResourceEndpoint, STUB_CUSTOM_RESOURCE_ID, readFile(REQUEST_PUT_CUSTOM_RESOURCE)); @@ -377,7 +415,7 @@ void shouldReturnUpdatedValuesCustomResourceOnSuccessfulPut() { @Test void shouldAcceptValuesCustomResourceWithUnrecognizedFieldInProxy() { - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); var actualResponse = mockUpdateResourceScenario(RMAPI_GET_CUSTOM_RESOURCE_UPDATED, customResourceEndpoint, STUB_CUSTOM_RESOURCE_ID, readFile(REQUEST_PUT_CUSTOM_RESOURCE_WITH_PROXIED_URL)); @@ -419,7 +457,7 @@ void shouldReturn422OnPutTagsWhenRequestBodyIsInvalid() { @Test void shouldReturn422WhenInvalidUrlIsProvidedForCustomResource() { - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); mockGet(matching(customResourceEndpoint), readFile(RMAPI_GET_CUSTOM_RESOURCE_UPDATED)); @@ -430,14 +468,38 @@ void shouldReturn422WhenInvalidUrlIsProvidedForCustomResource() { assertErrorContainsTitle(error, "Invalid url"); } + @Test + void shouldSendVisibilityPerCategoryToRmApiOnPut() { + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var request = new JsonObject(readFile(REQUEST_PUT_MANAGED_RESOURCE)); + request.getJsonObject("data").getJsonObject("attributes") + .put("visibility", new JsonArray() + .add(new JsonObject().put("category", "PF").put("hidden", true)) + .add(new JsonObject().put("category", "FTF").put("hidden", false)) + .add(new JsonObject().put("category", "MARC").put("hidden", true))); + + mockUpdateResourceScenario(RMAPI_GET_MANAGED_RESOURCE_UPDATED, managedResourceEndpoint, + STUB_MANAGED_RESOURCE_ID, request.encode()); + + var expectedVisibility = """ + [{"category": "PF", "hidden": true, "reason": "Hidden by Customer"}, + {"category": "FTF", "hidden": false}, + {"category": "MARC", "hidden": true, "reason": "Hidden by Customer"}] + """; + verifyPut(matching(managedResourceEndpoint), + WireMock.matchingJsonPath("$.visibility", equalToJson(expectedVisibility))); + } + @Test void shouldPostResourceToRmApi() { - mockPackageResources(RMAPI_GET_RESOURCES_BY_PACKAGE_ID); mockPackage(RMAPI_GET_CUSTOM_PACKAGE); mockTitle(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); - mockResource(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + // the title is not in the package before the post, and is returned as a resource after it + mockResponseList(urlPathEqualTo(managedResourceEndpoint), + aResponse().withStatus(SC_NOT_FOUND), + aResponse().withStatus(SC_OK).withBody(readFile(RMAPI_GET_RESOURCE_BY_ID_SUCCESS))); var putRequestBodyPattern = new EqualToJsonPattern(readFile(RMAPI_SELECT_RESOURCE_REQUEST), true, true); mockPut(matching(managedResourceEndpoint), putRequestBodyPattern, SC_NO_CONTENT); @@ -459,9 +521,21 @@ void shouldReturn404IfTitleOrPackageIsNotFound() { assertErrorContainsTitle(error, "not found"); } + @Test + void shouldReturn422IfTitleIsAlreadyInPackage() { + mockPackage(RMAPI_GET_CUSTOM_PACKAGE); + mockTitle(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); + mockResource(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); + + var error = + postWithStatus(RESOURCES_PATH, readFile(REQUEST_POST_RESOURCES), SC_UNPROCESSABLE_CONTENT).as(JsonapiError.class); + + assertErrorContainsTitle(error, "Invalid Title"); + verifyPut(anyUrl(), 0); + } + @Test void shouldReturn422IfPackageIsNotCustom() { - mockPackageResources(RMAPI_GET_RESOURCES_BY_PACKAGE_ID); mockPackage(RMAPI_GET_PACKAGE_FOR_RESOURCE); mockTitle(RMAPI_GET_RESOURCE_BY_ID_SUCCESS); @@ -474,7 +548,7 @@ void shouldReturn422IfPackageIsNotCustom() { @Test void shouldSendDeleteRequestForResourceAssociatedWithCustomPackage() { var putBodyPattern = new EqualToJsonPattern("{\"isSelected\":false}", true, true); - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); deleteResource(putBodyPattern); verifyPut(equalTo(customResourceEndpoint), putBodyPattern); @@ -509,7 +583,7 @@ void shouldReturn400WhenResourceIdIsInvalid() { @Test void shouldReturn400WhenTryingToDeleteResourceAssociatedWithManagedPackage() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); mockGet(equalTo(managedResourceEndpoint), readFile(RMAPI_GET_MANAGED_RESOURCE_UPDATED)); @@ -521,7 +595,7 @@ void shouldReturn400WhenTryingToDeleteResourceAssociatedWithManagedPackage() { @Test void shouldReturnListWithBulkFetchResources() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); mockGet(equalTo(managedResourceEndpoint), readFile(RMAPI_GET_RESOURCE_BY_ID_SUCCESS)); @@ -548,9 +622,9 @@ void shouldReturnResponseWhenIdIsTooLong() { @Test void shouldReturnResourcesAndFailedIds() { - var managedResourceEndpoint = resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); - var thirdResourceEndpoint = resourcesRmApi(186, 3150130, 19087948); + var managedResourceEndpoint = resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var thirdResourceEndpoint = resourcesRmApi(3150130, 19087948); mockGet(equalTo(managedResourceEndpoint), readFile(RMAPI_GET_RESOURCE_BY_ID_SUCCESS)); mockGet(equalTo(customResourceEndpoint), readFile(RMAPI_GET_CUSTOM_RESOURCE_UPDATED)); @@ -563,7 +637,7 @@ void shouldReturnResourcesAndFailedIds() { @Test void shouldReturnErrorWhenRmApiFails() { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), SC_INTERNAL_SERVER_ERROR); + mockGet(matching(packageTitlesRmApi(STUB_PACKAGE_ID) + ".*"), SC_INTERNAL_SERVER_ERROR); var bulkFetchCollection = postWithOk(RESOURCES_BULK_FETCH, readFile(REQUEST_POST_RESOURCES_BULK)) .as(ResourceBulkFetchCollection.class); @@ -573,16 +647,12 @@ void shouldReturnErrorWhenRmApiFails() { assertEquals(STUB_MANAGED_RESOURCE_ID, bulkFetchCollection.getMeta().getFailed().getResources().getFirst()); } - private void mockPackageResources(String responseFile) { - mockGet(matching(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID) + ".*"), readFile(responseFile)); - } - private void mockPackage(String responseFile) { mockGet(matching(packageRmApi(STUB_PACKAGE_ID)), readFile(responseFile)); } private void mockResource(String responseFile) { - mockGet(matching(resourcesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID)), + mockGet(matching(resourcesRmApi(STUB_PACKAGE_ID, STUB_MANAGED_TITLE_ID)), readFile(responseFile)); } @@ -612,7 +682,7 @@ private void sendPutTags(List<String> newTags) { } private void deleteResource(EqualToJsonPattern putBodyPattern) { - var customResourceEndpoint = resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); + var customResourceEndpoint = resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID); mockGet(equalTo(customResourceEndpoint), readFile(RMAPI_GET_CUSTOM_RESOURCE_UPDATED)); mockPut(equalTo(customResourceEndpoint), putBodyPattern, SC_NO_CONTENT); diff --git a/src/test/java/org/folio/rest/impl/EholdingsTitlesIntegrationTest.java b/src/test/java/org/folio/rest/impl/EholdingsTitlesIntegrationTest.java index 822a47af7..46779069b 100644 --- a/src/test/java/org/folio/rest/impl/EholdingsTitlesIntegrationTest.java +++ b/src/test/java/org/folio/rest/impl/EholdingsTitlesIntegrationTest.java @@ -41,6 +41,7 @@ import static org.hamcrest.Matchers.hasProperty; import static org.hamcrest.Matchers.not; import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertFalse; import static org.junit.jupiter.api.Assertions.assertTrue; import com.github.tomakehurst.wiremock.client.WireMock; @@ -72,6 +73,8 @@ class EholdingsTitlesIntegrationTest extends IntegrationTestBase { // RMAPI stub response files private static final String RMAPI_TITLES_SEARCH_RESPONSE = "responses/rmapi/titles/searchTitles.json"; + private static final String RMAPI_TITLE_WITH_RELATIONSHIPS_RESPONSE = + "responses/rmapi/titles/get-title-by-id-with-relationships-response.json"; private static final String RMAPI_TITLE_BY_ID_RESPONSE = "responses/rmapi/titles/get-title-by-id-response.json"; private static final String RMAPI_TITLE_BY_ID_2_RESPONSE = @@ -87,11 +90,11 @@ class EholdingsTitlesIntegrationTest extends IntegrationTestBase { private static final String RMAPI_PACKAGE_400_RESPONSE = "responses/rmapi/packages/post-package-400-error-response.json"; private static final String RMAPI_RESOURCE_UPDATED_RESPONSE = - "responses/rmapi/resources/get-custom-resource-updated-response.json"; + "responses/rmapi/titles/get-custom-title-updated-response.json"; private static final String RMAPI_RESOURCE_UPDATED_TITLE_NAME_RESPONSE = - "responses/rmapi/resources/get-custom-resource-updated-title-name-response.json"; + "responses/rmapi/titles/get-custom-title-updated-name-response.json"; private static final String RMAPI_MANAGED_RESOURCE_UPDATED_RESPONSE = - "responses/rmapi/resources/get-managed-resource-updated-response.json"; + "responses/rmapi/titles/get-managed-title-updated-response.json"; // KB-EBSCO expected response files private static final String EXPECTED_TITLES_RESPONSE = @@ -123,7 +126,7 @@ class EholdingsTitlesIntegrationTest extends IntegrationTestBase { private static final String PUT_TITLE_NULL_NAME_REQUEST = "requests/kb-ebsco/title/put-title-null-name.json"; private static final String RMAPI_PUT_RESOURCE_REQUEST = - "requests/rmapi/resources/put-custom-resource-is-selected-multiple-attributes.json"; + "requests/rmapi/titles/put-custom-title.json"; private String credentialsId; @@ -147,7 +150,7 @@ void tearDown() { void shouldReturnTitlesOnGet() { mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); - var actualResponse = getWithOk(EHOLDINGS_TITLES_PATH + "?page=1&filter[name]=Mind&sort=name").asString(); + var actualResponse = getWithOk(EHOLDINGS_TITLES_PATH + "?page=1&q=Mind&q[field]=name&sort=name").asString(); assertJsonEqual(readFile(EXPECTED_TITLES_RESPONSE), actualResponse); } @@ -155,7 +158,7 @@ void shouldReturnTitlesOnGet() { void shouldReturnTitlesOnGetWithResources() { mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); - var resourcePath = withInclude(EHOLDINGS_TITLES_PATH + "?page=1&filter[name]=Mind&sort=name", "resources"); + var resourcePath = withInclude(EHOLDINGS_TITLES_PATH + "?page=1&q=Mind&q[field]=name&sort=name", "resources"); var actualResponse = getWithOk(resourcePath).asString(); assertJsonEqual(readFile(EXPECTED_TITLES_WITH_RESOURCES_RESPONSE), actualResponse); @@ -279,14 +282,14 @@ void shouldReturnEmptyTitlesOnSearchByAccessTypesThatIsNotExist() { void shouldReturnTitlesOnSearchByPackageIds() { mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); - var queryParam = "?filter[packageIds]=1&filter[packageIds]=2&filter[packageIds]=3&filter[name]=Mind"; + var queryParam = "?filter[packageIds]=1&filter[packageIds]=2&filter[packageIds]=3&q=Mind&q[field]=name"; var actualResponse = getWithOk(EHOLDINGS_TITLES_PATH + queryParam).asString(); assertJsonEqual(readFile(EXPECTED_TITLES_RESPONSE), actualResponse); } @Test void shouldReturn400ValidationErrorForPackageIds() { - var queryParam = "?filter[packageIds]=1&filter[packageIds]=abc&filter[name]=Mind"; + var queryParam = "?filter[packageIds]=1&filter[packageIds]=abc&q=Mind&q[field]=name"; var error = getWithStatus(EHOLDINGS_TITLES_PATH + queryParam, SC_BAD_REQUEST).as(JsonapiError.class); assertErrorContainsTitle(error, "Invalid Query Parameter for filter[packageIds]"); @@ -294,7 +297,7 @@ void shouldReturn400ValidationErrorForPackageIds() { @Test void shouldReturn400IfCountOutOfRange() { - var error = getWithStatus(EHOLDINGS_TITLES_PATH + "?count=1000&page=1&filter[name]=Mind&sort=name", + var error = getWithStatus(EHOLDINGS_TITLES_PATH + "?count=1000&page=1&q=Mind&q[field]=name&sort=name", SC_BAD_REQUEST).as(JsonapiError.class); assertErrorContainsTitle(error, "parameter value {1000} is not valid"); @@ -304,7 +307,7 @@ void shouldReturn400IfCountOutOfRange() { void shouldReturn500WhenRmApiReturns500Error() { mockGet(matching(titlesRmApi() + ".*"), SC_INTERNAL_SERVER_ERROR); - var resourcePath = EHOLDINGS_TITLES_PATH + "?filter[name]=news"; + var resourcePath = EHOLDINGS_TITLES_PATH + "?q=news&q[field]=name"; var error = getWithStatus(resourcePath, SC_INTERNAL_SERVER_ERROR).as(JsonapiError.class); assertErrorContainsTitle(error, "Invalid RMAPI response"); @@ -414,7 +417,7 @@ void shouldAddTitleDataOnPost() { @Test void shouldReturn400WhenInvalidPostRequest() { mockPost( - WireMock.equalTo(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID)), + WireMock.equalTo(customTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID)), readFile(RMAPI_PACKAGE_400_RESPONSE), SC_BAD_REQUEST); @@ -430,7 +433,7 @@ void shouldReturnUpdatedValuesForCustomTitleOnSuccessfulPut() { var actualResponse = putTitle(null); assertJsonEqual(readFile(EXPECTED_UPDATED_TITLE_RESPONSE), actualResponse); - verifyPut(WireMock.equalTo(resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID)), + verifyPut(WireMock.equalTo(resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID)), equalToJson(readFile(RMAPI_PUT_RESOURCE_REQUEST))); } @@ -507,7 +510,7 @@ private String putTitle(List<String> tags) { private String putTitle(String updatedResourceResponse, List<String> tags) { mockGet(WireMock.equalTo(titlesRmApi(CUSTOM_TITLE_ID)), updatedResourceResponse); - mockPut(matching(resourcesRmApi(CUSTOM_VENDOR_ID, CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID)), SC_NO_CONTENT); + mockPut(matching(resourcesRmApi(CUSTOM_PACKAGE_ID, CUSTOM_TITLE_ID)), SC_NO_CONTENT); var titleToBeUpdated = readJsonFile(PUT_TITLE_REQUEST, TitlePutRequest.class); if (tags != null) { @@ -518,7 +521,7 @@ private String putTitle(String updatedResourceResponse, List<String> tags) { } private ExtractableResponse<Response> postTitle(List<String> tags) { - mockPost(WireMock.equalTo(packageTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID)), + mockPost(WireMock.equalTo(customTitlesRmApi(STUB_VENDOR_ID, STUB_PACKAGE_ID)), readFile(RMAPI_POST_TITLE_RESPONSE), SC_OK); mockGet(matching(titlesRmApi(STUB_TITLE_ID)), readFile(RMAPI_TITLE_FOR_POST_RESPONSE)); @@ -537,6 +540,104 @@ private void mockGetTitleById(int titleId, String responseFile) { mockGet(WireMock.equalTo(titlesRmApi(titleId)), readFile(responseFile)); } + @Test + void shouldMapLegacyFilterNameToSearchOnGet() { + mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); + + getWithOk(EHOLDINGS_TITLES_PATH + "?filter[name]=Mind"); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi())) + .withQueryParam("searchfield", WireMock.equalTo("titlename")) + .withQueryParam("search", WireMock.equalTo("Mind"))); + } + + @Test + void shouldMapLegacyFilterIsxnToSearchOnGet() { + mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); + + getWithOk(EHOLDINGS_TITLES_PATH + "?filter[isxn]=1050-3331"); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi())) + .withQueryParam("searchfield", WireMock.equalTo("isxn")) + .withQueryParam("search", WireMock.equalTo("1050-3331"))); + } + + @Test + void shouldPreferQueryOverLegacyFilterOnGet() { + mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); + + getWithOk(EHOLDINGS_TITLES_PATH + "?q=Mind&q[field]=subject&filter[name]=Other"); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi())) + .withQueryParam("searchfield", WireMock.equalTo("subject")) + .withQueryParam("search", WireMock.equalTo("Mind"))); + } + + @Test + void shouldSendZdbidAndAccessFiltersToRmApi() { + mockSearchTitles(RMAPI_TITLES_SEARCH_RESPONSE); + + var queryParam = "?q=2071469-8&q[field]=zdbid&filter[access]=public"; + getWithOk(EHOLDINGS_TITLES_PATH + queryParam); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi())) + .withQueryParam("searchfield", WireMock.equalTo("zdbid")) + .withQueryParam("search", WireMock.equalTo("2071469-8")) + .withQueryParam("packagefreeaccess", WireMock.equalTo("true")) + .withoutQueryParam("consortia")); + } + + @Test + void shouldReturn400WhenFilterAccessIsInvalid() { + var queryParam = "?q=Mind&q[field]=name&filter[access]=free"; + var error = getWithStatus(EHOLDINGS_TITLES_PATH + queryParam, SC_BAD_REQUEST).as(JsonapiError.class); + + assertErrorContainsTitle(error, "Invalid Query Parameter for filter[access]"); + } + + @Test + void shouldReturn400WhenQueryIsMissing() { + var error = getWithStatus(EHOLDINGS_TITLES_PATH + "?q[field]=name", SC_BAD_REQUEST).as(JsonapiError.class); + + assertErrorContainsTitle(error, "Invalid Query Parameter for q: is required"); + } + + @Test + void shouldReturn400WhenQueryFieldIsInvalid() { + var queryParam = "?q=Mind&q[field]=bogus"; + var error = getWithStatus(EHOLDINGS_TITLES_PATH + queryParam, SC_BAD_REQUEST).as(JsonapiError.class); + + assertErrorContainsTitle(error, "Invalid Query Parameter for q[field]"); + } + + @Test + void shouldReturnTitleRelationshipsWhenIncluded() { + mockSearchTitles(RMAPI_TITLE_WITH_RELATIONSHIPS_RESPONSE); + + var title = getWithOk(EHOLDINGS_TITLES_PATH + "/" + STUB_TITLE_ID + "?include=relationships").as(Title.class); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi(STUB_TITLE_ID))) + .withQueryParam("includerelationships", WireMock.equalTo("true"))); + var relationships = title.getData().getAttributes().getTitleRelationships(); + assertEquals(1, relationships.size()); + assertEquals(42, relationships.getFirst().getId()); + assertEquals("CONTINUED_BY", relationships.getFirst().getType()); + assertEquals("2020-01-01T00:00:00Z", relationships.getFirst().getDate()); + assertEquals(4444, relationships.getFirst().getTarget().getTitleId()); + assertEquals("Continued Title", relationships.getFirst().getTarget().getName()); + } + + @Test + void shouldNotReturnTitleRelationshipsWhenNotIncluded() { + mockSearchTitles(RMAPI_TITLE_BY_ID_RESPONSE); + + var response = getWithOk(EHOLDINGS_TITLES_PATH + "/" + STUB_TITLE_ID).asString(); + + wm.verify(1, WireMock.getRequestedFor(WireMock.urlPathEqualTo(titlesRmApi(STUB_TITLE_ID))) + .withoutQueryParam("includerelationships")); + assertFalse(response.contains("titleRelationships")); + } + private void mockSearchTitles(String responseFile) { mockGet(matching(titlesRmApi() + ".*"), readFile(responseFile)); } diff --git a/src/test/java/org/folio/rest/model/filter/PackageFilterValidatorTest.java b/src/test/java/org/folio/rest/model/filter/PackageFilterValidatorTest.java index ee8628c2d..63c0e694b 100644 --- a/src/test/java/org/folio/rest/model/filter/PackageFilterValidatorTest.java +++ b/src/test/java/org/folio/rest/model/filter/PackageFilterValidatorTest.java @@ -40,4 +40,11 @@ void shouldRejectUnknownVisibilityFilter() { void shouldAcceptMissingVisibilityFilter() { assertThatCode(() -> PackageRecordFilter.builder().sort("name").build()).doesNotThrowAnyException(); } + + @Test + void shouldRejectBlankQuery() { + var builder = PackageRecordFilter.builder().sort("name").query(" "); + + assertThatThrownBy(builder::build).isInstanceOf(QueryParamsValidationException.class); + } } diff --git a/src/test/java/org/folio/rest/model/filter/ResourceFilterValidatorTest.java b/src/test/java/org/folio/rest/model/filter/ResourceFilterValidatorTest.java new file mode 100644 index 000000000..beac64b85 --- /dev/null +++ b/src/test/java/org/folio/rest/model/filter/ResourceFilterValidatorTest.java @@ -0,0 +1,134 @@ +package org.folio.rest.model.filter; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatCode; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_FILTER_ACCESS_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_FILTER_SELECTED_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_FILTER_TYPE_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_PACKAGE_ID_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_QUERY_FIELD_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_QUERY_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.ResourceFilterValidator.INVALID_SORT_PARAMETER_MESSAGE; + +import java.util.List; +import org.folio.rest.exception.QueryParamsValidationException; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class ResourceFilterValidatorTest { + + @Test + void shouldAcceptValidFilter() { + var builder = validFilter() + .query("Mind") + .queryField("name") + .filterSelected("true") + .filterType("book") + .filterAccess("controlled"); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @Test + void shouldAcceptMissingQuery() { + assertThatCode(validFilter()::build).doesNotThrowAnyException(); + } + + @Test + void shouldAcceptMissingPackageId() { + var builder = validFilter().packageId(null); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @ParameterizedTest + @ValueSource(strings = {"name", "isxn", "subject", "publisher", "zdbid"}) + void shouldAcceptSupportedQueryField(String queryField) { + var builder = validFilter().query("Mind").queryField(queryField); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @Test + void shouldRejectEmptyQuery() { + assertValidationFails(validFilter().query(""), INVALID_QUERY_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectBlankQuery() { + assertValidationFails(validFilter().query(" "), INVALID_QUERY_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidSort() { + assertValidationFails(validFilter().sort("date"), INVALID_SORT_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidQueryField() { + assertValidationFails(validFilter().queryField("bogus"), INVALID_QUERY_FIELD_PARAMETER_MESSAGE); + } + + @Test + void shouldAcceptAllFilterType() { + assertThatCode(validFilter().filterType("all")::build).doesNotThrowAnyException(); + } + + @Test + void shouldRejectInvalidFilterType() { + assertValidationFails(validFilter().filterType("film"), INVALID_FILTER_TYPE_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidFilterSelected() { + assertValidationFails(validFilter().filterSelected("maybe"), INVALID_FILTER_SELECTED_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidFilterAccess() { + assertValidationFails(validFilter().filterAccess("free"), INVALID_FILTER_ACCESS_PARAMETER_MESSAGE); + } + + @ParameterizedTest + @ValueSource(strings = {"abc", "19", "19-abc"}) + void shouldRejectInvalidPackageId(String packageId) { + assertValidationFails(validFilter().packageId(packageId), INVALID_PACKAGE_ID_PARAMETER_MESSAGE); + } + + @Test + void shouldReportAllFailures() { + var builder = validFilter().query("").filterType("film").packageId("abc"); + + assertThatThrownBy(builder::build) + .isInstanceOfSatisfying(QueryParamsValidationException.class, e -> + assertThat(e.getMessageDetail()).containsExactly( + INVALID_QUERY_PARAMETER_MESSAGE, INVALID_FILTER_TYPE_PARAMETER_MESSAGE, + INVALID_PACKAGE_ID_PARAMETER_MESSAGE)); + } + + @Test + void shouldSkipValidationForTagSearch() { + var builder = ResourceFilter.builder().sort("date").packageId("abc").filterTags(List.of("tag")); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @Test + void shouldSkipValidationForAccessTypeSearch() { + var builder = ResourceFilter.builder().sort("date").packageId("abc").filterAccessType(List.of("access type")); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + private static ResourceFilter.ResourceFilterBuilder validFilter() { + return ResourceFilter.builder().sort("name").packageId("19-3964"); + } + + private static void assertValidationFails(ResourceFilter.ResourceFilterBuilder builder, String expectedMessage) { + assertThatThrownBy(builder::build) + .isInstanceOfSatisfying(QueryParamsValidationException.class, e -> + assertThat(e.getMessageDetail()).containsExactly(expectedMessage)); + } +} diff --git a/src/test/java/org/folio/rest/model/filter/TitleFilterValidatorTest.java b/src/test/java/org/folio/rest/model/filter/TitleFilterValidatorTest.java new file mode 100644 index 000000000..eb96c90cb --- /dev/null +++ b/src/test/java/org/folio/rest/model/filter/TitleFilterValidatorTest.java @@ -0,0 +1,160 @@ +package org.folio.rest.model.filter; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatCode; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_FILTER_ACCESS_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_FILTER_SELECTED_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_FILTER_TYPE_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_QUERY_FIELD_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_QUERY_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_QUERY_TYPE_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.INVALID_SORT_PARAMETER_MESSAGE; +import static org.folio.rest.model.filter.TitleFilterValidator.MISSING_QUERY_PARAMETER_MESSAGE; + +import java.util.List; +import org.folio.rest.exception.QueryParamsValidationException; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.ValueSource; + +class TitleFilterValidatorTest { + + @Test + void shouldAcceptValidFilter() { + var builder = validFilter() + .queryType("contains") + .filterSelected("true") + .filterType("book") + .filterAccess("public") + .filterPackageIds(List.of("1", "2")); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @ParameterizedTest + @ValueSource(strings = {"name", "isxn", "subject", "publisher", "zdbid"}) + void shouldAcceptSupportedQueryField(String queryField) { + var builder = validFilter().queryField(queryField); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @ParameterizedTest + @ValueSource(strings = {"any", "contains", "exactmatch", "beginswith", "proximity", "exactphrase", "advanced"}) + void shouldAcceptSupportedQueryType(String queryType) { + var builder = validFilter().queryType(queryType); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @Test + void shouldRejectMissingQuery() { + assertValidationFails(validFilter().query(null), MISSING_QUERY_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectEmptyQuery() { + assertValidationFails(validFilter().query(""), INVALID_QUERY_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectBlankQuery() { + assertValidationFails(validFilter().query(" "), INVALID_QUERY_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidSort() { + assertValidationFails(validFilter().sort("date"), INVALID_SORT_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidQueryType() { + assertValidationFails(validFilter().queryType("fuzzy"), INVALID_QUERY_TYPE_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidQueryField() { + assertValidationFails(validFilter().queryField("bogus"), INVALID_QUERY_FIELD_PARAMETER_MESSAGE); + } + + @Test + void shouldAcceptAllFilterType() { + assertThatCode(validFilter().filterType("all")::build).doesNotThrowAnyException(); + } + + @Test + void shouldRejectInvalidFilterType() { + assertValidationFails(validFilter().filterType("film"), INVALID_FILTER_TYPE_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidFilterSelected() { + assertValidationFails(validFilter().filterSelected("maybe"), INVALID_FILTER_SELECTED_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectInvalidFilterAccess() { + assertValidationFails(validFilter().filterAccess("free"), INVALID_FILTER_ACCESS_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectNonNumericFilterPackageIds() { + assertValidationFails(validFilter().filterPackageIds(List.of("1", "abc")), + INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectCommaSeparatedFilterPackageIds() { + assertValidationFails(validFilter().filterPackageIds(List.of("1,2")), + INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectEmptyFilterPackageId() { + assertValidationFails(validFilter().filterPackageIds(List.of("")), + INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE); + } + + @Test + void shouldRejectFilterPackageIdOutOfIntegerRange() { + assertValidationFails(validFilter().filterPackageIds(List.of("99999999999")), + INVALID_FILTER_PACKAGE_IDS_PARAMETER_MESSAGE); + } + + @Test + void shouldReportAllFailures() { + var builder = validFilter().query(null).filterType("film").filterAccess("free"); + + assertThatThrownBy(builder::build) + .isInstanceOfSatisfying(QueryParamsValidationException.class, e -> + assertThat(e.getMessageDetail()).containsExactly( + MISSING_QUERY_PARAMETER_MESSAGE, INVALID_FILTER_TYPE_PARAMETER_MESSAGE, + INVALID_FILTER_ACCESS_PARAMETER_MESSAGE)); + } + + @Test + void shouldSkipValidationForTagSearch() { + var builder = TitleFilter.builder().sort("date").filterTags(List.of("tag")); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + @Test + void shouldSkipValidationForAccessTypeSearch() { + var builder = TitleFilter.builder().sort("date").filterAccessType(List.of("access type")); + + assertThatCode(builder::build).doesNotThrowAnyException(); + } + + private static TitleFilter.TitleFilterBuilder validFilter() { + return TitleFilter.builder().sort("name").query("Mind").queryField("name"); + } + + private static void assertValidationFails(TitleFilter.TitleFilterBuilder builder, String expectedMessage) { + assertThatThrownBy(builder::build) + .isInstanceOfSatisfying(QueryParamsValidationException.class, e -> + assertThat(e.getMessageDetail()).containsExactly(expectedMessage)); + } +} diff --git a/src/test/java/org/folio/rest/model/filter/TitleSearchTest.java b/src/test/java/org/folio/rest/model/filter/TitleSearchTest.java new file mode 100644 index 000000000..7314edb1d --- /dev/null +++ b/src/test/java/org/folio/rest/model/filter/TitleSearchTest.java @@ -0,0 +1,49 @@ +package org.folio.rest.model.filter; + +import static org.assertj.core.api.Assertions.assertThat; + +import org.folio.holdingsiq.model.TitleSearchField; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.params.ParameterizedTest; +import org.junit.jupiter.params.provider.CsvSource; + +class TitleSearchTest { + + @ParameterizedTest + @CsvSource({ + "name,TITLE_NAME", + "isxn,ISXN", + "subject,SUBJECT", + "publisher,PUBLISHER", + "zdbid,ZDBID" + }) + void shouldMapSupportedField(String field, TitleSearchField expected) { + var search = TitleSearch.of("abc", field); + + assertThat(search.query()).isEqualTo("abc"); + assertThat(search.searchField()).isEqualTo(expected); + } + + @Test + void shouldDefaultToNameWhenFieldIsMissing() { + var search = TitleSearch.of("abc", null); + + assertThat(search.query()).isEqualTo("abc"); + assertThat(search.searchField()).isEqualTo(TitleSearchField.TITLE_NAME); + } + + @Test + void shouldDefaultToNameWhenFieldIsUnknown() { + var search = TitleSearch.of("abc", "bogus"); + + assertThat(search.searchField()).isEqualTo(TitleSearchField.TITLE_NAME); + } + + @Test + void shouldHaveNoSearchWhenQueryIsMissing() { + var search = TitleSearch.of(null, "isxn"); + + assertThat(search.query()).isNull(); + assertThat(search.searchField()).isNull(); + } +} diff --git a/src/test/java/org/folio/rest/validator/ResourcePostValidatorTest.java b/src/test/java/org/folio/rest/validator/ResourcePostValidatorTest.java index e829b6470..2b08f45b1 100644 --- a/src/test/java/org/folio/rest/validator/ResourcePostValidatorTest.java +++ b/src/test/java/org/folio/rest/validator/ResourcePostValidatorTest.java @@ -2,11 +2,7 @@ import static org.junit.jupiter.api.Assertions.assertThrows; -import java.util.Collections; -import java.util.List; import org.folio.holdingsiq.model.PackageData; -import org.folio.holdingsiq.model.Title; -import org.folio.holdingsiq.model.Titles; import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.ResourcePostData; import org.folio.rest.jaxrs.model.ResourcePostDataAttributes; @@ -17,8 +13,6 @@ class ResourcePostValidatorTest { private static final String PACKAGE_ID = "123-456"; private static final String TITLE_ID = "789"; - private static final String TITLE_NAME = "title name"; - private static final int OTHER_TITLE_ID = 555; private final ResourcePostValidator validator = new ResourcePostValidator(); @@ -53,10 +47,7 @@ void shouldThrowExceptionWhenUrlIsInvalid() { @Test void shouldValidateTitleAndPackage() { - validator.validateRelatedObjects( - createPackage().build(), - createTitle().build(), - createTitles().build()); + validator.validateRelatedObjects(createPackage().build(), false); } @Test @@ -64,30 +55,13 @@ void shouldThrowExceptionWhenPackageIsNotCustom() { PackageData packageData = createPackage() .isCustom(false) .build(); - Title build = createTitle().build(); - Titles build1 = createTitles().build(); - assertThrows(InputValidationException.class, () -> - validator.validateRelatedObjects( - packageData, - build, - build1)); + assertThrows(InputValidationException.class, () -> validator.validateRelatedObjects(packageData, false)); } @Test void shouldThrowExceptionWhenTitleIsAlreadyAddedToPackage() { - Title title = createTitle().build(); - Titles titles = createTitles().titleList(Collections.singletonList(title)).build(); PackageData packageData = createPackage().build(); - assertThrows(InputValidationException.class, () -> - validator.validateRelatedObjects( - packageData, - title, - titles)); - } - - private Titles.TitlesBuilder createTitles() { - List<Title> titles = Collections.singletonList(createTitle().titleId(OTHER_TITLE_ID).build()); - return Titles.builder().titleList(titles); + assertThrows(InputValidationException.class, () -> validator.validateRelatedObjects(packageData, true)); } private ResourcePostRequest createRequest(String packageId, String titleId, String url) { @@ -108,10 +82,4 @@ private PackageData.PackageDataBuilder createPackage() { .packageId(456) .isCustom(true); } - - private Title.TitleBuilder createTitle() { - return Title.builder() - .titleId(Integer.valueOf(TITLE_ID)) - .titleName(TITLE_NAME); - } } diff --git a/src/test/java/org/folio/rest/validator/ResourcePutBodyValidatorTest.java b/src/test/java/org/folio/rest/validator/ResourcePutBodyValidatorTest.java index 439a8752c..b2d25b193 100644 --- a/src/test/java/org/folio/rest/validator/ResourcePutBodyValidatorTest.java +++ b/src/test/java/org/folio/rest/validator/ResourcePutBodyValidatorTest.java @@ -3,12 +3,14 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertThrows; +import java.util.List; import org.apache.commons.lang3.RandomStringUtils; import org.folio.properties.customlabels.CustomLabelsProperties; import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.EmbargoPeriod; import org.folio.rest.jaxrs.model.EmbargoPeriod.EmbargoUnit; import org.folio.rest.jaxrs.model.ResourcePutDataAttributes; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.rest.jaxrs.model.VisibilityData; import org.folio.util.ResourcesTestUtil; import org.junit.jupiter.api.Test; @@ -63,6 +65,26 @@ void shouldThrowExceptionWhenResourceIsNotSelectedAndIsHiddenIsTrue() { assertEquals("Resource cannot be updated unless added to holdings", exception.getMessage()); } + @Test + void shouldThrowExceptionWhenResourceIsNotSelectedAndCategoryIsHidden() { + var request = ResourcesTestUtil.getResourcePutRequest( + new ResourcePutDataAttributes() + .withIsSelected(false) + .withVisibility(List.of( + new Visibility().withCategory(Visibility.Category.PF).withHidden(false), + new Visibility().withCategory(Visibility.Category.MARC).withHidden(true)))); + var exception = assertThrows(InputValidationException.class, () -> validator.validate(request, false)); + assertEquals("Resource cannot be updated unless added to holdings", exception.getMessage()); + } + + @Test + void shouldNotThrowExceptionWhenResourceIsNotSelectedAndNoCategoryIsHidden() { + validator.validate(ResourcesTestUtil.getResourcePutRequest( + new ResourcePutDataAttributes() + .withIsSelected(false) + .withVisibility(List.of(new Visibility().withCategory(Visibility.Category.PF).withHidden(false)))), false); + } + @Test void shouldThrowExceptionWhenResourceIsNotSelectedAndCvgStmtIsNotNull() { var request = ResourcesTestUtil.getResourcePutRequest( diff --git a/src/test/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidatorTest.java b/src/test/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidatorTest.java index 7318551a1..68ccd39a6 100644 --- a/src/test/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidatorTest.java +++ b/src/test/java/org/folio/rest/validator/packages/ManagedPackagePutBodyValidatorTest.java @@ -11,8 +11,8 @@ import org.folio.rest.exception.InputValidationException; import org.folio.rest.jaxrs.model.Coverage; import org.folio.rest.jaxrs.model.PackagePutDataAttributes; -import org.folio.rest.jaxrs.model.PackageVisibility; import org.folio.rest.jaxrs.model.Token; +import org.folio.rest.jaxrs.model.Visibility; import org.folio.util.PackagesTestUtil; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; @@ -51,8 +51,8 @@ void shouldThrowExceptionWhenPackageIsNotSelectedAndIsHiddenIsTrue() { new PackagePutDataAttributes() .withIsSelected(false) .withVisibility(List.of( - new PackageVisibility() - .withCategory(PackageVisibility.Category.PF) + new Visibility() + .withCategory(Visibility.Category.PF) .withHidden(true)))); var exception = assertThrows(InputValidationException.class, () -> validator.validate(request)); assertTrue(exception.getMessage().contains("visibility")); diff --git a/src/test/java/org/folio/rmapi/PackageServiceImplTest.java b/src/test/java/org/folio/rmapi/PackageServiceImplTest.java index 190a304e6..6c9f61d83 100644 --- a/src/test/java/org/folio/rmapi/PackageServiceImplTest.java +++ b/src/test/java/org/folio/rmapi/PackageServiceImplTest.java @@ -16,7 +16,7 @@ class PackageServiceImplTest extends WireMockTestBase { private static final int PACKAGE_ID = 3964; - private static final int VENDOR_ID = 111111; + private static final int VENDOR_ID = 19; private static final String CUSTOM_PACKAGE_STUB_FILE = "responses/rmapi/packages/get-custom-package-by-id-response.json"; @@ -25,8 +25,8 @@ void shouldReturnCachedPackage() { var getPackagePattern = equalTo(packageRmApi(PACKAGE_ID)); var configuration = getStubConfiguration(); - var service = new PackageServiceImpl(configuration, Vertx.vertx(), STUB_TENANT, null, null, - new VertxCache<>(Vertx.vertx(), 60, "packageCache"), null); + var service = new PackageServiceImpl(configuration, Vertx.vertx(), STUB_TENANT, null, + new VertxCache<>(Vertx.vertx(), 60, "packageCache")); mockGet(getPackagePattern, readFile(CUSTOM_PACKAGE_STUB_FILE)); diff --git a/src/test/java/org/folio/rmapi/ResourceServiceImplTest.java b/src/test/java/org/folio/rmapi/ResourceServiceImplTest.java index ded17705b..be4135524 100644 --- a/src/test/java/org/folio/rmapi/ResourceServiceImplTest.java +++ b/src/test/java/org/folio/rmapi/ResourceServiceImplTest.java @@ -16,7 +16,7 @@ class ResourceServiceImplTest extends WireMockTestBase { private static final int PACKAGE_ID = 3964; - private static final int VENDOR_ID = 111111; + private static final int VENDOR_ID = 19; private static final int TITLE_ID = 985846; private static final String CUSTOM_RESOURCE_STUB_FILE = @@ -24,7 +24,7 @@ class ResourceServiceImplTest extends WireMockTestBase { @Test void shouldReturnCachedResource() { - var getResourcePattern = equalTo(resourcesRmApi(VENDOR_ID, PACKAGE_ID, TITLE_ID)); + var getResourcePattern = equalTo(resourcesRmApi(PACKAGE_ID, TITLE_ID)); var configuration = getStubConfiguration(); var service = new ResourcesServiceImpl(configuration, Vertx.vertx(), STUB_TENANT, null, null, diff --git a/src/test/java/org/folio/rmapi/TitleServiceImplTest.java b/src/test/java/org/folio/rmapi/TitleServiceImplTest.java index 06c328e1d..dcd55e61b 100644 --- a/src/test/java/org/folio/rmapi/TitleServiceImplTest.java +++ b/src/test/java/org/folio/rmapi/TitleServiceImplTest.java @@ -7,6 +7,7 @@ import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import com.github.tomakehurst.wiremock.matching.UrlPattern; @@ -16,10 +17,12 @@ import org.folio.cache.VertxCache; import org.folio.holdingsiq.model.Configuration; import org.folio.holdingsiq.model.CustomerResources; +import org.folio.holdingsiq.model.Resource; import org.folio.holdingsiq.model.Title; import org.folio.rmapi.cache.TitleCacheKey; import org.folio.util.WireMockTestBase; import org.junit.jupiter.api.Test; +import org.mockito.ArgumentCaptor; class TitleServiceImplTest extends WireMockTestBase { @@ -64,10 +67,13 @@ void shouldUpdateCachedTitle() { when(titleCache.getValue(any(TitleCacheKey.class))).thenReturn(buildTitleWithCustomerResource(1)); - var title = buildTitleWithCustomerResource(2); - service.updateCache(title); + service.updateCache(Resource.builder().titleId(TITLE_ID).packageId(2).build()); - assertEquals(2, title.getCustomerResourcesList().size()); + var cachedTitle = ArgumentCaptor.forClass(Title.class); + verify(titleCache).putValue(any(TitleCacheKey.class), cachedTitle.capture()); + assertEquals(List.of(2, 1), cachedTitle.getValue().getCustomerResourcesList().stream() + .map(CustomerResources::getPackageId) + .toList()); } private Title buildTitleWithCustomerResource(int packageId) { diff --git a/src/test/java/org/folio/service/packages/PackageServiceTest.java b/src/test/java/org/folio/service/packages/PackageServiceTest.java index 062444ffd..0a2eeb474 100644 --- a/src/test/java/org/folio/service/packages/PackageServiceTest.java +++ b/src/test/java/org/folio/service/packages/PackageServiceTest.java @@ -23,7 +23,7 @@ import org.folio.holdingsiq.model.PackagePut; import org.folio.holdingsiq.model.Packages; import org.folio.holdingsiq.model.RequestContext; -import org.folio.holdingsiq.model.Titles; +import org.folio.holdingsiq.model.Resources; import org.folio.holdingsiq.service.exception.ResourceNotFoundException; import org.folio.okapi.common.XOkapiHeaders; import org.folio.properties.common.SearchProperties; @@ -48,7 +48,7 @@ import org.folio.rmapi.ProvidersServiceImpl; import org.folio.rmapi.TitlesServiceImpl; import org.folio.rmapi.result.PackageResult; -import org.folio.rmapi.result.TitleCollectionResult; +import org.folio.rmapi.result.ResourceItemCollectionResult; import org.folio.service.loader.RelatedEntitiesLoader; import org.folio.util.TestFutureFailedException; import org.junit.jupiter.api.BeforeEach; @@ -77,7 +77,7 @@ class PackageServiceTest { @Mock private RelatedEntitiesLoader relatedEntitiesLoader; @Mock - private Converter<Titles, TitleCollectionResult> titleCollectionConverter; + private Converter<Resources, ResourceItemCollectionResult> resourceItemCollectionConverter; @Mock private PackageServiceImpl packagesRmApiService; @Mock @@ -92,7 +92,8 @@ class PackageServiceTest { void setUp() { var searchProperties = new SearchProperties("any", "any", "b"); packageService = new PackageService(requestConvertionService, validationService, packageAccessTypeService, - packageTagsService, customProviderIdService, relatedEntitiesLoader, titleCollectionConverter, searchProperties); + packageTagsService, customProviderIdService, relatedEntitiesLoader, resourceItemCollectionConverter, + searchProperties); var requestContext = new RequestContext(Map.of( XOkapiHeaders.TENANT, TENANT, @@ -203,7 +204,7 @@ void shouldThrowWhenIsCustomDoesNotMatchOriginalPackage() { var packageId = new PackageId(19, 3964); var originalPackage = PackageData.builder().vendorId(19).packageId(3964).isCustom(true).build(); var entity = buildPutRequest(false, null); - when(packagesRmApiService.retrievePackage(3964)).thenReturn(completedFuture(originalPackage)); + when(packagesRmApiService.retrievePackage(packageId)).thenReturn(completedFuture(originalPackage)); var packageUpdateFuture = packageService.updatePackage(packageId, entity, context); var exception = assertThrows(TestFutureFailedException.class, () -> result(packageUpdateFuture)); @@ -219,7 +220,7 @@ void shouldUpdateCustomPackageAndAssignAccessType() { var entity = buildPutRequest(true, "access-type-id"); var packagePut = mock(PackagePut.class); var accessType = new AccessType(); - when(packagesRmApiService.retrievePackage(3964)).thenReturn(completedFuture(originalPackage)); + when(packagesRmApiService.retrievePackage(packageId)).thenReturn(completedFuture(originalPackage)); when(packageAccessTypeService.fetchAccessType("access-type-id", context)).thenReturn(completedFuture(accessType)); when(requestConvertionService.convertCustomPackagePutRequest(entity)).thenReturn(packagePut); when(packagesRmApiService.updatePackage(3964, packagePut)).thenReturn(completedFuture(null)); @@ -241,7 +242,7 @@ void shouldCleanUpLocalDataWhenPackageWasDeletedDuringUpdate() { var packagePut = mock(PackagePut.class); var notFound = new ResourceNotFoundException("not found", 404, "Not Found", "", "query"); var failedRetrieve = CompletableFuture.<PackageData>failedFuture(notFound); - when(packagesRmApiService.retrievePackage(3964)) + when(packagesRmApiService.retrievePackage(packageId)) .thenReturn(completedFuture(originalPackage)) .thenReturn(failedRetrieve); when(requestConvertionService.convertCustomPackagePutRequest(entity)).thenReturn(packagePut); @@ -260,7 +261,7 @@ void shouldCleanUpLocalDataWhenPackageWasDeletedDuringUpdate() { void shouldThrowWhenDeletingNonCustomPackage() { var packageId = new PackageId(19, 3964); var packageData = PackageData.builder().vendorId(19).packageId(3964).isCustom(false).build(); - when(packagesRmApiService.retrievePackage(3964)).thenReturn(completedFuture(packageData)); + when(packagesRmApiService.retrievePackage(packageId)).thenReturn(completedFuture(packageData)); var packageDeletionFuture = packageService.deletePackage(packageId, context); var exception = assertThrows(TestFutureFailedException.class, () -> result(packageDeletionFuture)); @@ -273,7 +274,7 @@ void shouldThrowWhenDeletingNonCustomPackage() { void shouldDeleteCustomPackageAndAssignedResources() { var packageId = new PackageId(19, 3964); var packageData = PackageData.builder().vendorId(19).packageId(3964).isCustom(true).build(); - when(packagesRmApiService.retrievePackage(3964)).thenReturn(completedFuture(packageData)); + when(packagesRmApiService.retrievePackage(packageId)).thenReturn(completedFuture(packageData)); when(packagesRmApiService.deletePackage(3964)).thenReturn(completedFuture(null)); when(packageAccessTypeService.updateRecordMapping(null, "19-3964", context)).thenReturn(completedFuture(null)); when(packageTagsService.deletePackageTags(eq(packageId), any(), eq(TENANT))).thenReturn(completedFuture(null)); diff --git a/src/test/java/org/folio/service/packages/PackageTagsServiceTest.java b/src/test/java/org/folio/service/packages/PackageTagsServiceTest.java index efa9ffd2a..e07711dc9 100644 --- a/src/test/java/org/folio/service/packages/PackageTagsServiceTest.java +++ b/src/test/java/org/folio/service/packages/PackageTagsServiceTest.java @@ -23,7 +23,7 @@ import org.folio.rest.jaxrs.model.ContentType; import org.folio.rest.jaxrs.model.PackageTagsDataAttributes; import org.folio.rest.jaxrs.model.Tags; -import org.folio.rmapi.result.TitleResult; +import org.folio.rmapi.result.ResourceItemResult; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; import org.mockito.InjectMocks; @@ -108,14 +108,14 @@ void shouldDeletePackageAndItsTags() { @Test void shouldPopulateResourceTagsFromTagRepository() { - var titleResult = new TitleResult(null, false); - var resourceIdToTitle = Map.of("resource-1", titleResult); + var itemResult = new ResourceItemResult(null); + var resourceIdToItem = Map.of("resource-1", itemResult); var tags = List.of(DbTag.builder().value("tag1").recordType(RecordType.RESOURCE).build()); when(tagRepository.findPerRecord(TENANT, List.of("resource-1"), RecordType.RESOURCE)) .thenReturn(CompletableFuture.completedFuture(Map.of("resource-1", tags))); - result(packageTagsService.loadResourceTags(TENANT, resourceIdToTitle)); + result(packageTagsService.loadResourceTags(TENANT, resourceIdToItem)); - assertEquals(tags, titleResult.getResourceTagList()); + assertEquals(tags, itemResult.getTagList()); } } diff --git a/src/test/java/org/folio/util/RmApiConstants.java b/src/test/java/org/folio/util/RmApiConstants.java index 1f31901ed..0d81d7890 100644 --- a/src/test/java/org/folio/util/RmApiConstants.java +++ b/src/test/java/org/folio/util/RmApiConstants.java @@ -112,11 +112,18 @@ protected String deltaStatusRmApi(String deltaId) { return RM_ACCOUNT_API_PATH + "/reports/holdings/deltas/" + deltaId + "/status"; } - protected String resourcesRmApi(int vendorId, int packageId, int titleId) { - return RM_ACCOUNT_API_PATH + "/vendors/" + vendorId + "/packages/" + packageId + "/titles/" + titleId; + protected String resourcesRmApi(int packageId, int titleId) { + return RM_ACCOUNT_V2_API_PATH + "/lists/" + packageId + "/titles/" + titleId; } - protected String packageTitlesRmApi(int vendorId, int packageId) { + protected String packageTitlesRmApi(int packageId) { + return RM_ACCOUNT_V2_API_PATH + "/lists/" + packageId + "/titles"; + } + + /** + * Custom titles are still created through the v1 endpoint. + */ + protected String customTitlesRmApi(int vendorId, int packageId) { return RM_ACCOUNT_API_PATH + "/vendors/" + vendorId + "/packages/" + packageId + "/titles"; } @@ -137,11 +144,11 @@ protected String providerPackagesRmApi(int vendorId) { } protected String titlesRmApi() { - return RM_ACCOUNT_API_PATH + "/titles"; + return RM_ACCOUNT_V2_API_PATH + "/titles"; } protected String titlesRmApi(int titleId) { - return RM_ACCOUNT_API_PATH + "/titles/" + titleId; + return RM_ACCOUNT_V2_API_PATH + "/titles/" + titleId; } protected String vendorsRmApi() { diff --git a/src/test/resources/requests/rmapi/resources/put-custom-resource-is-selected-multiple-attributes.json b/src/test/resources/requests/rmapi/resources/put-custom-resource-is-selected-multiple-attributes.json index 548bdc05f..1a795bc50 100644 --- a/src/test/resources/requests/rmapi/resources/put-custom-resource-is-selected-multiple-attributes.json +++ b/src/test/resources/requests/rmapi/resources/put-custom-resource-is-selected-multiple-attributes.json @@ -1,6 +1,22 @@ { "isSelected": true, - "isHidden": false, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": null + }, + { + "category": "FTF", + "hidden": false, + "reason": null + }, + { + "category": "MARC", + "hidden": false, + "reason": null + } + ], "coverageStatement": "My test statement", "customEmbargoPeriod": { "embargoUnit": "Weeks", @@ -17,22 +33,29 @@ "inherited": false }, "url": "https://hello", - "contributorsList": [{ - "type": "author", - "contributor": "Rappaport, Helen" - }], - "identifiersList": [{ - "id": "978-1-280-71298-2", - "subtype": 2, - "type": 1 - }], - "customCoverageList": [{ - "beginCoverage": "2018-01-10", - "endCoverage": "2018-01-11" - }], + "contributorsList": [ + { + "type": "author", + "contributor": "Rappaport, Helen" + } + ], + "identifiersList": [ + { + "id": "978-1-280-71298-2", + "source": null, + "subtype": 2, + "type": 1 + } + ], + "customCoverageList": [ + { + "beginCoverage": "2018-01-10", + "endCoverage": "2018-01-11" + } + ], "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", - "userDefinedField4" : null, + "userDefinedField4": null, "userDefinedField5": "test 5" } diff --git a/src/test/resources/requests/rmapi/resources/put-managed-resource-is-selected-multiple-attributes.json b/src/test/resources/requests/rmapi/resources/put-managed-resource-is-selected-multiple-attributes.json index cf087eea5..0f890c4a3 100644 --- a/src/test/resources/requests/rmapi/resources/put-managed-resource-is-selected-multiple-attributes.json +++ b/src/test/resources/requests/rmapi/resources/put-managed-resource-is-selected-multiple-attributes.json @@ -1,6 +1,22 @@ { "isSelected": true, - "isHidden": false, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": null + }, + { + "category": "FTF", + "hidden": false, + "reason": null + }, + { + "category": "MARC", + "hidden": false, + "reason": null + } + ], "coverageStatement": "test coverage statement", "customEmbargoPeriod": { "embargoUnit": "Years", @@ -23,6 +39,6 @@ "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", - "userDefinedField4" : null, + "userDefinedField4": null, "userDefinedField5": "test 5" } diff --git a/src/test/resources/requests/rmapi/titles/put-custom-title.json b/src/test/resources/requests/rmapi/titles/put-custom-title.json new file mode 100644 index 000000000..13813e3f0 --- /dev/null +++ b/src/test/resources/requests/rmapi/titles/put-custom-title.json @@ -0,0 +1,45 @@ +{ + "isSelected": true, + "visibility": null, + "coverageStatement": "My test statement", + "customEmbargoPeriod": { + "embargoUnit": "Weeks", + "embargoValue": 30 + }, + "titleName": "sd-test-java-again", + "pubType": "book", + "publisherName": "Not Empty", + "isPeerReviewed": true, + "description": "test description", + "edition": "test edition", + "proxy": { + "id": "Proxy-ID-234", + "inherited": false + }, + "url": "https://hello", + "contributorsList": [ + { + "type": "author", + "contributor": "Rappaport, Helen" + } + ], + "identifiersList": [ + { + "id": "978-1-280-71298-2", + "source": null, + "subtype": 2, + "type": 1 + } + ], + "customCoverageList": [ + { + "beginCoverage": "2018-01-10", + "endCoverage": "2018-01-11" + } + ], + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5" +} diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-managed-resource.json b/src/test/resources/responses/kb-ebsco/resources/expected-managed-resource.json index 8d8c290bd..e2d953a57 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-managed-resource.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-managed-resource.json @@ -44,6 +44,7 @@ "embargoValue": 10 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "isTokenNeeded": false, "locationId": 2863717, @@ -59,6 +60,23 @@ "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": false, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-after-post.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-after-post.json index 3e6599656..e4ee88123 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-after-post.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-after-post.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-all-objects.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-all-objects.json index ae19510ca..65aa3b159 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-all-objects.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-all-objects.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", @@ -232,4 +250,4 @@ "jsonapi": { "version": "1.0" } -} \ No newline at end of file +} diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-package.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-package.json index 1bb254e70..3299db38a 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-package.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-package.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", @@ -155,4 +173,4 @@ "jsonapi": { "version": "1.0" } -} \ No newline at end of file +} diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-provider.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-provider.json index 02e5abeb4..7ad0eeace 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-provider.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-provider.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-title.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-title.json index c7c6947c4..4ddd5e2eb 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-title.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id-with-title.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id.json b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id.json index ff851619e..76950f043 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resource-by-id.json @@ -48,6 +48,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Variable", "isSelected": true, "titleHasSelectedResources": true, "isTokenNeeded": false, @@ -64,6 +65,23 @@ "isHidden": true, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], "managedCoverages": [ { "beginCoverage": "2005-01-01", diff --git a/src/test/resources/responses/kb-ebsco/resources/expected-resources-by-package-id.json b/src/test/resources/responses/kb-ebsco/resources/expected-resources-by-package-id.json index a974f429a..ed0f1b6d0 100644 --- a/src/test/resources/responses/kb-ebsco/resources/expected-resources-by-package-id.json +++ b/src/test/resources/responses/kb-ebsco/resources/expected-resources-by-package-id.json @@ -39,19 +39,19 @@ "publicationType": "Book", "subjects": [ { - "subject": "BUSINESS & ECONOMICS \/ Industrial Management", + "subject": "BUSINESS & ECONOMICS / Industrial Management", "type": "BISAC" }, { - "subject": "BUSINESS & ECONOMICS \/ Management", + "subject": "BUSINESS & ECONOMICS / Management", "type": "BISAC" }, { - "subject": "BUSINESS & ECONOMICS \/ Management Science", + "subject": "BUSINESS & ECONOMICS / Management Science", "type": "BISAC" }, { - "subject": "BUSINESS & ECONOMICS \/ Organizational Behavior", + "subject": "BUSINESS & ECONOMICS / Organizational Behavior", "type": "BISAC" } ], @@ -59,6 +59,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Complete", "isSelected": true, "isTokenNeeded": false, "locationId": 28972134, @@ -67,22 +68,37 @@ }, "packageId": "295-2545963", "packageName": "InfoSci-Books 2014", - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4518-9", + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4518-9", "providerId": 295, "providerName": "IGI Global", "visibilityData": { "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2014-01-01", "endCoverage": "2014-12-31" } ], - "customCoverages": [ - - ], + "customCoverages": [], "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", @@ -144,7 +160,7 @@ "type": "TLI" }, { - "subject": "EDUCATION \/ Higher", + "subject": "EDUCATION / Higher", "type": "BISAC" } ], @@ -152,6 +168,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Complete", "isSelected": true, "isTokenNeeded": false, "locationId": 28972354, @@ -160,22 +177,37 @@ }, "packageId": "295-2545963", "packageName": "InfoSci-Books 2014", - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4797-8", + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4797-8", "providerId": 295, "providerName": "IGI Global", "visibilityData": { "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2014-01-01", "endCoverage": "2014-12-31" } ], - "customCoverages": [ - - ], + "customCoverages": [], "userDefinedField1": "test 3", "userDefinedField2": "test 4", "userDefinedField3": "", @@ -233,7 +265,7 @@ "publicationType": "Book", "subjects": [ { - "subject": "EDUCATION \/ Higher", + "subject": "EDUCATION / Higher", "type": "BISAC" } ], @@ -241,6 +273,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Complete", "isSelected": true, "isTokenNeeded": false, "locationId": 28972340, @@ -249,22 +282,37 @@ }, "packageId": "295-2545963", "packageName": "InfoSci-Books 2014", - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4590-5", + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4590-5", "providerId": 295, "providerName": "IGI Global", "visibilityData": { "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2014-01-01", "endCoverage": "2014-12-31" } ], - "customCoverages": [ - - ] + "customCoverages": [] }, "relationships": { "provider": { @@ -318,7 +366,7 @@ "publicationType": "Book", "subjects": [ { - "subject": "PSYCHOLOGY \/ Social Psychology", + "subject": "PSYCHOLOGY / Social Psychology", "type": "BISAC" } ], @@ -326,6 +374,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Complete", "isSelected": true, "isTokenNeeded": false, "locationId": 28972237, @@ -334,22 +383,37 @@ }, "packageId": "295-2545963", "packageName": "InfoSci-Books 2014", - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4490-8", + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4490-8", "providerId": 295, "providerName": "IGI Global", "visibilityData": { "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2014-01-01", "endCoverage": "2014-12-31" } ], - "customCoverages": [ - - ] + "customCoverages": [] }, "relationships": { "provider": { @@ -412,11 +476,11 @@ "type": "TLI" }, { - "subject": "EDUCATION \/ Adult & Continuing Education", + "subject": "EDUCATION / Adult & Continuing Education", "type": "BISAC" }, { - "subject": "EDUCATION \/ Non-Formal Education", + "subject": "EDUCATION / Non-Formal Education", "type": "BISAC" } ], @@ -424,6 +488,7 @@ "embargoValue": 0 }, "isPackageCustom": false, + "packageType": "Complete", "isSelected": true, "isTokenNeeded": false, "locationId": 28972367, @@ -432,22 +497,37 @@ }, "packageId": "295-2545963", "packageName": "InfoSci-Books 2014", - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-5780-9", + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-5780-9", "providerId": 295, "providerName": "IGI Global", "visibilityData": { "isHidden": false, "reason": "" }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ], "managedCoverages": [ { "beginCoverage": "2014-01-01", "endCoverage": "2014-12-31" } ], - "customCoverages": [ - - ], + "customCoverages": [], "userDefinedField1": "test 8", "userDefinedField2": "test 9", "userDefinedField3": "test 10", diff --git a/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-response.json b/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-response.json index 91581fda0..250309c37 100644 --- a/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-response.json +++ b/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-response.json @@ -1,5 +1,5 @@ { - "titleId": 19412030, + "kbid": 19412030, "titleName": "sd-test-java-again", "publisherName": "Not Empty", "identifiersList": [ @@ -12,50 +12,6 @@ "subjectsList": [], "isTitleCustom": true, "pubType": "book", - "customerResourcesList": [ - { - "titleId": 19412030, - "packageId": 3157070, - "packageName": "Andrii custom package ", - "packageType": "Custom", - "proxy": { - "id": "Proxy-ID-234", - "inherited": false - }, - "isPackageCustom": true, - "vendorId": 123356, - "vendorName": "API DEV GOVERNMENT CUSTOMER", - "locationId": 43006476, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [], - "customCoverageList": [ - { - "beginCoverage": "2018-01-10", - "endCoverage": "2018-01-11" - } - ], - "coverageStatement": "My test statement", - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": "Weeks", - "embargoValue": 30 - }, - "url": "https://hello", - "userDefinedField1": "test 1", - "userDefinedField2": "test 2", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 5" - } - ], "description": "test description", "edition": "test edition", "isPeerReviewed": true, @@ -64,5 +20,57 @@ "type": "author", "contributor": "Rappaport, Helen" } + ], + "listId": 3157070, + "packageName": "Andrii custom package ", + "packageType": "Custom", + "proxy": { + "id": "Proxy-ID-234", + "inherited": false + }, + "isPackageCustom": true, + "vendorId": 123356, + "vendorName": "API DEV GOVERNMENT CUSTOMER", + "locationId": 43006476, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [], + "customCoverageList": [ + { + "beginCoverage": "2018-01-10", + "endCoverage": "2018-01-11" + } + ], + "coverageStatement": "My test statement", + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": "Weeks", + "embargoValue": 30 + }, + "url": "https://hello", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } ] } diff --git a/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response-is-selected-false.json b/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response-is-selected-false.json index 82e5a43f1..482090dc0 100644 --- a/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response-is-selected-false.json +++ b/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response-is-selected-false.json @@ -1,5 +1,5 @@ { - "titleId": 762169, + "kbid": 762169, "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", "publisherName": "Praeger", "identifiersList": [ @@ -42,50 +42,6 @@ ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 762169, - "packageId": 3964, - "packageName": "ABC-CLIO eBook Collection", - "packageType": "Variable", - "proxy": { - "id": "Test-proxy-id", - "inherited": false - }, - "isPackageCustom": false, - "vendorId": 19, - "vendorName": "ABC-CLIO", - "locationId": 2863717, - "isSelected": false, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "Hidden by Customer" - }, - "managedCoverageList": [ - { - "beginCoverage": "2005-01-01", - "endCoverage": "2005-12-31" - } - ], - "customCoverageList": [], - "coverageStatement": "test coverage statement", - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": "Years", - "embargoValue": 10 - }, - "url": "https://publisher.abc-clio.com/9780313068003/", - "userDefinedField1": "test 1", - "userDefinedField2": "test 2", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 5" - } - ], "description": null, "edition": null, "isPeerReviewed": false, @@ -94,5 +50,57 @@ "type": "author", "contributor": "Beeman, William O." } + ], + "listId": 3964, + "packageName": "ABC-CLIO eBook Collection", + "packageType": "Variable", + "proxy": { + "id": "Test-proxy-id", + "inherited": false + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "ABC-CLIO", + "locationId": 2863717, + "isSelected": false, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2005-01-01", + "endCoverage": "2005-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": "test coverage statement", + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": "Years", + "embargoValue": 10 + }, + "url": "https://publisher.abc-clio.com/9780313068003/", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": false, + "reason": "Hidden by Customer" + } ] } diff --git a/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response.json b/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response.json index 415b67ee8..0af76ab8f 100644 --- a/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response.json +++ b/src/test/resources/responses/rmapi/resources/get-managed-resource-updated-response.json @@ -1,5 +1,5 @@ { - "titleId": 762169, + "kbid": 762169, "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", "publisherName": "Praeger", "identifiersList": [ @@ -42,50 +42,6 @@ ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 762169, - "packageId": 3964, - "packageName": "ABC-CLIO eBook Collection", - "packageType": "Variable", - "proxy": { - "id": "Test-proxy-id", - "inherited": false - }, - "isPackageCustom": false, - "vendorId": 19, - "vendorName": "ABC-CLIO", - "locationId": 2863717, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "Hidden by Customer" - }, - "managedCoverageList": [ - { - "beginCoverage": "2005-01-01", - "endCoverage": "2005-12-31" - } - ], - "customCoverageList": [], - "coverageStatement": "test coverage statement", - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": "Years", - "embargoValue": 10 - }, - "url": "https://publisher.abc-clio.com/9780313068003/", - "userDefinedField1": "test 1", - "userDefinedField2": "test 2", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 5" - } - ], "description": null, "edition": null, "isPeerReviewed": false, @@ -94,5 +50,57 @@ "type": "author", "contributor": "Beeman, William O." } + ], + "listId": 3964, + "packageName": "ABC-CLIO eBook Collection", + "packageType": "Variable", + "proxy": { + "id": "Test-proxy-id", + "inherited": false + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "ABC-CLIO", + "locationId": 2863717, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2005-01-01", + "endCoverage": "2005-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": "test coverage statement", + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": "Years", + "embargoValue": 10 + }, + "url": "https://publisher.abc-clio.com/9780313068003/", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": false, + "reason": "Hidden by Customer" + } ] } diff --git a/src/test/resources/responses/rmapi/resources/get-resource-by-id-response-empty-customer-list.json b/src/test/resources/responses/rmapi/resources/get-resource-by-id-response-empty-customer-list.json deleted file mode 100644 index c7d1aecee..000000000 --- a/src/test/resources/responses/rmapi/resources/get-resource-by-id-response-empty-customer-list.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "titleId": 762169, - "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", - "publisherName": "Praeger", - "identifiersList": [], - "subjectsList": [], - "alternateTitleList": [], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [], - "description": null, - "edition": null, - "isPeerReviewed": false, - "contributorsList": [] -} diff --git a/src/test/resources/responses/rmapi/resources/get-resource-by-id-success-response.json b/src/test/resources/responses/rmapi/resources/get-resource-by-id-success-response.json index f0c0f5bd0..94dee67a2 100644 --- a/src/test/resources/responses/rmapi/resources/get-resource-by-id-success-response.json +++ b/src/test/resources/responses/rmapi/resources/get-resource-by-id-success-response.json @@ -1,5 +1,5 @@ { - "titleId": 762169, + "kbid": 762169, "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", "publisherName": "Praeger", "identifiersList": [ @@ -48,51 +48,6 @@ ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 762169, - "packageId": 3964, - "packageName": "ABC-CLIO eBook Collection", - "packageType": "Variable", - "proxy": { - "id": "<n>", - "inherited": true, - "proxiedUrl": "https://example.com" - }, - "isPackageCustom": false, - "vendorId": 19, - "vendorName": "ABC-CLIO", - "locationId": 2863717, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": true, - "reason": "Hidden by Customer" - }, - "managedCoverageList": [ - { - "beginCoverage": "2005-01-01", - "endCoverage": "2005-12-31" - } - ], - "customCoverageList": [], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "https://publisher.abc-clio.com/9780313068003/", - "userDefinedField1": "test 1", - "userDefinedField2": "test 2", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 5" - } - ], "description": null, "edition": null, "isPeerReviewed": false, @@ -101,5 +56,58 @@ "type": "author", "contributor": "Beeman, William O." } + ], + "listId": 3964, + "packageName": "ABC-CLIO eBook Collection", + "packageType": "Variable", + "proxy": { + "id": "<n>", + "inherited": true, + "proxiedUrl": "https://example.com" + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "ABC-CLIO", + "locationId": 2863717, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2005-01-01", + "endCoverage": "2005-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "https://publisher.abc-clio.com/9780313068003/", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } ] } diff --git a/src/test/resources/responses/rmapi/resources/get-resource-by-id-with-relationships-response.json b/src/test/resources/responses/rmapi/resources/get-resource-by-id-with-relationships-response.json new file mode 100644 index 000000000..fec444baa --- /dev/null +++ b/src/test/resources/responses/rmapi/resources/get-resource-by-id-with-relationships-response.json @@ -0,0 +1,128 @@ +{ + "kbid": 762169, + "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", + "publisherName": "Praeger", + "identifiersList": [ + { + "id": "300079", + "source": "ResourceIdentifier", + "subtype": 0, + "type": 7 + }, + { + "id": "762169", + "source": "AtoZ", + "subtype": 0, + "type": 9 + }, + { + "id": "978-0-275-98214-0", + "source": "ResourceIdentifier", + "subtype": 1, + "type": 1 + }, + { + "id": "978-0-313-06800-3", + "source": "ResourceIdentifier", + "subtype": 2, + "type": 1 + }, + { + "id": "978-1-282-40979-8", + "source": "ResourceIdentifier", + "subtype": 2, + "type": 1 + } + ], + "subjectsList": [ + { + "type": "BISAC", + "subject": "SOCIAL SCIENCE / Ethnic Studies / General" + } + ], + "alternateTitleList": [ + { + "alternateTitle": "Detroit Coll Law Rev", + "titleType": "Abbreviated" + } + ], + "isTitleCustom": false, + "pubType": "Book", + "description": null, + "edition": null, + "isPeerReviewed": false, + "contributorsList": [ + { + "type": "author", + "contributor": "Beeman, William O." + } + ], + "listId": 3964, + "packageName": "ABC-CLIO eBook Collection", + "packageType": "Variable", + "proxy": { + "id": "<n>", + "inherited": true, + "proxiedUrl": "https://example.com" + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "ABC-CLIO", + "locationId": 2863717, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2005-01-01", + "endCoverage": "2005-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "https://publisher.abc-clio.com/9780313068003/", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ], + "titleRelationships": [ + { + "resourceRelationshipId": 42, + "source": { + "kbid": 762169, + "name": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other" + }, + "target": { + "kbid": 4444, + "name": "Continued Title" + }, + "type": "CONTINUED_BY", + "date": "2020-01-01T00:00:00Z" + } + ] +} diff --git a/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response-empty-customer-list.json b/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response-empty-customer-list.json deleted file mode 100644 index 69a9dc574..000000000 --- a/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response-empty-customer-list.json +++ /dev/null @@ -1,424 +0,0 @@ -{ - "totalResults": 5, - "titles": [ - { - "titleId": 2099944, - "titleName": "A Systemic Perspective to Managing Complexity with Enterprise Architecture", - "publisherName": "IGI Global", - "alternateTitleList": [ - { - "alternateTitle": "Colorado Coll Law Rev", - "titleType": "Abbreviated" - } - ], - "identifiersList": [ - { - "id": "978-1-4666-4518-9", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-299-80666-5", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-4666-4519-6", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-4666-4521-9", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "633718", - "source": "ResourceIdentifier", - "subtype": 0, - "type": 7 - }, - { - "id": "2096977", - "source": "AtoZ", - "subtype": 0, - "type": 9 - } - ], - "subjectsList": [ - { - "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Industrial Management" - }, - { - "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Management" - }, - { - "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Management Science" - }, - { - "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Organizational Behavior" - } - ], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [] - }, - { - "titleId": 2324668, - "titleName": "Academic Knowledge Construction and Multimodal Curriculum Development", - "publisherName": "IGI Global", - "alternateTitleList": [ - { - "alternateTitle": "Boston Coll Law Rev", - "titleType": "Abbreviated" - } - ], - "identifiersList": [ - { - "id": "978-1-4666-4797-8", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-4666-4798-5", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-4666-4800-5", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "668430", - "source": "ResourceIdentifier", - "subtype": 0, - "type": 7 - }, - { - "id": "2149244", - "source": "AtoZ", - "subtype": 0, - "type": 9 - } - ], - "subjectsList": [ - { - "type": "TLI", - "subject": "Education (General)" - }, - { - "type": "BISAC", - "subject": "EDUCATION \/ Higher" - } - ], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [] - }, - { - "titleId": 2172685, - "titleName": "Activity Theory Perspectives on Technology in Higher Education", - "publisherName": "IGI Global", - "alternateTitleList": [ - { - "alternateTitle": "Detroit Coll Law Rev", - "titleType": "Abbreviated" - } - ], - "identifiersList": [ - { - "id": "978-1-4666-4590-5", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-4666-4591-2", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-4666-4593-6", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "752357", - "source": "ResourceIdentifier", - "subtype": 0, - "type": 7 - }, - { - "id": "2102103", - "source": "AtoZ", - "subtype": 0, - "type": 9 - } - ], - "subjectsList": [ - { - "type": "BISAC", - "subject": "EDUCATION \/ Higher" - } - ], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2172685, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972340, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4590-5", - "userDefinedField1": null, - "userDefinedField2": null, - "userDefinedField3": null, - "userDefinedField4": null, - "userDefinedField5": null - } - ] - }, - { - "titleId": 2423505, - "titleName": "Advanced Research and Trends in New Technologies, Software, Human-Computer Interaction, and Communicability", - "publisherName": "IGI Global", - "alternateTitleList": [ - { - "alternateTitle": "Dallas Coll Law Rev", - "titleType": "Abbreviated" - } - ], - "identifiersList": [ - { - "id": "978-1-4666-4490-8", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-4666-4493-9", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-4666-4491-5", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "668426", - "source": "ResourceIdentifier", - "subtype": 0, - "type": 7 - }, - { - "id": "1887389", - "source": "AtoZ", - "subtype": 0, - "type": 9 - } - ], - "subjectsList": [ - { - "type": "BISAC", - "subject": "PSYCHOLOGY \/ Social Psychology" - } - ], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2423505, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972237, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4490-8", - "userDefinedField1": null, - "userDefinedField2": null, - "userDefinedField3": null, - "userDefinedField4": null, - "userDefinedField5": null - } - ] - }, - { - "titleId": 2733268, - "titleName": "Adult and Continuing Education: Concepts, Methodologies, Tools, and Applications", - "publisherName": "IGI Global", - "alternateTitleList": [ - { - "alternateTitle": "Atlanta Coll Law Rev", - "titleType": "Abbreviated" - } - ], - "identifiersList": [ - { - "id": "978-1-4666-5780-9", - "source": "ResourceIdentifier", - "subtype": 1, - "type": 1 - }, - { - "id": "978-1-4666-5781-6", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-4666-5782-3", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "978-1-78539-188-0", - "source": "ResourceIdentifier", - "subtype": 2, - "type": 1 - }, - { - "id": "752910", - "source": "ResourceIdentifier", - "subtype": 0, - "type": 7 - }, - { - "id": "2473410", - "source": "AtoZ", - "subtype": 0, - "type": 9 - } - ], - "subjectsList": [ - { - "type": "TLI", - "subject": "Education (General)" - }, - { - "type": "BISAC", - "subject": "EDUCATION \/ Adult & Continuing Education" - }, - { - "type": "BISAC", - "subject": "EDUCATION \/ Non-Formal Education" - } - ], - "isTitleCustom": false, - "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2733268, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972367, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-5780-9", - "userDefinedField1": null, - "userDefinedField2": null, - "userDefinedField3": null, - "userDefinedField4": null, - "userDefinedField5": null - } - ] - } - ] -} diff --git a/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response.json b/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response.json index e14b1396a..dde06ecb4 100644 --- a/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response.json +++ b/src/test/resources/responses/rmapi/resources/get-resources-by-package-id-response.json @@ -2,7 +2,7 @@ "totalResults": 5, "titles": [ { - "titleId": 2099944, + "kbid": 2099944, "titleName": "A Systemic Perspective to Managing Complexity with Enterprise Architecture", "publisherName": "IGI Global", "alternateTitleList": [ @@ -52,68 +52,74 @@ "subjectsList": [ { "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Industrial Management" + "subject": "BUSINESS & ECONOMICS / Industrial Management" }, { "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Management" + "subject": "BUSINESS & ECONOMICS / Management" }, { "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Management Science" + "subject": "BUSINESS & ECONOMICS / Management Science" }, { "type": "BISAC", - "subject": "BUSINESS & ECONOMICS \/ Organizational Behavior" + "subject": "BUSINESS & ECONOMICS / Organizational Behavior" } ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2099944, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972134, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4518-9", - "userDefinedField1": "test 1", - "userDefinedField2": "test 2", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 5" + "listId": 2545963, + "packageName": "InfoSci-Books 2014", + "packageType": "Complete", + "isPackageCustom": false, + "vendorId": 295, + "vendorName": "IGI Global", + "locationId": 28972134, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2014-01-01", + "endCoverage": "2014-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4518-9", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" } ] }, { - "titleId": 2324668, + "kbid": 2324668, "titleName": "Academic Knowledge Construction and Multimodal Curriculum Development", "publisherName": "IGI Global", "alternateTitleList": [ @@ -161,56 +167,62 @@ }, { "type": "BISAC", - "subject": "EDUCATION \/ Higher" + "subject": "EDUCATION / Higher" } ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2324668, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972354, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4797-8", - "userDefinedField1": "test 3", - "userDefinedField2": "test 4", - "userDefinedField3": "", - "userDefinedField4": null, - "userDefinedField5": "test 6" + "listId": 2545963, + "packageName": "InfoSci-Books 2014", + "packageType": "Complete", + "isPackageCustom": false, + "vendorId": 295, + "vendorName": "IGI Global", + "locationId": 28972354, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2014-01-01", + "endCoverage": "2014-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4797-8", + "userDefinedField1": "test 3", + "userDefinedField2": "test 4", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 6", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" } ] }, { - "titleId": 2172685, + "kbid": 2172685, "titleName": "Activity Theory Perspectives on Technology in Higher Education", "publisherName": "IGI Global", "alternateTitleList": [ @@ -254,56 +266,62 @@ "subjectsList": [ { "type": "BISAC", - "subject": "EDUCATION \/ Higher" + "subject": "EDUCATION / Higher" } ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2172685, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972340, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4590-5", - "userDefinedField1": null, - "userDefinedField2": null, - "userDefinedField3": null, - "userDefinedField4": null, - "userDefinedField5": null + "listId": 2545963, + "packageName": "InfoSci-Books 2014", + "packageType": "Complete", + "isPackageCustom": false, + "vendorId": 295, + "vendorName": "IGI Global", + "locationId": 28972340, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2014-01-01", + "endCoverage": "2014-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4590-5", + "userDefinedField1": null, + "userDefinedField2": null, + "userDefinedField3": null, + "userDefinedField4": null, + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" } ] }, { - "titleId": 2423505, + "kbid": 2423505, "titleName": "Advanced Research and Trends in New Technologies, Software, Human-Computer Interaction, and Communicability", "publisherName": "IGI Global", "alternateTitleList": [ @@ -347,56 +365,62 @@ "subjectsList": [ { "type": "BISAC", - "subject": "PSYCHOLOGY \/ Social Psychology" + "subject": "PSYCHOLOGY / Social Psychology" } ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2423505, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972237, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-4490-8", - "userDefinedField1": null, - "userDefinedField2": null, - "userDefinedField3": null, - "userDefinedField4": null, - "userDefinedField5": null + "listId": 2545963, + "packageName": "InfoSci-Books 2014", + "packageType": "Complete", + "isPackageCustom": false, + "vendorId": 295, + "vendorName": "IGI Global", + "locationId": 28972237, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2014-01-01", + "endCoverage": "2014-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-4490-8", + "userDefinedField1": null, + "userDefinedField2": null, + "userDefinedField3": null, + "userDefinedField4": null, + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" } ] }, { - "titleId": 2733268, + "kbid": 2733268, "titleName": "Adult and Continuing Education: Concepts, Methodologies, Tools, and Applications", "publisherName": "IGI Global", "alternateTitleList": [ @@ -450,55 +474,61 @@ }, { "type": "BISAC", - "subject": "EDUCATION \/ Adult & Continuing Education" + "subject": "EDUCATION / Adult & Continuing Education" }, { "type": "BISAC", - "subject": "EDUCATION \/ Non-Formal Education" + "subject": "EDUCATION / Non-Formal Education" } ], "isTitleCustom": false, "pubType": "Book", - "customerResourcesList": [ - { - "titleId": 2733268, - "packageId": 2545963, - "packageName": "InfoSci-Books 2014", - "packageType": "Complete", - "isPackageCustom": false, - "vendorId": 295, - "vendorName": "IGI Global", - "locationId": 28972367, - "isSelected": true, - "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - { - "beginCoverage": "2014-01-01", - "endCoverage": "2014-12-31" - } - ], - "customCoverageList": [ - - ], - "coverageStatement": null, - "managedEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "customEmbargoPeriod": { - "embargoUnit": null, - "embargoValue": 0 - }, - "url": "http:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/978-1-4666-5780-9", - "userDefinedField1": "test 8", - "userDefinedField2": "test 9", - "userDefinedField3": "test 10", - "userDefinedField4": "test 11", - "userDefinedField5": "test 12" + "listId": 2545963, + "packageName": "InfoSci-Books 2014", + "packageType": "Complete", + "isPackageCustom": false, + "vendorId": 295, + "vendorName": "IGI Global", + "locationId": 28972367, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2014-01-01", + "endCoverage": "2014-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://services.igi-global.com/resolvedoi/resolve.aspx?doi=10.4018/978-1-4666-5780-9", + "userDefinedField1": "test 8", + "userDefinedField2": "test 9", + "userDefinedField3": "test 10", + "userDefinedField4": "test 11", + "userDefinedField5": "test 12", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" } ] } diff --git a/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-title-name-response.json b/src/test/resources/responses/rmapi/titles/get-custom-title-updated-name-response.json similarity index 76% rename from src/test/resources/responses/rmapi/resources/get-custom-resource-updated-title-name-response.json rename to src/test/resources/responses/rmapi/titles/get-custom-title-updated-name-response.json index 9cc7b3c92..922a70ae6 100644 --- a/src/test/resources/responses/rmapi/resources/get-custom-resource-updated-title-name-response.json +++ b/src/test/resources/responses/rmapi/titles/get-custom-title-updated-name-response.json @@ -1,5 +1,5 @@ { - "titleId": 19412030, + "kbid": 19412030, "titleName": "new name", "publisherName": "Not Empty", "identifiersList": [ @@ -14,8 +14,8 @@ "pubType": "book", "customerResourcesList": [ { - "titleId": 19412030, - "packageId": 3157070, + "kbid": 19412030, + "listId": 3157070, "packageName": "Andrii custom package ", "packageType": "Custom", "proxy": { @@ -28,10 +28,6 @@ "locationId": 43006476, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [], "customCoverageList": [ { @@ -53,7 +49,24 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": "test description", diff --git a/src/test/resources/responses/rmapi/titles/get-custom-title-updated-response.json b/src/test/resources/responses/rmapi/titles/get-custom-title-updated-response.json new file mode 100644 index 000000000..d7ccc9df3 --- /dev/null +++ b/src/test/resources/responses/rmapi/titles/get-custom-title-updated-response.json @@ -0,0 +1,81 @@ +{ + "kbid": 19412030, + "titleName": "sd-test-java-again", + "publisherName": "Not Empty", + "identifiersList": [ + { + "id": "978-1-280-71298-2", + "subtype": 2, + "type": 1 + } + ], + "subjectsList": [], + "isTitleCustom": true, + "pubType": "book", + "customerResourcesList": [ + { + "kbid": 19412030, + "listId": 3157070, + "packageName": "Andrii custom package ", + "packageType": "Custom", + "proxy": { + "id": "Proxy-ID-234", + "inherited": false + }, + "isPackageCustom": true, + "vendorId": 123356, + "vendorName": "API DEV GOVERNMENT CUSTOMER", + "locationId": 43006476, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [], + "customCoverageList": [ + { + "beginCoverage": "2018-01-10", + "endCoverage": "2018-01-11" + } + ], + "coverageStatement": "My test statement", + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": "Weeks", + "embargoValue": 30 + }, + "url": "https://hello", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] + } + ], + "description": "test description", + "edition": "test edition", + "isPeerReviewed": true, + "contributorsList": [ + { + "type": "author", + "contributor": "Rappaport, Helen" + } + ] +} diff --git a/src/test/resources/responses/rmapi/titles/get-custom-title-with-coverage-dates-asc.json b/src/test/resources/responses/rmapi/titles/get-custom-title-with-coverage-dates-asc.json index b053688e0..e0568e428 100644 --- a/src/test/resources/responses/rmapi/titles/get-custom-title-with-coverage-dates-asc.json +++ b/src/test/resources/responses/rmapi/titles/get-custom-title-with-coverage-dates-asc.json @@ -1,19 +1,15 @@ { - "titleId": 1111111111, + "kbid": 1111111111, "titleName": "test-custom-title-132a648d", "publisherName": "test publisher", - "identifiersList": [ - - ], - "subjectsList": [ - - ], + "identifiersList": [], + "subjectsList": [], "isTitleCustom": true, "pubType": "Database", "customerResourcesList": [ { - "titleId": 1111111111, - "packageId": 222222, + "kbid": 1111111111, + "listId": 222222, "packageName": "test-custom-title-132a648d", "packageType": "Custom", "proxy": { @@ -26,13 +22,7 @@ "locationId": 0, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - - ], + "managedCoverageList": [], "customCoverageList": [ { "beginCoverage": "2001-01-01", @@ -57,13 +47,28 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": "This is the sample description for test", "edition": "test edition", "isPeerReviewed": true, - "contributorsList": [ - - ] + "contributorsList": [] } diff --git a/src/test/resources/responses/rmapi/titles/get-custom-title-with-managed-embargo.json b/src/test/resources/responses/rmapi/titles/get-custom-title-with-managed-embargo.json index 368f11192..c1ac270d6 100644 --- a/src/test/resources/responses/rmapi/titles/get-custom-title-with-managed-embargo.json +++ b/src/test/resources/responses/rmapi/titles/get-custom-title-with-managed-embargo.json @@ -1,19 +1,15 @@ { - "titleId": 1111111111, + "kbid": 1111111111, "titleName": "test-custom-title-132a648d", "publisherName": "test publisher", - "identifiersList": [ - - ], - "subjectsList": [ - - ], + "identifiersList": [], + "subjectsList": [], "isTitleCustom": true, "pubType": "Database", "customerResourcesList": [ { - "titleId": 1111111111, - "packageId": 222222, + "kbid": 1111111111, + "listId": 222222, "packageName": "test-custom-title-132a648d", "packageType": "Custom", "proxy": { @@ -26,13 +22,7 @@ "locationId": 0, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - - ], + "managedCoverageList": [], "customCoverageList": [ { "beginCoverage": "2001-01-01", @@ -57,13 +47,28 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": "This is the sample description for test", "edition": "test edition", "isPeerReviewed": true, - "contributorsList": [ - - ] + "contributorsList": [] } diff --git a/src/test/resources/responses/rmapi/titles/get-custom-title-with-no-selected-resources.json b/src/test/resources/responses/rmapi/titles/get-custom-title-with-no-selected-resources.json index 53a4a7038..aa8f413b4 100644 --- a/src/test/resources/responses/rmapi/titles/get-custom-title-with-no-selected-resources.json +++ b/src/test/resources/responses/rmapi/titles/get-custom-title-with-no-selected-resources.json @@ -1,19 +1,15 @@ { - "titleId": 1111111111, + "kbid": 1111111111, "titleName": "test-custom-title-132a648d", "publisherName": "test publisher", - "identifiersList": [ - - ], - "subjectsList": [ - - ], + "identifiersList": [], + "subjectsList": [], "isTitleCustom": true, "pubType": "Database", "customerResourcesList": [ { - "titleId": 1111111111, - "packageId": 222222, + "kbid": 1111111111, + "listId": 222222, "packageName": "test-custom-title-132a648d", "packageType": "Custom", "proxy": { @@ -26,13 +22,7 @@ "locationId": 0, "isSelected": false, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, - "managedCoverageList": [ - - ], + "managedCoverageList": [], "customCoverageList": [ { "beginCoverage": "2001-01-01", @@ -57,13 +47,28 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": "This is the sample description for test", "edition": "test edition", "isPeerReviewed": true, - "contributorsList": [ - - ] + "contributorsList": [] } diff --git a/src/test/resources/responses/rmapi/titles/get-managed-title-updated-response.json b/src/test/resources/responses/rmapi/titles/get-managed-title-updated-response.json new file mode 100644 index 000000000..db42af235 --- /dev/null +++ b/src/test/resources/responses/rmapi/titles/get-managed-title-updated-response.json @@ -0,0 +1,111 @@ +{ + "kbid": 762169, + "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", + "publisherName": "Praeger", + "identifiersList": [ + { + "id": "300079", + "source": "ResourceIdentifier", + "subtype": 0, + "type": 7 + }, + { + "id": "762169", + "source": "AtoZ", + "subtype": 0, + "type": 9 + }, + { + "id": "978-0-275-98214-0", + "source": "ResourceIdentifier", + "subtype": 1, + "type": 1 + }, + { + "id": "978-0-313-06800-3", + "source": "ResourceIdentifier", + "subtype": 2, + "type": 1 + }, + { + "id": "978-1-282-40979-8", + "source": "ResourceIdentifier", + "subtype": 2, + "type": 1 + } + ], + "subjectsList": [ + { + "type": "BISAC", + "subject": "SOCIAL SCIENCE / Ethnic Studies / General" + } + ], + "isTitleCustom": false, + "pubType": "Book", + "customerResourcesList": [ + { + "kbid": 762169, + "listId": 3964, + "packageName": "ABC-CLIO eBook Collection", + "packageType": "Variable", + "proxy": { + "id": "Test-proxy-id", + "inherited": false + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "ABC-CLIO", + "locationId": 2863717, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "2005-01-01", + "endCoverage": "2005-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": "test coverage statement", + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": "Years", + "embargoValue": 10 + }, + "url": "https://publisher.abc-clio.com/9780313068003/", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": false, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": false, + "reason": "Hidden by Customer" + } + ] + } + ], + "description": null, + "edition": null, + "isPeerReviewed": false, + "contributorsList": [ + { + "type": "author", + "contributor": "Beeman, William O." + } + ] +} diff --git a/src/test/resources/responses/rmapi/titles/get-title-by-id-2-response.json b/src/test/resources/responses/rmapi/titles/get-title-by-id-2-response.json index 523644fa7..ada854031 100644 --- a/src/test/resources/responses/rmapi/titles/get-title-by-id-2-response.json +++ b/src/test/resources/responses/rmapi/titles/get-title-by-id-2-response.json @@ -1,5 +1,5 @@ { - "titleId": 1108525, + "kbid": 1108525, "titleName": "\"Great Satan\" Vs. the \"Mad Mullahs\": How the United States and Iran Demonize Each Other", "publisherName": "Praeger", "identifiersList": [ @@ -19,7 +19,7 @@ "subjectsList": [ { "type": "BISAC", - "subject": "SOCIAL SCIENCE \/ Ethnic Studies \/ General" + "subject": "SOCIAL SCIENCE / Ethnic Studies / General" } ], "alternateTitleList": [ @@ -32,8 +32,8 @@ "pubType": "Book", "customerResourcesList": [ { - "titleId": 1108525, - "packageId": 3964, + "kbid": 1108525, + "listId": 3964, "packageName": "EBSCO eBooks", "packageType": "Selectable", "proxy": { @@ -46,19 +46,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -68,16 +62,33 @@ "embargoUnit": null, "embargoValue": 0 }, - "url": "http:\/\/search.ebscohost.com\/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { - "titleId": 1108525, - "packageId": 18, + "kbid": 1108525, + "listId": 18, "packageName": "Other package", "packageType": "Selectable", "proxy": { @@ -89,19 +100,13 @@ "vendorName": "BestVendor", "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -115,7 +120,24 @@ "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": null, diff --git a/src/test/resources/responses/rmapi/titles/get-title-by-id-for-post-request.json b/src/test/resources/responses/rmapi/titles/get-title-by-id-for-post-request.json index cc12788fd..24e7e7bf2 100644 --- a/src/test/resources/responses/rmapi/titles/get-title-by-id-for-post-request.json +++ b/src/test/resources/responses/rmapi/titles/get-title-by-id-for-post-request.json @@ -1,5 +1,5 @@ { - "titleId": 985846, + "kbid": 985846, "titleName": "Test Title", "publisherName": "Test publisher", "identifiersList": [ @@ -15,8 +15,8 @@ "pubType": "ThesisDissertation", "customerResourcesList": [ { - "titleId": 985846, - "packageId": 3964, + "kbid": 985846, + "listId": 3964, "packageName": "a", "packageType": "Custom", "proxy": { @@ -29,10 +29,6 @@ "locationId": 0, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": true, - "reason": "Hidden by Customer" - }, "managedCoverageList": [], "customCoverageList": [], "coverageStatement": null, @@ -48,8 +44,25 @@ "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", - "userDefinedField4" : "test 4", - "userDefinedField5": "test 5" + "userDefinedField4": "test 4", + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "FTF", + "hidden": true, + "reason": "Hidden by Customer" + }, + { + "category": "MARC", + "hidden": true, + "reason": "Hidden by Customer" + } + ] } ], "description": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit.", @@ -61,8 +74,8 @@ "contributor": "smith, john" }, { - "type": "illustrator", - "contributor": "smith, ralph" + "type": "illustrator", + "contributor": "smith, ralph" } ] } diff --git a/src/test/resources/responses/rmapi/titles/get-title-by-id-response-with-resources.json b/src/test/resources/responses/rmapi/titles/get-title-by-id-response-with-resources.json index 72de2249a..e9065e894 100644 --- a/src/test/resources/responses/rmapi/titles/get-title-by-id-response-with-resources.json +++ b/src/test/resources/responses/rmapi/titles/get-title-by-id-response-with-resources.json @@ -1,5 +1,5 @@ { - "titleId": 762169, + "kbid": 762169, "titleName": "F. Scott Fitzgerald's The Great Gatsby (Great Gatsby)", "publisherName": "Chelsea House Publishers", "identifiersList": [ @@ -37,7 +37,7 @@ "subjectsList": [ { "type": "BISAC", - "subject": "LITERARY CRITICISM \/ American \/ General" + "subject": "LITERARY CRITICISM / American / General" } ], "alternateTitleList": [ @@ -50,8 +50,8 @@ "pubType": "Book", "customerResourcesList": [ { - "titleId": 762169, - "packageId": 3964, + "kbid": 762169, + "listId": 3964, "packageName": "EBSCO eBooks", "packageType": "Selectable", "proxy": { @@ -64,19 +64,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -86,16 +80,33 @@ "embargoUnit": null, "embargoValue": 0 }, - "url": "http:\/\/search.ebscohost.com\/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { - "titleId": 762169, - "packageId": 0, + "kbid": 762169, + "listId": 0, "packageName": "", "packageType": "Selectable", "proxy": { @@ -108,19 +119,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -129,11 +134,28 @@ "customEmbargoPeriod": { "embargoUnit": null, "embargoValue": 0 - } + }, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { - "titleId": 762169, - "packageId": 987, + "kbid": 762169, + "listId": 987, "packageName": "# eBooks", "packageType": "Selectable", "proxy": { @@ -146,19 +168,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -168,16 +184,33 @@ "embargoUnit": null, "embargoValue": 0 }, - "url": "http:\/\/search.ebscohost.com\/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { - "titleId": 762169, - "packageId": 7745, + "kbid": 762169, + "listId": 7745, "packageName": "1st eBooks", "packageType": "Selectable", "proxy": { @@ -190,19 +223,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -212,12 +239,29 @@ "embargoUnit": null, "embargoValue": 0 }, - "url": "http:\/\/search.ebscohost.com\/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": null, diff --git a/src/test/resources/responses/rmapi/titles/get-title-by-id-response.json b/src/test/resources/responses/rmapi/titles/get-title-by-id-response.json index f8f115a05..ceae494a2 100644 --- a/src/test/resources/responses/rmapi/titles/get-title-by-id-response.json +++ b/src/test/resources/responses/rmapi/titles/get-title-by-id-response.json @@ -1,5 +1,5 @@ { - "titleId": 762169, + "kbid": 762169, "titleName": "F. Scott Fitzgerald's The Great Gatsby (Great Gatsby)", "publisherName": "Chelsea House Publishers", "identifiersList": [ @@ -37,7 +37,7 @@ "subjectsList": [ { "type": "BISAC", - "subject": "LITERARY CRITICISM \/ American \/ General" + "subject": "LITERARY CRITICISM / American / General" } ], "alternateTitleList": [ @@ -50,8 +50,8 @@ "pubType": "Book", "customerResourcesList": [ { - "titleId": 762169, - "packageId": 3964, + "kbid": 762169, + "listId": 3964, "packageName": "EBSCO eBooks", "packageType": "Selectable", "proxy": { @@ -64,19 +64,13 @@ "locationId": 3464602, "isSelected": true, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "1996-01-01", "endCoverage": "1996-12-31" } ], - "customCoverageList": [ - - ], + "customCoverageList": [], "coverageStatement": null, "managedEmbargoPeriod": { "embargoUnit": null, @@ -86,12 +80,29 @@ "embargoUnit": null, "embargoValue": 0 }, - "url": "http:\/\/search.ebscohost.com\/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", "userDefinedField1": "test 1", "userDefinedField2": "test 2", "userDefinedField3": "", "userDefinedField4": null, - "userDefinedField5": "test 5" + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ], "description": null, diff --git a/src/test/resources/responses/rmapi/titles/get-title-by-id-with-relationships-response.json b/src/test/resources/responses/rmapi/titles/get-title-by-id-with-relationships-response.json new file mode 100644 index 000000000..c55383d77 --- /dev/null +++ b/src/test/resources/responses/rmapi/titles/get-title-by-id-with-relationships-response.json @@ -0,0 +1,132 @@ +{ + "kbid": 762169, + "titleName": "F. Scott Fitzgerald's The Great Gatsby (Great Gatsby)", + "publisherName": "Chelsea House Publishers", + "identifiersList": [ + { + "id": "38624", + "source": "ResourceIdentifier", + "subtype": 0, + "type": 7 + }, + { + "id": "978-0-585-24731-1", + "source": "ResourceIdentifier", + "subtype": 2, + "type": 1 + }, + { + "id": "978-0-7910-3651-8", + "source": "ResourceIdentifier", + "subtype": 1, + "type": 1 + }, + { + "id": "985846", + "source": "AtoZ", + "subtype": 0, + "type": 9 + }, + { + "id": "U7Q", + "source": "MFS", + "subtype": 0, + "type": 8 + } + ], + "subjectsList": [ + { + "type": "BISAC", + "subject": "LITERARY CRITICISM / American / General" + } + ], + "alternateTitleList": [ + { + "alternateTitle": "Boston Coll Law Rev", + "titleType": "Abbreviated" + } + ], + "isTitleCustom": false, + "pubType": "Book", + "customerResourcesList": [ + { + "kbid": 762169, + "listId": 3964, + "packageName": "EBSCO eBooks", + "packageType": "Selectable", + "proxy": { + "id": "EZProxy", + "inherited": true + }, + "isPackageCustom": false, + "vendorId": 19, + "vendorName": "EBSCO", + "locationId": 3464602, + "isSelected": true, + "isTokenNeeded": false, + "managedCoverageList": [ + { + "beginCoverage": "1996-01-01", + "endCoverage": "1996-12-31" + } + ], + "customCoverageList": [], + "coverageStatement": null, + "managedEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "customEmbargoPeriod": { + "embargoUnit": null, + "embargoValue": 0 + }, + "url": "http://search.ebscohost.com/login.aspx?direct=true&scope=site&db=nlebk&db=nlabk&AN=38624", + "userDefinedField1": "test 1", + "userDefinedField2": "test 2", + "userDefinedField3": "", + "userDefinedField4": null, + "userDefinedField5": "test 5", + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] + } + ], + "description": null, + "edition": null, + "isPeerReviewed": false, + "contributorsList": [ + { + "type": "author", + "contributor": "Bloom, Harold" + } + ], + "titleRelationships": [ + { + "resourceRelationshipId": 42, + "source": { + "kbid": 762169, + "name": "F. Scott Fitzgerald's The Great Gatsby (Great Gatsby)" + }, + "target": { + "kbid": 4444, + "name": "Continued Title" + }, + "type": "CONTINUED_BY", + "date": "2020-01-01T00:00:00Z" + } + ] +} diff --git a/src/test/resources/responses/rmapi/titles/searchTitles.json b/src/test/resources/responses/rmapi/titles/searchTitles.json index 01b9f7b49..1bf921620 100644 --- a/src/test/resources/responses/rmapi/titles/searchTitles.json +++ b/src/test/resources/responses/rmapi/titles/searchTitles.json @@ -16,7 +16,7 @@ "contributor": "Black, John" } ], - "titleId": 1175655, + "kbid": 1175655, "titleName": "The $1 Million Reason to Change Your Mind", "publisherName": null, "identifiersList": [ @@ -64,8 +64,8 @@ "selected": false, "tokenNeeded": false, "packageCustom": false, - "titleId": 1175655, - "packageId": 22551, + "kbid": 1175655, + "listId": 22551, "packageName": "123Library eBooks", "isPackageCustom": false, "vendorId": 58251, @@ -73,10 +73,6 @@ "locationId": 8572506, "isSelected": false, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [], "customCoverageList": [], "coverageStatement": null, @@ -93,14 +89,31 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { "selected": false, "tokenNeeded": true, "packageCustom": false, - "titleId": 1175655, - "packageId": 1884903, + "kbid": 1175655, + "listId": 1884903, "packageName": "ProQuest Ebook Library (EBL)", "isPackageCustom": false, "vendorId": 22, @@ -108,10 +121,6 @@ "locationId": 20482285, "isSelected": false, "isTokenNeeded": true, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "2011-01-01", @@ -133,14 +142,31 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { "selected": false, "tokenNeeded": false, "packageCustom": false, - "titleId": 1175655, - "packageId": 1861142, + "kbid": 1175655, + "listId": 1861142, "packageName": "MyiLibrary", "isPackageCustom": false, "vendorId": 58388, @@ -148,10 +174,6 @@ "locationId": 9035313, "isSelected": false, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "2011-01-01", @@ -173,14 +195,31 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { "selected": false, "tokenNeeded": true, "packageCustom": false, - "titleId": 1175655, - "packageId": 1887786, + "kbid": 1175655, + "listId": 1887786, "packageName": "ProQuest Ebook Central", "isPackageCustom": false, "vendorId": 22, @@ -188,10 +227,6 @@ "locationId": 20692303, "isSelected": false, "isTokenNeeded": true, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "2011-01-01", @@ -213,14 +248,31 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { "selected": false, "tokenNeeded": false, "packageCustom": false, - "titleId": 1175655, - "packageId": 6822, + "kbid": 1175655, + "listId": 6822, "packageName": "DawsonEra eBooks", "isPackageCustom": false, "vendorId": 977, @@ -228,10 +280,6 @@ "locationId": 5491226, "isSelected": false, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "2011-01-01", @@ -253,14 +301,31 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] }, { "selected": false, "tokenNeeded": false, "packageCustom": false, - "titleId": 1175655, - "packageId": 3964, + "kbid": 1175655, + "listId": 3964, "packageName": "EBSCO eBooks", "isPackageCustom": false, "vendorId": 19, @@ -268,10 +333,6 @@ "locationId": 3982299, "isSelected": false, "isTokenNeeded": false, - "visibilityData": { - "isHidden": false, - "reason": "" - }, "managedCoverageList": [ { "beginCoverage": "2009-01-01", @@ -293,7 +354,24 @@ "userDefinedField2": null, "userDefinedField3": null, "userDefinedField4": null, - "userDefinedField5": null + "userDefinedField5": null, + "visibility": [ + { + "category": "PF", + "hidden": false, + "reason": "" + }, + { + "category": "FTF", + "hidden": false, + "reason": "" + }, + { + "category": "MARC", + "hidden": false, + "reason": "" + } + ] } ] }