Bump version: 1.8.0 → 1.8.1

Make Client._get and Client._post require a query input

.bumpversion.cfg

@@ -0,0 +1,7 @@
+[bumpversion]
+current_version = 1.8.1
+commit = True
+tag = True
+
+[bumpversion:file:fbchat/__init__.py]
+

.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
@@ -24,7 +26,13 @@ develop-eggs
 # Sphinx documentation
 docs/_build/
 
-# Data for tests
+# Scripts and data for tests
+my_tests.py
 my_test_data.json
 my_data.json
-tests.data
+tests.data
+.pytest_cache
+
+# Virtual environment
+venv/
+.venv*/

.readthedocs.yml

@@ -0,0 +1,18 @@
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+version: 2
+
+formats:
+  - pdf
+  - htmlzip
+
+python:
+  version: 3.6
+  install:
+    - path: .
+      extra_requirements:
+        - docs
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: true

.travis.yml

@@ -0,0 +1,61 @@
+sudo: false
+language: python
+python: 3.6
+
+cache: pip
+
+before_install: pip install flit
+# Use `--deps production` so that we don't install unnecessary dependencies
+install: flit install --deps production --extras test
+script: pytest -m offline
+
+jobs:
+  include:
+  - 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
+
+  - name: Lint
+    before_install: skip
+    install: pip install black
+    script: black --check --verbose .
+
+  - stage: deploy
+    name: GitHub Releases
+    if: tag IS present
+    install: skip
+    script: flit build
+    deploy:
+      provider: releases
+      api_key: $GITHUB_OAUTH_TOKEN
+      file_glob: true
+      file: dist/*
+      skip_cleanup: true
+      draft: false
+      on:
+        tags: true
+
+  - stage: deploy
+    name: PyPI
+    if: tag IS present
+    install: skip
+    script: skip
+    deploy:
+      provider: script
+      script: flit publish
+      on:
+        tags: true
+
+notifications:
+  email:
+    on_success: never
+    on_failure: change

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,38 @@
+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``.
+
+Development Environment
+-----------------------
+
+You can use `flit` to install the package as a symlink:
+
+.. code-block::
+
+    $ # *nix:
+    $ flit install --symlink
+    $ # Windows:
+    $ flit install --pth-file
+
+After that, you can ``import`` the module as normal.
+
+Before committing, you should run ``black .`` in the main directory, to format your code.
+
+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 +0,0 @@
-include LICENSE.txt
-include MANIFEST.in
-include README.rst
-include setup.py

README.rst

@@ -1,30 +1,50 @@
-fbchat: Facebook Chat (Messenger) for Python
-============================================
+``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%203.7%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, 3.7 and pypy
 
-.. image:: https://readthedocs.org/projects/fbchat/badge/?version=master
+.. image:: https://readthedocs.org/projects/fbchat/badge/?version=latest
     :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
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/ambv/black
+    :alt: Code style
+
 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:
 
-.. code-block:: console
+.. code-block::
 
     $ pip install fbchat
 
-© Copyright 2015 - 2017 by Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
+You can also install from source if you have ``pip>=19.0``:
+
+.. code-block::
+
+    $ git clone https://github.com/carpedm20/fbchat.git
+    $ pip install fbchat
+
+
+Maintainer
+----------
+
+- Mads Marquart / `@madsmtm <https://github.com/madsmtm>`__
+- Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__

docs/Makefile

@@ -3,8 +3,7 @@
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
-SPHINXBUILD   = python3.6 -msphinx
-SPHINXPROJ    = fbchat
+SPHINXBUILD   = sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 

docs/api.rst

@@ -1,44 +1,79 @@
 .. module:: fbchat
-.. highlight:: python
 .. _api:
 
+.. Note: we're using () to hide the __init__ method where relevant
+
 Full API
 ========
 
 If you are looking for information on a specific function, class, or method, this part of the documentation is for you.
 
-
-.. _api_client:
-
 Client
 ------
 
-This is the main class of `fbchat`, which contains all the methods you use to interract with Facebook.
-You can extend this class, and overwrite the events, to provide custom event handling (mainly used while listening)
+.. autoclass:: Client
 
-.. autoclass:: Client(email, password, user_agent=None, max_tries=5, session_cookies=None, logging_level=logging.INFO)
-    :members:
+Threads
+-------
 
+.. autoclass:: Thread()
+.. autoclass:: ThreadType(Enum)
+    :undoc-members:
+.. autoclass:: Page()
+.. autoclass:: User()
+.. autoclass:: Group()
 
-.. _api_models:
+Messages
+--------
 
-Models
-------
-
-These models are used in various functions, both as inputs and return values.
-A good tip is to write ``from fbchat.models import *`` at the start of your source, so you can use these models freely
-
-.. automodule:: fbchat.models
-    :members:
+.. autoclass:: Message
+.. autoclass:: Mention
+.. autoclass:: EmojiSize(Enum)
+    :undoc-members:
+.. autoclass:: MessageReaction(Enum)
     :undoc-members:
 
+Exceptions
+----------
 
-.. _api_utils:
+.. autoexception:: FBchatException()
+.. autoexception:: FBchatFacebookError()
+.. autoexception:: FBchatUserError()
 
-Utils
------
+Attachments
+-----------
 
-These functions and values are used internally by fbchat, and are subject to change. Do **NOT** rely on these to be backwards compatible!
+.. autoclass:: Attachment()
+.. autoclass:: ShareAttachment()
+.. autoclass:: Sticker()
+.. autoclass:: LocationAttachment()
+.. autoclass:: LiveLocationAttachment()
+.. autoclass:: FileAttachment()
+.. autoclass:: AudioAttachment()
+.. autoclass:: ImageAttachment()
+.. autoclass:: VideoAttachment()
+.. autoclass:: ImageAttachment()
 
-.. automodule:: fbchat.utils
-    :members:
+Miscellaneous
+-------------
+
+.. autoclass:: ThreadLocation(Enum)
+    :undoc-members:
+.. autoclass:: ThreadColor(Enum)
+    :undoc-members:
+.. autoclass:: ActiveStatus()
+.. autoclass:: TypingStatus(Enum)
+    :undoc-members:
+
+.. autoclass:: QuickReply
+.. autoclass:: QuickReplyText
+.. autoclass:: QuickReplyLocation
+.. autoclass:: QuickReplyPhoneNumber
+.. autoclass:: QuickReplyEmail
+
+.. autoclass:: Poll
+.. autoclass:: PollOption
+
+.. autoclass:: Plan
+.. autoclass:: GuestStatus(Enum)
+    :undoc-members:

docs/conf.py

@@ -1,191 +1,208 @@
-#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 #
-# fbchat documentation build configuration file, created by
-# sphinx-quickstart on Thu May 25 15:43:01 2017.
+# Configuration file for the Sphinx documentation builder.
 #
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
+# -- Path setup --------------------------------------------------------------
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('..'))
+
+sys.path.insert(0, os.path.abspath(".."))
 
 import fbchat
-import tests
-from fbchat import __copyright__, __author__, __version__, __description__
+
+# -- Project information -----------------------------------------------------
+
+project = fbchat.__name__
+copyright = fbchat.__copyright__
+author = fbchat.__author__
+
+# The short X.Y version
+version = fbchat.__version__
+# The full version, including alpha/beta/rc tags
+release = fbchat.__version__
 
 
-# -- General configuration ------------------------------------------------
+# -- General configuration ---------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-# needs_sphinx = '1.0'
+needs_sphinx = "2.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx.ext.viewcode'
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinxcontrib.spelling",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+templates_path = ["_templates"]
 
 # The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = 'fbchat'
-title = 'fbchat Documentation'
-copyright = __copyright__
-author = __author__
-description = __description__
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = __version__
-# The full version, including alpha/beta/rc tags.
-release = __version__
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
+master_doc = "index"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+rst_prolog = ".. currentmodule:: " + project
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#
+default_role = "any"
+
+# Make the reference parsing more strict
+#
+nitpicky = True
+
+# Prefer strict Python highlighting
+#
+highlight_language = "python3"
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#
+add_function_parentheses = False
 
 
-# -- Options for HTML output ----------------------------------------------
+# -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    "show_powered_by": False,
+    "github_user": "carpedm20",
+    "github_repo": project,
+    "github_banner": True,
+    "show_related": False,
+}
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+html_sidebars = {"**": ["sidebar.html", "searchbox.html"]}
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#
+html_show_sphinx = False
+
+# If true, links to the reST sources are added to the pages.
+#
+html_show_sourcelink = False
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#
+html_short_title = fbchat.__description__
 
 
-# -- Options for HTMLHelp output ------------------------------------------
+# -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = project + 'doc'
+htmlhelp_basename = project + "doc"
 
 
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
+# -- Options for LaTeX output ------------------------------------------------
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, project + '.tex', title,
-     author, 'manual'),
-]
+latex_documents = [(master_doc, project + ".tex", fbchat.__title__, author, "manual")]
 
 
-# -- Options for manual page output ---------------------------------------
+# -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, project, title,
-     [author], 1)
+    (master_doc, project, fbchat.__title__, [x.strip() for x in author.split(";")], 1)
 ]
 
 
-# -- Options for Texinfo output -------------------------------------------
+# -- Options for Texinfo output ----------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, project, title,
-     author, project, description,
-     'Miscellaneous'),
+    (
+        master_doc,
+        project,
+        fbchat.__title__,
+        author,
+        project,
+        fbchat.__description__,
+        "Miscellaneous",
+    )
 ]
 
 
+# -- Options for Epub output -------------------------------------------------
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for autodoc extension ---------------------------------------
+
+autoclass_content = "both"
+autodoc_member_order = "bysource"
+autodoc_default_options = {"members": True}
+
+# -- Options for intersphinx extension ---------------------------------------
+
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'https://docs.python.org/3/': None}
+intersphinx_mapping = {"https://docs.python.org/": None}
 
+# -- Options for todo extension ----------------------------------------------
 
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
 
-add_function_parentheses = False
+todo_link_only = True
 
-html_theme_options = {
-    'show_powered_by': False,
-    'github_user': 'carpedm20',
-    'github_repo': project,
-    'github_banner': True,
-    'show_related': False
-}
+# -- Options for napoleon extension ----------------------------------------------
 
-html_sidebars = {
-    '**': ['sidebar.html', 'searchbox.html']
-}
+# Use Google style docstrings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
 
-html_show_sphinx = False
-html_show_sourcelink = False
-autoclass_content = 'init'
-html_short_title = description
+# napoleon_use_admonition_for_examples = False
+# napoleon_use_admonition_for_notes = False
+# napoleon_use_admonition_for_references = False
+
+# -- Options for spelling extension ----------------------------------------------
+
+spelling_word_list_filename = [
+    "spelling/names.txt",
+    "spelling/technical.txt",
+    "spelling/fixes.txt",
+]
+spelling_ignore_wiki_words = False
+# spelling_ignore_acronyms = False
+spelling_ignore_python_builtins = False
+spelling_ignore_importable_modules = False

docs/examples.rst

@@ -1,16 +1,15 @@
-.. highlight:: python
 .. _examples:
 
 Examples
 ========
 
-These are a few examples on how to use `fbchat`. Remember to swap out `<email>` and `<password>` for your email and password
+These are a few examples on how to use ``fbchat``. Remember to swap out ``<email>`` and ``<password>`` for your email and password
 
 
 Basic example
 -------------
 
-This will show basic usage of `fbchat`
+This will show basic usage of ``fbchat``
 
 .. literalinclude:: ../examples/basic_usage.py
 
@@ -18,7 +17,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
 
@@ -31,8 +30,8 @@ This will show the different ways of fetching information about users and thread
 .. literalinclude:: ../examples/fetch.py
 
 
-Echobot
--------
+``Echobot``
+-----------
 
 This will reply to any message with the same message
 
@@ -42,7 +41,7 @@ This will reply to any message with the same message
 Remove Bot
 ----------
 
-This will remove a user from a group if they write the message `Remove me!`
+This will remove a user from a group if they write the message ``Remove me!``
 
 .. literalinclude:: ../examples/removebot.py
 

docs/faq.rst

@@ -1,5 +1,3 @@
-.. highlight:: python
-.. module:: fbchat
 .. _faq:
 
 FAQ
@@ -8,10 +6,10 @@ 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
+Downgrade to an earlier version of ``fbchat``, run this command
 
 .. code-block:: sh
 
@@ -23,14 +21,14 @@ Where you replace ``<X>`` with the version you want to use
 Will you be supporting creating posts/events/pages and so on?
 -------------------------------------------------------------
 
-We won't be focusing on anything else than chat-related things. This API is called `fbCHAT`, after all ;)
+We won't be focusing on anything else than chat-related things. This API is called ``fbCHAT``, after all ;)
 
 
 Submitting Issues
 -----------------
 
 If you're having trouble with some of the snippets, or you think some of the functionality is broken,
-please feel free to submit an issue on `Github <https://github.com/carpedm20/fbchat>`_.
+please feel free to submit an issue on `GitHub <https://github.com/carpedm20/fbchat>`_.
 You should first login with ``logging_level`` set to ``logging.DEBUG``::
 
     from fbchat import Client

docs/index.rst

@@ -1,5 +1,3 @@
-.. highlight:: python
-.. module:: fbchat
 .. fbchat documentation master file, created by
    sphinx-quickstart on Thu May 25 15:43:01 2017.
    You can adapt this file completely to your liking, but it should at least
@@ -8,8 +6,8 @@
 .. This documentation's layout is heavily inspired by requests' layout: https://requests.readthedocs.io
    Some documentation is also partially copied from facebook-chat-api: https://github.com/Schmavery/facebook-chat-api
 
-fbchat: Facebook Chat (Messenger) for Python
-============================================
+``fbchat``: Facebook Chat (Messenger) for Python
+================================================
 
 Release v\ |version|. (:ref:`install`)
 
@@ -30,14 +28,14 @@ This project was inspired by `facebook-chat-api <https://github.com/Schmavery/fa
 
 **No XMPP or API key is needed**. Just use your email and password.
 
-Currently `fbchat` support Python 2.7, 3.4, 3.5 and 3.6:
+Currently ``fbchat`` support Python 2.7, 3.4, 3.5 and 3.6:
 
-`fbchat` works by emulating the browser.
+``fbchat`` works by emulating the browser.
 This means doing the exact same GET/POST requests and tricking Facebook into thinking it's accessing the website normally.
 Therefore, this API requires the credentials of a Facebook account.
 
 .. note::
-    If you're having problems, please check the :ref:`faq`, before asking questions on Github
+    If you're having problems, please check the :ref:`faq`, before asking questions on GitHub
 
 .. warning::
     We are not responsible if your account gets banned for spammy activities,
@@ -46,9 +44,9 @@ Therefore, this API requires the credentials of a Facebook account.
 
 .. note::
     Facebook now has an `official API <https://developers.facebook.com/docs/messenger-platform>`_ for chat bots,
-    so if you're familiar with node.js, this might be what you're looking for.
+    so if you're familiar with ``Node.js``, this might be what you're looking for.
 
-If you're already familiar with the basics of how Facebook works internally, go to :ref:`examples` to see example usage of `fbchat`
+If you're already familiar with the basics of how Facebook works internally, go to :ref:`examples` to see example usage of ``fbchat``
 
 
 Overview

docs/install.rst

@@ -1,13 +1,14 @@
-.. highlight:: sh
 .. _install:
 
 Installation
 ============
 
-Pip Install fbchat
-------------------
+Install using pip
+-----------------
 
-To install fbchat, run this command::
+To install ``fbchat``, run this command:
+
+.. code-block:: sh
 
     $ pip install fbchat
 
@@ -18,19 +19,25 @@ can guide you through the process.
 Get the Source Code
 -------------------
 
-fbchat is developed on GitHub, where the code is
+``fbchat`` is developed on GitHub, where the code is
 `always available <https://github.com/carpedm20/fbchat>`_.
 
-You can either clone the public repository::
+You can either clone the public repository:
+
+.. code-block:: sh
 
     $ git clone git://github.com/carpedm20/fbchat.git
 
-Or, download a `tarball <https://github.com/carpedm20/fbchat/tarball/master>`_::
+Or, download a `tarball <https://github.com/carpedm20/fbchat/tarball/master>`_:
+
+.. code-block:: sh
 
     $ curl -OL https://github.com/carpedm20/fbchat/tarball/master
-      # optionally, zipball is also available (for Windows users).
+    # optionally, zipball is also available (for Windows users).
 
 Once you have a copy of the source, you can embed it in your own Python
-package, or install it into your site-packages easily::
+package, or install it into your site-packages easily:
+
+.. code-block:: sh
 
     $ python setup.py install

docs/intro.rst

@@ -1,12 +1,10 @@
-.. highlight:: python
-.. module:: fbchat
 .. _intro:
 
 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.
+``fbchat`` uses your email and password to communicate with the Facebook server.
+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 +14,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 *
@@ -26,9 +24,9 @@ Replace ``<email>`` and ``<password>`` with your email and password respectively
 
 .. note::
     For ease of use then most of the code snippets in this document will assume you've already completed the login process
-    Though the second line, ``from fbchat.models import *``, is not strictly neccesary here, later code snippets will assume you've done this
+    Though the second line, ``from fbchat.models import *``, is not strictly necessary here, later code snippets will assume you've done this
 
-If you want to change how verbose `fbchat` is, change the logging level (in :class:`Client`)
+If you want to change how verbose ``fbchat`` is, change the logging level (in :class:`Client`)
 
 Throughout your code, if you want to check whether you are still logged in, use :func:`Client.isLoggedIn`.
 An example would be to login again if you've been logged out, using :func:`Client.login`::
@@ -48,9 +46,9 @@ Threads
 
 A thread can refer to two things: A Messenger group chat or a single Facebook user
 
-:class:`models.ThreadType` is an enumerator with two values: ``USER`` and ``GROUP``.
+:class:`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`
@@ -70,8 +68,8 @@ The same method can be applied to some user accounts, though if they've set a cu
 Here's an snippet showing the usage of thread IDs and thread types, where ``<user id>`` and ``<group id>``
 corresponds to the ID of a single user, and the ID of a group respectively::
 
-    client.sendMessage('<message>', thread_id='<user id>', thread_type=ThreadType.USER)
-    client.sendMessage('<message>', thread_id='<group id>', thread_type=ThreadType.GROUP)
+    client.send(Message(text='<message>'), thread_id='<user id>', thread_type=ThreadType.USER)
+    client.send(Message(text='<message>'), thread_id='<group id>', thread_type=ThreadType.GROUP)
 
 Some functions (e.g. :func:`Client.changeThreadColor`) don't require a thread type, so in these cases you just provide the thread ID::
 
@@ -87,11 +85,11 @@ Message IDs
 Every message you send on Facebook has a unique ID, and every action you do in a thread,
 like changing a nickname or adding a person, has a unique ID too.
 
-Some of `fbchat`'s functions require these ID's, like :func:`Client.reactToMessage`,
+Some of ``fbchat``'s functions require these ID's, like :func:`Client.reactToMessage`,
 and some of then provide this ID, like :func:`Client.sendMessage`.
 This snippet shows how to send a message, and then use the returned ID to react to that message with a 😍 emoji::
 
-    message_id = client.sendMessage('message', thread_id=thread_id, thread_type=thread_type)
+    message_id = client.send(Message(text='message'), thread_id=thread_id, thread_type=thread_type)
     client.reactToMessage(message_id, MessageReaction.LOVE)
 
 
@@ -100,17 +98,17 @@ This snippet shows how to send a message, and then use the returned ID to react
 Interacting with Threads
 ------------------------
 
-`fbchat` provides multiple functions for interacting with threads
+``fbchat`` provides multiple functions for interacting with threads
 
 Most functionality works on all threads, though some things,
 like adding users to and removing users from a group chat, logically only works on group chats
 
-The simplest way of using `fbchat` is to send a message.
-The following snippet will, as you've probably already figured out, send the message `test message` to your account::
+The simplest way of using ``fbchat`` is to send a message.
+The following snippet will, as you've probably already figured out, send the message ``test message`` to your account::
 
-    message_id = client.sendMessage('test message', thread_id=client.uid, thread_type=ThreadType.USER)
+    message_id = client.send(Message(text='test message'), thread_id=client.uid, thread_type=ThreadType.USER)
 
-You can see a full example showing all the possible thread interactions with `fbchat` by going to :ref:`examples`
+You can see a full example showing all the possible thread interactions with ``fbchat`` by going to :ref:`examples`
 
 
 .. _intro_fetching:
@@ -118,7 +116,7 @@ You can see a full example showing all the possible thread interactions with `fb
 Fetching Information
 --------------------
 
-You can use `fbchat` to fetch basic information like user names, profile pictures, thread names and user IDs
+You can use ``fbchat`` to fetch basic information like user names, profile pictures, thread names and user IDs
 
 You can retrieve a user's ID with :func:`Client.searchForUsers`.
 The following snippet will search for users by their name, take the first (and most likely) user, and then get their user ID from the result::
@@ -127,12 +125,12 @@ The following snippet will search for users by their name, take the first (and m
     user = users[0]
     print("User's ID: {}".format(user.uid))
     print("User's name: {}".format(user.name))
-    print("User's profile picture url: {}".format(user.photo))
-    print("User's main url: {}".format(user.url))
+    print("User's profile picture URL: {}".format(user.photo))
+    print("User's main URL: {}".format(user.url))
 
 Since this uses Facebook's search functions, you don't have to specify the whole name, first names will usually be enough
 
-You can see a full example showing all the possible ways to fetch information with `fbchat` by going to :ref:`examples`
+You can see a full example showing all the possible ways to fetch information with ``fbchat`` by going to :ref:`examples`
 
 
 .. _intro_sessions:
@@ -140,8 +138,8 @@ You can see a full example showing all the possible ways to fetch information wi
 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.
+``fbchat`` provides functions to retrieve and set the session cookies.
+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()
@@ -156,7 +154,7 @@ Or you can set the ``session_cookies`` on your initial login.
     client = Client('<email>', '<password>', session_cookies=session_cookies)
 
 .. warning::
-    You session cookies can be just as valueable as you password, so store them with equal care
+    You session cookies can be just as valuable as you password, so store them with equal care
 
 
 .. _intro_events:
@@ -164,19 +162,19 @@ Or you can set the ``session_cookies`` on your initial login.
 Listening & Events
 ------------------
 
-To use the listening functions `fbchat` offers (like :func:`Client.listen`),
+To use the listening functions ``fbchat`` offers (like :func:`Client.listen`),
 you have to define what should be executed when certain events happen.
 By default, (most) events will just be a `logging.info` statement,
 meaning it will simply print information to the console when an event happens
 
 .. note::
-    You can identify the event methods by their `on` prefix, e.g. `onMessage`
+    You can identify the event methods by their ``on`` prefix, e.g. `onMessage`
 
 The event actions can be changed by subclassing the :class:`Client`, and then overwriting the event methods::
 
     class CustomClient(Client):
-        def onMessage(self, mid, author_id, message, thread_id, thread_type, ts, metadata, msg, **kwargs):
-            # Do something with the message here
+        def onMessage(self, mid, author_id, message_object, thread_id, thread_type, ts, metadata, msg, **kwargs):
+            # Do something with message_object here
             pass
 
     client = CustomClient('<email>', '<password>')
@@ -184,17 +182,17 @@ The event actions can be changed by subclassing the :class:`Client`, and then ov
 **Notice:** The following snippet is as equally valid as the previous one::
 
     class CustomClient(Client):
-        def onMessage(self, message, author_id, thread_id, thread_type, **kwargs):
-            # Do something with the message here
+        def onMessage(self, message_object, author_id, thread_id, thread_type, **kwargs):
+            # Do something with message_object here
             pass
 
     client = CustomClient('<email>', '<password>')
 
-The change was in the parameters that our `onMessage` method took: ``message`` and ``author_id`` got swapped,
+The change was in the parameters that our `onMessage` method took: ``message_object`` and ``author_id`` got swapped,
 and ``mid``, ``ts``, ``metadata`` and ``msg`` got removed, but the function still works, since we included ``**kwargs``
 
 .. note::
-    Therefore, for both backwards and forwards compatability,
+    Therefore, for both backwards and forwards compatibility,
     the API actually requires that you include ``**kwargs`` as your final argument.
 
 View the :ref:`examples` to see some more examples illustrating the event system

docs/make.bat

@@ -5,21 +5,20 @@ pushd %~dp0
 REM Command file for Sphinx documentation
 
 if "%SPHINXBUILD%" == "" (
-	set SPHINXBUILD=python -msphinx
+	set SPHINXBUILD=sphinx-build
 )
 set SOURCEDIR=.
 set BUILDDIR=_build
-set SPHINXPROJ=fbchat
 
 if "%1" == "" goto help
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
-	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
-	echo.then set the SPHINXBUILD environment variable to point to the full
-	echo.path of the 'sphinx-build' executable. Alternatively you may add the
-	echo.Sphinx directory to PATH.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
 	echo.http://sphinx-doc.org/

docs/spelling/fixes.txt

@@ -0,0 +1,3 @@
+premade
+todo
+emoji

docs/spelling/names.txt

@@ -0,0 +1,3 @@
+Facebook
+GraphQL
+GitHub

docs/spelling/technical.txt

@@ -0,0 +1,14 @@
+iterables
+timestamp
+metadata
+spam
+spammy
+admin
+admins
+unsend
+unsends
+unmute
+spritemap
+online
+inbox
+subclassing

docs/testing.rst

@@ -1,5 +1,3 @@
-.. highlight:: sh
-.. module:: fbchat
 .. _testing:
 
 Testing
@@ -15,7 +13,9 @@ To use the tests, copy ``tests/data.json`` to ``tests/my_data.json`` or type the
 Please remember to test all supported python versions.
 If you've made any changes to the 2FA functionality, test it with a 2FA enabled account.
 
-If you only want to execute specific tests, pass the function names in the commandline (not including the `test_` prefix). Example::
+If you only want to execute specific tests, pass the function names in the command line (not including the ``test_`` prefix). Example:
+
+.. code-block:: sh
 
     $ python tests.py sendMessage sessions sendEmoji
 
@@ -23,7 +23,3 @@ If you only want to execute specific tests, pass the function names in the comma
 
     Do not execute the full set of tests in too quick succession. This can get your account temporarily blocked for spam!
     (You should execute the script at max about 10 times a day)
-
-.. automodule:: tests
-    :members: TestFbchat
-    :undoc-members: TestFbchat

docs/todo.rst

@@ -1,5 +1,3 @@
-.. highlight:: python
-.. module:: fbchat
 .. _todo:
 
 Todo
@@ -11,11 +9,11 @@ This page will be periodically updated to show missing features and documentatio
 Missing Functionality
 ---------------------
 
-- Implement Client.searchForMessage
-    - This will use the graphql request API
+- Implement ``Client.searchForMessage``
+    - This will use the GraphQL request API
 - Implement chatting with pages properly
 - Write better FAQ
-- Explain usage of graphql
+- Explain usage of GraphQL
 
 
 Documentation

examples/basic_usage.py

@@ -3,10 +3,10 @@
 from fbchat import Client
 from fbchat.models import *
 
-client = Client('<email>', '<password>')
+client = Client("<email>", "<password>")
 
-print('Own id: {}'.format(client.uid))
+print("Own id: {}".format(client.uid))
 
-client.sendMessage('Hi me!', thread_id=client.uid, thread_type=ThreadType.USER)
+client.send(Message(text="Hi me!"), thread_id=client.uid, thread_type=ThreadType.USER)
 
 client.logout()

examples/echobot.py

@@ -4,15 +4,16 @@ from fbchat import log, Client
 
 # Subclass fbchat.Client and override required methods
 class EchoBot(Client):
-    def onMessage(self, author_id, message, thread_id, thread_type, **kwargs):
-        self.markAsDelivered(author_id, thread_id)
-        self.markAsRead(author_id)
+    def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
+        self.markAsDelivered(thread_id, message_object.uid)
+        self.markAsRead(thread_id)
 
-        log.info("Message from {} in {} ({}): {}".format(author_id, thread_id, thread_type.name, message))
+        log.info("{} from {} in {}".format(message_object, thread_id, thread_type.name))
 
         # If you're not the author, echo
         if author_id != self.uid:
-            self.sendMessage(message, thread_id=thread_id, thread_type=thread_type)
+            self.send(message_object, thread_id=thread_id, thread_type=thread_type)
+
 
 client = EchoBot("<email>", "<password>")
 client.listen()

examples/fetch.py

@@ -1,31 +1,32 @@
 # -*- coding: UTF-8 -*-
 
+from itertools import islice
 from fbchat import Client
 from fbchat.models import *
 
-client = Client('<email>', '<password>')
+client = Client("<email>", "<password>")
 
 # Fetches a list of all users you're currently chatting with, as `User` objects
 users = client.fetchAllUsers()
 
-print("users' IDs: {}".format(user.uid for user in users))
-print("users' names: {}".format(user.name for user in users))
+print("users' IDs: {}".format([user.uid for user in users]))
+print("users' names: {}".format([user.name for user in users]))
 
 
 # If we have a user id, we can use `fetchUserInfo` to fetch a `User` object
-user = client.fetchUserInfo('<user id>')['<user id>']
+user = client.fetchUserInfo("<user id>")["<user id>"]
 # We can also query both mutiple users together, which returns list of `User` objects
-users = client.fetchUserInfo('<1st user id>', '<2nd user id>', '<3rd user id>')
+users = client.fetchUserInfo("<1st user id>", "<2nd user id>", "<3rd user id>")
 
 print("user's name: {}".format(user.name))
-print("users' names: {}".format(users[k].name for k in users))
+print("users' names: {}".format([users[k].name for k in users]))
 
 
 # `searchForUsers` searches for the user and gives us a list of the results,
 # and then we just take the first one, aka. the most likely one:
-user = client.searchForUsers('<name of user>')[0]
+user = client.searchForUsers("<name of user>")[0]
 
-print('user ID: {}'.format(user.uid))
+print("user ID: {}".format(user.uid))
 print("user's name: {}".format(user.name))
 print("user's photo: {}".format(user.photo))
 print("Is user client's friend: {}".format(user.is_friend))
@@ -40,7 +41,7 @@ print("Threads: {}".format(threads))
 
 
 # Gets the last 10 messages sent to the thread
-messages = client.fetchThreadMessages(thread_id='<thread id>', limit=10)
+messages = client.fetchThreadMessages(thread_id="<thread id>", limit=10)
 # Since the message come in reversed order, reverse them
 messages.reverse()
 
@@ -50,15 +51,21 @@ for message in messages:
 
 
 # If we have a thread id, we can use `fetchThreadInfo` to fetch a `Thread` object
-thread = client.fetchThreadInfo('<thread id>')['<thread id>']
+thread = client.fetchThreadInfo("<thread id>")["<thread id>"]
 print("thread's name: {}".format(thread.name))
 print("thread's type: {}".format(thread.type))
 
 
 # `searchForThreads` searches works like `searchForUsers`, but gives us a list of threads instead
-thread = client.searchForThreads('<name of thread>')[0]
+thread = client.searchForThreads("<name of thread>")[0]
 print("thread's name: {}".format(thread.name))
 print("thread's type: {}".format(thread.type))
 
 
 # Here should be an example of `getUnread`
+
+
+# Print image url for 20 last images from thread.
+images = client.fetchThreadImages("<thread id>")
+for image in islice(image, 20):
+    print(image.large_preview_url)

examples/interract.py

@@ -5,51 +5,89 @@ from fbchat.models import *
 
 client = Client("<email>", "<password>")
 
-thread_id = '1234567890'
+thread_id = "1234567890"
 thread_type = ThreadType.GROUP
 
 # Will send a message to the thread
-client.sendMessage('<message>', thread_id=thread_id, thread_type=thread_type)
+client.send(Message(text="<message>"), thread_id=thread_id, thread_type=thread_type)
 
 # Will send the default `like` emoji
-client.sendEmoji(emoji=None, size=EmojiSize.LARGE, thread_id=thread_id, thread_type=thread_type)
+client.send(
+    Message(emoji_size=EmojiSize.LARGE), thread_id=thread_id, thread_type=thread_type
+)
 
 # Will send the emoji `👍`
-client.sendEmoji(emoji='👍', size=EmojiSize.LARGE, thread_id=thread_id, thread_type=thread_type)
+client.send(
+    Message(text="👍", emoji_size=EmojiSize.LARGE),
+    thread_id=thread_id,
+    thread_type=thread_type,
+)
+
+# Will send the sticker with ID `767334476626295`
+client.send(
+    Message(sticker=Sticker("767334476626295")),
+    thread_id=thread_id,
+    thread_type=thread_type,
+)
+
+# Will send a message with a mention
+client.send(
+    Message(
+        text="This is a @mention", mentions=[Mention(thread_id, offset=10, length=8)]
+    ),
+    thread_id=thread_id,
+    thread_type=thread_type,
+)
 
 # Will send the image located at `<image path>`
-client.sendLocalImage('<image path>', message='This is a local image', thread_id=thread_id, thread_type=thread_type)
+client.sendLocalImage(
+    "<image path>",
+    message=Message(text="This is a local image"),
+    thread_id=thread_id,
+    thread_type=thread_type,
+)
 
-# Will download the image at the url `<image url>`, and then send it
-client.sendRemoteImage('<image url>', message='This is a remote image', thread_id=thread_id, thread_type=thread_type)
+# Will download the image at the URL `<image url>`, and then send it
+client.sendRemoteImage(
+    "<image url>",
+    message=Message(text="This is a remote image"),
+    thread_id=thread_id,
+    thread_type=thread_type,
+)
 
 
 # Only do these actions if the thread is a group
 if thread_type == ThreadType.GROUP:
     # Will remove the user with ID `<user id>` from the thread
-    client.removeUserFromGroup('<user id>', thread_id=thread_id)
+    client.removeUserFromGroup("<user id>", thread_id=thread_id)
 
     # Will add the user with ID `<user id>` to the thread
-    client.addUsersToGroup('<user id>', thread_id=thread_id)
+    client.addUsersToGroup("<user id>", thread_id=thread_id)
 
     # Will add the users with IDs `<1st user id>`, `<2nd user id>` and `<3th user id>` to the thread
-    client.addUsersToGroup(['<1st user id>', '<2nd user id>', '<3rd user id>'], thread_id=thread_id)
+    client.addUsersToGroup(
+        ["<1st user id>", "<2nd user id>", "<3rd user id>"], thread_id=thread_id
+    )
 
 
 # Will change the nickname of the user `<user_id>` to `<new nickname>`
-client.changeNickname('<new nickname>', '<user id>', thread_id=thread_id, thread_type=thread_type)
+client.changeNickname(
+    "<new nickname>", "<user id>", thread_id=thread_id, thread_type=thread_type
+)
 
 # Will change the title of the thread to `<title>`
-client.changeThreadTitle('<title>', thread_id=thread_id, thread_type=thread_type)
+client.changeThreadTitle("<title>", thread_id=thread_id, thread_type=thread_type)
 
 # Will set the typing status of the thread to `TYPING`
-client.setTypingStatus(TypingStatus.TYPING, thread_id=thread_id, thread_type=thread_type)
+client.setTypingStatus(
+    TypingStatus.TYPING, thread_id=thread_id, thread_type=thread_type
+)
 
 # Will change the thread color to `MESSENGER_BLUE`
 client.changeThreadColor(ThreadColor.MESSENGER_BLUE, thread_id=thread_id)
 
 # Will change the thread emoji to `👍`
-client.changeThreadEmoji('👍', thread_id=thread_id)
+client.changeThreadEmoji("👍", thread_id=thread_id)
 
 # Will react to a message with a 😍 emoji
-client.reactToMessage('<message id>', MessageReaction.LOVE)
+client.reactToMessage("<message id>", MessageReaction.LOVE)

examples/keepbot.py

@@ -4,28 +4,33 @@ from fbchat import log, Client
 from fbchat.models import *
 
 # Change this to your group id
-old_thread_id = '1234567890'
+old_thread_id = "1234567890"
 
 # Change these to match your liking
 old_color = ThreadColor.MESSENGER_BLUE
-old_emoji = '👍'
-old_title = 'Old group chat name'
+old_emoji = "👍"
+old_title = "Old group chat name"
 old_nicknames = {
-    '12345678901': "User nr. 1's nickname",
-    '12345678902': "User nr. 2's nickname",
-    '12345678903': "User nr. 3's nickname",
-    '12345678904': "User nr. 4's nickname"
+    "12345678901": "User nr. 1's nickname",
+    "12345678902": "User nr. 2's nickname",
+    "12345678903": "User nr. 3's nickname",
+    "12345678904": "User nr. 4's nickname",
 }
 
+
 class KeepBot(Client):
     def onColorChange(self, author_id, new_color, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and old_color != new_color:
-            log.info("{} changed the thread color. It will be changed back".format(author_id))
+            log.info(
+                "{} changed the thread color. It will be changed back".format(author_id)
+            )
             self.changeThreadColor(old_color, thread_id=thread_id)
 
     def onEmojiChange(self, author_id, new_emoji, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and new_emoji != old_emoji:
-            log.info("{} changed the thread emoji. It will be changed back".format(author_id))
+            log.info(
+                "{} changed the thread emoji. It will be changed back".format(author_id)
+            )
             self.changeThreadEmoji(old_emoji, thread_id=thread_id)
 
     def onPeopleAdded(self, added_ids, author_id, thread_id, **kwargs):
@@ -36,19 +41,43 @@ class KeepBot(Client):
 
     def onPersonRemoved(self, removed_id, author_id, thread_id, **kwargs):
         # No point in trying to add ourself
-        if old_thread_id == thread_id and removed_id != self.uid and author_id != self.uid:
+        if (
+            old_thread_id == thread_id
+            and removed_id != self.uid
+            and author_id != self.uid
+        ):
             log.info("{} got removed. They will be re-added".format(removed_id))
             self.addUsersToGroup(removed_id, thread_id=thread_id)
 
     def onTitleChange(self, author_id, new_title, thread_id, thread_type, **kwargs):
         if old_thread_id == thread_id and old_title != new_title:
-            log.info("{} changed the thread title. It will be changed back".format(author_id))
-            self.changeThreadTitle(old_title, thread_id=thread_id, thread_type=thread_type)
+            log.info(
+                "{} changed the thread title. It will be changed back".format(author_id)
+            )
+            self.changeThreadTitle(
+                old_title, thread_id=thread_id, thread_type=thread_type
+            )
+
+    def onNicknameChange(
+        self, author_id, changed_for, new_nickname, thread_id, thread_type, **kwargs
+    ):
+        if (
+            old_thread_id == thread_id
+            and changed_for in old_nicknames
+            and old_nicknames[changed_for] != new_nickname
+        ):
+            log.info(
+                "{} changed {}'s' nickname. It will be changed back".format(
+                    author_id, changed_for
+                )
+            )
+            self.changeNickname(
+                old_nicknames[changed_for],
+                changed_for,
+                thread_id=thread_id,
+                thread_type=thread_type,
+            )
 
-    def onNicknameChange(self, author_id, changed_for, new_nickname, thread_id, thread_type, **kwargs):
-        if old_thread_id == thread_id and changed_for in old_nicknames and old_nicknames[changed_for] != new_nickname:
-            log.info("{} changed {}'s' nickname. It will be changed back".format(author_id, changed_for))
-            self.changeNickname(old_nicknames[changed_for], changed_for, thread_id=thread_id, thread_type=thread_type)
 
 client = KeepBot("<email>", "<password>")
 client.listen()

examples/removebot.py

@@ -3,15 +3,23 @@
 from fbchat import log, Client
 from fbchat.models import *
 
+
 class RemoveBot(Client):
-    def onMessage(self, author_id, message, thread_id, thread_type, **kwargs):
+    def onMessage(self, author_id, message_object, thread_id, thread_type, **kwargs):
         # We can only kick people from group chats, so no need to try if it's a user chat
-        if message == 'Remove me!' and thread_type == ThreadType.GROUP:
-            log.info('{} will be removed from {}'.format(author_id, thread_id))
+        if message_object.text == "Remove me!" and thread_type == ThreadType.GROUP:
+            log.info("{} will be removed from {}".format(author_id, thread_id))
             self.removeUserFromGroup(author_id, thread_id=thread_id)
         else:
             # Sends the data to the inherited onMessage, so that we can still see when a message is recieved
-            super(type(self), self).onMessage(author_id=author_id, message=message, thread_id=thread_id, thread_type=thread_type, **kwargs)
+            super(RemoveBot, self).onMessage(
+                author_id=author_id,
+                message_object=message_object,
+                thread_id=thread_id,
+                thread_type=thread_type,
+                **kwargs
+            )
+
 
 client = RemoveBot("<email>", "<password>")
 client.listen()

fbchat/__init__.py

@@ -1,29 +1,25 @@
 # -*- coding: UTF-8 -*-
+"""Facebook Chat (Messenger) for Python
 
+:copyright: (c) 2015 - 2019 by Taehoon Kim
+:license: BSD 3-Clause, see LICENSE for more details.
+"""
 from __future__ import unicode_literals
-from datetime import datetime
-from .client import *
 
+# These imports are far too general, but they're needed for backwards compatbility.
+from .models import *
 
-"""
-    fbchat
-    ~~~~~~
+from ._client import Client
+from ._util import log  # TODO: Remove this (from examples too)
 
-    Facebook Chat (Messenger) for Python
+__title__ = "fbchat"
+__version__ = "1.8.1"
+__description__ = "Facebook Chat (Messenger) for Python"
 
-    :copyright: (c) 2015 by Taehoon Kim.
-    :license: BSD, see LICENSE for more details.
-"""
+__copyright__ = "Copyright 2015 - 2019 by Taehoon Kim"
+__license__ = "BSD 3-Clause"
 
+__author__ = "Taehoon Kim; Moreels Pieter-Jan; Mads Marquart"
+__email__ = "carpedm20@gmail.com"
 
-__copyright__ = 'Copyright 2015 - {} by Taehoon Kim'.format(datetime.now().year)
-__version__ = '1.0.9'
-__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',
-]
+__all__ = ["Client"]

fbchat/_attachment.py

@@ -0,0 +1,86 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from . import _util
+
+
+@attr.s(cmp=False)
+class Attachment(object):
+    """Represents a Facebook attachment."""
+
+    #: The attachment ID
+    uid = attr.ib(None)
+
+
+@attr.s(cmp=False)
+class UnsentMessage(Attachment):
+    """Represents an unsent message attachment."""
+
+
+@attr.s(cmp=False)
+class ShareAttachment(Attachment):
+    """Represents a shared item (e.g. URL) attachment."""
+
+    #: ID of the author of the shared post
+    author = attr.ib(None)
+    #: Target URL
+    url = attr.ib(None)
+    #: Original URL if Facebook redirects the URL
+    original_url = attr.ib(None)
+    #: Title of the attachment
+    title = attr.ib(None)
+    #: Description of the attachment
+    description = attr.ib(None)
+    #: Name of the source
+    source = attr.ib(None)
+    #: URL of the attachment image
+    image_url = attr.ib(None)
+    #: URL of the original image if Facebook uses ``safe_image``
+    original_image_url = attr.ib(None)
+    #: Width of the image
+    image_width = attr.ib(None)
+    #: Height of the image
+    image_height = attr.ib(None)
+    #: List of additional attachments
+    attachments = attr.ib(factory=list, converter=lambda x: [] if x is None else x)
+
+    # Put here for backwards compatibility, so that the init argument order is preserved
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        from . import _file
+
+        url = data.get("url")
+        rtn = cls(
+            uid=data.get("deduplication_key"),
+            author=data["target"]["actors"][0]["id"]
+            if data["target"].get("actors")
+            else None,
+            url=url,
+            original_url=_util.get_url_parameter(url, "u")
+            if "/l.php?u=" in url
+            else url,
+            title=data["title_with_entities"].get("text"),
+            description=data["description"].get("text")
+            if data.get("description")
+            else None,
+            source=data["source"].get("text") if data.get("source") else None,
+            attachments=[
+                _file.graphql_to_subattachment(attachment)
+                for attachment in data.get("subattachments")
+            ],
+        )
+        media = data.get("media")
+        if media and media.get("image"):
+            image = media["image"]
+            rtn.image_url = image.get("uri")
+            rtn.original_image_url = (
+                _util.get_url_parameter(rtn.image_url, "url")
+                if "/safe_image.php" in rtn.image_url
+                else rtn.image_url
+            )
+            rtn.image_width = image.get("width")
+            rtn.image_height = image.get("height")
+        return rtn

fbchat/_core.py

@@ -0,0 +1,26 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import logging
+import aenum
+
+log = logging.getLogger("client")
+
+
+class Enum(aenum.Enum):
+    """Used internally by ``fbchat`` to support enumerations"""
+
+    def __repr__(self):
+        # For documentation:
+        return "{}.{}".format(type(self).__name__, self.name)
+
+    @classmethod
+    def _extend_if_invalid(cls, value):
+        try:
+            return cls(value)
+        except ValueError:
+            log.warning(
+                "Failed parsing {.__name__}({!r}). Extending enum.".format(cls, value)
+            )
+            aenum.extend_enum(cls, "UNKNOWN_{}".format(value).upper(), value)
+            return cls(value)

fbchat/_exception.py

@@ -0,0 +1,60 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+
+class FBchatException(Exception):
+    """Custom exception thrown by ``fbchat``.
+
+    All exceptions in the ``fbchat`` module inherits this.
+    """
+
+
+class FBchatFacebookError(FBchatException):
+    #: The error code that Facebook returned
+    fb_error_code = None
+    #: The error message that Facebook returned (In the user's own language)
+    fb_error_message = None
+    #: The status code that was sent in the HTTP response (e.g. 404) (Usually only set if not successful, aka. not 200)
+    request_status_code = None
+
+    def __init__(
+        self,
+        message,
+        fb_error_code=None,
+        fb_error_message=None,
+        request_status_code=None,
+    ):
+        super(FBchatFacebookError, self).__init__(message)
+        """Thrown by ``fbchat`` when Facebook returns an error"""
+        self.fb_error_code = str(fb_error_code)
+        self.fb_error_message = fb_error_message
+        self.request_status_code = request_status_code
+
+
+class FBchatInvalidParameters(FBchatFacebookError):
+    """Raised by Facebook if:
+
+    - Some function supplied invalid parameters.
+    - Some content is not found.
+    - Some content is no longer available.
+    """
+
+
+class FBchatNotLoggedIn(FBchatFacebookError):
+    """Raised by Facebook if the client has been logged out."""
+
+    fb_error_code = "1357001"
+
+
+class FBchatPleaseRefresh(FBchatFacebookError):
+    """Raised by Facebook if the client has been inactive for too long.
+
+    This error usually happens after 1-2 days of inactivity.
+    """
+
+    fb_error_code = "1357004"
+    fb_error_message = "Please try closing and re-opening your browser window."
+
+
+class FBchatUserError(FBchatException):
+    """Thrown by ``fbchat`` when wrong values are entered."""

fbchat/_file.py

@@ -0,0 +1,301 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._attachment import Attachment
+
+
+@attr.s(cmp=False)
+class FileAttachment(Attachment):
+    """Represents a file that has been sent as a Facebook attachment."""
+
+    #: URL where you can download the file
+    url = attr.ib(None)
+    #: Size of the file in bytes
+    size = attr.ib(None)
+    #: Name of the file
+    name = attr.ib(None)
+    #: Whether Facebook determines that this file may be harmful
+    is_malicious = attr.ib(None)
+
+    # Put here for backwards compatibility, so that the init argument order is preserved
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        return cls(
+            url=data.get("url"),
+            name=data.get("filename"),
+            is_malicious=data.get("is_malicious"),
+            uid=data.get("message_file_fbid"),
+        )
+
+
+@attr.s(cmp=False)
+class AudioAttachment(Attachment):
+    """Represents an audio file that has been sent as a Facebook attachment."""
+
+    #: Name of the file
+    filename = attr.ib(None)
+    #: URL of the audio file
+    url = attr.ib(None)
+    #: Duration of the audio clip in milliseconds
+    duration = attr.ib(None)
+    #: Audio type
+    audio_type = attr.ib(None)
+
+    # Put here for backwards compatibility, so that the init argument order is preserved
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        return cls(
+            filename=data.get("filename"),
+            url=data.get("playable_url"),
+            duration=data.get("playable_duration_in_ms"),
+            audio_type=data.get("audio_type"),
+        )
+
+
+@attr.s(cmp=False, init=False)
+class ImageAttachment(Attachment):
+    """Represents an image that has been sent as a Facebook attachment.
+
+    To retrieve the full image URL, use: `Client.fetchImageUrl`, and pass it the id of
+    the image attachment.
+    """
+
+    #: The extension of the original image (e.g. ``png``)
+    original_extension = attr.ib(None)
+    #: Width of original image
+    width = attr.ib(None, converter=lambda x: None if x is None else int(x))
+    #: Height of original image
+    height = attr.ib(None, converter=lambda x: None if x is None else int(x))
+
+    #: Whether the image is animated
+    is_animated = attr.ib(None)
+
+    #: URL to a thumbnail of the image
+    thumbnail_url = attr.ib(None)
+
+    #: URL to a medium preview of the image
+    preview_url = attr.ib(None)
+    #: Width of the medium preview image
+    preview_width = attr.ib(None)
+    #: Height of the medium preview image
+    preview_height = attr.ib(None)
+
+    #: URL to a large preview of the image
+    large_preview_url = attr.ib(None)
+    #: Width of the large preview image
+    large_preview_width = attr.ib(None)
+    #: Height of the large preview image
+    large_preview_height = attr.ib(None)
+
+    #: URL to an animated preview of the image (e.g. for GIFs)
+    animated_preview_url = attr.ib(None)
+    #: Width of the animated preview image
+    animated_preview_width = attr.ib(None)
+    #: Height of the animated preview image
+    animated_preview_height = attr.ib(None)
+
+    def __init__(
+        self,
+        original_extension=None,
+        width=None,
+        height=None,
+        is_animated=None,
+        thumbnail_url=None,
+        preview=None,
+        large_preview=None,
+        animated_preview=None,
+        **kwargs
+    ):
+        super(ImageAttachment, self).__init__(**kwargs)
+        self.original_extension = original_extension
+        if width is not None:
+            width = int(width)
+        self.width = width
+        if height is not None:
+            height = int(height)
+        self.height = height
+        self.is_animated = is_animated
+        self.thumbnail_url = thumbnail_url
+
+        if preview is None:
+            preview = {}
+        self.preview_url = preview.get("uri")
+        self.preview_width = preview.get("width")
+        self.preview_height = preview.get("height")
+
+        if large_preview is None:
+            large_preview = {}
+        self.large_preview_url = large_preview.get("uri")
+        self.large_preview_width = large_preview.get("width")
+        self.large_preview_height = large_preview.get("height")
+
+        if animated_preview is None:
+            animated_preview = {}
+        self.animated_preview_url = animated_preview.get("uri")
+        self.animated_preview_width = animated_preview.get("width")
+        self.animated_preview_height = animated_preview.get("height")
+
+    @classmethod
+    def _from_graphql(cls, data):
+        return cls(
+            original_extension=data.get("original_extension")
+            or (data["filename"].split("-")[0] if data.get("filename") else None),
+            width=data.get("original_dimensions", {}).get("width"),
+            height=data.get("original_dimensions", {}).get("height"),
+            is_animated=data["__typename"] == "MessageAnimatedImage",
+            thumbnail_url=data.get("thumbnail", {}).get("uri"),
+            preview=data.get("preview") or data.get("preview_image"),
+            large_preview=data.get("large_preview"),
+            animated_preview=data.get("animated_image"),
+            uid=data.get("legacy_attachment_id"),
+        )
+
+    @classmethod
+    def _from_list(cls, data):
+        data = data["node"]
+        return cls(
+            width=data["original_dimensions"].get("x"),
+            height=data["original_dimensions"].get("y"),
+            thumbnail_url=data["image"].get("uri"),
+            large_preview=data["image2"],
+            preview=data["image1"],
+            uid=data["legacy_attachment_id"],
+        )
+
+
+@attr.s(cmp=False, init=False)
+class VideoAttachment(Attachment):
+    """Represents a video that has been sent as a Facebook attachment."""
+
+    #: Size of the original video in bytes
+    size = attr.ib(None)
+    #: Width of original video
+    width = attr.ib(None)
+    #: Height of original video
+    height = attr.ib(None)
+    #: Length of video in milliseconds
+    duration = attr.ib(None)
+    #: URL to very compressed preview video
+    preview_url = attr.ib(None)
+
+    #: URL to a small preview image of the video
+    small_image_url = attr.ib(None)
+    #: Width of the small preview image
+    small_image_width = attr.ib(None)
+    #: Height of the small preview image
+    small_image_height = attr.ib(None)
+
+    #: URL to a medium preview image of the video
+    medium_image_url = attr.ib(None)
+    #: Width of the medium preview image
+    medium_image_width = attr.ib(None)
+    #: Height of the medium preview image
+    medium_image_height = attr.ib(None)
+
+    #: URL to a large preview image of the video
+    large_image_url = attr.ib(None)
+    #: Width of the large preview image
+    large_image_width = attr.ib(None)
+    #: Height of the large preview image
+    large_image_height = attr.ib(None)
+
+    def __init__(
+        self,
+        size=None,
+        width=None,
+        height=None,
+        duration=None,
+        preview_url=None,
+        small_image=None,
+        medium_image=None,
+        large_image=None,
+        **kwargs
+    ):
+        super(VideoAttachment, self).__init__(**kwargs)
+        self.size = size
+        self.width = width
+        self.height = height
+        self.duration = duration
+        self.preview_url = preview_url
+
+        if small_image is None:
+            small_image = {}
+        self.small_image_url = small_image.get("uri")
+        self.small_image_width = small_image.get("width")
+        self.small_image_height = small_image.get("height")
+
+        if medium_image is None:
+            medium_image = {}
+        self.medium_image_url = medium_image.get("uri")
+        self.medium_image_width = medium_image.get("width")
+        self.medium_image_height = medium_image.get("height")
+
+        if large_image is None:
+            large_image = {}
+        self.large_image_url = large_image.get("uri")
+        self.large_image_width = large_image.get("width")
+        self.large_image_height = large_image.get("height")
+
+    @classmethod
+    def _from_graphql(cls, data):
+        return cls(
+            width=data.get("original_dimensions", {}).get("width"),
+            height=data.get("original_dimensions", {}).get("height"),
+            duration=data.get("playable_duration_in_ms"),
+            preview_url=data.get("playable_url"),
+            small_image=data.get("chat_image"),
+            medium_image=data.get("inbox_image"),
+            large_image=data.get("large_image"),
+            uid=data.get("legacy_attachment_id"),
+        )
+
+    @classmethod
+    def _from_subattachment(cls, data):
+        media = data["media"]
+        return cls(
+            duration=media.get("playable_duration_in_ms"),
+            preview_url=media.get("playable_url"),
+            medium_image=media.get("image"),
+            uid=data["target"].get("video_id"),
+        )
+
+    @classmethod
+    def _from_list(cls, data):
+        data = data["node"]
+        return cls(
+            width=data["original_dimensions"].get("x"),
+            height=data["original_dimensions"].get("y"),
+            small_image=data["image"],
+            medium_image=data["image1"],
+            large_image=data["image2"],
+            uid=data["legacy_attachment_id"],
+        )
+
+
+def graphql_to_attachment(data):
+    _type = data["__typename"]
+    if _type in ["MessageImage", "MessageAnimatedImage"]:
+        return ImageAttachment._from_graphql(data)
+    elif _type == "MessageVideo":
+        return VideoAttachment._from_graphql(data)
+    elif _type == "MessageAudio":
+        return AudioAttachment._from_graphql(data)
+    elif _type == "MessageFile":
+        return FileAttachment._from_graphql(data)
+
+    return Attachment(uid=data.get("legacy_attachment_id"))
+
+
+def graphql_to_subattachment(data):
+    target = data.get("target")
+    type_ = target.get("__typename") if target else None
+
+    if type_ == "Video":
+        return VideoAttachment._from_subattachment(data)
+
+    return None

fbchat/_graphql.py

@@ -0,0 +1,237 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import json
+import re
+from . import _util
+from ._exception import FBchatException
+
+# Shameless copy from https://stackoverflow.com/a/8730674
+FLAGS = re.VERBOSE | re.MULTILINE | re.DOTALL
+WHITESPACE = re.compile(r"[ \t\n\r]*", FLAGS)
+
+
+class ConcatJSONDecoder(json.JSONDecoder):
+    def decode(self, s, _w=WHITESPACE.match):
+        s_len = len(s)
+
+        objs = []
+        end = 0
+        while end != s_len:
+            obj, end = self.raw_decode(s, idx=_w(s, end).end())
+            end = _w(s, end).end()
+            objs.append(obj)
+        return objs
+
+
+# End shameless copy
+
+
+def queries_to_json(*queries):
+    """
+    Queries should be a list of GraphQL objects
+    """
+    rtn = {}
+    for i, query in enumerate(queries):
+        rtn["q{}".format(i)] = query
+    return json.dumps(rtn)
+
+
+def response_to_json(content):
+    content = _util.strip_json_cruft(content)  # Usually only needed in some error cases
+    try:
+        j = json.loads(content, cls=ConcatJSONDecoder)
+    except Exception:
+        raise FBchatException("Error while parsing JSON: {}".format(repr(content)))
+
+    rtn = [None] * (len(j))
+    for x in j:
+        if "error_results" in x:
+            del rtn[-1]
+            continue
+        _util.handle_payload_error(x)
+        [(key, value)] = x.items()
+        _util.handle_graphql_errors(value)
+        if "response" in value:
+            rtn[int(key[1:])] = value["response"]
+        else:
+            rtn[int(key[1:])] = value["data"]
+
+    _util.log.debug(rtn)
+
+    return rtn
+
+
+def from_query(query, params):
+    return {"priority": 0, "q": query, "query_params": params}
+
+
+def from_query_id(query_id, params):
+    return {"query_id": query_id, "query_params": params}
+
+
+def from_doc(doc, params):
+    return {"doc": doc, "query_params": params}
+
+
+def from_doc_id(doc_id, params):
+    return {"doc_id": doc_id, "query_params": params}
+
+
+FRAGMENT_USER = """
+QueryFragment User: User {
+    id,
+    name,
+    first_name,
+    last_name,
+    profile_picture.width(<pic_size>).height(<pic_size>) {
+        uri
+    },
+    is_viewer_friend,
+    url,
+    gender,
+    viewer_affinity
+}
+"""
+
+FRAGMENT_GROUP = """
+QueryFragment Group: MessageThread {
+    name,
+    thread_key {
+        thread_fbid
+    },
+    image {
+        uri
+    },
+    is_group_thread,
+    all_participants {
+        nodes {
+            messaging_actor {
+                id
+            }
+        }
+    },
+    customization_info {
+        participant_customizations {
+            participant_id,
+            nickname
+        },
+        outgoing_bubble_color,
+        emoji
+    },
+    thread_admins {
+        id
+    },
+    group_approval_queue {
+        nodes {
+            requester {
+                id
+            }
+        }
+    },
+    approval_mode,
+    joinable_mode {
+        mode,
+        link
+    },
+    event_reminders {
+        nodes {
+            id,
+            lightweight_event_creator {
+                id
+            },
+            time,
+            location_name,
+            event_title,
+            event_reminder_members {
+                edges {
+                    node {
+                        id
+                    },
+                    guest_list_state
+                }
+            }
+        }
+    }
+}
+"""
+
+FRAGMENT_PAGE = """
+QueryFragment Page: Page {
+    id,
+    name,
+    profile_picture.width(32).height(32) {
+        uri
+    },
+    url,
+    category_type,
+    city {
+        name
+    }
+}
+"""
+
+SEARCH_USER = (
+    """
+Query SearchUser(<search> = '', <limit> = 10) {
+    entities_named(<search>) {
+        search_results.of_type(user).first(<limit>) as users {
+            nodes {
+                @User
+            }
+        }
+    }
+}
+"""
+    + FRAGMENT_USER
+)
+
+SEARCH_GROUP = (
+    """
+Query SearchGroup(<search> = '', <limit> = 10, <pic_size> = 32) {
+    viewer() {
+        message_threads.with_thread_name(<search>).last(<limit>) as groups {
+            nodes {
+                @Group
+            }
+        }
+    }
+}
+"""
+    + FRAGMENT_GROUP
+)
+
+SEARCH_PAGE = (
+    """
+Query SearchPage(<search> = '', <limit> = 10) {
+    entities_named(<search>) {
+        search_results.of_type(page).first(<limit>) as pages {
+            nodes {
+                @Page
+            }
+        }
+    }
+}
+"""
+    + FRAGMENT_PAGE
+)
+
+SEARCH_THREAD = (
+    """
+Query SearchThread(<search> = '', <limit> = 10) {
+    entities_named(<search>) {
+        search_results.first(<limit>) as threads {
+            nodes {
+                __typename,
+                @User,
+                @Group,
+                @Page
+            }
+        }
+    }
+}
+"""
+    + FRAGMENT_USER
+    + FRAGMENT_GROUP
+    + FRAGMENT_PAGE
+)

fbchat/_group.py

@@ -0,0 +1,121 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from . import _plan
+from ._thread import ThreadType, Thread
+
+
+@attr.s(cmp=False, init=False)
+class Group(Thread):
+    """Represents a Facebook group. Inherits `Thread`."""
+
+    #: Unique list (set) of the group thread's participant user IDs
+    participants = attr.ib(factory=set, converter=lambda x: set() if x is None else x)
+    #: A dictionary, containing user nicknames mapped to their IDs
+    nicknames = attr.ib(factory=dict, converter=lambda x: {} if x is None else x)
+    #: A :class:`ThreadColor`. The groups's message color
+    color = attr.ib(None)
+    #: The groups's default emoji
+    emoji = attr.ib(None)
+    # Set containing user IDs of thread admins
+    admins = attr.ib(factory=set, converter=lambda x: set() if x is None else x)
+    # True if users need approval to join
+    approval_mode = attr.ib(None)
+    # Set containing user IDs requesting to join
+    approval_requests = attr.ib(
+        factory=set, converter=lambda x: set() if x is None else x
+    )
+    # Link for joining group
+    join_link = attr.ib(None)
+
+    def __init__(
+        self,
+        uid,
+        participants=None,
+        nicknames=None,
+        color=None,
+        emoji=None,
+        admins=None,
+        approval_mode=None,
+        approval_requests=None,
+        join_link=None,
+        privacy_mode=None,
+        **kwargs
+    ):
+        super(Group, self).__init__(ThreadType.GROUP, uid, **kwargs)
+        if participants is None:
+            participants = set()
+        self.participants = participants
+        if nicknames is None:
+            nicknames = []
+        self.nicknames = nicknames
+        self.color = color
+        self.emoji = emoji
+        if admins is None:
+            admins = set()
+        self.admins = admins
+        self.approval_mode = approval_mode
+        if approval_requests is None:
+            approval_requests = set()
+        self.approval_requests = approval_requests
+        self.join_link = join_link
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if data.get("image") is None:
+            data["image"] = {}
+        c_info = cls._parse_customization_info(data)
+        last_message_timestamp = None
+        if "last_message" in data:
+            last_message_timestamp = data["last_message"]["nodes"][0][
+                "timestamp_precise"
+            ]
+        plan = None
+        if data.get("event_reminders") and data["event_reminders"].get("nodes"):
+            plan = _plan.Plan._from_graphql(data["event_reminders"]["nodes"][0])
+
+        return cls(
+            data["thread_key"]["thread_fbid"],
+            participants=set(
+                [
+                    node["messaging_actor"]["id"]
+                    for node in data["all_participants"]["nodes"]
+                ]
+            ),
+            nicknames=c_info.get("nicknames"),
+            color=c_info.get("color"),
+            emoji=c_info.get("emoji"),
+            admins=set([node.get("id") for node in data.get("thread_admins")]),
+            approval_mode=bool(data.get("approval_mode"))
+            if data.get("approval_mode") is not None
+            else None,
+            approval_requests=set(
+                node["requester"]["id"]
+                for node in data["group_approval_queue"]["nodes"]
+            )
+            if data.get("group_approval_queue")
+            else None,
+            join_link=data["joinable_mode"].get("link"),
+            photo=data["image"].get("uri"),
+            name=data.get("name"),
+            message_count=data.get("messages_count"),
+            last_message_timestamp=last_message_timestamp,
+            plan=plan,
+        )
+
+    def _to_send_data(self):
+        return {"thread_fbid": self.uid}
+
+
+@attr.s(cmp=False, init=False)
+class Room(Group):
+    """Deprecated. Use `Group` instead."""
+
+    # True is room is not discoverable
+    privacy_mode = attr.ib(None)
+
+    def __init__(self, uid, privacy_mode=None, **kwargs):
+        super(Room, self).__init__(uid, **kwargs)
+        self.type = ThreadType.ROOM
+        self.privacy_mode = privacy_mode

fbchat/_location.py

@@ -0,0 +1,112 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._attachment import Attachment
+from . import _util
+
+
+@attr.s(cmp=False)
+class LocationAttachment(Attachment):
+    """Represents a user location.
+
+    Latitude and longitude OR address is provided by Facebook.
+    """
+
+    #: Latitude of the location
+    latitude = attr.ib(None)
+    #: Longitude of the location
+    longitude = attr.ib(None)
+    #: URL of image showing the map of the location
+    image_url = attr.ib(None, init=False)
+    #: Width of the image
+    image_width = attr.ib(None, init=False)
+    #: Height of the image
+    image_height = attr.ib(None, init=False)
+    #: URL to Bing maps with the location
+    url = attr.ib(None, init=False)
+    # Address of the location
+    address = attr.ib(None)
+
+    # Put here for backwards compatibility, so that the init argument order is preserved
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        url = data.get("url")
+        address = _util.get_url_parameter(_util.get_url_parameter(url, "u"), "where1")
+        try:
+            latitude, longitude = [float(x) for x in address.split(", ")]
+            address = None
+        except ValueError:
+            latitude, longitude = None, None
+        rtn = cls(
+            uid=int(data["deduplication_key"]),
+            latitude=latitude,
+            longitude=longitude,
+            address=address,
+        )
+        media = data.get("media")
+        if media and media.get("image"):
+            image = media["image"]
+            rtn.image_url = image.get("uri")
+            rtn.image_width = image.get("width")
+            rtn.image_height = image.get("height")
+        rtn.url = url
+        return rtn
+
+
+@attr.s(cmp=False, init=False)
+class LiveLocationAttachment(LocationAttachment):
+    """Represents a live user location."""
+
+    #: Name of the location
+    name = attr.ib(None)
+    #: Timestamp when live location expires
+    expiration_time = attr.ib(None)
+    #: True if live location is expired
+    is_expired = attr.ib(None)
+
+    def __init__(self, name=None, expiration_time=None, is_expired=None, **kwargs):
+        super(LiveLocationAttachment, self).__init__(**kwargs)
+        self.expiration_time = expiration_time
+        self.is_expired = is_expired
+
+    @classmethod
+    def _from_pull(cls, data):
+        return cls(
+            uid=data["id"],
+            latitude=data["coordinate"]["latitude"] / (10 ** 8)
+            if not data.get("stopReason")
+            else None,
+            longitude=data["coordinate"]["longitude"] / (10 ** 8)
+            if not data.get("stopReason")
+            else None,
+            name=data.get("locationTitle"),
+            expiration_time=data["expirationTime"],
+            is_expired=bool(data.get("stopReason")),
+        )
+
+    @classmethod
+    def _from_graphql(cls, data):
+        target = data["target"]
+        rtn = cls(
+            uid=int(target["live_location_id"]),
+            latitude=target["coordinate"]["latitude"]
+            if target.get("coordinate")
+            else None,
+            longitude=target["coordinate"]["longitude"]
+            if target.get("coordinate")
+            else None,
+            name=data["title_with_entities"]["text"],
+            expiration_time=target.get("expiration_time"),
+            is_expired=target.get("is_expired"),
+        )
+        media = data.get("media")
+        if media and media.get("image"):
+            image = media["image"]
+            rtn.image_url = image.get("uri")
+            rtn.image_width = image.get("width")
+            rtn.image_height = image.get("height")
+        rtn.url = data.get("url")
+        return rtn

fbchat/_message.py

@@ -0,0 +1,395 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+import json
+from string import Formatter
+from . import _util, _attachment, _location, _file, _quick_reply, _sticker
+from ._core import Enum
+
+
+class EmojiSize(Enum):
+    """Used to specify the size of a sent emoji."""
+
+    LARGE = "369239383222810"
+    MEDIUM = "369239343222814"
+    SMALL = "369239263222822"
+
+    @classmethod
+    def _from_tags(cls, tags):
+        string_to_emojisize = {
+            "large": cls.LARGE,
+            "medium": cls.MEDIUM,
+            "small": cls.SMALL,
+            "l": cls.LARGE,
+            "m": cls.MEDIUM,
+            "s": cls.SMALL,
+        }
+        for tag in tags or ():
+            data = tag.split(":", maxsplit=1)
+            if len(data) > 1 and data[0] == "hot_emoji_size":
+                return string_to_emojisize.get(data[1])
+        return None
+
+
+class MessageReaction(Enum):
+    """Used to specify a message reaction."""
+
+    HEART = "❤"
+    LOVE = "😍"
+    SMILE = "😆"
+    WOW = "😮"
+    SAD = "😢"
+    ANGRY = "😠"
+    YES = "👍"
+    NO = "👎"
+
+
+@attr.s(cmp=False)
+class Mention(object):
+    """Represents a ``@mention``."""
+
+    #: The thread ID the mention is pointing at
+    thread_id = attr.ib()
+    #: The character where the mention starts
+    offset = attr.ib(0)
+    #: The length of the mention
+    length = attr.ib(10)
+
+
+@attr.s(cmp=False)
+class Message(object):
+    """Represents a Facebook message."""
+
+    #: The actual message
+    text = attr.ib(None)
+    #: A list of :class:`Mention` objects
+    mentions = attr.ib(factory=list, converter=lambda x: [] if x is None else x)
+    #: A :class:`EmojiSize`. Size of a sent emoji
+    emoji_size = attr.ib(None)
+    #: The message ID
+    uid = attr.ib(None, init=False)
+    #: ID of the sender
+    author = attr.ib(None, init=False)
+    #: Timestamp of when the message was sent
+    timestamp = attr.ib(None, init=False)
+    #: Whether the message is read
+    is_read = attr.ib(None, init=False)
+    #: A list of people IDs who read the message, works only with :func:`fbchat.Client.fetchThreadMessages`
+    read_by = attr.ib(factory=list, init=False)
+    #: A dictionary with user's IDs as keys, and their :class:`MessageReaction` as values
+    reactions = attr.ib(factory=dict, init=False)
+    #: A :class:`Sticker`
+    sticker = attr.ib(None)
+    #: A list of attachments
+    attachments = attr.ib(factory=list, converter=lambda x: [] if x is None else x)
+    #: A list of :class:`QuickReply`
+    quick_replies = attr.ib(factory=list, converter=lambda x: [] if x is None else x)
+    #: Whether the message is unsent (deleted for everyone)
+    unsent = attr.ib(False, init=False)
+    #: Message ID you want to reply to
+    reply_to_id = attr.ib(None)
+    #: Replied message
+    replied_to = attr.ib(None, init=False)
+    #: Whether the message was forwarded
+    forwarded = attr.ib(False, init=False)
+
+    @classmethod
+    def formatMentions(cls, text, *args, **kwargs):
+        """Like `str.format`, but takes tuples with a thread id and text instead.
+
+        Return 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
+
+    @staticmethod
+    def _get_forwarded_from_tags(tags):
+        if tags is None:
+            return False
+        return any(map(lambda tag: "forward" in tag or "copy" in tag, tags))
+
+    def _to_send_data(self):
+        data = {}
+
+        if self.text or self.sticker or self.emoji_size:
+            data["action_type"] = "ma-type:user-generated-message"
+
+        if self.text:
+            data["body"] = self.text
+
+        for i, mention in enumerate(self.mentions):
+            data["profile_xmd[{}][id]".format(i)] = mention.thread_id
+            data["profile_xmd[{}][offset]".format(i)] = mention.offset
+            data["profile_xmd[{}][length]".format(i)] = mention.length
+            data["profile_xmd[{}][type]".format(i)] = "p"
+
+        if self.emoji_size:
+            if self.text:
+                data["tags[0]"] = "hot_emoji_size:" + self.emoji_size.name.lower()
+            else:
+                data["sticker_id"] = self.emoji_size.value
+
+        if self.sticker:
+            data["sticker_id"] = self.sticker.uid
+
+        if self.quick_replies:
+            xmd = {"quick_replies": []}
+            for quick_reply in self.quick_replies:
+                # TODO: Move this to `_quick_reply.py`
+                q = dict()
+                q["content_type"] = quick_reply._type
+                q["payload"] = quick_reply.payload
+                q["external_payload"] = quick_reply.external_payload
+                q["data"] = quick_reply.data
+                if quick_reply.is_response:
+                    q["ignore_for_webhook"] = False
+                if isinstance(quick_reply, _quick_reply.QuickReplyText):
+                    q["title"] = quick_reply.title
+                if not isinstance(quick_reply, _quick_reply.QuickReplyLocation):
+                    q["image_url"] = quick_reply.image_url
+                xmd["quick_replies"].append(q)
+            if len(self.quick_replies) == 1 and self.quick_replies[0].is_response:
+                xmd["quick_replies"] = xmd["quick_replies"][0]
+            data["platform_xmd"] = json.dumps(xmd)
+
+        if self.reply_to_id:
+            data["replied_to_message_id"] = self.reply_to_id
+
+        return data
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if data.get("message_sender") is None:
+            data["message_sender"] = {}
+        if data.get("message") is None:
+            data["message"] = {}
+        tags = data.get("tags_list")
+        rtn = cls(
+            text=data["message"].get("text"),
+            mentions=[
+                Mention(
+                    m.get("entity", {}).get("id"),
+                    offset=m.get("offset"),
+                    length=m.get("length"),
+                )
+                for m in data["message"].get("ranges") or ()
+            ],
+            emoji_size=EmojiSize._from_tags(tags),
+            sticker=_sticker.Sticker._from_graphql(data.get("sticker")),
+        )
+        rtn.forwarded = cls._get_forwarded_from_tags(tags)
+        rtn.uid = str(data["message_id"])
+        rtn.author = str(data["message_sender"]["id"])
+        rtn.timestamp = data.get("timestamp_precise")
+        rtn.unsent = False
+        if data.get("unread") is not None:
+            rtn.is_read = not data["unread"]
+        rtn.reactions = {
+            str(r["user"]["id"]): MessageReaction._extend_if_invalid(r["reaction"])
+            for r in data["message_reactions"]
+        }
+        if data.get("blob_attachments") is not None:
+            rtn.attachments = [
+                _file.graphql_to_attachment(attachment)
+                for attachment in data["blob_attachments"]
+            ]
+        if data.get("platform_xmd_encoded"):
+            quick_replies = json.loads(data["platform_xmd_encoded"]).get(
+                "quick_replies"
+            )
+            if isinstance(quick_replies, list):
+                rtn.quick_replies = [
+                    _quick_reply.graphql_to_quick_reply(q) for q in quick_replies
+                ]
+            elif isinstance(quick_replies, dict):
+                rtn.quick_replies = [
+                    _quick_reply.graphql_to_quick_reply(quick_replies, is_response=True)
+                ]
+        if data.get("extensible_attachment") is not None:
+            attachment = graphql_to_extensible_attachment(data["extensible_attachment"])
+            if isinstance(attachment, _attachment.UnsentMessage):
+                rtn.unsent = True
+            elif attachment:
+                rtn.attachments.append(attachment)
+        if data.get("replied_to_message") is not None:
+            rtn.replied_to = cls._from_graphql(data["replied_to_message"]["message"])
+            rtn.reply_to_id = rtn.replied_to.uid
+        return rtn
+
+    @classmethod
+    def _from_reply(cls, data):
+        tags = data["messageMetadata"].get("tags")
+        rtn = cls(
+            text=data.get("body"),
+            mentions=[
+                Mention(m.get("i"), offset=m.get("o"), length=m.get("l"))
+                for m in json.loads(data.get("data", {}).get("prng", "[]"))
+            ],
+            emoji_size=EmojiSize._from_tags(tags),
+        )
+        metadata = data.get("messageMetadata", {})
+        rtn.forwarded = cls._get_forwarded_from_tags(tags)
+        rtn.uid = metadata.get("messageId")
+        rtn.author = str(metadata.get("actorFbId"))
+        rtn.timestamp = metadata.get("timestamp")
+        rtn.unsent = False
+        if data.get("data", {}).get("platform_xmd"):
+            quick_replies = json.loads(data["data"]["platform_xmd"]).get(
+                "quick_replies"
+            )
+            if isinstance(quick_replies, list):
+                rtn.quick_replies = [
+                    _quick_reply.graphql_to_quick_reply(q) for q in quick_replies
+                ]
+            elif isinstance(quick_replies, dict):
+                rtn.quick_replies = [
+                    _quick_reply.graphql_to_quick_reply(quick_replies, is_response=True)
+                ]
+        if data.get("attachments") is not None:
+            for attachment in data["attachments"]:
+                attachment = json.loads(attachment["mercuryJSON"])
+                if attachment.get("blob_attachment"):
+                    rtn.attachments.append(
+                        _file.graphql_to_attachment(attachment["blob_attachment"])
+                    )
+                if attachment.get("extensible_attachment"):
+                    extensible_attachment = graphql_to_extensible_attachment(
+                        attachment["extensible_attachment"]
+                    )
+                    if isinstance(extensible_attachment, _attachment.UnsentMessage):
+                        rtn.unsent = True
+                    else:
+                        rtn.attachments.append(extensible_attachment)
+                if attachment.get("sticker_attachment"):
+                    rtn.sticker = _sticker.Sticker._from_graphql(
+                        attachment["sticker_attachment"]
+                    )
+        return rtn
+
+    @classmethod
+    def _from_pull(cls, data, mid=None, tags=None, author=None, timestamp=None):
+        rtn = cls(text=data.get("body"))
+        rtn.uid = mid
+        rtn.author = author
+        rtn.timestamp = timestamp
+
+        if data.get("data") and data["data"].get("prng"):
+            try:
+                rtn.mentions = [
+                    Mention(
+                        str(mention.get("i")),
+                        offset=mention.get("o"),
+                        length=mention.get("l"),
+                    )
+                    for mention in _util.parse_json(data["data"]["prng"])
+                ]
+            except Exception:
+                _util.log.exception("An exception occured while reading attachments")
+
+        if data.get("attachments"):
+            try:
+                for a in data["attachments"]:
+                    mercury = a["mercury"]
+                    if mercury.get("blob_attachment"):
+                        image_metadata = a.get("imageMetadata", {})
+                        attach_type = mercury["blob_attachment"]["__typename"]
+                        attachment = _file.graphql_to_attachment(
+                            mercury["blob_attachment"]
+                        )
+
+                        if attach_type in [
+                            "MessageFile",
+                            "MessageVideo",
+                            "MessageAudio",
+                        ]:
+                            # TODO: Add more data here for audio files
+                            attachment.size = int(a["fileSize"])
+                        rtn.attachments.append(attachment)
+
+                    elif mercury.get("sticker_attachment"):
+                        rtn.sticker = _sticker.Sticker._from_graphql(
+                            mercury["sticker_attachment"]
+                        )
+
+                    elif mercury.get("extensible_attachment"):
+                        attachment = graphql_to_extensible_attachment(
+                            mercury["extensible_attachment"]
+                        )
+                        if isinstance(attachment, _attachment.UnsentMessage):
+                            rtn.unsent = True
+                        elif attachment:
+                            rtn.attachments.append(attachment)
+
+            except Exception:
+                _util.log.exception(
+                    "An exception occured while reading attachments: {}".format(
+                        data["attachments"]
+                    )
+                )
+
+        rtn.emoji_size = EmojiSize._from_tags(tags)
+        rtn.forwarded = cls._get_forwarded_from_tags(tags)
+        return rtn
+
+
+def graphql_to_extensible_attachment(data):
+    story = data.get("story_attachment")
+    if not story:
+        return None
+
+    target = story.get("target")
+    if not target:
+        return _attachment.UnsentMessage(uid=data.get("legacy_attachment_id"))
+
+    _type = target["__typename"]
+    if _type == "MessageLocation":
+        return _location.LocationAttachment._from_graphql(story)
+    elif _type == "MessageLiveLocation":
+        return _location.LiveLocationAttachment._from_graphql(story)
+    elif _type in ["ExternalUrl", "Story"]:
+        return _attachment.ShareAttachment._from_graphql(story)
+
+    return None

fbchat/_page.py

@@ -0,0 +1,60 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from . import _plan
+from ._thread import ThreadType, Thread
+
+
+@attr.s(cmp=False, init=False)
+class Page(Thread):
+    """Represents a Facebook page. Inherits `Thread`."""
+
+    #: The page's custom URL
+    url = attr.ib(None)
+    #: The name of the page's location city
+    city = attr.ib(None)
+    #: Amount of likes the page has
+    likes = attr.ib(None)
+    #: Some extra information about the page
+    sub_title = attr.ib(None)
+    #: The page's category
+    category = attr.ib(None)
+
+    def __init__(
+        self,
+        uid,
+        url=None,
+        city=None,
+        likes=None,
+        sub_title=None,
+        category=None,
+        **kwargs
+    ):
+        super(Page, self).__init__(ThreadType.PAGE, uid, **kwargs)
+        self.url = url
+        self.city = city
+        self.likes = likes
+        self.sub_title = sub_title
+        self.category = category
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if data.get("profile_picture") is None:
+            data["profile_picture"] = {}
+        if data.get("city") is None:
+            data["city"] = {}
+        plan = None
+        if data.get("event_reminders") and data["event_reminders"].get("nodes"):
+            plan = _plan.Plan._from_graphql(data["event_reminders"]["nodes"][0])
+
+        return cls(
+            data["id"],
+            url=data.get("url"),
+            city=data.get("city").get("name"),
+            category=data.get("category_type"),
+            photo=data["profile_picture"].get("uri"),
+            name=data.get("name"),
+            message_count=data.get("messages_count"),
+            plan=plan,
+        )

fbchat/_plan.py

@@ -0,0 +1,103 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+import json
+from ._core import Enum
+
+
+class GuestStatus(Enum):
+    INVITED = 1
+    GOING = 2
+    DECLINED = 3
+
+
+@attr.s(cmp=False)
+class Plan(object):
+    """Represents a plan."""
+
+    #: ID of the plan
+    uid = attr.ib(None, init=False)
+    #: Plan time (timestamp), only precise down to the minute
+    time = attr.ib(converter=int)
+    #: Plan title
+    title = attr.ib()
+    #: Plan location name
+    location = attr.ib(None, converter=lambda x: x or "")
+    #: Plan location ID
+    location_id = attr.ib(None, converter=lambda x: x or "")
+    #: ID of the plan creator
+    author_id = attr.ib(None, init=False)
+    #: Dictionary of `User` IDs mapped to their `GuestStatus`
+    guests = attr.ib(None, init=False)
+
+    @property
+    def going(self):
+        """List of the `User` IDs who will take part in the plan."""
+        return [
+            id_
+            for id_, status in (self.guests or {}).items()
+            if status is GuestStatus.GOING
+        ]
+
+    @property
+    def declined(self):
+        """List of the `User` IDs who won't take part in the plan."""
+        return [
+            id_
+            for id_, status in (self.guests or {}).items()
+            if status is GuestStatus.DECLINED
+        ]
+
+    @property
+    def invited(self):
+        """List of the `User` IDs who are invited to the plan."""
+        return [
+            id_
+            for id_, status in (self.guests or {}).items()
+            if status is GuestStatus.INVITED
+        ]
+
+    @classmethod
+    def _from_pull(cls, data):
+        rtn = cls(
+            time=data.get("event_time"),
+            title=data.get("event_title"),
+            location=data.get("event_location_name"),
+            location_id=data.get("event_location_id"),
+        )
+        rtn.uid = data.get("event_id")
+        rtn.author_id = data.get("event_creator_id")
+        rtn.guests = {
+            x["node"]["id"]: GuestStatus[x["guest_list_state"]]
+            for x in json.loads(data["guest_state_list"])
+        }
+        return rtn
+
+    @classmethod
+    def _from_fetch(cls, data):
+        rtn = cls(
+            time=data.get("event_time"),
+            title=data.get("title"),
+            location=data.get("location_name"),
+            location_id=str(data["location_id"]) if data.get("location_id") else None,
+        )
+        rtn.uid = data.get("oid")
+        rtn.author_id = data.get("creator_id")
+        rtn.guests = {id_: GuestStatus[s] for id_, s in data["event_members"].items()}
+        return rtn
+
+    @classmethod
+    def _from_graphql(cls, data):
+        rtn = cls(
+            time=data.get("time"),
+            title=data.get("event_title"),
+            location=data.get("location_name"),
+        )
+        rtn.uid = data.get("id")
+        rtn.author_id = data["lightweight_event_creator"].get("id")
+        rtn.guests = {
+            x["node"]["id"]: GuestStatus[x["guest_list_state"]]
+            for x in data["event_reminder_members"]["edges"]
+        }
+        return rtn

fbchat/_poll.py

@@ -0,0 +1,67 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+
+
+@attr.s(cmp=False)
+class Poll(object):
+    """Represents a poll."""
+
+    #: Title of the poll
+    title = attr.ib()
+    #: List of :class:`PollOption`, can be fetched with :func:`fbchat.Client.fetchPollOptions`
+    options = attr.ib()
+    #: Options count
+    options_count = attr.ib(None)
+    #: ID of the poll
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        return cls(
+            uid=int(data["id"]),
+            title=data.get("title") if data.get("title") else data.get("text"),
+            options=[PollOption._from_graphql(m) for m in data.get("options")],
+            options_count=data.get("total_count"),
+        )
+
+
+@attr.s(cmp=False)
+class PollOption(object):
+    """Represents a poll option."""
+
+    #: Text of the poll option
+    text = attr.ib()
+    #: Whether vote when creating or client voted
+    vote = attr.ib(False)
+    #: ID of the users who voted for this poll option
+    voters = attr.ib(None)
+    #: Votes count
+    votes_count = attr.ib(None)
+    #: ID of the poll option
+    uid = attr.ib(None)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if data.get("viewer_has_voted") is None:
+            vote = None
+        elif isinstance(data["viewer_has_voted"], bool):
+            vote = data["viewer_has_voted"]
+        else:
+            vote = data["viewer_has_voted"] == "true"
+        return cls(
+            uid=int(data["id"]),
+            text=data.get("text"),
+            vote=vote,
+            voters=(
+                [m.get("node").get("id") for m in data.get("voters").get("edges")]
+                if isinstance(data.get("voters"), dict)
+                else data.get("voters")
+            ),
+            votes_count=(
+                data.get("voters").get("count")
+                if isinstance(data.get("voters"), dict)
+                else data.get("total_count")
+            ),
+        )

fbchat/_quick_reply.py

@@ -0,0 +1,99 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._attachment import Attachment
+
+
+@attr.s(cmp=False)
+class QuickReply(object):
+    """Represents a quick reply."""
+
+    #: Payload of the quick reply
+    payload = attr.ib(None)
+    #: External payload for responses
+    external_payload = attr.ib(None, init=False)
+    #: Additional data
+    data = attr.ib(None)
+    #: Whether it's a response for a quick reply
+    is_response = attr.ib(False)
+
+
+@attr.s(cmp=False, init=False)
+class QuickReplyText(QuickReply):
+    """Represents a text quick reply."""
+
+    #: Title of the quick reply
+    title = attr.ib(None)
+    #: URL of the quick reply image (optional)
+    image_url = attr.ib(None)
+    #: Type of the quick reply
+    _type = "text"
+
+    def __init__(self, title=None, image_url=None, **kwargs):
+        super(QuickReplyText, self).__init__(**kwargs)
+        self.title = title
+        self.image_url = image_url
+
+
+@attr.s(cmp=False, init=False)
+class QuickReplyLocation(QuickReply):
+    """Represents a location quick reply (Doesn't work on mobile)."""
+
+    #: Type of the quick reply
+    _type = "location"
+
+    def __init__(self, **kwargs):
+        super(QuickReplyLocation, self).__init__(**kwargs)
+        self.is_response = False
+
+
+@attr.s(cmp=False, init=False)
+class QuickReplyPhoneNumber(QuickReply):
+    """Represents a phone number quick reply (Doesn't work on mobile)."""
+
+    #: URL of the quick reply image (optional)
+    image_url = attr.ib(None)
+    #: Type of the quick reply
+    _type = "user_phone_number"
+
+    def __init__(self, image_url=None, **kwargs):
+        super(QuickReplyPhoneNumber, self).__init__(**kwargs)
+        self.image_url = image_url
+
+
+@attr.s(cmp=False, init=False)
+class QuickReplyEmail(QuickReply):
+    """Represents an email quick reply (Doesn't work on mobile)."""
+
+    #: URL of the quick reply image (optional)
+    image_url = attr.ib(None)
+    #: Type of the quick reply
+    _type = "user_email"
+
+    def __init__(self, image_url=None, **kwargs):
+        super(QuickReplyEmail, self).__init__(**kwargs)
+        self.image_url = image_url
+
+
+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

fbchat/_state.py

@@ -0,0 +1,331 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+import bs4
+import re
+import requests
+import random
+
+from . import _graphql, _util, _exception
+
+FB_DTSG_REGEX = re.compile(r'name="fb_dtsg" value="(.*?)"')
+
+
+def get_user_id(session):
+    # TODO: Optimize this `.get_dict()` call!
+    rtn = session.cookies.get_dict().get("c_user")
+    if rtn is None:
+        raise _exception.FBchatException("Could not find user id")
+    return str(rtn)
+
+
+def find_input_fields(html):
+    return bs4.BeautifulSoup(html, "html.parser", parse_only=bs4.SoupStrainer("input"))
+
+
+def session_factory(user_agent=None):
+    session = requests.session()
+    session.headers["Referer"] = "https://www.facebook.com"
+    # TODO: Deprecate setting the user agent manually
+    session.headers["User-Agent"] = user_agent or random.choice(_util.USER_AGENTS)
+    return session
+
+
+def client_id_factory():
+    return hex(int(random.random() * 2 ** 31))[2:]
+
+
+def is_home(url):
+    parts = _util.urlparse(url)
+    # Check the urls `/home.php` and `/`
+    return "home" in parts.path or "/" == parts.path
+
+
+def _2fa_helper(session, code, r):
+    soup = find_input_fields(r.text)
+    data = dict()
+
+    url = "https://m.facebook.com/login/checkpoint/"
+
+    data["approvals_code"] = code
+    data["fb_dtsg"] = soup.find("input", {"name": "fb_dtsg"})["value"]
+    data["nh"] = soup.find("input", {"name": "nh"})["value"]
+    data["submit[Submit Code]"] = "Submit Code"
+    data["codes_submitted"] = 0
+    _util.log.info("Submitting 2FA code.")
+
+    r = session.post(url, data=data)
+
+    if is_home(r.url):
+        return r
+
+    del data["approvals_code"]
+    del data["submit[Submit Code]"]
+    del data["codes_submitted"]
+
+    data["name_action_selected"] = "save_device"
+    data["submit[Continue]"] = "Continue"
+    _util.log.info("Saving browser.")
+    # At this stage, we have dtsg, nh, name_action_selected, submit[Continue]
+    r = session.post(url, data=data)
+
+    if is_home(r.url):
+        return r
+
+    del data["name_action_selected"]
+    _util.log.info("Starting Facebook checkup flow.")
+    # At this stage, we have dtsg, nh, submit[Continue]
+    r = session.post(url, data=data)
+
+    if is_home(r.url):
+        return r
+
+    del data["submit[Continue]"]
+    data["submit[This was me]"] = "This Was Me"
+    _util.log.info("Verifying login attempt.")
+    # At this stage, we have dtsg, nh, submit[This was me]
+    r = session.post(url, data=data)
+
+    if is_home(r.url):
+        return r
+
+    del data["submit[This was me]"]
+    data["submit[Continue]"] = "Continue"
+    data["name_action_selected"] = "save_device"
+    _util.log.info("Saving device again.")
+    # At this stage, we have dtsg, nh, submit[Continue], name_action_selected
+    r = session.post(url, data=data)
+    return r
+
+
+@attr.s(slots=True)  # TODO i Python 3: Add kw_only=True
+class State(object):
+    """Stores and manages state required for most Facebook requests."""
+
+    user_id = attr.ib()
+    _fb_dtsg = attr.ib()
+    _revision = attr.ib()
+    _session = attr.ib(factory=session_factory)
+    _counter = attr.ib(0)
+    _client_id = attr.ib(factory=client_id_factory)
+    _logout_h = attr.ib(None)
+
+    def get_params(self):
+        self._counter += 1  # TODO: Make this operation atomic / thread-safe
+        return {
+            "__a": 1,
+            "__req": _util.str_base(self._counter, 36),
+            "__rev": self._revision,
+            "fb_dtsg": self._fb_dtsg,
+        }
+
+    @classmethod
+    def login(cls, email, password, on_2fa_callback, user_agent=None):
+        session = session_factory(user_agent=user_agent)
+
+        soup = find_input_fields(session.get("https://m.facebook.com/").text)
+        data = dict(
+            (elem["name"], elem["value"])
+            for elem in soup
+            if elem.has_attr("value") and elem.has_attr("name")
+        )
+        data["email"] = email
+        data["pass"] = password
+        data["login"] = "Log In"
+
+        r = session.post("https://m.facebook.com/login.php?login_attempt=1", data=data)
+
+        # Usually, 'Checkpoint' will refer to 2FA
+        if "checkpoint" in r.url and ('id="approvals_code"' in r.text.lower()):
+            code = on_2fa_callback()
+            r = _2fa_helper(session, code, r)
+
+        # Sometimes Facebook tries to show the user a "Save Device" dialog
+        if "save-device" in r.url:
+            r = session.get("https://m.facebook.com/login/save-device/cancel/")
+
+        if is_home(r.url):
+            return cls.from_session(session=session)
+        else:
+            raise _exception.FBchatUserError(
+                "Login failed. Check email/password. "
+                "(Failed on url: {})".format(r.url)
+            )
+
+    def is_logged_in(self):
+        # Send a request to the login url, to see if we're directed to the home page
+        url = "https://m.facebook.com/login.php?login_attempt=1"
+        r = self._session.get(url, allow_redirects=False)
+        return "Location" in r.headers and is_home(r.headers["Location"])
+
+    def logout(self):
+        logout_h = self._logout_h
+        if not logout_h:
+            url = _util.prefix_url("/bluebar/modern_settings_menu/")
+            h_r = self._session.post(url, data={"pmid": "4"})
+            logout_h = re.search(r'name=\\"h\\" value=\\"(.*?)\\"', h_r.text).group(1)
+
+        url = _util.prefix_url("/logout.php")
+        return self._session.get(url, params={"ref": "mb", "h": logout_h}).ok
+
+    @classmethod
+    def from_session(cls, session):
+        # TODO: Automatically set user_id when the cookie changes in the session
+        user_id = get_user_id(session)
+
+        r = session.get(_util.prefix_url("/"))
+
+        soup = find_input_fields(r.text)
+
+        fb_dtsg_element = soup.find("input", {"name": "fb_dtsg"})
+        if fb_dtsg_element:
+            fb_dtsg = fb_dtsg_element["value"]
+        else:
+            # Fall back to searching with a regex
+            fb_dtsg = FB_DTSG_REGEX.search(r.text).group(1)
+
+        revision = int(r.text.split('"client_revision":', 1)[1].split(",", 1)[0])
+
+        logout_h_element = soup.find("input", {"name": "h"})
+        logout_h = logout_h_element["value"] if logout_h_element else None
+
+        return cls(
+            user_id=user_id,
+            fb_dtsg=fb_dtsg,
+            revision=revision,
+            session=session,
+            logout_h=logout_h,
+        )
+
+    def get_cookies(self):
+        return self._session.cookies.get_dict()
+
+    @classmethod
+    def from_cookies(cls, cookies, user_agent=None):
+        session = session_factory(user_agent=user_agent)
+        session.cookies = requests.cookies.merge_cookies(session.cookies, cookies)
+        return cls.from_session(session=session)
+
+    def _do_refresh(self):
+        # TODO: Raise the error instead, and make the user do the refresh manually
+        # It may be a bad idea to do this in an exception handler, if you have a better method, please suggest it!
+        _util.log.warning("Refreshing state and resending request")
+        new = State.from_session(session=self._session)
+        self.user_id = new.user_id
+        self._fb_dtsg = new._fb_dtsg
+        self._revision = new._revision
+        self._counter = new._counter
+        self._logout_h = new._logout_h or self._logout_h
+
+    def _get(self, url, params, error_retries=3):
+        params.update(self.get_params())
+        r = self._session.get(_util.prefix_url(url), params=params)
+        content = _util.check_request(r)
+        j = _util.to_json(content)
+        try:
+            _util.handle_payload_error(j)
+        except _exception.FBchatPleaseRefresh:
+            if error_retries > 0:
+                self._do_refresh()
+                return self._get(url, params, error_retries=error_retries - 1)
+            raise
+        return j
+
+    def _post(self, url, data, files=None, as_graphql=False, error_retries=3):
+        data.update(self.get_params())
+        r = self._session.post(_util.prefix_url(url), data=data, files=files)
+        content = _util.check_request(r)
+        try:
+            if as_graphql:
+                return _graphql.response_to_json(content)
+            else:
+                j = _util.to_json(content)
+                # TODO: Remove this, and move it to _payload_post instead
+                # We can't yet, since errors raised in here need to be caught below
+                _util.handle_payload_error(j)
+                return j
+        except _exception.FBchatPleaseRefresh:
+            if error_retries > 0:
+                self._do_refresh()
+                return self._post(
+                    url,
+                    data,
+                    files=files,
+                    as_graphql=as_graphql,
+                    error_retries=error_retries - 1,
+                )
+            raise
+
+    def _payload_post(self, url, data, files=None):
+        j = self._post(url, data, files=files)
+        try:
+            return j["payload"]
+        except (KeyError, TypeError):
+            raise _exception.FBchatException("Missing payload: {}".format(j))
+
+    def _graphql_requests(self, *queries):
+        data = {
+            "method": "GET",
+            "response_format": "json",
+            "queries": _graphql.queries_to_json(*queries),
+        }
+        return self._post("/api/graphqlbatch/", data, as_graphql=True)
+
+    def _upload(self, files, voice_clip=False):
+        """Upload files to Facebook.
+
+        `files` should be a list of files that requests can upload, see
+        `requests.request <https://docs.python-requests.org/en/master/api/#requests.request>`_.
+
+        Return a list of tuples with a file's ID and mimetype.
+        """
+        file_dict = {"upload_{}".format(i): f for i, f in enumerate(files)}
+
+        data = {"voice_clip": voice_clip}
+
+        j = self._payload_post(
+            "https://upload.facebook.com/ajax/mercury/upload.php", data, files=file_dict
+        )
+
+        if len(j["metadata"]) != len(files):
+            raise _exception.FBchatException(
+                "Some files could not be uploaded: {}, {}".format(j, files)
+            )
+
+        return [
+            (data[_util.mimetype_to_key(data["filetype"])], data["filetype"])
+            for data in j["metadata"]
+        ]
+
+    def _do_send_request(self, data):
+        offline_threading_id = _util.generateOfflineThreadingID()
+        data["client"] = "mercury"
+        data["author"] = "fbid:{}".format(self.user_id)
+        data["timestamp"] = _util.now()
+        data["source"] = "source:chat:web"
+        data["offline_threading_id"] = offline_threading_id
+        data["message_id"] = offline_threading_id
+        data["threading_id"] = _util.generateMessageID(self._client_id)
+        data["ephemeral_ttl_mode:"] = "0"
+        j = self._post("/messaging/send/", data)
+
+        # update JS token if received in response
+        fb_dtsg = _util.get_jsmods_require(j, 2)
+        if fb_dtsg is not None:
+            self._fb_dtsg = fb_dtsg
+
+        try:
+            message_ids = [
+                (action["message_id"], action["thread_fbid"])
+                for action in j["payload"]["actions"]
+                if "message_id" in action
+            ]
+            if len(message_ids) != 1:
+                log.warning("Got multiple message ids' back: {}".format(message_ids))
+            return message_ids[0]
+        except (KeyError, IndexError, TypeError) as e:
+            raise _exception.FBchatException(
+                "Error when sending message: "
+                "No message IDs could be found: {}".format(j)
+            )

fbchat/_sticker.py

@@ -0,0 +1,60 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._attachment import Attachment
+
+
+@attr.s(cmp=False, init=False)
+class Sticker(Attachment):
+    """Represents a Facebook sticker that has been sent to a thread as an attachment."""
+
+    #: The sticker-pack's ID
+    pack = attr.ib(None)
+    #: Whether the sticker is animated
+    is_animated = attr.ib(False)
+
+    # If the sticker is animated, the following should be present
+    #: URL to a medium spritemap
+    medium_sprite_image = attr.ib(None)
+    #: URL to a large spritemap
+    large_sprite_image = attr.ib(None)
+    #: The amount of frames present in the spritemap pr. row
+    frames_per_row = attr.ib(None)
+    #: The amount of frames present in the spritemap pr. column
+    frames_per_col = attr.ib(None)
+    #: The frame rate the spritemap is intended to be played in
+    frame_rate = attr.ib(None)
+
+    #: URL to the sticker's image
+    url = attr.ib(None)
+    #: Width of the sticker
+    width = attr.ib(None)
+    #: Height of the sticker
+    height = attr.ib(None)
+    #: The sticker's label/name
+    label = attr.ib(None)
+
+    def __init__(self, uid=None):
+        super(Sticker, self).__init__(uid=uid)
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if not data:
+            return None
+        self = cls(uid=data["id"])
+        if data.get("pack"):
+            self.pack = data["pack"].get("id")
+        if data.get("sprite_image"):
+            self.is_animated = True
+            self.medium_sprite_image = data["sprite_image"].get("uri")
+            self.large_sprite_image = data["sprite_image_2x"].get("uri")
+            self.frames_per_row = data.get("frames_per_row")
+            self.frames_per_col = data.get("frames_per_column")
+            self.frame_rate = data.get("frame_rate")
+        self.url = data.get("url")
+        self.width = data.get("width")
+        self.height = data.get("height")
+        if data.get("label"):
+            self.label = data["label"]
+        return self

fbchat/_thread.py

@@ -0,0 +1,147 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._core import Enum
+
+
+class ThreadType(Enum):
+    """Used to specify what type of Facebook thread is being used.
+
+    See :ref:`intro_threads` for more info.
+    """
+
+    USER = 1
+    GROUP = 2
+    ROOM = 2
+    PAGE = 3
+
+    def _to_class(self):
+        """Convert this enum value to the corresponding class."""
+        from . import _user, _group, _page
+
+        return {
+            ThreadType.USER: _user.User,
+            ThreadType.GROUP: _group.Group,
+            ThreadType.ROOM: _group.Room,
+            ThreadType.PAGE: _page.Page,
+        }[self]
+
+
+class ThreadLocation(Enum):
+    """Used to specify where a thread is located (inbox, pending, archived, other)."""
+
+    INBOX = "INBOX"
+    PENDING = "PENDING"
+    ARCHIVED = "ARCHIVED"
+    OTHER = "OTHER"
+
+
+class ThreadColor(Enum):
+    """Used to specify a thread colors."""
+
+    MESSENGER_BLUE = "#0084ff"
+    VIKING = "#44bec7"
+    GOLDEN_POPPY = "#ffc300"
+    RADICAL_RED = "#fa3c4c"
+    SHOCKING = "#d696bb"
+    PICTON_BLUE = "#6699cc"
+    FREE_SPEECH_GREEN = "#13cf13"
+    PUMPKIN = "#ff7e29"
+    LIGHT_CORAL = "#e68585"
+    MEDIUM_SLATE_BLUE = "#7646ff"
+    DEEP_SKY_BLUE = "#20cef5"
+    FERN = "#67b868"
+    CAMEO = "#d4a88c"
+    BRILLIANT_ROSE = "#ff5ca1"
+    BILOBA_FLOWER = "#a695c7"
+    TICKLE_ME_PINK = "#ff7ca8"
+    MALACHITE = "#1adb5b"
+    RUBY = "#f01d6a"
+    DARK_TANGERINE = "#ff9c19"
+    BRIGHT_TURQUOISE = "#0edcde"
+
+    @classmethod
+    def _from_graphql(cls, color):
+        if color is None:
+            return None
+        if not color:
+            return cls.MESSENGER_BLUE
+        color = color[2:]  # Strip the alpha value
+        value = "#{}".format(color.lower())
+        return cls._extend_if_invalid(value)
+
+
+@attr.s(cmp=False, init=False)
+class Thread(object):
+    """Represents a Facebook thread."""
+
+    #: The unique identifier of the thread. Can be used a ``thread_id``. See :ref:`intro_threads` for more info
+    uid = attr.ib(converter=str)
+    #: Specifies the type of thread. Can be used a ``thread_type``. See :ref:`intro_threads` for more info
+    type = attr.ib()
+    #: A URL to the thread's picture
+    photo = attr.ib(None)
+    #: The name of the thread
+    name = attr.ib(None)
+    #: Timestamp of last message
+    last_message_timestamp = attr.ib(None)
+    #: Number of messages in the thread
+    message_count = attr.ib(None)
+    #: Set :class:`Plan`
+    plan = attr.ib(None)
+
+    def __init__(
+        self,
+        _type,
+        uid,
+        photo=None,
+        name=None,
+        last_message_timestamp=None,
+        message_count=None,
+        plan=None,
+    ):
+        self.uid = str(uid)
+        self.type = _type
+        self.photo = photo
+        self.name = name
+        self.last_message_timestamp = last_message_timestamp
+        self.message_count = message_count
+        self.plan = plan
+
+    @staticmethod
+    def _parse_customization_info(data):
+        if data is None or data.get("customization_info") is None:
+            return {}
+        info = data["customization_info"]
+
+        rtn = {
+            "emoji": info.get("emoji"),
+            "color": ThreadColor._from_graphql(info.get("outgoing_bubble_color")),
+        }
+        if (
+            data.get("thread_type") == "GROUP"
+            or data.get("is_group_thread")
+            or data.get("thread_key", {}).get("thread_fbid")
+        ):
+            rtn["nicknames"] = {}
+            for k in info.get("participant_customizations", []):
+                rtn["nicknames"][k["participant_id"]] = k.get("nickname")
+        elif info.get("participant_customizations"):
+            uid = data.get("thread_key", {}).get("other_user_id") or data.get("id")
+            pc = info["participant_customizations"]
+            if len(pc) > 0:
+                if pc[0].get("participant_id") == uid:
+                    rtn["nickname"] = pc[0].get("nickname")
+                else:
+                    rtn["own_nickname"] = pc[0].get("nickname")
+            if len(pc) > 1:
+                if pc[1].get("participant_id") == uid:
+                    rtn["nickname"] = pc[1].get("nickname")
+                else:
+                    rtn["own_nickname"] = pc[1].get("nickname")
+        return rtn
+
+    def _to_send_data(self):
+        # TODO: Only implement this in subclasses
+        return {"other_user_fbid": self.uid}

fbchat/_user.py

@@ -0,0 +1,208 @@
+# -*- coding: UTF-8 -*-
+from __future__ import unicode_literals
+
+import attr
+from ._core import Enum
+from . import _plan
+from ._thread import ThreadType, Thread
+
+
+GENDERS = {
+    # For standard requests
+    0: "unknown",
+    1: "female_singular",
+    2: "male_singular",
+    3: "female_singular_guess",
+    4: "male_singular_guess",
+    5: "mixed",
+    6: "neuter_singular",
+    7: "unknown_singular",
+    8: "female_plural",
+    9: "male_plural",
+    10: "neuter_plural",
+    11: "unknown_plural",
+    # For graphql requests
+    "UNKNOWN": "unknown",
+    "FEMALE": "female_singular",
+    "MALE": "male_singular",
+    # '': 'female_singular_guess',
+    # '': 'male_singular_guess',
+    # '': 'mixed',
+    "NEUTER": "neuter_singular",
+    # '': 'unknown_singular',
+    # '': 'female_plural',
+    # '': 'male_plural',
+    # '': 'neuter_plural',
+    # '': 'unknown_plural',
+}
+
+
+class TypingStatus(Enum):
+    """Used to specify whether the user is typing or has stopped typing."""
+
+    STOPPED = 0
+    TYPING = 1
+
+
+@attr.s(cmp=False, init=False)
+class User(Thread):
+    """Represents a Facebook user. Inherits `Thread`."""
+
+    #: The profile URL
+    url = attr.ib(None)
+    #: The users first name
+    first_name = attr.ib(None)
+    #: The users last name
+    last_name = attr.ib(None)
+    #: Whether the user and the client are friends
+    is_friend = attr.ib(None)
+    #: The user's gender
+    gender = attr.ib(None)
+    #: From 0 to 1. How close the client is to the user
+    affinity = attr.ib(None)
+    #: The user's nickname
+    nickname = attr.ib(None)
+    #: The clients nickname, as seen by the user
+    own_nickname = attr.ib(None)
+    #: A :class:`ThreadColor`. The message color
+    color = attr.ib(None)
+    #: The default emoji
+    emoji = attr.ib(None)
+
+    def __init__(
+        self,
+        uid,
+        url=None,
+        first_name=None,
+        last_name=None,
+        is_friend=None,
+        gender=None,
+        affinity=None,
+        nickname=None,
+        own_nickname=None,
+        color=None,
+        emoji=None,
+        **kwargs
+    ):
+        super(User, self).__init__(ThreadType.USER, uid, **kwargs)
+        self.url = url
+        self.first_name = first_name
+        self.last_name = last_name
+        self.is_friend = is_friend
+        self.gender = gender
+        self.affinity = affinity
+        self.nickname = nickname
+        self.own_nickname = own_nickname
+        self.color = color
+        self.emoji = emoji
+
+    @classmethod
+    def _from_graphql(cls, data):
+        if data.get("profile_picture") is None:
+            data["profile_picture"] = {}
+        c_info = cls._parse_customization_info(data)
+        plan = None
+        if data.get("event_reminders") and data["event_reminders"].get("nodes"):
+            plan = _plan.Plan._from_graphql(data["event_reminders"]["nodes"][0])
+
+        return cls(
+            data["id"],
+            url=data.get("url"),
+            first_name=data.get("first_name"),
+            last_name=data.get("last_name"),
+            is_friend=data.get("is_viewer_friend"),
+            gender=GENDERS.get(data.get("gender")),
+            affinity=data.get("affinity"),
+            nickname=c_info.get("nickname"),
+            color=c_info.get("color"),
+            emoji=c_info.get("emoji"),
+            own_nickname=c_info.get("own_nickname"),
+            photo=data["profile_picture"].get("uri"),
+            name=data.get("name"),
+            message_count=data.get("messages_count"),
+            plan=plan,
+        )
+
+    @classmethod
+    def _from_thread_fetch(cls, data):
+        if data.get("big_image_src") is None:
+            data["big_image_src"] = {}
+        c_info = cls._parse_customization_info(data)
+        participants = [
+            node["messaging_actor"] for node in data["all_participants"]["nodes"]
+        ]
+        user = next(
+            p for p in participants if p["id"] == data["thread_key"]["other_user_id"]
+        )
+        last_message_timestamp = None
+        if "last_message" in data:
+            last_message_timestamp = data["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 = None
+        if data.get("event_reminders") and data["event_reminders"].get("nodes"):
+            plan = _plan.Plan._from_graphql(data["event_reminders"]["nodes"][0])
+
+        return cls(
+            user["id"],
+            url=user.get("url"),
+            name=user.get("name"),
+            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"),
+            nickname=c_info.get("nickname"),
+            color=c_info.get("color"),
+            emoji=c_info.get("emoji"),
+            own_nickname=c_info.get("own_nickname"),
+            photo=user["big_image_src"].get("uri"),
+            message_count=data.get("messages_count"),
+            last_message_timestamp=last_message_timestamp,
+            plan=plan,
+        )
+
+    @classmethod
+    def _from_all_fetch(cls, data):
+        return cls(
+            data["id"],
+            first_name=data.get("firstName"),
+            url=data.get("uri"),
+            photo=data.get("thumbSrc"),
+            name=data.get("name"),
+            is_friend=data.get("is_friend"),
+            gender=GENDERS.get(data.get("gender")),
+        )
+
+
+@attr.s(cmp=False)
+class ActiveStatus(object):
+    #: Whether the user is active now
+    active = attr.ib(None)
+    #: Timestamp when the user was last active
+    last_active = attr.ib(None)
+    #: Whether the user is playing Messenger game now
+    in_game = attr.ib(None)
+
+    @classmethod
+    def _from_chatproxy_presence(cls, id_, data):
+        return cls(
+            active=data["p"] in [2, 3] if "p" in data else None,
+            last_active=data.get("lat"),
+            in_game=int(id_) in data.get("gamers", {}),
+        )
+
+    @classmethod
+    def _from_buddylist_overlay(cls, data, in_game=None):
+        return cls(
+            active=data["a"] in [2, 3] if "a" in data else None,
+            last_active=data.get("la"),
+            in_game=None,
+        )

fbchat/_util.py

@@ -0,0 +1,256 @@
+# -*- coding: UTF-8 -*-
+
+from __future__ import unicode_literals
+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 ._exception import (
+    FBchatException,
+    FBchatFacebookError,
+    FBchatInvalidParameters,
+    FBchatNotLoggedIn,
+    FBchatPleaseRefresh,
+)
+
+try:
+    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
+try:
+    input = raw_input
+except NameError:
+    pass
+
+# Log settings
+log = logging.getLogger("client")
+log.setLevel(logging.DEBUG)
+# Creates the console handler
+handler = logging.StreamHandler()
+log.addHandler(handler)
+
+#: Default list of user agents
+USER_AGENTS = [
+    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
+    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/601.1.10 (KHTML, like Gecko) Version/8.0.5 Safari/601.1.10",
+    "Mozilla/5.0 (Windows NT 6.3; WOW64; ; NCT50_AAP285C84A1328) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
+    "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.1 (KHTML, like Gecko) Chrome/22.0.1207.1 Safari/537.1",
+    "Mozilla/5.0 (X11; CrOS i686 2268.111.0) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11",
+    "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1092.0 Safari/536.6",
+]
+
+
+def now():
+    return int(time() * 1000)
+
+
+def strip_json_cruft(text):
+    """Removes `for(;;);` (and other cruft) that preceeds JSON responses."""
+    try:
+        return text[text.index("{") :]
+    except ValueError:
+        raise FBchatException("No JSON object found: {!r}".format(text))
+
+
+def get_decoded_r(r):
+    return get_decoded(r._content)
+
+
+def get_decoded(content):
+    return content.decode("utf-8")
+
+
+def parse_json(content):
+    try:
+        return json.loads(content)
+    except ValueError:
+        raise FBchatFacebookError("Error while parsing JSON: {!r}".format(content))
+
+
+def digitToChar(digit):
+    if digit < 10:
+        return str(digit)
+    return chr(ord("a") + digit - 10)
+
+
+def str_base(number, base):
+    if number < 0:
+        return "-" + str_base(-number, base)
+    (d, m) = divmod(number, base)
+    if d > 0:
+        return str_base(d, base) + digitToChar(m)
+    return digitToChar(m)
+
+
+def generateMessageID(client_id=None):
+    k = now()
+    l = int(random() * 4294967295)
+    return "<{}:{}-{}@mail.projektitan.com>".format(k, l, client_id)
+
+
+def getSignatureID():
+    return hex(int(random() * 2147483648))
+
+
+def generateOfflineThreadingID():
+    ret = now()
+    value = int(random() * 4294967295)
+    string = ("0000000000000000000000" + format(value, "b"))[-22:]
+    msgs = format(ret, "b") + string
+    return str(int(msgs, 2))
+
+
+def handle_payload_error(j):
+    if "error" not in j:
+        return
+    error = j["error"]
+    if j["error"] == 1357001:
+        error_cls = FBchatNotLoggedIn
+    elif j["error"] == 1357004:
+        error_cls = FBchatPleaseRefresh
+    elif j["error"] in (1357031, 1545010, 1545003):
+        error_cls = FBchatInvalidParameters
+    else:
+        error_cls = FBchatFacebookError
+    # TODO: Use j["errorSummary"]
+    # "errorDescription" is in the users own language!
+    raise error_cls(
+        "Error #{} when sending request: {}".format(error, j["errorDescription"]),
+        fb_error_code=error,
+        fb_error_message=j["errorDescription"],
+    )
+
+
+def handle_graphql_errors(j):
+    errors = []
+    if j.get("error"):
+        errors = [j["error"]]
+    if "errors" in j:
+        errors = j["errors"]
+    if errors:
+        error = errors[0]  # TODO: Handle multiple errors
+        # TODO: Use `summary`, `severity` and `description`
+        raise FBchatFacebookError(
+            "GraphQL error #{}: {} / {!r}".format(
+                error.get("code"), error.get("message"), error.get("debug_info")
+            ),
+            fb_error_code=error.get("code"),
+            fb_error_message=error.get("message"),
+        )
+
+
+def check_request(r):
+    check_http_code(r.status_code)
+    content = get_decoded_r(r)
+    check_content(content)
+    return content
+
+
+def check_http_code(code):
+    msg = "Error when sending request: Got {} response.".format(code)
+    if code == 404:
+        raise FBchatFacebookError(
+            msg + " This is either because you specified an invalid URL, or because"
+            " you provided an invalid id (Facebook usually requires integer ids).",
+            request_status_code=code,
+        )
+    if 400 <= code < 600:
+        raise FBchatFacebookError(msg, request_status_code=code)
+
+
+def check_content(content, as_json=True):
+    if content is None or len(content) == 0:
+        raise FBchatFacebookError("Error when sending request: Got empty response")
+
+
+def to_json(content):
+    content = strip_json_cruft(content)
+    j = parse_json(content)
+    log.debug(j)
+    return j
+
+
+def get_jsmods_require(j, index):
+    if j.get("jsmods") and j["jsmods"].get("require"):
+        try:
+            return j["jsmods"]["require"][0][index][0]
+        except (KeyError, IndexError) as e:
+            log.warning(
+                "Error when getting jsmods_require: "
+                "{}. Facebook might have changed protocol".format(j)
+            )
+    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).split("?")[0].split("#")[0],
+                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()
+
+
+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]
+
+
+def prefix_url(url):
+    if url.startswith("/"):
+        return "https://www.facebook.com" + url
+    return url

fbchat/graphql.py

@@ -1,283 +0,0 @@
-# -*- coding: UTF-8 -*-
-
-from __future__ import unicode_literals
-import json
-import re
-from .models import *
-from .utils import *
-
-# Shameless copy from https://stackoverflow.com/a/8730674
-FLAGS = re.VERBOSE | re.MULTILINE | re.DOTALL
-WHITESPACE = re.compile(r'[ \t\n\r]*', FLAGS)
-
-class ConcatJSONDecoder(json.JSONDecoder):
-    def decode(self, s, _w=WHITESPACE.match):
-        s_len = len(s)
-
-        objs = []
-        end = 0
-        while end != s_len:
-            obj, end = self.raw_decode(s, idx=_w(s, end).end())
-            end = _w(s, end).end()
-            objs.append(obj)
-        return objs
-# End shameless copy
-
-def graphql_color_to_enum(color):
-    if color is None:
-        return None
-    if len(color) == 0:
-        return ThreadColor.MESSENGER_BLUE
-    try:
-        return ThreadColor('#{}'.format(color[2:].lower()))
-    except ValueError:
-        raise Exception('Could not get ThreadColor from color: {}'.format(color))
-
-def get_customization_info(thread):
-    if thread is None or thread.get('customization_info') is None:
-        return {}
-    info = thread['customization_info']
-
-    rtn = {
-        'emoji': info.get('emoji'),
-        'color': graphql_color_to_enum(info.get('outgoing_bubble_color'))
-    }
-    if thread.get('thread_type') == 'GROUP' or thread.get('is_group_thread') or thread.get('thread_key', {}).get('thread_fbid'):
-        rtn['nicknames'] = {}
-        for k in info['participant_customizations']:
-            rtn['nicknames'][k['participant_id']] = k.get('nickname')
-    elif info.get('participant_customizations'):
-        _id = thread.get('thread_key', {}).get('other_user_id') or thread.get('id')
-        if info['participant_customizations'][0]['participant_id'] == _id:
-            rtn['nickname'] = info['participant_customizations'][0]
-            rtn['own_nickname'] = info['participant_customizations'][1]
-        elif info['participant_customizations'][1]['participant_id'] == _id:
-            rtn['nickname'] = info['participant_customizations'][1]
-            rtn['own_nickname'] = info['participant_customizations'][0]
-        else:
-            raise Exception('No participant matching the user {} found: {}'.format(_id, info['participant_customizations']))
-    return rtn
-
-def graphql_to_message(message):
-    if message.get('message_sender') is None:
-        message['message_sender'] = {}
-    if message.get('message') is None:
-        message['message'] = {}
-    is_read = None
-    if message.get('unread') is not None:
-        is_read = not message['unread']
-    return Message(
-        message.get('message_id'),
-        author=message.get('message_sender').get('id'),
-        timestamp=message.get('timestamp_precise'),
-        is_read=is_read,
-        reactions=message.get('message_reactions'),
-        text=message.get('message').get('text'),
-        mentions=[Mention(m.get('entity', {}).get('id'), offset=m.get('offset'), length=m.get('length')) for m in message.get('message').get('ranges', [])],
-        sticker=message.get('sticker'),
-        attachments=message.get('blob_attachments')
-    )
-
-def graphql_to_user(user):
-    if user.get('profile_picture') is None:
-        user['profile_picture'] = {}
-    c_info = get_customization_info(user)
-    return User(
-        user['id'],
-        url=user.get('url'),
-        first_name=user.get('first_name'),
-        last_name=user.get('last_name'),
-        is_friend=user.get('is_viewer_friend'),
-        gender=GENDERS[user.get('gender')],
-        affinity=user.get('affinity'),
-        nickname=c_info.get('nickname'),
-        color=c_info.get('color'),
-        emoji=c_info.get('emoji'),
-        own_nickname=c_info.get('own_nickname'),
-        photo=user['profile_picture'].get('uri'),
-        name=user.get('name')
-    )
-
-def graphql_to_group(group):
-    if group.get('image') is None:
-        group['image'] = {}
-    c_info = get_customization_info(group)
-    return Group(
-        group['thread_key']['thread_fbid'],
-        participants=set([node['messaging_actor']['id'] for node in group['all_participants']['nodes']]),
-        nicknames=c_info.get('nicknames'),
-        color=c_info.get('color'),
-        emoji=c_info.get('emoji'),
-        photo=group['image'].get('uri'),
-        name=group.get('name')
-    )
-
-def graphql_to_page(page):
-    if page.get('profile_picture') is None:
-        page['profile_picture'] = {}
-    if page.get('city') is None:
-        page['city'] = {}
-    return Page(
-        page['id'],
-        url=page.get('url'),
-        city=page.get('city').get('name'),
-        category=page.get('category_type'),
-        photo=page['profile_picture'].get('uri'),
-        name=page.get('name')
-    )
-
-def graphql_queries_to_json(*queries):
-    """
-    Queries should be a list of GraphQL objects
-    """
-    rtn = {}
-    for i, query in enumerate(queries):
-        rtn['q{}'.format(i)] = query.value
-    return json.dumps(rtn)
-
-def graphql_response_to_json(content):
-    j = json.loads(content, cls=ConcatJSONDecoder)
-
-    rtn = [None]*(len(j))
-    for x in j:
-        if 'error_results' in x:
-            del rtn[-1]
-            continue
-        check_json(x)
-        [(key, value)] = x.items()
-        check_json(value)
-        if 'response' in value:
-            rtn[int(key[1:])] = value['response']
-        else:
-            rtn[int(key[1:])] = value['data']
-
-    log.debug(rtn)
-
-    return rtn
-
-class GraphQL(object):
-    def __init__(self, query=None, doc_id=None, params={}):
-        if query is not None:
-            self.value = {
-                'priority': 0,
-                'q': query,
-                'query_params': params
-            }
-        elif doc_id is not None:
-            self.value = {
-                'doc_id': doc_id,
-                'query_params': params
-            }
-        else:
-            raise Exception('A query or doc_id must be specified')
-
-
-    FRAGMENT_USER = """
-    QueryFragment User: User {
-        id,
-        name,
-        first_name,
-        last_name,
-        profile_picture.width(<pic_size>).height(<pic_size>) {
-            uri
-        },
-        is_viewer_friend,
-        url,
-        gender,
-        viewer_affinity
-    }
-    """
-
-    FRAGMENT_GROUP = """
-    QueryFragment Group: MessageThread {
-        name,
-        thread_key {
-            thread_fbid
-        },
-        image {
-            uri
-        },
-        is_group_thread,
-        all_participants {
-            nodes {
-                messaging_actor {
-                    id
-                }
-            }
-        },
-        customization_info {
-            participant_customizations {
-                participant_id,
-                nickname
-            },
-            outgoing_bubble_color,
-            emoji
-        }
-    }
-    """
-
-    FRAGMENT_PAGE = """
-    QueryFragment Page: Page {
-        id,
-        name,
-        profile_picture.width(32).height(32) {
-            uri
-        },
-        url,
-        category_type,
-        city {
-            name
-        }
-    }
-    """
-
-    SEARCH_USER = """
-    Query SearchUser(<search> = '', <limit> = 1) {
-        entities_named(<search>) {
-            search_results.of_type(user).first(<limit>) as users {
-                nodes {
-                    @User
-                }
-            }
-        }
-    }
-    """ + FRAGMENT_USER
-
-    SEARCH_GROUP = """
-    Query SearchGroup(<search> = '', <limit> = 1, <pic_size> = 32) {
-        viewer() {
-            message_threads.with_thread_name(<search>).last(<limit>) as groups {
-                nodes {
-                    @Group
-                }
-            }
-        }
-    }
-    """ + FRAGMENT_GROUP
-
-    SEARCH_PAGE = """
-    Query SearchPage(<search> = '', <limit> = 1) {
-        entities_named(<search>) {
-            search_results.of_type(page).first(<limit>) as pages {
-                nodes {
-                    @Page
-                }
-            }
-        }
-    }
-    """ + FRAGMENT_PAGE
-
-    SEARCH_THREAD = """
-    Query SearchThread(<search> = '', <limit> = 1) {
-        entities_named(<search>) {
-            search_results.first(<limit>) as threads {
-                nodes {
-                    __typename,
-                    @User,
-                    @Group,
-                    @Page
-                }
-            }
-        }
-    }
-    """ + FRAGMENT_USER + FRAGMENT_GROUP + FRAGMENT_PAGE

fbchat/models.py

@@ -1,224 +1,29 @@
 # -*- coding: UTF-8 -*-
+"""This file is here to maintain backwards compatability, and to re-export our models
+into the global module (see `__init__.py`).
 
+A common pattern was to use `from fbchat.models import *`, hence we need this while
+transitioning to a better code structure.
+"""
 from __future__ import unicode_literals
-import enum
 
-
-class Thread(object):
-    #: The unique identifier of the thread. Can be used a `thread_id`. See :ref:`intro_threads` for more info
-    uid = str
-    #: Specifies the type of thread. Can be used a `thread_type`. See :ref:`intro_threads` for more info
-    type = None
-    #: The thread's picture
-    photo = str
-    #: The name of the thread
-    name = str
-
-    def __init__(self, _type, uid, photo=None, name=None):
-        """Represents a Facebook thread"""
-        self.uid = str(uid)
-        self.type = _type
-        self.photo = photo
-        self.name = name
-
-    def __repr__(self):
-        return self.__unicode__()
-
-    def __unicode__(self):
-        return '<{} {} ({})>'.format(self.type.name, self.name, self.uid)
-
-
-class User(Thread):
-    #: The profile url
-    url = str
-    #: The users first name
-    first_name = str
-    #: The users last name
-    last_name = str
-    #: Whether the user and the client are friends
-    is_friend = bool
-    #: The user's gender
-    gender = str
-    #: From 0 to 1. How close the client is to the user
-    affinity = float
-    #: The user's nickname
-    nickname = str
-    #: The clients nickname, as seen by the user
-    own_nickname = str
-    #: A :class:`ThreadColor`. The message color
-    color = None
-    #: The default emoji
-    emoji = str
-
-    def __init__(self, uid, url=None, first_name=None, last_name=None, is_friend=None, gender=None, affinity=None, nickname=None, own_nickname=None, color=None, emoji=None, **kwargs):
-        """Represents a Facebook user. Inherits `Thread`"""
-        super(User, self).__init__(ThreadType.USER, uid, **kwargs)
-        self.url = url
-        self.first_name = first_name
-        self.last_name = last_name
-        self.is_friend = is_friend
-        self.gender = gender
-        self.affinity = affinity
-        self.nickname = nickname
-        self.own_nickname = own_nickname
-        self.color = color
-        self.emoji = emoji
-
-
-class Group(Thread):
-    #: Unique list (set) of the group thread's participant user IDs
-    participants = set
-    #: Dict, containing user nicknames mapped to their IDs
-    nicknames = dict
-    #: A :class:`ThreadColor`. The groups's message color
-    color = None
-    #: The groups's default emoji
-    emoji = str
-
-    def __init__(self, uid, participants=set(), nicknames=[], color=None, emoji=None, **kwargs):
-        """Represents a Facebook group. Inherits `Thread`"""
-        super(Group, self).__init__(ThreadType.GROUP, uid, **kwargs)
-        self.participants = participants
-        self.nicknames = nicknames
-        self.color = color
-        self.emoji = emoji
-
-
-class Page(Thread):
-    #: The page's custom url
-    url = str
-    #: The name of the page's location city
-    city = str
-    #: Amount of likes the page has
-    likes = int
-    #: Some extra information about the page
-    sub_title = str
-    #: The page's category
-    category = str
-
-    def __init__(self, uid, url=None, city=None, likes=None, sub_title=None, category=None, **kwargs):
-        """Represents a Facebook page. Inherits `Thread`"""
-        super(Page, self).__init__(ThreadType.PAGE, uid, **kwargs)
-        self.url = url
-        self.city = city
-        self.likes = likes
-        self.sub_title = sub_title
-        self.category = category
-
-
-class Message(object):
-    #: The message ID
-    uid = str
-    #: ID of the sender
-    author = int
-    #: Timestamp of when the message was sent
-    timestamp = str
-    #: Whether the message is read
-    is_read = bool
-    #: A list of message reactions
-    reactions = list
-    #: The actual message
-    text = str
-    #: A list of :class:`Mention` objects
-    mentions = list
-    #: An ID of a sent sticker
-    sticker = str
-    #: A list of attachments
-    attachments = list
-
-    def __init__(self, uid, author=None, timestamp=None, is_read=None, reactions=[], text=None, mentions=[], sticker=None, attachments=[]):
-        """Represents a Facebook message"""
-        self.uid = uid
-        self.author = author
-        self.timestamp = timestamp
-        self.is_read = is_read
-        self.reactions = reactions
-        self.text = text
-        self.mentions = mentions
-        self.sticker = sticker
-        self.attachments = attachments
-
-
-class Mention(object):
-    #: The user ID the mention is pointing at
-    user_id = str
-    #: The character where the mention starts
-    offset = int
-    #: The length of the mention
-    length = int
-
-    def __init__(self, user_id, offset=0, length=10):
-        """Represents a @mention"""
-        self.user_id = user_id
-        self.offset = offset
-        self.length = length
-
-class Enum(enum.Enum):
-    """Used internally by fbchat to support enumerations"""
-    def __repr__(self):
-        # For documentation:
-        return '{}.{}'.format(type(self).__name__, self.name)
-
-class ThreadType(Enum):
-    """Used to specify what type of Facebook thread is being used. See :ref:`intro_threads` for more info"""
-    USER = 1
-    GROUP = 2
-    PAGE = 3
-
-class TypingStatus(Enum):
-    """Used to specify whether the user is typing or has stopped typing"""
-    STOPPED = 0
-    TYPING = 1
-
-class EmojiSize(Enum):
-    """Used to specify the size of a sent emoji"""
-    LARGE = '369239383222810'
-    MEDIUM = '369239343222814'
-    SMALL = '369239263222822'
-
-class ThreadColor(Enum):
-    """Used to specify a thread colors"""
-    MESSENGER_BLUE = ''
-    VIKING = '#44bec7'
-    GOLDEN_POPPY = '#ffc300'
-    RADICAL_RED = '#fa3c4c'
-    SHOCKING = '#d696bb'
-    PICTON_BLUE = '#6699cc'
-    FREE_SPEECH_GREEN = '#13cf13'
-    PUMPKIN = '#ff7e29'
-    LIGHT_CORAL = '#e68585'
-    MEDIUM_SLATE_BLUE = '#7646ff'
-    DEEP_SKY_BLUE = '#20cef5'
-    FERN = '#67b868'
-    CAMEO = '#d4a88c'
-    BRILLIANT_ROSE = '#ff5ca1'
-    BILOBA_FLOWER = '#a695c7'
-
-class MessageReaction(Enum):
-    """Used to specify a message reaction"""
-    LOVE = '😍'
-    SMILE = '😆'
-    WOW = '😮'
-    SAD = '😢'
-    ANGRY = '😠'
-    YES = '👍'
-    NO = '👎'
-
-LIKES = {
-    'large': EmojiSize.LARGE,
-    'medium': EmojiSize.MEDIUM,
-    'small': EmojiSize.SMALL,
-    'l': EmojiSize.LARGE,
-    'm': EmojiSize.MEDIUM,
-    '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')
-}
+from ._core import Enum
+from ._exception import FBchatException, FBchatFacebookError, FBchatUserError
+from ._thread import ThreadType, ThreadLocation, ThreadColor, Thread
+from ._user import TypingStatus, User, ActiveStatus
+from ._group import Group, Room
+from ._page import Page
+from ._message import EmojiSize, MessageReaction, Mention, Message
+from ._attachment import Attachment, UnsentMessage, ShareAttachment
+from ._sticker import Sticker
+from ._location import LocationAttachment, LiveLocationAttachment
+from ._file import FileAttachment, AudioAttachment, ImageAttachment, VideoAttachment
+from ._quick_reply import (
+    QuickReply,
+    QuickReplyText,
+    QuickReplyLocation,
+    QuickReplyPhoneNumber,
+    QuickReplyEmail,
+)
+from ._poll import Poll, PollOption
+from ._plan import GuestStatus, Plan

fbchat/utils.py

@@ -1,173 +0,0 @@
-# -*- coding: UTF-8 -*-
-
-from __future__ import unicode_literals
-import re
-import json
-from time import time
-from random import random
-import warnings
-import logging
-from .models import *
-
-# Python 2's `input` executes the input, whereas `raw_input` just returns the input
-try:
-    input = raw_input
-except NameError:
-    pass
-
-# Log settings
-log = logging.getLogger("client")
-log.setLevel(logging.DEBUG)
-# Creates the console handler
-handler = logging.StreamHandler()
-log.addHandler(handler)
-
-#: Default list of user agents
-USER_AGENTS = [
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
-    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/601.1.10 (KHTML, like Gecko) Version/8.0.5 Safari/601.1.10",
-    "Mozilla/5.0 (Windows NT 6.3; WOW64; ; NCT50_AAP285C84A1328) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36",
-    "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.1 (KHTML, like Gecko) Chrome/22.0.1207.1 Safari/537.1",
-    "Mozilla/5.0 (X11; CrOS i686 2268.111.0) AppleWebKit/536.11 (KHTML, like Gecko) Chrome/20.0.1132.57 Safari/536.11",
-    "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/536.6 (KHTML, like Gecko) Chrome/20.0.1092.0 Safari/536.6"
-]
-
-GENDERS = {
-    # For standard requests
-    0: 'unknown',
-    1: 'female_singular',
-    2: 'male_singular',
-    3: 'female_singular_guess',
-    4: 'male_singular_guess',
-    5: 'mixed',
-    6: 'neuter_singular',
-    7: 'unknown_singular',
-    8: 'female_plural',
-    9: 'male_plural',
-    10: 'neuter_plural',
-    11: 'unknown_plural',
-
-    # For graphql requests
-    #'': 'unknown',
-    'FEMALE': 'female_singular',
-    'MALE': 'male_singular',
-    #'': 'female_singular_guess',
-    #'': 'male_singular_guess',
-    #'': 'mixed',
-    #'': 'neuter_singular',
-    #'': 'unknown_singular',
-    #'': 'female_plural',
-    #'': 'male_plural',
-    #'': 'neuter_plural',
-    #'': 'unknown_plural',
-    None: None
-}
-
-class ReqUrl(object):
-    """A class containing all urls used by `fbchat`"""
-    SEARCH = "https://www.facebook.com/ajax/typeahead/search.php"
-    LOGIN = "https://m.facebook.com/login.php?login_attempt=1"
-    SEND = "https://www.facebook.com/messaging/send/"
-    THREAD_SYNC = "https://www.facebook.com/ajax/mercury/thread_sync.php"
-    THREADS = "https://www.facebook.com/ajax/mercury/threadlist_info.php"
-    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"
-    MARK_SEEN = "https://www.facebook.com/ajax/mercury/mark_seen.php"
-    BASE = "https://www.facebook.com"
-    MOBILE = "https://m.facebook.com/"
-    STICKY = "https://0-edge-chat.facebook.com/pull"
-    PING = "https://0-edge-chat.facebook.com/active_ping"
-    UPLOAD = "https://upload.facebook.com/ajax/mercury/upload.php"
-    INFO = "https://www.facebook.com/chat/user_info/"
-    CONNECT = "https://www.facebook.com/ajax/add_friend/action.php?dpr=1"
-    REMOVE_USER = "https://www.facebook.com/chat/remove_participants/"
-    LOGOUT = "https://www.facebook.com/logout.php"
-    ALL_USERS = "https://www.facebook.com/chat/user_info_all"
-    SAVE_DEVICE = "https://m.facebook.com/login/save-device/cancel/"
-    CHECKPOINT = "https://m.facebook.com/login/checkpoint/"
-    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"
-    MESSAGE_REACTION = "https://www.facebook.com/webgraphql/mutation"
-    TYPING = "https://www.facebook.com/ajax/messaging/typ.php"
-    GRAPHQL = "https://www.facebook.com/api/graphqlbatch/"
-
-
-facebookEncoding = 'UTF-8'
-
-def now():
-    return int(time()*1000)
-
-def strip_to_json(text):
-    try:
-        return text[text.index('{'):]
-    except ValueError:
-        raise Exception('No JSON object found: {}, {}'.format(repr(text), text.index('{')))
-
-def get_decoded_r(r):
-    return get_decoded(r._content)
-
-def get_decoded(content):
-    return content.decode(facebookEncoding)
-
-def get_json(r):
-    return json.loads(strip_to_json(get_decoded_r(r)))
-
-def digitToChar(digit):
-    if digit < 10:
-        return str(digit)
-    return chr(ord('a') + digit - 10)
-
-def str_base(number, base):
-    if number < 0:
-        return '-' + str_base(-number, base)
-    (d, m) = divmod(number, base)
-    if d > 0:
-        return str_base(d, base) + digitToChar(m)
-    return digitToChar(m)
-
-def generateMessageID(client_id=None):
-    k = now()
-    l = int(random() * 4294967295)
-    return "<{}:{}-{}@mail.projektitan.com>".format(k, l, client_id)
-
-def getSignatureID():
-    return hex(int(random() * 2147483648))
-
-def generateOfflineThreadingID():
-    ret = now()
-    value = int(random() * 4294967295)
-    string = ("0000000000000000000000" + format(value, 'b'))[-22:]
-    msgs = format(ret, 'b') + string
-    return str(int(msgs, 2))
-
-def check_json(j):
-    if 'error' in j and j['error'] is not None:
-        if 'errorDescription' in j:
-            # 'errorDescription' is in the users own language!
-            raise Exception('Error #{} when sending request: {}'.format(j['error'], j['errorDescription']))
-        elif 'debug_info' in j['error']:
-            raise Exception('Error #{} when sending request: {}'.format(j['error']['code'], repr(j['error']['debug_info'])))
-        else:
-            raise Exception('Error {} when sending request'.format(j['error']))
-
-def checkRequest(r, do_json_check=True):
-    if not r.ok:
-        raise Exception('Error when sending request: Got {} response'.format(r.status_code))
-
-    content = get_decoded_r(r)
-
-    if content is None or len(content) == 0:
-        raise Exception('Error when sending request: Got empty response')
-
-    if do_json_check:
-        content = strip_to_json(content)
-        try:
-            j = json.loads(content)
-        except Exception as e:
-            raise Exception('Error while parsing JSON: {}'.format(repr(content)), e)
-        check_json(j)
-        return j
-    else:
-        return content

pyproject.toml

@@ -0,0 +1,67 @@
+[tool.black]
+line-length = 88
+
+[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~=2.0",
+    "attrs>=18.2",
+    "requests~=2.19",
+    "beautifulsoup4~=4.0",
+]
+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~=1.0",
+]
+docs = [
+    "sphinx~=2.0",
+    "sphinxcontrib-spelling~=4.0"
+]
+lint = [
+    "black",
+]
+tools = [
+    # Fork of bumpversion, see https://github.com/c4urself/bump2version
+    "bump2version~=0.5.0",
+]

pytest.ini

@@ -0,0 +1,6 @@
+[pytest]
+xfail_strict=true
+markers =
+    offline: Offline tests, aka. tests that can be executed without the need of a client
+    expensive: Expensive tests, which should be executed sparingly
+addopts = -m "not expensive"

requirements.txt

@@ -1,3 +0,0 @@
-requests
-lxml
-beautifulsoup4

setup.py

@@ -1,81 +0,0 @@
-#!/usr/bin/env python
-
-
-"""
-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()
-
-try:
-    requirements = [line.rstrip('\n') for line in open(os.path.join('fbchat.egg-info', 'requires.txt'))]
-except FileNotFoundError:
-    requirements = [line.rstrip('\n') for line in open('requirements.txt')]
-
-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 :: Developers',
-        'Intended Audience :: Information Technology',
-        'License :: OSI Approved :: BSD License',
-        '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,
-    url=source,
-    version=version,
-    zip_safe=True,
-)

tests.py

@@ -1,238 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: UTF-8 -*-
-
-from __future__ import unicode_literals
-import json
-import logging
-import unittest
-from getpass import getpass
-from sys import argv
-from os import path, chdir
-from glob import glob
-from fbchat import Client
-from fbchat.models import *
-import py_compile
-
-logging_level = logging.ERROR
-
-"""
-
-Testing script for `fbchat`.
-Full documentation on https://fbchat.readthedocs.io/
-
-"""
-
-class CustomClient(Client):
-    def __init__(self, *args, **kwargs):
-        self.got_qprimer = False
-        super(type(self), self).__init__(*args, **kwargs)
-
-    def onQprimer(self, msg, **kwargs):
-        self.got_qprimer = True
-
-class TestFbchat(unittest.TestCase):
-    def test_examples(self):
-        # Checks for syntax errors in the examples
-        chdir('examples')
-        for f in glob('*.txt'):
-            print(f)
-            with self.assertRaises(py_compile.PyCompileError):
-                py_compile.compile(f)
-
-        chdir('..')
-
-    def test_loginFunctions(self):
-        self.assertTrue(client.isLoggedIn())
-
-        client.logout()
-
-        self.assertFalse(client.isLoggedIn())
-
-        with self.assertRaises(Exception):
-            client.login('<email>', '<password>', max_tries=1)
-
-        client.login(email, password)
-
-        self.assertTrue(client.isLoggedIn())
-
-    def test_sessions(self):
-        global client
-        session_cookies = client.getSession()
-        client = CustomClient(email, password, session_cookies=session_cookies, logging_level=logging_level)
-
-        self.assertTrue(client.isLoggedIn())
-
-    def test_defaultThread(self):
-        # setDefaultThread
-        client.setDefaultThread(group_id, ThreadType.GROUP)
-        self.assertTrue(client.sendMessage('test_default_recipient★'))
-
-        client.setDefaultThread(user_id, ThreadType.USER)
-        self.assertTrue(client.sendMessage('test_default_recipient★'))
-
-        # resetDefaultThread
-        client.resetDefaultThread()
-        with self.assertRaises(ValueError):
-            client.sendMessage('should_not_send')
-
-    def test_fetchAllUsers(self):
-        users = client.fetchAllUsers()
-        self.assertGreater(len(users), 0)
-
-    def test_searchFor(self):
-        users = client.searchForUsers('Mark Zuckerberg')
-        self.assertGreater(len(users), 0)
-
-        u = users[0]
-
-        # Test if values are set correctly
-        self.assertEqual(u.uid, '4')
-        self.assertEqual(u.type, ThreadType.USER)
-        self.assertEqual(u.photo[:4], 'http')
-        self.assertEqual(u.url[:4], 'http')
-        self.assertEqual(u.name, 'Mark Zuckerberg')
-
-        group_name = client.changeThreadTitle('tést_searchFor', thread_id=group_id, thread_type=ThreadType.GROUP)
-        groups = client.searchForGroups('té')
-        self.assertGreater(len(groups), 0)
-
-    def test_sendEmoji(self):
-        self.assertIsNotNone(client.sendEmoji(size=EmojiSize.SMALL, thread_id=user_id, thread_type=ThreadType.USER))
-        self.assertIsNotNone(client.sendEmoji(size=EmojiSize.MEDIUM, thread_id=user_id, thread_type=ThreadType.USER))
-        self.assertIsNotNone(client.sendEmoji('😆', EmojiSize.LARGE, user_id, ThreadType.USER))
-
-        self.assertIsNotNone(client.sendEmoji(size=EmojiSize.SMALL, thread_id=group_id, thread_type=ThreadType.GROUP))
-        self.assertIsNotNone(client.sendEmoji(size=EmojiSize.MEDIUM, thread_id=group_id, thread_type=ThreadType.GROUP))
-        self.assertIsNotNone(client.sendEmoji('😆', EmojiSize.LARGE, group_id, ThreadType.GROUP))
-
-    def test_sendMessage(self):
-        self.assertIsNotNone(client.sendMessage('test_send_user★', user_id, ThreadType.USER))
-        self.assertIsNotNone(client.sendMessage('test_send_group★', group_id, ThreadType.GROUP))
-        with self.assertRaises(Exception):
-            client.sendMessage('test_send_user_should_fail★', user_id, ThreadType.GROUP)
-        with self.assertRaises(Exception):
-            client.sendMessage('test_send_group_should_fail★', group_id, ThreadType.USER)
-
-    def test_sendImages(self):
-        image_url = 'https://cdn4.iconfinder.com/data/icons/ionicons/512/icon-image-128.png'
-        image_local_url = path.join(path.dirname(__file__), 'tests/image.png')
-        self.assertTrue(client.sendRemoteImage(image_url, 'test_send_user_images_remote★', user_id, ThreadType.USER))
-        self.assertTrue(client.sendRemoteImage(image_url, 'test_send_group_images_remote★', group_id, ThreadType.GROUP))
-        self.assertTrue(client.sendLocalImage(image_local_url, 'test_send_group_images_local★', user_id, ThreadType.USER))
-        self.assertTrue(client.sendLocalImage(image_local_url, 'test_send_group_images_local★', group_id, ThreadType.GROUP))
-
-    def test_fetchThreadList(self):
-        client.fetchThreadList(offset=0, limit=20)
-
-    def test_fetchThreadMessages(self):
-        client.sendMessage('test_user_getThreadInfo★', thread_id=user_id, thread_type=ThreadType.USER)
-
-        messages = client.fetchThreadMessages(thread_id=user_id, limit=1)
-        self.assertEqual(messages[0].author, client.uid)
-        self.assertEqual(messages[0].text, 'test_user_getThreadInfo★')
-
-        client.sendMessage('test_group_getThreadInfo★', thread_id=group_id, thread_type=ThreadType.GROUP)
-
-        messages = client.fetchThreadMessages(thread_id=group_id, limit=1)
-        self.assertEqual(messages[0].author, client.uid)
-        self.assertEqual(messages[0].text, 'test_group_getThreadInfo★')
-
-    def test_listen(self):
-        client.startListening()
-        client.doOneListen()
-        client.stopListening()
-
-        self.assertTrue(client.got_qprimer)
-
-    def test_fetchInfo(self):
-        info = client.fetchUserInfo('4')['4']
-        self.assertEqual(info.name, 'Mark Zuckerberg')
-
-        info = client.fetchGroupInfo(group_id)[group_id]
-        self.assertEqual(info.type, ThreadType.GROUP)
-
-    def test_removeAddFromGroup(self):
-        client.removeUserFromGroup(user_id, thread_id=group_id)
-        client.addUsersToGroup(user_id, thread_id=group_id)
-
-    def test_changeThreadTitle(self):
-        client.changeThreadTitle('test_changeThreadTitle★', thread_id=group_id, thread_type=ThreadType.GROUP)
-        client.changeThreadTitle('test_changeThreadTitle★', thread_id=user_id, thread_type=ThreadType.USER)
-
-    def test_changeNickname(self):
-        client.changeNickname('test_changeNicknameSelf★', client.uid, thread_id=user_id, thread_type=ThreadType.USER)
-        client.changeNickname('test_changeNicknameOther★', user_id, thread_id=user_id, thread_type=ThreadType.USER)
-        client.changeNickname('test_changeNicknameSelf★', client.uid, thread_id=group_id, thread_type=ThreadType.GROUP)
-        client.changeNickname('test_changeNicknameOther★', user_id, thread_id=group_id, thread_type=ThreadType.GROUP)
-
-    def test_changeThreadEmoji(self):
-        client.changeThreadEmoji('😀', group_id)
-        client.changeThreadEmoji('😀', user_id)
-        client.changeThreadEmoji('😆', group_id)
-        client.changeThreadEmoji('😆', user_id)
-
-    def test_changeThreadColor(self):
-        client.changeThreadColor(ThreadColor.BRILLIANT_ROSE, group_id)
-        client.changeThreadColor(ThreadColor.MESSENGER_BLUE, group_id)
-        client.changeThreadColor(ThreadColor.BRILLIANT_ROSE, user_id)
-        client.changeThreadColor(ThreadColor.MESSENGER_BLUE, user_id)
-
-    def test_reactToMessage(self):
-        mid = client.sendMessage('test_reactToMessage★', user_id, ThreadType.USER)
-        client.reactToMessage(mid, MessageReaction.LOVE)
-        mid = client.sendMessage('test_reactToMessage★', group_id, ThreadType.GROUP)
-        client.reactToMessage(mid, MessageReaction.LOVE)
-
-    def test_setTypingStatus(self):
-        client.setTypingStatus(TypingStatus.TYPING, thread_id=user_id, thread_type=ThreadType.USER)
-        client.setTypingStatus(TypingStatus.STOPPED, thread_id=user_id, thread_type=ThreadType.USER)
-        client.setTypingStatus(TypingStatus.TYPING, thread_id=group_id, thread_type=ThreadType.GROUP)
-        client.setTypingStatus(TypingStatus.STOPPED, thread_id=group_id, thread_type=ThreadType.GROUP)
-
-
-def start_test(param_client, param_group_id, param_user_id, tests=[]):
-    global client
-    global group_id
-    global user_id
-
-    client = param_client
-    group_id = param_group_id
-    user_id = param_user_id
-
-    tests = ['test_' + test if 'test_' != test[:5] else test for test in tests]
-
-    if len(tests) == 0:
-        suite = unittest.TestLoader().loadTestsFromTestCase(TestFbchat)
-    else:
-        suite = unittest.TestSuite(map(TestFbchat, tests))
-    print('Starting test(s)')
-    unittest.TextTestRunner(verbosity=2).run(suite)
-
-
-client = None
-
-if __name__ == '__main__':
-    # Python 3 does not use raw_input, whereas Python 2 does
-    try:
-        input = raw_input
-    except Exception as e:
-        pass
-
-    try:
-        with open(path.join(path.dirname(__file__), 'tests/my_data.json'), 'r') as f:
-            json = json.load(f)
-        email = json['email']
-        password = json['password']
-        user_id = json['user_thread_id']
-        group_id = json['group_thread_id']
-    except (IOError, IndexError) as e:
-        email = input('Email: ')
-        password = getpass()
-        group_id = input('Please enter a group thread id (To test group functionality): ')
-        user_id = input('Please enter a user thread id (To test kicking/adding functionality): ')
-
-    print('Logging in...')
-    client = CustomClient(email, password, logging_level=logging_level)
-
-    # Warning! Taking user input directly like this could be dangerous! Use only for testing purposes!
-    start_test(client, group_id, user_id, argv[1:])

tests/conftest.py

@@ -0,0 +1,129 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+import json
+
+from utils import *
+from contextlib import contextmanager
+from fbchat.models import ThreadType, Message, Mention
+
+
+@pytest.fixture(scope="session")
+def user(client2):
+    return {"id": client2.uid, "type": ThreadType.USER}
+
+
+@pytest.fixture(scope="session")
+def group(pytestconfig):
+    return {
+        "id": load_variable("group_id", pytestconfig.cache),
+        "type": ThreadType.GROUP,
+    }
+
+
+@pytest.fixture(
+    scope="session",
+    params=["user", "group", pytest.param("none", marks=[pytest.mark.xfail()])],
+)
+def thread(request, user, group):
+    return {
+        "user": user,
+        "group": group,
+        "none": {"id": "0", "type": ThreadType.GROUP},
+    }[request.param]
+
+
+@pytest.fixture(scope="session")
+def client1(pytestconfig):
+    with load_client(1, pytestconfig.cache) as c:
+        yield c
+
+
+@pytest.fixture(scope="session")
+def client2(pytestconfig):
+    with load_client(2, pytestconfig.cache) as c:
+        yield c
+
+
+@pytest.fixture(scope="module")
+def client(client1, thread):
+    client1.setDefaultThread(thread["id"], thread["type"])
+    yield client1
+    client1.resetDefaultThread()
+
+
+@pytest.fixture(scope="session", params=["client1", "client2"])
+def client_all(request, client1, client2):
+    return client1 if request.param == "client1" else client2
+
+
+@pytest.fixture(scope="session")
+def catch_event(client2):
+    t = ClientThread(client2)
+    t.start()
+
+    @contextmanager
+    def inner(method_name):
+        caught = CaughtValue()
+        old_method = getattr(client2, method_name)
+
+        # Will be called by the other thread
+        def catch_value(*args, **kwargs):
+            old_method(*args, **kwargs)
+            # Make sure the `set` is only called once
+            if not caught.is_set():
+                caught.set(kwargs)
+
+        setattr(client2, method_name, catch_value)
+        yield caught
+        caught.wait()
+        if not caught.is_set():
+            raise ValueError("The value could not be caught")
+        setattr(client2, method_name, old_method)
+
+    yield inner
+
+    t.should_stop.set()
+
+    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(random_hex(), client2.uid)
+    finally:
+        t.join()
+
+
+@pytest.fixture(scope="module")
+def compare(client, thread):
+    def inner(caught_event, **kwargs):
+        d = {
+            "author_id": client.uid,
+            "thread_id": client.uid
+            if thread["type"] == ThreadType.USER
+            else thread["id"],
+            "thread_type": thread["type"],
+        }
+        d.update(kwargs)
+        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_base.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+import py_compile
+
+from glob import glob
+from os import path, environ
+from fbchat import Client
+from fbchat.models import FBchatUserError, Message
+
+
+@pytest.mark.offline
+def test_examples():
+    # Compiles the examples, to check for syntax errors
+    for name in glob(path.join(path.dirname(__file__), "../examples", "*.py")):
+        py_compile.compile(name)
+
+
+@pytest.mark.trylast
+@pytest.mark.expensive
+def test_login(client1):
+    assert client1.isLoggedIn()
+    email = client1.email
+    password = client1.password
+
+    client1.logout()
+
+    assert not client1.isLoggedIn()
+
+    with pytest.raises(FBchatUserError):
+        client1.login("<invalid email>", "<invalid password>", max_tries=1)
+
+    client1.login(email, password)
+
+    assert client1.isLoggedIn()
+
+
+@pytest.mark.trylast
+def test_sessions(client1):
+    session = client1.getSession()
+    Client("no email needed", "no password needed", session_cookies=session)
+    client1.setSession(session)
+    assert client1.isLoggedIn()
+
+
+@pytest.mark.tryfirst
+def test_default_thread(client1, thread):
+    client1.setDefaultThread(thread["id"], thread["type"])
+    assert client1.send(Message(text="Sent to the specified thread"))
+
+    client1.resetDefaultThread()
+    with pytest.raises(ValueError):
+        client1.send(Message(text="Should not be sent"))

tests/test_fetch.py

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+from os import path
+from fbchat.models import ThreadType, Message, Mention, EmojiSize, Sticker
+from utils import subset, STICKER_LIST, EMOJI_LIST
+
+
+def test_fetch_all_users(client1):
+    users = client1.fetchAllUsers()
+    assert len(users) > 0
+
+
+def test_fetch_thread_list(client1):
+    threads = client1.fetchThreadList(limit=2)
+    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)
+    message, = client.fetchThreadMessages(limit=1)
+
+    assert subset(
+        vars(message), uid=mid, author=client.uid, text=emoji, emoji_size=emoji_size
+    )
+
+
+@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"])
+
+    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=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]
+
+
+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.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):
+    info = client1.fetchUserInfo("4")["4"]
+    assert info.name == "Mark Zuckerberg"
+
+    info = client1.fetchGroupInfo(group["id"])[group["id"]]
+    assert info.type == ThreadType.GROUP
+
+
+def test_fetch_image_url(client):
+    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

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+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,114 @@
+# -*- 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.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:
+        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,107 @@
+# -*- 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.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:
+        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_search.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+from fbchat.models import ThreadType
+
+
+def test_search_for(client1):
+    users = client1.searchForUsers("Mark Zuckerberg")
+    assert len(users) > 0
+
+    u = users[0]
+
+    assert u.uid == "4"
+    assert u.type == ThreadType.USER
+    assert u.photo[:4] == "http"
+    assert u.url[:4] == "http"
+    assert u.name == "Mark Zuckerberg"

tests/test_send.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+from os import path
+from fbchat.models import FBchatFacebookError, Message, Mention
+from utils import subset, STICKER_LIST, EMOJI_LIST, TEXT_LIST
+
+
+@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)
+
+    assert compare(x, mid=mid, message=text)
+    assert subset(vars(x.res["message_object"]), uid=mid, author=client.uid, text=text)
+
+
+@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)
+
+    assert compare(x, mid=mid, message=emoji)
+    assert subset(
+        vars(x.res["message_object"]),
+        uid=mid,
+        author=client.uid,
+        text=emoji,
+        emoji_size=emoji_size,
+    )
+
+
+def test_send_mentions(client, catch_event, compare, message_with_mentions):
+    with catch_event("onMessage") as x:
+        mid = client.send(message_with_mentions)
+
+    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 [vars(x) for x in message_with_mentions.mentions]
+
+
+@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))
+
+    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.uid)
+
+
+# Kept for backwards compatibility
+@pytest.mark.parametrize(
+    "method_name, url",
+    [
+        (
+            "sendRemoteImage",
+            "https://github.com/carpedm20/fbchat/raw/master/tests/image.png",
+        ),
+        ("sendLocalImage", path.join(path.dirname(__file__), "resources", "image.png")),
+    ],
+)
+def test_send_images(client, catch_event, compare, method_name, url):
+    text = "An image sent with {}".format(method_name)
+    with catch_event("onMessage") as x:
+        mid = getattr(client, method_name)(url, Message(text))
+
+    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_tests.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+
+def test_catch_event(client2, catch_event):
+    mid = "test"
+    with catch_event("onMessage") as x:
+        client2.onMessage(mid=mid)
+    assert x.res["mid"] == mid

tests/test_thread_interraction.py

@@ -0,0 +1,164 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import unicode_literals
+
+import pytest
+
+from fbchat.models import (
+    Message,
+    ThreadType,
+    FBchatFacebookError,
+    TypingStatus,
+    ThreadColor,
+)
+from utils import random_hex, subset
+from os import path
+
+
+def test_remove_from_and_add_to_group(client1, client2, group, catch_event):
+    # Test both methods, while ensuring that the user gets added to the group
+    try:
+        with catch_event("onPersonRemoved") as x:
+            client1.removeUserFromGroup(client2.uid, group["id"])
+        assert subset(
+            x.res, removed_id=client2.uid, author_id=client1.uid, thread_id=group["id"]
+        )
+    finally:
+        with catch_event("onPeopleAdded") as x:
+            client1.addUsersToGroup(client2.uid, group["id"])
+        assert subset(
+            x.res, added_ids=[client2.uid], author_id=client1.uid, thread_id=group["id"]
+        )
+
+
+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"]
+        )
+    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:
+        client1.changeThreadTitle(title, group["id"], thread_type=ThreadType.GROUP)
+    assert subset(
+        x.res,
+        author_id=client1.uid,
+        new_title=title,
+        thread_id=group["id"],
+        thread_type=ThreadType.GROUP,
+    )
+
+
+def test_change_nickname(client, client_all, catch_event, compare):
+    nickname = random_hex()
+    with catch_event("onNicknameChange") as x:
+        client.changeNickname(nickname, client_all.uid)
+    assert compare(x, changed_for=client_all.uid, new_nickname=nickname)
+
+
+@pytest.mark.parametrize(
+    "emoji",
+    [
+        "😀",
+        "😂",
+        "😕",
+        "😍",
+        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:
+        client.changeThreadEmoji(emoji)
+    assert compare(x, new_emoji=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(
+    "color",
+    [
+        x
+        if x in [ThreadColor.MESSENGER_BLUE, ThreadColor.PUMPKIN]
+        else pytest.param(x, marks=[pytest.mark.expensive()])
+        for x in ThreadColor
+    ],
+)
+def test_change_color(client, catch_event, compare, color):
+    with catch_event("onColorChange") as x:
+        client.changeThreadColor(color)
+    assert compare(x, new_color=color)
+
+
+@pytest.mark.xfail(raises=FBchatFacebookError, reason="Should fail, but doesn't")
+def test_change_color_invalid(client):
+    class InvalidColor:
+        value = "#0077ff"
+
+    client.changeThreadColor(InvalidColor())
+
+
+@pytest.mark.parametrize("status", TypingStatus)
+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

@@ -0,0 +1,114 @@
+# -*- coding: utf-8 -*-
+
+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, 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.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.param(Sticker("0"), marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+    pytest.param(Sticker(None), marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+]
+
+TEXT_LIST = [
+    "test_send",
+    "😆",
+    "\\\n\t%?&'\"",
+    "ˁҭʚ¹Ʋջوװ՞ޱɣࠚԹБɑȑңКએ֭ʗыԈٌʼőԈ×௴nચϚࠖణٔє܅Ԇޑط",
+    "a" * 20000,  # Maximum amount of characters you can send
+    pytest.param("a" * 20001, marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+    pytest.param(None, marks=[pytest.mark.xfail(raises=FBchatFacebookError)]),
+]
+
+
+class ClientThread(threading.Thread):
+    def __init__(self, client, *args, **kwargs):
+        self.client = client
+        self.should_stop = threading.Event()
+        super(ClientThread, self).__init__(*args, **kwargs)
+
+    def start(self):
+        self.client.startListening()
+        self.client.doOneListen()  # QPrimer, Facebook now knows we're about to start pulling
+        super(ClientThread, self).start()
+
+    def run(self):
+        while not self.should_stop.is_set() and self.client.doOneListen():
+            pass
+
+        self.client.stopListening()
+
+
+if six.PY2:
+    event_class = threading._Event
+else:
+    event_class = threading.Event
+
+
+class CaughtValue(event_class):
+    def set(self, res):
+        self.res = res
+        super(CaughtValue, self).set()
+
+    def wait(self, timeout=3):
+        super(CaughtValue, self).wait(timeout=timeout)
+
+
+def random_hex(length=20):
+    return "{:X}".format(randrange(16 ** length))
+
+
+def subset(a, **b):
+    print(a)
+    print(b)
+    return viewitems(b) <= viewitems(a)
+
+
+def load_variable(name, cache):
+    var = environ.get(name, None)
+    if var is not None:
+        if cache.get(name, None) != var:
+            cache.set(name, var)
+        return var
+
+    var = cache.get(name, None)
+    if var is None:
+        raise ValueError("Variable {!r} neither in environment nor cache".format(name))
+    return var
+
+
+@contextmanager
+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())