Make UserAgentWire configurable

jcabi · Jun 25, 2021 · 771cf34 · 771cf34
1 parent 357ce43
commit 771cf34
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 18 deletions.
diff --git a/src/main/java/com/jcabi/http/wire/UserAgentWire.java b/src/main/java/com/jcabi/http/wire/UserAgentWire.java
@@ -42,6 +42,7 @@
 import java.util.Map;
 import javax.ws.rs.core.HttpHeaders;
 import lombok.EqualsAndHashCode;
+import lombok.RequiredArgsConstructor;
 import lombok.ToString;
 
 /**
@@ -69,29 +70,33 @@
 @Immutable
 @ToString(of = "origin")
 @EqualsAndHashCode(of = "origin")
+@RequiredArgsConstructor
 public final class UserAgentWire implements Wire {
 
     /**
-     * Default user agent.
+     * Original wire.
      */
-    private static final String AGENT = String.format(
-        "jcabi-%s/%s Java/%s",
-        Manifests.read("JCabi-Version"),
-        Manifests.read("JCabi-Build"),
-        System.getProperty("java.version")
-    );
+    private final Wire origin;
 
     /**
-     * Original wire.
+     * Agent.
      */
-    private final transient Wire origin;
+    private final String agent;
 
     /**
      * Public ctor.
      * @param wire Original wire
      */
     public UserAgentWire(final Wire wire) {
-        this.origin = wire;
+        this(
+            wire,
+            String.format(
+                "jcabi-%s/%s Java/%s",
+                Manifests.read("JCabi-Version"),
+                Manifests.read("JCabi-Build"),
+                System.getProperty("java.version")
+            )
+        );
     }
 
     // @checkstyle ParameterNumber (7 lines)
@@ -115,7 +120,7 @@ public Response send(final Request req, final String home,
             hdrs.add(
                 new ImmutableHeader(
                     HttpHeaders.USER_AGENT,
-                    UserAgentWire.AGENT
+                    this.agent
                 )
             );
         }

diff --git a/src/test/java/com/jcabi/http/wire/UserAgentWireTest.java b/src/test/java/com/jcabi/http/wire/UserAgentWireTest.java
@@ -44,14 +44,10 @@
  * Test case for {@link UserAgentWire}.
  * @since 1.2
  */
-public final class UserAgentWireTest {
+final class UserAgentWireTest {
 
-    /**
-     * UserAgentWire can add User-Agent HTTP header.
-     * @throws Exception If something goes wrong inside
-     */
     @Test
-    void addsUserAgentHeader() throws Exception {
+    void addsDefaultUserAgentHeader() throws Exception {
         final MkContainer container = new MkGrizzlyContainer().next(
             new MkAnswer.Simple("")
         ).start();
@@ -62,8 +58,36 @@ void addsUserAgentHeader() throws Exception {
             .assertStatus(HttpURLConnection.HTTP_OK);
         container.stop();
         MatcherAssert.assertThat(
+            "must add default User-Agent HTTP header",
             container.take().headers(),
-            Matchers.hasKey(HttpHeaders.USER_AGENT)
+            Matchers.hasEntry(
+                Matchers.is(HttpHeaders.USER_AGENT),
+                Matchers.contains(
+                    Matchers.startsWith("jcabi-")
+                )
+            )
+        );
+    }
+
+    @Test
+    void addsCustomUserAgentHeader() throws Exception {
+        final MkContainer container = new MkGrizzlyContainer().next(
+            new MkAnswer.Simple("")
+        ).start();
+        final String agent = "Mozilla/5.0";
+        new JdkRequest(container.home())
+            .through(UserAgentWire.class, agent)
+            .fetch()
+            .as(RestResponse.class)
+            .assertStatus(HttpURLConnection.HTTP_OK);
+        container.stop();
+        MatcherAssert.assertThat(
+            "must add custom User-Agent HTTP header",
+            container.take().headers(),
+            Matchers.hasEntry(
+                Matchers.is(HttpHeaders.USER_AGENT),
+                Matchers.contains(agent)
+            )
         );
     }