Merge branch '6.0.0-release'

CHANGELOG.md

@@ -8,13 +8,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## Added
 - ASR (Automatic Speech Recognition)
 
+### Changed
+- Refactored Application v2 requests to remove duplicated code
+- Deprecated Product.MESSAGE from RedactRequest. Use Product.MESSAGES instead
+- Deprecated InsightClient#getStandardNumberInsight(number, country, cnam). Use InsightClient#getStandardNumberInsight(StandardInsightRequest) instead
+- Deprecated InsightClient.getAdvancedNumberInsight(number, country, ipAddress, cnam). Use InsightClient#getAdvancedNumberInsight(AdvancedInsightRequest) instead
+- Deprecated InsightClient.getAdvancedNumberInsight(number, country, ipAddress). Use InsightClient#getAdvancedNumberInsight(AdvancedInsightRequest) instead
+- Deprecated public constructors and setters in VerifyRequest use VerifyRequest.Builder instead
+- Deprecated MD5Util use HashUtil instead
+- Removed setters from BaseRequest. Set fields in the builders of Psd2Request or VerifyRequest instead.
+
 ## [5.6.0]
 ### Added
 - NotifyEvent structure for Notify Actions
 - SHA256 hashing option
 
 ### Changed
-- Create application request use basic auth for authentication
+- Changed application requests to use basic auth in header for authentication
 
 ### Fixed
 - Fixed error throw when trying to log No Content responses

src/main/java/com/vonage/client/HttpWrapper.java

@@ -61,10 +61,10 @@ public HttpWrapper(HttpConfig httpConfig, AuthMethod... authMethods) {
     }
 
     public HttpClient getHttpClient() {
-        if (this.httpClient == null) {
-            this.httpClient = createHttpClient();
+        if (httpClient == null) {
+            httpClient = createHttpClient();
         }
-        return this.httpClient;
+        return httpClient;
     }
 
     public void setHttpClient(HttpClient httpClient) {

src/main/java/com/vonage/client/VonageClient.java

@@ -291,7 +291,7 @@ public Builder privateKeyPath(String privateKeyPath) throws VonageUnableToReadPr
          *                                      generating an {@link JWTAuthMethod} with the provided credentials.
          */
         public VonageClient build() {
-            this.authCollection = generateAuthCollection(applicationId,
+            authCollection = generateAuthCollection(applicationId,
                     apiKey,
                     apiSecret,
                     signatureSecret,

src/main/java/com/vonage/client/account/BalanceEndpoint.java

@@ -46,7 +46,7 @@ public RequestBuilder makeRequest(Void request) throws UnsupportedEncodingExcept
     }
 
     public BalanceResponse execute() {
-        return this.execute(null);
+        return execute(null);
     }
 
     @Override

src/main/java/com/vonage/client/account/PricingMethod.java

@@ -38,7 +38,7 @@ protected Class[] getAcceptableAuthMethods() {
 
     @Override
     public RequestBuilder makeRequest(PricingRequest pricingRequest) {
-        return RequestBuilder.get(this.getUri()).addParameter("country", pricingRequest.getCountryCode());
+        return RequestBuilder.get(getUri()).addParameter("country", pricingRequest.getCountryCode());
     }
 
     @Override

src/main/java/com/vonage/client/application/ApplicationMethod.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2020  Vonage
+ *
+ * Licensed 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 com.vonage.client.application;
+
+import com.vonage.client.AbstractMethod;
+import com.vonage.client.HttpWrapper;
+import com.vonage.client.VonageClientException;
+import org.apache.http.client.methods.RequestBuilder;
+
+public abstract class ApplicationMethod<RequestT, ResultT> extends AbstractMethod<RequestT, ResultT> {
+
+    public ApplicationMethod(HttpWrapper httpWrapper) {
+        super(httpWrapper);
+    }
+
+    @Override
+    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
+        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
+    }
+}

src/main/java/com/vonage/client/application/CreateApplicationMethod.java

@@ -15,7 +15,6 @@
  */
 package com.vonage.client.application;
 
-import com.vonage.client.AbstractMethod;
 import com.vonage.client.HttpWrapper;
 import com.vonage.client.VonageBadRequestException;
 import com.vonage.client.VonageClientException;
@@ -29,7 +28,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 
-class CreateApplicationMethod extends AbstractMethod<Application, Application> {
+class CreateApplicationMethod extends ApplicationMethod<Application, Application> {
     private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
 
     private static final String PATH = "/applications";
@@ -59,9 +58,4 @@ public Application parseResponse(HttpResponse response) throws IOException, Vona
 
         return Application.fromJson(new BasicResponseHandler().handleResponse(response));
     }
-
-    @Override
-    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
-        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
-    }
 }

src/main/java/com/vonage/client/application/DeleteApplicationMethod.java

@@ -15,7 +15,6 @@
  */
 package com.vonage.client.application;
 
-import com.vonage.client.AbstractMethod;
 import com.vonage.client.HttpWrapper;
 import com.vonage.client.VonageBadRequestException;
 import com.vonage.client.VonageClientException;
@@ -27,7 +26,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 
-class DeleteApplicationMethod extends AbstractMethod<String, Void> {
+class DeleteApplicationMethod extends ApplicationMethod<String, Void> {
     private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
 
     private static final String PATH = "/applications/%s";
@@ -56,9 +55,4 @@ public Void parseResponse(HttpResponse response) throws IOException, VonageClien
 
         return null;
     }
-
-    @Override
-    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
-        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
-    }
 }

src/main/java/com/vonage/client/application/GetApplicationMethod.java

@@ -15,7 +15,6 @@
  */
 package com.vonage.client.application;
 
-import com.vonage.client.AbstractMethod;
 import com.vonage.client.HttpWrapper;
 import com.vonage.client.VonageBadRequestException;
 import com.vonage.client.VonageClientException;
@@ -28,7 +27,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 
-class GetApplicationMethod extends AbstractMethod<String, Application> {
+class GetApplicationMethod extends ApplicationMethod<String, Application> {
     private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
 
     private static final String PATH = "/applications/%s";
@@ -57,9 +56,4 @@ public Application parseResponse(HttpResponse response) throws IOException, Vona
 
         return Application.fromJson(new BasicResponseHandler().handleResponse(response));
     }
-
-    @Override
-    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
-        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
-    }
 }

src/main/java/com/vonage/client/application/ListApplicationsMethod.java

@@ -15,7 +15,6 @@
  */
 package com.vonage.client.application;
 
-import com.vonage.client.AbstractMethod;
 import com.vonage.client.HttpWrapper;
 import com.vonage.client.VonageBadRequestException;
 import com.vonage.client.VonageClientException;
@@ -28,7 +27,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 
-class ListApplicationsMethod extends AbstractMethod<ListApplicationRequest, ApplicationList> {
+class ListApplicationsMethod extends ApplicationMethod<ListApplicationRequest, ApplicationList> {
     private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
 
     private static final String PATH = "/applications";
@@ -69,9 +68,4 @@ public ApplicationList parseResponse(HttpResponse response) throws IOException,
 
         return ApplicationList.fromJson(new BasicResponseHandler().handleResponse(response));
     }
-
-    @Override
-    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
-        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
-    }
 }

