issue #342. add a default base path configuration

Author: ryber

CHANGELOG.md

@@ -1,9 +1,12 @@
+## 3.7.00
+* Issue #342: Add a default base URL configuration
+
 ## 3.6.01
 * Issue #341:
    * Do not URLDecode cookie values because they may not be and decoding can remove legit values like +
    * Split cookie pairs on the first = only so values can have =
 
-## 3.4.00
+## 3.6.00
 * issue #336 Add ProgressMonitor for file downloads.
 
 ## 3.5.00

docs/index.md

@@ -92,12 +92,22 @@ Unirest.get("http://httpbin.org/{fruit}")
 
 // Results in `http://httpbin.org/apple`
 ```
-Basically the placeholder `{method}` will be replaced with `apple`.
+The placeholder `{fruit}` will be replaced with `apple`.
 
-The placeholder's format is as easy as: `{custom_name}`
+The placeholder's format is as easy as wrapping in curly braces: `{custom_name}`
 
 All param values will be URL-Encoded for you
 
+## Default Base URLs
+You  can configure a default base URL to be used for all requests that do not contain a full URL.
+
+This configuration will result in a GET to "http://homestar.com/runner"
+```java
+   Unirest.config().defaultBaseUrl("http://homestar.com");
+    
+   Unirest.get("/runner").asString();
+``` 
+
 ## Query Parameters
 Query-string params can be built up one by one
 
@@ -507,6 +517,7 @@ Changing Unirest's config should ideally be done once, or rarely. There are seve
 | ```errorHandler(Consumer<HttpResponse<?>> consumer)``` | Set a global error handler that will be invoked for any status > 400 or a parsing error | | 
 | ```interceptor(Interceptor value)``` | Set a global Interceptor handler that will be invoked before and after each request | | 
 | ```hostNameVerifier(HostNameVerifier value)``` | Set a custom HostNameVerifier for the security configuration | DefaultHostNameVerifier | 
+| ```defaultBaseUrl(String value)``` | Set a default base URL to be used for all requests that do not already contain a scheme |  | 
 
 ##  Global Interceptor
 You can set a global interceptor for your configuration. This is invoked before and after each request.

object-mapper-gson/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.konghq</groupId>
         <artifactId>unirest-java-parent</artifactId>
-        <version>3.6.02-SNAPSHOT</version>
+        <version>3.7.00-SNAPSHOT</version>
     </parent>
 
     <artifactId>unirest-object-mappers-gson</artifactId>

object-mapper-jackson/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.konghq</groupId>
         <artifactId>unirest-java-parent</artifactId>
-        <version>3.6.02-SNAPSHOT</version>
+        <version>3.7.00-SNAPSHOT</version>
     </parent>
 
     <artifactId>unirest-objectmapper-jackson</artifactId>

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.konghq</groupId>
     <artifactId>unirest-java-parent</artifactId>
     <packaging>pom</packaging>
-    <version>3.6.02-SNAPSHOT</version>
+    <version>3.7.00-SNAPSHOT</version>
     <name>unirest</name>
     <description>Parent pom for unirest packages</description>
     <url>http://github.com/Kong/unirest-java/</url>

unirest/pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>com.konghq</groupId>
         <artifactId>unirest-java-parent</artifactId>
-        <version>3.6.02-SNAPSHOT</version>
+        <version>3.7.00-SNAPSHOT</version>
     </parent>
 
     <description>Simplified, lightweight HTTP client library.</description>

unirest/src/main/java/kong/unirest/BaseRequest.java

@@ -61,7 +61,7 @@ abstract class BaseRequest<R extends HttpRequest> implements HttpRequest<R> {
     BaseRequest(Config config, HttpMethod method, String url) {
         this.config = config;
         this.method = method;
-        this.url = new Path(url);
+        this.url = new Path(url, config.getDefaultBaseUrl());
         headers.putAll(config.getDefaultHeaders());
     }
 
@@ -323,7 +323,7 @@ public <T> PagedList<T> asPaged(Function<HttpRequest, HttpResponse> mappingFunct
         PagedList<T> all = new PagedList<>();
         String nextLink = this.getUrl();
         do {
-            this.url = new Path(nextLink);
+            this.url = new Path(nextLink, config.getDefaultBaseUrl());
             HttpResponse<T> next = mappingFunction.apply(this);
             all.add(next);
             nextLink = linkExtractor.apply(next);

unirest/src/main/java/kong/unirest/Config.java

@@ -49,7 +49,6 @@
 
 import static kong.unirest.Util.tryCast;
 
-
 public class Config {
     public static final int DEFAULT_CONNECTION_TIMEOUT = 10000;
     public static final int DEFAULT_MAX_CONNECTIONS = 200;
@@ -86,6 +85,7 @@ public class Config {
     private SSLContext sslContext;
     private Interceptor interceptor = new DefaultInterceptor();
     private HostnameVerifier hostnameVerifier;
+    private String defaultBaseUrl;
 
     public Config() {
         setDefaults();
@@ -577,6 +577,20 @@ public Config addShutdownHook(boolean value) {
         return this;
     }
 
+    /**
+     * set a default base url for all routes.
+     * this is overridden if the url contains a valid base already
+     * the url may contain path params
+     *
+     * for example. Setting a default path of 'http://somwhere'
+     * and then calling Unirest with Unirest.get('/place')
+     * will result in a path of 'https://somwehre/place'
+     * @param value
+     */
+    public void defaultBaseUrl(String value) {
+        this.defaultBaseUrl = value;
+    }
+
     /**
      * Return default headers that are added to every request
      *
@@ -829,4 +843,8 @@ private Optional<DefaultInterceptor> getDefaultInterceptor() {
     public HostnameVerifier getHostnameVerifier() {
         return hostnameVerifier;
     }
+
+    String getDefaultBaseUrl() {
+        return this.defaultBaseUrl;
+    }
 }

unirest/src/main/java/kong/unirest/Path.java

@@ -37,9 +37,15 @@ class Path {
     private String url;
     private String rawPath;
 
-    Path(String url) {
-        this.url = url;
-        this.rawPath = url;
+    Path(String url, String defaultBasePath) {
+        if(defaultBasePath != null && url != null && !url.toLowerCase().startsWith("http")){
+            String full = defaultBasePath + url;
+            this.url = full;
+            this.rawPath = full;
+        } else {
+            this.url = url;
+            this.rawPath = url;
+        }
     }
 
     public void param(Map<String, Object> params) {

unirest/src/test/java/BehaviorTests/BaseUrlTest.java

@@ -0,0 +1,64 @@
+/**
+ * The MIT License
+ *
+ * Copyright for portions of unirest-java are held by Kong Inc (c) 2013.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package BehaviorTests;
+
+import kong.unirest.Unirest;
+import org.junit.jupiter.api.Test;
+
+public class BaseUrlTest extends BddTest {
+
+    @Test
+    void canConfigureADefaultBaseUrl() {
+        Unirest.config().defaultBaseUrl(MockServer.HOST);
+
+        Unirest.get("/get")
+                .asObject(RequestCapture.class)
+                .getBody()
+                .assertUrl(MockServer.GET);
+    }
+
+    @Test
+    void willNotUseTheDefaultIfOverridden() {
+        Unirest.config().defaultBaseUrl("http://somewhere");
+
+        Unirest.get(MockServer.GET)
+                .asObject(RequestCapture.class)
+                .getBody()
+                .assertUrl(MockServer.GET);
+    }
+
+    @Test
+    void defaultUrlsCanHavePlaceholders() {
+        Unirest.config().defaultBaseUrl(MockServer.PASSED_PATH_PARAM);
+
+        Unirest.get("/{another}")
+                .routeParam("params", "George")
+                .routeParam("another", "Ringo")
+                .asObject(RequestCapture.class)
+                .getBody()
+                .assertUrl("http://localhost:4567/get/George/passed/Ringo");
+    }
+}

unirest/src/test/java/BehaviorTests/BddTest.java

@@ -28,6 +28,8 @@
 import kong.unirest.*;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
 
 import java.io.IOException;
 import java.util.concurrent.CountDownLatch;
@@ -41,7 +43,7 @@ public class BddTest {
     private boolean status;
     private String fail;
 
-    @Before
+    @Before @BeforeEach
     public void setUp() {
         //TestUtil.debugApache();
         MockServer.reset();
@@ -50,7 +52,7 @@ public void setUp() {
         status = false;
     }
 
-    @After
+    @After @AfterEach
     public void tearDown() {
         Unirest.shutDown(true);
     }

unirest/src/test/java/kong/unirest/PathTest.java

@@ -32,19 +32,19 @@
 public class PathTest {
     @Test
     public void pathIsTheSameIfUrlIs() {
-        Path p = new Path("https://localhost/apples");
-        Path o = new Path("https://localhost/apples");
+        Path p = new Path("https://localhost/apples", null);
+        Path o = new Path("https://localhost/apples", null);
         assertEquals(p, o);
     }
 
     @Test
     public void pathsWithDifferentParams() {
         String raw = "http://somewhere/fruits/{id}";
-        Path q = new Path(raw);
+        Path q = new Path(raw, null);
         q.param("id", "apple");
-        Path w = new Path(raw);
+        Path w = new Path(raw, null);
         w.param("id", "apple");
-        Path e = new Path(raw);
+        Path e = new Path(raw, null);
         e.param("id", "oranges");
 
         assertEquals(q,w);
@@ -54,14 +54,24 @@ public void pathsWithDifferentParams() {
     @Test
     public void queryParamsMatter() {
         String raw = "http://somewhere/fruits/}";
-        Path q = new Path(raw);
+        Path q = new Path(raw, null);
         q.queryString("id", "apple");
-        Path w = new Path(raw);
+        Path w = new Path(raw, null);
         w.queryString("id", "apple");
-        Path e = new Path(raw);
+        Path e = new Path(raw, null);
         e.queryString("id", "oranges");
 
         assertEquals(q,w);
         assertNotEquals(q, e);
     }
+
+    @Test
+    public void canBuildUsingDefaultBase() {
+        assertEquals("http://somwhere/fruit", new Path("/fruit","http://somwhere").toString());
+    }
+
+    @Test
+    public void willNotAddBaseIfPrimaryPathIsFull() {
+        assertEquals("http://somwhere/fruit", new Path("http://somwhere/fruit","http://elsewhere/rocks").toString());
+    }
 }