Merge pull request #117 from thomasvargiu/feature/events-on-login

EventMask parameter on login action

Author: marcelog

src/PAMI/Client/Impl/ClientImpl.php

@@ -34,9 +34,7 @@
 use PAMI\Message\Message;
 use PAMI\Message\IncomingMessage;
 use PAMI\Message\Action\LoginAction;
-use PAMI\Message\Action\LogoffAction;
 use PAMI\Message\Response\ResponseMessage;
-use PAMI\Message\Event\EventMessage;
 use PAMI\Message\Event\Factory\Impl\EventFactoryImpl;
 use PAMI\Listener\IEventListener;
 use PAMI\Client\Exception\ClientException;
@@ -60,7 +58,7 @@ class ClientImpl implements IClient
 {
     /**
      * PSR-3 logger.
-     * @var Logger
+     * @var LoggerInterface
      */
     private $logger;
 
@@ -150,6 +148,12 @@ class ClientImpl implements IClient
      */
     private $lastActionId;
 
+    /**
+     * Event mask to apply on login action.
+     * @var string|null
+     */
+    private $eventMask;
+
     /**
      * Opens a tcp connection to ami.
      *
@@ -173,7 +177,7 @@ public function open()
         if ($this->socket === false) {
             throw new ClientException('Error connecting to ami: ' . $errstr);
         }
-        $msg = new LoginAction($this->user, $this->pass);
+        $msg = new LoginAction($this->user, $this->pass, $this->eventMask);
         $asteriskId = @stream_get_line($this->socket, 1024, Message::EOL);
         if (strstr($asteriskId, 'Asterisk') === false) {
             throw new ClientException(
@@ -434,7 +438,7 @@ public function close()
     /**
      * Sets the logger implementation.
      *
-     * @param Psr\Log\LoggerInterface $logger The PSR3-Logger
+     * @param LoggerInterface $logger The PSR3-Logger
      *
      * @return void
      */
@@ -453,12 +457,13 @@ public function __construct(array $options)
     {
         $this->logger = new NullLogger;
         $this->host = $options['host'];
-        $this->port = intval($options['port']);
+        $this->port = (int) $options['port'];
         $this->user = $options['username'];
         $this->pass = $options['secret'];
         $this->cTimeout = $options['connect_timeout'];
         $this->rTimeout = $options['read_timeout'];
         $this->scheme = isset($options['scheme']) ? $options['scheme'] : 'tcp://';
+        $this->eventMask = isset($options['event_mask']) ? $options['event_mask'] : null;
         $this->eventListeners = array();
         $this->eventFactory = new EventFactoryImpl();
         $this->incomingQueue = array();

src/PAMI/Message/Action/LoginAction.php

@@ -46,15 +46,20 @@ class LoginAction extends ActionMessage
     /**
      * Constructor.
      *
-     * @param string $user     AMI username.
+     * @param string $user AMI username.
      * @param string $password AMI password.
+     * @param string|null $eventMask
      *
      * @return void
      */
-    public function __construct($user, $password)
+    public function __construct($user, $password, $eventMask = null)
     {
         parent::__construct('Login');
         $this->setKey('Username', $user);
         $this->setKey('Secret', $password);
+
+        if (null !== $eventMask) {
+            $this->setKey('Events', $eventMask);
+        }
     }
 }

test/actions/Test_Actions.php

@@ -108,6 +108,37 @@ public function can_absolute_timeout()
         $action = new \PAMI\Message\Action\AbsoluteTimeoutAction('SIP/asd', 10);
         $client = $this->_start($write, $action);
     }
+    /**
+     * @test
+     */
+    public function can_login()
+    {
+        $write = array(implode("\r\n", array(
+            'action: Login',
+            'actionid: 1432.123',
+            'username: foo',
+            'secret: bar',
+            ''
+        )));
+        $action = new \PAMI\Message\Action\LoginAction('foo', 'bar');
+        $client = $this->_start($write, $action);
+    }
+    /**
+     * @test
+     */
+    public function can_login_with_events()
+    {
+        $write = array(implode("\r\n", array(
+            'action: Login',
+            'actionid: 1432.123',
+            'username: foo',
+            'secret: bar',
+            'events: all',
+            ''
+        )));
+        $action = new \PAMI\Message\Action\LoginAction('foo', 'bar', 'all');
+        $client = $this->_start($write, $action);
+    }
     /**
      * @test
      */