Version up, thanks to @kapi2289, @gave92, @ThatAlexanderA and @1ttric

Bunch of new methods, bunch of fixes, bunch of tests

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report if you're having trouble with `fbchat`
+
+---
+
+## Description of the problem
+Example: Logging in fails when the character `%` is in the password. A specific password that fails is `a_password_with_%`
+
+## Code to reproduce
+```py
+# Example code
+from fbchat import Client
+client = Client("[REDACTED_USERNAME]", "a_password_with_%")
+```
+
+## Traceback
+```
+Traceback (most recent call last):
+  File "<test.py>", line 1, in <module>
+  File "[site-packages]/fbchat/client.py", line 78, in __init__
+    self.login(email, password, max_tries)
+  File "[site-packages]/fbchat/client.py", line 407, in login
+    raise FBchatUserError('Login failed. Check email/password. (Failed on url: {})'.format(login_url))
+fbchat.models.FBchatUserError: Login failed. Check email/password. (Failed on url: https://m.facebook.com/login.php?login_attempt=1)
+```
+
+## Environment information
+- Python version
+- `fbchat` version
+- If relevant, output from `$ python -m pip list`
+
+If you have done any research, include that.
+Make sure to redact all personal information.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest a feature that you'd like to see implemented
+
+---
+
+## Description
+Example: There's no way to send messages to groups
+
+## Research (if applicable)
+Example: I've found the URL `https://facebook.com/send_message.php`, to which you can send a POST requests with the following JSON:
+```json
+{
+   "text": message_content,
+   "fbid": group_id,
+   "some_variable": ?
+}
+```
+But I don't know how what `some_variable` does, and it doesn't work without it. I've found some examples of `some_variable` to be: `MTIzNDU2Nzg5MA`, `MTIzNDU2Nzg5MQ` and `MTIzNDU2Nzg5Mg`

.gitignore

@@ -8,9 +8,11 @@
 # Packages
 *.egg
 *.egg-info
+*.dist-info
 dist
 build
 eggs
+.eggs
 parts
 bin
 var

.travis.yml

@@ -1,35 +1,90 @@
 sudo: false
 language: python
-python:
-- 2.7
-- 3.4
-- 3.5
-- 3.6
+conditions: v1
 
-env:
-  global:
-    # These two accounts are made specifically for this purpose, and the passwords are really only encrypted for obscurity
-    # In reality, you could probably still login with the accounts by looking at log output from travis-ci.org
-    - client1_email=travis.fbchat1@gmail.com # Facebook ID: 100023782141139
-    - secure: "W1NON6qaLnvYIOVoC93MXkmbAIkUkHcGREBwN0BSVM3cLuMduk4VVkz6PY2T8bnntGYVwicXwcn5aNJ6pDue17TBZqGPk/tdpws8mnAZUtBYhpkIFTTlyh5kJSZejx9fd5s4nceGpH6ofCCnNxPp2PdHKU8piqnQYZVQ4cFNNDE=" # client1_password
-    - client2_email=fbchat.travis2@gmail.com # Facebook ID: 100026538491708
-    - secure: "V7RB3go2Tc/DdW1x9DkMI+vCfnOgiS3ygmFCABs/GjfPZjZL7VLMJgYGlx0cjeeeN+Oxa2GrhczRAKeMdGB6Ss2lGGAVs6cjJ56ODuBHWT6/FNzLjtDkTnjD+Kfh0l8ZOdxTF3MQ6M/9hU6z5ek+XYGr7u+/7wOYZ5L2cK5MaQ0=" # client2_password
-    - group_id=1463789480385605
+# 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
 
-before_script:
-  - if [[ "$TRAVIS_PYTHON_VERSION" = "2.7" ]]; then export PYTEST_ADDOPTS='-m ""'; fi; # expensive tests (otherwise disabled in pytest.ini)
-  - if [[ "$TRAVIS_PULL_REQUEST" != false ]]; then export PYTEST_ADDOPTS='-m offline'; fi; # offline tests only
+# The tests are run with `Limit concurrent jobs = 1`, since the tests can't use the clients simultaneously
 
-script: python -m pytest || python -m pytest --lf; # Run failed tests twice
+install:
+  - pip install -U -r requirements.txt
+  - pip install -U -r dev-requirements.txt
 
-cache: pip
+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
 
+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
+
+    - &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
+      install: skip
       deploy:
         provider: pypi
         user: madsmtm
         password:
           secure: "VA0MLSrwIW/T2KjMwjLZCzrLHw8pJT6tAvb48t7qpBdm8x192hax61pz1TaBZoJvlzyBPFKvluftuclTc7yEFwzXe7Gjqgd/ODKZl/wXDr36hQ7BBOLPZujdwmWLvTzMh3eJZlvkgcLCzrvK3j2oW8cM/+FZeVi/5/FhVuJ4ofs="
-  on:
+        distributions: sdist bdist_wheel
+        skip_existing: true
+
+    # We need the bdist_wheels from both Python 2 and 3
       python: 3.6
-    branch: master
-    tags: true
+    - <<: *deploy
+      python: 2.7

CODE_OF_CONDUCT

@@ -0,0 +1,75 @@
+Contributor Covenant Code of Conduct
+
+Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+
+Examples of unacceptable behavior by participants include:
+
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or electronic
+address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+
+Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at carpedm20@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project’s leadership.
+
+Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.rst

@@ -0,0 +1,22 @@
+Contributing to fbchat
+======================
+
+Thanks for reading this, all contributions are very much welcome!
+
+Please be aware that ``fbchat`` uses `Scemantic Versioning <https://semver.org/>`__
+That means that if you're submitting a breaking change, it will probably take a while before it gets considered.
+
+In that case, you can point your PR to the ``2.0.0-dev`` branch, where the API is being properly developed.
+Otherwise, just point it to ``master``.
+
+Testing Environment
+-------------------
+
+The tests use `pytest <https://docs.pytest.org/>`__, and to work they need two Facebook accounts, and a group thread between these.
+To set these up, you should export the following environment variables:
+
+``client1_email``, ``client1_password``, ``client2_email``, ``client2_password`` and ``group_id``
+
+If you're not able to do this, consider simply running ``pytest -m offline``.
+
+And if you're adding new functionality, if possible, make sure to create a new test for it.

LICENSE

@@ -1,4 +1,4 @@
-New BSD License
+BSD 3-Clause License
 
 Copyright (c) 2015, Taehoon Kim
 All rights reserved.
@@ -13,8 +13,9 @@ modification, are permitted provided that the following conditions are met:
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
-* The names of its contributors may not be used to endorse or promote products
-  derived from this software without specific prior written permission.
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

MANIFEST.in

@@ -1,4 +1,3 @@
-include LICENSE.txt
-include MANIFEST.in
+include LICENSE
+include CONTRIBUTING.rst
 include README.rst
-include setup.py

README.rst

@@ -2,24 +2,28 @@ fbchat: Facebook Chat (Messenger) for Python
 ============================================
 
 .. image:: https://img.shields.io/badge/license-BSD-blue.svg
-    :target: LICENSE.txt
-    :alt: License: BSD
+    :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-blue.svg
+.. image:: https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6%20pypy-blue.svg
     :target: https://pypi.python.org/pypi/fbchat
