Fixing issue #57 extra slash in URL with HTTP Client >=4.5.3

Author: Chris Wilson

README.md

@@ -10,6 +10,10 @@ Use this library in Java applications to easily access the SparkPost Email API i
 
 ## Version Compatibility Note
 
+### Version 0.6.2 -> 0.6.3
+
+Due to [issue 57](https://github.com/SparkPost/java-sparkpost/issues/57) and to maintain compatibility with old and new version of Apache HTTP Client `SPARKPOST_BASE_URL` must not end with a `/` slash.
+
 ### Version 0.12 -> 0.13
 
 Although we try to maintain library backward compatibility this migration may require some minor changes to your code. Substitution data was changed from `Map<String, String>` to `Map<String, Object>`. Most client code will just need to change their map to this new signature.

libs/sparkpost-lib/pom.xml

@@ -25,7 +25,7 @@
 		<dependency>
 			<groupId>org.apache.httpcomponents</groupId>
 			<artifactId>httpclient</artifactId>
-			<version>4.5</version>
+			<version>4.5.3</version>
 		</dependency>
 
 		<!-- the following two dependencies are required for correct jmockit operation 

libs/sparkpost-lib/src/main/java/com/sparkpost/resources/Endpoint.java

@@ -21,8 +21,17 @@ private void addString(String name, String value) {
         this.uriBuilder.addParameter(name, value);
     }
 
-    public Endpoint addCommonParams(String from, String to, String domains, String campaigns, String templates, String metrics,
-                                    String timezone, String limit, String orderBy) {
+    public Endpoint addCommonParams(
+            String from,
+            String to,
+            String domains,
+            String campaigns,
+            String templates,
+            String metrics,
+            String timezone,
+            String limit,
+            String orderBy) {
+
         addParam("from", from);
         addParam("to", to);
         addParam("domains", domains);
@@ -57,7 +66,14 @@ public Endpoint addParam(String name, Boolean value) {
 
     @Override
     public String toString() {
-        return this.uriBuilder.toString();
+        String result = this.uriBuilder.toString();
+
+        if (result.startsWith("/")) {
+            return result;
+        } else {
+
+            return "/" + this.uriBuilder.toString();
+        }
     }
 
 }

libs/sparkpost-lib/src/main/java/com/sparkpost/transport/RestConnection.java

@@ -42,9 +42,9 @@ public class RestConnection {
 
     /**
      * Default endpoint to use for connections :
-     * https://api.sparkpost.com/api/v1/
+     * https://api.sparkpost.com/api/v1
      */
-    public final static String defaultApiEndpoint = "https://api.sparkpost.com/api/v1/";
+    public final static String defaultApiEndpoint = "https://api.sparkpost.com/api/v1";
 
     private final Client client;
 
@@ -70,7 +70,7 @@ public enum Method {
      * @throws SparkPostException
      */
     public RestConnection(Client client) throws SparkPostException {
-        this(client, null /* means:set to default endpoint */);
+        this(client, "" /* means:set to default endpoint */);
     }
 
     /**
@@ -84,15 +84,17 @@ public RestConnection(Client client) throws SparkPostException {
      * @throws SparkPostException
      */
     public RestConnection(Client client, String endpoint) throws SparkPostException {
+
         this.client = client;
         if (StringUtils.isAnyEmpty(endpoint)) {
             this.endpoint = defaultApiEndpoint;
         } else {
-            if (endpoint.endsWith("/")) {
-                this.endpoint = endpoint;
-            } else {
-                this.endpoint = endpoint + '/';
-            }
+
+            this.endpoint = endpoint;
+        }
+
+        if (endpoint.endsWith("/")) {
+            throw new IllegalStateException("SPARKPOST_BASE_URL should not end with a '/',  SPARKPOST_BASE_URL=" + endpoint + "");
         }
     }
 
@@ -110,7 +112,11 @@ private HttpURLConnection createConnectionObject(String path, Method method) thr
         HttpURLConnection conn;
         try {
             URL url;
-            url = new URL(this.endpoint + path);
+            if (path.startsWith("/")) {
+                url = new URL(this.endpoint + path);
+            } else {
+                url = new URL(this.endpoint + "/" + path);
+            }
 
             // Retrieve the URLConnection object (but doesn't actually connect):
             // (HttpUrlConnection doesn't connect to the server until we've
@@ -160,10 +166,13 @@ private HttpURLConnection createConnectionObject(String path, Method method) thr
                     throw new SparkPostException("Invalid Method");
             }
         } catch (MalformedURLException ex) {
+
             throw new SparkPostException("Invalid path: " + path + ex.toString());
         } catch (ProtocolException ex) {
+
             throw new SparkPostException("Invalid method:" + ex.toString());
         } catch (IOException ex) {
+
             throw new SparkPostException("Error with connection to " + path + ex.toString());
         }
         return conn;

libs/sparkpost-lib/src/test/java/com/sparkpost/EndPointTest.java

@@ -43,7 +43,7 @@ public void testSimpleEndPoint() {
         endPoint.addParam("num_rcpt_errors", 3);
 
         String result = endPoint.toString();
-        Assert.assertEquals("transmissions?num_rcpt_errors=3", result);
+        Assert.assertEquals("/transmissions?num_rcpt_errors=3", result);
     }
 
     /**
@@ -55,7 +55,7 @@ public void testEndPointWithBoolean() {
         endPoint.addParam("myBool", new Boolean(true));
 
         String result = endPoint.toString();
-        Assert.assertEquals("transmissions?myBool=true", result);
+        Assert.assertEquals("/transmissions?myBool=true", result);
     }
 
     /**
@@ -67,7 +67,7 @@ public void testEndPointWithInteger() {
         endPoint.addParam("myInteger", new Integer(100));
 
         String result = endPoint.toString();
-        Assert.assertEquals("transmissions?myInteger=100", result);
+        Assert.assertEquals("/transmissions?myInteger=100", result);
     }
 
     /**
@@ -81,7 +81,7 @@ public void testEndPointWithMultipleParameters() {
         endPoint.addParam("MyInteger", new Integer(0));
 
         String result = endPoint.toString();
-        Assert.assertEquals("transmissions?num_rcpt_errors=3&myBool=false&MyInteger=0", result);
+        Assert.assertEquals("/transmissions?num_rcpt_errors=3&myBool=false&MyInteger=0", result);
     }
 
 }