Merge pull request #60 from pevdh/better-error-description

Better error description

setup.py

@@ -2,14 +2,14 @@
 from setuptools import setup
 
 setup(name='pyTelegramBotAPI',
-      version='0.3.0',
+      version='0.3.1',
       description='Python Telegram bot api. ',
       author='eternnoir',
       author_email='eternnoir@gmail.com',
       url='https://github.com/eternnoir/pyTelegramBotAPI',
       packages=['telebot'],
       license='GPL2',
-      keywords='tools',
+      keywords='telegram bot api tools',
       install_requires=['pytest', 'requests', 'six'],
       classifiers=[
           'Development Status :: 5 - Production/Stable',

telebot/apihelper.py

@@ -16,20 +16,44 @@ def _make_request(token, method_name, method='get', params=None, files=None):
     :param method: HTTP method to be used. Defaults to 'get'.
     :param params: Optional parameters. Should be a dictionary with key-value pairs.
     :param files: Optional files.
-    :return:
+    :return: The result parsed to a JSON dictionary.
     """
     request_url = telebot.API_URL + 'bot' + token + '/' + method_name
     result = requests.request(method, request_url, params=params, files=files)
     logger.debug(result.text)
+    return _check_result(method_name, result)['result']
+
+
+def _check_result(method_name, result):
+    """
+    Checks whether `result` is a valid API response.
+    A result is considered invalid if:
+        - The server returned an HTTP response code other than 200
+        - The content of the result is invalid JSON.
+        - The method call was unsuccessful (The JSON 'ok' field equals False)
+
+    :raises ApiException: if one of the above listed cases is applicable
+    :param method_name: The name of the method called
+    :param result: The returned result of the method request
+    :return: The result parsed to a JSON dictionary.
+    """
     if result.status_code != 200:
-        raise ApiException(method_name, result)
+        msg = 'The server returned HTTP {0} {1}. Response body:\n[{2}]'\
+            .format(result.status_code, result.reason, result.text)
+        raise ApiException(msg, method_name, result)
+
     try:
         result_json = result.json()
-        if not result_json['ok']:
-            raise Exception()
     except:
-        raise ApiException(method_name, result)
+        msg = 'The server returned an invalid JSON response. Response body:\n[{0}]'\
-    return result_json['result']
+            .format(result.text)
+        raise ApiException(msg, method_name, result)
+
+    if not result_json['ok']:
+        msg = 'Error code: {0} Description: {1}'\
+            .format(result_json['error_code'], result_json['description'])
+        raise ApiException(msg, method_name, result)
+    return result_json
 
 
 def get_me(token):
@@ -251,9 +275,12 @@ def split_string(text, chars_per_string):
 class ApiException(Exception):
     """
     This class represents an Exception thrown when a call to the Telegram API fails.
+    In addition to an informative message, it has a `function_name` and a `result` attribute, which respectively
+    contain the name of the failed function and the returned result that made the function to be considered  as
+    failed.
     """
 
-    def __init__(self, function_name, result):
+    def __init__(self, msg, function_name, result):
-        super(ApiException, self).__init__('{0} failed. Returned result: {1}'.format(function_name, result))
+        super(ApiException, self).__init__("A request to the Telegram API was unsuccessful. {0}".format(msg))
         self.function_name = function_name
         self.result = result

tests/test_telebot.py

@@ -1,21 +1,29 @@
 # -*- coding: utf-8 -*-
 import sys
-import time
-
 sys.path.append('../')
-from telebot import types
+
-from telebot import apihelper
+import time
-import telebot
+import pytest
 import os
 
+import telebot
+from telebot import types
+from telebot import apihelper
+
+should_skip = 'TOKEN' and 'CHAT_ID' not in os.environ
+
+if not should_skip:
     TOKEN = os.environ['TOKEN']
     CHAT_ID = os.environ['CHAT_ID']
 
 
-def test_message_listener():
+@pytest.mark.skipif(should_skip, reason="No environment variables configured")
+class TestTeleBot:
+
+    def test_message_listener(self):
         msg_list = []
         for x in range(100):
-        msg_list.append(create_text_message('Message ' + str(x)))
+            msg_list.append(self.create_text_message('Message ' + str(x)))
 
         def listener(messages):
             assert len(messages) == 100
@@ -23,10 +31,9 @@ def test_message_listener():
         tb = telebot.TeleBot('')
         tb.set_update_listener(listener)
 
-
+    def test_message_handler(self):
-def test_message_handler():
         tb = telebot.TeleBot('')
-    msg = create_text_message('/help')
+        msg = self.create_text_message('/help')
 
         @tb.message_handler(commands=['help', 'start'])
         def command_handler(message):
@@ -36,10 +43,9 @@ def test_message_handler():
         time.sleep(1)
         assert msg.text == 'got'
 
-
+    def test_message_handler_reg(self):
-def test_message_handler_reg():
         bot = telebot.TeleBot('')
-    msg = create_text_message(r'https://web.telegram.org/')
+        msg = self.create_text_message(r'https://web.telegram.org/')
 
         @bot.message_handler(regexp='((https?):((//)|(\\\\))+([\w\d:#@%/;$()~_?\+-=\\\.&](#!)?)*)')
         def command_url(message):
@@ -49,10 +55,9 @@ def test_message_handler_reg():
         time.sleep(1)
         assert msg.text == 'got'
 
-
+    def test_message_handler_reg_fail(self):
-def test_message_handler_reg_fail():
         bot = telebot.TeleBot('')
-    msg = create_text_message(r'web.telegram.org/')
+        msg = self.create_text_message(r'web.telegram.org/')
 
         @bot.message_handler(regexp='((https?):((//)|(\\\\))+([\w\d:#@%/;$()~_?\+-=\\\.&](#!)?)*)')
         def command_url(message):
@@ -62,60 +67,52 @@ def test_message_handler_reg_fail():
         time.sleep(1)
         assert not msg.text == 'got'
 
-
+    def test_send_file_by_id(self):
-def test_send_file_by_id():
         file_id = 'BQADBQADjAIAAsYifgbvqwq1he9REAI'
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_document(CHAT_ID, file_id)
         assert ret_msg.message_id
 
-
+    def test_send_file(self):
-def test_send_file():
         file_data = open('../examples/detailed_example/kitten.jpg', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_document(CHAT_ID, file_data)
         assert ret_msg.message_id
 
-
+    def test_send_video(self):
-def test_send_video():
         file_data = open('./test_data/test_video.mp4', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_video(CHAT_ID, file_data)
         assert ret_msg.message_id
 
-
+    def test_send_video_more_params(self):
-def test_send_video_more_params():
         file_data = open('./test_data/test_video.mp4', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_video(CHAT_ID, file_data, 1)
         assert ret_msg.message_id
 
-
+    def test_send_file_exception(self):
-def test_send_file_exception():
         tb = telebot.TeleBot(TOKEN)
         try:
-        ret_msg = tb.send_document(CHAT_ID, None)
+            tb.send_document(CHAT_ID, None)
             assert False
         except Exception as e:
             print(e)
             assert True
 
-
+    def test_send_photo_by_id(self):
-def test_send_photo_by_id():
         photo_id = 'AgADBQADTKgxG8YifgbcWQAB7Da9yYIx1rEyAAT-HYJ3CrJEqdA2AQABAg'
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_photo(CHAT_ID, photo_id)
         assert ret_msg.message_id
 
-
+    def test_send_photo(self):
-def test_send_photo():
         file_data = open('../examples/detailed_example/kitten.jpg', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_photo(CHAT_ID, file_data)
         assert ret_msg.message_id
 
-
+    def test_send_audio(self):
-def test_send_audio():
         file_data = open('./test_data/record.mp3', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_audio(CHAT_ID, file_data, 1, 'eternnoir', 'pyTelegram')
@@ -123,38 +120,33 @@ def test_send_audio():
         assert ret_msg.audio.performer == 'eternnoir'
         assert ret_msg.audio.title == 'pyTelegram'
 
-
+    def test_send_voice(self):
-def test_send_voice():
         file_data = open('./test_data/record.ogg', 'rb')
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_voice(CHAT_ID, file_data)
         assert ret_msg.voice.mime_type == 'audio/ogg'
 
-
+    def test_send_message(self):
-def test_send_message():
         text = 'CI Test Message'
         tb = telebot.TeleBot(TOKEN)
         ret_msg = tb.send_message(CHAT_ID, text)
         assert ret_msg.message_id
 
-
+    def test_forward_message(self):
-def test_forward_message():
         text = 'CI forward_message Test Message'
         tb = telebot.TeleBot(TOKEN)
         msg = tb.send_message(CHAT_ID, text)
         ret_msg = tb.forward_message(CHAT_ID, CHAT_ID, msg.message_id)
         assert ret_msg.forward_from
 
-
+    def test_reply_to(self):
-def test_reply_to():
         text = 'CI reply_to Test Message'
         tb = telebot.TeleBot(TOKEN)
         msg = tb.send_message(CHAT_ID, text)
         ret_msg = tb.reply_to(msg, text + ' REPLY')
         assert ret_msg.reply_to_message.message_id == msg.message_id
 
-
+    def test_register_for_reply(self):
-def test_register_for_reply():
         text = 'CI reply_to Test Message'
         tb = telebot.TeleBot(TOKEN)
         msg = tb.send_message(CHAT_ID, text, reply_markup=types.ForceReply())
@@ -167,8 +159,7 @@ def test_register_for_reply():
 
         tb.process_new_messages([reply_msg])
 
-
+    def test_send_location(self):
-def test_send_location():
         tb = telebot.TeleBot(TOKEN)
         lat = 26.3875591
         lon = -161.2901042
@@ -176,25 +167,19 @@ def test_send_location():
         assert int(ret_msg.location.longitude) == int(lon)
         assert int(ret_msg.location.latitude) == int(lat)
 
-
+    def create_text_message(self, text):
-def create_text_message(text):
         params = {'text': text}
         chat = types.User(11, 'test')
         return types.Message(1, None, None, chat, 'text', params)
 
-
+    def test_is_string_unicode(self):
-def test_is_string_unicode():
         s1 = u'string'
         assert apihelper.is_string(s1)
 
-
+    def test_is_string_string(self):
-def test_is_string_string():
         s1 = 'string'
         assert apihelper.is_string(s1)
 
-
+    def test_not_string(self):
-def test_not_string():
         i1 = 10
         assert not apihelper.is_string(i1)
-
-test_send_voice()