-    :alt: Supported python versions: 2.7, 3.4, 3.5 and 3.6
+    :alt: Supported python versions: 2.7, 3.4, 3.5, 3.6 and pypy
 
 .. image:: https://readthedocs.org/projects/fbchat/badge/?version=master
     :target: https://fbchat.readthedocs.io
     :alt: Documentation
 
+.. image:: https://travis-ci.org/carpedm20/fbchat.svg?branch=master
+    :target: https://travis-ci.org/carpedm20/fbchat
+    :alt: Travis CI
+
 Facebook Chat (`Messenger <https://www.facebook.com/messages/>`__) for Python.
 This project was inspired by `facebook-chat-api <https://github.com/Schmavery/facebook-chat-api>`__.
 
 **No XMPP or API key is needed**. Just use your email and password.
 
 Go to `Read the Docs <https://fbchat.readthedocs.io>`__ to see the full documentation,
-or jump right into the code by viewing the `examples <examples>`__
+or jump right into the code by viewing the `examples <https://github.com/carpedm20/fbchat/tree/master/examples>`__
 
 Installation:
 
@@ -27,6 +31,15 @@ Installation:
 
     $ pip install fbchat
 
+You can also install from source, by using `setuptools` (You need at least version 30.3.0):
+
+.. code-block:: console
+
+    $ git clone https://github.com/carpedm20/fbchat.git
+    $ cd fbchat
+    $ python setup.py install
+
+
 Maintainer
 ----------
 

dev-requirements.txt

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

fbchat/__init__.py

@@ -1,28 +1,28 @@
 # -*- coding: UTF-8 -*-
 
-from __future__ import unicode_literals
-from datetime import datetime
-from .client import *
-
-
 """
     fbchat
     ~~~~~~
 
     Facebook Chat (Messenger) for Python
 
-    :copyright: (c) 2015 by Taehoon Kim.
-    :license: BSD, see LICENSE for more details.
+    :copyright: (c) 2015 - 2018 by Taehoon Kim
+    :license: BSD 3-Clause, see LICENSE for more details.
 """
 
+from __future__ import unicode_literals
+
+from .client import *
+
+__title__ = 'fbchat'
+__version__ = '1.4.0'
+__description__ = 'Facebook Chat (Messenger) for Python'
+
+__copyright__ = 'Copyright 2015 - 2018 by Taehoon Kim'
+__license__ = 'BSD 3-Clause'
 
-__copyright__ = 'Copyright 2015 - {} by Taehoon Kim'.format(datetime.now().year)
-__version__ = '1.3.8'
-__license__ = 'BSD'
 __author__ = 'Taehoon Kim; Moreels Pieter-Jan; Mads Marquart'
 __email__ = 'carpedm20@gmail.com'
-__source__ = 'https://github.com/carpedm20/fbchat/'
-__description__ = 'Facebook Chat (Messenger) for Python'
 
 __all__ = [
     'Client',

fbchat/graphql.py

@@ -128,6 +128,71 @@ def graphql_to_attachment(a):
             uid=a.get('legacy_attachment_id')
         )
 
