Merge branch 'actionid' into collector

Author: clue

CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+This file is a manually maintained list of changes for each release. Feel free
+to add your changes here when sending pull requests. Also send corrections if
+you spot any mistakes.
+
+## 0.0.0 (2014-06-25)
+
+* Initial concept

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Christian Lück
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# clue/asterisk-ami-react [![Build Status](https://travis-ci.org/clue/reactphp-asterisk-ami.png?branch=master)](https://travis-ci.org/clue/reactphp-asterisk-ami)
+
+Simple async, event-driven access to the Asterisk Manager Interface (AMI)
+
+> Note: This project is in eary alpha stage! Feel free to report any issues you encounter.
+
+## Quickstart example
+
+Once [installed](#install), you can use the following code to access your local
+Asterisk Telephony instance and issue some simple commands via AMI:
+
+```php
+$factory = new Factory($loop);
+
+$factory->createClient('username:secret@localhost')->then(function (Client $client) {
+    echo 'Client connected' . PHP_EOL;
+    
+    $api = new Api($client);
+    $api->listCommands()->then(function (Response $response) {
+        echo 'Available commands:' . PHP_EOL;
+        var_dump($response);
+    });
+});
+
+$loop->run();
+```
+
+See also the [examples](example).
+
+## Install
+
+The recommended way to install this library is [through composer](http://getcomposer.org). [New to composer?](http://getcomposer.org/doc/00-intro.md)
+
+```JSON
+{
+    "require": {
+        "clue/asterisk-ami-react": "dev-master"
+    }
+}
+```
+
+> Note: This project is currently not listed on packagist.
+
+## License
+
+MIT

composer.json

@@ -1,8 +1,8 @@
 {
-    "name": "clue/redis-react",
-    "description": "Async redis client implementation",
-    "keywords": ["redis", "client", "async", "react"],
-    "homepage": "https://github.com/clue/reactphp-redis",
+    "name": "clue/asterisk-ami-react",
+    "description": "Async, event-driven access to the Asterisk Manager Interface (AMI)",
+    "keywords": ["Asterisk Manager Interface", "AMI", "async", "react"],
+    "homepage": "https://github.com/clue/reactphp-asterisk-ami",
     "license": "MIT",
     "authors": [
         {

composer.lock

@@ -20,33 +20,33 @@ public function __construct(Client $client)
     public function login($username, $secret, $events = null)
     {
         $events = $this->boolParam($events);
-        return $this->client->request(new Action('Login', array('UserName' => $username, 'Secret' => $secret, 'Events' => $events)));
+        return $this->request('Login', array('UserName' => $username, 'Secret' => $secret, 'Events' => $events));
     }
 
     public function logout()
     {
-        return $this->client->request(new Action('Logout'));
+        return $this->request('Logout');
     }
 
     public function agentLogoff($agentId, $soft = false)
     {
         $bool = $soft ? 'true' : 'false';
-        return $this->client->request(new Action('AgentLogoff', array('Agent' => $agentId, 'Soft' => $bool)));
+        return $this->request('AgentLogoff', array('Agent' => $agentId, 'Soft' => $bool));
     }
 
     public function ping()
     {
-        return $this->client->request(new Action('Ping'));
+        return $this->request('Ping');
     }
 
     public function coreShowChannels()
     {
-        return $this->client->request(new Action('CoreShowChannels'));
+        return $this->request('CoreShowChannels');
     }
 
     public function command($command)
     {
-        return $this->client->request(new Action('Command', array('Command' => $command)));
+        return $this->request('Command', array('Command' => $command));
     }
 
     public function events($eventMask)
@@ -59,42 +59,42 @@ public function events($eventMask)
             $eventMask = implode(',', $eventMask);
         }
 
-        return $this->client->request(new Action('Events', array('EventMask' => $eventMask)));
+        return $this->request('Events', array('EventMask' => $eventMask));
     }
 
     public function sipPeers()
     {
-        return $this->client->request(new Action('SIPPeers'));
+        return $this->request('SIPPeers');
     }
 
     public function sipShowPeer($peerName)
     {
-        return $this->client->request(new Action('SIPshowpeer', array('Peer' => $peerName)));
+        return $this->request('SIPshowpeer', array('Peer' => $peerName));
     }
 
     public function listCommands()
     {
-        return $this->client->request(new Action('ListCommands'));
+        return $this->request('ListCommands');
     }
 
     public function sendText($channel, $message)
     {
-        return $this->client->request(new Action('Sendtext', array('Channel' => $channel, 'Message' => $message)));
+        return $this->request('Sendtext', array('Channel' => $channel, 'Message' => $message));
     }
 
     public function hangup($channel, $cause)
     {
-        return $this->client->request(new Action('Hangup', array('Channel' => $channel, 'Cause' => $cause)));
+        return $this->request('Hangup', array('Channel' => $channel, 'Cause' => $cause));
     }
 
     public function challenge($authType = 'MD5')
     {
-        return $this->client->request(new Action('Challenge', array('AuthType' => $authType)));
+        return $this->request('Challenge', array('AuthType' => $authType));
     }
 
     public function getConfig($filename, $category = null)
     {
-        return $this->client->request(new Action('GetConfig', array('Filename' => $filename, 'Category' => $category)));
+        return $this->request('GetConfig', array('Filename' => $filename, 'Category' => $category));
     }
 
     private function boolParam($value)
@@ -107,4 +107,9 @@ private function boolParam($value)
         }
         return null;
     }
+
+    private function request($name, array $args = array())
+    {
+        return $this->client->request($this->client->createAction($name, $args));
+    }
 }

