Merge pull request #23 from clue-labs/command

Add Response::getCommandOutput() helper

README.md

@@ -184,6 +184,17 @@ This is a shortcut to get the value of the "ActionID" field.
 The `Response` value object represents the incoming response received from the AMI.
 It shares all properties of the [`Message`](#message) parent class.
 
+The `getCommandOutput()` method can be used to get the resulting output of
+a "command" [`Action`](#action).
+This value is only available if this is actually a response to a "command" action,
+otherwise it defaults to `null`.
+
+```php
+$sender->command('help')->then(function (Response $response) {
+    echo $response->getCommandOutput();
+});
+```
+
 #### Action
 
 The `Action` value object represents an outgoing action message to be sent to the AMI.

examples/commands.php

@@ -34,7 +34,7 @@
 
         $sender->command($line)->then(
             function (Response $response) {
-                echo $response->getFieldValue('_') . PHP_EOL;
+                echo $response->getCommandOutput() . PHP_EOL;
             },
             function (Exception $error) use ($line) {
                 echo 'Error executing "' . $line . '": ' . $error->getMessage() . PHP_EOL;

src/Protocol/Parser.php

@@ -47,7 +47,7 @@ private function parseMessage($message)
         foreach ($lines as $i => $line) {
             $pos = strlen($line) - self::LCOMMAND_END - 1;
             if ($i === $last && substr($line, -self::LCOMMAND_END) === self::COMMAND_END && ($pos < 0 || $line[$pos] === "\n")) {
-                $key = '_';
+                $key = Response::FIELD_COMMAND_OUTPUT;
                 $value = $line;
             } else {
                 $pos = strpos($line, ': ');

src/Protocol/Response.php

@@ -4,8 +4,16 @@
 
 class Response extends Message
 {
+    /** @internal */
+    const FIELD_COMMAND_OUTPUT = '_';
+
     public function __construct(array $fields)
     {
         $this->fields = $fields;
     }
+
+    public function getCommandOutput()
+    {
+        return $this->getFieldValue(self::FIELD_COMMAND_OUTPUT);
+    }
 }

tests/Protocol/ParserTest.php

@@ -78,7 +78,7 @@ public function testParsingCommandResponse()
 
         $this->assertInstanceOf('Clue\React\Ami\Protocol\Response', $first);
         $this->assertEquals('Follows', $first->getFieldValue('Response'));
-        $this->assertEquals("Testing: yes\nAnother Line\n--END COMMAND--", $first->getFieldValue('_'));
+        $this->assertEquals("Testing: yes\nAnother Line\n--END COMMAND--", $first->getCommandOutput());
     }
 
     public function testParsingCommandResponseEmpty()
@@ -94,7 +94,7 @@ public function testParsingCommandResponseEmpty()
 
         $this->assertInstanceOf('Clue\React\Ami\Protocol\Response', $first);
         $this->assertEquals('Follows', $first->getFieldValue('Response'));
-        $this->assertEquals("--END COMMAND--", $first->getFieldValue('_'));
+        $this->assertEquals("--END COMMAND--", $first->getCommandOutput());
     }
 
     public function testParsingResponseIsNotCommandResponse()