+def graphql_to_poll(a):
+    rtn = Poll(
+        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"])
+    rtn.options_count = a.get("total_count")
+    return rtn
+
+def graphql_to_poll_option(a):
+    if a.get('viewer_has_voted') is None:
+        vote = None
+    elif isinstance(a['viewer_has_voted'], bool):
+        vote = a['viewer_has_voted']
+    else:
+        vote = a['viewer_has_voted'] == 'true'
+    rtn = PollOption(
+        text=a.get('text'),
+        vote=vote
+    )
+    rtn.uid = int(a["id"])
+    rtn.voters = [m.get('node').get('id') for m in a.get('voters').get('edges')] if isinstance(a.get('voters'), dict) else a.get('voters')
+    rtn.votes_count = a.get('voters').get('count') if isinstance(a.get('voters'), dict) else a.get('total_count')
+    return rtn
+
+def graphql_to_plan(a):
+    if a.get('event_members'):
+        rtn = Plan(
+            time=a.get('event_time'),
+            title=a.get('title'),
+            location=a.get('location_name')
+        )
+        if a.get('location_id') != 0:
+            rtn.location_id = str(a.get('location_id'))
+        rtn.uid = a.get('oid')
+        rtn.author_id = a.get('creator_id')
+        guests = a.get("event_members")
+        rtn.going = [uid for uid in guests if guests[uid] == "GOING"]
+        rtn.declined = [uid for uid in guests if guests[uid] == "DECLINED"]
+        rtn.invited = [uid for uid in guests if guests[uid] == "INVITED"]
+        return rtn
+    elif a.get('id') is None:
+        rtn = Plan(
+            time=a.get('event_time'),
+            title=a.get('event_title'),
+            location=a.get('event_location_name'),
+            location_id=a.get('event_location_id')
+        )
+        rtn.uid = a.get('event_id')
+        rtn.author_id = a.get('event_creator_id')
+        guests = json.loads(a.get('guest_state_list'))
+    else:
+        rtn = Plan(
+            time=a.get('time'),
+            title=a.get('event_title'),
+            location=a.get('location_name')
+        )
+        rtn.uid = a.get('id')
+        rtn.author_id = a.get('lightweight_event_creator').get('id')
+        guests = a.get('event_reminder_members').get('edges')
+    rtn.going = [m.get('node').get('id') for m in guests if m.get('guest_list_state') == "GOING"]
+    rtn.declined = [m.get('node').get('id') for m in guests if m.get('guest_list_state') == "DECLINED"]
+    rtn.invited = [m.get('node').get('id') for m in guests if m.get('guest_list_state') == "INVITED"]
+    return rtn
+
 def graphql_to_message(message):
     if message.get('message_sender') is None:
         message['message_sender'] = {}
@@ -155,6 +220,7 @@ def graphql_to_user(user):
     if user.get('profile_picture') is None:
         user['profile_picture'] = {}
     c_info = get_customization_info(user)
+    plan = graphql_to_plan(user['event_reminders']['nodes'][0]) if user.get('event_reminders', dict()).get('nodes') else None
     return User(
         user['id'],
         url=user.get('url'),
@@ -169,7 +235,8 @@ def graphql_to_user(user):
         own_nickname=c_info.get('own_nickname'),
         photo=user['profile_picture'].get('uri'),
         name=user.get('name'),
-        message_count=user.get('messages_count')
+        message_count=user.get('messages_count'),
+        plan=plan,
     )
 
 def graphql_to_thread(thread):
@@ -185,12 +252,20 @@ def graphql_to_thread(thread):
         if 'last_message' in thread:
             last_message_timestamp = thread['last_message']['nodes'][0]['timestamp_precise']
 
+        first_name = user.get('short_name')
+        if first_name is None:
+            last_name = None
+        else:
+            last_name = user.get('name').split(first_name, 1).pop().strip()
+
+        plan = graphql_to_plan(thread['event_reminders']['nodes'][0]) if thread.get('event_reminders', dict()).get('nodes') else None
+
         return User(
             user['id'],
             url=user.get('url'),
             name=user.get('name'),
-            first_name=user.get('short_name'),
-            last_name=user.get('name').split(user.get('short_name'),1).pop().strip(),
+            first_name=first_name,
+            last_name=last_name,
             is_friend=user.get('is_viewer_friend'),
             gender=GENDERS.get(user.get('gender')),
             affinity=user.get('affinity'),
@@ -200,7 +275,8 @@ def graphql_to_thread(thread):
             own_nickname=c_info.get('own_nickname'),
             photo=user['big_image_src'].get('uri'),
             message_count=thread.get('messages_count'),
-            last_message_timestamp=last_message_timestamp
+            last_message_timestamp=last_message_timestamp,
+            plan=plan,
         )
     else:
         raise FBchatException('Unknown thread type: {}, with data: {}'.format(thread.get('thread_type'), thread))
@@ -212,6 +288,7 @@ def graphql_to_group(group):
     last_message_timestamp = None
     if 'last_message' in group:
         last_message_timestamp = group['last_message']['nodes'][0]['timestamp_precise']
+    plan = graphql_to_plan(group['event_reminders']['nodes'][0]) if group.get('event_reminders', dict()).get('nodes') else None
     return Group(
         group['thread_key']['thread_fbid'],
         participants=set([node['messaging_actor']['id'] for node in group['all_participants']['nodes']]),
@@ -221,13 +298,15 @@ def graphql_to_group(group):
         photo=group['image'].get('uri'),
         name=group.get('name'),
         message_count=group.get('messages_count'),
-        last_message_timestamp=last_message_timestamp
+        last_message_timestamp=last_message_timestamp,
+        plan=plan,
     )
 
 def graphql_to_room(room):
     if room.get('image') is None:
         room['image'] = {}
     c_info = get_customization_info(room)
+    plan = graphql_to_plan(room['event_reminders']['nodes'][0]) if room.get('event_reminders', dict()).get('nodes') else None
     return Room(
         room['thread_key']['thread_fbid'],
         participants=set([node['messaging_actor']['id'] for node in room['all_participants']['nodes']]),
@@ -242,6 +321,7 @@ def graphql_to_room(room):
         approval_requests = set(node.get('id') for node in room['thread_queue_metadata'].get('approval_requests', {}).get('nodes')),
         join_link = room['joinable_mode'].get('link'),
         privacy_mode = bool(room.get('privacy_mode')),
+        plan=plan,
     )
 
 def graphql_to_page(page):
@@ -249,6 +329,7 @@ def graphql_to_page(page):
         page['profile_picture'] = {}
     if page.get('city') is None:
         page['city'] = {}
+    plan = graphql_to_plan(page['event_reminders']['nodes'][0]) if page.get('event_reminders', dict()).get('nodes') else None
     return Page(
         page['id'],
         url=page.get('url'),
@@ -256,7 +337,8 @@ def graphql_to_page(page):
         category=page.get('category_type'),
         photo=page['profile_picture'].get('uri'),
         name=page.get('name'),
-        message_count=page.get('messages_count')
+        message_count=page.get('messages_count'),
+        plan=plan,
     )
 
 def graphql_queries_to_json(*queries):

fbchat/models.py

@@ -37,7 +37,9 @@ class Thread(object):
     last_message_timestamp = None
     #: Number of messages in the thread
     message_count = None
-    def __init__(self, _type, uid, photo=None, name=None, last_message_timestamp=None, message_count=None):
+    #: Set :class:`Plan`
+    plan = None
+    def __init__(self, _type, uid, photo=None, name=None, last_message_timestamp=None, message_count=None, plan=None):
         """Represents a Facebook thread"""
         self.uid = str(uid)
         self.type = _type
@@ -45,6 +47,7 @@ class Thread(object):
         self.name = name
         self.last_message_timestamp = last_message_timestamp
         self.message_count = message_count
+        self.plan = plan
 
     def __repr__(self):
         return self.__unicode__()
@@ -436,6 +439,87 @@ class Mention(object):
     def __unicode__(self):
         return '<Mention {}: offset={} length={}>'.format(self.thread_id, self.offset, self.length)
 
+class Poll(object):
+    #: ID of the poll
+    uid = None
+    #: Title of the poll
+    title = None
+    #: List of :class:`PollOption`, can be fetched with :func:`fbchat.Client.fetchPollOptions`
+    options = None
+    #: Options count
+    options_count = None
+
+    def __init__(self, title, options):
+        """Represents a poll"""
+        self.title = title
+        self.options = options
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    def __unicode__(self):
+        return '<Poll ({}): {} options={}>'.format(self.uid, repr(self.title), self.options)
+
+class PollOption(object):
+    #: ID of the poll option
+    uid = None
+    #: Text of the poll option
+    text = None
+    #: Whether vote when creating or client voted
+    vote = None
+    #: ID of the users who voted for this poll option
+    voters = None
+    #: Votes count
+    votes_count = None
+
+    def __init__(self, text, vote=False):
+        """Represents a poll option"""
+        self.text = text
+        self.vote = vote
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    def __unicode__(self):
+        return '<PollOption ({}): {} voters={}>'.format(self.uid, repr(self.text), self.voters)
+
+class Plan(object):
+    #: ID of the plan
+    uid = None
+    #: Plan time (unix time stamp), only precise down to the minute
+    time = None
+    #: Plan title
+    title = None
+    #: Plan location name
+    location = None
+    #: Plan location ID
+    location_id = None
+    #: ID of the plan creator
+    author_id = None
+    #: List of the people IDs who will take part in the plan
+    going = None
+    #: List of the people IDs who won't take part in the plan
+    declined = None
+    #: List of the people IDs who are invited to the plan
+    invited = None
+
+    def __init__(self, time, title, location=None, location_id=None):
+        """Represents a plan"""
+        self.time = int(time)
+        self.title = title
+        self.location = location or ''
+        self.location_id = location_id or ''
+        self.author_id = None
+        self.going = []
+        self.declined = []
+        self.invited = []
+
+    def __repr__(self):
+        return self.__unicode__()
+
+    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):
     """Used internally by fbchat to support enumerations"""
     def __repr__(self):

fbchat/utils.py

@@ -5,8 +5,12 @@ import re
 import json
 from time import time
 from random import random
+from contextlib import contextmanager
+from mimetypes import guess_type
+from os.path import basename
 import warnings
 import logging
+import requests
 from .models import *
 
 try:
@@ -48,16 +52,6 @@ LIKES = {
     's': EmojiSize.SMALL
 }
 
