Implement required utility functions from Apache, drop vulnerable Apache dependencies (#24)

- Extract, rewrite the few Apache functions we need into ApachePatch
- Drop Apache-related code
- Drop all Apache dependencies
- Move several public utilities into internal utilities to consolidate
- Delete utilities that weren't being used (dead code)
- Add citation, license for modified Apache code
- Explicitly target Java 8 during compilation, to avoid an 8 vs. 11 discrepancy: https://stackoverflow.com/a/61267496/13343799
- Fix Javadoc generation issue
- Adjust Makefile to not re-compile code prior to testing

Author: nwithan8

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        javaversion: [ "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19" ]
+        java_version: [ "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19" ]
     steps:
       - uses: actions/checkout@v3
       - name: Load Maven dependencies cache
@@ -30,12 +30,12 @@ jobs:
           java-version: "19" # Always use the latest JDK for building
       - name: Compile
         run: make build
-      - name: Set up Java ${{ matrix.javaversion }}
+      - name: Set up Java ${{ matrix.java_version }}
         uses: actions/setup-java@v3
         with:
           distribution: "zulu"
-          java-version: ${{ matrix.javaversion }}
-      - name: Run test with Java ${{ matrix.javaversion }}
+          java-version: ${{ matrix.java_version }}
+      - name: Run test with Java ${{ matrix.java_version }}
         run: make test
   coverage:
     runs-on: ubuntu-20.04

Makefile

@@ -51,6 +51,6 @@ scan:
 
 ## test - Test the project
 test:
-	mvn --batch-mode install -Dgpg.skip=true -Dcheckstyle.skip=true -Dcheckstyle.skip=true -Ddependency-check.skip=true -Djavadoc.skip=true
+	mvn surefire:test
 
 .PHONY: help build clean coverage install-checkstyle install lint publish publish-dry release scan test

pom.xml

@@ -36,18 +36,14 @@
     </scm>
 
     <dependencies>
-        <!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient -->
-        <dependency>
-            <groupId>org.apache.httpcomponents</groupId>
-            <artifactId>httpclient</artifactId>
-            <version>4.5.13</version>
-        </dependency>
         <dependency>
+            <!-- https://mvnrepository.com/artifact/com.google.code.gson/gson -->
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
             <version>2.8.9</version>
         </dependency>
         <dependency>
+            <!-- https://mvnrepository.com/artifact/junit/junit -->
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.13.2</version>
@@ -62,15 +58,9 @@
         <dependency>
             <groupId>org.jetbrains</groupId>
             <artifactId>annotations</artifactId>
-            <version>23.0.0</version>
+            <version>23.1.0</version>
             <scope>compile</scope>
         </dependency>
-        <!-- https://mvnrepository.com/artifact/commons-beanutils/commons-beanutils -->
-        <dependency>
-            <groupId>commons-beanutils</groupId>
-            <artifactId>commons-beanutils</artifactId>
-            <version>1.9.4</version>
-        </dependency>
     </dependencies>
 
     <organization>
@@ -91,7 +81,19 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <maven.compiler.release>8</maven.compiler.release>
     </properties>
+    <profiles>
+        <profile>
+            <id>java8-doclint-disabled</id>
+            <activation>
+                <jdk>[1.8,)</jdk>
+            </activation>
+            <properties>
+                <javadoc.opts>none</javadoc.opts>
+            </properties>
+        </profile>
+    </profiles>
     <build>
         <resources>
             <resource>
@@ -146,21 +148,19 @@
                 </executions>
             </plugin>
             <plugin>
+                <!-- Configuration via https://stackoverflow.com/a/16743137/13343799 -->
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <configuration>
-                    <source>8</source>
-                    <doclint>-html</doclint>
-                    <quiet>true</quiet>
-                    <additionalparam>-Xdoclint:none</additionalparam>
-                </configuration>
                 <version>3.3.1</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
                         <goals>
                             <goal>jar</goal>
                         </goals>
+                        <configuration>
+                            <doclint>${javadoc.opts}</doclint>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>
@@ -183,8 +183,7 @@
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.9.0</version>
                 <configuration>
-                    <source>1.8</source>
-                    <target>1.8</target>
+                    <release>8</release>
                 </configuration>
             </plugin>
             <plugin>
@@ -262,7 +261,7 @@
             <plugin>
                 <groupId>org.owasp</groupId>
                 <artifactId>dependency-check-maven</artifactId>
-                <version>7.2.1</version>
+                <version>7.4.4</version>
                 <configuration>
                     <failBuildOnCVSS>7</failBuildOnCVSS>
                     <junitFailOnCVSS>7</junitFailOnCVSS>

src/main/java/com/easypost/easyvcr/Cassette.java

@@ -1,8 +1,8 @@
 package com.easypost.easyvcr;
 
-import com.easypost.easyvcr.internalutilities.Files;
-import com.easypost.easyvcr.internalutilities.Tools;
-import com.easypost.easyvcr.internalutilities.json.Serialization;
+import com.easypost.easyvcr.internal.Files;
+import com.easypost.easyvcr.internal.Utilities;
+import com.easypost.easyvcr.internal.json.Serialization;
 import com.easypost.easyvcr.requestelements.HttpInteraction;
 import com.google.gson.JsonElement;
 import com.google.gson.JsonParser;
@@ -40,7 +40,7 @@ public final class Cassette {
      */
     public Cassette(String folderPath, String cassetteName) {
         name = cassetteName;
-        filePath = Tools.getFilePath(folderPath, cassetteName + ".json");
+        filePath = Utilities.getFilePath(folderPath, cassetteName + ".json");
     }
 
     /**
@@ -62,7 +62,7 @@ public int numInteractions() {
      * @return The cassette file as a File object.
      */
     private File getFile() {
-        return Tools.getFile(filePath);
+        return Utilities.getFile(filePath);
     }
 
     /**

src/main/java/com/easypost/easyvcr/Censors.java

@@ -1,10 +1,9 @@
 package com.easypost.easyvcr;
 
-import com.easypost.easyvcr.internalutilities.Tools;
-import com.easypost.easyvcr.internalutilities.json.Serialization;
+import com.easypost.easyvcr.internal.Utilities;
+import com.easypost.easyvcr.internal.json.Serialization;
 import com.google.gson.JsonParseException;
-import org.apache.http.NameValuePair;
-import org.apache.http.client.utils.URLEncodedUtils;
+import com.easypost.easyvcr.internal.ApachePatch;
 
 import java.net.URI;
 import java.nio.charset.StandardCharsets;
@@ -17,7 +16,7 @@
 /**
  * Censoring capabilities for EasyVCR.
  */
-@SuppressWarnings("unchecked")
+@SuppressWarnings ("unchecked")
 public final class Censors {
     /**
      * The body elements to censor.
@@ -113,7 +112,7 @@ private static List<Object> applyJsonCensors(List<Object> list, String censorTex
             } else if (Utilities.isList(value)) {
                 // recursively censor list elements
                 try {
-                    // change the value if can be parsed as a list
+                    // change the value if it can be parsed as a list
                     value = applyJsonCensors((List<Object>) value, censorText, elementsToCensor);
                 } catch (ClassCastException e) {
                     // otherwise, skip censoring
@@ -165,15 +164,15 @@ private static Map<String, Object> applyJsonCensors(Map<String, Object> dictiona
                 if (Utilities.isDictionary(value)) {
                     // recursively censor inner dictionaries
                     try {
-                        // change the value if can be parsed as a dictionary
+                        // change the value if it can be parsed as a dictionary
                         value = applyJsonCensors((Map<String, Object>) value, censorText, elementsToCensor);
                     } catch (ClassCastException e) {
                         // otherwise, skip censoring
                     }
                 } else if (Utilities.isList(value)) {
                     // recursively censor list elements
                     try {
-                        // change the value if can be parsed as a list
+                        // change the value if it can be parsed as a list
                         value = applyJsonCensors((List<Object>) value, censorText, elementsToCensor);
                     } catch (ClassCastException e) {
                         // otherwise, skip censoring
@@ -292,8 +291,7 @@ public static Map<String, List<String>> applyHeaderCensors(Map<String, List<Stri
      * @param pathElementsToCensor The path elements to censor.
      * @return Censored URL string.
      */
-    public static String applyUrlCensors(String url, String censorText,
-                                         List<CensorElement> queryParamsToCensor,
+    public static String applyUrlCensors(String url, String censorText, List<CensorElement> queryParamsToCensor,
                                          List<RegexCensorElement> pathElementsToCensor) {
         if (url == null || url.length() == 0) {
             // short circuit if url is null
@@ -342,8 +340,10 @@ public static String applyUrlCensors(String url, String censorText,
                     }
                 }
 
-                List<NameValuePair> censoredQueryParametersList = Tools.mapToQueryParameters(queryParameters);
-                censoredQueryString = URLEncodedUtils.format(censoredQueryParametersList, StandardCharsets.UTF_8);
+                List<ApachePatch.NameValuePair> censoredQueryParametersList =
+                        Utilities.mapToQueryParameters(queryParameters);
+                censoredQueryString =
+                        ApachePatch.URLEncodedUtils.format(censoredQueryParametersList, StandardCharsets.UTF_8);
             }
         }
 

src/main/java/com/easypost/easyvcr/MatchRules.java

@@ -1,6 +1,6 @@
 package com.easypost.easyvcr;
 
-import com.easypost.easyvcr.internalutilities.Tools;
+import com.easypost.easyvcr.internal.Utilities;
 import com.easypost.easyvcr.requestelements.Request;
 
 import java.util.ArrayList;
@@ -83,8 +83,8 @@ public MatchRules byBody(List<CensorElement> ignoredElements) {
             recordedBody = Utilities.removeJsonElements(recordedBody, ignoredElements);
 
             // convert body to base64string to assist comparison by removing special characters
-            receivedBody = Tools.toBase64String(receivedBody);
-            recordedBody = Tools.toBase64String(recordedBody);
+            receivedBody = Utilities.toBase64String(receivedBody);
+            recordedBody = Utilities.toBase64String(recordedBody);
             return receivedBody.equalsIgnoreCase(recordedBody);
         });
         return this;
@@ -135,8 +135,8 @@ public MatchRules byFullUrl() {
     public MatchRules byFullUrl(boolean exact) {
         if (exact) {
             by((received, recorded) -> {
-                String receivedUri = Tools.toBase64String(received.getUriString());
-                String recordedUri = Tools.toBase64String(recorded.getUriString());
+                String receivedUri = Utilities.toBase64String(received.getUriString());
+                String recordedUri = Utilities.toBase64String(recorded.getUriString());
                 return receivedUri.equalsIgnoreCase(recordedUri);
             });
         } else {

src/main/java/com/easypost/easyvcr/Utilities.java

@@ -1,13 +1,7 @@
 package com.easypost.easyvcr;
 
-import org.apache.http.NameValuePair;
-import org.apache.http.client.utils.URLEncodedUtils;
-
 import javax.net.ssl.HttpsURLConnection;
 import java.net.HttpURLConnection;
-import java.net.URI;
-import java.nio.charset.StandardCharsets;
-import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 
@@ -36,76 +30,4 @@ public static boolean responseCameFromRecording(HttpURLConnection connection) {
         }
         return false;
     }
-
-    /**
-     * Check if the object is a dictionary.
-     * @param obj The object to check.
-     * @return True if the object is a dictionary.
-     */
-    public static boolean isDictionary(Object obj) {
-        return obj instanceof Map;
-    }
-
-    /**
-     * Check if the object is a list.
-     * @param obj The object to check.
-     * @return True if the object is a list.
-     */
-    public static boolean isList(Object obj) {
-        return obj instanceof List;
-    }
-
-    /**
-     * Remove elements from a JSON string.
-     * @param json The JSON string to remove elements from.
-     * @param elements The elements to remove.
-     * @return The JSON string without the elements.
-     */
-    public static String removeJsonElements(String json, List<CensorElement> elements) {
-        if (json == null || elements == null) {
-            return json;
-        }
-
-        return Censors.censorJsonData(json, "FILTERED", elements);
-    }
-
-    /**
-     * Convert a URI's query parameters to a Map.
-     *
-     * @param uri The URI.
-     * @return The Map of query parameters.
-     */
-    public static Map<String, String> queryParametersToMap(URI uri) {
-        List<NameValuePair> receivedQueryDict = URLEncodedUtils.parse(uri, StandardCharsets.UTF_8);
-        if (receivedQueryDict == null || receivedQueryDict.size() == 0) {
-            return Collections.emptyMap();
-        }
-        Map<String, String> queryDict = new java.util.Hashtable<>();
-        for (NameValuePair pair : receivedQueryDict) {
-            queryDict.put(pair.getName(), pair.getValue());
-        }
-        return queryDict;
-    }
-
-    /**
-     * Extract the path from a URI.
-     *
-     * @param uri The URI to extract the path from.
-     * @return The path.
-     */
-    public static String extractPathFromUri(URI uri) {
-        String uriString = uri.toString();
-
-        // strip the query parameters
-        uriString = uriString.replace(uri.getQuery(), "");
-
-        if (uriString.endsWith("?")) {
-            uriString = uriString.substring(0, uriString.length() - 1);
-        }
-
-        // strip the scheme
-        uriString = uriString.replace(uri.getScheme() + "://", "");
-
-        return uriString;
-    }
 }

src/main/java/com/easypost/easyvcr/clients/httpurlconnection/RecordableHttpURLConnection.java

@@ -6,8 +6,8 @@
 import com.easypost.easyvcr.RecordingExpirationException;
 import com.easypost.easyvcr.VCRException;
 import com.easypost.easyvcr.interactionconverters.HttpUrlConnectionInteractionConverter;
-import com.easypost.easyvcr.internalutilities.ConsoleFallbackLogger;
-import com.easypost.easyvcr.internalutilities.ExpirationActionExtensions;
+import com.easypost.easyvcr.internal.ConsoleFallbackLogger;
+import com.easypost.easyvcr.internal.ExpirationActionExtensions;
 import com.easypost.easyvcr.requestelements.HttpInteraction;
 import com.easypost.easyvcr.requestelements.Request;
 
@@ -28,8 +28,8 @@
 import java.util.Map;
 import java.util.function.Function;
 
-import static com.easypost.easyvcr.internalutilities.Tools.createInputStream;
-import static com.easypost.easyvcr.internalutilities.Tools.simulateDelay;
+import static com.easypost.easyvcr.internal.Utilities.createInputStream;
+import static com.easypost.easyvcr.internal.Utilities.simulateDelay;
 
 public final class RecordableHttpURLConnection extends HttpURLConnection {