Proxies now support an additional path component

Author: m0nk3y2k4

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Util method `Parameters.isPositiveInteger` returning Predicate<String> used to check for positive numeric integers.
+- `Proxy` objects now support an additional path component.
 
 ### Changed
 - Method `APIUtil.prettyPrint(JsonNode)` now wraps lines with a fix Unix-style (LF) line separator.

src/main/java/com/github/m0nk3y2k4/thetvdb/TheTVDBApiFactory.java

@@ -146,15 +146,37 @@ public static QueryParameters createQueryParameters(@Nonnull Map<String, String>
     /**
      * Creates a new proxy object based on the given parameters. A proxy may be provided when creating a new TheTVDBApi
      * instance in order to forward all communication towards this proxy instead of directly communicating with the
-     * remote <i>TheTVDB.com</i> API.
+     * remote <i>TheTVDB.com</i> API. The returned proxy object represents a URI in the following format:
+     * <em>{@code "protocol://host:port"}</em>.
      *
      * @param protocol The protocol used by the proxy
      * @param host     The host name of the proxy
      * @param port     The port number to be used for communication
      *
      * @return New immutable proxy object based on the given parameters
+     *
+     * @see TheTVDBApiFactory#createProxy(String, String, String, int) createProxy(protocol, host, path, port)
      */
     public static Proxy createProxy(@Nonnull String protocol, @Nonnull String host, int port) {
         return new RemoteAPI.Builder().protocol(protocol).host(host).port(port).build();
     }
+
+    /**
+     * Creates a new proxy object based on the given parameters. A proxy may be provided when creating a new TheTVDBApi
+     * instance in order to forward all communication towards this proxy instead of directly communicating with the
+     * remote <i>TheTVDB.com</i> API. The returned proxy object represents a URI in the following format:
+     * <em>{@code "protocol://host:port/path"}</em>.
+     *
+     * @param protocol The protocol used by the proxy
+     * @param host     The host name of the proxy
+     * @param path     The path component with a leading '/'. Will be appended to the authority component.
+     * @param port     The port number to be used for communication
+     *
+     * @return New immutable proxy object based on the given parameters
+     *
+     * @see TheTVDBApiFactory#createProxy(String, String, int) createProxy(protocol, host, port)
+     */
+    public static Proxy createProxy(@Nonnull String protocol, @Nonnull String host, @Nonnull String path, int port) {
+        return new RemoteAPI.Builder().protocol(protocol).host(host).port(port).path(path).build();
+    }
 }

src/main/java/com/github/m0nk3y2k4/thetvdb/api/Proxy.java

@@ -16,14 +16,17 @@
 
 package com.github.m0nk3y2k4.thetvdb.api;
 
+import java.util.Optional;
+
 import com.github.m0nk3y2k4.thetvdb.TheTVDBApiFactory;
 
 /**
  * Interface representing a proxy service to be used for communication with the remote API. Such proxies may be provided
  * when creating a new API instance in order to forward the all the communication towards this proxy rather than
  * directly communicating with the the actual <i>TheTVDB.com</i> remote API. The latter one will be the default behavior
  * if no specific proxy is set during the API instantiation. Instances of this interface might be created via the {@link
- * TheTVDBApiFactory}.
+ * TheTVDBApiFactory}. The URI represented by this proxy will be assembled in the following form:
+ * <em>{@code protocol://host:port[/path]}</em>
  */
 public interface Proxy {
 
@@ -41,6 +44,13 @@ public interface Proxy {
      */
     String getHost();
 
+    /**
+     * Returns the optional path component of this proxy.
+     *
+     * @return The optional path component of this proxy
+     */
+    Optional<String> getPath();
+
     /**
      * Returns the port number used for communication with this proxy.
      *

src/main/java/com/github/m0nk3y2k4/thetvdb/internal/connection/RemoteAPI.java

@@ -96,7 +96,7 @@ public int getPort() {
      * @throws MalformedURLException If an unknown protocol is used or the port is a negative number other than -1
      */
     public URL forResource(@Nonnull String resource) throws MalformedURLException {
-        return new URL(getProtocol(), getHost(), getPort(), resource);
+        return new URL(getProtocol(), getHost(), getPort(), getPath().orElse("") + resource);
     }
 
     /**

src/test/java/com/github/m0nk3y2k4/thetvdb/TheTVDBApiFactoryTest.java

@@ -63,13 +63,27 @@ void createQueryParameters_withValidParameterMap_verifyQueryParameters() {
     }
 
     @Test
-    void createProxy_withValidSettings_verifyProxySettings() {
+    void createProxy_withoutPath_verifyProxySettings() {
         final String protocol = "https";
-        final String host = "sub.proxy.com";
+        final String host = "sub1.proxy.com";
         final int port = 9584;
         Proxy proxy = TheTVDBApiFactory.createProxy(protocol, host, port);
         assertThat(proxy.getProtocol()).isEqualTo(protocol);
         assertThat(proxy.getHost()).isEqualTo(host);
+        assertThat(proxy.getPath()).isEmpty();
+        assertThat(proxy.getPort()).isEqualTo(port);
+    }
+
+    @Test
+    void createProxy_withPath_verifyProxySettings() {
+        final String protocol = "https";
+        final String host = "sub2.proxy.com";
+        final String path = "/path";
+        final int port = 6487;
+        Proxy proxy = TheTVDBApiFactory.createProxy(protocol, host, path, port);
+        assertThat(proxy.getProtocol()).isEqualTo(protocol);
+        assertThat(proxy.getHost()).isEqualTo(host);
+        assertThat(proxy.getPath()).contains(path);
         assertThat(proxy.getPort()).isEqualTo(port);
     }
 }

src/test/java/com/github/m0nk3y2k4/thetvdb/internal/connection/RemoteAPITest.java

@@ -51,10 +51,20 @@ void buildNewRemoteAPI_withSpecificOrDefaultSettings_verifyAPISettings(RemoteAPI
     }
 
     @Test
-    void forResource() throws Exception {
+    void forResource_withoutPath_checkUrl() throws Exception {
         final URL remote = new URL("http", "localhost", 3654, "/someRemoteResource");
         URL url = new RemoteAPI.Builder().protocol(remote.getProtocol()).host(remote.getHost()).port(remote.getPort())
                 .build().forResource(remote.getFile());
         assertThat(url).isEqualTo(remote);
     }
+
+    @Test
+    void forResource_withPath_checkUrl() throws Exception {
+        final String path = "/path";
+        final String resource = "/someRemoteResource";
+        final URL remote = new URL("http", "localhost", 3654, path + resource);
+        URL url = new RemoteAPI.Builder().protocol(remote.getProtocol()).host(remote.getHost()).path(path)
+                .port(remote.getPort()).build().forResource(resource);
+        assertThat(url).isEqualTo(remote);
+    }
 }