Merge pull request #238 from TheGreatCodeholio/new

Prettier logging Ping Method and Catch Temp Ban

examples/echo_bot.py

@@ -41,7 +41,7 @@ def __init__(self, creds: dict):
         android_id = creds['android_id']
         node = creds.get('node') # If you don't know it, set it to None
 
-        self.client = KikClient(self, username, password, node, device_id=device_id, android_id=android_id, logging=True)
+        self.client = KikClient(self, username, str(password), node, device_id=device_id, android_id=android_id, enable_logging=True)
         self.client.wait_for_messages()
 
     # Initialization and Authentication

kik_unofficial/callbacks.py

@@ -3,12 +3,12 @@
 from kik_unofficial.datatypes.xmpp.account import GetMyProfileResponse
 from kik_unofficial.datatypes.xmpp.chatting import *
 from kik_unofficial.datatypes.xmpp.errors import LoginError, SignUpError
-from kik_unofficial.datatypes.xmpp.login import LoginResponse, ConnectionFailedResponse, CaptchaElement
+from kik_unofficial.datatypes.xmpp.login import LoginResponse, ConnectionFailedResponse, CaptchaElement, TempBanElement
 from kik_unofficial.datatypes.xmpp.roster import FetchRosterResponse, PeersInfoResponse, GroupSearchResponse
 from kik_unofficial.datatypes.xmpp.sign_up import RegisterResponse, UsernameUniquenessResponse
 from kik_unofficial.datatypes.xmpp.xiphias import UsersResponse, UsersByAliasResponse
 from kik_unofficial.datatypes.xmpp.history import HistoryResponse
-
+from kik_unofficial.datatypes.xmpp.chatting import KikPongResponse
 
 
 class KikClientCallback:
@@ -147,3 +147,17 @@ def on_xiphias_get_users_response(self, response: Union[UsersResponse, UsersByAl
 
     def on_card_received(self, response: IncomingCardMessage):
         pass
+
+    def on_pong(self, response: KikPongResponse):
+        """
+        Gets called when the kik server sends a pong response to a ping response.
+        :return:
+        """
+        pass
+
+    def on_temp_ban_received(self, response: TempBanElement):
+        """
+        Gets called when kik servers send a temp ban message after successful authentication
+        When received, you will be unable to send or receive any stanzas until the current time is greater than the ban end time.
+        """
+        pass

kik_unofficial/datatypes/xmpp/account.py

@@ -1,4 +1,5 @@
 import datetime
+import time
 
 from bs4 import BeautifulSoup
 
@@ -124,3 +125,6 @@ def serialize(self):
                 f'</query>'
                 f'</iq>')
         return data.encode()
+
+
+

kik_unofficial/datatypes/xmpp/auth_stanza.py

@@ -33,7 +33,7 @@ def send_stanza(self) -> None:
         Send the outgoing auth stanza
         """
         stanza = self.searlize()
-        log.info('[+] Sending authentication certificate')
+        log.info('Sending authentication certificate')
         self.client.loop.call_soon_threadsafe(self.client.connection.send_raw_data, stanza)
 
     def revalidate(self) -> None:
@@ -43,7 +43,7 @@ def revalidate(self) -> None:
         if time.time() < self.revalidate_time:
             return
         stanza = self.searlize()
-        log.info('[+] Revalidating the authentication certificate')
+        log.info('Revalidating the authentication certificate')
         self.client.loop.call_soon_threadsafe(self.client.connection.send_raw_data, stanza)
 
     def searlize(self) -> bytes:
@@ -158,11 +158,11 @@ def handle(self, data: bs4.BeautifulSoup):
         Handles the auth response (result/error) sent by Kik
         """
         if data.error:
-            log.error('[!] kik:auth:cert [' + data.error.get('code') + '] ' + data.error.get_text())
+            log.error('kik:auth:cert [' + data.error.get('code') + '] ' + data.error.get_text())
             log.debug(str(data))
             return
         if data.find_all('regenerate-key', recursive=True):
-            log.info('[!] Regenerating the keys for certificate authentication')
+            log.info('Regenerating the keys for certificate authentication')
             self.teardown()
             self.send_stanza()
             return
@@ -171,7 +171,7 @@ def handle(self, data: bs4.BeautifulSoup):
         self.cert_url = data.certificate.url.text
         self.revalidate_time = current + (revalidate * 1000)
         self.client.loop.call_later(revalidate, self.revalidate)
-        log.info('[+] Successfully validated the authentication certificate')
+        log.info('Successfully validated the authentication certificate')
 
     def teardown(self):
         """

kik_unofficial/datatypes/xmpp/chatting.py

@@ -19,6 +19,7 @@ class OutgoingChatMessage(XMPPElement):
     """
     Represents an outgoing text chat message to another kik entity (member or group)
     """
+
     def __init__(self, peer_jid, body, is_group=False, bot_mention_jid=None):
         super().__init__()
         self.peer_jid = peer_jid
@@ -49,6 +50,7 @@ class OutgoingGroupChatMessage(OutgoingChatMessage):
     """
     Represents an outgoing text chat message to a group
     """
+
     def __init__(self, group_jid, body, bot_mention_jid):
         super().__init__(group_jid, body, is_group=True, bot_mention_jid=bot_mention_jid)
 
@@ -57,6 +59,7 @@ class OutgoingChatImage(XMPPElement):
     """
    Represents an outgoing image chat message to another kik entity (member or group)
    """
+
     def __init__(self, peer_jid, file_location, is_group=False, forward=True):
         super().__init__()
         self.peer_jid = peer_jid
@@ -96,15 +99,15 @@ def serialize(self):
             '</message>'
         )
 
-
-        packets =  [data[s:s+16384].encode() for s in range(0, len(data), 16384)]
+        packets = [data[s:s + 16384].encode() for s in range(0, len(data), 16384)]
         return list(packets)
 
 
 class OutgoingGroupChatImage(OutgoingChatImage):
     """
     Represents an outgoing image chat message to a group
     """
+
     def __init__(self, group_jid, file_location, forward):
         super().__init__(group_jid, file_location, is_group=True, forward=forward)
 
@@ -113,6 +116,7 @@ class IncomingChatMessage(XMPPResponse):
     """
     Represents an incoming text chat message from another user
     """
+
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
         self.request_delivered_receipt = data.request['d'] == 'true' if 'd' in data.request.attrs else False
@@ -131,6 +135,7 @@ class IncomingGroupChatMessage(IncomingChatMessage):
     """
     Represents an incoming text chat message from a group
     """
+
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
         self.group_jid = data.g['jid']
@@ -142,6 +147,7 @@ class OutgoingReadReceipt(XMPPElement):
     """
     Represents an outgoing read receipt to a specific user, for one or more messages
     """
+
     def __init__(self, peer_jid, receipt_message_id, group_jid=None):
         super().__init__()
         self.peer_jid = peer_jid
@@ -234,7 +240,7 @@ def __init__(self, peer_jid, link, title, text, app_name):
     def serialize(self):
         message_type = 'type="groupchat" xmlns="kik:groups"' if 'group' in self.peer_jid else 'type="chat"'
         timestamp = str(int(round(time.time() * 1000)))
-        
+
         data = (f'<message {message_type} to="{self.peer_jid}" id="{self.message_id}" cts="{timestamp}">'
                 '<pb></pb>'
                 f'<kik push="true" qos="true" timestamp="{timestamp}" />'
@@ -258,7 +264,7 @@ def serialize(self):
                 '</uris>'
                 '</content>'
                 '</message>')
-        
+
         return data.encode()
 
 
@@ -298,7 +304,8 @@ class IncomingGroupStatus(XMPPResponse):
 
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.requets_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.group_jid = data['from']
         self.to_jid = data['to']
@@ -312,7 +319,8 @@ class IncomingGroupSysmsg(XMPPResponse):
 
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.requets_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.group_jid = data['from']
         self.to_jid = data['to']
@@ -354,7 +362,8 @@ def __init__(self, data: BeautifulSoup):
 class IncomingImageMessage(XMPPResponse):
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.requets_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.image_url = data.find('file-url').get_text() if data.find('file-url') else None
         self.status = data.status.text if data.status else None
@@ -392,9 +401,11 @@ class IncomingGifMessage(XMPPResponse):
     """
     Represents an incoming GIF message from another kik entity, sent as a URL
     """
+
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.requets_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.status = data.status.text if data.status else None
         self.from_jid = data['from'] if data else None
@@ -413,6 +424,7 @@ class OutgoingGIFMessage(XMPPElement):
     """
 	Represents an outgoing GIF message to another kik entity (member or group)
 	"""
+
     def __init__(self, peer_jid, search_term, API_key, is_group=True):
         super().__init__()
         self.peer_jid = peer_jid
@@ -454,11 +466,10 @@ def serialize(self):
             '</message>'
         )
 
-
         packets = [data[s:s + 16384].encode() for s in range(0, len(data), 16384)]
         return list(packets)
 
-    def get_gif_data(self, search_term, API_key): 
+    def get_gif_data(self, search_term, API_key):
         if not API_key:
             raise Exception("A tendor.com API key is required to search for GIFs images. please get one and change it")
 
@@ -479,7 +490,8 @@ def get_gif_data(self, search_term, API_key):
 class IncomingVideoMessage(XMPPResponse):
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.requets_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.video_url = data.find('file-url').text
         self.file_content_type = data.find('file-content-type').text if data.find('file-content-type') else None
@@ -493,7 +505,8 @@ def __init__(self, data: BeautifulSoup):
 class IncomingCardMessage(XMPPResponse):
     def __init__(self, data: BeautifulSoup):
         super().__init__(data)
-        self.request_delivered_receipt = data.request['d'] == 'true' if data.request and 'd' in data.request.attrs else False
+        self.request_delivered_receipt = data.request[
+                                             'd'] == 'true' if data.request and 'd' in data.request.attrs else False
         self.request_read_receipt = data.request['r'] == 'true' if data.request and 'r' in data.request.attrs else False
         self.from_jid = data['from']
         self.to_jid = data['to']
@@ -508,3 +521,20 @@ def __init__(self, data: BeautifulSoup):
         self.uri = data.find('uri').text if data.find('uri') else None
 
 
+class KikPingRequest(XMPPElement):
+    def __init__(self):
+        super().__init__()
+
+    def serialize(self) -> bytes:
+        data = ('<ping/>')
+
+        return data.encode()
+
+
+class KikPongResponse:
+    """
+    Response to a <ping/> request to kik servers
+    """
+
+    def __init__(self, data: BeautifulSoup):
+        self.recieved_time = time.time()