Releasing v2.9.2

Decode Emoji byte strings into unicode strings if using Python 3 (Alternative)

.travis.yml

@@ -8,6 +8,7 @@ python:
   - "pypy3"
 install:
   - pip install coveralls
+  - pip install -r requirements.txt
 script:
   nosetests --with-coverage --cover-package telegram/
 after_success:

AUTHORS.rst

@@ -13,6 +13,7 @@ The following wonderful people contributed directly or indirectly to this projec
 - `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
 - `franciscod <https://github.com/franciscod>`_
 - `JASON0916 <https://github.com/JASON0916>`_
+- `jh0ker <https://github.com/jh0ker>`_
 - `JRoot3D <https://github.com/JRoot3D>`_
 - `macrojames <https://github.com/macrojames>`_
 - `njittam <https://github.com/njittam>`_

CHANGES.rst

@@ -1,182 +1,266 @@
-2015-09-24
-  Released 2.8.5
-  Handles HTTP Bad Gateway (503) errors on request
-  Fixes regression on Audio and Document for unicode fields
+**2015-11-11**
 
+*Released 2.9.2*
 
-2015-09-20
-  Released 2.8.4
-  getFile and File.download is now fully supported
+- Error handling on request timeouts has been improved
 
+**2015-11-10**
 
-2015-09-10
-  Released 2.8.3
-  Moved Bot._requestURL to its own class (telegram.utils.request)
-  Much better, such wow, Telegram Objects tests
-  Add consistency for str properties on Telegram Objects
-  Better design to test if chat_id is invalid
-  Add ability to set custom filename on Bot.sendDocument(..,filename='')
-  Fix Sticker as InputFile
-  Send JSON requests over urlencoded post data
-  Markdown support for Bot.sendMessage(..., parse_mode=ParseMode.MARKDOWN)
-  Refactor of TelegramError class (no more handling IOError or URLError)
+*Released 2.9.1*
 
+- Add parameter ``network_delay`` to Bot.getUpdates for slow connections
 
-2015-09-05
-  Released 2.8.2
-  Fix regression on Telegram ReplyMarkup
-  Add certificate to is_inputfile method
+**2015-11-10**
 
+*Released 2.9*
 
-2015-09-05
-  Released 2.8.1
-  Fix regression on Telegram objects with thumb properties
+- Emoji class now uses ``bytes_to_native_str`` from ``future`` 3rd party lib
+- Make ``user_from`` optional to work with channels
+- Raise exception if Telegram times out on long-polling
 
+*Special thanks to @jh0ker for all hard work*
 
-2015-09-04
-  Released 2.8
-  TelegramError when chat_id is empty for send* methods
-  setWebhook now supports sending self-signed certificate
-  Huge redesign of existing Telegram classes
-  Added support for PyPy
-  Added docstring for existing classes
 
+**2015-10-08**
 
-2015-08-19
-  Released 2.7.1
-  Fixed JSON serialization for message
+*Released 2.8.7*
 
+- Type as optional for ``GroupChat`` class
 
-2015-08-17
-  Released 2.7
-  Added support for Voice object and sendVoice method
-  Due backward compatibility performer or/and title will be required for sendAudio
-  Fixed JSON serialization when forwarded message
 
+**2015-10-08**
 
-2015-08-15
-  Released 2.6.1
-  Fixed parsing image header issue on < Python 2.7.3
+*Released 2.8.6*
 
+- Adds type to ``User`` and ``GroupChat`` classes (pre-release Telegram feature)
 
-2015-08-14
-  Released 2.6.0
-  Depreciation of require_authentication and clearCredentials methods
-  Giving AUTHORS the proper credits for their contribution for this project
-  Message.date and Message.forward_date are now datetime objects
 
+**2015-09-24**
 
-2015-08-12
-  Released 2.5.3
-  telegram.Bot now supports to be unpickled
+*Released 2.8.5*
 
+- Handles HTTP Bad Gateway (503) errors on request
+- Fixes regression on ``Audio`` and ``Document`` for unicode fields
 
