refactor: Replace query params auth with Header

Vonage · Dec 2, 2024 · 39a2643 · 39a2643
1 parent b4cc357
commit 39a2643
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 19 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,7 +5,7 @@ updates:
   - package-ecosystem: 'maven'
     directory: '/'
     schedule:
-      interval: 'weekly'
+      interval: 'monthly'
     commit-message:
       prefix: 'build'
     ignore:

diff --git a/src/main/java/com/vonage/client/auth/ApiKeyHeaderAuthMethod.java b/src/main/java/com/vonage/client/auth/ApiKeyHeaderAuthMethod.java
@@ -41,7 +41,9 @@ public String getApiKey() {
      * Converts this to a {@linkplain QueryParamsAuthMethod}.
      *
      * @return A new {@linkplain ApiKeyQueryParamsAuthMethod} with this object's API key and secret.
+     * @deprecated This will be removed in a future release.
      */
+    @Deprecated
     public QueryParamsAuthMethod asQueryParams() {
         return new ApiKeyQueryParamsAuthMethod(apiKey, apiSecret);
     }

diff --git a/src/main/java/com/vonage/client/insight/InsightClient.java b/src/main/java/com/vonage/client/insight/InsightClient.java
@@ -16,7 +16,9 @@
 package com.vonage.client.insight;
 
 import com.vonage.client.*;
+import com.vonage.client.auth.ApiKeyHeaderAuthMethod;
 import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
+import com.vonage.client.auth.AuthMethod;
 import com.vonage.client.auth.SignatureAuthMethod;
 import com.vonage.client.common.HttpMethod;
 import java.util.function.Function;
@@ -38,10 +40,10 @@ public class InsightClient {
     public InsightClient(HttpWrapper wrapper) {
         @SuppressWarnings("unchecked")
         final class Endpoint<T, R> extends DynamicEndpoint<T, R> {
-            Endpoint(Function<T, String> pathGetter, R... type) {
+            Endpoint(Function<T, String> pathGetter, Class<? extends AuthMethod> auth, R... type) {
                 super(DynamicEndpoint.<T, R> builder(type)
                         .wrapper(wrapper).requestMethod(HttpMethod.POST)
-                        .authMethod(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class)
+                        .authMethod(SignatureAuthMethod.class, auth)
                         .pathGetter((de, req) -> {
                             String base = de.getHttpWrapper().getHttpConfig().getApiBaseUri();
                             return base + "/ni/" + pathGetter.apply(req) + "/json";
@@ -50,9 +52,9 @@ final class Endpoint<T, R> extends DynamicEndpoint<T, R> {
             }
         }
 
-        basic = new Endpoint<>(req -> "basic");
-        standard = new Endpoint<>(req -> "standard");
-        advanced = new Endpoint<>(req -> "advanced" + (req.isAsync() ? "/async" : ""));
+        basic = new Endpoint<>(req -> "basic", ApiKeyHeaderAuthMethod.class);
+        standard = new Endpoint<>(req -> "standard", ApiKeyQueryParamsAuthMethod.class);
+        advanced = new Endpoint<>(req -> "advanced" + (req.isAsync() ? "/async" : ""), ApiKeyQueryParamsAuthMethod.class);
     }
 
     /**

diff --git a/src/main/java/com/vonage/client/sms/SmsClient.java b/src/main/java/com/vonage/client/sms/SmsClient.java
@@ -16,6 +16,7 @@
 package com.vonage.client.sms;
 
 import com.vonage.client.*;
+import com.vonage.client.auth.ApiKeyHeaderAuthMethod;
 import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
 import com.vonage.client.auth.SignatureAuthMethod;
 import com.vonage.client.common.HttpMethod;
@@ -40,7 +41,7 @@ class Endpoint extends DynamicEndpoint<Message, SmsSubmissionResponse> {
             Endpoint() {
                 super(DynamicEndpoint.<Message, SmsSubmissionResponse> builder(SmsSubmissionResponse.class)
                         .wrapper(wrapper).requestMethod(HttpMethod.POST)
-                        .authMethod(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class)
+                        .authMethod(SignatureAuthMethod.class, ApiKeyHeaderAuthMethod.class)
                         .urlFormEncodedContentType(true).pathGetter((de, req) ->
                                 de.getHttpWrapper().getHttpConfig().getRestBaseUri() + "/sms/json"
                         )

diff --git a/src/main/java/com/vonage/client/verify/VerifyClient.java b/src/main/java/com/vonage/client/verify/VerifyClient.java
@@ -16,6 +16,7 @@
 package com.vonage.client.verify;
 
 import com.vonage.client.*;
+import com.vonage.client.auth.ApiKeyHeaderAuthMethod;
 import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
 import com.vonage.client.common.HttpMethod;
 import java.util.Locale;

diff --git a/src/test/java/com/vonage/client/insight/InsightClientTest.java b/src/test/java/com/vonage/client/insight/InsightClientTest.java
@@ -17,10 +17,16 @@
 
 import com.vonage.client.AbstractClientTest;
 import com.vonage.client.RestEndpoint;
+import com.vonage.client.auth.ApiKeyHeaderAuthMethod;
+import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
+import com.vonage.client.auth.AuthMethod;
+import com.vonage.client.auth.SignatureAuthMethod;
 import org.junit.jupiter.api.*;
 import static org.junit.jupiter.api.Assertions.*;
 import java.math.BigDecimal;
+import java.util.Collection;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 
 public class InsightClientTest extends AbstractClientTest<InsightClient> {
@@ -222,6 +228,11 @@ protected RestEndpoint<BasicInsightRequest, BasicInsightResponse> endpoint() {
                 return client.basic;
             }
 
+            @Override
+            protected Collection<Class<? extends AuthMethod>> expectedAuthMethods() {
+                return List.of(SignatureAuthMethod.class, ApiKeyHeaderAuthMethod.class);
+            }
+
             @Override
             protected String expectedEndpointUri(BasicInsightRequest request) {
                 return "/ni/basic/json";
@@ -254,6 +265,11 @@ protected RestEndpoint<StandardInsightRequest, StandardInsightResponse> endpoint
                 return client.standard;
             }
 
+            @Override
+            protected Collection<Class<? extends AuthMethod>> expectedAuthMethods() {
+                return List.of(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class);
+            }
+
             @Override
             protected String expectedEndpointUri(StandardInsightRequest request) {
                 return "/ni/standard/json";
@@ -288,6 +304,11 @@ protected RestEndpoint<AdvancedInsightRequest, AdvancedInsightResponse> endpoint
                 return client.advanced;
             }
 
+            @Override
+            protected Collection<Class<? extends AuthMethod>> expectedAuthMethods() {
+                return List.of(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class);
+            }
+
             @Override
             protected String expectedEndpointUri(AdvancedInsightRequest request) {
                 return request.isAsync() ? "/ni/advanced/async/json" : "/ni/advanced/json";

diff --git a/src/test/java/com/vonage/client/insight/InsightEndpointTestSpec.java b/src/test/java/com/vonage/client/insight/InsightEndpointTestSpec.java
@@ -17,21 +17,11 @@
 
 import com.vonage.client.DynamicEndpointTestSpec;
 import com.vonage.client.VonageApiResponseException;
-import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
-import com.vonage.client.auth.AuthMethod;
-import com.vonage.client.auth.SignatureAuthMethod;
 import com.vonage.client.common.HttpMethod;
-import java.util.Arrays;
-import java.util.Collection;
 import java.util.Map;
 
 abstract class InsightEndpointTestSpec<T, R> extends DynamicEndpointTestSpec<T, R> {
 
-	@Override
-	protected Collection<Class<? extends AuthMethod>> expectedAuthMethods() {
-		return Arrays.asList(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class);
-	}
-
 	@Override
 	protected Class<? extends VonageApiResponseException> expectedResponseExceptionType() {
 		return VonageApiResponseException.class;

diff --git a/src/test/java/com/vonage/client/sms/SmsEndpointTestSpec.java b/src/test/java/com/vonage/client/sms/SmsEndpointTestSpec.java
@@ -18,7 +18,7 @@
 import com.vonage.client.DynamicEndpointTestSpec;
 import com.vonage.client.RestEndpoint;
 import com.vonage.client.VonageApiResponseException;
-import com.vonage.client.auth.ApiKeyQueryParamsAuthMethod;
+import com.vonage.client.auth.ApiKeyHeaderAuthMethod;
 import com.vonage.client.auth.AuthMethod;
 import com.vonage.client.auth.SignatureAuthMethod;
 import com.vonage.client.common.HttpMethod;
@@ -47,7 +47,7 @@ protected HttpMethod expectedHttpMethod() {
 
     @Override
     protected Collection<Class<? extends AuthMethod>> expectedAuthMethods() {
-        return Arrays.asList(SignatureAuthMethod.class, ApiKeyQueryParamsAuthMethod.class);
+        return Arrays.asList(SignatureAuthMethod.class, ApiKeyHeaderAuthMethod.class);
     }
 
     @Override