Refactored BaseMessage::toArray and added BaseMessage::getData in Push API

Author: mremi

src/Mremi/Flowdock/Api/Push/BaseMessage.php

@@ -95,14 +95,42 @@ public function hasErrors()
         return count($this->errors) > 0;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getData()
+    {
+        $array = $this->toArray();
+
+        // to be consistent with the Flowdock API
+        unset($array['errors']);
+
+        return $array;
+    }
+
     /**
      * {@inheritdoc}
      */
     public function toArray()
     {
-        return array(
-            'content' => $this->content,
-            'tags'    => $this->tags,
-        );
+        $array = get_object_vars($this);
+
+        $keys = array_map(array($this, 'underscore'), array_keys($array));
+
+        return array_combine($keys, array_values($array));
+    }
+
+    /**
+     * A string to underscore.
+     *
+     * This has been copied from the DependencyInjection Symfony component.
+     *
+     * @param string $string The string to underscore
+     *
+     * @return string The underscored string
+     */
+    private function underscore($string)
+    {
+        return strtolower(preg_replace(array('/([A-Z]+)([A-Z][a-z])/', '/([a-z\d])([A-Z])/'), array('\\1_\\2', '\\1_\\2'), strtr($string, '_', '.')));
     }
 }

src/Mremi/Flowdock/Api/Push/BaseMessageInterface.php

@@ -73,6 +73,13 @@ public function getErrors();
      */
     public function hasErrors();
 
+    /**
+     * Returns an array representation of the message data
+     *
+     * @return array
+     */
+    public function getData();
+
     /**
      * Returns an array representation of the message
      *

src/Mremi/Flowdock/Api/Push/Chat/Chat.php

@@ -32,7 +32,7 @@ public function sendMessage(MessageInterface $message, array $options = array())
         $request = $client->post(null, array(
             'Content-Type' => 'application/json'
         ), json_encode(
-            $message->toArray()
+            $message->getData()
         ), $options);
 
         $response = $request->send();

src/Mremi/Flowdock/Api/Push/Chat/Message.php

@@ -23,12 +23,12 @@ class Message extends BaseMessage implements MessageInterface
     /**
      * @var string
      */
-    private $externalUserName;
+    protected $externalUserName;
 
     /**
      * @var integer
      */
-    private $messageId;
+    protected $messageId;
 
     /**
      * {@inheritdoc}
@@ -65,15 +65,4 @@ public function getMessageId()
     {
         return $this->messageId;
     }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function toArray()
-    {
-        return array_merge(parent::toArray(), array(
-            'external_user_name' => $this->externalUserName,
-            'message_id'         => $this->messageId,
-        ));
-    }
 }

tests/Mremi/Flowdock/Tests/Api/Push/Chat/ChatTest.php

@@ -38,7 +38,7 @@ public function testSendMessage()
         $client
             ->expects($this->exactly(2))
             ->method('post')
-            ->with($this->equalTo(null), $this->equalTo(array('Content-Type' => 'application/json')), $this->equalTo(json_encode($message->toArray())), $this->equalTo(array()))
+            ->with($this->equalTo(null), $this->equalTo(array('Content-Type' => 'application/json')), $this->equalTo(json_encode($message->getData())), $this->equalTo(array()))
             ->will($this->returnValue($request));
 
         $chat = $this->getMockBuilder('Mremi\Flowdock\Api\Push\Chat\Chat')

tests/Mremi/Flowdock/Tests/Api/Push/Chat/MessageTest.php

@@ -68,6 +68,30 @@ public function testAddErrors()
         $this->assertTrue($this->message->hasErrors());
     }
 
+    /**
+     * Tests the getData method
+     */
+    public function testGetData()
+    {
+        $this->message
+            ->setContent('Hello world!')
+            ->setExternalUserName('mremi')
+            ->addTag('tag1')
+            ->addTag('tag2')
+            ->setMessageId(1)
+            ->addError('Error #1')
+            ->addError('Error #2');
+
+        $expected = array(
+            'content'            => $this->message->getContent(),
+            'external_user_name' => $this->message->getExternalUserName(),
+            'tags'               => $this->message->getTags(),
+            'message_id'         => $this->message->getMessageId(),
+        );
+
+        $this->assertEquals($expected, $this->message->getData());
+    }
+
     /**
      * Tests the toArray method
      */
@@ -78,13 +102,16 @@ public function testToArray()
             ->setExternalUserName('mremi')
             ->addTag('tag1')
             ->addTag('tag2')
-            ->setMessageId(1);
+            ->setMessageId(1)
+            ->addError('Error #1')
+            ->addError('Error #2');
 
         $expected = array(
             'content'            => $this->message->getContent(),
             'external_user_name' => $this->message->getExternalUserName(),
             'tags'               => $this->message->getTags(),
             'message_id'         => $this->message->getMessageId(),
+            'errors'             => $this->message->getErrors(),
         );
 
         $this->assertEquals($expected, $this->message->toArray());