Skip to content

Commit

Permalink
Merge pull request apache#484 from ShruthiRajaram/FINERACT-628_Surveys
Browse files Browse the repository at this point in the history
FINERACT-628 Self service APIs for Surveys
  • Loading branch information
ShruthiRajaram authored Nov 26, 2018
2 parents 26302b5 + be49522 commit cb83166
Show file tree
Hide file tree
Showing 3 changed files with 305 additions and 10 deletions.
160 changes: 150 additions & 10 deletions api-docs/apiLive.htm
Original file line number Diff line number Diff line change
Expand Up @@ -3617,6 +3617,14 @@ <h2 class="flybar-button">Self Service</h2>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>self/clients/{clientId}/images</td>
<td></td>
<td></td>
<td></td>
<td><a href="#self_client_image_delete">Delete client image</a></td>
</tr>
<tr>
<td><a href="#self_loanproducts">Loan Product</a></td>
<td>self/loanproducts?clientId={clientId}</td>
Expand Down Expand Up @@ -3651,14 +3659,6 @@ <h2 class="flybar-button">Self Service</h2>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>self/clients/{clientId}/images</td>
<td></td>
<td></td>
<td></td>
<td><a href="#self_client_image_delete">Delete client image</a></td>
</tr>
<tr>
<td><a href="#self_shareproducts_list">Share Product</a></td>
<td>self/shareproducts?clientId={clientId}</td>
Expand Down Expand Up @@ -3875,6 +3875,30 @@ <h2 class="flybar-button">Self Service</h2>
<td></td>
<td></td>
</tr>
<tr>
<td><a href="#active_surveys">Surveys</a></td>
<td>self/surveys?isActive=true</td>
<td></td>
<td><a href="#active_surveys">Retrieve Active Surveys</a></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>self/surveys/scorecards/{surveyId}</td>
<td><a href="#submit_survey">Take Survey</a></td>
<td></td>
<td></td>
<td></td>
</tr>
<tr>
<td></td>
<td>self/surveys/scorecards/clients/{clientId}</td>
<td></td>
<td><a href="#survey_score">Survey Scorecards</a></td>
<td></td>
<td></td>
</tr>
</table>
</div>
</div>
Expand Down Expand Up @@ -49700,8 +49724,7 @@ <h4>List Loan Products</h4>
]
</code>
</div>
</div>

</div>

<a id="self_loanproducts_retrieve" name="self_loanproducts_retrieve"
class="old-syle-anchor">&nbsp;</a>
Expand Down Expand Up @@ -50414,6 +50437,123 @@ <h4>Retrieve a Share Product</h4>
</code>
</div>
</div>

<a id="active_surveys" name="active_surveys" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h2>Retrieve Active Surveys</h2>

<p>Example Requests : </p>
<div class=apiClick>self/surveys?isActive=true</div>
</div>
<div class="method-example">
<code class="method-declaration">GET https://domainname/api/v1/self/surveys?isActive=true</code>
<code class="method-response">
[
{
"id":1,
"componentDatas":[

],
"questionDatas":[
{
"id":1,
"responseDatas":[
{
"id":2,
"text":"Own",
"value":1,
"sequenceNo":1
},
{
"id":1,
"text":"Rent",
"value":0,
"sequenceNo":2
}
],
"componentKey":Test,
"key":"t1",
"text":"Type of house",
"description":Test,
"sequenceNo":1
}
],
"key":"test",
"name":"test",
"description":"test",
"countryCode":"in",
"validFrom":1540233000000,
"validTo":4695906600000
}
]
</code>
</div>
</div>

<a id="submit_survey" name="submit_survey" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h2>Submit Survey</h2>

<p>Example Requests : </p>
<div class=apiClick>self/surveys/scorecards/1</div>
</div>
<div class="method-example">
<code class="method-declaration">POST https://domainname/api/v1/self/surveys/scorecards/{surveyId}</code>
<code class="method-request">
{
"userId":3,
"clientId":"1",
"surveyId":1,
"scorecardValues":[
{
"questionId":1,
"responseId":2,
"value":1,
"createdOn":1540291482379
}
],
"surveyName":"",
"username":"",
"id":0
}
</code>
</div>
</div>

