Add FileMessage (#65)

* Add FileMessage

* 1. Fix flake8 errors.
2. Add test code for parsing webhook

Author: xsfishxs

README.rst

@@ -660,6 +660,11 @@ Message
     - id
     - package\_id
     - sticker\_id
+_ FileMessage
+    - type
+    - id
+    - file\_size
+    - file\_name
 
 Hints
 -----

examples/flask-kitchensink/app.py

@@ -36,7 +36,7 @@
     PostbackTemplateAction, DatetimePickerTemplateAction,
     CarouselTemplate, CarouselColumn, PostbackEvent,
     StickerMessage, StickerSendMessage, LocationMessage, LocationSendMessage,
-    ImageMessage, VideoMessage, AudioMessage,
+    ImageMessage, VideoMessage, AudioMessage, FileMessage,
     UnfollowEvent, FollowEvent, JoinEvent, LeaveEvent, BeaconEvent
 )
 
@@ -231,6 +231,25 @@ def handle_content_message(event):
         ])
 
 
+@handler.add(MessageEvent, message=FileMessage)
+def handle_file_message(event):
+    message_content = line_bot_api.get_message_content(event.message.id)
+    with tempfile.NamedTemporaryFile(dir=static_tmp_path, prefix='file-', delete=False) as tf:
+        for chunk in message_content.iter_content():
+            tf.write(chunk)
+        tempfile_path = tf.name
+
+    dist_path = tempfile_path + '-' + event.message.file_name
+    dist_name = os.path.basename(dist_path)
+    os.rename(tempfile_path, dist_path)
+
+    line_bot_api.reply_message(
+        event.reply_token, [
+            TextSendMessage(text='Save file.'),
+            TextSendMessage(text=request.host_url + os.path.join('static', 'tmp', dist_name))
+        ])
+
+
 @handler.add(FollowEvent)
 def handle_follow(event):
     line_bot_api.reply_message(

linebot/models/__init__.py

@@ -49,6 +49,7 @@
     AudioMessage,
     LocationMessage,
     StickerMessage,
+    FileMessage
 )
 from .responses import (  # noqa
     Profile,

linebot/models/events.py

@@ -27,7 +27,8 @@
     VideoMessage,
     AudioMessage,
     LocationMessage,
-    StickerMessage
+    StickerMessage,
+    FileMessage
 )
 from .sources import SourceUser, SourceGroup, SourceRoom
 
@@ -93,7 +94,8 @@ def __init__(self, timestamp=None, source=None, reply_token=None, message=None,
                 'video': VideoMessage,
                 'audio': AudioMessage,
                 'location': LocationMessage,
-                'sticker': StickerMessage
+                'sticker': StickerMessage,
+                'file': FileMessage
             }
         )
 

linebot/models/messages.py

@@ -167,3 +167,27 @@ def __init__(self, id=None, package_id=None, sticker_id=None, **kwargs):
         self.type = 'sticker'
         self.package_id = package_id
         self.sticker_id = sticker_id
+
+
+class FileMessage(Message):
+    """FileMessage.
+
+    https://devdocs.line.me/en/#file-message
+
+    Message object which contains the file content sent from the source.
+    The binary file data can be retrieved with the Content API.
+    """
+
+    def __init__(self, id=None, file_name=None, file_size=None, **kwargs):
+        """__init__ method.
+
+        :param str id: Message ID
+        :param str file_name: File Name
+        :param int file_size: File Size
+        :param kwargs:
+        """
+        super(FileMessage, self).__init__(id=id, **kwargs)
+
+        self.type = 'file'
+        self.file_size = file_size
+        self.file_name = file_name

tests/test_webhook.py

@@ -25,7 +25,7 @@
     MessageEvent, FollowEvent, UnfollowEvent, JoinEvent,
     LeaveEvent, PostbackEvent, BeaconEvent,
     TextMessage, ImageMessage, VideoMessage, AudioMessage,
-    LocationMessage, StickerMessage,
+    LocationMessage, StickerMessage, FileMessage,
     SourceUser, SourceRoom, SourceGroup
 )
 
@@ -291,6 +291,21 @@ def test_parse(self):
         self.assertEqual(events[17].postback.data, 'action=buyItem&itemId=123123&color=red')
         self.assertEqual(events[17].postback.params['datetime'], '2013-04-01T10:00')
 
+        # MessageEvent, SourceUser, FileMessage
+        self.assertIsInstance(events[18], MessageEvent)
+        self.assertEqual(events[18].reply_token, 'nHuyWiB7yP5Zw52FIkcQobQuGDXCTA')
+        self.assertEqual(events[18].type, 'message')
+        self.assertEqual(events[18].timestamp, 1462629479859)
+        self.assertIsInstance(events[18].source, SourceUser)
+        self.assertEqual(events[18].source.type, 'user')
+        self.assertEqual(events[18].source.user_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
+        self.assertEqual(events[18].source.sender_id, 'U206d25c2ea6bd87c17655609a1c37cb8')
+        self.assertIsInstance(events[18].message, FileMessage)
+        self.assertEqual(events[18].message.id, '325708')
+        self.assertEqual(events[18].message.type, 'file')
+        self.assertEqual(events[18].message.file_name, "file.txt")
+        self.assertEqual(events[18].message.file_size, 2138)
+
 
 class TestWebhookHandler(unittest.TestCase):
     def setUp(self):

tests/text/webhook.json

@@ -232,6 +232,21 @@
           "datetime": "2013-04-01T10:00"
         }
       }
+    },
+    {
+      "replyToken": "nHuyWiB7yP5Zw52FIkcQobQuGDXCTA",
+      "type": "message",
+      "timestamp": 1462629479859,
+      "source": {
+        "type": "user",
+        "userId": "U206d25c2ea6bd87c17655609a1c37cb8"
+      },
+      "message": {
+        "id": "325708",
+        "type": "file",
+        "fileName": "file.txt",
+        "fileSize": 2138
+      }
     }
   ]
 }