-MessageReactionFix = {
-    '😍': ('0001f60d', '%F0%9F%98%8D'),
-    '😆': ('0001f606', '%F0%9F%98%86'),
-    '😮': ('0001f62e', '%F0%9F%98%AE'),
-    '😢': ('0001f622', '%F0%9F%98%A2'),
-    '😠': ('0001f620', '%F0%9F%98%A0'),
-    '👍': ('0001f44d', '%F0%9F%91%8D'),
-    '👎': ('0001f44e', '%F0%9F%91%8E')
-}
-
 
 GENDERS = {
     # For standard requests
@@ -97,6 +91,9 @@ class ReqUrl(object):
     UNREAD_THREADS = "https://www.facebook.com/ajax/mercury/unread_threads.php"
     UNSEEN_THREADS = "https://www.facebook.com/mercury/unseen_thread_ids/"
     THREADS = "https://www.facebook.com/ajax/mercury/threadlist_info.php"
+    MOVE_THREAD = "https://www.facebook.com/ajax/mercury/move_thread.php"
+    ARCHIVED_STATUS = "https://www.facebook.com/ajax/mercury/change_archived_status.php?dpr=1"
+    PINNED_STATUS = "https://www.facebook.com/ajax/mercury/change_pinned_status.php?dpr=1"
     MESSAGES = "https://www.facebook.com/ajax/mercury/thread_info.php"
     READ_STATUS = "https://www.facebook.com/ajax/mercury/change_read_status.php"
     DELIVERED = "https://www.facebook.com/ajax/mercury/delivery_receipts.php"
@@ -116,12 +113,33 @@ class ReqUrl(object):
     THREAD_COLOR = "https://www.facebook.com/messaging/save_thread_color/?source=thread_settings&dpr=1"
     THREAD_NICKNAME = "https://www.facebook.com/messaging/save_thread_nickname/?source=thread_settings&dpr=1"
     THREAD_EMOJI = "https://www.facebook.com/messaging/save_thread_emoji/?source=thread_settings&dpr=1"
+    THREAD_IMAGE = "https://www.facebook.com/messaging/set_thread_image/?dpr=1"
+    THREAD_NAME = "https://www.facebook.com/messaging/set_thread_name/?dpr=1"
     MESSAGE_REACTION = "https://www.facebook.com/webgraphql/mutation"
     TYPING = "https://www.facebook.com/ajax/messaging/typ.php"
     GRAPHQL = "https://www.facebook.com/api/graphqlbatch/"
     ATTACHMENT_PHOTO = "https://www.facebook.com/mercury/attachments/photo/"
-    EVENT_REMINDER = "https://www.facebook.com/ajax/eventreminder/create"
+    PLAN_CREATE = "https://www.facebook.com/ajax/eventreminder/create"
+    PLAN_INFO = "https://www.facebook.com/ajax/eventreminder"
+    PLAN_CHANGE = "https://www.facebook.com/ajax/eventreminder/submit"
+    PLAN_PARTICIPATION = "https://www.facebook.com/ajax/eventreminder/rsvp"
     MODERN_SETTINGS_MENU = "https://www.facebook.com/bluebar/modern_settings_menu/"
+    REMOVE_FRIEND = "https://m.facebook.com/a/removefriend.php"
+    BLOCK_USER = "https://www.facebook.com/messaging/block_messages/?dpr=1"
+    UNBLOCK_USER = "https://www.facebook.com/messaging/unblock_messages/?dpr=1"
+    SAVE_ADMINS = "https://www.facebook.com/messaging/save_admins/?dpr=1"
+    APPROVAL_MODE = "https://www.facebook.com/messaging/set_approval_mode/?dpr=1"
+    CREATE_GROUP = "https://m.facebook.com/messages/send/?icm=1"
+    DELETE_THREAD = "https://www.facebook.com/ajax/mercury/delete_thread.php?dpr=1"
+    DELETE_MESSAGES = "https://www.facebook.com/ajax/mercury/delete_messages.php?dpr=1"
+    MUTE_THREAD = "https://www.facebook.com/ajax/mercury/change_mute_thread.php?dpr=1"
+    MUTE_REACTIONS = "https://www.facebook.com/ajax/mercury/change_reactions_mute_thread/?dpr=1"
+    MUTE_MENTIONS = "https://www.facebook.com/ajax/mercury/change_mentions_mute_thread/?dpr=1"
+    CREATE_POLL = "https://www.facebook.com/messaging/group_polling/create_poll/?dpr=1"
+    UPDATE_VOTE = "https://www.facebook.com/messaging/group_polling/update_vote/?dpr=1"
+    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"
 
     pull_channel = 0
 
@@ -143,7 +161,7 @@ def strip_to_json(text):
     try:
         return text[text.index('{'):]
     except ValueError:
-        raise FBchatException('No JSON object found: {}, {}'.format(repr(text), text.index('{')))
+        raise FBchatException('No JSON object found: {!r}'.format(text))
 
 def get_decoded_r(r):
     return get_decoded(r._content)
@@ -210,8 +228,9 @@ def check_request(r, as_json=True):
         try:
             j = json.loads(content)
         except ValueError:
-            raise FBchatFacebookError('Error while parsing JSON: {}'.format(repr(content)))
+            raise FBchatFacebookError('Error while parsing JSON: {!r}'.format(content))
         check_json(j)
+        log.debug(j)
         return j
     else:
         return content
@@ -234,3 +253,47 @@ def get_emojisize_from_tags(tags):
         except (KeyError, IndexError):
             log.exception('Could not determine emoji size from {} - {}'.format(tags, tmp))
     return None
+
+def require_list(list_):
+    if isinstance(list_, list):
+        return set(list_)
+    else:
+        return set([list_])
+
+def mimetype_to_key(mimetype):
+    if not mimetype:
+        return "file_id"
+    if mimetype == "image/gif":
+        return "gif_id"
+    x = mimetype.split("/")
+    if x[0] in ["video", "image", "audio"]:
+        return "%s_id" % x[0]
+    return "file_id"
+
+
+def get_files_from_urls(file_urls):
+    files = []
+    for file_url in file_urls:
+        r = requests.get(file_url)
+        # We could possibly use r.headers.get('Content-Disposition'), see
+        # https://stackoverflow.com/a/37060758
+        files.append((
+            basename(file_url),
+            r.content,
+            r.headers.get('Content-Type') or guess_type(file_url)[0],
+        ))
+    return files
+
+
+@contextmanager
+def get_files_from_paths(filenames):
+    files = []
+    for filename in filenames:
+        files.append((
+            basename(filename),
+            open(filename, 'rb'),
+            guess_type(filename)[0],
+        ))
+    yield files
+    for fn, fp, ft in files:
+        fp.close()

requirements.txt

@@ -1,5 +1,3 @@
 requests
-lxml
 beautifulsoup4
 enum34; python_version < '3.4'
-six

scripts/travis-offline

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

scripts/travis-online

@@ -0,0 +1,18 @@
+#!/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

@@ -0,0 +1,51 @@
+[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,82 +1,8 @@
 #!/usr/bin/env python
+# -*- coding: UTF-8 -*-
 
+from __future__ import unicode_literals
 
-"""
-Setup script for fbchat
-"""
-import os
-try:
 from setuptools import setup
-except ImportError:
-    from distutils.core import setup
 
-with open('README.rst') as f:
-    readme_content = f.read().strip()
-
-requirements = [
-    'requests',
-    'lxml',
-    'beautifulsoup4'
-]
-
-extras_requirements = {
-    ':python_version < "3.4"': ['enum34']
-}
-
-version = None
-author = None
-email = None
-source = None
-description = None
-with open(os.path.join('fbchat', '__init__.py')) as f:
-    for line in f:
-        if line.strip().startswith('__version__'):
-            version = line.split('=')[1].strip().replace('"', '').replace("'", '')
-        elif line.strip().startswith('__author__'):
-            author = line.split('=')[1].strip().replace('"', '').replace("'", '')
-        elif line.strip().startswith('__email__'):
-            email = line.split('=')[1].strip().replace('"', '').replace("'", '')
-        elif line.strip().startswith('__source__'):
-            source = line.split('=')[1].strip().replace('"', '').replace("'", '')
-        elif line.strip().startswith('__description__'):
-            description = line.split('=')[1].strip().replace('"', '').replace("'", '')
-        elif None not in (version, author, email, source, description):
-            break
-
-setup(
-    name='fbchat',
-    author=author,
-    author_email=email,
-    license='BSD License',
-    keywords=["facebook chat fbchat"],
-    description=description,
-    long_description=readme_content,
-    classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
-        'Intended Audience :: Developers',
-        'Intended Audience :: Information Technology',
-        'License :: OSI Approved :: BSD License',
-        'Operating System :: OS Independent',
-        'Programming Language :: Python :: 2.6',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: Implementation :: CPython',
-        'Programming Language :: Python :: Implementation :: PyPy',
-        'Programming Language :: Python',
-        'Topic :: Software Development :: Libraries :: Python Modules',
-        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
-        'Topic :: Communications :: Chat',
-    ],
-    include_package_data=True,
-    packages=['fbchat'],
-    install_requires=requirements,
-    extras_require=extras_requirements,
-    url=source,
-    version=version,
-    zip_safe=True,
-)
+setup(extras_require={':python_version < "3.4"': ['enum34']})

tests/conftest.py

@@ -7,7 +7,7 @@ import json
 
 from utils import *
 from contextlib import contextmanager
-from fbchat.models import ThreadType
+from fbchat.models import ThreadType, Message, Mention
 
 
 @pytest.fixture(scope="session")
@@ -20,9 +20,13 @@ def group(pytestconfig):
     return {"id": load_variable("group_id", pytestconfig.cache), "type": ThreadType.GROUP}
 
 
-@pytest.fixture(scope="session", params=["user", "group"])
+@pytest.fixture(scope="session", params=["user", "group", pytest.mark.xfail("none")])
 def thread(request, user, group):
-    return user if request.param == "user" else group
+    return {
+        "user": user,
+        "group": group,
+        "none": {"id": "0", "type": ThreadType.GROUP}
+    }[request.param]
 
 
 @pytest.fixture(scope="session")
@@ -37,7 +41,7 @@ def client2(pytestconfig):
         yield c
 
 
-@pytest.fixture  # (scope="session")
+@pytest.fixture(scope="module")
 def client(client1, thread):
     client1.setDefaultThread(thread["id"], thread["type"])
     yield client1
@@ -80,12 +84,12 @@ def catch_event(client2):
     try:
         # Make the client send a messages to itself, so the blocking pull request will return
         # This is probably not safe, since the client is making two requests simultaneously
-        client2.sendMessage("Shutdown", client2.uid)
+        client2.sendMessage(random_hex(), client2.uid)
     finally:
         t.join()
 
 
-@pytest.fixture  # (scope="session")
+@pytest.fixture(scope="module")
 def compare(client, thread):
     def inner(caught_event, **kwargs):
         d = {
@@ -99,3 +103,21 @@ def compare(client, thread):
         return subset(caught_event.res, **d)
 
     return inner
+
+
+@pytest.fixture(params=["me", "other", "me other"])
+def message_with_mentions(request, client, client2, group):
+    text = "Hi there ["
+    mentions = []
+    if 'me' in request.param:
+        mentions.append(Mention(thread_id=client.uid, offset=len(text), length=2))
+        text += "me, "
+    if 'other' in request.param:
+        mentions.append(Mention(thread_id=client2.uid, offset=len(text), length=5))
+        text += "other, "
+    # Unused, because Facebook don't properly support sending mentions with groups as targets
+    if 'group' in request.param:
+        mentions.append(Mention(thread_id=group["id"], offset=len(text), length=5))
+        text += "group, "
+    text += "nothing]"
+    return Message(text, mentions=mentions)

tests/data.json

@@ -1,6 +0,0 @@
-{
-    "email": "",
-    "password": "",
-    "user_thread_id": "",
-    "group_thread_id": ""
-}

tests/resources/file.json

@@ -0,0 +1,4 @@
+{
+    "some": "data",
+    "in": "here"
+}

tests/resources/file.txt

@@ -0,0 +1 @@
+This is just a text file

tests/test_fetch.py

@@ -6,32 +6,20 @@ import pytest
 
 from os import path
 from fbchat.models import ThreadType, Message, Mention, EmojiSize, Sticker
-from utils import subset
+from utils import subset, STICKER_LIST, EMOJI_LIST
 
 
-def test_fetch_all_users(client):
-    users = client.fetchAllUsers()
+def test_fetch_all_users(client1):
+    users = client1.fetchAllUsers()
     assert len(users) > 0
 
 
-def test_fetch_thread_list(client):
-    threads = client.fetchThreadList(limit=2)
+def test_fetch_thread_list(client1):
+    threads = client1.fetchThreadList(limit=2)
     assert len(threads) == 2
 
 
-@pytest.mark.parametrize(
-    "emoji, emoji_size",
-    [
-        ("😆", EmojiSize.SMALL),
-        ("😆", EmojiSize.MEDIUM),
-        ("😆", EmojiSize.LARGE),
-        # These fail 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.mark.parametrize("emoji, emoji_size", EMOJI_LIST)
 def test_fetch_message_emoji(client, emoji, emoji_size):
     mid = client.sendEmoji(emoji, emoji_size)
     message, = client.fetchThreadMessages(limit=1)
@@ -41,25 +29,52 @@ def test_fetch_message_emoji(client, emoji, emoji_size):
     )
 
 
-def test_fetch_message_mentions(client):
-    text = "This is a test of fetchThreadMessages"
-    mentions = [Mention(client.uid, offset=10, length=4)]
+@pytest.mark.parametrize("emoji, emoji_size", EMOJI_LIST)
+def test_fetch_message_info_emoji(client, thread, emoji, emoji_size):
+    mid = client.sendEmoji(emoji, emoji_size)
+    message = client.fetchMessageInfo(mid, thread_id=thread["id"])
 
-    mid = client.send(Message(text, mentions=mentions))
+    assert subset(
+        vars(message), uid=mid, author=client.uid, text=emoji, emoji_size=emoji_size
+    )
+
+
+def test_fetch_message_mentions(client, thread, message_with_mentions):
+    mid = client.send(message_with_mentions)
     message, = client.fetchThreadMessages(limit=1)
 
-    assert subset(vars(message), uid=mid, author=client.uid, text=text)
-    for i, m in enumerate(mentions):
-        assert vars(message.mentions[i]) == vars(m)
+    assert subset(vars(message), uid=mid, author=client.uid, text=message_with_mentions.text)
+    # The mentions are not ordered by offset
+    for m in message.mentions:
+        assert vars(m) in [vars(x) for x in message_with_mentions.mentions]
 
 
-@pytest.mark.parametrize("sticker_id", ["767334476626295"])
-def test_fetch_message_sticker(client, sticker_id):
-    mid = client.send(Message(sticker=Sticker(sticker_id)))
+def test_fetch_message_info_mentions(client, thread, message_with_mentions):
+    mid = client.send(message_with_mentions)
+    message = client.fetchMessageInfo(mid, thread_id=thread["id"])
+
+    assert subset(vars(message), uid=mid, author=client.uid, text=message_with_mentions.text)
+    # The mentions are not ordered by offset
+    for m in message.mentions:
+        assert vars(m) in [vars(x) for x in message_with_mentions.mentions]
+
+
+@pytest.mark.parametrize("sticker", STICKER_LIST)
+def test_fetch_message_sticker(client, sticker):
+    mid = client.send(Message(sticker=sticker))
     message, = client.fetchThreadMessages(limit=1)
 
     assert subset(vars(message), uid=mid, author=client.uid)
-    assert subset(vars(message.sticker), uid=sticker_id)
+    assert subset(vars(message.sticker), uid=sticker.uid)
+
+
+@pytest.mark.parametrize("sticker", STICKER_LIST)
+def test_fetch_message_info_sticker(client, thread, sticker):
+    mid = client.send(Message(sticker=sticker))
+    message = client.fetchMessageInfo(mid, thread_id=thread["id"])
+
+    assert subset(vars(message), uid=mid, author=client.uid)
+    assert subset(vars(message.sticker), uid=sticker.uid)
 
 
 def test_fetch_info(client1, group):
@@ -71,9 +86,7 @@ def test_fetch_info(client1, group):
 
 
 def test_fetch_image_url(client):
-    url = path.join(path.dirname(__file__), "image.png")
-
-    client.sendLocalImage(url)
+    client.sendLocalFiles([path.join(path.dirname(__file__), "resources", "image.png")])
     message, = client.fetchThreadMessages(limit=1)
 
     assert client.fetchImageUrl(message.attachments[0].uid)

tests/test_message_management.py

@@ -5,8 +5,19 @@ from __future__ import unicode_literals
 import pytest
 
 from fbchat.models import Message, MessageReaction
+from utils import subset
 
 
 def test_set_reaction(client):
     mid = client.send(Message(text="This message will be reacted to"))
     client.reactToMessage(mid, MessageReaction.LOVE)
+
+
+def test_delete_messages(client):
+    text1 = "This message will stay"
+    text2 = "This message will be removed"
+    mid1 = client.sendMessage(text1)
+    mid2 = client.sendMessage(text2)
+    client.deleteMessages(mid2)
+    message, = client.fetchThreadMessages(limit=1)
+    assert subset(vars(message), uid=mid1, author=client.uid, text=text1)

tests/test_plans.py

@@ -0,0 +1,105 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+from fbchat.models import Plan, FBchatFacebookError, ThreadType
+from utils import random_hex, subset
+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)),
+])
+def plan_data(request, client, user, thread, catch_event, compare):
+    with catch_event("onPlanCreated") as x:
+        client.createPlan(request.param, thread["id"])
+    assert compare(x)
+    assert subset(
+        vars(x.res["plan"]),
+        time=request.param.time,
+        title=request.param.title,
+        author_id=client.uid,
+        going=[client.uid],
+        declined=[],
+    )
+    plan_id = x.res["plan"]
+    assert user["id"] in x.res["plan"].invited
+    request.param.uid = x.res["plan"].uid
+    yield x.res, request.param
+    with catch_event("onPlanDeleted") as x:
+        client.deletePlan(plan_id)
+    assert compare(x)
+
+
+@pytest.mark.tryfirst
+def test_create_delete_plan(plan_data):
+    pass
+
+
+def test_fetch_plan_info(client, catch_event, plan_data):
+    event, plan = plan_data
+    fetched_plan = client.fetchPlanInfo(plan.uid)
+    assert subset(
+        vars(fetched_plan),
+        time=plan.time,
+        title=plan.title,
+        author_id=int(client.uid),
+    )
+
+
+@pytest.mark.parametrize("take_part", [False, True])
+def test_change_plan_participation(client, thread, catch_event, compare, plan_data, take_part):
+    event, plan = plan_data
+    with catch_event("onPlanParticipation") as x:
+        client.changePlanParticipation(plan, take_part=take_part)
+    assert compare(x, take_part=take_part)
+    assert subset(
+        vars(x.res["plan"]),
+        time=plan.time,
+        title=plan.title,
+        author_id=client.uid,
+        going=[client.uid] if take_part else [],
+        declined=[client.uid] if not take_part else [],
+    )
+
+
+@pytest.mark.trylast
+def test_edit_plan(client, thread, catch_event, compare, plan_data):
+    event, plan = plan_data
+    new_plan = Plan(plan.time + 100, random_hex())
+    with catch_event("onPlanEdited") as x:
+        client.editPlan(plan, new_plan)
+    assert compare(x)
+    assert subset(
+        vars(x.res["plan"]),
+        time=new_plan.time,
+        title=new_plan.title,
+        author_id=client.uid,
+    )
+
+
+@pytest.mark.trylast
+@pytest.mark.expensive
+def test_on_plan_ended(client, thread, catch_event, compare):
+    with catch_event("onPlanEnded") as x:
+        client.createPlan(Plan(int(time()) + 120, "Wait for ending"))
+        x.wait(180)
+    assert subset(x.res, thread_id=client.uid if thread["type"] == ThreadType.USER else thread["id"], thread_type=thread["type"])
+
+
+#createPlan(self, plan, thread_id=None)
+#editPlan(self, plan, new_plan)
+#deletePlan(self, plan)
+#changePlanParticipation(self, plan, take_part=True)
+
+#onPlanCreated(self, mid=None, plan=None, author_id=None, thread_id=None, thread_type=None, ts=None, metadata=None, msg=None)
+#onPlanEnded(self, mid=None, plan=None, thread_id=None, thread_type=None, ts=None, metadata=None, msg=None)
+#onPlanEdited(self, mid=None, plan=None, author_id=None, thread_id=None, thread_type=None, ts=None, metadata=None, msg=None)
+#onPlanDeleted(self, mid=None, plan=None, author_id=None, thread_id=None, thread_type=None, ts=None, metadata=None, msg=None)
+#onPlanParticipation(self, mid=None, plan=None, take_part=None, author_id=None, thread_id=None, thread_type=None, ts=None, metadata=None, msg=None)
+
+#fetchPlanInfo(self, plan_id)

