Add ChatGrant, deprecate IpMessagingGrant (#379)

Author: jingming

tests/unit/jwt/test_access_token.py

@@ -11,7 +11,8 @@
     VoiceGrant,
     VideoGrant,
     ConversationsGrant,
-    TaskRouterGrant
+    TaskRouterGrant,
+    ChatGrant
 )
 
 ACCOUNT_SID = 'AC123'
@@ -121,6 +122,20 @@ def test_ip_messaging_grant(self):
             'push_credential_sid': 'CR123'
         }, decoded_token.payload['grants']['ip_messaging'])
 
+    def test_chat_grant(self):
+        scat = AccessToken(ACCOUNT_SID, SIGNING_KEY_SID, 'secret')
+        scat.add_grant(ChatGrant(service_sid='IS123', push_credential_sid='CR123'))
+
+        token = scat.to_jwt()
+        assert_is_not_none(token)
+        decoded_token = AccessToken.from_jwt(token, 'secret')
+        self._validate_claims(decoded_token.payload)
+        assert_equal(1, len(decoded_token.payload['grants']))
+        assert_equal({
+            'service_sid': 'IS123',
+            'push_credential_sid': 'CR123'
+        }, decoded_token.payload['grants']['chat'])
+
     def test_sync_grant(self):
         scat = AccessToken(ACCOUNT_SID, SIGNING_KEY_SID, 'secret')
         scat.identity = "bender"

twilio/jwt/access_token/grants.py

@@ -18,8 +18,38 @@ def new_func(*args, **kwargs):
     return new_func
 
 
+class ChatGrant(AccessTokenGrant):
+    """Grant to access Twilio Chat"""
+
+    def __init__(self, service_sid=None, endpoint_id=None,
+                 deployment_role_sid=None, push_credential_sid=None):
+        self.service_sid = service_sid
+        self.endpoint_id = endpoint_id
+        self.deployment_role_sid = deployment_role_sid
+        self.push_credential_sid = push_credential_sid
+
+    @property
+    def key(self):
+        return "chat"
+
+    def to_payload(self):
+        grant = {}
+        if self.service_sid:
+            grant['service_sid'] = self.service_sid
+        if self.endpoint_id:
+            grant['endpoint_id'] = self.endpoint_id
+        if self.deployment_role_sid:
+            grant['deployment_role_sid'] = self.deployment_role_sid
+        if self.push_credential_sid:
+            grant['push_credential_sid'] = self.push_credential_sid
+
+        return grant
+
+
 class IpMessagingGrant(AccessTokenGrant):
     """Grant to access Twilio IP Messaging"""
+
+    @deprecated
     def __init__(self, service_sid=None, endpoint_id=None,
                  deployment_role_sid=None, push_credential_sid=None):
         self.service_sid = service_sid