Version up, thanks to @kapi2289 and @2FWAH

[Feature] Quick replies

.travis.yml

@@ -1,90 +1,50 @@
 sudo: false
 language: python
-conditions: v1
+python: 3.6
 
-# There are two accounts made specifically for Travis, and the passwords are really only encrypted for obscurity
-# The global env variables `client1_email`, `client1_password`, `client2_email`, `client2_password` and `group_id`
-# are set on the Travis Settings page
+cache: pip
 
-# The tests are run with `Limit concurrent jobs = 1`, since the tests can't use the clients simultaneously
-
-install:
-  - pip install -U -r requirements.txt
-  - pip install -U -r dev-requirements.txt
-
-cache:
-  pip: true
-  # Pytest caching is disabled, since TravisCI instances have different public IPs. Facebook  doesn't like that,
-  # and redirects you to the url `/checkpoint/block`, where you have to change the account's password
-  # directories:
-  #   - .pytest_cache
+before_install: pip install flit
+install: flit install --deps production --extras test
+script: pytest -m offline
 
 jobs:
   include:
-    # The tests are split into online and offline versions.
-    # The online tests are only run against the master branch.
-    # Because:
-    # Travis caching is per-branch and per-job, so even though we cache the Facebook sessions via. `.pytest_cache`
-    # and in `tests.utils.load_client`, we need 6 new sessions per branch. This is usually the point where Facebook
-    # starts complaining, and we have to manually fix it
+  - python: 2.7
+    before_install:
+    - sudo apt-get -y install python3-pip python3-setuptools
+    - sudo pip3 install flit
+    install: flit install --python python --deps production --extras test
+  - python: 3.4
+  - python: 3.5
+  - python: 3.6
+  - python: 3.7
+    dist: xenial
+    sudo: required
+  - python: pypy3.5
 
-    - &test-online
-      if: (branch = master OR tag IS present) AND type != pull_request
-      stage: online tests
-      script: scripts/travis-online
-
-    # Run online tests in all the supported python versions
-      python: 2.7
-    - <<: *test-online
-      python: 3.4
-    - <<: *test-online
-      python: 3.5
-    - <<: *test-online
-      python: 3.6
-    - <<: *test-online
-      python: pypy
-
-    # Run the expensive tests, with the python version most likely to break, aka. 2
-    - <<: *test-online
-      # Only run if the commit message includes [ci all] or [all ci]
-      if: commit_message =~ /\[ci\s+all\]|\[all\s+ci\]/
-      python: 2.7
-      env: PYTEST_ADDOPTS='-m expensive'
-
-    - &test-offline
-      # Ideally, it'd be nice to run the offline tests in every build, but since we can't run jobs concurrently (yet),
-      # we'll disable them when they're not needed, and include them inside the online tests instead
-      if: not ((branch = master OR tag IS present) AND type != pull_request)
-      stage: offline tests
-      script: scripts/travis-offline
-
-    # Run offline tests in all the supported python versions
-      python: 2.7
-    - <<: *test-offline
-      python: 3.4
-    - <<: *test-offline
-      python: 3.5
-    - <<: *test-offline
-      python: 3.6
-    - <<: *test-offline
-      python: 3.6
-    - <<: *test-offline
-      python: pypy
-
-    # Deploy to PyPI
-    - &deploy
-      stage: deploy
-      if: branch = master AND tag IS present
+  - stage: deploy
+    name: Github Releases
+    if: tag IS present
     install: skip
+    script: flit build
     deploy:
