feat: add webhooks

Author: null8626

README.md

@@ -188,4 +188,118 @@ final String widgetUrl = Widget.owner(Widget.Type.DISCORD_BOT, "5746527517457776
 
 ```java
 final String widgetUrl = Widget.social(Widget.Type.DISCORD_BOT, "574652751745777665");
+```
+
+### Webhooks
+
+#### Being notified whenever someone voted for your bot
+
+##### Spring Boot
+
+In your `TopggWebhookFilterConfig.java`:
+
+```java
+import org.discordbots.api.client.entity.Vote;
+import org.discordbots.api.client.webhooks.SpringBoot;
+
+import org.springframework.boot.web.servlet.FilterRegistrationBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class TopggWebhookFilterConfig {
+    @Bean
+    public FilterRegistrationBean<SpringBoot<Vote>> registerVoteWebhook() {
+        final FilterRegistrationBean<SpringBoot<Vote>> registrationBean = new FilterRegistrationBean<>();
+        
+        registrationBean.setFilter(new SpringBoot<>(Vote.class, System.getenv("MY_TOPGG_WEBHOOK_SECRET")) {
+            @Override
+            public void callback(final Vote vote) {
+                System.out.println("A user with the ID of " + vote.getVoterId() + " has voted us on Top.gg!");
+            }
+        });
+        
+        registrationBean.addUrlPatterns("/votes");
+        registrationBean.setOrder(1);
+
+        return registrationBean;
+    }
+}
+```
+
+##### Dropwizard
+
+In your `MyVoteListener.java`:
+
+```java
+import org.discordbots.api.client.entity.Vote;
+import org.discordbots.api.client.webhooks.Dropwizard;
+
+import jakarta.ws.rs.Path;
+
+@Path("/votes")
+public class MyVoteListener extends Dropwizard<Vote> {
+    public MyVoteListener() {
+        super(Vote.class, System.getenv("MY_TOPGG_WEBHOOK_SECRET"));
+    }
+
+    @Override
+    public void callback(final Vote vote) {
+        System.out.println("A user with the ID of " + vote.getVoterId() + " has voted us on Top.gg!");
+    }
+}
+```
+
+In your `MyServer.java`:
+
+```java
+import io.dropwizard.core.Application;
+import io.dropwizard.core.Configuration;
+import io.dropwizard.core.setup.Environment;
+import io.dropwizard.jersey.setup.JerseyEnvironment;
+
+public class MyServer extends Application<Configuration> {
+    public static void main(String[] args) throws Exception {
+        new MyServer().run(args);
+    }
+
+    @Override
+    public void run(Configuration config, Environment env) {
+        final JerseyEnvironment jersey = env.jersey();
+        
+        jersey.register(new MyVoteListener());
+    }
+}
+```
+
+##### Eclipse Jetty
+
+In your `MyServer.java`:
+
+```java
+import org.discordbots.api.client.entity.Vote;
+import org.discordbots.api.client.webhooks.EclipseJetty;
+
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.servlet.ServletContextHandler;
+import org.eclipse.jetty.servlet.ServletHolder;
+
+public class MyServer {
+    public static void main(String[] args) throws Exception {
+        final Server server = new Server(8080);
+        final ServletContextHandler handler = new ServletContextHandler();
+
+        handler.setContextPath("/");
+        handler.addServlet(new ServletHolder(new EclipseJetty<>(Vote.class, System.getenv("MY_TOPGG_WEBHOOK_SECRET")) {
+            @Override
+            public void callback(final Vote vote) {
+                System.out.println("A user with the ID of " + vote.getVoterId() + " has voted us on Top.gg!");
+            }
+        }), "/votes");
+
+        server.setHandler(handler);
+        server.start();
+        server.join();
+    }
+}
 ```

build.gradle

@@ -16,4 +16,7 @@ dependencies {
     implementation "com.squareup.okhttp3:okhttp:4.12.0"
     implementation "com.google.code.gson:gson:2.13.1"
     implementation "com.fatboyindustrial.gson-javatime-serialisers:gson-javatime-serialisers:1.1.2"
+    implementation "org.springframework.boot:spring-boot-starter-web:3.5.3"
+    implementation "jakarta.servlet:jakarta.servlet-api:6.1.0"
+    implementation "jakarta.ws.rs:jakarta.ws.rs-api:4.0.0"
 }

src/main/java/org/discordbots/api/client/entity/Vote.java

@@ -1,13 +1,22 @@
 package org.discordbots.api.client.entity;
 
+import java.net.URLDecoder;
+import java.nio.charset.StandardCharsets;
+import java.util.HashMap;
+import java.util.Map;
+
 import com.google.gson.annotations.SerializedName;
 
 public class Vote {
 
     @SerializedName("bot")
     private String botId;
+
+    @SerializedName("guild")
+    private String serverId;
+
     @SerializedName("user")
-    private String userId;
+    private String voterId;
 
     private String type;
 
@@ -16,22 +25,36 @@ public class Vote {
     @SerializedName("isWeekend")
     private boolean weekend;
 
-
-
-    public String getBotId() {
-        return botId;
+    public String getReceiverId() {
+        return botId == null ? serverId : botId;
     }
 
-    public String getUserId() {
-        return userId;
+    public String getVoterId() {
+        return voterId;
     }
 
-    public String getType() {
-        return type;
+    public boolean isTest() {
+        return type.equals("test");
     }
 
-    public String getQuery() {
-        return query;
+    public Map<String, String> getQuery() {
+        Map<String, String> map = new HashMap<>();
+
+        if (query != null) {
+            if (query.startsWith("?")) {
+                query = query.substring(1);
+            }
+
+            for (final String param : query.split("&")) {
+                final String[] pair = param.split("=", 2);
+                final String key = URLDecoder.decode(pair[0], StandardCharsets.UTF_8);
+                final String value = pair.length > 1 ? URLDecoder.decode(pair[1], StandardCharsets.UTF_8) : "";
+    
+                map.put(key, value);
+            }
+        }
+
+        return map;
     }
 
     public boolean isWeekend() {

src/main/java/org/discordbots/api/client/entity/VotingMultiplier.java

@@ -7,8 +7,6 @@ public class VotingMultiplier {
     @SerializedName("is_weekend")
     private boolean weekend;
 
-
-
     public boolean isWeekend() {
         return weekend;
     }

src/main/java/org/discordbots/api/client/impl/DiscordBotListAPIImpl.java

@@ -25,6 +25,7 @@
 import org.discordbots.api.client.io.EmptyResponseTransformer;
 import org.discordbots.api.client.io.ResponseTransformer;
 import org.discordbots.api.client.io.UnsuccessfulHttpException;
+import org.json.JSONException;
 import org.json.JSONObject;
 
 import com.fatboyindustrial.gsonjavatime.OffsetDateTimeConverter;
@@ -344,7 +345,7 @@ public void onResponse(Call call, Response response) {
                                 if (body != null) {
                                     message = (new JSONObject(body)).getString("error");
                                 }
-                            } catch (final Exception ignored) {}
+                            } catch (final JSONException ignored) {}
                         }
 
                         Exception e = new UnsuccessfulHttpException(response.code(), message);

src/main/java/org/discordbots/api/client/io/DefaultResponseTransformer.java

@@ -1,9 +1,11 @@
 package org.discordbots.api.client.io;
 
+import java.io.IOException;
+
 import com.google.gson.Gson;
-import okhttp3.Response;
 
-import java.io.IOException;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
 
 public class DefaultResponseTransformer<E> implements ResponseTransformer<E> {
 
@@ -17,8 +19,13 @@ public DefaultResponseTransformer(Class<E> aClass, Gson gson) {
 
     @Override
     public E transform(Response response) throws IOException {
-        String body = response.body().string();
-        return gson.fromJson(body, aClass);
+        try (ResponseBody responseBody = response.body()) {
+            if (responseBody != null) {
+                return gson.fromJson(responseBody.charStream(), aClass);
+            }
+        }
+
+        throw new IOException("Unable to parse JSON because of malformed response body.");
     }
 
 }

src/main/java/org/discordbots/api/client/webhooks/Dropwizard.java

@@ -0,0 +1,45 @@
+package org.discordbots.api.client.webhooks;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonIOException;
+import com.google.gson.JsonSyntaxException;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.core.Context;
+import jakarta.ws.rs.core.Response;
+
+public abstract class Dropwizard<T> {
+    private final Class<T> aClass;
+    private final String authorization;
+    private final Gson gson;
+
+    public Dropwizard(final Class<T> aClass, final String authorization) {
+        this.aClass = aClass;
+        this.authorization = authorization;
+        this.gson = new GsonBuilder().create();
+    }
+
+    @POST
+    public Response handle(@Context HttpServletRequest request) {
+        final String authorizationHeader = request.getHeader("Authorization");
+        
+        if (authorizationHeader == null || !authorizationHeader.equals(this.authorization)) {
+            return Response.status(Response.Status.UNAUTHORIZED).entity("Unauthorized").build();
+        }
+
+        try {
+            callback(gson.fromJson(new InputStreamReader(request.getInputStream()), aClass));
+
+            return Response.noContent().build();
+        } catch (final JsonSyntaxException | JsonIOException | IOException ignored) {}
+
+        return Response.status(Response.Status.BAD_REQUEST).entity("Bad request").build();
+    }
+
+    public abstract void callback(T data);
+}

src/main/java/org/discordbots/api/client/webhooks/EclipseJetty.java

@@ -0,0 +1,51 @@
+package org.discordbots.api.client.webhooks;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonIOException;
+import com.google.gson.JsonSyntaxException;
+
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+public abstract class EclipseJetty<T> extends HttpServlet {
+    private final Class<T> aClass;
+    private final String authorization;
+    private final Gson gson;
+
+    public EclipseJetty(final Class<T> aClass, final String authorization) {
+        this.aClass = aClass;
+        this.authorization = authorization;
+        this.gson = new GsonBuilder().create();
+    }
+
+    @Override
+    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws IOException {
+        final String authorizationHeader = request.getHeader("Authorization");
+        
+        if (authorizationHeader == null || !authorizationHeader.equals(this.authorization)) {
+            response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
+            response.getWriter().write("Unauthorized");
+
+            return;
+        }
+
+        try {
+            callback(gson.fromJson(new InputStreamReader(request.getInputStream()), aClass));
+
+            response.setStatus(HttpServletResponse.SC_NO_CONTENT);
+            response.getWriter().write("");
+            
+            return;
+        } catch (final JsonSyntaxException | JsonIOException | IOException ignored) {}
+
+        response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
+        response.getWriter().write("Bad request");
+    }
+
+    public abstract void callback(T data);
+}