fix: Avoid raising 404 when file cannot generate a thumbnail (#642)

Author: DaveSawyer

HISTORY.rst

@@ -14,6 +14,7 @@ Next release
 
 **Bug Fixes:**
 - Limit cryptography to version <3.5.0 (`#636 <https://github.com/box/box-python-sdk/pull/636>`_)
+- Avoid raising 404 when a thumbnail cannot be generated for a file (`#642 <https://github.com/box/box-python-sdk/pull/642>`_)
 
 2.13.0 (2021-09-30)
 ++++++++

boxsdk/object/file.py

@@ -791,9 +791,12 @@ def get_thumbnail_representation(self, dimensions, extension='png'):
             `bytes`
         """
         rep_hints = '[{0}?dimensions={1}]'.format(extension, dimensions)
-        representation = self.get_representation_info(rep_hints)
-        if representation:
-            url = representation[0]['content']['url_template']
+        representations = self.get_representation_info(rep_hints)
+        if representations:
+            representation = representations[0]
+            if representation['status'].get('code') in ('error_conversion_failed', 'error_password_protected'):
+                return b''
+            url = representation['content']['url_template']
             url = url.replace('{+asset_path}', '')
             response = self._session.get(url, expect_json_response=False)
             return response.content

test/unit/object/test_file.py

@@ -902,3 +902,49 @@ def test_get_thumbnail_representation_not_found(
         params={'fields': 'representations'},
     )
     assert thumb == b''
+
+
+def test_get_thumbnail_representation_not_available(
+        test_file,
+        mock_box_session,
+        mock_content_response,
+):
+    representation_url = '{0}/files/{1}'.format(API.BASE_API_URL, test_file.object_id)
+    dimensions = '100x100'
+    extension = 'jpg'
+
+    mock_representations_response = Mock()
+    mock_representations_response.json.return_value = {
+        'etag': '1',
+        'id': test_file.object_id,
+        'representations': {
+            'entries': [
+                {
+                    'content': {
+                        'url_template': 'content_url {+asset_path}'
+                    },
+                    'info': {
+                        'url': 'https://api.box.com/2.0/internal_files/123/versions/345/representations/jpg'
+                    },
+                    'properties': {},
+                    'representation': 'pdf',
+                    'status': {'state': 'error', 'code': 'error_password_protected'}
+                }
+            ]
+        },
+        'type': 'file'
+    }
+
+    mock_box_session.get.side_effect = [mock_representations_response, mock_content_response]
+
+    thumb = test_file.get_thumbnail_representation(
+        dimensions=dimensions,
+        extension=extension,
+    )
+
+    mock_box_session.get.assert_any_call(
+        representation_url,
+        headers={'X-Rep-Hints': '[{}?dimensions={}]'.format(extension, dimensions)},
+        params={'fields': 'representations'},
+    )
+    assert thumb == b''