Make Testing classes easier

phpcs.xml

@@ -4,5 +4,7 @@
     <exclude-pattern>*/vendor/*</exclude-pattern>
     <arg name="colors" />
     <arg value="p" />
-    <rule ref="PSR12" />
+    <rule ref="PSR12" >
+        <exclude name="PSR12.Properties.ConstantVisibility.NotFound" />
+    </rule>
 </ruleset>

src/Databases/AbstractNetAcuityDatabase.php

@@ -2,8 +2,8 @@
 
 namespace TraderInteractive\NetAcuity\Databases;
 
+use TraderInteractive\NetAcuity\Exceptions\NetacuityException;
 use TraderInteractive\Util\Arrays;
-use Exception;
 use GuzzleHttp\ClientInterface;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Psr7\Request;
@@ -13,6 +13,12 @@
  */
 abstract class AbstractNetAcuityDatabase implements NetAcuityDatabaseInterface
 {
+    /**
+     * @var string
+     * @internal
+     */
+    const DEFAULT_NETACUITY_BASE_URL = 'https://usa.cloud.netacuity.com/webservice/query';
+
     /**
      * @var ClientInterface The GuzzleHttp Client.
      */
@@ -23,6 +29,11 @@ abstract class AbstractNetAcuityDatabase implements NetAcuityDatabaseInterface
      */
     protected $translations;
 
+    /**
+     * @var string
+     */
+    protected $netacuityBaseUrl;
+
     /**
      * @var string The API User Token.
      */
@@ -36,23 +47,26 @@ abstract class AbstractNetAcuityDatabase implements NetAcuityDatabaseInterface
     /**
      * AbstractNetAcuityDatabase constructor.
      *
-     * @param ClientInterface $client       The injected GuzzleHttp Client.
-     * @param string          $apiUserToken The Net Acuity API User Token.
+     * @param ClientInterface $client           The injected GuzzleHttp Client.
+     * @param string          $apiUserToken     The Net Acuity API User Token.
+     * @param string          $netacuityBaseUrl The base url for the netacuity webservice.
      */
     public function __construct(
         ClientInterface $client,
-        string $apiUserToken
+        string $apiUserToken,
+        string $netacuityBaseUrl
     ) {
         $this->client = $client;
         $this->apiUserToken = $apiUserToken;
+        $this->netacuityBaseUrl = $netacuityBaseUrl;
     }
 
     /**
      * @param string $ip The IP to fetch the result data set for.
      *
      * @return array The formatted data set.
      *
-     * @throws Exception On failure to send a Guzzle request.
+     * @throws NetacuityException On failure to send a Guzzle request.
      */
     public function fetch(string $ip)
     {
@@ -73,7 +87,7 @@ public function fetch(string $ip)
     /**
      * @param ClientException $e The thrown exception for handling.
      *
-     * @throws Exception A formatted exception masking the API User Token in the event that it becomes invalid.
+     * @throws NetacuityException A formatted exception masking the API User Token in the event that it becomes invalid.
      *
      * @return void
      */
@@ -83,13 +97,13 @@ protected function handleGuzzleException(ClientException $e)
         $code = $response->getStatusCode();
 
         if ($code === 403) {
-            throw new Exception('NetAcuity API rejected the provided api user token.', $code);
+            throw new NetacuityException('NetAcuity API rejected the provided api user token.', $code);
         }
 
         $error = json_decode($response->getBody()->getContents(), true);
         $reason = Arrays::getNested($error, 'error.message');
 
-        throw new Exception("NetAcuity API rejected the request, Reason: {$reason}", $code);
+        throw new NetacuityException("NetAcuity API rejected the request, Reason: {$reason}", $code);
     }
 
     /**
@@ -117,7 +131,6 @@ protected function parseBody(array $response)
      */
     protected function buildQuery(string $userToken, string $ip): string
     {
-        $baseUrl = 'https://usa.cloud.netacuity.com/webservice/query';
-        return "{$baseUrl}?u={$userToken}&dbs={$this->databaseIdentifier}&ip={$ip}&json=true";
+        return "{$this->netacuityBaseUrl}?u={$userToken}&dbs={$this->databaseIdentifier}&ip={$ip}&json=true";
     }
 }

src/Databases/EdgeDatabase.php

@@ -12,12 +12,16 @@ final class EdgeDatabase extends AbstractNetAcuityDatabase
     /**
      * EdgeDatabase constructor.
      *
-     * @param ClientInterface $client       The injected GuzzleHttp Client.
-     * @param string          $apiUserToken The Net Acuity API User Token.
+     * @param ClientInterface $client           The injected GuzzleHttp Client.
+     * @param string          $apiUserToken     The Net Acuity API User Token.
+     * @param string          $netacuityBaseUrl The base url for the netacuity webservice.
      */
-    public function __construct(ClientInterface $client, string $apiUserToken)
-    {
-        parent::__construct($client, $apiUserToken);
+    public function __construct(
+        ClientInterface $client,
+        string $apiUserToken,
+        string $netacuityBaseUrl = self::DEFAULT_NETACUITY_BASE_URL
+    ) {
+        parent::__construct($client, $apiUserToken, $netacuityBaseUrl);
 
         $this->databaseIdentifier = 4;
 

src/Databases/PulseDatabase.php

@@ -6,9 +6,17 @@
 
 class PulseDatabase extends AbstractNetAcuityDatabase
 {
-    public function __construct(ClientInterface $client, string $apiUserToken)
-    {
-        parent::__construct($client, $apiUserToken);
+    /**
+     * @param ClientInterface $client           The injected GuzzleHttp Client.
+     * @param string          $apiUserToken     The Net Acuity API User Token.
+     * @param string          $netacuityBaseUrl The base url for the netacuity webservice.
+     */
+    public function __construct(
+        ClientInterface $client,
+        string $apiUserToken,
+        string $netacuityBaseUrl = self::DEFAULT_NETACUITY_BASE_URL
+    ) {
+        parent::__construct($client, $apiUserToken, $netacuityBaseUrl);
 
         $this->databaseIdentifier = 26;
 

src/Exceptions/NetacuityException.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace TraderInteractive\NetAcuity\Exceptions;
+
+use Exception;
+
+class NetacuityException extends Exception
+{
+}

tests/Databases/AbstractNetAcuityDatabaseTest.php

@@ -3,6 +3,7 @@
 namespace TraderInteractive\NetAcuity\Databases\Tests;
 
 use TraderInteractive\NetAcuity\Databases\EdgeDatabase;
+use TraderInteractive\NetAcuity\Exceptions\NetacuityException;
 use TraderInteractive\NetAcuity\Tests\NetAcuityTestSuite;
 use Exception;
 
@@ -154,6 +155,7 @@ public function getGeoWithExtraFieldEdge()
      */
     public function getGeoNonStringIp()
     {
+        $this->expectException(NetacuityException::class);
         $this->expectExceptionMessage('NetAcuity API rejected the request, Reason: Invalid IP (1)');
         $this->expectExceptionCode(400);
 
@@ -171,6 +173,7 @@ public function getGeoNonStringIp()
      */
     public function netAcuityUserTokenInvalid()
     {
+        $this->expectException(NetacuityException::class);
         $this->expectExceptionMessage('NetAcuity API rejected the provided api user token.');
         $this->expectExceptionCode(403);