Add Logger interface into API provider

webeweb · Aug 7, 2019 · 4f52201 · 4f52201
1 parent 8bec5b8
commit 4f52201
Show file tree

Hide file tree

Showing 5 changed files with 67 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+### [2.1.0](https://github.com/webeweb/haveibeenpwned-library/tree/v2.1.0) (2019-08-07)
+
+- Add Logger interface into API provider
+
 ### [2.0.1](https://github.com/webeweb/haveibeenpwned-library/tree/v2.0.1) (2019-08-01)
 
 - Optimize API v3 calls

diff --git a/composer.json b/composer.json
@@ -21,6 +21,7 @@
         "php": "^5.6|^7.0",
         "ext-json": "*",
         "guzzlehttp/guzzle": "^6.0",
+        "psr/log": "^1.0",
         "webeweb/core-library": "^5.0"
     },
     "require-dev": {

diff --git a/src/Provider/APIv3Provider.php b/src/Provider/APIv3Provider.php
@@ -12,6 +12,7 @@
 namespace WBW\Library\HaveIBeenPwned\Provider;
 
 use InvalidArgumentException;
+use Psr\Log\LoggerInterface;
 use WBW\Library\HaveIBeenPwned\Exception\APIException;
 use WBW\Library\HaveIBeenPwned\Model\Request\BreachedAccountRequest;
 use WBW\Library\HaveIBeenPwned\Model\Request\BreachesRequest;
@@ -45,9 +46,10 @@ class APIv3Provider extends AbstractProvider {
      * Constructor.
      *
      * @param string|null $apiKey The API key.
+     * @param LoggerInterface|null $logger The logger.
      */
-    public function __construct($apiKey = null) {
-        parent::__construct();
+    public function __construct($apiKey = null, LoggerInterface $logger = null) {
+        parent::__construct($logger);
         $this->setApiKey($apiKey);
     }
 

diff --git a/src/Provider/AbstractProvider.php b/src/Provider/AbstractProvider.php
@@ -15,6 +15,7 @@
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
 use InvalidArgumentException;
+use Psr\Log\LoggerInterface;
 use WBW\Library\HaveIBeenPwned\API\SubstituteRequestInterface;
 use WBW\Library\HaveIBeenPwned\Exception\APIException;
 use WBW\Library\HaveIBeenPwned\Model\AbstractRequest;
@@ -42,11 +43,21 @@ abstract class AbstractProvider {
      */
     private $debug;
 
+    /**
+     * Logger.
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * Constructor.
+     *
+     * @param LoggerInterface|null $logger The logger.
      */
-    public function __construct() {
+    public function __construct(LoggerInterface $logger = null) {
         $this->setDebug(false);
+        $this->setLogger($logger);
     }
 
     /**
@@ -112,14 +123,19 @@ protected function callAPI(AbstractRequest $request, array $queryData, $endpoint
 
             $host = null === $endpointPath ? self::ENDPOINT_PATH . $this->getEndpointVersion() : $endpointPath;
 
-            $client = new Client($this->buildConfiguration($host, $apiKey));
+            $config = $this->buildConfiguration($host, $apiKey);
+
+            $client = new Client($config);
 
+            $method  = "GET";
             $uri     = substr($this->buildResourcePath($request), 1);
             $options = [
                 "query" => $queryData,
             ];
 
-            $response = $client->request("GET", $uri, $options);
+            $this->log(sprintf("Call HaveIBeenPwned API %s %s", $method, $uri), ["config" => $config, "options" => $options]);
+
+            $response = $client->request($method, $uri, $options);
 
             return $response->getBody()->getContents();
         } catch (InvalidArgumentException $ex) {
@@ -151,6 +167,29 @@ public function getDebug() {
      */
     abstract public function getEndpointVersion();
 
+    /**
+     * Get the logger.
+     *
+     * @return LoggerInterface Returns the logger.
+     */
+    public function getLogger() {
+        return $this->logger;
+    }
+
+    /**
+     * Log.
+     *
+     * @param string $message The message.
+     * @param array $context The context.
+     * @return AbstractProvider Returns this provider.
+     */
+    protected function log($message, array $context) {
+        if (null !== $this->getLogger()) {
+            $this->getLogger()->info($message, $context);
+        }
+        return $this;
+    }
+
     /**
      * Set the debug.
      *
@@ -161,4 +200,15 @@ public function setDebug($debug) {
         $this->debug = $debug;
         return $this;
     }
+
+    /**
+     * Set the logger.
+     *
+     * @param LoggerInterface|null $logger The logger
+     * @return AbstractProvider Returns this provider
+     */
+    protected function setLogger(LoggerInterface $logger = null) {
+        $this->logger = $logger;
+        return $this;
+    }
 }
diff --git a/tests/Provider/APIv1ProviderTest.php b/tests/Provider/APIv1ProviderTest.php
@@ -13,6 +13,7 @@
 
 use Exception;
 use InvalidArgumentException;
+use Psr\Log\LoggerInterface;
 use WBW\Library\HaveIBeenPwned\Exception\APIException;
 use WBW\Library\HaveIBeenPwned\Model\Request\BreachedAccountRequest;
 use WBW\Library\HaveIBeenPwned\Model\Response\BreachesResponse;
@@ -43,11 +44,14 @@ protected function setUp() {
      */
     public function testBreachedAccount() {
 
+        // Set a Logger mock.
+        $logger = $this->getMockBuilder(LoggerInterface::class)->getMock();
+
         // Set a Breached account request mock.
         $breachedAccountRequest = new BreachedAccountRequest();
         $breachedAccountRequest->setAccount("john.doe@gmail.com");
 
-        $obj = new APIv1Provider();
+        $obj = new APIv1Provider($logger);
 
         try {