Merge pull request #28 from polyapi/develop

Delete function feature (#27)

Author: gastonortiz

.github/workflows/maven-publish.yml

@@ -27,4 +27,4 @@ jobs:
       with:
         servers: '[{"id": "ossrh", "username": "${{ secrets.DISTRIBUTION_REPOSITORY_RELEASE_USERNAME }}", "password": "${{ secrets.DISTRIBUTION_REPOSITORY_RELEASE_PASSWORD }}"}]'
     - name: Release to production
-      run: mvn clean release:clean release:prepare release:perform -B -DaltDeploymentRepository=ossrh::https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/
+      run: mvn clean release:clean release:prepare release:perform -B -DaltDeploymentRepository=ossrh::https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/

README.md

@@ -1,7 +1,7 @@
 # Java Client Library (beta)
 
-* Latest released version 0.9.3
-* Latest snapshot version 0.10.0-SNAPSHOT
+* Latest released version 0.10.1
+* Latest snapshot version 0.11.0-SNAPSHOT
 
 ## Introduction
 Welcome my friends! This is the Poly API Java client GitHub page. If you are here, then it means you're familiar with what we do at Poly. If you aren't, you can always check [here](https://github.com/polyapi/poly-alpha).
@@ -55,7 +55,7 @@ Nice to have some customers looking around here! So, you'll need to run the foll
 2. **Update the project.** Add the following to your project's `pom.xml`:
 ```xml
 <properties>
-  <poly.version>0.9.3</poly.version>
+  <poly.version>0.10.1</poly.version>
 </properties>
 <dependencies>
   <dependency>
@@ -227,6 +227,22 @@ Here's the list of parameters:
 - **functions:** Comma separated value containing the names of the functions to deploy. The functions must be annotated with the `@PolyFunction` annotation as it is described. This parameter triggers a filter by function name and/or context + function name in the `[context].[functionName]` format. Each comma separated value will be taken independently and deployed.
 - **dry-run:** Flag that when added makes the MOJO prepare everything for a deployment but not do it. This is for debugging purposes.
 
+#### delete-function
+This MOJO doesn't require a project to run.
+
+It deletes a server/client/api/auth function, webhook or variable from the Poly server. It can take 2 types of inputs:
+ - **id**: Deletes the entity with the matching ID.
+ - **contxt/function name**: Deletes the entity that matches the context and function name. It's case insensitive, but will fall back to be case sensitive in case that there are 2 or more matches with different cases. If none of those cases match exactly, it will throw an error. 
+
+##### Parameters
+Here's the list of parameters:
+- **host (required):** The host where the Poly API instance is hosted.
+- **port:** The port that the Poly API instance is listening to. Default value is 443.
+- **apiKey (required):** The API key required to authenticate to Poly.
+- **id:** ID of the entity to delete. Cannot coexist with either `functionName` nor `context` arguments.
+- **functionName:** Name of the function to delete. Cannot coexist with `id` argument. Mandatory unless `id` is set.
+- **context:** Context of the function to delete. Cannot coexist with `id` argument. Mandatory unless `id` is set.
+
 <a name="project-usage"></a>
 ## Usage
 

commons/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.polyapi</groupId>
         <artifactId>parent-pom</artifactId>
-        <version>0.10.2-SNAPSHOT</version>
+        <version>0.11.0-SNAPSHOT</version>
         <relativePath>../parent-pom</relativePath>
     </parent>
 

commons/src/main/java/io/polyapi/commons/api/service/PolyApiService.java

@@ -60,6 +60,15 @@ public <I> void patch(String relativePath, Map<String, List<String>> headers, Ma
     parsedCall(PATCH, relativePath, headers, queryParams, body, Void.TYPE);
   }
 
+  public void delete(String relativePath) {
+    delete(relativePath, new HashMap<>(), new HashMap<>(), null);
+  }
+
+
+  public <I> void delete(String relativePath, Map<String, List<String>> headers, Map<String, List<String>> queryParams, I body) {
+    parsedCall(DELETE, relativePath, headers, queryParams, body, Void.TYPE);
+  }
+
   private <I, O> O parsedCall(HttpMethod method, String relativePath, Map<String, List<String>> headers, Map<String, List<String>> queryParams, I body, Type expectedResponseType) {
     Map<String, List<String>> allHeaders = new HashMap<>();
     allHeaders.put("Accept", List.of("application/json"));

library/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.polyapi</groupId>
         <artifactId>parent-pom</artifactId>
-        <version>0.10.2-SNAPSHOT</version>
+        <version>0.11.0-SNAPSHOT</version>
         <relativePath>../parent-pom</relativePath>
     </parent>
     <artifactId>library</artifactId>

parent-pom/pom.xml

@@ -3,7 +3,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>io.polyapi</groupId>
     <artifactId>parent-pom</artifactId>
-    <version>0.10.2-SNAPSHOT</version>
+    <version>0.11.0-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>Poly API Java parent POM</name>
     <url>https://polyapi.io</url>

polyapi-maven-plugin/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>io.polyapi</groupId>
         <artifactId>parent-pom</artifactId>
-        <version>0.10.2-SNAPSHOT</version>
+        <version>0.11.0-SNAPSHOT</version>
         <relativePath>../parent-pom</relativePath>
     </parent>
     <artifactId>polyapi-maven-plugin</artifactId>

polyapi-maven-plugin/src/main/java/io/polyapi/plugin/error/function/UnclearFunctionReferenceException.java

@@ -0,0 +1,15 @@
+package io.polyapi.plugin.error.function;
+
+import io.polyapi.plugin.error.PolyApiMavenPluginException;
+
+import java.util.List;
+
+import static java.lang.String.format;
+import static java.lang.String.join;
+
+public class UnclearFunctionReferenceException extends PolyApiMavenPluginException {
+
+    public UnclearFunctionReferenceException(String expectedReference, List<String> retrievedReferences) {
+        super(format("Unclear function reference. Expected '%s', but found '%s'. Please retry with a specific case sensitive one.", expectedReference, join(", ", retrievedReferences)));
+    }
+}

polyapi-maven-plugin/src/main/java/io/polyapi/plugin/error/validation/BadExclusionException.java

@@ -0,0 +1,9 @@
+package io.polyapi.plugin.error.validation;
+
+import static java.lang.String.format;
+
+public class BadExclusionException extends ValidationException {
+    public BadExclusionException(String propertyName, String excludedPropertyName) {
+        super(propertyName, format("Property '%s' cannot be set at the same time as property '%s'.", "%s", excludedPropertyName));
+    }
+}

polyapi-maven-plugin/src/main/java/io/polyapi/plugin/error/validation/InvalidUUIDException.java

@@ -0,0 +1,9 @@
+package io.polyapi.plugin.error.validation;
+
+import static java.lang.String.format;
+
+public class InvalidUUIDException extends ValidationException {
+    public InvalidUUIDException(String propertyName, String propertyValue, Throwable cause) {
+        super(propertyName, format("Property '%s' with value '%s' doesn't match UUID format.", propertyName, propertyValue), cause);
+    }
+}