Add (deprecated) video message (#44)

Author: lgrahl

examples/e2e.py

@@ -16,6 +16,7 @@
     FileMessage,
     ImageMessage,
     TextMessage,
+    VideoMessage,
 )
 
 
@@ -83,6 +84,25 @@ def send_image(connection):
     return (yield from message.send())
 
 
+@asyncio.coroutine
+def send_video(connection):
+    """
+    Send a video including a thumbnail to a specific Threema ID.
+
+    Note that the public key will be automatically fetched from the
+    Threema servers. It is strongly recommended that you cache
+    public keys to avoid querying the API for each message.
+    """
+    message = VideoMessage(
+        connection=connection,
+        to_id='ECHOECHO',
+        duration=1,
+        video_path='res/threema.mp4',
+        thumbnail_path='res/threema.jpg',
+    )
+    return (yield from message.send())
+
+
 @asyncio.coroutine
 def send_file(connection):
     """
@@ -132,6 +152,7 @@ def main():
             yield from send_cached_key(connection)
             yield from send_cached_key_file(connection)
             yield from send_image(connection)
+            yield from send_video(connection)
             yield from send_file(connection)
             yield from send_file_with_thumbnail(connection)
     except GatewayError as exc:

examples/e2e_blocking.py

@@ -14,6 +14,7 @@
     FileMessage,
     ImageMessage,
     TextMessage,
+    VideoMessage,
 )
 
 
@@ -77,6 +78,24 @@ def send_image(connection):
     return message.send()
 
 
+def send_video(connection):
+    """
+    Send a video including a thumbnail to a specific Threema ID.
+
+    Note that the public key will be automatically fetched from the
+    Threema servers. It is strongly recommended that you cache
+    public keys to avoid querying the API for each message.
+    """
+    message = VideoMessage(
+        connection=connection,
+        to_id='ECHOECHO',
+        duration=1,
+        video_path='res/threema.mp4',
+        thumbnail_path='res/threema.jpg',
+    )
+    return message.send()
+
+
 def send_file(connection):
     """
     Send a file to a specific Threema ID.
@@ -124,6 +143,7 @@ def main():
             send_cached_key(connection)
             send_cached_key_file(connection)
             send_image(connection)
+            send_video(connection)
             send_file(connection)
             send_file_with_thumbnail(connection)
     except GatewayError as exc:

tests/conftest.py

@@ -64,6 +64,7 @@ def send(self, get_data_only=False):
 class Server:
     def __init__(self):
         self.threema_jpg = os.path.join(_res_path, 'threema.jpg')
+        self.threema_mp4 = os.path.join(_res_path, 'threema.mp4')
         key = b'4a6a1b34dcef15d43cb74de2fd36091be99fbbaf126d099d47d83d919712c72b'
         self.echoecho_key = key
         self.echoecho_encoded_key = 'public:' + key.decode('ascii')
@@ -163,7 +164,7 @@ def capabilities(self, request):
         elif id_ == 'ECHOECHO':
             return web.Response(body=b'text,image,video,file')
         elif id_ == '*MOCKING':
-            return web.Response(body=b'text,image,file')
+            return web.Response(body=b'text,image,video,file')
         return web.Response(status=404)
 
     @asyncio.coroutine

tests/res/threema.mp4

@@ -551,6 +551,21 @@ def test_image(self, connection, server):
         assert len(server.latest_blob_ids) == 1
         assert all((yield from get_latest_blob_ids(server, connection)))
 
+    @pytest.mark.asyncio
+    def test_video(self, connection, server):
+        server.latest_blob_ids = []
+        id_ = yield from e2e.VideoMessage(
+            connection=connection,
+            to_id='ECHOECHO',
+            key=server.echoecho_encoded_key,
+            duration=1,
+            video_path=server.threema_mp4,
+            thumbnail_path=server.threema_jpg,
+        ).send()
+        assert id_ == '1' * 16
+        assert len(server.latest_blob_ids) == 2
+        assert all((yield from get_latest_blob_ids(server, connection)))
+
     @pytest.mark.asyncio
     def test_file(self, connection, server):
         server.latest_blob_ids = []

tests/test_api.py