tests/test_polls.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+from fbchat.models import Poll, PollOption, ThreadType
+from utils import random_hex, subset
+
+
+@pytest.fixture(scope="module", params=[
+    Poll(title=random_hex(), options=[]),
+    Poll(title=random_hex(), options=[
+        PollOption(random_hex(), vote=True),
+        PollOption(random_hex(), vote=True),
+    ]),
+    Poll(title=random_hex(), options=[
+        PollOption(random_hex(), vote=False),
+        PollOption(random_hex(), vote=False),
+    ]),
+    Poll(title=random_hex(), options=[
+        PollOption(random_hex(), vote=True),
+        PollOption(random_hex(), vote=True),
+        PollOption(random_hex(), vote=False),
+        PollOption(random_hex(), vote=False),
+        PollOption(random_hex()),
+        PollOption(random_hex()),
+    ]),
+    pytest.mark.xfail(Poll(title=None, options=[]), raises=ValueError),
+])
+def poll_data(request, client1, group, catch_event):
+    with catch_event("onPollCreated") as x:
+        client1.createPoll(request.param, thread_id=group["id"])
+    options = client1.fetchPollOptions(x.res["poll"].uid)
+    return x.res, request.param, options
+
+
+def test_create_poll(client1, group, catch_event, poll_data):
+    event, poll, _ = poll_data
+    assert subset(
+        event,
+        author_id=client1.uid,
+        thread_id=group["id"],
+        thread_type=ThreadType.GROUP,
+    )
+    assert subset(vars(event["poll"]), title=poll.title, options_count=len(poll.options))
+    for recv_option in event["poll"].options:  # The recieved options may not be the full list
+        old_option, = list(filter(lambda o: o.text == recv_option.text, poll.options))
+        voters = [client1.uid] if old_option.vote else []
+        assert subset(vars(recv_option), voters=voters, votes_count=len(voters), vote=False)
+
+
+def test_fetch_poll_options(client1, group, catch_event, poll_data):
+    _, poll, options = poll_data
+    assert len(options) == len(poll.options)
+    for option in options:
+        assert subset(vars(option))
+
+
+@pytest.mark.trylast
+def test_update_poll_vote(client1, group, catch_event, poll_data):
+    event, poll, options = poll_data
+    new_vote_ids = [o.uid for o in options[0:len(options):2] if not o.vote]
+    re_vote_ids = [o.uid for o in options[0:len(options):2] if o.vote]
+    new_options = [random_hex(), random_hex()]
+    with catch_event("onPollVoted") as x:
+        client1.updatePollVote(event["poll"].uid, option_ids=new_vote_ids + re_vote_ids, new_options=new_options)
+
+    assert subset(
+        x.res,
+        author_id=client1.uid,
+        thread_id=group["id"],
+        thread_type=ThreadType.GROUP,
+    )
+    assert subset(vars(x.res["poll"]), title=poll.title, options_count=len(options + new_options))
+    for o in new_vote_ids:
+        assert o in x.res["added_options"]
+    assert len(x.res["added_options"]) == len(new_vote_ids) + len(new_options)
+    assert set(x.res["removed_options"]) == set(o.uid for o in options if o.vote and o.uid not in re_vote_ids)

