Merge pull request #58 from sergej-koscejev/master

Add interfaces for incoming notifications

Author: greydnls

src/Omnipay/Common/AbstractGateway.php

@@ -247,6 +247,16 @@ public function supportsVoid()
         return method_exists($this, 'void');
     }
 
+    /**
+     * Supports AcceptNotification
+     *
+     * @return boolean True if this gateway supports the acceptNotification() method
+     */
+    public function supportsAcceptNotification()
+    {
+        return method_exists($this, 'acceptNotification');
+    }
+
     /**
      * Supports CreateCard
      *

src/Omnipay/Common/Message/NotificationInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Omnipay\Common\Message;
+
+/**
+ * Incoming notification
+ */
+interface NotificationInterface extends MessageInterface
+{
+    const STATUS_COMPLETED = 'completed';
+    const STATUS_PENDING = 'pending';
+    const STATUS_FAILED = 'failed';
+
+    /**
+     * Gateway Reference
+     *
+     * @return string A reference provided by the gateway to represent this transaction
+     */
+    public function getTransactionReference();
+
+    /**
+     * Was the transaction successful?
+     *
+     * @return string Transaction status, one of {@see STATUS_COMPLETED}, {@see #STATUS_PENDING},
+     * or {@see #STATUS_FAILED}.
+     */
+    public function getTransactionStatus();
+
+    /**
+     * Response Message
+     *
+     * @return string A response message from the payment gateway
+     */
+    public function getMessage();
+}

tests/Omnipay/Common/AbstractGatewayTest.php

@@ -133,6 +133,11 @@ public function testSupportsUpdateCard()
         $this->assertFalse($this->gateway->supportsUpdateCard());
     }
 
+    public function testSupportsAcceptNotification()
+    {
+        $this->assertFalse($this->gateway->supportsAcceptNotification());
+    }
+
     public function testCreateRequest()
     {
         $this->gateway = new AbstractGatewayTest_MockAbstractGateway;