Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow passing custom header for websocket handshake. Change pre-commi… #144

Merged
merged 1 commit into from
Dec 30, 2024
Merged

Allow passing custom header for websocket handshake. Change pre-commi… #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ repos:
--disable=too-many-locals,
--disable=duplicate-code,
--disable=logging-fstring-interpolation]
- repo: https://gitlab.com/pycqa/flake8
- repo: https://github.com/pycqa/flake8
rev: '3.8.4'
hooks:
- id: flake8
Expand Down
2 changes: 2 additions & 0 deletions changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,12 @@ All notable changes to this project will be documented in this file.
- Added `response_timeout` parameter in `open_connection` methods.
- New `get_license_info` method in agent-api v3.5.
- New `update_session` method in agent-api v3.6 (rtm).
- Allow passing custom header for websocket handshake.

### Changed
- Added missing top-level arguments to `update_auto_access` method in configuration-api.
- Updated outdated packages.
- Changed pre-commit flake8 URL

## [0.3.9] - 2024-04-22

Expand Down
11 changes: 8 additions & 3 deletions livechat/agent/rtm/api/v33.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
''' Module containing Agent RTM API client implementation for v3.3. '''

from typing import Any, Optional, Union
from typing import Any, Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,8 +11,13 @@

class AgentRtmV33:
''' Agent RTM API Class containing methods in version 3.3. '''
def __init__(self, url: str):
self.ws = WebsocketClient(url=f'wss://{url}/v3.3/agent/rtm/ws')
def __init__(
self,
url: str,
header: Union[list, dict, Callable, None],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

opt: use typing.Optional

Optional[X] is equivalent to Union[X, None].

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is copied from WebSocketApp client that is used in our SDK

class WebSocketApp:
    """
    Higher level of APIs are provided. The interface is like JavaScript WebSocket object.
    """

    def __init__(
        self,
        url: str,
        header: Union[list, dict, Callable, None] = None,

):
self.ws = WebsocketClient(url=f'wss://{url}/v3.3/agent/rtm/ws',
header=header)

def open_connection(self,
origin: dict = None,
Expand Down
11 changes: 8 additions & 3 deletions livechat/agent/rtm/api/v34.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
''' Module containing Agent RTM API client implementation for v3.4. '''

from typing import Any, Optional, Union
from typing import Any, Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,8 +11,13 @@

class AgentRtmV34:
''' Agent RTM API Class containing methods in version 3.4. '''
def __init__(self, url: str):
self.ws = WebsocketClient(url=f'wss://{url}/v3.4/agent/rtm/ws')
def __init__(
self,
url: str,
header: Union[list, dict, Callable, None],
):
self.ws = WebsocketClient(url=f'wss://{url}/v3.4/agent/rtm/ws',
header=header)

def open_connection(self,
origin: dict = None,
Expand Down
11 changes: 8 additions & 3 deletions livechat/agent/rtm/api/v35.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
''' Module containing Agent RTM API client implementation for v3.5. '''

from typing import Any, Optional, Union
from typing import Any, Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,8 +11,13 @@

class AgentRtmV35:
''' Agent RTM API Class containing methods in version 3.5. '''
def __init__(self, url: str):
self.ws = WebsocketClient(url=f'wss://{url}/v3.5/agent/rtm/ws')
def __init__(
self,
url: str,
header: Union[list, dict, Callable, None],
):
self.ws = WebsocketClient(url=f'wss://{url}/v3.5/agent/rtm/ws',
header=header)

def open_connection(self,
origin: dict = None,
Expand Down
13 changes: 10 additions & 3 deletions livechat/agent/rtm/api/v36.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
''' Module containing Agent RTM API client implementation for v3.6. '''

from typing import Any, Optional, Union
from typing import Any, Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,8 +11,15 @@

class AgentRtmV36:
''' Agent RTM API Class containing methods in version 3.6. '''
def __init__(self, url: str):
self.ws = WebsocketClient(url=f'wss://{url}/v3.6/agent/rtm/ws')
def __init__(
self,
url: str,
header: Union[list, dict, Callable, None],
):
self.ws = WebsocketClient(
url=f'wss://{url}/v3.6/agent/rtm/ws',
header=header,
)

def open_connection(self,
origin: dict = None,
Expand Down
9 changes: 6 additions & 3 deletions livechat/agent/rtm/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# pylint: disable=W0613,W0622,C0103,R0913,R0903,W0107,W0221
from __future__ import annotations

from typing import Union
from typing import Callable, Union

from livechat.agent.rtm.api.v33 import AgentRtmV33
from livechat.agent.rtm.api.v34 import AgentRtmV34
Expand All @@ -20,13 +20,16 @@ class AgentRTM:
@staticmethod
def get_client(
version: str = stable_version,
base_url: str = api_url
base_url: str = api_url,
header: Union[list, dict, Callable, None] = None,
) -> Union[AgentRtmV33, AgentRtmV34, AgentRtmV35, AgentRtmV36]:
''' Returns client for specific Agent RTM version.

Args:
version (str): API's version. Defaults to the stable version of API.
base_url (str): API's base url. Defaults to API's production URL.
header (Union[list, dict, Callable, None]): Custom header for websocket handshake.
If the parameter is a callable object, it is called just before the connection attempt.

Returns:
API client object for specified version.
Expand All @@ -42,4 +45,4 @@ def get_client(
}.get(version)
if not client:
raise ValueError('Provided version does not exist.')
return client(base_url)
return client(base_url, header)
13 changes: 9 additions & 4 deletions livechat/customer/rtm/api/v33.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# pylint: disable=C0103,R0903,R0913,W0107,W0231,W0613,W0622

from typing import Optional, Union
from typing import Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,12 +11,17 @@

class CustomerRtmV33:
''' Customer RTM API client class in version 3.3. '''
def __init__(self, license_id: str, base_url: str):
def __init__(
self,
license_id: str,
base_url: str,
header: Union[list, dict, Callable, None],
):
if isinstance(license_id, (int, str)):
self.ws = WebsocketClient(
url=
f'wss://{base_url}/v3.3/customer/rtm/ws?license_id={license_id}'
)
f'wss://{base_url}/v3.3/customer/rtm/ws?license_id={license_id}',
header=header)
else:
raise ValueError(
f'Provided `license_id` (`{license_id}`) seems invalid. Websocket connection may not open.'
Expand Down
13 changes: 9 additions & 4 deletions livechat/customer/rtm/api/v34.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# pylint: disable=C0103,R0903,R0913,W0107,W0231,W0613,W0622

from typing import Optional, Union
from typing import Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,12 +11,17 @@

class CustomerRtmV34:
''' Customer RTM API client class in version 3.4. '''
def __init__(self, organization_id: str, base_url: str):
def __init__(
self,
organization_id: str,
base_url: str,
header: Union[list, dict, Callable, None],
):
if isinstance(organization_id, str):
self.ws = WebsocketClient(
url=
f'wss://{base_url}/v3.4/customer/rtm/ws?organization_id={organization_id}'
)
f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}',
header=header)
else:
raise ValueError(
f'Provided `organization_id` (`{organization_id}`) seems invalid. Websocket connection may not open.'
Expand Down
13 changes: 9 additions & 4 deletions livechat/customer/rtm/api/v35.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# pylint: disable=C0103,R0903,R0913,W0107,W0231,W0613,W0622

from typing import Optional, Union
from typing import Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,12 +11,17 @@

class CustomerRtmV35:
''' Customer RTM API client class in version 3.5. '''
def __init__(self, organization_id: str, base_url: str):
def __init__(
self,
organization_id: str,
base_url: str,
header: Union[list, dict, Callable, None],
):
if isinstance(organization_id, str):
self.ws = WebsocketClient(
url=
f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}'
)
f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}',
header=header)
else:
raise ValueError(
f'Provided `organization_id` (`{organization_id}`) seems invalid. Websocket connection may not open.'
Expand Down
13 changes: 9 additions & 4 deletions livechat/customer/rtm/api/v36.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# pylint: disable=C0103,R0903,R0913,W0107,W0231,W0613,W0622

from typing import Optional, Union
from typing import Callable, Optional, Union

from livechat.utils.helpers import prepare_payload
from livechat.utils.structures import AccessToken, RtmResponse
Expand All @@ -11,12 +11,17 @@

class CustomerRtmV36:
''' Customer RTM API client class in version 3.6. '''
def __init__(self, organization_id: str, base_url: str):
def __init__(
self,
organization_id: str,
base_url: str,
header: Union[list, dict, Callable, None],
):
if isinstance(organization_id, str):
self.ws = WebsocketClient(
url=
f'wss://{base_url}/v3.6/customer/rtm/ws?organization_id={organization_id}'
)
f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}',
header=header)
else:
raise ValueError(
f'Provided `organization_id` (`{organization_id}`) seems invalid. Websocket connection may not open.'
Expand Down
9 changes: 6 additions & 3 deletions livechat/customer/rtm/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# pylint: disable=C0103,R0903,R0913,W0107,W0231,W0613,W0622

from typing import Union
from typing import Callable, Union

from livechat.config import CONFIG
from livechat.customer.rtm.api.v33 import CustomerRtmV33
Expand All @@ -21,7 +21,8 @@ def get_client(
version: str = stable_version,
base_url: str = api_url,
license_id: int = None,
organization_id: str = None
organization_id: str = None,
header: Union[list, dict, Callable, None] = None,
) -> Union[CustomerRtmV33, CustomerRtmV34, CustomerRtmV35, CustomerRtmV36]:
''' Returns client for specific Customer RTM version.

Expand All @@ -30,6 +31,8 @@ def get_client(
base_url (str): API's base url. Defaults to API's production URL.
license_id (int): License ID. Required to use for API version <= 3.3.
organization_id (str): Organization ID, replaced license ID in v3.4.
header (Union[list, dict, Callable, None]): Custom header for websocket handshake.
If the parameter is a callable object, it is called just before the connection attempt.

Returns:
API client object for specified version.
Expand Down Expand Up @@ -62,5 +65,5 @@ def get_client(
},
}.get(version)
if client:
return client(**client_kwargs)
return client(**client_kwargs, header=header)
raise ValueError('Provided version does not exist.')
Loading