@@ -60,6 +60,24 @@ def test_image_message(self, connection, callback_send, callback_receive, server
         assert outgoing.to_id == incoming.to_id
         assert outgoing.image == incoming.image
 
+    @pytest.mark.asyncio
+    def test_video(self, connection, callback_send, callback_receive, server):
+        outgoing = e2e.VideoMessage(
+            connection,
+            to_id=pytest.msgapi.id,
+            duration=1,
+            video_path=server.threema_mp4,
+            thumbnail_path=server.threema_jpg,
+        )
+        response = yield from callback_send(outgoing)
+        yield from response.release()
+        incoming = yield from callback_receive()
+        assert outgoing.from_id == incoming.from_id
+        assert outgoing.to_id == incoming.to_id
+        assert outgoing.duration == incoming.duration
+        assert outgoing.video == incoming.video
+        assert outgoing.thumbnail_content == incoming.thumbnail_content
+
     @pytest.mark.asyncio
     def test_file_message(self, connection, callback_send, callback_receive, server):
         outgoing = e2e.FileMessage(

tests/test_callback.py

@@ -119,6 +119,28 @@ def test_send_image(self, cli, server):
         assert output_1 == output_2
         assert len(server.latest_blob_ids) == 2
 
+    @pytest.mark.asyncio
+    def test_send_video(self, cli, server):
+        server.latest_blob_ids = []
+        output_1 = yield from cli(
+            'send_video', 'ECHOECHO', pytest.msgapi.id, pytest.msgapi.secret,
+            pytest.msgapi.private, server.threema_mp4, server.threema_jpg)
+        assert output_1
+        assert len(server.latest_blob_ids) == 2
+        output_2 = yield from cli(
+            'send_video', 'ECHOECHO', pytest.msgapi.id, pytest.msgapi.secret,
+            pytest.msgapi.private, server.threema_mp4, server.threema_jpg,
+            '-k', server.echoecho_encoded_key)
+        assert output_2
+        assert output_1 == output_2
+        assert len(server.latest_blob_ids) == 4
+        output = yield from cli(
+            'send_video', 'ECHOECHO', pytest.msgapi.id, pytest.msgapi.secret,
+            pytest.msgapi.private, server.threema_mp4, server.threema_jpg,
+            '-d', '1337')
+        assert output
+        assert len(server.latest_blob_ids) == 6
+
     @pytest.mark.asyncio
     def test_send_file(self, cli, server):
         server.latest_blob_ids = []

tests/test_cli.py

@@ -342,6 +342,58 @@ def send_image(ctx, **arguments):
         click.echo((yield from message.send()))
 
 
+@cli.command(short_help='Send a video using end-to-end mode.', help="""
+Encrypt and send a video ('mp4') including a thumbnail to the given ID.
+FROM is the API identity and SECRET is the API secret.
+VIDEO_PATH is a relative or absolute path to a video.
+THUMBNAIL_PATH is a relative or absolute path to a thumbnail.
+Prints the message ID on success.
+""")
+@click.argument('to')
+@click.argument('from')
+@click.argument('secret')
+@click.argument('private_key')
+@click.argument('video_path')
+@click.argument('thumbnail_path')
+@click.option('-k', '--public-key', help="""
+The public key of the recipient. Will be fetched automatically if not provided.
+""")
+@click.option('-d', '--duration', help="""
+Duration of the video in seconds. Defaults to 0.
+""", default=0)
+@click.pass_context
+@util.aio_run_decorator()
+def send_video(ctx, **arguments):
+    # Get key instances
+    private_key = util.read_key_or_key_file(arguments['private_key'], Key.Type.private)
+    if arguments['public_key'] is not None:
+        public_key = util.read_key_or_key_file(arguments['public_key'], Key.Type.public)
+    else:
+        public_key = None
+
+    # Create connection
+    connection = Connection(
+        identity=arguments['from'],
+        secret=arguments['secret'],
+        key=private_key,
+        **ctx.obj
+    )
+
+    with connection:
+        # Create message
+        message = e2e.VideoMessage(
+            connection=connection,
+            to_id=arguments['to'],
+            key=public_key,
+            duration=arguments['duration'],
+            video_path=arguments['video_path'],
+            thumbnail_path=arguments['thumbnail_path']
+        )
+
+        # Send message
+        click.echo((yield from message.send()))
+
+
 @cli.command(short_help='Send a file using end-to-end mode.', help="""
 Encrypt and send a file to the given ID, optionally with a thumbnail.
 FROM is the API identity and SECRET is the API secret.