src/Api.php

@@ -5,7 +5,7 @@
 use Clue\React\Ami\Protocol\Event;
 use Clue\React\Ami\Protocol\Action;
 use Evenement\EventEmitter;
-use React\Stream\StreamInterface;
+use React\Stream\Stream;
 use Clue\React\Ami\Protocol\Parser;
 use React\Promise\Deferred;
 use Exception;
@@ -20,7 +20,9 @@ class Client extends EventEmitter
     private $pending = array();
     private $ending = false;
 
-    public function __construct(StreamInterface $stream, Parser $parser = null)
+    private $actionId = 0;
+
+    public function __construct(Stream $stream, Parser $parser = null)
     {
         if ($parser === null) {
             $parser = new Parser();
@@ -124,4 +126,11 @@ public function isBusy()
     {
         return !!$this->pending;
     }
+
+    public function createAction($name, array $args = array())
+    {
+        $args = array('ActionID' => (string)++$this->actionId) + $args;
+
+        return new Action($name, $args);
+    }
 }

src/Client.php

@@ -10,8 +10,6 @@ public function __construct($action, array $parts = array())
     {
         $this->action = $action;
         $this->parts = $parts;
-
-        $this->parts['ActionID'] = (string)mt_rand();
     }
 
     public function getMessageSerialized()

src/Protocol/Action.php

@@ -3,13 +3,13 @@
 use React\Stream\Stream;
 use Clue\React\Ami\Protocol\Parser;
 use Clue\React\Ami\Client;
-use React\Stream\ThroughStream;
+use React\EventLoop\Factory;
 
 class ClientTest extends TestCase
 {
     public function testClosingStreamClosesClient()
     {
-        $stream = new ThroughStream();
+        $stream = $this->createStreamMock();
 
         $client = new Client($stream);
 
@@ -21,7 +21,7 @@ public function testClosingStreamClosesClient()
 
     public function testParserExceptionForwardsErrorAndClosesClient()
     {
-        $stream = new ThroughStream();
+        $stream = $this->createStreamMock();
         $parser = new Parser();
 
         $client = new Client($stream, $parser);
@@ -31,4 +31,9 @@ public function testParserExceptionForwardsErrorAndClosesClient()
 
         $stream->emit('data', array("invalid chunk\r\n\r\ninvalid chunk\r\n\r\n"));
     }
+
+    private function createStreamMock()
+    {
+        return new Stream(fopen('php://memory', 'r+'), $this->getMock('React\EventLoop\LoopInterface'));
+    }
 }

tests/ClientTest.php

@@ -1,37 +1,48 @@
 <?php
 
 use Clue\React\Ami\Protocol\Action;
+
 class ActionTest extends TestCase
 {
+    public function testIdDefaultsToNull()
+    {
+        $action = new Action('name');
+
+        $this->assertNull($action->getActionId());
+    }
+
+    public function testIdCanBeSet()
+    {
+        $action = new Action('name', array('ActionID' => '123'));
+
+        $this->assertEquals('123', $action->getActionId());
+    }
+
     public function testSerializeSimple()
     {
         $action = new Action('name');
-        $id = $action->getActionId();
 
-        $this->assertEquals("Action: name\r\nActionID: $id\r\n\r\n", $action->getMessageSerialized());
+        $this->assertEquals("Action: name\r\n\r\n", $action->getMessageSerialized());
     }
 
     public function testSerializeKeySingle()
     {
         $action = new Action('name', array('Key' => 'Value'));
-        $id = $action->getActionId();
 
-        $this->assertEquals("Action: name\r\nKey: Value\r\nActionID: $id\r\n\r\n", $action->getMessageSerialized());
+        $this->assertEquals("Action: name\r\nKey: Value\r\n\r\n", $action->getMessageSerialized());
     }
 
     public function testSerializeKeyMultipleValues()
     {
         $action = new Action('name', array('Key' => array('Value1', 'Value2')));
-        $id = $action->getActionId();
 
-        $this->assertEquals("Action: name\r\nKey: Value1\r\nKey: Value2\r\nActionID: $id\r\n\r\n", $action->getMessageSerialized());
+        $this->assertEquals("Action: name\r\nKey: Value1\r\nKey: Value2\r\n\r\n", $action->getMessageSerialized());
     }
 
     public function testSerializeKeyMultipleKeyValues()
     {
         $action = new Action('name', array('Variables' => array('first' => 'on', 'second' => 'off')));
-        $id = $action->getActionId();
 
-        $this->assertEquals("Action: name\r\nVariables: first=on\r\nVariables: second=off\r\nActionID: $id\r\n\r\n", $action->getMessageSerialized());
+        $this->assertEquals("Action: name\r\nVariables: first=on\r\nVariables: second=off\r\n\r\n", $action->getMessageSerialized());
     }
 }