fix: Support status codes with no content (box/box-codegen#604) (#378)

box-sdk-build · web-flow · commit 051716c84b4f · 2024-11-19T16:11:29.000+01:00
diff --git a/.codegen.json b/.codegen.json
@@ -1 +1 @@
-{ "engineHash": "c4810bd", "specHash": "c2c76f3", "version": "1.7.0" }
+{ "engineHash": "37e1577", "specHash": "c2c76f3", "version": "1.7.0" }
diff --git a/box_sdk_gen/managers/chunked_uploads.py b/box_sdk_gen/managers/chunked_uploads.py
@@ -624,7 +624,7 @@ def create_file_upload_session_commit_by_url(
         if_match: Optional[str] = None,
         if_none_match: Optional[str] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
-    ) -> Files:
+    ) -> Optional[Files]:
         """
                 Using this method with urls provided in response when creating a new upload session is preferred to use over CreateFileUploadSessionCommit method.
 
@@ -692,7 +692,9 @@ def create_file_upload_session_commit_by_url(
                 network_session=self.network_session,
             )
         )
-        return deserialize(response.data, Files)
+        if to_string(response.status) == '202':
+            return None
+        return deserialize(response.data, Optional[Files])
 
     def create_file_upload_session_commit(
         self,
@@ -703,7 +705,7 @@ def create_file_upload_session_commit(
         if_match: Optional[str] = None,
         if_none_match: Optional[str] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
-    ) -> Files:
+    ) -> Optional[Files]:
         """
                 Close an upload session and create a file from the uploaded chunks.
 
@@ -773,7 +775,9 @@ def create_file_upload_session_commit(
                 network_session=self.network_session,
             )
         )
-        return deserialize(response.data, Files)
+        if to_string(response.status) == '202':
+            return None
+        return deserialize(response.data, Optional[Files])
 
     def _reducer(self, acc: _PartAccumulator, chunk: ByteStream) -> _PartAccumulator:
         last_index: int = acc.last_index
@@ -860,7 +864,7 @@ def upload_big_file(
         assert processed_session_parts.total_count == total_parts
         sha_1: str = file_hash.digest_hash('base64')
         digest: str = ''.join(['sha=', sha_1])
-        committed_session: Files = self.create_file_upload_session_commit_by_url(
-            commit_url, parts, digest
+        committed_session: Optional[Files] = (
+            self.create_file_upload_session_commit_by_url(commit_url, parts, digest)
         )
         return committed_session.entries[0]
diff --git a/box_sdk_gen/managers/downloads.py b/box_sdk_gen/managers/downloads.py
@@ -50,7 +50,7 @@ def download_file(
         range: Optional[str] = None,
         boxapi: Optional[str] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
-    ) -> ByteStream:
+    ) -> Optional[ByteStream]:
         """
                 Returns the contents of a file in binary format.
                 :param file_id: The unique identifier that represents a file.
@@ -112,6 +112,8 @@ def download_file(
                 network_session=self.network_session,
             )
         )
+        if to_string(response.status) == '202':
+            return None
         return response.content
 
     def download_file_to_output_stream(
diff --git a/box_sdk_gen/managers/files.py b/box_sdk_gen/managers/files.py
@@ -601,7 +601,7 @@ def get_file_thumbnail_by_id(
         max_height: Optional[int] = None,
         max_width: Optional[int] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
-    ) -> ByteStream:
+    ) -> Optional[ByteStream]:
         """
                 Retrieves a thumbnail, or smaller image representation, of a file.
 
@@ -675,4 +675,6 @@ def get_file_thumbnail_by_id(
                 network_session=self.network_session,
             )
         )
+        if to_string(response.status) == '202':
+            return None
         return response.content
