Merge pull request #221 from folio-org/CIRCSTORE-170

[CIRCSTORE-170] Add Item Limit to Loan Policy

descriptors/ModuleDescriptor-template.json

@@ -80,7 +80,7 @@
     },
     {
       "id": "loan-policy-storage",
-      "version": "2.0",
+      "version": "2.1",
       "handlers": [
         {
           "methods": ["GET"],

pom.xml

@@ -52,6 +52,11 @@
       <version>5.4.2</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.glassfish.web</groupId>
+      <artifactId>javax.el</artifactId>
+      <version>2.2.4</version>
+    </dependency>
   </dependencies>
 
   <properties>

ramls/examples/loan-policy.json

@@ -13,7 +13,8 @@
     "gracePeriod": {
       "duration": 7,
       "intervalId": "Days"
-    }
+    },
+    "itemLimit": 1000
   },
   "renewable": true,
   "renewalsPolicy": {

ramls/loan-policy-storage.raml

@@ -1,6 +1,6 @@
 #%RAML 1.0
 title: Loan Policy Storage
-version: v2.0
+version: v2.1
 protocols: [ HTTP, HTTPS ]
 baseUri: http://localhost:9130
 

ramls/loan-policy.json

@@ -44,6 +44,12 @@
         "fixedDueDateScheduleId": {
           "type": "string",
           "description": "Fixed due date schedule (due date limit)"
+        },
+        "itemLimit": {
+          "type": "integer",
+          "description": "Number of items allowed",
+          "minimum": 1,
+          "maximum": 9999
         }
       }
     },

src/test/java/org/folio/rest/api/LoanPoliciesApiTest.java

@@ -314,6 +314,108 @@ public void cannotCreateALoanPolicyWithAdditionalPropertiesInLoanPolicy()
       response.getStatusCode(), is(HttpStatus.HTTP_VALIDATION_ERROR.toInt()));
   }
 
+  @Test
+  public void canCreateLoanPolicyWithItemLimitWithinBounds()
+    throws MalformedURLException,
+    InterruptedException,
+    ExecutionException,
+    TimeoutException {
+
+    CompletableFuture<JsonResponse> createCompleted = new CompletableFuture<>();
+
+    UUID id = UUID.randomUUID();
+
+    JsonObject loanPolicyRequest = defaultRollingPolicy()
+      .withId(id)
+      .withName("Example Loan Policy")
+      .withDescription("An example loan policy")
+      .create();
+
+    loanPolicyRequest.getJsonObject("loansPolicy").put("itemLimit", 1000);
+
+    client.post(loanPolicyStorageUrl(),
+      loanPolicyRequest, StorageTestSuite.TENANT_ID,
+      ResponseHandler.json(createCompleted));
+
+    JsonResponse response = createCompleted.get(5, TimeUnit.SECONDS);
+
+    assertThat(String.format("Failed to create loan policy: %s", response.getBody()),
+      response.getStatusCode(), is(HttpURLConnection.HTTP_CREATED));
+    assertThat(response.getJson().getJsonObject("loansPolicy").getInteger("itemLimit"), is(1000));
+  }
+
+  @Test
+  public void cannotCreateLoanPolicyWithItemLimitBelowMinimum()
+    throws MalformedURLException,
+    InterruptedException,
+    ExecutionException,
+    TimeoutException {
+
+    CompletableFuture<JsonResponse> createCompleted = new CompletableFuture<>();
+
+    UUID id = UUID.randomUUID();
+
+    JsonObject loanPolicyRequest = defaultRollingPolicy()
+      .withId(id)
+      .withName("Example Loan Policy")
+      .withDescription("An example loan policy")
+      .create();
+
+    loanPolicyRequest.getJsonObject("loansPolicy").put("itemLimit", 0);
+
+    client.post(loanPolicyStorageUrl(),
+      loanPolicyRequest, StorageTestSuite.TENANT_ID,
+      ResponseHandler.json(createCompleted));
+
+    JsonResponse response = createCompleted.get(5, TimeUnit.SECONDS);
+
+    assertThat(String.format("Should fail to create loan policy: %s", response.getBody()),
+      response.getStatusCode(), is(HttpStatus.HTTP_VALIDATION_ERROR.toInt()));
+
+    JsonObject error = getErrorFromResponse(response);
+    JsonObject parameters = error.getJsonArray("parameters").getJsonObject(0);
+
+    assertThat(error.getString("message"), is("must be greater than or equal to 1"));
+    assertThat(parameters.getString("key"), is("loansPolicy.itemLimit"));
+    assertThat(parameters.getString("value"), is("0"));
+  }
+
+  @Test
+  public void cannotCreateLoanPolicyWithItemLimitAboveMaximum()
+    throws MalformedURLException,
+    InterruptedException,
+    ExecutionException,
+    TimeoutException {
+
+    CompletableFuture<JsonResponse> createCompleted = new CompletableFuture<>();
+
+    UUID id = UUID.randomUUID();
+
+    JsonObject loanPolicyRequest = defaultRollingPolicy()
+      .withId(id)
+      .withName("Example Loan Policy")
+      .withDescription("An example loan policy")
+      .create();
+
+    loanPolicyRequest.getJsonObject("loansPolicy").put("itemLimit", 10_000);
+
+    client.post(loanPolicyStorageUrl(),
+      loanPolicyRequest, StorageTestSuite.TENANT_ID,
+      ResponseHandler.json(createCompleted));
+
+    JsonResponse response = createCompleted.get(5, TimeUnit.SECONDS);
+
+    assertThat(String.format("Should fail to create loan policy: %s", response.getBody()),
+      response.getStatusCode(), is(HttpStatus.HTTP_VALIDATION_ERROR.toInt()));
+
+    JsonObject error = getErrorFromResponse(response);
+    JsonObject parameters = error.getJsonArray("parameters").getJsonObject(0);
+
+    assertThat(error.getString("message"), is("must be less than or equal to 9999"));
+    assertThat(parameters.getString("key"), is("loansPolicy.itemLimit"));
+    assertThat(parameters.getString("value"), is("10000"));
+  }
+
   @Test
   public void cannotCreateALoanPolicyWithInvalidPeriodInterval()
     throws MalformedURLException,
@@ -887,4 +989,8 @@ private IndividualResource createFixedDueDateSchedule(String name,
 
     return new IndividualResource(response);
   }
+
+  private JsonObject getErrorFromResponse(JsonResponse response) {
+    return response.getJson().getJsonArray("errors").getJsonObject(0);
+  }
 }