tests/test_send.py

@@ -5,20 +5,11 @@ from __future__ import unicode_literals
 import pytest
 
 from os import path
-from fbchat.models import Message, Mention, EmojiSize, FBchatFacebookError, Sticker
-from utils import subset
+from fbchat.models import FBchatFacebookError, Message, Mention
+from utils import subset, STICKER_LIST, EMOJI_LIST, TEXT_LIST
 
 
-@pytest.mark.parametrize(
-    "text",
-    [
-        "test_send",
-        "😆",
-        "\\\n\t%?&'\"",
-        "ˁҭʚ¹Ʋջوװ՞ޱɣࠚԹБɑȑңКએ֭ʗыԈٌʼőԈ×௴nચϚࠖణٔє܅Ԇޑط",
-        "a" * 20000,  # Maximum amount of characters you can send
-    ],
-)
+@pytest.mark.parametrize("text", TEXT_LIST)
 def test_send_text(client, catch_event, compare, text):
     with catch_event("onMessage") as x:
         mid = client.sendMessage(text)
@@ -27,19 +18,7 @@ def test_send_text(client, catch_event, compare, text):
     assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
 
 
-@pytest.mark.parametrize(
-    "emoji, emoji_size",
-    [
-        ("😆", EmojiSize.SMALL),
-        ("😆", EmojiSize.MEDIUM),
-        ("😆", EmojiSize.LARGE),
-        # These fail 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.mark.parametrize("emoji, emoji_size", EMOJI_LIST)
 def test_send_emoji(client, catch_event, compare, emoji, emoji_size):
     with catch_event("onMessage") as x:
         mid = client.sendEmoji(emoji, emoji_size)
@@ -54,42 +33,28 @@ def test_send_emoji(client, catch_event, compare, emoji, emoji_size):
     )
 
 
-@pytest.mark.xfail(raises=FBchatFacebookError)
-@pytest.mark.parametrize("message", [Message("a" * 20001)])
-def test_send_invalid(client, message):
-    client.send(message)
-
-
-def test_send_mentions(client, client2, thread, catch_event, compare):
-    text = "Hi there @me, @other and @thread"
-    mentions = [
-        dict(thread_id=client.uid, offset=9, length=3),
-        dict(thread_id=client2.uid, offset=14, length=6),
-        dict(thread_id=thread["id"], offset=26, length=7),
-    ]
+def test_send_mentions(client, catch_event, compare, message_with_mentions):
     with catch_event("onMessage") as x:
-        mid = client.send(Message(text, mentions=[Mention(**d) for d in mentions]))
+        mid = client.send(message_with_mentions)
 
-    assert compare(x, mid=mid, message=text)
-    assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
+    assert compare(x, mid=mid, message=message_with_mentions.text)
+    assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=message_with_mentions.text)
     # The mentions are not ordered by offset
     for m in x.res["message_object"].mentions:
-        assert vars(m) in mentions
+        assert vars(m) in [vars(x) for x in message_with_mentions.mentions]
 
 
-@pytest.mark.parametrize(
-    "sticker_id",
-    ["767334476626295", pytest.mark.xfail("0", raises=FBchatFacebookError)],
-)
-def test_send_sticker(client, catch_event, compare, sticker_id):
+@pytest.mark.parametrize("sticker", STICKER_LIST)
+def test_send_sticker(client, catch_event, compare, sticker):
     with catch_event("onMessage") as x:
-        mid = client.send(Message(sticker=Sticker(sticker_id)))
+        mid = client.send(Message(sticker=sticker))
 
     assert compare(x, mid=mid)
     assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid)
-    assert subset(vars(x.res["message_object"].sticker), uid=sticker_id)
+    assert subset(vars(x.res["message_object"].sticker), uid=sticker.uid)
 
 
+# Kept for backwards compatibility
 @pytest.mark.parametrize(
     "method_name, url",
     [
@@ -97,7 +62,7 @@ def test_send_sticker(client, catch_event, compare, sticker_id):
             "sendRemoteImage",
             "https://github.com/carpedm20/fbchat/raw/master/tests/image.png",
         ),
-        ("sendLocalImage", path.join(path.dirname(__file__), "image.png")),
+        ("sendLocalImage", path.join(path.dirname(__file__), "resources", "image.png")),
     ],
 )
 def test_send_images(client, catch_event, compare, method_name, url):
@@ -108,3 +73,37 @@ def test_send_images(client, catch_event, compare, method_name, url):
     assert compare(x, mid=mid, message=text)
     assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
     assert x.res["message_object"].attachments[0]
+
+
+def test_send_local_files(client, catch_event, compare):
+    files = ["image.png", "image.jpg", "image.gif", "file.json", "file.txt", "audio.mp3", "video.mp4"]
+    text = "Files sent locally"
+    with catch_event("onMessage") as x:
+        mid = client.sendLocalFiles(
+            [path.join(path.dirname(__file__), "resources", f) for f in files],
+            message=Message(text),
+        )
+
+    assert compare(x, mid=mid, message=text)
+    assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
+    assert len(x.res["message_object"].attachments) == len(files)
+
+
+# To be changed when merged into master
+def test_send_remote_files(client, catch_event, compare):
+    files = ["image.png", "data.json"]
+    text = "Files sent from remote"
+    with catch_event("onMessage") as x:
+        mid = client.sendRemoteFiles(
+            ["https://github.com/carpedm20/fbchat/raw/master/tests/{}".format(f) for f in files],
+            message=Message(text),
+        )
+
+    assert compare(x, mid=mid, message=text)
+    assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
+    assert len(x.res["message_object"].attachments) == len(files)
+
+
+@pytest.mark.parametrize('wave_first', [True, False])
+def test_wave(client, wave_first):
+    client.wave(wave_first)

