Merge pull request #1031 from rishy/Batch-API

added client activation, loan approval and loan disbursal commands

mifosng-provider/src/integrationTest/java/org/mifosplatform/integrationtests/BatchApiTest.java

@@ -346,7 +346,65 @@ public class BatchApiTest {
         final List<BatchResponse> response = BatchHelper.postBatchRequestsWithoutEnclosingTransaction(this.requestSpec, this.responseSpec,
                 jsonifiedRequest);
 
-        Assert.assertEquals("Verify Status Code 200 for Create Charge", 200L, (long) response.get(0).getStatusCode());
+        Assert.assertEquals("Verify Status Code 200 for Create Client", 200L, (long) response.get(0).getStatusCode());
-        Assert.assertEquals("Verify Status Code 200 for Collect Charges", 200L, (long) response.get(1).getStatusCode());
+        Assert.assertEquals("Verify Status Code 200 for Activate Client", 200L, (long) response.get(1).getStatusCode());
+    }
+
+    /**
+     * Test for the successful approval and disbursal of a loan using
+     * 'ApproveLoanCommandStrategy' and 'DisburseLoanCommandStrategy'. A '200'
+     * status code is expected on successful activation.
+     * 
+     * @see org.mifosplatform.batch.command.internal.ApproveLoanCommandStrategy
+     * @see org.mifosplatform.batch.command.internal.DisburseLoanCommandStrategy
+     */
+    @Test
+    public void shouldReturnOkStatusOnSuccessfulLoanApprovalAndDisburse() {
+        final String loanProductJSON = new LoanProductTestBuilder() //
+                .withPrincipal("10000000.00") //
+                .withNumberOfRepayments("24") //
+                .withRepaymentAfterEvery("1") //
+                .withRepaymentTypeAsMonth() //
+                .withinterestRatePerPeriod("2") //
+                .withInterestRateFrequencyTypeAsMonths() //
+                .withAmortizationTypeAsEqualPrincipalPayment() //
+                .withInterestTypeAsDecliningBalance() //
+                .currencyDetails("0", "100").build(null);
+
+        final Integer productId = new LoanTransactionHelper(this.requestSpec, this.responseSpec).getLoanProductId(loanProductJSON);
+
+        // Create a createClient Request
+        final BatchRequest br1 = BatchHelper.createClientRequest(4730L, "");
+
+        // Create a activateClient Request
+        final BatchRequest br2 = BatchHelper.activateClientRequest(4731L, 4730L);
+
+        // Create a ApplyLoan Request
+        final BatchRequest br3 = BatchHelper.applyLoanRequest(4732L, 4731L, productId);
+
+        // Create a approveLoan Request
+        final BatchRequest br4 = BatchHelper.approveLoanRequest(4733L, 4732L);
+
+        // Create a disburseLoan Request
+        final BatchRequest br5 = BatchHelper.disburseLoanRequest(4734L, 4733L);
+
+        final List<BatchRequest> batchRequests = new ArrayList<>();
+
+        batchRequests.add(br1);
+        batchRequests.add(br2);
+        batchRequests.add(br3);
+        batchRequests.add(br4);
+        batchRequests.add(br5);
+
+        final String jsonifiedRequest = BatchHelper.toJsonString(batchRequests);
+
+        final List<BatchResponse> response = BatchHelper.postBatchRequestsWithoutEnclosingTransaction(this.requestSpec, this.responseSpec,
+                jsonifiedRequest);
+
+        System.out.println(response.get(3));
+        System.out.println(response.get(4));
+
+        Assert.assertEquals("Verify Status Code 200 for Approve Loan", 200L, (long) response.get(3).getStatusCode());
+        Assert.assertEquals("Verify Status Code 200 for Disburse Loan", 200L, (long) response.get(4).getStatusCode());
     }
 }

mifosng-provider/src/integrationTest/java/org/mifosplatform/integrationtests/common/BatchHelper.java

