Merge pull request #3 from vimeo/update-logging-methods

Update logging methods usage in subscriber

Author: JCManzo

README.md

@@ -4,14 +4,15 @@ These events are dispatched via the HTTP client's `EventDispatcherInterface`.
 For example in the gateway's `sendData()` methods we can do:
 
     ```PHP
+    $request_name; // The name of the API endpoint being called
     $event_dispatcher = $this->httpClient->getEventDispatcher();
-    $event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_BEFORE_SEND, new RequestEvent($request));
+    $event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_BEFORE_SEND, new RequestEvent($request, $request_name));
     ```
 
     Logging Errors and Responses events can be emitted like so
     ```PHP
-    $event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_ERROR new ErrorEvent($exception));
-    $event_dispatcher->dispatch(Constants::OMNIPAY_RESPONSE_SUCCESS, new ResponseEvent($response));
+    $event_dispatcher->dispatch(Constants::OMNIPAY_REQUEST_ERROR new ErrorEvent($exception', $request_name));
+    $event_dispatcher->dispatch(Constants::OMNIPAY_RESPONSE_SUCCESS, new ResponseEvent($response, $request_name));
     ```
 
 `OmnipayGatewayRequestSubscriber.php` takes in a logger of type `LoggerInterface` which will listen to and log these events.
@@ -22,5 +23,5 @@ The subscriber can be set up  to listen to these events when instantiating the H
 $httpClient = new GuzzleClient();
 $gateway = Omnipay::create('Vindicia', $httpClient);
 $eventDispatcher = $httpClient->getEventDispatcher();