<a id="survey_score" name="survey_score" class="old-syle-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h2>Retrieve Survey records</h2>

<p>Example Requests : </p>
<div class=apiClick>self/surveys/scorecards/clients/1</div>
</div>
<div class="method-example">
<code class="method-declaration">GET https://domainname/api/v1/self/surveys/scorecards/clients/{clientId}</code>
<code class="method-response">
[
{
"id":8,
"userId":,
"username":"mifos",
"clientId":3,
"surveyId":1,
"surveyName":"test",
"scorecardValues":[
{
"questionId":1,
"responseId":2,
"value":1,
"createdOn":1540233000000
}
]
}
] </code>
</div>
</div>

<!-- end of Customer Self Service APIs-->
</div>
<!-- main-content-wrapper -->
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.apache.fineract.portfolio.self.spm.api;

import java.util.List;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.portfolio.client.exception.ClientNotFoundException;
import org.apache.fineract.portfolio.self.client.service.AppuserClientMapperReadService;
import org.apache.fineract.spm.api.ScorecardApiResource;
import org.apache.fineract.spm.data.ScorecardData;
import org.apache.fineract.useradministration.domain.AppUser;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;

@Path("/self/surveys/scorecards")
@Component
@Scope("singleton")
public class SelfScorecardApiResource {

private final PlatformSecurityContext context;
private final ScorecardApiResource scorecardApiResource;
private final AppuserClientMapperReadService appuserClientMapperReadService;

@Autowired
public SelfScorecardApiResource(final PlatformSecurityContext securityContext,
final AppuserClientMapperReadService appuserClientMapperReadService,
final ScorecardApiResource scorecardApiResource) {
this.context = securityContext;
this.scorecardApiResource = scorecardApiResource;
this.appuserClientMapperReadService = appuserClientMapperReadService;
}

@GET
@Path("clients/{clientId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
@Transactional
public List<ScorecardData> findByClient(@PathParam("clientId") final Long clientId) {

validateAppuserClientsMapping(clientId);
return this.scorecardApiResource.findByClient(clientId);
}

@POST
@Path("{surveyId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
@Transactional
public void createScorecard(@PathParam("surveyId") final Long surveyId, final ScorecardData scorecardData) {
if (scorecardData.getClientId() != null) {
validateAppuserClientsMapping(scorecardData.getClientId());
this.scorecardApiResource.createScorecard(surveyId, scorecardData);
}

}

private void validateAppuserClientsMapping(final Long clientId) {
AppUser user = this.context.authenticatedUser();
final boolean mappedClientId = this.appuserClientMapperReadService.isClientMappedToUser(clientId, user.getId());
if (!mappedClientId) {
throw new ClientNotFoundException(clientId);
}
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/

package org.apache.fineract.portfolio.self.spm.api;

import java.util.List;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

import org.apache.fineract.infrastructure.security.service.PlatformSecurityContext;
import org.apache.fineract.spm.api.SpmApiResource;
import org.apache.fineract.spm.data.SurveyData;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;
import org.springframework.transaction.annotation.Transactional;

@Path("/self/surveys")
@Component
@Scope("singleton")
public class SelfSpmApiResource {

private final PlatformSecurityContext securityContext;
private final SpmApiResource spmApiResource;

@Autowired
public SelfSpmApiResource(final PlatformSecurityContext securityContext, final SpmApiResource spmApiResource) {
this.securityContext = securityContext;
this.spmApiResource = spmApiResource;
}

@GET
@Consumes({ MediaType.APPLICATION_JSON })
@Produces({ MediaType.APPLICATION_JSON })
@Transactional
public List<SurveyData> fetchAllSurveys() {
securityContext.authenticatedUser();
final Boolean isActive = true;
return this.spmApiResource.fetchAllSurveys(isActive);
}

}

0 comments on commit cb83166

Please sign in to comment.