Add web rtc channel (#63)

* Added payload models

* Added generate_token method

* Added tests for save_application body

* Added save_application method

* Added get_applications method

* Added get_application method

* Added delete_application

* Added update_application

* Corrected regex issue with unicode characters

* Added aditional test cases

* Updated README.md

* Added first integration tests

* Changed integration tests

* Added additional tests

* Added tests for update application endpoint

* Added tests for delete application endpoind

* Added tests for unsupported cases

* Added dependency to requirements/dev.txt

* Added header methods for post and delete

* Changed tests cases parameters

* Changed README.md

* Changed README.md v2

* Added regex==2022.3.15 to setup.cfg, tox.ini and common.txt

* Updated pull request with review suggestions

* Moved validate_path_parameter to Channel class

Author: dlozina

README.md

@@ -1,6 +1,11 @@
 # infobip-api-python-sdk
 Python client for Infobip's  API channels.
 
+# Supported channels
+- Whatsapp -> [Docs](https://www.infobip.com/docs/api#channels/whatsapp)
+- WebRTC -> [Docs](https://www.infobip.com/docs/api#channels/webrtc/)
+- MMS -> [Docs](https://www.infobip.com/docs/api#channels/mms)
+
 #### Table of contents:
 
 - [General Info](#general-info)
@@ -9,10 +14,6 @@ Python client for Infobip's  API channels.
 - [Code example](#code-example)
 - [Testing](#testing)
 - [Enable pre-commit hooks](#enable-pre-commit-hooks)
-- [Generating distribution package](#generating-distribution-package)
-- [Uploading distribution package on TestPyPI](#uploading-distribution-package-on-testpypi-for-testing-purposes)
-- [Installing your newly uploaded package](#installing-your-newly-uploaded-package)
-
 
 ## General Info
 
@@ -27,7 +28,7 @@ Published under [MIT License](LICENSE).
 ## Installation
 
 Install the library by using the following command:
-```
+```bash
 pip install infobip-api-python-sdk
 ```
 
@@ -38,21 +39,21 @@ If you don't already have one, you can create a free trial account [here](https:
 In this example we will show how to send WhatsApp text message.
 First step is to import necessary channel, in this case WhatsApp channel.
 
-```
+```python
 from infobip_channels import WhatsAppChannel
 ```
 
 Now you can create instance of `WhatsAppChannel` with your `base_url` and `api_key`.
 
-```
+```python
 c = WhatsAppChannel.from_auth_params({
     "base_url": "<your_base_url>",
     "api_key": "<your_api_key>"
 })
 ```
 After that you can access all the methods from `WhatsAppChannel`.
 To send text message you can use `send_text_message` method and add correct payload:
-```
+```python
 response = c.send_text_message(
     {
       "from": "<WhatsApp sender number from your Infobib account>",
@@ -69,89 +70,38 @@ response = c.send_text_message(
 ## Testing
 To run tests position yourself in the project's root while your virtual environment
 is active and run:
-```
+```bash
 python -m pytest
 ```
 
 ## Enable pre-commit hooks
 To enable pre-commit hooks run:
-```
+```bash
 pip install -r requirements/dev.txt
 ```
 You will need to install pre-commit hooks
 Using homebrew:
-```
+```bash
 brew install pre-commit
 ```
 Using conda (via conda-forge):
-```
+```bash
 conda install -c conda-forge pre-commit
 ```
 To check installation run:
-```
+```bash
 pre-commit --version
 ```
 If installation was successful you will see version number.
 You can find the Pre-commit configuration in `.pre-commit-config.yaml`.
 Install the git hook scripts:
-```
+```bash
 pre-commit install
 ```
 Run against all files:
-```
+```bash
 pre-commit run --all-files
 ```
 If setup was successful pre-commit will run on every commit.
 Every time you clone a project that uses pre-commit, running `pre-commit install`
 should be the first thing you do.
-
-
-## Generating distribution package
-Make sure you have the latest version of PyPA's
-[build](https://packaging.python.org/en/latest/key_projects/#build) installed:
-```
-python -m pip install --upgrade build
-```
-After installation check `setup.cfg` file for metadata.
-Name and version are used for file generation.
-Make sure that you appropriately change version before build.
-Update the `version` in the  `setup.cfg` file to the desired one.
-
-Now run this command from the same directory where pyproject.toml is located:
-```
-python -m build
-```
-
-This command should generate two files in the `dist` directory:
-```
-dist/
-  infobip_channels-x.y.z-py3-none-any.whl
-  infobip-channels-x.y.z.tar.gz
-```
-
-
-## Uploading distribution package on TestPyPI (for testing purposes)
-First thing to do is create an account on TestPyPI and acquire an API token.
-To upload the distribution package, you can use
-[twine](https://packaging.python.org/en/latest/key_projects/#twine):
-```
-python -m pip install --upgrade twine
-```
-
-Once installed, run Twine to upload all the archives under dist:
-```
-python -m twine upload --repository testpypi dist/*
-```
-
-You will be prompted for a username and password. For the username, use *\_\_token\_\_*.
-For the password, use the token value, including the pypi- prefix.
-
-
-## Installing your newly uploaded package
-To test the newly uploaded package, create a virtual environment and download the
-package:
-```
-pip install --extra-index-url https://test.pypi.org/simple/ infobip-channels==x.y.z
-```
-
-After that, create a test script or import the library in a shell and try it out.

infobip_channels/core/channel.py

@@ -12,6 +12,7 @@
     PostHeaders,
     ResponseBase,
 )
+from infobip_channels.web_rtc.models.path_parameters.core import PathParameter
 
 
 class Channel(ABC):
@@ -114,6 +115,24 @@ def convert_model_to_dict(
         """
         return model.dict(by_alias=by_alias, exclude_unset=exclude_unset, **kwargs)
 
+    @staticmethod
+    def validate_path_parameter(
+        parameter: Union[PathParameter, Dict], parameter_type: Type[PathParameter]
+    ) -> PathParameter:
+        """
+        Validate path parameter by trying to instantiate the provided class and
+        extract valid path parameter.
+
+        :param parameter: Path parameter to validate
+        :param parameter_type: Type of path parameter
+        :return: Class instance corresponding to the provided parameter type
+        """
+        return (
+            parameter
+            if isinstance(parameter, parameter_type)
+            else parameter_type(**parameter)
+        )
+
     @staticmethod
     def validate_message_body(
         message: Union[MessageBodyBase, Dict],
@@ -135,11 +154,18 @@ def _construct_response(
             response_class = self._get_custom_response_class(
                 raw_response, *args, **kwargs
             )
+
+            response_json = raw_response.json()
+            if type(response_json) is list:
+                raw_response_data = {"list": response_json}
+            else:
+                raw_response_data = response_json
+
             return response_class(
                 **{
                     "status_code": raw_response.status_code,
                     "raw_response": raw_response,
-                    **raw_response.json(),
+                    **raw_response_data,
                 }
             )
 

infobip_channels/core/http_client.py

@@ -4,8 +4,10 @@
 
 from infobip_channels.core.models import (
     Authentication,
+    DeleteHeaders,
     GetHeaders,
     PostHeaders,
+    PutHeaders,
     RequestHeaders,
 )
 
@@ -18,16 +20,21 @@ def __init__(
         auth: Authentication,
         post_headers: RequestHeaders = None,
         get_headers: RequestHeaders = None,
+        put_headers: RequestHeaders = None,
+        delete_headers: RequestHeaders = None,
     ):
-        """Create an instance of the _HttpClient class with the provided authentication
-        model instance. Get and post headers can optionally be provided, otherwise
-        default instances will be created for both. These headers will be used as
-        defaults in the get and post methods, unless new values are sent through method
-        arguments.
+        """Create an instance of the _HttpClient class with the provided
+        authentication model instance. Headers can optionally be provided, otherwise
+        default instances will be created. These headers will be used as defaults in
+        the HTTP methods, unless new values are sent through method arguments.
         """
         self.auth = auth
         self.post_headers = post_headers or PostHeaders(authorization=self.auth.api_key)
         self.get_headers = get_headers or GetHeaders(authorization=self.auth.api_key)
+        self.put_headers = put_headers or PutHeaders(authorization=self.auth.api_key)
+        self.delete_headers = delete_headers or DeleteHeaders(
+            authorization=self.auth.api_key
+        )
 
     def post(
         self, endpoint: str, body: Union[Dict, bytes], headers: RequestHeaders = None
@@ -53,7 +60,6 @@ def get(
         self, endpoint: str, headers: RequestHeaders = None, params: Dict = None
     ) -> requests.Response:
         """Send an HTTP get request to base_url + endpoint.
-
         :param endpoint: Which endpoint to hit
         :param headers: Request headers
         :param params: Dictionary of query parameters
@@ -63,3 +69,31 @@ def get(
         url = self.auth.base_url + endpoint
 
         return requests.get(url=url, headers=headers.dict(by_alias=True), params=params)
+
+    def put(
+        self, endpoint: str, body: Dict, headers: RequestHeaders = None
+    ) -> requests.Response:
+        """Send an HTTP put request to base_url + endpoint.
+
+        :param endpoint: Which endpoint to hit
+        :param headers: Request headers
+        :param body: Body to send with the request
+        :return: Received response
+        """
+        headers = headers or self.put_headers
+        url = self.auth.base_url + endpoint
+
+        return requests.put(url=url, json=body, headers=headers.dict(by_alias=True))
+
+    def delete(
+        self, endpoint: str, headers: RequestHeaders = None
+    ) -> requests.Response:
+        """Send an HTTP delete request to base_url + endpoint.
+
+        :param endpoint: Which endpoint to hit
+        :return: Received response
+        """
+        headers = headers or self.delete_headers
+        url = self.auth.base_url + endpoint
+
+        return requests.delete(url=url, headers=headers.dict(by_alias=True))

infobip_channels/core/models.py

@@ -96,6 +96,14 @@ class PostHeaders(RequestHeaders):
     content_type: Optional[str] = "application/json"
 
 
+class PutHeaders(RequestHeaders):
+    content_type: Optional[str] = "application/json"
+
+
+class DeleteHeaders(RequestHeaders):
+    pass
+
+
 class PathParameter(CamelCaseModel):
     sender: str