src/main/java/com/vonage/client/application/UpdateApplicationMethod.java

@@ -15,7 +15,6 @@
  */
 package com.vonage.client.application;
 
-import com.vonage.client.AbstractMethod;
 import com.vonage.client.HttpWrapper;
 import com.vonage.client.VonageBadRequestException;
 import com.vonage.client.VonageClientException;
@@ -29,7 +28,7 @@
 import java.io.IOException;
 import java.io.UnsupportedEncodingException;
 
-class UpdateApplicationMethod extends AbstractMethod<Application, Application> {
+class UpdateApplicationMethod extends ApplicationMethod<Application, Application> {
     private static final Class[] ALLOWED_AUTH_METHODS = new Class[]{TokenAuthMethod.class};
 
     private static final String PATH = "/applications/%s";
@@ -59,9 +58,4 @@ public Application parseResponse(HttpResponse response) throws IOException, Vona
 
         return Application.fromJson(new BasicResponseHandler().handleResponse(response));
     }
-
-    @Override
-    protected RequestBuilder applyAuth(RequestBuilder request) throws VonageClientException {
-        return getAuthMethod(getAcceptableAuthMethods()).applyAsBasicAuth(request);
-    }
 }

src/main/java/com/vonage/client/auth/AuthCollection.java

@@ -63,6 +63,7 @@ public void add(AuthMethod auth) {
      *
      * @throws VonageUnacceptableAuthException if no matching AuthMethod is found.
      */
+    @SuppressWarnings("unchecked")
     public <T extends AuthMethod> T getAuth(Class<T> type) throws VonageUnacceptableAuthException {
         for (AuthMethod availableAuthMethod : authList) {
             if (type.isInstance(availableAuthMethod)) {

src/main/java/com/vonage/client/auth/RequestSigning.java

@@ -160,6 +160,7 @@ public static boolean verifyRequestSignature(HttpServletRequest request, String
      *
      * @param request The HttpServletRequest to be verified.
      * @param secretKey The pre-shared secret key used by the sender of the request to create the signature.
+     * @param hashType Hash type to be used to construct request parameters.
      *
      * @return true if the signature is correct for this request and secret key.
      */

src/main/java/com/vonage/client/auth/SignatureAuthMethod.java

@@ -31,7 +31,7 @@ public class SignatureAuthMethod extends AbstractAuthMethod {
     public SignatureAuthMethod(String apiKey, String secret) {
         this.apiKey = apiKey;
         this.secret = secret;
-        this.hashType = HashUtil.HashType.MD5;
+        hashType = HashUtil.HashType.MD5;
     }
 
     public SignatureAuthMethod(String apiKey, String secret, HashUtil.HashType hashType) {

src/main/java/com/vonage/client/auth/hashutils/AbstractHasher.java

@@ -31,9 +31,10 @@ public String calculate(String input) throws NoSuchAlgorithmException, InvalidKe
      * @return  hashed representation of the input string
      * @throws NoSuchAlgorithmException if the algorithm is not available.
      * @throws UnsupportedEncodingException if the encoding type is invalid
+     * @throws InvalidKeyException Only applicable to HMAC encoding types, when a bad key is provided.
      */
     public String calculate(String input, String secretKey, String encoding) throws UnsupportedEncodingException, NoSuchAlgorithmException, InvalidKeyException {
-        return this.calculate(input + secretKey, encoding);
+        return calculate(input + secretKey, encoding);
     }
 
     /**
@@ -44,6 +45,7 @@ public String calculate(String input, String secretKey, String encoding) throws
      * @return  hashed representation of the input string
      * @throws NoSuchAlgorithmException if the algorithm is not available.
      * @throws UnsupportedEncodingException if the encoding type is invalid
+     * @throws InvalidKeyException Only applicable to HMAC encoding types, when a bad key is provided.
      */
     public abstract String calculate(String input, String encoding) throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException;
 

src/main/java/com/vonage/client/auth/hashutils/HashUtil.java

@@ -39,6 +39,7 @@ public static String calculate(String input, HashType hashType) throws NoSuchAlg
      * @return representation of the input string with given hash type
      * @throws NoSuchAlgorithmException if the algorithm is not available.
      * @throws InvalidKeyException Only applicable to HMAC encoding types, when a bad key is provided.
+     * @throws UnsupportedEncodingException if the specified encoding is unavailable.
      */
     public static String calculate(String input, String encoding, HashType hashType) throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
         return hashTypes.get(hashType).calculate(input, encoding);

src/main/java/com/vonage/client/auth/hashutils/HmacMd5Hasher.java

@@ -28,7 +28,7 @@ public class HmacMd5Hasher extends AbstractHasher {
 
         byte[] digest = sha1HMAC.doFinal(input.getBytes(encoding));
 
-        return this.buildHexString(digest);
+        return buildHexString(digest);
     }
 
     /**
@@ -43,6 +43,6 @@ public class HmacMd5Hasher extends AbstractHasher {
      * @throws InvalidKeyException if key is invalid
      */
     @Override public String calculate(String input, String encoding) throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
-        return this.calculate(input, input, encoding);
+        return calculate(input, input, encoding);
     }
 }

src/main/java/com/vonage/client/auth/hashutils/HmacSha1Hasher.java

@@ -28,7 +28,7 @@ public class HmacSha1Hasher extends AbstractHasher {
 
         byte[] digest = sha1HMAC.doFinal(input.getBytes(encoding));
 
-        return this.buildHexString(digest);
+        return buildHexString(digest);
     }
 
     /**
@@ -43,6 +43,6 @@ public class HmacSha1Hasher extends AbstractHasher {
      * @throws InvalidKeyException if key is invalid
      */
     @Override public String calculate(String input, String encoding) throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
-        return this.calculate(input, input, encoding);
+        return calculate(input, input, encoding);
     }
 }

src/main/java/com/vonage/client/auth/hashutils/HmacSha256Hasher.java

@@ -28,7 +28,7 @@ public class HmacSha256Hasher extends AbstractHasher {
 
         byte[] digest = sha256HMAC.doFinal(input.getBytes(encoding));
 
-        return this.buildHexString(digest);
+        return buildHexString(digest);
     }
 
     /**
@@ -43,6 +43,6 @@ public class HmacSha256Hasher extends AbstractHasher {
      * @throws InvalidKeyException if key is invalid
      */
     @Override public String calculate(String input, String encoding) throws NoSuchAlgorithmException, UnsupportedEncodingException, InvalidKeyException {
-        return this.calculate(input, input, encoding);
+        return calculate(input, input, encoding);
     }
 }