Skip to content

Commit 2f113b1

Browse files
committed
Added apihelper tests
1 parent 0954b75 commit 2f113b1

6 files changed

Lines changed: 278 additions & 65 deletions

File tree

‎requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ pytest==2.7.2
33
requests==2.7.0
44
six==1.9.0
55
wheel==0.24.0
6+
mock==2.0.0

‎telebot/apihelper.py‎

Lines changed: 26 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,12 @@
1111
FILE_URL = "https://api.telegram.org/file/bot{0}/{1}"
1212

1313

14-
class RequestExecutorImpl:
14+
class RequestExecutor:
15+
def make_request(self, url, method='get', params=None, files=None, response_type='text'):
16+
raise NotImplementedError()
17+
18+
19+
class RequestExecutorImpl(RequestExecutor):
1520
DEFAULT_CONNECT_TIMEOUT = 3.5
1621
DEFAULT_READ_TIMEOUT = 9999
1722

@@ -33,7 +38,6 @@ def make_request(self, url, method='get', params=None, files=None, response_type
3338

3439

3540
class TelegramApiInterface:
36-
3741
def __init__(self, token, request_executor, api_url=API_URL, file_url=FILE_URL):
3842
self.token = token
3943
self.request_executor = request_executor
@@ -51,38 +55,25 @@ def convert_inline_results(results):
5155
:param results: list of InlineQueryResult objects
5256
:rtype: str
5357
"""
54-
converted_results = [r.to_json() for r in results]
58+
converted_results = [r.to_json() if isinstance(r, types.JsonSerializable) else r for r in results]
5559
return '[' + ','.join(converted_results) + ']'
5660

57-
@staticmethod
58-
def __merge(*dicts):
59-
"""
60-
Merges two or more dicts into one, and deletes any keys which' associated values are equal to None.
61-
:rtype: dict
62-
"""
63-
d = util.merge_dicts(*dicts)
64-
copy = d.copy()
65-
for k, v in six.iteritems(d.copy()):
66-
if v is None:
67-
del copy[k]
68-
return copy
69-
7061
def make_request(self, method_name, params=None, files=None, method='get', response_type='json'):
71-
if params is not None and 'reply_markup' in params:
72-
params['reply_markup'] = self.convert_markup(params['reply_markup'])
7362
request_url = self.api_url.format(self.token, method_name)
7463
try:
7564
response = self.request_executor.make_request(request_url, method, params, files, response_type)
7665
return response
7766
except Exception as e:
78-
raise ApiException(e.message, method_name)
67+
raise ApiException(repr(e), method_name)
7968

8069
def make_json_request(self, method_name, params=None, files=None, method='post', return_type=None):
8170
if params is not None and 'reply_markup' in params:
8271
params['reply_markup'] = self.convert_markup(params['reply_markup'])
72+
8373
response = self.make_request(method_name, params, files, method, response_type='json')
8474
if not response['ok']:
85-
raise ApiException('Error code: {error_code} Description: {description}' .format(**response), method)
75+
raise ApiException('Error code: {error_code} Description: {description}'.format(**response), method)
76+
8677
if hasattr(return_type, 'de_json'):
8778
return return_type.de_json(response['result'])
8879
return response['result']
@@ -95,7 +86,7 @@ def get_updates(self, **kwargs):
9586
:param timeout: Integer. Timeout in seconds for long polling.
9687
:return: list of Updates
9788
"""
98-
json_updates = self.make_json_request('getUpdates', params=self.__merge(kwargs))
89+
json_updates = self.make_json_request('getUpdates', params=util.xmerge(kwargs))
9990
return [types.Update.de_json(update) for update in json_updates]
10091

10192
def get_me(self):
@@ -126,13 +117,13 @@ def send_message(self, chat_id, text, **kwargs):
126117
:rtype types.Message
127118
"""
128119
payload = {'chat_id': str(chat_id), 'text': text}
129-
return self.make_json_request('sendMessage', self.__merge(payload, kwargs), return_type=types.Message)
120+
return self.make_json_request('sendMessage', params=util.xmerge(payload, kwargs), return_type=types.Message)
130121

131122
def set_webhook(self, certificate=None, **kwargs):
132123
files = None
133124
if certificate is not None:
134125
files = {'certificate': certificate}
135-
return self.make_json_request('setWebhook', params=self.__merge(kwargs), files=files)
126+
return self.make_json_request('setWebhook', params=util.xmerge(kwargs), files=files)
136127

137128
def get_user_profile_photos(self, user_id, **kwargs):
138129
"""
@@ -143,7 +134,7 @@ def get_user_profile_photos(self, user_id, **kwargs):
143134
:param limit:
144135
:return: API reply.
145136
"""
146-
params = self.__merge({'user_id': user_id}, kwargs)
137+
params = util.xmerge({'user_id': user_id}, kwargs)
147138
return self.make_json_request('getUserProfilePhotos', params=params, return_type=types.UserProfilePhotos)
148139

149140
def forward_message(self, chat_id, from_chat_id, message_id, **kwargs):
@@ -155,14 +146,13 @@ def forward_message(self, chat_id, from_chat_id, message_id, **kwargs):
155146
:param message_id: message id
156147
:return: API reply.
157148
"""
158-
params = self.__merge({
149+
params = util.xmerge({
159150
'chat_id': chat_id,
160151
'from_chat_id': from_chat_id,
161152
'message_id': message_id
162153
}, kwargs)
163154
return self.make_json_request('forwardMessage', params=params, return_type=types.Message)
164155

165-
166156
def send_location(self, chat_id, latitude, longitude, **kwargs):
167157
"""
168158
Use this method to send point on the map.
@@ -174,7 +164,7 @@ def send_location(self, chat_id, latitude, longitude, **kwargs):
174164
:param reply_markup:
175165
:return: API reply.
176166
"""
177-
params = self.__merge({'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude}, kwargs)
167+
params = util.xmerge({'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude}, kwargs)
178168
return self.make_json_request('sendLocation', params=params, return_type=types.Message)
179169

180170
def send_venue(self, chat_id, latitude, longitude, title, address, **kwargs):
@@ -192,11 +182,11 @@ def send_venue(self, chat_id, latitude, longitude, title, address, **kwargs):
192182
:return:
193183
"""
194184
params = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude, 'title': title, 'address': address}
195-
params = self.__merge(params, kwargs)
185+
params = util.xmerge(params, kwargs)
196186
return self.make_json_request('sendVenue', params=params, return_type=types.Message)
197187

198188
def send_contact(self, chat_id, phone_number, first_name, **kwargs):
199-
params = self.__merge({'chat_id': chat_id, 'phone_number': phone_number, 'first_name': first_name}, kwargs)
189+
params = util.xmerge({'chat_id': chat_id, 'phone_number': phone_number, 'first_name': first_name}, kwargs)
200190
return self.make_json_request('sendContact', params=params, return_type=types.Message)
201191

202192
def send_chat_action(self, chat_id, action):
@@ -297,7 +287,7 @@ def send_data(self, data_type, chat_id, data, **kwargs):
297287
files = {data_type: data}
298288
else:
299289
params[data_type] = data
300-
params = self.__merge(params, kwargs)
290+
params = util.xmerge(params, kwargs)
301291
method = self.get_method_by_type(data_type)
302292
return self.make_json_request(method, params=params, files=files, return_type=types.Message)
303293

@@ -325,16 +315,16 @@ def unban_chat_member(self, chat_id, user_id):
325315
return self.make_json_request('unbanChatMember', params={'chat_id': chat_id, 'user_id': user_id})
326316

327317
def edit_message_text(self, text, **kwargs):
328-
params = self.__merge({'text': text}, kwargs)
318+
params = util.xmerge({'text': text}, kwargs)
329319
response = self.make_json_request('editMessageText', params=params)
330320
return response if type(response) == bool else types.Message.de_json(response)
331321

332322
def edit_message_caption(self, caption, **kwargs):
333-
params = self.__merge({'caption': caption}, kwargs)
323+
params = util.xmerge({'caption': caption}, kwargs)
334324
return self.make_json_request('editMessageCaption', params=params, return_type=types.Message)
335325

336326
def edit_message_reply_markup(self, **kwargs):
337-
return self.make_json_request('editMessageReplyMarkup', params=self.__merge(kwargs), return_type=types.Message)
327+
return self.make_json_request('editMessageReplyMarkup', params=util.xmerge(kwargs), return_type=types.Message)
338328

339329
def answer_callback_query(self, callback_query_id, **kwargs):
340330
"""
@@ -345,7 +335,7 @@ def answer_callback_query(self, callback_query_id, **kwargs):
345335
:param show_alert:
346336
:return:
347337
"""
348-
params = self.__merge({'callback_query_id': callback_query_id}, kwargs)
338+
params = util.xmerge({'callback_query_id': callback_query_id}, kwargs)
349339
return self.make_json_request('answerCallbackQuery', params=params)
350340

351341
def answer_inline_query(self, inline_query_id, results, **kwargs):
@@ -362,7 +352,7 @@ def answer_inline_query(self, inline_query_id, results, **kwargs):
362352
:param switch_pm_text: Parameter for the start message sent to the bot when user presses the switch button
363353
:return: True means success.
364354
"""
365-
params = self.__merge({
355+
params = util.xmerge({
366356
'inline_query_id': inline_query_id,
367357
'results': self.convert_inline_results(results)
368358
}, kwargs)
@@ -376,6 +366,7 @@ class ApiException(Exception):
376366
contain the name of the failed function and the returned result that made the function to be considered as
377367
failed.
378368
"""
369+
379370
def __init__(self, msg, function_name=None, result=None):
380371
super(ApiException, self).__init__("A request to the Telegram API was unsuccessful. {0}".format(msg))
381372
self.function_name = function_name

‎telebot/types.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import json
44
import six
55

6-
from telebot import util
6+
import util
77

88

99
class JsonSerializable:

‎telebot/util.py‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -269,3 +269,16 @@ def merge_dicts(*dicts):
269269
for dictionary in dicts:
270270
result.update(dictionary)
271271
return result
272+
273+
274+
def xmerge(*dicts):
275+
"""
276+
Merges two or more dicts into one, and deletes any keys which' associated values are equal to None.
277+
:rtype: dict
278+
"""
279+
d = merge_dicts(*dicts)
280+
copy = d.copy()
281+
for k, v in six.iteritems(d.copy()):
282+
if v is None:
283+
del copy[k]
284+
return copy

0 commit comments

Comments
 (0)