-2015-08-11
-  Released 2.5.2
-  New changes from Telegram Bot API have been applied
-  telegram.Bot now supports to be pickled
-  Return empty str instead None when message.text is empty
 
+**2015-09-20**
 
-2015-08-10
-  Released 2.5.1
-  Moved from GPLv2 to LGPLv3
+*Released 2.8.4*
 
+- ``getFile`` and ``File.download`` is now fully supported
 
-2015-08-09
-  Released 2.5
-  Fixes logging calls in API
 
+**2015-09-10**
 
-2015-08-08
-  Released 2.4
-  Fixes Emoji class for Python 3
-  PEP8 improvements
+*Released 2.8.3*
 
+- Moved ``Bot._requestURL`` to its own class (``telegram.utils.request``)
+- Much better, such wow, Telegram Objects tests
+- Add consistency for ``str`` properties on Telegram Objects
+- Better design to test if ``chat_id`` is invalid
+- Add ability to set custom filename on ``Bot.sendDocument(..,filename='')``
+- Fix Sticker as ``InputFile``
+- Send JSON requests over urlencoded post data
+- Markdown support for ``Bot.sendMessage(..., parse_mode=ParseMode.MARKDOWN)``
+- Refactor of ``TelegramError`` class (no more handling ``IOError`` or ``URLError``)
 
-2015-08-08
-  Released 2.3
-  Fixes ForceReply class
-  Remove logging.basicConfig from library
 
+**2015-09-05**
 
-2015-07-25
-  Released 2.2
-  Allows debug=True when initializing telegram.Bot
+*Released 2.8.2*
 
+- Fix regression on Telegram ReplyMarkup
+- Add certificate to ``is_inputfile`` method
 
-2015-07-20
-  Released 2.1
-  Fix to_dict for Document and Video
 
+**2015-09-05**
 
-2015-07-19
+*Released 2.8.1*
 
-  Released 2.0
-  Fixes bugs
-  Improves __str__ over to_json()
-  Creates abstractclass TelegramObject
+- Fix regression on Telegram objects with thumb properties
 
 
-2015-07-15
+**2015-09-04**
 
-  Released 1.9
-  Python 3 officially supported
-  PEP8 improvements
+*Released 2.8*
 
+- TelegramError when ``chat_id`` is empty for send* methods
+- ``setWebhook`` now supports sending self-signed certificate
+- Huge redesign of existing Telegram classes
+- Added support for PyPy
+- Added docstring for existing classes
 
-2015-07-12
 
-  Released 1.8
-  Fixes crash when replying an unicode text message (special thanks to JRoot3D)
+**2015-08-19**
 
+*Released 2.7.1*
 
-2015-07-11
+- Fixed JSON serialization for ``message``
 
-  Released 1.7
-  Fixes crash when username is not defined on chat (special thanks to JRoot3D)
 
+**2015-08-17**
 
-2015-07-10
+*Released 2.7*
 
-  Released 1.6
-  Improvements for GAE support
+- Added support for ``Voice`` object and ``sendVoice`` method
+- Due backward compatibility performer or/and title will be required for ``sendAudio``
+- Fixed JSON serialization when forwarded message
 
 
-2015-07-10
+**2015-08-15**
 
-  Released 1.5
-  Fixes randomly unicode issues when using InputFile
+*Released 2.6.1*
 
+- Fixed parsing image header issue on < Python 2.7.3
 
-2015-07-10
 
-  Released 1.4
-  requests lib is no longer required
-  Google App Engine (GAE) is supported
+**2015-08-14**
 
+*Released 2.6.0*
 
-2015-07-10
+- Depreciation of ``require_authentication`` and ``clearCredentials`` methods
+- Giving ``AUTHORS`` the proper credits for their contribution for this project
+- ``Message.date`` and ``Message.forward_date`` are now ``datetime`` objects
 
-  Released 1.3
-  Added support to setWebhook (special thanks to macrojames)
 
+**2015-08-12**
 
-2015-07-09
+*Released 2.5.3*
 
-  Released 1.2
-  CustomKeyboard classes now available
-  Emojis available
-  PEP8 improvements
+- ``telegram.Bot`` now supports to be unpickled
 
 
-2015-07-08
+**2015-08-11**
 
