MODTLR-79: Pick Slips API (part 2) (#78)

* MODTLR-79 Departments and address types

* MODTLR-79 Implementation

* MODTLR-79 Lower limit for search by query

* MODTLR-79 Search instances with expandAll=true

* MODTLR-79 Search instances with expandAll=true

* MODTLR-79 Convert UUID to string

* MODTLR-79 Fresh schemas, tests

* MODTLR-79 Allow additional properties in imported schemas

* MODTLR-79 Verify all calls in test

* MODTLR-79 Tests for PickSlipsServiceImpl

* MODTLR-79 Fix code smells

* MODTLR-79 Remove unused class

descriptors/ModuleDescriptor-template.json

@@ -114,15 +114,28 @@
       ]
     },
     {
-      "id": "staff-slips",
+      "id": "tlr-staff-slips",
       "version": "1.0",
       "handlers": [
         {
           "methods": ["GET"],
           "pathPattern": "/tlr/staff-slips/pick-slips/{servicePointId}",
-          "permissionsRequired": ["tlr.staff-slips.pick-slips.get"],
+          "permissionsRequired": ["tlr.pick-slips.collection.get"],
           "modulePermissions": [
-            "user-tenants.collection.get"
+            "user-tenants.collection.get",
+            "search.instances.collection.get",
+            "circulation-storage.requests.item.get",
+            "circulation-storage.requests.collection.get",
+            "users.item.get",
+            "users.collection.get",
+            "usergroups.item.get",
+            "usergroups.collection.get",
+            "departments.item.get",
+            "departments.collection.get",
+            "addresstypes.item.get",
+            "addresstypes.collection.get",
+            "inventory-storage.service-points.item.get",
+            "inventory-storage.service-points.collection.get"
           ]
         }
       ]
@@ -228,7 +241,7 @@
       "description": "Get ECS TLR allowed service points"
     },
     {
-      "permissionName": "tlr.staff-slips.pick-slips.get",
+      "permissionName": "tlr.pick-slips.collection.get",
       "displayName": "ecs-tlr - pick slips",
       "description": "Get pick slips"
     },

src/main/java/org/folio/client/feign/AddressTypeClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.AddressTypes;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "address-types", url = "addresstypes", configuration = FeignClientConfiguration.class)
+public interface AddressTypeClient extends GetByQueryClient<AddressTypes> {
+
+}

src/main/java/org/folio/client/feign/DepartmentClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.Departments;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "departments", url = "departments", configuration = FeignClientConfiguration.class)
+public interface DepartmentClient extends GetByQueryClient<Departments> {
+
+}

src/main/java/org/folio/client/feign/GetByQueryClient.java

@@ -8,12 +8,14 @@
 
 @FeignClient(name="get-by-query", configuration = FeignClientConfiguration.class)
 public interface GetByQueryClient<T> {
+
   int DEFAULT_LIMIT = 1000;
 
   @GetMapping
-  T getByQuery(@RequestParam CqlQuery query, @RequestParam int limit);
+  T getByQuery(@RequestParam CqlQuery query, @RequestParam(defaultValue = "1000") int limit);
 
   default T getByQuery(CqlQuery query) {
     return getByQuery(query, DEFAULT_LIMIT);
   }
+
 }

src/main/java/org/folio/client/feign/LoanTypeClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.LoanTypes;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "loan-types", url = "loan-types", configuration = FeignClientConfiguration.class)
+public interface LoanTypeClient extends GetByQueryClient<LoanTypes> {
+
+}

src/main/java/org/folio/client/feign/LocationCampusClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.Campuses;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "campuses", url = "location-units/campuses", configuration = FeignClientConfiguration.class)
+public interface LocationCampusClient extends GetByQueryClient<Campuses> {
+
+}

src/main/java/org/folio/client/feign/LocationInstitutionClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.Institutions;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "institutions", url = "location-units/institutions", configuration = FeignClientConfiguration.class)
+public interface LocationInstitutionClient extends GetByQueryClient<Institutions> {
+
+}

src/main/java/org/folio/client/feign/LocationLibraryClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.Libraries;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "libraries", url = "location-units/libraries", configuration = FeignClientConfiguration.class)
+public interface LocationLibraryClient extends GetByQueryClient<Libraries> {
+
+}

src/main/java/org/folio/client/feign/MaterialTypeClient.java

@@ -0,0 +1,10 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.MaterialTypes;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+
+@FeignClient(name = "material-types", url = "material-types", configuration = FeignClientConfiguration.class)
+public interface MaterialTypeClient extends GetByQueryClient<MaterialTypes> {
+
+}

src/main/java/org/folio/client/feign/SearchClient.java → src/main/java/org/folio/client/feign/SearchInstanceClient.java

@@ -1,25 +1,25 @@
 package org.folio.client.feign;
 
 import org.folio.domain.dto.SearchInstancesResponse;