-        provider: pypi
-        user: madsmtm
-        password:
-          secure: "VA0MLSrwIW/T2KjMwjLZCzrLHw8pJT6tAvb48t7qpBdm8x192hax61pz1TaBZoJvlzyBPFKvluftuclTc7yEFwzXe7Gjqgd/ODKZl/wXDr36hQ7BBOLPZujdwmWLvTzMh3eJZlvkgcLCzrvK3j2oW8cM/+FZeVi/5/FhVuJ4ofs="
-        distributions: sdist bdist_wheel
-        skip_existing: true
+      provider: releases
+      api_key: $GITHUB_OAUTH_TOKEN
+      file_glob: true
+      file: dist/*
+      skip_cleanup: true
+      draft: true
+      on:
+        tags: true
 
-    # We need the bdist_wheels from both Python 2 and 3
-      python: 3.6
-    - <<: *deploy
-      python: 2.7
+  - stage: deploy
+    name: PyPI
+    if: tag IS present
+    install: skip
+    script: skip
+    deploy:
+      provider: script
+      script: flit publish
+      on:
+        tags: true

MANIFEST.in

@@ -1,3 +0,0 @@
-include LICENSE
-include CONTRIBUTING.rst
-include README.rst

README.rst

@@ -5,9 +5,9 @@ fbchat: Facebook Chat (Messenger) for Python
     :target: https://github.com/carpedm20/fbchat/tree/master/LICENSE
     :alt: License: BSD 3-Clause
 
-.. image:: https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6%20pypy-blue.svg
+.. image:: https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6%203.7%20pypy-blue.svg
     :target: https://pypi.python.org/pypi/fbchat
-    :alt: Supported python versions: 2.7, 3.4, 3.5, 3.6 and pypy
+    :alt: Supported python versions: 2.7, 3.4, 3.5, 3.6, 3.7 and pypy
 
 .. image:: https://readthedocs.org/projects/fbchat/badge/?version=master
     :target: https://fbchat.readthedocs.io
@@ -27,17 +27,18 @@ or jump right into the code by viewing the `examples <https://github.com/carpedm
 
 Installation:
 
-.. code-block:: console
+.. code-block::
 
     $ pip install fbchat
 
-You can also install from source, by using `setuptools` (You need at least version 30.3.0):
+You can also install from source, by using `flit`:
 
-.. code-block:: console
+.. code-block::
 
+    $ pip install flit
     $ git clone https://github.com/carpedm20/fbchat.git
     $ cd fbchat
-    $ python setup.py install
+    $ flit install
 
 
 Maintainer

dev-requirements.txt

@@ -1,2 +0,0 @@
-pytest
-six

docs/api.rst

@@ -13,7 +13,7 @@ If you are looking for information on a specific function, class, or method, thi
 Client
 ------
 
-This is the main class of `fbchat`, which contains all the methods you use to interract with Facebook.
+This is the main class of `fbchat`, which contains all the methods you use to interact with Facebook.
 You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening)
 
 .. autoclass:: Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO)

docs/examples.rst

@@ -18,7 +18,7 @@ This will show basic usage of `fbchat`
 Interacting with Threads
 ------------------------
 
-This will interract with the thread in every way `fbchat` supports
+This will interact with the thread in every way `fbchat` supports
 
 .. literalinclude:: ../examples/interract.py
 

docs/faq.rst

@@ -8,7 +8,7 @@ FAQ
 Version X broke my installation
 -------------------------------
 
-We try to provide backwards compatability where possible, but since we're not part of Facebook,
+We try to provide backwards compatibility where possible, but since we're not part of Facebook,
 most of the things may be broken at any point in time
 
 Downgrade to an earlier version of fbchat, run this command

docs/intro.rst

@@ -6,7 +6,7 @@ Introduction
 ============
 
 `fbchat` uses your email and password to communicate with the Facebook server.
-That means that you should always store your password in a seperate file, in case e.g. someone looks over your shoulder while you're writing code.
+That means that you should always store your password in a separate file, in case e.g. someone looks over your shoulder while you're writing code.
 You should also make sure that the file's access control is appropriately restrictive
 
 
@@ -16,7 +16,7 @@ Logging In
 ----------
 
 Simply create an instance of :class:`Client`. If you have two factor authentication enabled, type the code in the terminal prompt
-(If you want to supply the code in another fasion, overwrite :func:`Client.on2FACode`)::
+(If you want to supply the code in another fashion, overwrite :func:`Client.on2FACode`)::
 
     from fbchat import Client
     from fbchat.models import *
@@ -50,7 +50,7 @@ A thread can refer to two things: A Messenger group chat or a single Facebook us
 
 :class:`models.ThreadType` is an enumerator with two values: ``USER`` and ``GROUP``.
 These will specify whether the thread is a single user chat or a group chat.
-This is required for many of `fbchat`'s functions, since Facebook differetiates between these two internally
+This is required for many of `fbchat`'s functions, since Facebook differentiates between these two internally
 
 Searching for group chats and finding their ID can be done via. :func:`Client.searchForGroups`,
 and searching for users is possible via. :func:`Client.searchForUsers`. See :ref:`intro_fetching`
@@ -141,7 +141,7 @@ Sessions
 --------
 
 `fbchat` provides functions to retrieve and set the session cookies.
-This will enable you to store the session cookies in a seperate file, so that you don't have to login each time you start your script.
+This will enable you to store the session cookies in a separate file, so that you don't have to login each time you start your script.
 Use :func:`Client.getSession` to retrieve the cookies::
 
     session_cookies = client.getSession()

fbchat/__init__.py

@@ -1,12 +1,7 @@
 # -*- coding: UTF-8 -*-
+"""Facebook Chat (Messenger) for Python
 
-"""
-    fbchat
-    ~~~~~~
-
-    Facebook Chat (Messenger) for Python
-
-    :copyright: (c) 2015 - 2018 by Taehoon Kim
+:copyright: (c) 2015 - 2019 by Taehoon Kim
 :license: BSD 3-Clause, see LICENSE for more details.
 """
 
@@ -15,10 +10,10 @@ from __future__ import unicode_literals
 from .client import *
 
 __title__ = 'fbchat'
-__version__ = '1.4.1'
+__version__ = '1.6.0'
 __description__ = 'Facebook Chat (Messenger) for Python'
 
-__copyright__ = 'Copyright 2015 - 2018 by Taehoon Kim'
+__copyright__ = 'Copyright 2015 - 2019 by Taehoon Kim'
 __license__ = 'BSD 3-Clause'
 
 __author__ = 'Taehoon Kim; Moreels Pieter-Jan; Mads Marquart'

fbchat/graphql.py

@@ -26,12 +26,11 @@ class ConcatJSONDecoder(json.JSONDecoder):
 def graphql_color_to_enum(color):
     if color is None:
         return None
-    if len(color) == 0:
+    if not color:
         return ThreadColor.MESSENGER_BLUE
-    try:
-        return ThreadColor('#{}'.format(color[2:].lower()))
-    except ValueError:
-        raise FBchatException('Could not get ThreadColor from color: {}'.format(color))
+    color = color[2:]  # Strip the alpha value
+    color_value = '#{}'.format(color.lower())
+    return enum_extend_if_invalid(ThreadColor, color_value)
 
 def get_customization_info(thread):
     if thread is None or thread.get('customization_info') is None:
@@ -128,9 +127,84 @@ def graphql_to_attachment(a):
             uid=a.get('legacy_attachment_id')
         )
 
+def graphql_to_extensible_attachment(a):
+    story = a.get('story_attachment')
+    if story:
+        target = story.get('target')
+        if target:
+            _type = target['__typename']
+            if _type == 'MessageLocation':
+                latitude, longitude = get_url_parameter(get_url_parameter(story['url'], 'u'), 'where1').split(", ")
+                rtn = LocationAttachment(
+                    uid=int(story['deduplication_key']),
+                    latitude=float(latitude),
+                    longitude=float(longitude),
+                )
+                if story['media']:
+                    rtn.image_url = story['media']['image']['uri']
+                    rtn.image_width = story['media']['image']['width']
+                    rtn.image_height = story['media']['image']['height']
+                rtn.url = story['url']
+                return rtn
+            elif _type == 'MessageLiveLocation':
+                rtn = LiveLocationAttachment(
+                    uid=int(story['target']['live_location_id']),
+                    latitude=story['target']['coordinate']['latitude'] if story['target'].get('coordinate') else None,
+                    longitude=story['target']['coordinate']['longitude'] if story['target'].get('coordinate') else None,
+                    name=story['title_with_entities']['text'],
+                    expiration_time=story['target']['expiration_time'] if story['target'].get('expiration_time') else None,
+                    is_expired=story['target']['is_expired'],
+                )
+                if story['media']:
+                    rtn.image_url = story['media']['image']['uri']
+                    rtn.image_width = story['media']['image']['width']
+                    rtn.image_height = story['media']['image']['height']
+                rtn.url = story['url']
+                return rtn
+            elif _type in ['ExternalUrl', 'Story']:
+                return ShareAttachment(
+                    uid=a.get('legacy_attachment_id'),
+                    author=story['target']['actors'][0]['id'] if story['target'].get('actors') else None,
+                    url=story['url'],
+                    original_url=get_url_parameter(story['url'], 'u') if "/l.php?u=" in story['url'] else story['url'],
+                    title=story['title_with_entities'].get('text'),
+                    description=story['description'].get('text'),
+                    source=story['source']['text'],
+                    image_url=story['media']['image']['uri'] if story.get('media') else None,
+                    original_image_url=(get_url_parameter(story['media']['image']['uri'], 'url') if "/safe_image.php" in story['media']['image']['uri'] else story['media']['image']['uri']) if story.get('media') else None,
+                    image_width=story['media']['image']['width'] if story.get('media') else None,
+                    image_height=story['media']['image']['height'] if story.get('media') else None,
+                    attachments=[graphql_to_subattachment(attachment) for attachment in story.get('subattachments')],
+                )
+        else:
+            return UnsentMessage(
+                uid=a.get('legacy_attachment_id'),
+            )
+
+
+def graphql_to_subattachment(a):
+    _type = a['target']['__typename']
+    if _type == 'Video':
+        return VideoAttachment(
+            duration=a['media'].get('playable_duration_in_ms'),
+            preview_url=a['media'].get('playable_url'),
+            medium_image=a['media'].get('image'),
+            uid=a['target'].get('video_id'),
+        )
+
+def graphql_to_live_location(a):
+    return LiveLocationAttachment(
+        uid=a['id'],
+        latitude=a['coordinate']['latitude'] / (10 ** 8) if not a.get('stopReason') else None,
+        longitude=a['coordinate']['longitude'] / (10 ** 8)  if not a.get('stopReason') else None,
+        name=a.get('locationTitle'),
+        expiration_time=a['expirationTime'],
+        is_expired=bool(a.get('stopReason')),
+    )
+
 def graphql_to_poll(a):
     rtn = Poll(
-        title=a.get('title') if a.get('title') else a.get("text"),
+        title=a.get('title') if a.get('title') else a.get('text'),
         options=[graphql_to_poll_option(m) for m in a.get('options')]
     )
     rtn.uid = int(a["id"])
@@ -193,6 +267,24 @@ def graphql_to_plan(a):
     rtn.invited = [m.get('node').get('id') for m in guests if m.get('guest_list_state') == "INVITED"]
     return rtn
 
+def graphql_to_quick_reply(q, is_response=False):
+    data = dict()
+    _type = q.get('content_type').lower()
+    if q.get('payload'): data["payload"] = q["payload"]
+    if q.get('data'): data["data"] = q["data"]
+    if q.get('image_url') and _type is not QuickReplyLocation._type: data["image_url"] = q["image_url"]
+    data["is_response"] = is_response
+    if _type == QuickReplyText._type:
+        if q.get('title') is not None: data["title"] = q["title"]
+        rtn = QuickReplyText(**data)
+    elif _type == QuickReplyLocation._type:
+        rtn = QuickReplyLocation(**data)
+    elif _type == QuickReplyPhoneNumber._type:
+        rtn = QuickReplyPhoneNumber(**data)
+    elif _type == QuickReplyEmail._type:
+        rtn = QuickReplyEmail(**data)
+    return rtn
+
 def graphql_to_message(message):
     if message.get('message_sender') is None:
         message['message_sender'] = {}
@@ -207,13 +299,27 @@ def graphql_to_message(message):
     rtn.uid = str(message.get('message_id'))
     rtn.author = str(message.get('message_sender').get('id'))
     rtn.timestamp = message.get('timestamp_precise')
+    rtn.unsent = False
     if message.get('unread') is not None:
         rtn.is_read = not message['unread']
-    rtn.reactions = {str(r['user']['id']):MessageReaction(r['reaction']) for r in message.get('message_reactions')}
+    rtn.reactions = {
+        str(r['user']['id']): enum_extend_if_invalid(MessageReaction, r['reaction'])
+        for r in message.get('message_reactions')
+    }
     if message.get('blob_attachments') is not None:
         rtn.attachments = [graphql_to_attachment(attachment) for attachment in message['blob_attachments']]
-    # TODO: This is still missing parsing:
-    # message.get('extensible_attachment')
+    if message.get('platform_xmd_encoded'):
+        quick_replies = json.loads(message['platform_xmd_encoded']).get('quick_replies')
+        if isinstance(quick_replies, list):
+            rtn.quick_replies = [graphql_to_quick_reply(q) for q in quick_replies]
+        elif isinstance(quick_replies, dict):
+            rtn.quick_replies = [graphql_to_quick_reply(quick_replies, is_response=True)]
+    if message.get('extensible_attachment') is not None:
+        attachment = graphql_to_extensible_attachment(message['extensible_attachment'])
+        if isinstance(attachment, UnsentMessage):
+            rtn.unsent = True
+        elif attachment:
+            rtn.attachments.append(attachment)
     return rtn
 
 def graphql_to_user(user):
@@ -477,7 +583,7 @@ class GraphQL(object):
     """
 
     SEARCH_USER = """
-    Query SearchUser(<search> = '', <limit> = 1) {
+    Query SearchUser(<search> = '', <limit> = 10) {
         entities_named(<search>) {
             search_results.of_type(user).first(<limit>) as users {
                 nodes {
@@ -489,7 +595,7 @@ class GraphQL(object):
     """ + FRAGMENT_USER
 
     SEARCH_GROUP = """
-    Query SearchGroup(<search> = '', <limit> = 1, <pic_size> = 32) {
+    Query SearchGroup(<search> = '', <limit> = 10, <pic_size> = 32) {
         viewer() {
             message_threads.with_thread_name(<search>).last(<limit>) as groups {
                 nodes {
@@ -501,7 +607,7 @@ class GraphQL(object):
     """ + FRAGMENT_GROUP
 
     SEARCH_PAGE = """
-    Query SearchPage(<search> = '', <limit> = 1) {
+    Query SearchPage(<search> = '', <limit> = 10) {
         entities_named(<search>) {
             search_results.of_type(page).first(<limit>) as pages {
                 nodes {
@@ -513,7 +619,7 @@ class GraphQL(object):
     """ + FRAGMENT_PAGE
 
     SEARCH_THREAD = """
-    Query SearchThread(<search> = '', <limit> = 1) {
+    Query SearchThread(<search> = '', <limit> = 10) {
         entities_named(<search>) {
             search_results.first(<limit>) as threads {
                 nodes {

fbchat/models.py

@@ -1,7 +1,8 @@
 # -*- coding: UTF-8 -*-
 
 from __future__ import unicode_literals
-import enum
+import aenum
+from string import Formatter
 
 
 class FBchatException(Exception):
@@ -190,8 +191,12 @@ class Message(object):
     sticker = None
     #: A list of attachments
     attachments = None
+    #: A list of :class:`QuickReply`
+    quick_replies = None
+    #: Whether the message is unsent (deleted for everyone)
+    unsent = None
 
-    def __init__(self, text=None, mentions=None, emoji_size=None, sticker=None, attachments=None):
+    def __init__(self, text=None, mentions=None, emoji_size=None, sticker=None, attachments=None, quick_replies=None):
         """Represents a Facebook message"""
         self.text = text
         if mentions is None:
@@ -202,8 +207,12 @@ class Message(object):
         if attachments is None:
             attachments = []
         self.attachments = attachments
+        if quick_replies is None:
+            quick_replies = []
+        self.quick_replies = quick_replies
         self.reactions = {}
         self.read_by = []
+        self.deleted = False
 
     def __repr__(self):
         return self.__unicode__()
@@ -211,6 +220,52 @@ class Message(object):
     def __unicode__(self):
         return '<Message ({}): {}, mentions={} emoji_size={} attachments={}>'.format(self.uid, repr(self.text), self.mentions, self.emoji_size, self.attachments)
 
+    @classmethod
+    def formatMentions(cls, text, *args, **kwargs):
+        """Like `str.format`, but takes tuples with a thread id and text instead.
+
+        Returns a `Message` object, with the formatted string and relevant mentions.
+
+        ```
+        >>> Message.formatMentions("Hey {!r}! My name is {}", ("1234", "Peter"), ("4321", "Michael"))
+        <Message (None): "Hey 'Peter'! My name is Michael", mentions=[<Mention 1234: offset=4 length=7>, <Mention 4321: offset=24 length=7>] emoji_size=None attachments=[]>
+
+        >>> Message.formatMentions("Hey {p}! My name is {}", ("1234", "Michael"), p=("4321", "Peter"))
+        <Message (None): 'Hey Peter! My name is Michael', mentions=[<Mention 4321: offset=4 length=5>, <Mention 1234: offset=22 length=7>] emoji_size=None attachments=[]>
+        ```
+        """
+        result = ""
+        mentions = list()
+        offset = 0
+        f = Formatter()
+        field_names = [field_name[1] for field_name in f.parse(text)]
+        automatic = '' in field_names
+        i = 0
+
+        for (literal_text, field_name, format_spec, conversion) in f.parse(text):
+            offset += len(literal_text)
+            result += literal_text
+
+            if field_name is None: continue
+
+            if field_name == '':
+                field_name = str(i)
+                i += 1
+            elif automatic and field_name.isdigit():
+                raise ValueError("cannot switch from automatic field numbering to manual field specification")
+
+            thread_id, name = f.get_field(field_name, args, kwargs)[0]
+
+            if format_spec: name = f.format_field(name, format_spec)
+            if conversion: name = f.convert_field(name, conversion)
+
+            result += name
+            mentions.append(Mention(thread_id=thread_id, offset=offset, length=len(name)))
+            offset += len(name)
+
+        message = cls(text=result, mentions=mentions)
+        return message
+
 class Attachment(object):
     #: The attachment ID
     uid = None
@@ -219,6 +274,12 @@ class Attachment(object):
         """Represents a Facebook attachment"""
         self.uid = uid
 
+class UnsentMessage(Attachment):
+
+    def __init__(self, *args, **kwargs):
+        """Represents an unsent message attachment"""
+        super(UnsentMessage, self).__init__(*args, **kwargs)
+
 class Sticker(Attachment):
     #: The sticker-pack's ID
     pack = None
@@ -251,9 +312,79 @@ class Sticker(Attachment):
         super(Sticker, self).__init__(*args, **kwargs)
 
 class ShareAttachment(Attachment):
-    def __init__(self, **kwargs):
-        """Represents a shared item (eg. URL) that has been sent as a Facebook attachment - *Currently Incomplete!*"""
+    #: ID of the author of the shared post
+    author = None
+    #: Target URL
+    url = None
+    #: Original URL if Facebook redirects the URL
+    original_url = None
+    #: Title of the attachment
+    title = None
+    #: Description of the attachment
+    description = None
+    #: Name of the source
+    source = None
+    #: URL of the attachment image
+    image_url = None
+    #: URL of the original image if Facebook uses `safe_image`
+    original_image_url = None
+    #: Width of the image
+    image_width = None
+    #: Height of the image
+    image_height = None
+    #: List of additional attachments
+    attachments = None
+
+    def __init__(self, author=None, url=None, original_url=None, title=None, description=None, source=None, image_url=None, original_image_url=None, image_width=None, image_height=None, attachments=None, **kwargs):
+        """Represents a shared item (eg. URL) that has been sent as a Facebook attachment"""
         super(ShareAttachment, self).__init__(**kwargs)
+        self.author = author
+        self.url = url
+        self.original_url = original_url
+        self.title = title
+        self.description = description
+        self.source = source
+        self.image_url = image_url
+        self.original_image_url = original_image_url
+        self.image_width = image_width
+        self.image_height = image_height
+        if attachments is None:
+            attachments = []
+        self.attachments = attachments
+
+class LocationAttachment(Attachment):
+    #: Latidute of the location
+    latitude = None
+    #: Longitude of the location
+    longitude = None
+    #: URL of image showing the map of the location
+    image_url = None
+    #: Width of the image
+    image_width = None
+    #: Height of the image
+    image_height = None
+    #: URL to Bing maps with the location
+    url = None
+
+    def __init__(self, latitude=None, longitude=None, **kwargs):
+        """Represents a user location"""
+        super(LocationAttachment, self).__init__(**kwargs)
+        self.latitude = latitude
+        self.longitude = longitude
+
+class LiveLocationAttachment(LocationAttachment):
+    #: Name of the location
+    name = None
+    #: Timestamp when live location expires
+    expiration_time = None
+    #: True if live location is expired
+    is_expired = None
+
+    def __init__(self, name=None, expiration_time=None, is_expired=None, **kwargs):
+        """Represents a live user location"""
+        super(LiveLocationAttachment, self).__init__(**kwargs)
+        self.expiration_time = expiration_time
+        self.is_expired = is_expired
 
 class FileAttachment(Attachment):
     #: Url where you can download the file
@@ -442,6 +573,73 @@ class Mention(object):
     def __unicode__(self):
         return '<Mention {}: offset={} length={}>'.format(self.thread_id, self.offset, self.length)
 
+class QuickReply(object):
+    #: Payload of the quick reply
+    payload = None
+    #: External payload for responses
+    external_payload = None
+    #: Additional data
+    data = None
+    #: Whether it's a response for a quick reply
+    is_response = None
+
+    def __init__(self, payload=None, data=None, is_response=False):
+        """Represents a quick reply"""
+        self.payload = payload
+        self.data = data
+        self.is_response = is_response
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    def __unicode__(self):
+        return '<{}: payload={!r}>'.format(self.__class__.__name__, self.payload)
+
+class QuickReplyText(QuickReply):
+    #: Title of the quick reply
+    title = None
+    #: URL of the quick reply image (optional)
+    image_url = None
+    #: Type of the quick reply
+    _type = "text"
+
+    def __init__(self, title=None, image_url=None, **kwargs):
+        """Represents a text quick reply"""
+        super(QuickReplyText, self).__init__(**kwargs)
+        self.title = title
+        self.image_url = image_url
+
+class QuickReplyLocation(QuickReply):
+    #: Type of the quick reply
+    _type = "location"
+
+    def __init__(self, **kwargs):
+        """Represents a location quick reply (Doesn't work on mobile)"""
+        super(QuickReplyLocation, self).__init__(**kwargs)
+        self.is_response = False
+
+class QuickReplyPhoneNumber(QuickReply):
+    #: URL of the quick reply image (optional)
+    image_url = None
+    #: Type of the quick reply
+    _type = "user_phone_number"
+
+    def __init__(self, image_url=None, **kwargs):
+        """Represents a phone number quick reply (Doesn't work on mobile)"""
+        super(QuickReplyPhoneNumber, self).__init__(**kwargs)
+        self.image_url = image_url
+
+class QuickReplyEmail(QuickReply):
+    #: URL of the quick reply image (optional)
+    image_url = None
+    #: Type of the quick reply
+    _type = "user_email"
+
+    def __init__(self, image_url=None, **kwargs):
+        """Represents an email quick reply (Doesn't work on mobile)"""
+        super(QuickReplyEmail, self).__init__(**kwargs)
+        self.image_url = image_url
+
 class Poll(object):
     #: ID of the poll
     uid = None
@@ -523,7 +721,26 @@ class Plan(object):
     def __unicode__(self):
         return '<Plan ({}): {} time={}, location={}, location_id={}>'.format(self.uid, repr(self.title), self.time, repr(self.location), repr(self.location_id))
 
-class Enum(enum.Enum):
+class ActiveStatus(object):
+    #: Whether the user is active now
+    active = None
+    #: Timestamp when the user was last active
+    last_active = None
+    #: Whether the user is playing Messenger game now
+    in_game = None
+
+    def __init__(self, active=None, last_active=None, in_game=None):
+        self.active = active
+        self.last_active = last_active
+        self.in_game = in_game
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    def __unicode__(self):
+        return '<ActiveStatus: active={} last_active={} in_game={}>'.format(self.active, self.last_active, self.in_game)
+
+class Enum(aenum.Enum):
     """Used internally by fbchat to support enumerations"""
     def __repr__(self):
         # For documentation:

fbchat/utils.py

@@ -11,13 +11,15 @@ from os.path import basename
 import warnings
 import logging
 import requests
+import aenum
 from .models import *
 
 try:
-    from urllib.parse import urlencode
+    from urllib.parse import urlencode, parse_qs, urlparse
     basestring = (str, bytes)
 except ImportError:
     from urllib import urlencode
+    from urlparse import parse_qs, urlparse
     basestring = basestring
 
 # Python 2's `input` executes the input, whereas `raw_input` just returns the input
@@ -140,6 +142,7 @@ class ReqUrl(object):
     GET_POLL_OPTIONS = "https://www.facebook.com/ajax/mercury/get_poll_options"
     SEARCH_MESSAGES = "https://www.facebook.com/ajax/mercury/search_snippets.php?dpr=1"
     MARK_SPAM = "https://www.facebook.com/ajax/mercury/mark_spam.php?dpr=1"
+    UNSEND = "https://www.facebook.com/messaging/unsend_message/?dpr=1"
 
     pull_channel = 0
 
@@ -297,3 +300,18 @@ def get_files_from_paths(filenames):
     yield files
     for fn, fp, ft in files:
         fp.close()
+
+def enum_extend_if_invalid(enumeration, value):
+    try:
+        return enumeration(value)
+    except ValueError:
+        log.warning("Failed parsing {.__name__}({!r}). Extending enum.".format(enumeration, value))
+        aenum.extend_enum(enumeration, "UNKNOWN_{}".format(value).upper(), value)
+        return enumeration(value)
+
+def get_url_parameters(url, *args):
+    params = parse_qs(urlparse(url).query)
+    return [params[arg][0] for arg in args if params.get(arg)]
+
+def get_url_parameter(url, param):
+    return get_url_parameters(url, param)[0]

pyproject.toml

@@ -0,0 +1,52 @@
+[build-system]
+requires = ["flit"]
+build-backend = "flit.buildapi"
+
+[tool.flit.metadata]
+module = "fbchat"
+author = "Taehoon Kim"
+author-email = "carpedm20@gmail.com"
+maintainer = "Mads Marquart"
+maintainer-email = "madsmtm@gmail.com"
+home-page = "https://github.com/carpedm20/fbchat/"
+requires = [
+    "aenum",
+    "requests",
+    "beautifulsoup4",
+]
+description-file = "README.rst"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Natural Language :: English",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 2.7",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: Implementation :: CPython",
+    "Programming Language :: Python :: Implementation :: PyPy",
+    "Topic :: Communications :: Chat",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4.0"
+keywords = "Facebook FB Messenger Library Chat Api Bot"
+license = "BSD 3-Clause"
+
+[tool.flit.metadata.urls]
+Documentation = "https://fbchat.readthedocs.io/"
+Repository = "https://github.com/carpedm20/fbchat/"
+
+[tool.flit.metadata.requires-extra]
+test = [
+    "pytest~=4.0",
+    "six",
+]

requirements.txt

@@ -1,3 +0,0 @@
-requests
-beautifulsoup4
-enum34; python_version < '3.4'

scripts/travis-offline

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-set -ex
-
-python -m pytest -m offline --color=yes

scripts/travis-online

@@ -1,18 +0,0 @@
-#!/bin/bash
-
-set -ex
-
-if ! python -m pytest --color=yes; then
-    echo << EOF
------------------------------------------------------------------
------------------------------------------------------------------
------------------------------------------------------------------
-
-Some tests failed! Rerunning them, since they can be kinda flaky.
-
------------------------------------------------------------------
------------------------------------------------------------------
------------------------------------------------------------------
-EOF
-    python -m pytest --last-failed --color=yes
-fi

setup.cfg

@@ -1,51 +0,0 @@
-[metadata]
-name = fbchat
-version = attr: fbchat.__version__
-license = BSD 3-Clause
-license_file = LICENSE
-
-author = Taehoon Kim
-author_email = carpedm20@gmail.com
-maintainer = Mads Marquart
-maintainer_email = madsmtm@gmail.com
-
-description = Facebook Chat (Messenger) for Python
-long_description = file: README.rst
-long_description_content_type = text/x-rst
-
-keywords = Facebook FB Messenger Chat Api Bot
-classifiers =
-    Development Status :: 3 - Alpha
-    Intended Audience :: Developers
-    Intended Audience :: Information Technology
-    License :: OSI Approved :: BSD License
-    Operating System :: OS Independent
-    Natural Language :: English
-    Programming Language :: Python
-    Programming Language :: Python :: 2.7
-    Programming Language :: Python :: 3.4
-    Programming Language :: Python :: 3.5
-    Programming Language :: Python :: 3.6
-    Programming Language :: Python :: Implementation :: CPython
-    Programming Language :: Python :: Implementation :: PyPy
-    Topic :: Communications :: Chat
-    Topic :: Internet :: WWW/HTTP :: Dynamic Content
-    Topic :: Software Development :: Libraries :: Python Modules
-
-url = https://github.com/carpedm20/fbchat/
-project_urls =
-    Documentation = https://fbchat.readthedocs.io/
-    Repository = https://github.com/carpedm20/fbchat/
-
-[options]
-zip_safe = True
-include_package_data = True
-packages = find:
-python_requires = >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, <4.0
-install_requires =
-    requests
-    beautifulsoup4
-    # May not work in pip with bdist_wheel
-    # See https://wheel.readthedocs.io/en/latest/#defining-conditional-dependencies
-    # It is therefore defined in setup.py
-    # enum34; python_version < '3.4'

setup.py

@@ -1,8 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: UTF-8 -*-
-
-from __future__ import unicode_literals
-
-from setuptools import setup
-
-setup(extras_require={':python_version < "3.4"': ['enum34']})

tests/conftest.py

@@ -20,7 +20,9 @@ def group(pytestconfig):
     return {"id": load_variable("group_id", pytestconfig.cache), "type": ThreadType.GROUP}
 
 
-@pytest.fixture(scope="session", params=["user", "group", pytest.mark.xfail("none")])
+@pytest.fixture(scope="session", params=[
+    "user", "group", pytest.param("none", marks=[pytest.mark.xfail()])
+])
 def thread(request, user, group):
     return {
         "user": user,

tests/test_fetch.py

@@ -19,6 +19,11 @@ def test_fetch_thread_list(client1):
     assert len(threads) == 2
 
 
+def test_fetch_threads(client1):
+    threads = client1.fetchThreads(limit=2)
+    assert len(threads) == 2
+
+
 @pytest.mark.parametrize("emoji, emoji_size", EMOJI_LIST)
 def test_fetch_message_emoji(client, emoji, emoji_size):
     mid = client.sendEmoji(emoji, emoji_size)

tests/test_plans.py

@@ -11,8 +11,14 @@ from time import time
 
 @pytest.fixture(scope="module", params=[
     Plan(int(time()) + 100, random_hex()),
-    pytest.mark.xfail(Plan(int(time()), random_hex()), raises=FBchatFacebookError),
-    pytest.mark.xfail(Plan(0, None)),
+    pytest.param(
+        Plan(int(time()), random_hex()),
+        marks=[pytest.mark.xfail(raises=FBchatFacebookError)]
+    ),
+    pytest.param(
+        Plan(0, None),
+        marks=[pytest.mark.xfail()],
+    ),
 ])
 def plan_data(request, client, user, thread, catch_event, compare):
     with catch_event("onPlanCreated") as x:

tests/test_polls.py

@@ -26,7 +26,9 @@ from utils import random_hex, subset
         PollOption(random_hex()),
         PollOption(random_hex()),
     ]),
-    pytest.mark.xfail(Poll(title=None, options=[]), raises=ValueError),
+    pytest.param(
+        Poll(title=None, options=[]), marks=[pytest.mark.xfail(raises=ValueError)]
+    ),
 ])
 def poll_data(request, client1, group, catch_event):
     with catch_event("onPollCreated") as x:

tests/test_thread_interraction.py

@@ -72,8 +72,8 @@ def test_change_nickname(client, client_all, catch_event, compare):
     "😂",
     "😕",
     "😍",
-    pytest.mark.xfail("🙃", raises=FBchatFacebookError),
-    pytest.mark.xfail("not an emoji", raises=FBchatFacebookError)
+    pytest.param("🙃", marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+    pytest.param("not an emoji", marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
 ])
 def test_change_emoji(client, catch_event, compare, emoji):
     with catch_event("onEmojiChange") as x:
@@ -101,7 +101,7 @@ def test_change_image_remote(client1, group, catch_event):
     [
         x
         if x in [ThreadColor.MESSENGER_BLUE, ThreadColor.PUMPKIN]
-        else pytest.mark.expensive(x)
+        else pytest.param(x, marks=[pytest.mark.expensive()])
         for x in ThreadColor
     ],
 )

tests/utils.py

@@ -23,15 +23,15 @@ EMOJI_LIST = [
     ("😆", EmojiSize.LARGE),
     # These fail in `catch_event` because the emoji is made into a sticker
     # This should be fixed
-    pytest.mark.xfail((None, EmojiSize.SMALL)),
-    pytest.mark.xfail((None, EmojiSize.MEDIUM)),
-    pytest.mark.xfail((None, EmojiSize.LARGE)),
+    pytest.param(None, EmojiSize.SMALL, marks=[pytest.mark.xfail()]),
+    pytest.param(None, EmojiSize.MEDIUM, marks=[pytest.mark.xfail()]),
+    pytest.param(None, EmojiSize.LARGE, marks=[pytest.mark.xfail()]),
 ]
 
 STICKER_LIST = [
     Sticker("767334476626295"),
-    pytest.mark.xfail(Sticker("0"), raises=FBchatFacebookError),
-    pytest.mark.xfail(Sticker(None), raises=FBchatFacebookError),
+    pytest.param(Sticker("0"), marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+    pytest.param(Sticker(None), marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
 ]
 
 TEXT_LIST = [
@@ -40,8 +40,8 @@ TEXT_LIST = [
     "\\\n\t%?&'\"",
     "ˁҭʚ¹Ʋջوװ՞ޱɣࠚԹБɑȑңКએ֭ʗыԈٌʼőԈ×௴nચϚࠖణٔє܅Ԇޑط",
     "a" * 20000,  # Maximum amount of characters you can send
-    pytest.mark.xfail("a" * 20001, raises=FBchatFacebookError),
-    pytest.mark.xfail(None, raises=FBchatFacebookError),
+    pytest.param("a" * 20001, marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+    pytest.param(None, marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
 ]