-  Released 1.1
-  PyPi package now available
+*Released 2.5.2*
 
+- New changes from Telegram Bot API have been applied
+- ``telegram.Bot`` now supports to be pickled
+- Return empty ``str`` instead ``None`` when ``message.text`` is empty
 
-2015-07-08
 
-  Released 1.0
-  Initial checkin of python-telegram-bot
+**2015-08-10**
+
+*Released 2.5.1*
+
+- Moved from GPLv2 to LGPLv3
+
+
+**2015-08-09**
+
+*Released 2.5*
+
+- Fixes logging calls in API
+
+
+**2015-08-08**
+
+*Released 2.4*
+
+- Fixes ``Emoji`` class for Python 3
+- ``PEP8`` improvements
+
+
+**2015-08-08**
+
+*Released 2.3*
+
+- Fixes ``ForceReply`` class
+- Remove ``logging.basicConfig`` from library
+
+
+**2015-07-25**
+
+*Released 2.2*
+
+- Allows ``debug=True`` when initializing ``telegram.Bot``
+
+
+**2015-07-20**
+
+*Released 2.1*
+
+- Fix ``to_dict`` for ``Document`` and ``Video``
+
+
+**2015-07-19**
+
+*Released 2.0*
+
+- Fixes bugs
+- Improves ``__str__`` over ``to_json()``
+- Creates abstract class ``TelegramObject``
+
+
+**2015-07-15**
+
+*Released 1.9*
+
+- Python 3 officially supported
+- ``PEP8`` improvements
+
+
+**2015-07-12**
+
+*Released 1.8*
+
+- Fixes crash when replying an unicode text message (special thanks to JRoot3D)
+
+
+**2015-07-11**
+
+*Released 1.7*
+
+- Fixes crash when ``username`` is not defined on ``chat`` (special thanks to JRoot3D)
+
+
+**2015-07-10**
+
+*Released 1.6*
+
+- Improvements for GAE support
+
+
+**2015-07-10**
+
+*Released 1.5*
+
+- Fixes randomly unicode issues when using ``InputFile``
+
+
+**2015-07-10**
+
+*Released 1.4*
+
+- ``requests`` lib is no longer required
+- Google App Engine (GAE) is supported
+
+
+**2015-07-10**
+
+*Released 1.3*
+
+- Added support to ``setWebhook`` (special thanks to macrojames)
+
+
+**2015-07-09**
+
+*Released 1.2*
+
+- ``CustomKeyboard`` classes now available
+- Emojis available
+- ``PEP8`` improvements
+
+
+**2015-07-08**
+
+*Released 1.1*
+
+- PyPi package now available
+
+
+**2015-07-08**
+
+*Released 1.0*
+
+- Initial checkin of python-telegram-bot

MANIFEST.in

@@ -1 +1 @@
-include LICENSE LICENSE.lesser Makefile
+include LICENSE LICENSE.lesser Makefile requirements.txt

Makefile

@@ -1,4 +1,4 @@
-.PHONY: clean pep8 lint test
+.PHONY: clean pep8 lint test install
 
 clean:
 	rm -fr build
@@ -16,6 +16,9 @@ lint:
 test:
 	nosetests
 
+install:
+	pip install -r requirements.txt
+
 help:
 	@echo "Available targets:"
 	@echo "- clean       Clean up the source directory"

README.rst

@@ -2,6 +2,8 @@ Python Telegram Bot
 
 A Python wrapper around the Telegram Bot API.
 
+*Stay tuned for library updates and new releases on our* `Telegram Channel <http://telegram.me/pythontelegrambotchannel>`_.
+
 By `Leandro Toledo <leandrotoledodesouza@gmail.com>`_
 
 .. image:: https://img.shields.io/pypi/v/python-telegram-bot.svg
@@ -16,7 +18,7 @@ By `Leandro Toledo <leandrotoledodesouza@gmail.com>`_
    :target: https://readthedocs.org/projects/python-telegram-bot/?badge=latest
    :alt: Documentation Status
 