@@ -280,11 +280,56 @@ public class BatchHelper {
         br.setRelativeUrl("clients/$.clientId?command=activate");
         br.setReference(reference);
         br.setMethod("POST");
-        br.setBody("{ \"locale\": \"en\", \"dateFormat\": \"dd MMMM yyyy\", \"activationDate\": \"01 March 2011\"}");
+        br.setBody("{\"locale\": \"en\", \"dateFormat\": \"dd MMMM yyyy\", \"activationDate\": \"01 March 2011\"}");
+
+        return br;
+    }
+    
+    /**
+     * Creates and returns a
+     * {@link org.mifosplatform.batch.command.internal.ApproveLoanCommandStrategy}
+     * Request with given requestId and reference.
+     * 
+     * 
+     * @param requestId
+     * @param reference
+     * @return BatchRequest
+     */
+    public static BatchRequest approveLoanRequest(final Long requestId, final Long reference) {
+        final BatchRequest br = new BatchRequest();
+
+        br.setRequestId(requestId);
+        br.setRelativeUrl("loans/$.loanId?command=approve");
+        br.setReference(reference);
+        br.setMethod("POST");
+        br.setBody("{\"locale\": \"en\", \"dateFormat\": \"dd MMMM yyyy\", \"approvedOnDate\": \"12 September 2013\"," 
+                + "\"note\": \"Loan approval note\"}");
 
         return br;
     }
 
+    /**
+     * Creates and returns a
+     * {@link org.mifosplatform.batch.command.internal.DisburseLoanCommandStrategy}
+     * Request with given requestId and reference.
+     * 
+     * 
+     * @param requestId
+     * @param reference
+     * @return BatchRequest
+     */
+    public static BatchRequest disburseLoanRequest(final Long requestId, final Long reference) {
+        final BatchRequest br = new BatchRequest();
+
+        br.setRequestId(requestId);
+        br.setRelativeUrl("loans/$.loanId?command=disburse");
+        br.setReference(reference);
+        br.setMethod("POST");
+        br.setBody("{\"locale\": \"en\", \"dateFormat\": \"dd MMMM yyyy\", \"actualDisbursementDate\": \"15 September 2013\"}");
+
+        return br;
+    }
+    
     /**
      * Checks that the client with given externalId is not created on the
      * server.

mifosng-provider/src/main/java/org/mifosplatform/batch/command/CommandStrategyProvider.java

@@ -76,6 +76,10 @@ public class CommandStrategyProvider {
                 .put(CommandContext.resource("loans\\/\\d+\\/charges").method("GET").build(), "collectChargesCommandStrategy");
         this.commandStrategies.put(CommandContext.resource("clients\\/\\d+\\?command=activate").method("POST").build(),
                 "activateClientCommandStrategy");
+        this.commandStrategies.put(CommandContext.resource("loans\\/\\d+\\?command=approve").method("POST").build(),
+                "approveLoanCommandStrategy");
+        this.commandStrategies.put(CommandContext.resource("loans\\/\\d+\\?command=disburse").method("POST").build(),
+                "disburseLoanCommandStrategy");
     }
 
 }

mifosng-provider/src/main/java/org/mifosplatform/batch/command/internal/ActivateClientCommandStrategy.java

@@ -51,8 +51,7 @@ public class ActivateClientCommandStrategy implements CommandStrategy {
         // Try-catch blocks to map exceptions to appropriate status codes
         try {
 
-            // Calls 'activate' function from 'ClientsApiResource' to create a new
+            // Calls 'activate' function from 'ClientsApiResource' to activate a client
-            // client
             responseBody = clientsApiResource.activate(clientId, "activate", request.getBody());
 
             response.setStatusCode(200);

mifosng-provider/src/main/java/org/mifosplatform/batch/command/internal/ApproveLoanCommandStrategy.java

@@ -0,0 +1,74 @@
+package org.mifosplatform.batch.command.internal;
+
+import javax.ws.rs.core.UriInfo;
+
+import org.mifosplatform.batch.command.CommandStrategy;
+import org.mifosplatform.batch.domain.BatchRequest;
+import org.mifosplatform.batch.domain.BatchResponse;
+import org.mifosplatform.batch.exception.ErrorHandler;
+import org.mifosplatform.batch.exception.ErrorInfo;
+import org.mifosplatform.portfolio.loanaccount.api.LoansApiResource;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link org.mifosplatform.batch.command.CommandStrategy} to handle
+ * approval of a pending loan. It passes the contents of the body from the
+ * BatchRequest to
+ * {@link org.mifosplatform.portfolio.client.api.LoansApiResource} and gets
+ * back the response. This class will also catch any errors raised by
+ * {@link org.mifosplatform.portfolio.client.api.LoansApiResource} and map
+ * those errors to appropriate status codes in BatchResponse.
+ * 
+ * @author Rishabh Shukla
+ * 
+ * @see org.mifosplatform.batch.command.CommandStrategy
+ * @see org.mifosplatform.batch.domain.BatchRequest
+ * @see org.mifosplatform.batch.domain.BatchResponse
+ */
+@Component
+public class ApproveLoanCommandStrategy implements CommandStrategy {
+
+    private final LoansApiResource loansApiResource;
+
+    @Autowired
+    public ApproveLoanCommandStrategy(final LoansApiResource loansApiResource) {
+        this.loansApiResource = loansApiResource;
+    }
+
+    @Override
+    public BatchResponse execute(final BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+        
+        final String[] pathParameters = request.getRelativeUrl().split("/");
+        Long loanId = Long.parseLong(pathParameters[1].substring(0, pathParameters[1].indexOf("?")));
+
+        // Try-catch blocks to map exceptions to appropriate status codes
+        try {
+
+            // Calls 'approve' function from 'LoansApiResource' to approve a loan          
+            responseBody = loansApiResource.stateTransitions(loanId, "approve", request.getBody());
+
+            response.setStatusCode(200);
+            // Sets the body of the response after the successful approval of a loan
+            response.setBody(responseBody);
+
+        } catch (RuntimeException e) {
+
+            // Gets an object of type ErrorInfo, containing information about
+            // raised exception
+            ErrorInfo ex = ErrorHandler.handler(e);
+
+            response.setStatusCode(ex.getStatusCode());
+            response.setBody(ex.getMessage());
+        }
+
+        return response;
+    }
+
+}