diff --git a/box_sdk_gen/managers/user_collaborations.py b/box_sdk_gen/managers/user_collaborations.py
@@ -199,7 +199,7 @@ def update_collaboration_by_id(
         expires_at: Optional[DateTime] = None,
         can_view_path: Optional[bool] = None,
         extra_headers: Optional[Dict[str, Optional[str]]] = None
-    ) -> Collaboration:
+    ) -> Optional[Collaboration]:
         """
                 Updates a collaboration.
 
@@ -275,7 +275,9 @@ def update_collaboration_by_id(
                 network_session=self.network_session,
             )
         )
-        return deserialize(response.data, Collaboration)
+        if to_string(response.status) == '204':
+            return None
+        return deserialize(response.data, Optional[Collaboration])
 
     def delete_collaboration_by_id(
         self,
diff --git a/box_sdk_gen/networking/fetch.py b/box_sdk_gen/networking/fetch.py
@@ -124,7 +124,9 @@ def fetch(options: FetchOptions) -> FetchResponse:
             accepted_with_retry_after = (
                 network_response.status_code == HTTPStatus.ACCEPTED
             ) and response.get_header('Retry-After', None)
-            if network_response.ok and not accepted_with_retry_after:
+            if network_response.ok and (
+                not accepted_with_retry_after or attempt_nr >= max_attempts
+            ):
                 if options.response_format == 'binary':
                     return FetchResponse(
                         status=network_response.status_code,
diff --git a/docs/chunked_uploads.md b/docs/chunked_uploads.md
@@ -397,7 +397,7 @@ client.chunked_uploads.create_file_upload_session_commit_by_url(
 
 ### Returns
 
-This function returns a value of type `Files`.
+This function returns a value of type `Optional[Files]`.
 
 Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed.
 
@@ -442,7 +442,7 @@ client.chunked_uploads.create_file_upload_session_commit(
 
 ### Returns
 
-This function returns a value of type `Files`.
+This function returns a value of type `Optional[Files]`.
 
 Returns the file object in a list.Returns when all chunks have been uploaded but not yet processed.
 
diff --git a/docs/downloads.md b/docs/downloads.md
@@ -35,7 +35,7 @@ client.downloads.download_file(uploaded_file.id)
 
 ### Returns
 
-This function returns a value of type `ByteStream`.
+This function returns a value of type `Optional[ByteStream]`.
 
 Returns the requested file if the client has the **follow
 redirects** setting enabled to automatically
diff --git a/docs/files.md b/docs/files.md
@@ -221,7 +221,7 @@ client.files.get_file_thumbnail_by_id(
 
 ### Returns
 
-This function returns a value of type `ByteStream`.
+This function returns a value of type `Optional[ByteStream]`.
 
 When a thumbnail can be created the thumbnail data will be
 returned in the body of the response.Sometimes generating a thumbnail can take a few seconds. In these
diff --git a/docs/user_collaborations.md b/docs/user_collaborations.md
@@ -71,7 +71,7 @@ client.user_collaborations.update_collaboration_by_id(
 
 ### Returns
 
-This function returns a value of type `Collaboration`.
+This function returns a value of type `Optional[Collaboration]`.
 
 Returns an updated collaboration object unless the owner has changed.If the role is changed to `owner`, the collaboration is deleted
 and a new collaboration is created. The previous `owner` of
diff --git a/test/chunked_uploads.py b/test/chunked_uploads.py
@@ -2,6 +2,8 @@
 
 from box_sdk_gen.internal.utils import to_string
 
+from typing import Optional
+
 from box_sdk_gen.internal.utils import Buffer
 
 from box_sdk_gen.internal.utils import HashName
@@ -147,8 +149,10 @@ def testChunkedManualProcessById():
     assert processed_session.id == upload_session_id
     sha_1: str = file_hash.digest_hash('base64')
     digest: str = ''.join(['sha=', sha_1])
-    committed_session: Files = client.chunked_uploads.create_file_upload_session_commit(
-        upload_session_id, parts, digest
+    committed_session: Optional[Files] = (
+        client.chunked_uploads.create_file_upload_session_commit(
+            upload_session_id, parts, digest
+        )
     )
     assert committed_session.entries[0].name == file_name
     client.chunked_uploads.delete_file_upload_session_by_id(upload_session_id)
@@ -240,7 +244,7 @@ def testChunkedManualProcessByUrl():
     assert processed_session.id == upload_session_id
     sha_1: str = file_hash.digest_hash('base64')
     digest: str = ''.join(['sha=', sha_1])
-    committed_session: Files = (
+    committed_session: Optional[Files] = (
         client.chunked_uploads.create_file_upload_session_commit_by_url(
             commit_url, parts, digest
         )
diff --git a/test/downloads.py b/test/downloads.py
@@ -1,3 +1,5 @@
+from typing import Optional
+
 from box_sdk_gen.client import BoxClient
 
 from box_sdk_gen.internal.utils import Buffer
@@ -50,7 +52,7 @@ def test_download_file():
         file_content_stream,
     )
     uploaded_file: FileFull = uploaded_files.entries[0]
-    downloaded_file_content: ByteStream = client.downloads.download_file(
+    downloaded_file_content: Optional[ByteStream] = client.downloads.download_file(
         uploaded_file.id
     )
     assert buffer_equals(read_byte_stream(downloaded_file_content), file_buffer)
diff --git a/test/fetch.py b/test/fetch.py
@@ -481,7 +481,9 @@ def test_retryable_status_codes(
     assert mock_requests_session.request.call_count == 3
 
 
-def test_status_code_202(mock_requests_session, network_session_mock, response_202):
+def test_status_code_202_with_no_retry_after_header(
+    mock_requests_session, network_session_mock, response_202
+):
     response_202.text = None
     response_202.content = None
     response_202.headers = {'content-type': 'text/html'}
@@ -520,6 +522,26 @@ def test_retryable_status_code_202(
     assert mock_requests_session.request.call_count == 3
 
 
+def test_202_should_be_returned_if_retry_limit_is_reached(
+    mock_requests_session, network_session_mock, response_202_with_retry_after
+):
+    network_session_mock.MAX_ATTEMPTS = 5
+    response_202.text = None
+    response_202.content = None
+    response_200.headers = {'Retry-After': '0'}
+    mock_requests_session.request.return_value = response_202_with_retry_after
+
+    with patch('time.sleep'):
+        fetch_response = fetch(
+            FetchOptions(
+                url="https://example.com", network_session=network_session_mock
+            )
+        )
+
+    assert fetch_response.status == 202
+    assert fetch_response.data == None
+
+
 @pytest.mark.parametrize('not_retryable_status_code', [404, 403, 400])
 def test_not_retryable_status_codes(
     mock_requests_session,
diff --git a/test/files.py b/test/files.py
@@ -1,3 +1,5 @@
+from typing import Optional
+
 import pytest
 
 from box_sdk_gen.client import BoxClient
@@ -55,14 +57,12 @@ def testGetFileThumbnail():
     thumbnail_file: FileFull = upload_file(
         thumbnail_file_name, thumbnail_content_stream
     )
+    thumbnail: Optional[ByteStream] = client.files.get_file_thumbnail_by_id(
+        thumbnail_file.id, GetFileThumbnailByIdExtension.PNG.value
+    )
     assert (
         not buffer_equals(
-            read_byte_stream(
-                client.files.get_file_thumbnail_by_id(
-                    thumbnail_file.id, GetFileThumbnailByIdExtension.PNG.value
-                )
-            ),
-            read_byte_stream(thumbnail_content_stream),
+            read_byte_stream(thumbnail), read_byte_stream(thumbnail_content_stream)
         )
         == True
     )
diff --git a/test/user_collaborations.py b/test/user_collaborations.py
@@ -1,5 +1,7 @@
 from box_sdk_gen.internal.utils import to_string
 
+from typing import Optional
+
 import pytest
 
 from box_sdk_gen.client import BoxClient
@@ -24,6 +26,8 @@
 
 from box_sdk_gen.managers.user_collaborations import UpdateCollaborationByIdRole
 
+from box_sdk_gen.schemas.collaborations import Collaborations
+
 from box_sdk_gen.internal.utils import get_uuid
 
 from test.commons import get_default_client
@@ -58,7 +62,7 @@ def testUserCollaborations():
     assert to_string(collaboration_from_api.status) == 'accepted'
     assert to_string(collaboration_from_api.type) == 'collaboration'
     assert collaboration_from_api.invite_email == None
-    updated_collaboration: Collaboration = (
+    updated_collaboration: Optional[Collaboration] = (
         client.user_collaborations.update_collaboration_by_id(
             collaboration_id, UpdateCollaborationByIdRole.VIEWER.value
         )
@@ -71,6 +75,40 @@ def testUserCollaborations():
     client.users.delete_user_by_id(user.id)
 
 
+def testConvertingUserCollaborationToOwnership():
+    user_name: str = get_uuid()
+    user_login: str = ''.join([get_uuid(), '@gmail.com'])
+    user: UserFull = client.users.create_user(
+        user_name, login=user_login, is_platform_access_only=True
+    )
+    folder: FolderFull = create_new_folder()
+    collaboration: Collaboration = client.user_collaborations.create_collaboration(
+        CreateCollaborationItem(
+            type=CreateCollaborationItemTypeField.FOLDER.value, id=folder.id
+        ),
+        CreateCollaborationAccessibleBy(
+            type=CreateCollaborationAccessibleByTypeField.USER.value, id=user.id
+        ),
+        CreateCollaborationRole.EDITOR.value,
+    )
+    assert to_string(collaboration.role) == 'editor'
+    owner_collaboration: Optional[Collaboration] = (
+        client.user_collaborations.update_collaboration_by_id(
+            collaboration.id, UpdateCollaborationByIdRole.OWNER.value
+        )
+    )
+    assert owner_collaboration == None
+    folder_collaborations: Collaborations = (
+        client.list_collaborations.get_folder_collaborations(folder.id)
+    )
+    folder_collaboration: Collaboration = folder_collaborations.entries[0]
+    client.user_collaborations.delete_collaboration_by_id(folder_collaboration.id)
+    user_client: BoxClient = client.with_as_user_header(user.id)
+    user_client.folders.delete_folder_by_id(folder.id)
+    user_client.trashed_folders.delete_trashed_folder_by_id(folder.id)
+    client.users.delete_user_by_id(user.id)
+
+
 def testExternalUserCollaborations():
     user_name: str = get_uuid()
     user_login: str = ''.join([get_uuid(), '@boxdemo.com'])
@@ -93,7 +131,7 @@ def testExternalUserCollaborations():
     assert to_string(collaboration_from_api.status) == 'pending'
     assert to_string(collaboration_from_api.type) == 'collaboration'
     assert collaboration_from_api.invite_email == user_login
-    updated_collaboration: Collaboration = (
+    updated_collaboration: Optional[Collaboration] = (
         client.user_collaborations.update_collaboration_by_id(
             collaboration_id, UpdateCollaborationByIdRole.VIEWER.value
         )

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{ "engineHash": "c4810bd", "specHash": "c2c76f3", "version": "1.7.0" }`
	`1`	`+{ "engineHash": "37e1577", "specHash": "c2c76f3", "version": "1.7.0" }`
Original file line number	Diff line number	Diff line change
`@@ -601,7 +601,7 @@ def get_file_thumbnail_by_id(`
`601`	`601`	`max_height: Optional[int] = None,`
`602`	`602`	`max_width: Optional[int] = None,`
`603`	`603`	`extra_headers: Optional[Dict[str, Optional[str]]] = None`
`604`		`- ) -> ByteStream:`
	`604`	`+ ) -> Optional[ByteStream]:`
`605`	`605`	`"""`
`606`	`606`	`Retrieves a thumbnail, or smaller image representation, of a file.`
`607`	`607`
`@@ -675,4 +675,6 @@ def get_file_thumbnail_by_id(`
`675`	`675`	`network_session=self.network_session,`
`676`	`676`	`)`
`677`	`677`	`)`
	`678`	`+ if to_string(response.status) == '202':`
	`679`	`+ return None`
`678`	`680`	`return response.content`