Add Unknown event (#424)

* Define UnkownEvent

* Add example

* Format

Author: Yang-33

examples/flask-kitchensink/app.py

@@ -41,7 +41,7 @@
     StickerMessage, StickerSendMessage, LocationMessage, LocationSendMessage,
     ImageMessage, VideoMessage, AudioMessage, FileMessage,
     UnfollowEvent, FollowEvent, JoinEvent, LeaveEvent, BeaconEvent,
-    MemberJoinedEvent, MemberLeftEvent,
+    MemberJoinedEvent, MemberLeftEvent, UnknownEvent,
     FlexSendMessage, BubbleContainer, ImageComponent, BoxComponent,
     TextComponent, IconComponent, ButtonComponent,
     SeparatorComponent, QuickReply, QuickReplyButton,
@@ -680,6 +680,11 @@ def handle_member_left(event):
     app.logger.info("Got memberLeft event")
 
 
+@handler.add(UnknownEvent)
+def handle_unknown_left(event):
+    app.logger.info(f"unknown event {event}")
+
+
 @app.route('/static/<path:path>')
 def send_static_content(path):
     return send_from_directory('static', path)

linebot/models/__init__.py

@@ -51,6 +51,7 @@
     MemberLeftEvent,
     BeaconEvent,
     ThingsEvent,
+    UnknownEvent,
     Postback,
     Beacon,
     Link,

linebot/models/events.py

@@ -490,6 +490,22 @@ def __init__(self, mode=None, timestamp=None, source=None, reply_token=None,
         )
 
 
+class UnknownEvent(Event):
+    """Unknown event.
+
+    We welcome your contribution to line-bot-sdk-python!
+    """
+
+    def __init__(self, **kwargs):
+        """__init__ method.
+
+        :param kwargs:
+        """
+        super(UnknownEvent, self).__init__(**kwargs)
+
+        self.type = 'unknown'
+
+
 class Postback(Base):
     """Postback.
 

linebot/webhook.py

@@ -33,7 +33,10 @@
     AccountLinkEvent,
     MemberJoinedEvent,
     MemberLeftEvent,
-    ThingsEvent, UnsendEvent, VideoPlayCompleteEvent,
+    ThingsEvent,
+    UnsendEvent,
+    VideoPlayCompleteEvent,
+    UnknownEvent,
 )
 from .utils import LOGGER, PY3, safe_compare_digest
 
@@ -172,7 +175,8 @@ def parse(self, body, signature, as_payload=False):
             elif event_type == 'videoPlayComplete':
                 events.append(VideoPlayCompleteEvent.new_from_json_dict(event))
             else:
-                LOGGER.warn('Unknown event type. type=' + event_type)
+                LOGGER.info('Unknown event type. type=' + event_type)
+                events.append(UnknownEvent.new_from_json_dict(event))
 
         if as_payload:
             return WebhookPayload(events=events, destination=body_json.get('destination'))

tests/test_webhook.py

@@ -26,6 +26,7 @@
     MessageEvent, FollowEvent, UnfollowEvent, JoinEvent,
     LeaveEvent, PostbackEvent, BeaconEvent, AccountLinkEvent,
     MemberJoinedEvent, MemberLeftEvent, ThingsEvent,
+    UnknownEvent,
     TextMessage, ImageMessage, VideoMessage, AudioMessage,
     LocationMessage, StickerMessage, FileMessage,
     SourceUser, SourceRoom, SourceGroup,
@@ -69,7 +70,7 @@ def test_parse(self):
         events = self.parser.parse(body, 'channel_secret')
 
         # events count
-        self.assertEqual(len(events), 29)
+        self.assertEqual(len(events), 30)
 
         # MessageEvent, SourceUser, TextMessage
         self.assertIsInstance(events[0], MessageEvent)
@@ -567,6 +568,9 @@ def test_parse(self):
         self.assertEqual(events[28].message.type, 'text')
         self.assertEqual(events[28].message.text, 'Hello, world')
 
+        # UnknownEvent
+        self.assertIsInstance(events[29], UnknownEvent)
+
     def test_parse_webhook_req_without_destination(self):
         body = """
         {

tests/text/webhook.json

@@ -581,6 +581,22 @@
         "type": "text",
         "text": "Hello, world"
       }
+    },
+    {
+      "type": "undefined",
+      "mode": "active",
+      "timestamp": 1462629479859,
+      "source": {
+        "type": "user",
+        "userId": "U206d25c2ea6bd87c17655609a1c37cb8"
+      },
+      "webhookEventId": "testwebhookeventid",
+      "deliveryContext": {
+        "isRedelivery": true
+      },
+      "undefinedField": {
+        "1": 1
+      }
     }
   ]
 }