-$eventDispatcher->addSubscriber(new OmnipayGatewayRequestSubscriber($gateway_name, new LoggerClassThatImplementsInterface()));
+$eventDispatcher->addSubscriber(new OmnipayGatewayRequestSubscriber($gateway_name, new LoggerClassThatImplementsPSRInterface()));
 ```

src/Event/ErrorEvent.php

@@ -14,27 +14,13 @@
 
 class ErrorEvent extends Event
 {
-    /**
-     * @var Exception
-     */
-    protected $error;
-
     /**
      * @param Exception $error
+     * @param string    $request_name
      */
-    public function __construct($error)
-    {
-        $this->error = $error;
-
-        parent::__construct(array('error' => $error));
-    }
-
-    /**
-     * @return Exception
-     */
-    public function getContext()
+    public function __construct($error, $request_name)
     {
-        return $this->error;
+        parent::__construct(array('error' => $error, 'request_name' => $request_name));
     }
 
     /**

src/Event/RequestEvent.php

@@ -14,27 +14,13 @@
 
 class RequestEvent extends Event
 {
-    /**
-     * @var RequestInterface
-     */
-    protected $request;
-
     /**
      * @param RequestInterface $request
+     * @param string           $request_name
      */
-    public function __construct($request)
-    {
-        $this->request = $request;
-
-        parent::__construct(array('request' => $request));
-    }
-
-    /**
-     * @return RequestInterface
-     */
-    public function getContext()
+    public function __construct($request, $request_name)
     {
-        return $this->request;
+        parent::__construct(array('request' => $request, 'request_name' => $request_name));
     }
 
     /**

src/Event/ResponseEvent.php

@@ -14,27 +14,13 @@
 
 class ResponseEvent extends Event
 {
-    /**
-     * @var ResponseInterface
-     */
-    protected $response;
-
     /**
      * @param ResponseInterface $response
+     * @param string            $request_name
      */
-    public function __construct($response)
-    {
-        $this->response = $response;
-
-        parent::__construct(array('response' => $response));
-    }
-
-    /**
-     * @return ResponseInterface
-     */
-    public function getContext()
+    public function __construct($response, $request_name)
     {
-        return $this->response;
+        parent::__construct(array('response' => $response, 'request_name' => $request_name));
     }
 
     /**

src/Event/Subscriber/OmnipayGatewayRequestSubscriber.php

@@ -12,7 +12,6 @@
 use Guzzle\Common\Event;
 use PaymentGatewayLogger\Event\Constants;
 use Psr\Log\LoggerInterface;
-use Psr\Log\LogLevel;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class OmnipayGatewayRequestSubscriber implements EventSubscriberInterface
@@ -80,7 +79,7 @@ public static function getSubscribedEvents()
      */
     public function onOmnipayRequestBeforeSend(Event $event)
     {
-        $this->logger->log(LogLevel::INFO, $this->gateway_name, $event->toArray());
+        $this->logger->info($this->gateway_name, $event->toArray());
     }
 
     /**
@@ -95,7 +94,7 @@ public function onOmnipayRequestBeforeSend(Event $event)
      */
     public function onOmnipayResponseSuccess(Event $event)
     {
-        $this->logger->log(LogLevel::INFO, $this->gateway_name, $event->toArray());
+        $this->logger->notice($this->gateway_name, $event->toArray());
     }
 
     /**
@@ -110,6 +109,6 @@ public function onOmnipayResponseSuccess(Event $event)
      */
     public function onOmnipayRequestError(Event $event)
     {
-        $this->logger->log(LogLevel::ERROR, $this->gateway_name, $event->toArray());
+        $this->logger->error($this->gateway_name, $event->toArray());
     }
 }

tests/OmnipayGatewayRequestSubscriberTest.php

@@ -3,8 +3,8 @@
 namespace PaymentGatewayLogger;
 
 use Exception;
-use InvalidArgumentException;
 use Guzzle\Common\Event;
+use InvalidArgumentException;
 use Guzzle\Http\Client;
 use Mockery;
 use Omnipay\Common\Message\RequestInterface;
@@ -42,6 +42,11 @@ class OmnipayGatewayRequestSubscriberTest extends TestCase
      */
     private $logger;
 
+    /**
+     * @var string
+     */
+    private $requestName = 'test_request_name';
+
     /**
      * @return void
      */
@@ -51,7 +56,6 @@ protected function setUp()
         $this->eventDispatcher = $httpClient->getEventDispatcher();
         $this->logger = new TestLogger();
         $this->subscriber = new OmnipayGatewayRequestSubscriber('test', $this->logger);
-
         parent::setUp();
     }
 
@@ -69,17 +73,17 @@ public function providerLoggingEvents()
         /** @var Exception $exception */
         $exception = Mockery::mock('Exception');
 
-        $requestEvent = new RequestEvent($request);
-        $responseEvent = new ResponseEvent($response);
-        $errorEvent = new ErrorEvent($exception);
+        $requestEvent = new RequestEvent($request, $this->requestName);
+        $responseEvent = new ResponseEvent($response, $this->requestName);
+        $errorEvent = new ErrorEvent($exception, $this->requestName);
 
         $requestRecord = array(
             'level' => LogLevel::INFO,
             'message' => 'omnipay_test',
             'context' => $requestEvent->toArray(),
         );
         $responseRecord = array(
-            'level' => LogLevel::INFO,
+            'level' => LogLevel::NOTICE,
             'message' => 'omnipay_test',
             'context' => $responseEvent->toArray(),
         );
@@ -111,10 +115,19 @@ public function testLogging($event_type, $event, array $record)
         $this->eventDispatcher->addSubscriber($this->subscriber);
         $this->eventDispatcher->dispatch($event_type, $event);
 
+        $context = $event->toArray();
+        $this->assertEquals($this->requestName, $context['request_name']);
+
         if ($record['level'] === LogLevel::INFO) {
+            $this->assertInstanceOf('Omnipay\Common\Message\RequestInterface', $context['request']);
             $this->assertTrue($this->logger->hasInfoRecords());
             $this->assertTrue($this->logger->hasInfo($record));
+        } else if ($record['level'] === LogLevel::NOTICE) {
+            $this->assertInstanceOf('Omnipay\Common\Message\ResponseInterface', $context['response']);
+            $this->assertTrue($this->logger->hasNoticeRecords());
+            $this->assertTrue($this->logger->hasNotice($record));
         } else if ($record['level'] === LogLevel::ERROR) {
+            $this->assertInstanceOf('\Exception', $context['error']);
             $this->assertTrue($this->logger->hasErrorRecords());
             $this->assertTrue($this->logger->hasError($record));
         } else {