After audit

Author: sadiv

README.md

@@ -22,7 +22,7 @@ from whatsapp_api_client_python import API
 ```
 ## Авторизация 
 
-Чтобы отправить сообщение или выполнить другой метод Green-API, аккаунт WhatsApp в приложении телефона должен быть в авторизованном состоянии. Для авторизации аккаунта перейдите в [личный кабинет](https://cabinet.green-api.com) и сканируйте QR-код с использованием приложения WhatsApp.
+Чтобы отправить сообщение или выполнить другой метод Green-API, аккаунт WhatsApp в приложении телефона должен быть в авторизованном состоянии. Для авторизации аккаунта перейдите в [личный кабинет](https://console.green-api.com) и сканируйте QR-код с использованием приложения WhatsApp.
 
 ## Примеры
 

examples/createGroupAndSendMessage.py

@@ -2,22 +2,23 @@
 
 from whatsapp_api_client_python import greenAPI as greenAPI
 
+# First you need to set the environment variables
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-restApi = API.RestApi('https://api.green-api.com', 
+greenAPI = greenAPI.greenAPI('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 
 def main():
     chatIds = [
         "79001234567@c.us"
     ]
-    resultCreate = restApi.groups.createGroup('GroupName', 
+    resultCreate = greenAPI.groups.createGroup('GroupName', 
         chatIds)
 
     if resultCreate.code == 200:
-        resultSend = restApi.sending.sendMessage(resultCreate.data['chatId'], 
+        resultSend = greenAPI.sending.sendMessage(resultCreate.data['chatId'], 
             'Message text')
         print(resultSend)
 

examples/receiveNotification.py

@@ -1,21 +1,25 @@
 from os import environ
-from whatsapp_api_client_python import API as API
+from whatsapp_api_client_python import greenAPI as greenAPI
 from datetime import datetime
 
 
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-restApi = API.RestApi('https://api.green-api.com', 
+restApi = greenAPI.RestApi('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 
 def main():
+    print('Incoming notifications are being received. '\
+        'To interrupt, press Ctrl+C')
     try:
         while True:
             resultReceive = restApi.receiving.receiveNotification()
             if resultReceive.code == 200:
                 if resultReceive.data == None:
+                    # There are no incoming notifications, 
+                    # we send the request again
                     continue
                 body = resultReceive.data['body']
                 idMessage = body['idMessage']

examples/sendPictureByLink.py

@@ -1,11 +1,11 @@
 from os import environ
 
-from whatsapp_api_client_python import API as API
+from whatsapp_api_client_python import greenAPI as greenAPI
 
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-restApi = API.RestApi('https://api.green-api.com', 
+restApi = greenAPI.RestApi('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 

examples/sendPictureByUpload.py

@@ -1,11 +1,11 @@
 from os import environ
 
-from whatsapp_api_client_python import API as API
+from whatsapp_api_client_python import greenAPI as greenAPI
 
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-restApi = API.RestApi('https://api.green-api.com', 
+restApi = greenAPI.RestApi('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 

examples/sendTextMessage.py

@@ -1,11 +1,11 @@
 from os import environ
 
-from whatsapp_api_client_python import API as API
+from whatsapp_api_client_python import greenAPI as greenAPI
 
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-restApi = API.RestApi('https://api.green-api.com', 
+restApi = greenAPI.RestApi('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 

tests/test_main.py

@@ -1,12 +1,12 @@
 from os import environ
 
-from whatsapp_api_client_python import API as API
+from whatsapp_api_client_python import greenAPI as greenAPI
 
 
 ID_INSTANCE = environ['ID_INSTANCE']
 API_TOKEN_INSTANCE = environ['API_TOKEN_INSTANCE']
 
-RestApi = API.RestApi('https://api.green-api.com', 
+RestApi = greenAPI.RestApi('https://api.green-api.com', 
                         ID_INSTANCE, 
                         API_TOKEN_INSTANCE)
 
@@ -15,13 +15,13 @@ def test_getSettings(self):
                 result = RestApi.account.getSettings()
                 if result.code != 200:
                         print(result.error)
-                assert isinstance(result, API.Response) and result.code == 200
+                assert isinstance(result, greenAPI.Response) and result.code == 200
 
         def test_getStateInstance(self):            
                 result = RestApi.account.getStateInstance()
                 if result.code != 200:
                         print(result.error)
-                assert isinstance(result, API.Response) and result.code == 200
+                assert isinstance(result, greenAPI.Response) and result.code == 200
 
 def main():
         TestClass.test_getSettings(TestClass)