public/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2025-12-13 01:36:18 +00:00
Code Issues Releases Wiki Activity

#243: webhook CRUD

Browse Source
This commit is contained in:
Benjamin Gamard
2018-10-16 19:04:04 +02:00
parent b5f0612e78
commit dfdd5f8d20
14 changed files with 547 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs-web/src/dev/resources/config.properties
View File

@@ -1,3 +1,3 @@
api.current_version=${project.version}
api.min_version=1.0
db.version=19
db.version=20

4
docs-web/src/main/java/com/sismics/docs/rest/resource/BaseResource.java
View File

@@ -67,7 +67,7 @@ public abstract class BaseResource {
*/
protected boolean authenticate() {
Principal principal = (Principal) request.getAttribute(SecurityFilter.PRINCIPAL_ATTRIBUTE);
if (principal != null && principal instanceof IPrincipal) {
if (principal instanceof IPrincipal) {
this.principal = (IPrincipal) principal;
return !this.principal.isAnonymous();
} else {
@@ -93,7 +93,7 @@ public abstract class BaseResource {
* @return True if the user has the base function
*/
boolean hasBaseFunction(BaseFunction baseFunction) {
if (principal == null || !(principal instanceof UserPrincipal)) {
if (!(principal instanceof UserPrincipal)) {
return false;
}
Set<String> baseFunctionSet = ((UserPrincipal) principal).getBaseFunctionSet();

144
docs-web/src/main/java/com/sismics/docs/rest/resource/WebhookResource.java Normal file
View File

@@ -0,0 +1,144 @@
package com.sismics.docs.rest.resource;
import com.sismics.docs.core.constant.WebhookEvent;
import com.sismics.docs.core.dao.WebhookDao;
import com.sismics.docs.core.dao.criteria.WebhookCriteria;
import com.sismics.docs.core.dao.dto.WebhookDto;
import com.sismics.docs.core.model.jpa.Webhook;
import com.sismics.docs.core.util.jpa.SortCriteria;
import com.sismics.docs.rest.constant.BaseFunction;
import com.sismics.rest.exception.ForbiddenClientException;
import com.sismics.rest.util.ValidationUtil;
import javax.json.Json;
import javax.json.JsonArrayBuilder;
import javax.json.JsonObjectBuilder;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import java.util.List;
/**
* Webhook REST resources.
*
* @author bgamard
*/
@Path("/webhook")
public class WebhookResource extends BaseResource {
/**
* Returns the list of all webhooks.
*
* @api {get} /webhook Get webhooks
* @apiName GetWebhook
* @apiWebhook Webhook
* @apiSuccess {Object[]} webhooks List of webhooks
* @apiSuccess {String} webhooks.id ID
* @apiSuccess {String} webhooks.event Event
* @apiSuccess {String} webhooks.url URL
* @apiError (client) ForbiddenError Access denied
* @apiPermission admin
* @apiVersion 1.6.0
*
* @return Response
*/
@GET
public Response list(@QueryParam("document") String documentId) {
if (!authenticate()) {
throw new ForbiddenClientException();
}
checkBaseFunction(BaseFunction.ADMIN);
WebhookDao webhookDao = new WebhookDao();
JsonArrayBuilder webhooks = Json.createArrayBuilder();
List<WebhookDto> webhookDtoList = webhookDao.findByCriteria(new WebhookCriteria(), new SortCriteria(2, true));
for (WebhookDto webhookDto : webhookDtoList) {
webhooks.add(Json.createObjectBuilder()
.add("id", webhookDto.getId())
.add("event", webhookDto.getEvent())
.add("url", webhookDto.getUrl())
.add("create_date", webhookDto.getCreateTimestamp()));
}
JsonObjectBuilder response = Json.createObjectBuilder()
.add("webhooks", webhooks);
return Response.ok().entity(response.build()).build();
}
/**
* Add a webhook.
*
* @api {put} /webhook Add a webhook
* @apiName PutWebhook
* @apiWebhook Webhook
* @apiParam {String="DOCUMENT_CREATED","DOCUMENT_UPDATED","DOCUMENT_DELETED","FILE_CREATED","FILE_UPDATED","FILE_DELETED"} event Event
* @apiParam {String} url URL
* @apiSuccess {String} status Status OK
* @apiError (client) ForbiddenError Access denied
* @apiError (client) ValidationError Validation error
* @apiPermission admin
* @apiVersion 1.6.0
*
* @return Response
*/
@PUT
public Response add(@FormParam("event") String eventStr,
@FormParam("url") String url) {
if (!authenticate()) {
throw new ForbiddenClientException();
}
checkBaseFunction(BaseFunction.ADMIN);
// Validate input
WebhookEvent event = WebhookEvent.valueOf(ValidationUtil.validateLength(eventStr, "event", 1, 50, false));
url = ValidationUtil.validateLength(url, "url", 1, 1024, false);
// Create the webhook
WebhookDao webhookDao = new WebhookDao();
webhookDao.create(new Webhook()
.setUrl(url)
.setEvent(event));
// Always return OK
JsonObjectBuilder response = Json.createObjectBuilder()
.add("status", "ok");
return Response.ok().entity(response.build()).build();
}
/**
* Delete a webhook.
*
* @api {delete} /webhook/:id Delete a webhook
* @apiName DeleteWebhook
* @apiWebhook Webhook
* @apiParam {String} id Webhook ID
* @apiSuccess {String} status Status OK
* @apiError (client) ForbiddenError Access denied
* @apiError (client) NotFound Webhook not found
* @apiPermission admin
* @apiVersion 1.6.0
*
* @return Response
*/
@DELETE
@Path("{id: [a-z0-9\\-]+}")
public Response delete(@PathParam("id") String id) {
if (!authenticate()) {
throw new ForbiddenClientException();
}
checkBaseFunction(BaseFunction.ADMIN);
// Get the webhook
WebhookDao webhookDao = new WebhookDao();
Webhook webhook = webhookDao.getActiveById(id);
if (webhook == null) {
throw new NotFoundException();
}
// Delete the webhook
webhookDao.delete(webhook.getId());
// Always return OK
JsonObjectBuilder response = Json.createObjectBuilder()
.add("status", "ok");
return Response.ok().entity(response.build()).build();
}
}

2
docs-web/src/prod/resources/config.properties
View File

@@ -1,3 +1,3 @@
api.current_version=${project.version}
api.min_version=1.0
db.version=19
db.version=20

2
docs-web/src/stress/resources/config.properties
View File

@@ -1,3 +1,3 @@
api.current_version=${project.version}
api.min_version=1.0
db.version=19
db.version=20

68
docs-web/src/test/java/com/sismics/docs/rest/TestWebhookResource.java Normal file
View File

@@ -0,0 +1,68 @@
package com.sismics.docs.rest;
import com.sismics.util.filter.TokenBasedSecurityFilter;
import org.junit.Assert;
import org.junit.Test;
import javax.json.JsonArray;
import javax.json.JsonObject;
import javax.ws.rs.client.Entity;
import javax.ws.rs.core.Form;
/**
* Test the webhook resource.
*
* @author bgamard
*/
public class TestWebhookResource extends BaseJerseyTest {
/**
* Test the webhook resource.
*/
@Test
public void testWebhookResource() {
// Login admin
String adminToken = clientUtil.login("admin", "admin", false);
// Get all webhooks
JsonObject json = target().path("/webhook")
.request()
.cookie(TokenBasedSecurityFilter.COOKIE_NAME, adminToken)
.get(JsonObject.class);
JsonArray webhooks = json.getJsonArray("webhooks");
Assert.assertEquals(0, webhooks.size());
// Create a webhook
target().path("/webhook").request()
.cookie(TokenBasedSecurityFilter.COOKIE_NAME, adminToken)
.put(Entity.form(new Form()
.param("event", "DOCUMENT_CREATED")
.param("url", "https://www.sismics.com")), JsonObject.class);
// Get all webhooks
json = target().path("/webhook")
.request()
.cookie(TokenBasedSecurityFilter.COOKIE_NAME, adminToken)
.get(JsonObject.class);
webhooks = json.getJsonArray("webhooks");
Assert.assertEquals(1, webhooks.size());
JsonObject webhook = webhooks.getJsonObject(0);
String webhookId = webhook.getString("id");
Assert.assertEquals("DOCUMENT_CREATED", webhook.getString("event"));
Assert.assertEquals("https://www.sismics.com", webhook.getString("url"));
Assert.assertNotNull(webhook.getJsonNumber("create_date"));
// Delete a webhook
target().path("/webhook/" + webhookId).request()
.cookie(TokenBasedSecurityFilter.COOKIE_NAME, adminToken)
.delete(JsonObject.class);
// Get all webhooks
json = target().path("/webhook")
.request()
.cookie(TokenBasedSecurityFilter.COOKIE_NAME, adminToken)
.get(JsonObject.class);
webhooks = json.getJsonArray("webhooks");
Assert.assertEquals(0, webhooks.size());
}
}