-import org.folio.domain.dto.SearchItemResponse;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.folio.support.CqlQuery;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestParam;
 
-@FeignClient(name = "search", url = "search", configuration = FeignClientConfiguration.class)
-public interface SearchClient {
+@FeignClient(name = "search", url = "search/instances", configuration = FeignClientConfiguration.class)
+public interface SearchInstanceClient extends GetByQueryClient<SearchInstancesResponse> {
 
-  @GetMapping("/instances")
+  @GetMapping
   SearchInstancesResponse searchInstances(@RequestParam("query") CqlQuery cql,
-    @RequestParam("expandAll") Boolean expandAll);
+    @RequestParam("expandAll") Boolean expandAll, @RequestParam("limit") int limit);
 
-  @GetMapping("/instances?query=id=={instanceId}&expandAll=true")
+  @GetMapping("?query=id=={instanceId}&expandAll=true")
   SearchInstancesResponse searchInstance(@PathVariable("instanceId") String instanceId);
 
-  @GetMapping("/consortium/item/{itemId}")
-  SearchItemResponse searchItem(@PathVariable("itemId") String itemId);
-
+  @Override
+  // max limit for instance search is 500
+  @GetMapping("?expandAll=true&limit=500&query={query}")
+  SearchInstancesResponse getByQuery(@PathVariable CqlQuery query);
 }

src/main/java/org/folio/client/feign/SearchItemClient.java

@@ -0,0 +1,17 @@
+package org.folio.client.feign;
+
+import org.folio.domain.dto.SearchInstancesResponse;
+import org.folio.domain.dto.SearchItemResponse;
+import org.folio.spring.config.FeignClientConfiguration;
+import org.springframework.cloud.openfeign.FeignClient;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+
+@FeignClient(name = "search-item", url = "search/consortium/item",
+  configuration = FeignClientConfiguration.class)
+public interface SearchItemClient extends GetByQueryClient<SearchInstancesResponse> {
+
+  @GetMapping("/{itemId}")
+  SearchItemResponse searchItem(@PathVariable("itemId") String itemId);
+
+}

src/main/java/org/folio/client/feign/ServicePointClient.java

@@ -1,6 +1,7 @@
 package org.folio.client.feign;
 
 import org.folio.domain.dto.ServicePoint;
+import org.folio.domain.dto.ServicePoints;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -9,7 +10,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 
 @FeignClient(name = "service-points", url = "service-points", configuration = FeignClientConfiguration.class)
