Host & port parsing

Author: adamw

core/src/main/scala/sttp/model/headers/Forwarded.scala

@@ -8,7 +8,7 @@ case class Forwarded(by: Option[String], `for`: Option[String], host: Option[Str
   /** Serialize a single [[Forwarded]] header to a string
     *
     * @see
-    *   [[Forwarded#toString]] for a multi-header variant
+    *   [[Forwarded.toString]] for a multi-header variant
     */
   override def toString: String = {
     val sb = new java.lang.StringBuilder()

core/src/main/scala/sttp/model/headers/Host.scala

@@ -0,0 +1,29 @@
+package sttp.model.headers
+
+import sttp.model.internal.ParseUtils
+
+object Host {
+
+  /** Parses the given string into a host and an optional port. If the host is an IPv6 address, the surrounding `[` and
+    * `]` characters are removed. If the port is not a number, it is discarded.
+    *
+    * For example, `example.com:8080` will be parsed into `("example.com", Some(8080))`.
+    */
+  def parseHostAndPort(v: String): (String, Option[Int]) = {
+    val lastColonIndex = v.lastIndexOf(":")
+    val lastBracketIndex = v.lastIndexOf("]") // checking if the last colon is part of an IPv6 address
+    val (host, port) =
+      if (lastColonIndex == -1 || lastBracketIndex > lastColonIndex) (v, None)
+      else {
+        (v.substring(0, lastColonIndex), ParseUtils.toIntOption(v.substring(lastColonIndex + 1)))
+      }
+
+    val hostWithoutBrackets = if (host.startsWith("[") && host.endsWith("]")) {
+      host.substring(1, host.length - 1)
+    } else {
+      host
+    }
+
+    (hostWithoutBrackets, port)
+  }
+}

core/src/test/scala/sttp/model/headers/HostTest.scala

@@ -0,0 +1,31 @@
+package sttp.model.headers
+
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+class HostTest extends AnyFlatSpec with Matchers {
+  it should "parse host and port" in {
+    Host.parseHostAndPort("example.com:8080") shouldBe (("example.com", Some(8080)))
+  }
+
+  it should "parse host without port" in {
+    Host.parseHostAndPort("example.com") shouldBe (("example.com", None))
+  }
+
+  it should "parse IPv4 address with port" in {
+    Host.parseHostAndPort("192.168.1.1:8080") shouldBe (("192.168.1.1", Some(8080)))
+  }
+
+  it should "parse IPv4 address without port" in {
+    Host.parseHostAndPort("192.168.1.1") shouldBe (("192.168.1.1", None))
+  }
+
+  it should "parse IPv6 address with port" in {
+    Host.parseHostAndPort("[2001:db8::1]:8080") shouldBe (("2001:db8::1", Some(8080)))
+  }
+
+  it should "parse IPv6 address without port" in {
+    Host.parseHostAndPort("[2001:db8::1]") shouldBe (("2001:db8::1", None))
+  }
+
+}