-.. image:: https://img.shields.io/github/license/leandrotoledo/python-telegram-bot.svg
+.. image:: https://img.shields.io/pypi/l/python-telegram-bot.svg
    :target: http://www.gnu.org/licenses/lgpl-3.0.html
    :alt: LGPLv3 License
 

docs/source/conf.py

@@ -58,9 +58,9 @@ author = u'Leandro Toledo'
 # built documents.
 #
 # The short X.Y version.
-version = '2.8'
+version = '2.9'
 # The full version, including alpha/beta/rc tags.
-release = '2.8.5'
+release = '2.9.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

examples/echobot.py

@@ -51,15 +51,15 @@ def echo(bot):
     for update in bot.getUpdates(offset=LAST_UPDATE_ID, timeout=10):
         # chat_id is required to reply any message
         chat_id = update.message.chat_id
-        message = update.message.text.encode('utf-8')
+        reply_text = update.message.text
 
-        if (message):
+        if reply_text:
             # Reply the message
             bot.sendMessage(chat_id=chat_id,
-                            text=message)
+                            text=reply_text)
 
-            # Updates global offset to get the new updates
-            LAST_UPDATE_ID = update.update_id + 1
+        # Updates global offset to get the new updates
+        LAST_UPDATE_ID = update.update_id + 1
 
 
 if __name__ == '__main__':

requirements.txt

@@ -0,0 +1 @@
+future

setup.py

@@ -13,9 +13,20 @@ def read(*paths):
         return f.read()
 
 
+def requirements():
+    """Build the requirements list for this project"""
+    requirements_list = []
+
+    with open('requirements.txt') as requirements:
+        for install in requirements:
+            requirements_list.append(install.strip())
+
+    return requirements_list
+
+
 setup(
     name='python-telegram-bot',
-    version='2.8.5',
+    version='2.9.2',
     author='Leandro Toledo',
     author_email='leandrotoledodesouza@gmail.com',
     license='LGPLv3',
@@ -24,6 +35,7 @@ setup(
     description='A Python wrapper around the Telegram Bot API',
     long_description=(read('README.rst')),
     packages=find_packages(exclude=['tests*']),
+    install_requires=requirements(),
     include_package_data=True,
     classifiers=[
         'Development Status :: 5 - Production/Stable',

telegram/__init__.py

@@ -19,7 +19,7 @@
 """A library that provides a Python interface to the Telegram Bot API"""
 
 __author__ = 'leandrotoledodesouza@gmail.com'
-__version__ = '2.8.5'
+__version__ = '2.8.7'
 
 from .base import TelegramObject
 from .user import User

telegram/bot.py

@@ -649,7 +649,8 @@ class Bot(TelegramObject):
     def getUpdates(self,
                    offset=None,
                    limit=100,
-                   timeout=0):
+                   timeout=0,
+                   network_delay=2.):
         """Use this method to receive incoming updates using long polling.
 
         Args:
@@ -665,6 +666,11 @@ class Bot(TelegramObject):
           timeout:
             Timeout in seconds for long polling. Defaults to 0, i.e. usual
             short polling.
+          network_delay:
+            Additional timeout in seconds to allow the response from Telegram
+            to take some time when using long polling. Defaults to 2, which
+            should be enough for most connections. Increase it if it takes very
+            long for data to be transmitted from and to the Telegram servers.
 
         Returns:
           A list of telegram.Update objects are returned.
@@ -680,7 +686,7 @@ class Bot(TelegramObject):
         if timeout:
             data['timeout'] = timeout
 
-        result = request.post(url, data)
+        result = request.post(url, data, network_delay=network_delay)
 
         if result:
             self.logger.info(

telegram/groupchat.py

@@ -33,17 +33,21 @@ class GroupChat(TelegramObject):
     Args:
         id (int):
         title (str):
-        type (str):
+        **kwargs: Arbitrary keyword arguments.
+
+    Keyword Args:
+        type (Optional[str]):
     """
 
     def __init__(self,
                  id,
                  title,
-                 type):
+                 **kwargs):
         # Required
         self.id = int(id)
         self.title = title
-        self.type = type
+        # Optionals
+        self.type = kwargs.get('type', '')
 
     @staticmethod
     def de_json(data):

telegram/message.py

@@ -134,7 +134,7 @@ class Message(TelegramObject):
         if not data:
             return None
 
-        data['from_user'] = User.de_json(data['from'])
+        data['from_user'] = User.de_json(data.get('from'))
         data['date'] = datetime.fromtimestamp(data['date'])
         if 'first_name' in data.get('chat', ''):
             data['chat'] = User.de_json(data.get('chat'))
@@ -185,7 +185,7 @@ class Message(TelegramObject):
         data = super(Message, self).to_dict()
 
         # Required
-        data['from'] = data.pop('from_user')
+        data['from'] = data.pop('from_user', None)
         data['date'] = self._totimestamp(self.date)
         # Optionals
         if self.forward_date:

telegram/parsemode.py

@@ -17,7 +17,8 @@
 # You should have received a copy of the GNU Lesser Public License
 # along with this program.  If not, see [http://www.gnu.org/licenses/].
 
-"""This module contains a object that represents a Telegram Message Parse Modes"""
+"""This module contains a object that represents a Telegram
+Message Parse Modes"""
 
 
 class ParseMode(object):

telegram/utils/request.py

@@ -20,15 +20,16 @@
 """This module contains methods to make POST and GET requests"""
 
 import json
+import socket
+from ssl import SSLError
 
 try:
-    from urllib.parse import urlencode
     from urllib.request import urlopen, urlretrieve, Request
-    from urllib.error import HTTPError, URLError
+    from urllib.error import HTTPError
 except ImportError:
-    from urllib import urlencode, urlretrieve
+    from urllib import urlretrieve
     from urllib2 import urlopen, Request
-    from urllib2 import HTTPError, URLError
+    from urllib2 import HTTPError
 
 from telegram import (InputFile, TelegramError)
 
@@ -67,17 +68,29 @@ def get(url):
 
 
 def post(url,
-         data):
+         data,
+         network_delay=2.):
     """Request an URL.
     Args:
       url:
         The web location we want to retrieve.
       data:
         A dict of (str, unicode) key/value pairs.
+      network_delay:
+        Additional timeout in seconds to allow the response from Telegram to
+        take some time.
 
     Returns:
       A JSON object.
     """