tests/test_thread_interraction.py

@@ -12,7 +12,7 @@ from fbchat.models import (
     ThreadColor,
 )
 from utils import random_hex, subset
-from os import environ
+from os import path
 
 
 def test_remove_from_and_add_to_group(client1, client2, group, catch_event):
@@ -31,16 +31,28 @@ def test_remove_from_and_add_to_group(client1, client2, group, catch_event):
         )
 
 
-@pytest.mark.xfail(
-    raises=FBchatFacebookError, reason="Apparently changeThreadTitle is broken"
+def test_remove_from_and_add_admins_to_group(client1, client2, group, catch_event):
+    # Test both methods, while ensuring that the user gets added as group admin
+    try:
+        with catch_event("onAdminRemoved") as x:
+            client1.removeGroupAdmins(client2.uid, group["id"])
+        assert subset(
+            x.res, removed_id=client2.uid, author_id=client1.uid, thread_id=group["id"]
         )
-def test_change_title(client1, catch_event, group):
+    finally:
+        with catch_event("onAdminAdded") as x:
+            client1.addGroupAdmins(client2.uid, group["id"])
+        assert subset(
+            x.res, added_id=client2.uid, author_id=client1.uid, thread_id=group["id"]
+        )
+
+
+def test_change_title(client1, group, catch_event):
     title = random_hex()
     with catch_event("onTitleChange") as x:
-        mid = client1.changeThreadTitle(title, group["id"])
+        client1.changeThreadTitle(title, group["id"], thread_type=ThreadType.GROUP)
     assert subset(
         x.res,
-        mid=mid,
         author_id=client1.uid,
         new_title=title,
         thread_id=group["id"],
@@ -55,17 +67,33 @@ def test_change_nickname(client, client_all, catch_event, compare):
     assert compare(x, changed_for=client_all.uid, new_nickname=nickname)
 
 
-@pytest.mark.parametrize("emoji", ["😀", "😂", "😕", "😍"])
+@pytest.mark.parametrize("emoji", [
+    "😀",
+    "😂",
+    "😕",
+    "😍",
+    pytest.mark.xfail("🙃", raises=FBchatFacebookError),
+    pytest.mark.xfail("not an emoji", raises=FBchatFacebookError)
+])
 def test_change_emoji(client, catch_event, compare, emoji):
     with catch_event("onEmojiChange") as x:
         client.changeThreadEmoji(emoji)
     assert compare(x, new_emoji=emoji)
 
 
-@pytest.mark.xfail(raises=FBchatFacebookError)
-@pytest.mark.parametrize("emoji", ["🙃", "not an emoji"])
-def test_change_emoji_invalid(client, emoji):
-    client.changeThreadEmoji(emoji)
+def test_change_image_local(client1, group, catch_event):
+    url = path.join(path.dirname(__file__), "resources", "image.png")
+    with catch_event("onImageChange") as x:
+        image_id = client1.changeGroupImageLocal(url, group["id"])
+    assert subset(x.res, new_image=image_id, author_id=client1.uid, thread_id=group["id"])
+
+
+# To be changed when merged into master
+def test_change_image_remote(client1, group, catch_event):
+    url = "https://github.com/carpedm20/fbchat/raw/master/tests/image.png"
+    with catch_event("onImageChange") as x:
+        image_id = client1.changeGroupImageRemote(url, group["id"])
+    assert subset(x.res, new_image=image_id, author_id=client1.uid, thread_id=group["id"])
 
 
 @pytest.mark.parametrize(
@@ -83,9 +111,7 @@ def test_change_color(client, catch_event, compare, color):
     assert compare(x, new_color=color)
 
 
-@pytest.mark.xfail(
-    raises=FBchatFacebookError, strict=False, reason="Should fail, but doesn't"
-)
+@pytest.mark.xfail(raises=FBchatFacebookError, reason="Should fail, but doesn't")
 def test_change_color_invalid(client):
     class InvalidColor:
         value = "#0077ff"
@@ -98,3 +124,31 @@ def test_typing_status(client, catch_event, compare, status):
     with catch_event("onTyping") as x:
         client.setTypingStatus(status)
     assert compare(x, status=status)
+
+
+@pytest.mark.parametrize('require_admin_approval', [True, False])
+def test_change_approval_mode(client1, group, catch_event, require_admin_approval):
+    with catch_event("onApprovalModeChange") as x:
+        client1.changeGroupApprovalMode(require_admin_approval, group["id"])
+
+    assert subset(
+        x.res,
+        approval_mode=require_admin_approval,
+        author_id=client1.uid,
+        thread_id=group["id"],
+    )
+
+@pytest.mark.parametrize("mute_time", [0, 10, 100, 1000, -1])
+def test_mute_thread(client, mute_time):
+    assert client.muteThread(mute_time)
+    assert client.unmuteThread()
+
+
+def test_mute_thread_reactions(client):
+    assert client.muteThreadReactions()
+    assert client.unmuteThreadReactions()
+
+
+def test_mute_thread_mentions(client):
+    assert client.muteThreadMentions()
+    assert client.unmuteThreadMentions()

tests/utils.py

@@ -5,17 +5,46 @@ from __future__ import unicode_literals
 import threading
 import logging
 import six
+import pytest
 
 from os import environ
 from random import randrange
 from contextlib import contextmanager
 from six import viewitems
 from fbchat import Client
-from fbchat.models import ThreadType
+from fbchat.models import ThreadType, EmojiSize, FBchatFacebookError, Sticker
 
 log = logging.getLogger("fbchat.tests").addHandler(logging.NullHandler())
 
 
+EMOJI_LIST = [
+    ("😆", EmojiSize.SMALL),
+    ("😆", EmojiSize.MEDIUM),
+    ("😆", 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)),
+]
+
+STICKER_LIST = [
+    Sticker("767334476626295"),
+    pytest.mark.xfail(Sticker("0"), raises=FBchatFacebookError),
+    pytest.mark.xfail(Sticker(None), raises=FBchatFacebookError),
+]
+
+TEXT_LIST = [
+    "test_send",
+    "😆",
+    "\\\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),
+]
+
+
 class ClientThread(threading.Thread):
     def __init__(self, client, *args, **kwargs):
         self.client = client
@@ -77,7 +106,9 @@ def load_client(n, cache):
     client = Client(
         load_variable("client{}_email".format(n), cache),
         load_variable("client{}_password".format(n), cache),
+        user_agent='Mozilla/5.0 (Windows NT 6.3; WOW64; ; NCT50_AAP285C84A1328) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36',
         session_cookies=cache.get("client{}_session".format(n), None),
+        max_tries=1,
     )
     yield client
     cache.set("client{}_session".format(n), client.getSession())