Merge pull request #82 from line/support_provide_user_id_by_group_n_room

Provide the user ID on group and room event

Author: moznion

src/LINEBot/Event/BaseEvent.php

@@ -117,13 +117,9 @@ public function isUnknownEvent()
      * Returns user ID of the event.
      *
      * @return string|null
-     * @throws InvalidEventSourceException Raise when called with non user type event.
      */
     public function getUserId()
     {
-        if (!$this->isUserEvent()) {
-            throw new InvalidEventSourceException('This event source is not a user type');
-        }
         return array_key_exists('userId', $this->event['source'])
             ? $this->event['source']['userId']
             : null;

tests/LINEBot/EventRequestParserTest.php

@@ -67,6 +67,20 @@ class EventRequestParserTest extends \PHPUnit_Framework_TestCase
     "type":"image"
    }
   },
+  {
+   "type":"message",
+   "timestamp":12345678901234,
+   "source":{
+    "type":"group",
+    "groupId":"groupid",
+    "userId":"userid"
+   },
+   "replyToken":"replytoken",
+   "message":{
+    "id":"contentid",
+    "type":"audio"
+   }
+  },
   {
    "type":"message",
    "timestamp":12345678901234,
@@ -85,7 +99,8 @@ class EventRequestParserTest extends \PHPUnit_Framework_TestCase
    "timestamp":12345678901234,
    "source":{
     "type":"room",
-    "roomId":"roomid"
+    "roomId":"roomid",
+    "userId":"userid"
    },
    "replyToken":"replytoken",
    "message":{
@@ -221,9 +236,9 @@ public function testParseEventRequest()
     {
         $bot = new LINEBot(new DummyHttpClient($this, function () {
         }), ['channelSecret' => 'testsecret']);
-        $events = $bot->parseEventRequest($this::$json, 'nwhDFVDoPEfWyaXthI/KrL0HdTJWafDYqW6RHlgvi6M=');
+        $events = $bot->parseEventRequest($this::$json, 'Cz7xWmZJizFKB+paG1imAwycGOSAq6IUMVw4slB3VpQ=');
 
-        $this->assertEquals(count($events), 15);
+        $this->assertEquals(count($events), 16);
 
         {
             // text
@@ -247,18 +262,35 @@ public function testParseEventRequest()
             $this->assertTrue($event->isGroupEvent());
             $this->assertEquals('groupid', $event->getGroupId());
             $this->assertEquals('groupid', $event->getEventSourceId());
+            $this->assertEquals(null, $event->getUserId());
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\ImageMessage', $event);
             /** @var ImageMessage $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
             $this->assertEquals('image', $event->getMessageType());
+            $this->assertEquals('contentid', $event->getMessageId());
         }
 
         {
-            // video
+            // audio (group event & it has user ID)
             $event = $events[2];
+            $this->assertTrue($event->isGroupEvent());
+            $this->assertEquals('groupid', $event->getGroupId());
+            $this->assertEquals('groupid', $event->getEventSourceId());
+            $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\AudioMessage', $event);
+            $this->assertEquals('userid', $event->getUserId());
+            /** @var AudioMessage $event */
+            $this->assertEquals('replytoken', $event->getReplyToken());
+            $this->assertEquals('audio', $event->getMessageType());
+            $this->assertEquals('contentid', $event->getMessageId());
+        }
+
+        {
+            // video
+            $event = $events[3];
             $this->assertTrue($event->isRoomEvent());
             $this->assertEquals('roomid', $event->getRoomId());
             $this->assertEquals('roomid', $event->getEventSourceId());
+            $this->assertEquals(null, $event->getUserId());
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\VideoMessage', $event);
             /** @var VideoMessage $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -267,7 +299,9 @@ public function testParseEventRequest()
 
         {
             // audio
-            $event = $events[3];
+            $event = $events[4];
+            $this->assertTrue($event->isRoomEvent());
+            $this->assertEquals('userid', $event->getUserId());
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\AudioMessage', $event);
             /** @var AudioMessage $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -276,7 +310,7 @@ public function testParseEventRequest()
 
         {
             // location
-            $event = $events[4];
+            $event = $events[5];
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\LocationMessage', $event);
             /** @var LocationMessage $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -289,7 +323,7 @@ public function testParseEventRequest()
 
         {
             // sticker
-            $event = $events[5];
+            $event = $events[6];
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\StickerMessage', $event);
             /** @var StickerMessage $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -300,39 +334,39 @@ public function testParseEventRequest()
 
         {
             // follow
-            $event = $events[6];
+            $event = $events[7];
             $this->assertInstanceOf('LINE\LINEBot\Event\FollowEvent', $event);
             /** @var FollowEvent $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
         }
 
         {
             // unfollow
-            $event = $events[7];
+            $event = $events[8];
             $this->assertInstanceOf('LINE\LINEBot\Event\UnfollowEvent', $event);
             /** @var UnfollowEvent $event */
             $this->assertTrue($event->getReplyToken() === null);
         }
 
         {
             // join
-            $event = $events[8];
+            $event = $events[9];
             $this->assertInstanceOf('LINE\LINEBot\Event\JoinEvent', $event);
             /** @var JoinEvent $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
         }
 
         {
             // leave
-            $event = $events[9];
+            $event = $events[10];
             $this->assertInstanceOf('LINE\LINEBot\Event\LeaveEvent', $event);
             /** @var LeaveEvent $event */
             $this->assertTrue($event->getReplyToken() === null);
         }
 
         {
             // postback
-            $event = $events[10];
+            $event = $events[11];
             $this->assertInstanceOf('LINE\LINEBot\Event\PostbackEvent', $event);
             /** @var PostbackEvent $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -341,7 +375,7 @@ public function testParseEventRequest()
 
         {
             // beacon
-            $event = $events[11];
+            $event = $events[12];
             $this->assertInstanceOf('LINE\LINEBot\Event\BeaconDetectionEvent', $event);
             /** @var BeaconDetectionEvent $event */
             $this->assertEquals('replytoken', $event->getReplyToken());
@@ -352,7 +386,7 @@ public function testParseEventRequest()
 
         {
             // unknown event (event source: user)
-            $event = $events[12];
+            $event = $events[13];
             $this->assertInstanceOf('LINE\LINEBot\Event\UnknownEvent', $event);
             /** @var UnknownEvent $event */
             $this->assertEquals('__unknown__', $event->getType());
@@ -366,7 +400,7 @@ public function testParseEventRequest()
 
         {
             // unknown event (event source: unknown)
-            $event = $events[13];
+            $event = $events[14];
             $this->assertInstanceOf('LINE\LINEBot\Event\UnknownEvent', $event);
             /** @var UnknownEvent $event */
             $this->assertEquals('__unknown__', $event->getType());
@@ -379,7 +413,7 @@ public function testParseEventRequest()
 
         {
             // message event & unknown message event
-            $event = $events[14];
+            $event = $events[15];
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent', $event);
             $this->assertInstanceOf('LINE\LINEBot\Event\MessageEvent\UnknownMessage', $event);
             /** @var UnknownMessage $event */