mifosng-provider/src/main/java/org/mifosplatform/batch/command/internal/DisburseLoanCommandStrategy.java

@@ -0,0 +1,75 @@
+package org.mifosplatform.batch.command.internal;
+
+import javax.ws.rs.core.UriInfo;
+
+import org.mifosplatform.batch.command.CommandStrategy;
+import org.mifosplatform.batch.domain.BatchRequest;
+import org.mifosplatform.batch.domain.BatchResponse;
+import org.mifosplatform.batch.exception.ErrorHandler;
+import org.mifosplatform.batch.exception.ErrorInfo;
+import org.mifosplatform.portfolio.loanaccount.api.LoansApiResource;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+/**
+ * Implements {@link org.mifosplatform.batch.command.CommandStrategy} to handle
+ * disburse of a loan. It passes the contents of the body from the
+ * BatchRequest to
+ * {@link org.mifosplatform.portfolio.client.api.LoansApiResource} and gets
+ * back the response. This class will also catch any errors raised by
+ * {@link org.mifosplatform.portfolio.client.api.LoansApiResource} and map
+ * those errors to appropriate status codes in BatchResponse.
+ * 
+ * @author Rishabh Shukla
+ * 
+ * @see org.mifosplatform.batch.command.CommandStrategy
+ * @see org.mifosplatform.batch.domain.BatchRequest
+ * @see org.mifosplatform.batch.domain.BatchResponse
+ */
+@Component
+public class DisburseLoanCommandStrategy implements CommandStrategy {
+
+    private final LoansApiResource loansApiResource;
+
+    @Autowired
+    public DisburseLoanCommandStrategy(final LoansApiResource loansApiResource) {
+        this.loansApiResource = loansApiResource;
+    }
+
+    @Override
+    public BatchResponse execute(final BatchRequest request, @SuppressWarnings("unused") UriInfo uriInfo) {
+
+        final BatchResponse response = new BatchResponse();
+        final String responseBody;
+
+        response.setRequestId(request.getRequestId());
+        response.setHeaders(request.getHeaders());
+        
+        final String[] pathParameters = request.getRelativeUrl().split("/");
+        Long loanId = Long.parseLong(pathParameters[1].substring(0, pathParameters[1].indexOf("?")));
+
+        // Try-catch blocks to map exceptions to appropriate status codes
+        try {
+
+            // Calls 'disburse' function from 'LoansApiResource' to disburse a loan          
+            responseBody = loansApiResource.stateTransitions(loanId, "disburse", request.getBody());
+
+            response.setStatusCode(200);
+            
+            // Sets the body of the response after the successful disbursal of the loan
+            response.setBody(responseBody);
+
+        } catch (RuntimeException e) {
+
+            // Gets an object of type ErrorInfo, containing information about
+            // raised exception
+            ErrorInfo ex = ErrorHandler.handler(e);
+
+            response.setStatusCode(ex.getStatusCode());
+            response.setBody(ex.getMessage());
+        }
+
+        return response;
+    }
+
+}