+
+    # Add time to the timeout of urlopen to allow data to be transferred over
+    # the network.
+    if 'timeout' in data:
+        timeout = data['timeout'] + network_delay
+    else:
+        timeout = None
+
     try:
         if InputFile.is_inputfile(data):
             data = InputFile(data)
@@ -90,7 +103,7 @@ def post(url,
                               data=data.encode(),
                               headers={'Content-Type': 'application/json'})
 
-        result = urlopen(request).read()
+        result = urlopen(request, timeout=timeout).read()
     except HTTPError as error:
         if error.getcode() == 403:
             raise TelegramError('Unauthorized')
@@ -99,7 +112,11 @@ def post(url,
 
         message = _parse(error.read())
         raise TelegramError(message)
+    except (SSLError, socket.timeout) as error:
+        if "operation timed out" in str(error):
+            raise TelegramError("Timed out")
 
+        raise TelegramError(str(error))
     return _parse(result)
 
 

tests/test_emoji.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python
+#
+# A library that provides a Python interface to the Telegram Bot API
+# Copyright (C) 2015 Leandro Toledo de Souza <leandrotoeldodesouza@gmail.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see [http://www.gnu.org/licenses/].
+
+"""This module contains a object that represents Tests for Telegram Emoji"""
+
+import os
+import unittest
+import sys
+sys.path.append('.')
+
+import telegram
+from telegram.emoji import Emoji
+from tests.base import BaseTest
+
+
+class EmojiTest(BaseTest, unittest.TestCase):
+    """This object represents Tests for Telegram Emoji."""
+
+    def test_emoji(self):
+        """Test Emoji class"""
+        print('Testing Emoji class')
+        
+        for attr in dir(Emoji):
+            if attr[0] != '_':  # TODO: dirty way to filter out functions
+                self.assertTrue(type(getattr(Emoji, attr)) is str)
+
+
+if __name__ == '__main__':
+    unittest.main()