remove redundant field, add new max_bitrate option to video api

Author: maxkahan

http_client/CHANGES.md

@@ -1,4 +1,6 @@
-- Updated dependency versions
+# 1.5.1
+- Remove unnecessary `Content-Type` check on error
+
 # 1.5.0
 - Add new `HttpClient.download_file_stream` method
 - Add new `FileStreamingError` exception type

http_client/src/vonage_http_client/_version.py

@@ -1 +1 @@
-__version__ = '1.5.0'
+__version__ = '1.5.1'

http_client/src/vonage_http_client/errors.py

@@ -1,4 +1,5 @@
 from json import JSONDecodeError, dumps
+from typing import Optional
 
 from requests import Response
 from vonage_utils.errors import VonageError
@@ -21,32 +22,32 @@ class HttpRequestError(VonageError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes:
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
+    def __init__(self, response: Response):
         self.response = response
-        self.set_error_message(self.response, content_type)
+        self.message = self._format_error_message()
         super().__init__(self.message)
 
-    def set_error_message(self, response: Response, content_type: str):
-        body = None
-        if content_type == 'application/json':
-            try:
-                body = dumps(response.json(), indent=4)
-            except JSONDecodeError:
-                pass
-        else:
-            body = response.text
+    def _format_error_message(self) -> str:
+        body = self._get_response_body()
+        base_message = f'{self.response.status_code} response from {self.response.url}'
 
         if body:
-            self.message = f'{response.status_code} response from {response.url}. Error response body: \n{body}'
-        else:
-            self.message = f'{response.status_code} response from {response.url}.'
+            return f'{base_message}. Error response body: \n{body}'
+        return base_message
+
+    def _get_response_body(self) -> Optional[str]:
+        if not self.response.content:
+            return None
+        try:
+            return dumps(self.response.json(), indent=4)
+        except JSONDecodeError:
+            return self.response.text
 
 
 class AuthenticationError(HttpRequestError):
@@ -56,15 +57,14 @@ class AuthenticationError(HttpRequestError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes (inherited from HttpRequestError parent exception):
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
-        super().__init__(response, content_type)
+    def __init__(self, response: Response):
+        super().__init__(response)
 
 
 class ForbiddenError(HttpRequestError):
@@ -74,15 +74,14 @@ class ForbiddenError(HttpRequestError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes (inherited from HttpRequestError parent exception):
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
-        super().__init__(response, content_type)
+    def __init__(self, response: Response):
+        super().__init__(response)
 
 
 class NotFoundError(HttpRequestError):
@@ -92,15 +91,14 @@ class NotFoundError(HttpRequestError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes (inherited from HttpRequestError parent exception):
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
-        super().__init__(response, content_type)
+    def __init__(self, response: Response):
+        super().__init__(response)
 
 
 class RateLimitedError(HttpRequestError):
@@ -111,15 +109,14 @@ class RateLimitedError(HttpRequestError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes (inherited from HttpRequestError parent exception):
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
-        super().__init__(response, content_type)
+    def __init__(self, response: Response):
+        super().__init__(response)
 
 
 class ServerError(HttpRequestError):
@@ -130,15 +127,14 @@ class ServerError(HttpRequestError):
 
     Args:
         response (requests.Response): The HTTP response object.
-        content_type (str): The response content type.
 
     Attributes (inherited from HttpRequestError parent exception):
         response (requests.Response): The HTTP response object.
         message (str): The returned error message.
     """
 
-    def __init__(self, response: Response, content_type: str):
-        super().__init__(response, content_type)
+    def __init__(self, response: Response):
+        super().__init__(response)
 
 
 class FileStreamingError(VonageError):

http_client/src/vonage_http_client/http_client.py

@@ -343,18 +343,17 @@ def _parse_response(self, response: Response) -> Union[dict, None]:
             except JSONDecodeError:
                 return None
         if response.status_code >= 400:
-            content_type = response.headers['Content-Type'].split(';', 1)[0]
             logger.warning(
                 f'Http Response Error! Status code: {response.status_code}; content: {repr(response.text)}; from url: {response.url}'
             )
             if response.status_code == 401:
-                raise AuthenticationError(response, content_type)
+                raise AuthenticationError(response)
             if response.status_code == 403:
-                raise ForbiddenError(response, content_type)
+                raise ForbiddenError(response)
             elif response.status_code == 404:
-                raise NotFoundError(response, content_type)
+                raise NotFoundError(response)
             elif response.status_code == 429:
-                raise RateLimitedError(response, content_type)
+                raise RateLimitedError(response)
             elif response.status_code == 500:
-                raise ServerError(response, content_type)
-        raise HttpRequestError(response, content_type)
+                raise ServerError(response)
+        raise HttpRequestError(response)

sms/tests/test_sms.py

@@ -170,7 +170,7 @@ def test_submit_sms_conversion_402():
     try:
         sms.submit_sms_conversion('3295d748-4e14-4681-af78-166dca3c5aab')
     except HttpRequestError as err:
-        assert err.message == '402 response from https://api.nexmo.com/conversions/sms.'
+        assert '402 response from https://api.nexmo.com/conversions/sms.' in err.message
 
 
 def test_http_client_property():

video/CHANGES.md

@@ -1,3 +1,6 @@
+# 1.1.0
+- Add new `max_bitrate` field for archives
+
 # 1.0.4
 - Updated dependency versions
 

video/src/vonage_video/_version.py

@@ -1 +1 @@
-__version__ = '1.0.4'
+__version__ = '1.1.0'

video/src/vonage_video/models/archive.py

@@ -69,6 +69,8 @@ class Archive(BaseModel):
         url (str, Optional): The download URL of the available archive file.
             This is only set for an archive with the status set to `available`.
         transcription (Transcription, Optional): Transcription options for the archive.
+        max_bitrate (int, Optional): The maximum video bitrate of the archive, in bits per
+            second. This is only valid for composed archives.
     """
 
     id: Optional[str] = None
@@ -94,6 +96,7 @@ class Archive(BaseModel):
     streams: Optional[list[VideoStream]] = None
     url: Optional[str] = None
     transcription: Optional[Transcription] = None
+    max_bitrate: Optional[int] = Field(None, validation_alias='maxBitrate')
 
 
 class CreateArchiveRequest(BaseModel):
@@ -114,7 +117,8 @@ class CreateArchiveRequest(BaseModel):
         resolution (VideoResolution, Optional): The resolution of the archive.
         stream_mode (StreamMode, Optional): Whether streams included in the archive are selected
             automatically ("auto", the default) or manually ("manual").
-
+        max_bitrate (int, Optional): The maximum video bitrate of the archive, in bits per
+            second. This is only valid for composed archives.
     Raises:
         NoAudioOrVideoError: If neither `has_audio` nor `has_video` is set.
         IndividualArchivePropertyError: If `resolution` or `layout` is set for individual archives
@@ -133,6 +137,9 @@ class CreateArchiveRequest(BaseModel):
     output_mode: Optional[OutputMode] = Field(None, serialization_alias='outputMode')
     resolution: Optional[VideoResolution] = None
     stream_mode: Optional[StreamMode] = Field(None, serialization_alias='streamMode')
+    max_bitrate: Optional[int] = Field(
+        None, ge=100_000, le=6_000_000, serialization_alias='maxBitrate'
+    )
 
     @model_validator(mode='after')
     def validate_audio_or_video(self):

video/tests/data/archive.json

@@ -19,5 +19,6 @@
     "multiArchiveTag": "my-multi-archive",
     "event": "archive",
     "resolution": "1280x720",
-    "url": null
+    "url": null,
+    "maxBitrate": 2000000
 }

video/tests/data/list_archives.json

@@ -45,7 +45,8 @@
             "multiArchiveTag": "my-multi-archive",
             "event": "archive",
             "resolution": "1280x720",
-            "url": "https://example.com/archive.mp4"
+            "url": "https://example.com/archive.mp4",
+            "maxBitrate": 2000000
         }
     ]
 }

video/tests/test_archive.py

@@ -127,6 +127,7 @@ def test_list_archives():
     assert archives[1].duration == 134
     assert archives[1].sha256_sum == 'test_sha256_sum'
     assert archives[1].url == 'https://example.com/archive.mp4'
+    assert archives[1].max_bitrate == 2_000_000
 
 
 @responses.activate
@@ -150,6 +151,7 @@ def test_start_archive():
         output_mode=OutputMode.COMPOSED,
         resolution=VideoResolution.RES_1280x720,
         stream_mode=StreamMode.MANUAL,
+        max_bitrate=2_000_000,
     )
 
     archive = video.start_archive(archive_options)
@@ -162,6 +164,7 @@ def test_start_archive():
     assert archive.status == 'started'
     assert archive.name == 'first archive test'
     assert archive.resolution == '1280x720'
+    assert archive.max_bitrate == 2_000_000
 
 
 @responses.activate