Merge pull request #203 from clarencetw/member_join_event_member_leave_event

Member join event member leave event

Author: Vaduz

src/LINEBot/Event/MemberJoinEvent.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Event;
+
+/**
+ * A class that represents the event of joining.
+ *
+ * @package LINE\LINEBot\Event
+ */
+class MemberJoinEvent extends BaseEvent
+{
+    /**
+     * MemberJoinEvent constructor.
+     *
+     * @param array $event
+     */
+    public function __construct($event)
+    {
+        parent::__construct($event);
+    }
+
+    /**
+     * Returns joined members.
+     *
+     * @return string
+     */
+    public function getMembers()
+    {
+        return $this->event['joined']['members'];
+    }
+}

src/LINEBot/Event/MemberLeaveEvent.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * Copyright 2019 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Event;
+
+/**
+ * A class that represents the event of leaving.
+ *
+ * @package LINE\LINEBot\Event
+ */
+class MemberLeaveEvent extends BaseEvent
+{
+    /**
+     * MemberLeaveEvent constructor.
+     *
+     * @param array $event
+     */
+    public function __construct($event)
+    {
+        parent::__construct($event);
+    }
+
+    /**
+     * Returns left members.
+     *
+     * @return string
+     */
+    public function getMembers()
+    {
+        return $this->event['left']['members'];
+    }
+}

src/LINEBot/Event/Parser/EventRequestParser.php

@@ -36,6 +36,8 @@ class EventRequestParser
         'postback' => 'LINE\LINEBot\Event\PostbackEvent',
         'beacon' => 'LINE\LINEBot\Event\BeaconDetectionEvent',
         'accountLink' => 'LINE\LINEBot\Event\AccountLinkEvent',
+        'memberJoined' => 'LINE\LINEBot\Event\MemberJoinEvent',
+        'memberLeft' => 'LINE\LINEBot\Event\MemberLeaveEvent',
     ];
 
     private static $messageType2class = [

tests/LINEBot/EventRequestParserTest.php

@@ -24,6 +24,8 @@
 use LINE\LINEBot\Event\FollowEvent;
 use LINE\LINEBot\Event\JoinEvent;
 use LINE\LINEBot\Event\LeaveEvent;
+use LINE\LINEBot\Event\MemberJoinEvent;
+use LINE\LINEBot\Event\MemberLeaveEvent;
 use LINE\LINEBot\Event\MessageEvent\AudioMessage;
 use LINE\LINEBot\Event\MessageEvent\FileMessage;
 use LINE\LINEBot\Event\MessageEvent\ImageMessage;
@@ -348,6 +350,47 @@ class EventRequestParserTest extends TestCase
     "result": "failed",
     "nonce": "1234567890abcdefghijklmnopqrstuvwxyz"
    }
+  },
+  {
+   "type":"memberJoined",
+   "timestamp":12345678901234,
+   "source":{
+    "type":"group",
+    "groupId":"groupid"
+   },
+   "joined": {
+    "members": [
+     {
+      "type": "user",
+      "userId": "U4af4980629..."
+     },
+     {
+      "type": "user",
+      "userId": "U91eeaf62d9..."
+     }
+    ]
+   },
+   "replyToken":"replytoken"
+  },
+  {
+   "type":"memberLeft",
+   "timestamp":12345678901234,
+   "source":{
+    "type":"group",
+    "groupId":"groupid"
+   },
+   "left": {
+    "members": [
+     {
+      "type": "user",
+      "userId": "U4af4980629..."
+     },
+     {
+      "type": "user",
+      "userId": "U91eeaf62d9..."
+     }
+    ]
+   }
   }
  ]
 }
@@ -362,9 +405,9 @@ public function testParseEventRequest()
     {
         $bot = new LINEBot(new DummyHttpClient($this, function () {
         }), ['channelSecret' => 'testsecret']);
-        $events = $bot->parseEventRequest($this::$json, 'uilGuZPX3SyyreXYIYla+I3kS48xg4+igqQZL33fc6M=');
+        $events = $bot->parseEventRequest($this::$json, 'iiWsqJCsXZSzoKpuZPBk9Vqw3XiAl+AqLJLUKYEVf2I=');
 
-        $this->assertEquals(count($events), 24);
+        $this->assertEquals(count($events), 26);
 
         {
             // text
@@ -640,5 +683,29 @@ public function testParseEventRequest()
             $this->assertEquals(true, $event->isFailed());
             $this->assertEquals("1234567890abcdefghijklmnopqrstuvwxyz", $event->getNonce());
         }
+
+        {
+            // member join
+            $event = $events[24];
+            $this->assertInstanceOf('LINE\LINEBot\Event\MemberJoinEvent', $event);
+            /** @var MemberJoinEvent $event */
+            $this->assertEquals('replytoken', $event->getReplyToken());
+            $this->assertEquals(12345678901234, $event->getTimestamp());
+            $members = $event->getMembers();
+            $this->assertEquals(["type" => "user", "userId" => "U4af4980629..."], $members[0]);
+            $this->assertEquals(["type" => "user", "userId" => "U91eeaf62d9..."], $members[1]);
+        }
+
+        {
+            // member leave
+            $event = $events[25];
+            $this->assertInstanceOf('LINE\LINEBot\Event\MemberLeaveEvent', $event);
+            /** @var MemberLeaveEvent $event */
+            $this->assertTrue($event->getReplyToken() === null);
+            $this->assertEquals(12345678901234, $event->getTimestamp());
+            $members = $event->getMembers();
+            $this->assertEquals(["type" => "user", "userId" => "U4af4980629..."], $members[0]);
+            $this->assertEquals(["type" => "user", "userId" => "U91eeaf62d9..."], $members[1]);
+        }
     }
 }