Add meetings api (#240)

* adding patch method, creating Meetings class and initial methods

* adding new Meetings class methods, optional params field to client.delete, new error type

* basic implementation of Meetings API methods

* Bump version: 3.2.0 → 3.2.1

* fixing import issue with uncommitted init file

* adding check that subfolders contain an __init__.py file

* refactoring, raising exception

* adding get_meetings_api_host method and _meetings_api_host attribute to Client

* adding new test module and adding meetings object instantiation to client

* small tweaks to methods

* implementing Meetings API endpoints, test room and recording endpoints, add mocks

* adding tests for themes methods, adding new mocks, check in client.parse

* commenting out unimplemented test

* adding Meetings.upload_logo_to_theme method to wrap the logo upload process, added tests and mocks

* using Literal type from typing-extensions module for python 3.7 compatibility

* adding Meetings API info to README

* Bump version: 3.2.2 → 3.3.0

* adding xml response mock from aws

* setting "no content" responses

* catching exception where no values for application_id and private_key but try to use jwt auth

* adding page_size parameter and code formatting

* testing for returned empty json body on list_themes with no themes, response formatting

* adding tests for previously undocumented properties

* catching expires_at errors for creating room, updating error responses

Author: maxkahan

README.md

@@ -18,6 +18,7 @@ need a Vonage account. Sign up [for free at vonage.com][signup].
 - [NCCO Builder](#ncco-builder)
 - [Verify V2 API](#verify-v2-api)
 - [Verify V1 API](#verify-v1-api)
+- [Meetings API](#meetings-api)
 - [Number Insight API](#number-insight-api)
 - [Account API](#account-api)
 - [Subaccounts API](#subaccounts-api)
@@ -579,6 +580,144 @@ else:
     print("Error: %s" % response["error_text"])
 ```
 
+## Meetings API
+
+Full docs for the [Meetings API are available here](https://developer.vonage.com/en/meetings/overview).
+
+### Create a meeting room
+
+```python
+# Instant room
+params = {'display_name': 'my_test_room'}
+meeting = client.meetings.create_room(params)
+
+# Long term room
+params = {'display_name': 'test_long_term_room', 'type': 'long_term', 'expires_at': '2023-01-30T00:47:04+0000'}
+meeting = client.meetings.create_room(params)
+```
+
+### Get all meeting rooms
+
+```python
+client.meetings.list_rooms()
+```
+
+### Get a room by id
+
+```python
+client.meetings.get_room('MY_ROOM_ID')
+```
+
+### Update a long term room
+
+```python
+params = {
+    'update_details': {
+        "available_features": {
+            "is_recording_available": False,
+            "is_chat_available": False,
+        }
+    }
+}
+meeting = client.meetings.update_room('MY_ROOM_ID', params)
+```
+
+### Get all recordings for a session
+
+```python
+session = client.meetings.get_session_recordings('MY_SESSION_ID')
+```
+
+### Get a recording by id
+
+```python
+recording = client.meetings.get_recording('MY_RECORDING_ID')
+```
+
+### Delete a recording
+
+```python
+client.meetings.delete_recording('MY_RECORDING_ID')
+```
+
+### List dial-in numbers
+
+```python
+numbers = client.meetings.list_dial_in_numbers()
+```
+
+### Create a theme
+
+```python
+params = {
+    'theme_name': 'my_theme',
+    'main_color': '#12f64e',
+    'brand_text': 'My Company',
+    'short_company_url': 'my-company',
+}
+theme = client.meetings.create_theme(params)
+```
+
+### Add a theme to a room
+
+```python
+meetings.add_theme_to_room('MY_ROOM_ID', 'MY_THEME_ID')
+```
+
+### List themes
+
+```python
+themes = client.meetings.list_themes()
+```
+
+### Get theme information
+
+```python
+theme = client.meetings.get_theme('MY_THEME_ID')
+```
+
+### Delete a theme
+
+```python
+client.meetings.delete_theme('MY_THEME_ID')
+```
+
+### Update a theme
+
+```python
+params = {
+    'update_details': {
+        'theme_name': 'updated_theme',
+        'main_color': '#FF0000',
+        'brand_text': 'My Updated Company Name',
+        'short_company_url': 'updated_company_url',
+    }
+}
+theme = client.meetings.update_theme('MY_THEME_ID', params)
+```
+
+### List all rooms using a specified theme
+
+```python
+rooms = client.meetings.list_rooms_with_theme_id('MY_THEME_ID')
+```
+
+### Update the default theme for your application
+
+```python
+response = client.meetings.update_application_theme('MY_THEME_ID')
+```
+
+### Upload a logo to a theme
+
+```python
+response = client.meetings.upload_logo_to_theme(
+        theme_id='MY_THEME_ID',
+        path_to_image='path/to/my/image.png',
+        logo_type='white', # 'white', 'colored' or 'favicon'
+    )
+```
+
 ## Number Insight API
 
 ### Basic Number Insight
@@ -909,9 +1048,9 @@ from vonage import Client
 
 client = Client(key='YOUR_API_KEY', secret='YOUR_API_SECRET')
 print(client.host()) # return rest.nexmo.com
-client.host('mio.nexmo.com') # rewrites the host value to mio.nexmo.com
+client.host('newhost.vonage.com') # rewrites the host value to newhost.vonage.com
 print(client.api_host()) # returns api.vonage.com
-client.api_host('myapi.vonage.com') # rewrite the value of api_host
+client.api_host('myapi.vonage.com') # rewrite the value of api_host to myapi.vonage.com
 ```
 
 ## Frequently Asked Questions
@@ -930,6 +1069,7 @@ The following is a list of Vonage APIs and whether the Python SDK provides suppo
 | Dispatch API          |         Beta         |     ❌     |
 | External Accounts API |         Beta         |     ❌     |
 | Media API             |         Beta         |     ❌     |
+| Meetings API          | General Availability |     ✅     |
 | Messages API          | General Availability |     ✅     |
 | Number Insight API    | General Availability |     ✅     |
 | Number Management API | General Availability |     ✅     |

setup.py

@@ -4,9 +4,7 @@
 from setuptools import setup, find_packages
 
 
-with io.open(
-    os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8"
-) as f:
+with io.open(os.path.join(os.path.dirname(__file__), "README.md"), encoding="utf-8") as f:
     long_description = f.read()
 
 setup(

src/vonage/client.py

@@ -4,6 +4,7 @@
 from .account import Account
 from .application import ApplicationV2, Application
 from .errors import *
+from .meetings import Meetings
 from .messages import Messages
 from .number_insight import NumberInsight
 from .number_management import Numbers
@@ -100,6 +101,7 @@ def __init__(
         self._jwt_claims = {}
         self._host = "rest.nexmo.com"
         self._api_host = "api.nexmo.com"
+        self._meetings_api_host = "api-eu.vonage.com/beta/meetings"
 
         user_agent = f"vonage-python/{vonage.__version__} python/{python_version()}"
 
@@ -110,6 +112,7 @@ def __init__(
 
         self.account = Account(self)
         self.application = Application(self)
+        self.meetings = Meetings(self)
         self.messages = Messages(self)
         self.number_insight = NumberInsight(self)
         self.numbers = Numbers(self)
@@ -128,20 +131,27 @@ def __init__(
         )
         self.session.mount("https://", self.adapter)
 
-    # Get and Set _host attribute
+    # Gets and sets _host attribute
     def host(self, value=None):
         if value is None:
             return self._host
         else:
             self._host = value
 
-    # Gets And Set _api_host attribute
+    # Gets and sets _api_host attribute
     def api_host(self, value=None):
         if value is None:
             return self._api_host
         else:
             self._api_host = value
 
+    # Gets and sets _meetings_api_host attribute
+    def meetings_api_host(self, value=None):
+        if value is None:
+            return self._meetings_api_host
+        else:
+            self._meetings_api_host = value
+
     def auth(self, params=None, **kwargs):
         self._jwt_claims = params or kwargs
 
@@ -261,7 +271,7 @@ def patch(self, host, request_uri, params, auth_type=None):
         # Only newer APIs (that expect json-bodies) currently use this method, so we will always send a json-formatted body
         return self.parse(host, self.session.patch(uri, json=params, headers=self._request_headers))
 
-    def delete(self, host, request_uri, auth_type=None):
+    def delete(self, host, request_uri, params=None, auth_type=None):
         uri = f"https://{host}{request_uri}"
         self._request_headers = self.headers
 
@@ -275,7 +285,11 @@ def delete(self, host, request_uri, auth_type=None):
             )
 
         logger.debug(f"DELETE to {repr(uri)} with headers {repr(self._request_headers)}")
-        return self.parse(host, self.session.delete(uri, headers=self._request_headers, timeout=self.timeout))
+        if params is not None:
+            logger.debug(f"DELETE call has params {repr(params)}")
+        return self.parse(
+            host, self.session.delete(uri, headers=self._request_headers, timeout=self.timeout, params=params)
+        )
 
     def parse(self, host, response: Response):
         logger.debug(f"Response headers {repr(response.headers)}")
@@ -291,7 +305,10 @@ def parse(self, host, response: Response):
                 if response.json() is None:
                     return None
             if content_mime == "application/json":
-                return response.json()
+                try:
+                    return response.json()
+                except JSONDecodeError:
+                    pass
             else:
                 return response.content
         elif 400 <= response.status_code < 500:
@@ -306,6 +323,11 @@ def parse(self, host, response: Response):
                     detail = error_data["detail"]
                     type = error_data["type"]
                     message = f"{title}: {detail} ({type})"
+                elif 'status' in error_data and 'message' in error_data and 'name' in error_data:
+                    message = f'Status Code {error_data["status"]}: {error_data["name"]}: {error_data["message"]}'
+                    if 'errors' in error_data:
+                        for error in error_data['errors']:
+                            message += f', error: {error}'
                 else:
                     message = error_data
             except JSONDecodeError:
@@ -320,7 +342,15 @@ def _create_jwt_auth_string(self):
         return b"Bearer " + self._generate_application_jwt()
 
     def _generate_application_jwt(self):
-        return self._jwt_client.generate_application_jwt(self._jwt_claims)
+        try:
+            return self._jwt_client.generate_application_jwt(self._jwt_claims)
+        except AttributeError as err:
+            if '_jwt_client' in str(err):
+                raise ClientError(
+                    'JWT generation failed. Check that you passed in valid values for "application_id" and "private_key".'
+                )
+            else:
+                raise err
 
     def _create_header_auth_string(self):
         hash = base64.b64encode(f"{self.api_key}:{self.api_secret}".encode("utf-8")).decode("ascii")

src/vonage/errors.py

@@ -33,7 +33,11 @@ class RedactError(Error):
 
 
 class InvalidAuthenticationTypeError(Error):
-    """An authentication method was specified that is not allowed."""
+    """An authentication method was specified that is not allowed"""
+
+
+class MeetingsError(ClientError):
+    """An error related to the Meetings class which calls the Vonage Meetings API."""
 
 
 class Verify2Error(ClientError):