-public interface ServicePointClient {
+public interface ServicePointClient extends GetByQueryClient<ServicePoints> {
 
   @PostMapping
   ServicePoint postServicePoint(@RequestBody ServicePoint servicePoint);

src/main/java/org/folio/client/feign/UserClient.java

@@ -1,6 +1,7 @@
 package org.folio.client.feign;
 
 import org.folio.domain.dto.User;
+import org.folio.domain.dto.Users;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.http.MediaType;
@@ -11,7 +12,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 
 @FeignClient(name = "users", url = "users", configuration = FeignClientConfiguration.class)
-public interface UserClient {
+public interface UserClient extends GetByQueryClient<Users> {
 
   @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
   User postUser(@RequestBody User user);

src/main/java/org/folio/client/feign/UserGroupClient.java

@@ -1,6 +1,7 @@
 package org.folio.client.feign;
 
 import org.folio.domain.dto.UserGroup;
+import org.folio.domain.dto.UserGroups;
 import org.folio.spring.config.FeignClientConfiguration;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.http.MediaType;
@@ -10,7 +11,7 @@
 import org.springframework.web.bind.annotation.RequestBody;
 
 @FeignClient(name = "groups", url = "groups", configuration = FeignClientConfiguration.class)
-public interface UserGroupClient {
+public interface UserGroupClient extends GetByQueryClient<UserGroups> {
 
   @PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE)
   UserGroup postUserGroup(@RequestBody UserGroup userGroup);

src/main/java/org/folio/service/AddressTypeService.java

@@ -0,0 +1,9 @@
+package org.folio.service;
+
+import java.util.Collection;
+
+import org.folio.domain.dto.AddressType;
+
+public interface AddressTypeService {
+  Collection<AddressType> findAddressTypes(Collection<String> ids);
+}

src/main/java/org/folio/service/DepartmentService.java

@@ -0,0 +1,9 @@
+package org.folio.service;
+
+import java.util.Collection;
+
+import org.folio.domain.dto.Department;
+
+public interface DepartmentService {
+  Collection<Department> findDepartments(Collection<String> ids);
+}

src/main/java/org/folio/service/InventoryService.java

@@ -0,0 +1,21 @@
+package org.folio.service;
+
+import java.util.Collection;
+
+import org.folio.domain.dto.Campus;
+import org.folio.domain.dto.Institution;
+import org.folio.domain.dto.Item;
+import org.folio.domain.dto.Library;
+import org.folio.domain.dto.LoanType;
+import org.folio.domain.dto.MaterialType;
+import org.folio.support.CqlQuery;
+
+public interface InventoryService {
+  Collection<Item> findItems(CqlQuery query, String idIndex, Collection<String> ids);
+  Collection<Item> findItems(Collection<String> ids);
+  Collection<MaterialType> findMaterialTypes(Collection<String> ids);
+  Collection<LoanType> findLoanTypes(Collection<String> ids);
+  Collection<Library> findLibraries(Collection<String> ids);
+  Collection<Campus> findCampuses(Collection<String> ids);
+  Collection<Institution> findInstitutions(Collection<String> ids);
+}

src/main/java/org/folio/service/SearchService.java

@@ -0,0 +1,11 @@
+package org.folio.service;
+
+import java.util.Collection;
+
+import org.folio.domain.dto.SearchInstance;
+import org.folio.support.CqlQuery;
+
+public interface SearchService {
+  Collection<SearchInstance> searchInstances(CqlQuery commonQuery, String idIndex,
+    Collection<String> ids);
+}

src/main/java/org/folio/service/ServicePointService.java

@@ -1,8 +1,11 @@
 package org.folio.service;
 
+import java.util.Collection;
+
 import org.folio.domain.dto.ServicePoint;
 
 public interface ServicePointService {
   ServicePoint find(String id);
+  Collection<ServicePoint> find(Collection<String> servicePointIds);
   ServicePoint create(ServicePoint servicePoint);
 }

src/main/java/org/folio/service/UserGroupService.java

@@ -1,8 +1,11 @@
 package org.folio.service;
 
+import java.util.Collection;
+
 import org.folio.domain.dto.UserGroup;
 
 public interface UserGroupService {
   UserGroup create(UserGroup userGroup);
   UserGroup update(UserGroup userGroup);
+  Collection<UserGroup> find(Collection<String> ids);
 }

src/main/java/org/folio/service/UserService.java

@@ -1,9 +1,12 @@
 package org.folio.service;
 
+import java.util.Collection;
+
 import org.folio.domain.dto.User;
 
 public interface UserService {
   User find(String userId);
   User create(User user);
   User update(User user);
+  Collection<User> find(Collection<String> userIds);
 }

src/main/java/org/folio/service/impl/AddressTypeServiceImpl.java

@@ -0,0 +1,28 @@
+package org.folio.service.impl;
+
+import java.util.Collection;
+
+import org.folio.client.feign.AddressTypeClient;
+import org.folio.domain.dto.AddressType;
+import org.folio.domain.dto.AddressTypes;
+import org.folio.service.AddressTypeService;
+import org.folio.support.BulkFetcher;
+import org.springframework.stereotype.Service;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.log4j.Log4j2;
+
+@Service
+@RequiredArgsConstructor
+@Log4j2
+public class AddressTypeServiceImpl implements AddressTypeService {
+
+  private final AddressTypeClient addressTypeClient;
+
+  @Override
+  public Collection<AddressType> findAddressTypes(Collection<String> ids) {
+    log.info("findAddressTypes:: fetching address types by {} IDs", ids.size());
+    log.debug("findAddressTypes:: ids={}", ids);
+    return BulkFetcher.fetch(addressTypeClient, ids, AddressTypes::getAddressTypes);
+  }
+}

src/main/java/org/folio/service/impl/AllowedServicePointsForItemLevelRequestService.java

@@ -5,7 +5,7 @@
 
 import org.apache.commons.lang3.StringUtils;
 import org.folio.client.feign.CirculationClient;
-import org.folio.client.feign.SearchClient;
+import org.folio.client.feign.SearchItemClient;
 import org.folio.domain.dto.AllowedServicePointsRequest;
 import org.folio.domain.dto.AllowedServicePointsResponse;
 import org.folio.domain.dto.SearchItemResponse;
@@ -21,7 +21,7 @@
 @Service
 public class AllowedServicePointsForItemLevelRequestService extends AllowedServicePointsServiceImpl {
 
-  public AllowedServicePointsForItemLevelRequestService(SearchClient searchClient,
+  public AllowedServicePointsForItemLevelRequestService(SearchItemClient searchClient,
     CirculationClient circulationClient, UserService userService,
     SystemUserScopedExecutionService executionService, RequestService requestService,
     EcsTlrRepository ecsTlrRepository) {
@@ -32,7 +32,7 @@ public AllowedServicePointsForItemLevelRequestService(SearchClient searchClient,
 
   @Override
   protected Collection<String> getLendingTenants(AllowedServicePointsRequest request) {
-    SearchItemResponse item = searchClient.searchItem(request.getItemId());
+    SearchItemResponse item = searchItemClient.searchItem(request.getItemId());
     if (StringUtils.isNotEmpty(item.getTenantId())) {
       request.setInstanceId(item.getInstanceId());
       return List.of(item.getTenantId());