Skip to content

Commit f7e0d77

Browse files
authored
[Communication]Rename CommunicationUserCredential to CommunicationTokenCredential (Azure#16177)
* Rename CommunicationUserCredential to CommunicationTokenCredential * Fix casing in method name
1 parent 82f13b8 commit f7e0d77

25 files changed

+127
-127
lines changed

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/user_credential.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from msrest.serialization import TZ_UTC
1414
from .utils import create_access_token
1515

16-
class CommunicationUserCredential(object):
16+
class CommunicationTokenCredential(object):
1717
"""Credential type used for authenticating to an Azure Communication service.
1818
:param str token: The token used to authenticate to an Azure Communication service
1919
:raises: TypeError

sdk/communication/azure-communication-administration/azure/communication/administration/_shared/user_credential_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from msrest.serialization import TZ_UTC
1414
from .utils import create_access_token
1515

16-
class CommunicationUserCredential(object):
16+
class CommunicationTokenCredential(object):
1717
"""Credential type used for authenticating to an Azure Communication service.
1818
:param str token: The token used to authenticate to an Azure Communication service
1919
:raises: TypeError

sdk/communication/azure-communication-administration/tests/user_credential_tests.py

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,47 @@
55
# --------------------------------------------------------------------------
66
from unittest import TestCase
77
from unittest.mock import MagicMock
8-
from azure.communication.administration._shared.user_credential import CommunicationUserCredential
8+
from azure.communication.administration._shared.user_credential import CommunicationTokenCredential
99
from azure.communication.administration._shared.utils import create_access_token
1010

1111

12-
class TestCommunicationUserCredential(TestCase):
12+
class TestCommunicationTokenCredential(TestCase):
1313
sample_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9."+\
1414
"eyJleHAiOjMyNTAzNjgwMDAwfQ.9i7FNNHHJT8cOzo-yrAUJyBSfJ-tPPk2emcHavOEpWc"
1515
sample_token_expiry = 32503680000
1616
expired_token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9."+\
1717
"eyJleHAiOjEwMH0.1h_scYkNp-G98-O4cW6KvfJZwiz54uJMyeDACE4nypg"
1818

1919

20-
def test_communicationusercredential_decodes_token(self):
21-
credential = CommunicationUserCredential(self.sample_token)
20+
def test_communicationtokencredential_decodes_token(self):
21+
credential = CommunicationTokenCredential(self.sample_token)
2222
access_token = credential.get_token()
2323

2424
self.assertEqual(access_token.token, self.sample_token)
2525

26-
def test_communicationusercredential_throws_if_invalid_token(self):
27-
self.assertRaises(ValueError, lambda: CommunicationUserCredential("foo.bar.tar"))
26+
def test_communicationtokencredential_throws_if_invalid_token(self):
27+
self.assertRaises(ValueError, lambda: CommunicationTokenCredential("foo.bar.tar"))
2828

29-
def test_communicationusercredential_throws_if_nonstring_token(self):
30-
self.assertRaises(TypeError, lambda: CommunicationUserCredential(454))
29+
def test_communicationtokencredential_throws_if_nonstring_token(self):
30+
self.assertRaises(TypeError, lambda: CommunicationTokenCredential(454))
3131

32-
def test_communicationusercredential_static_token_returns_expired_token(self):
33-
credential = CommunicationUserCredential(self.expired_token)
32+
def test_communicationtokencredential_static_token_returns_expired_token(self):
33+
credential = CommunicationTokenCredential(self.expired_token)
3434

3535
self.assertEqual(credential.get_token().token, self.expired_token)
3636

37-
def test_communicationusercredential_token_expired_refresh_called(self):
37+
def test_communicationtokencredential_token_expired_refresh_called(self):
3838
refresher = MagicMock(return_value=self.sample_token)
39-
access_token = CommunicationUserCredential(
39+
access_token = CommunicationTokenCredential(
4040
self.expired_token,
4141
token_refresher=refresher).get_token()
4242
refresher.assert_called_once()
4343
self.assertEqual(access_token, self.sample_token)
4444

4545

46-
def test_communicationusercredential_token_expired_refresh_called_asnecessary(self):
46+
def test_communicationtokencredential_token_expired_refresh_called_asnecessary(self):
4747
refresher = MagicMock(return_value=create_access_token(self.expired_token))
48-
credential = CommunicationUserCredential(
48+
credential = CommunicationTokenCredential(
4949
self.expired_token,
5050
token_refresher=refresher)
5151

sdk/communication/azure-communication-chat/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ it with this token. It is because the initiator of the create request must be in
4444
This will allow you to create, get, list or delete chat threads.
4545

4646
```python
47-
from azure.communication.chat import ChatClient, CommunicationUserCredential
47+
from azure.communication.chat import ChatClient, CommunicationTokenCredential
4848
# Your unique Azure Communication service endpoint
4949
endpoint = "https://<RESOURCE_NAME>.communcationservices.azure.com"
5050
token = "<token>"
51-
chat_client = ChatClient(endpoint, CommunicationUserCredential(token))
51+
chat_client = ChatClient(endpoint, CommunicationTokenCredential(token))
5252
```
5353

5454
## Create Chat Thread Client

sdk/communication/azure-communication-chat/azure/communication/chat/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
SendChatMessageResult,
77
ChatThreadInfo,
88
)
9-
from ._shared.user_credential import CommunicationUserCredential
9+
from ._shared.user_credential import CommunicationTokenCredential
1010
from ._models import (
1111
ChatThreadMember,
1212
ChatMessage,
@@ -24,7 +24,7 @@
2424
'SendChatMessageResult',
2525
'ChatThread',
2626
'ChatThreadInfo',
27-
'CommunicationUserCredential',
27+
'CommunicationTokenCredential',
2828
'ChatThreadMember',
2929
'CommunicationUserIdentifier',
3030
]

sdk/communication/azure-communication-chat/azure/communication/chat/_chat_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from azure.core.pipeline.policies import BearerTokenCredentialPolicy
1616

1717
from ._chat_thread_client import ChatThreadClient
18-
from ._shared.user_credential import CommunicationUserCredential
18+
from ._shared.user_credential import CommunicationTokenCredential
1919
from ._generated import AzureCommunicationChatService
2020
from ._generated.models import CreateChatThreadRequest
2121
from ._models import ChatThread
@@ -37,7 +37,7 @@ class ChatClient(object):
3737
3838
:param str endpoint:
3939
The endpoint of the Azure Communication resource.
40-
:param CommunicationUserCredential credential:
40+
:param CommunicationTokenCredential credential:
4141
The credentials with which to authenticate.
4242
4343
.. admonition:: Example:
@@ -53,7 +53,7 @@ class ChatClient(object):
5353
def __init__(
5454
self,
5555
endpoint, # type: str
56-
credential, # type: CommunicationUserCredential
56+
credential, # type: CommunicationTokenCredential
5757
**kwargs # type: Any
5858
):
5959
# type: (...) -> None

sdk/communication/azure-communication-chat/azure/communication/chat/_chat_thread_client.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from azure.core.tracing.decorator import distributed_trace
1414
from azure.core.pipeline.policies import BearerTokenCredentialPolicy
1515

16-
from ._shared.user_credential import CommunicationUserCredential
16+
from ._shared.user_credential import CommunicationTokenCredential
1717
from ._generated import AzureCommunicationChatService
1818
from ._generated.models import (
1919
AddChatThreadMembersRequest,
@@ -51,7 +51,7 @@ class ChatThreadClient(object):
5151
5252
:param str endpoint:
5353
The endpoint of the Azure Communication resource.
54-
:param CommunicationUserCredential credential:
54+
:param CommunicationTokenCredential credential:
5555
The credentials with which to authenticate. The value contains a User
5656
Access Token
5757
:param str thread_id:
@@ -70,7 +70,7 @@ class ChatThreadClient(object):
7070
def __init__(
7171
self,
7272
endpoint, # type: str
73-
credential, # type: CommunicationUserCredential
73+
credential, # type: CommunicationTokenCredential
7474
thread_id, # type: str
7575
**kwargs # type: Any
7676
):

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
from msrest.serialization import TZ_UTC
1515
from .utils import create_access_token
1616

17-
class CommunicationUserCredential(object):
17+
class CommunicationTokenCredential(object):
1818
"""Credential type used for authenticating to an Azure Communication service.
1919
:param str token: The token used to authenticate to an Azure Communication service
2020
:raises: TypeError

sdk/communication/azure-communication-chat/azure/communication/chat/_shared/user_credential_async.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
from msrest.serialization import TZ_UTC
1616
from .utils import create_access_token
1717

18-
class CommunicationUserCredential(object):
18+
class CommunicationTokenCredential(object):
1919
"""Credential type used for authenticating to an Azure Communication service.
2020
:param str token: The token used to authenticate to an Azure Communication service
2121
:raises: TypeError

sdk/communication/azure-communication-chat/azure/communication/chat/aio/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
# ------------------------------------
55
from ._chat_client_async import ChatClient
66
from ._chat_thread_client_async import ChatThreadClient
7-
from .._shared.user_credential_async import CommunicationUserCredential
7+
from .._shared.user_credential_async import CommunicationTokenCredential
88

99
__all__ = [
1010
"ChatClient",
1111
"ChatThreadClient",
12-
"CommunicationUserCredential"
12+
"CommunicationTokenCredential"
1313
]

0 commit comments

Comments
 (0)