Merge pull request #60 from Frameio/jh/watermark-id-downloads

[DEVREL-484] Add support for Watermark ID downloads

Author: jhodges10

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.1
+current_version = 0.8.2
 commit = True
 tag = True
 

.github/CODEOWNERS

@@ -7,4 +7,4 @@
 # Order is important; the last matching pattern takes the most
 # precedence. When someone opens a pull request that only
 # modifies Python files.
-*.py    jmeggesto@frame.io billy@frame.io zach@frame.io jay@frame.io
+*.py    @devrel

examples/download_asset.py

@@ -0,0 +1,12 @@
+import os
+
+from frameioclient import FrameioClient
+
+def download_file(asset_id):
+    token = os.getenv("FRAMEIO_TOKEN")
+    client = FrameioClient(token)
+    asset_info = client.get_asset(asset_id)
+    client.download(asset_info, "downloads")
+
+if __name__ == "__main__":
+    download_file("6cc9a45f-64a7-456e-a95f-98687220bf6e")

frameioclient/client.py

@@ -351,8 +351,7 @@ def copy_asset(self, destination_folder_id, **kwargs):
     return self._api_call('post', endpoint, kwargs)
 
   def bulk_copy_assets(self, destination_folder_id, asset_list=[], copy_comments=False):
-    """
-    Bulk copy assets
+    """Bulk copy assets
 
     :Args:
       destination_folder_id (string): The id of the folder you want to copy into.

frameioclient/download.py

@@ -1,18 +1,51 @@
-import requests
-import math
 import os
+import math
+import requests
+
+from .exceptions import DownloadException
 
 class FrameioDownloader(object):
   def __init__(self, asset, download_folder):
     self.asset = asset
     self.download_folder = download_folder
 
+  def get_download_key(self):
+    try:
+      url = self.asset['original']
+    except KeyError as e:
+      if self.asset['is_session_watermarked'] == True:
+        resolution_list = list()
+        try:
+          for resolution_key, download_url in sorted(self.asset['downloads'].items()):
+            resolution = resolution_key.split("_")[1] # Grab the item at index 1 (resolution)
+            try:
+              resolution = int(resolution)
+            except ValueError:
+              continue
+
+            if download_url is not None:
+              resolution_list.append(download_url)
+
+          # Grab the highest resolution (first item) now
+          url = resolution_list[0]
+        except KeyError:
+          raise DownloadException
+      else:
+        raise DownloadException
+
+    return url
+
   def download(self):
     original_filename = self.asset['name']
     final_destination = os.path.join(self.download_folder, original_filename)
-    
-    url = self.asset['original']
-    r = requests.get(url)
-    
-    open(final_destination, 'wb').write(r.content)
+
+    print("Final destiation: {}".format(final_destination))
+
+    if os.path.isfile(final_destination):
+      return final_destination
+    else:
+      url = self.get_download_key()
+      r = requests.get(url)
+      open(final_destination, 'wb').write(r.content)
+      return final_destination
 

frameioclient/exceptions.py

@@ -10,3 +10,14 @@ def __init__(
     ):
         self.message = message
         super().__init__(self.message)
+
+class DownloadException(Exception):
+    """Exception raised when trying to download a file where there is no available
+    download URL.
+    """
+    def __init__(
+        self, 
+        message="This file is unavailable for download due to security and permission settings."
+    ):
+        self.message = message
+        super().__init__(self.message)

setup.py

@@ -4,7 +4,7 @@
 
 from setuptools.command.install import install
 
-version='0.8.1'
+version='0.8.2'
 
 with open("README.md", "r") as f:
   long_description = f.read()
@@ -47,9 +47,11 @@ def run(self):
     'Programming Language :: Python :: 2',
     'Programming Language :: Python :: 2.7',
     'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.5',
     'Programming Language :: Python :: 3.6',
     'Programming Language :: Python :: 3.7',
     'Programming Language :: Python :: 3.8',
+    'Programming Language :: Python :: 3.9',
   ],
   description='Client library for the Frame.io API',
   long_description=long_description,

tests/conftest.py

@@ -1,6 +1,15 @@
+import os
 import pytest
 from frameioclient import FrameioClient
 
-@pytest.fixture
-def frameioclient(token):
-  return FrameioClient("aaaabbbbccccddddeeee")
+token = os.getenv('FRAME_IO_TOKEN')
+
+# @pytest.fixture
+# def frameioclient(token):
+#   return FrameioClient("aaaabbbbccccddddeeee")
+
+
+@pytest.fixture()
+def setup_client():
+  client = FrameioClient(token)
+  return client

tests/test_frameioclient.py

@@ -1,5 +1,5 @@
-import pytest
 from frameioclient import FrameioClient
 
-def test_FrameioClient(frameioclient):
-  assert type(frameioclient) == FrameioClient
+def test_FrameioClient(setup_client):
+  client = setup_client
+  assert type(client) == FrameioClient 

tests/test_frameiodownloader.py

@@ -0,0 +1,56 @@
+import pytest
+from frameioclient.download import FrameioDownloader
+from frameioclient.exceptions import DownloadException
+
+
+regular_asset = {
+    "is_hls_required": False,
+    "is_session_watermarked": False,
+    "downloads": {
+        "h264_720": "some-720-url",
+        "h264_1080_best": "some-1080-url"
+    },
+    "h264_720": "some-720-url",
+    "h264_1080_best": "some-1080-url",
+    "original": "some-original-url",
+    "hls_manifest": "some-hls-url"
+}
+
+watermarked_asset_download_allowed = {
+    "is_hls_required": True,
+    "is_session_watermarked": True,
+    "downloads": {
+        "h264_720": "download-stream-service-url",
+        "h264_1080_best": "download-stream-service-url"
+    },
+    "hls_manifest": "hls-url"
+}
+
+watermarked_asset_no_download = {
+    "is_hls_required": True,
+    "is_session_watermarked": True,
+    "hls_manifest": "hls-url"
+}
+
+no_download_allowed = {
+    "is_hls_required": True,
+    "is_session_watermarked": False,
+    "hls_manifest": "hls-url"
+}
+
+def test_get_download_key_returns_original():
+    url = FrameioDownloader(regular_asset, './').get_download_key()
+    assert url == regular_asset['original']
+
+def test_get_download_key_returns_watermarked_download():
+    url = FrameioDownloader(watermarked_asset_download_allowed, './').get_download_key()
+    assert url == watermarked_asset_download_allowed['downloads']['h264_1080_best']
+
+def test_get_download_key_fails_gracefully_on_watermarked_asset():
+    with pytest.raises(DownloadException):
+        FrameioDownloader(watermarked_asset_no_download, './').get_download_key()
+
+def test_get_download_key_fails_gracefully_when_downloads_disallowed():
+    with pytest.raises(DownloadException):
+        FrameioDownloader(no_download_allowed, './').get_download_key()
+