Check IP address before making WS request

Author: oschwald

CHANGELOG.md

@@ -1,6 +1,14 @@
 CHANGELOG
 =========
 
+3.0.0
+-------------------
+
+* `GeoIp2\WebService\Client` methods now throw an `InvalidArgumentException`
+  if an invalid IP address is passed to them. Previously, they would make
+  a request to the web service and throw a
+  `GeoIp2\Exception\InvalidRequestException`.
+
 2.13.0 (2022-08-05)
 -------------------
 

src/WebService/Client.php

@@ -135,6 +135,8 @@ private function userAgent(): string
      * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
      *                                           class to the above exceptions. It will be thrown directly
      *                                           if a 200 status code is returned but the body is invalid.
+     * @throws \InvalidArgumentException         if something other than a single IP address or "me" is
+     *                                           passed to the method
      */
     public function city(string $ipAddress = 'me'): City
     {
@@ -165,6 +167,8 @@ public function city(string $ipAddress = 'me'): City
      * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent class to the above exceptions. It
      *                                           will be thrown directly if a 200 status code is returned but
      *                                           the body is invalid.
+     * @throws \InvalidArgumentException         if something other than a single IP address or "me" is
+     *                                           passed to the method
      */
     public function country(string $ipAddress = 'me'): Country
     {
@@ -195,6 +199,8 @@ public function country(string $ipAddress = 'me'): Country
      * @throws \GeoIp2\Exception\GeoIp2Exception This serves as the parent
      *                                           class to the above exceptions. It will be thrown directly
      *                                           if a 200 status code is returned but the body is invalid.
+     * @throws \InvalidArgumentException         if something other than a single IP address or "me" is
+     *                                           passed to the method
      */
     public function insights(string $ipAddress = 'me'): Insights
     {
@@ -204,6 +210,11 @@ public function insights(string $ipAddress = 'me'): Insights
 
     private function responseFor(string $endpoint, string $class, string $ipAddress): Country
     {
+        if ($ipAddress !== 'me' && !filter_var($ipAddress, \FILTER_VALIDATE_IP)) {
+            throw new \InvalidArgumentException(
+                "The value \"$ipAddress\" is not a valid IP address."
+            );
+        }
         $path = implode('/', [self::$basePath, $endpoint, $ipAddress]);
 
         try {

tests/GeoIp2/Test/WebService/ClientTest.php

@@ -67,7 +67,7 @@ private function getResponse(string $service, string $ipAddress): array
             ),
             '1.2.3.5' => $this->response('country', 200),
             '2.2.3.5' => $this->response('country', 200, 'bad body'),
-            '1.2.3.6' => $this->response(
+            '1.2.3' => $this->response(
                 'error',
                 400,
                 [
@@ -316,11 +316,10 @@ public function testBadBodyException(): void
 
     public function testInvalidIPException(): void
     {
-        $this->expectException(\GeoIp2\Exception\InvalidRequestException::class);
-        $this->expectExceptionCode(400);
-        $this->expectExceptionMessage('The value "1.2.3" is not a valid ip address');
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('The value "1.2.3" is not a valid IP address');
 
-        $this->makeRequest('Country', '1.2.3.6');
+        $this->makeRequest('Country', '1.2.3', callsToRequest: 0);
     }
 
     public function testNoErrorBodyIPException(): void