🎉 Initial commit.

Author: Shivelight

.gitignore

@@ -0,0 +1,123 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don’t work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Shivelight
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

MANIFEST.in

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

README.rst

@@ -0,0 +1,140 @@
+🤖 line-bot-sdk-python-extra
+============================
+
+.. image:: https://img.shields.io/pypi/v/line-bot-sdk-extra.svg
+   :target: https://pypi.python.org/pypi/line-bot-sdk-extra
+   :alt: PyPI - Version
+
+.. image:: https://img.shields.io/pypi/status/line-bot-sdk-extra.svg
+   :target: https://pypi.python.org/pypi/line-bot-sdk-extra
+   :alt: PyPI - Status
+
+.. image:: https://img.shields.io/pypi/pyversions/line-bot-sdk-extra.svg
+   :target: https://pypi.python.org/pypi/line-bot-sdk-extra
+   :alt: PyPI - Python Version
+
+.. image:: https://img.shields.io/pypi/l/line-bot-sdk-extra.svg
+   :target: https://pypi.python.org/pypi/line-bot-sdk-extra
+   :alt: PyPI - License
+
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+   :target: https://github.com/ambv/black
+   :alt: Code Style - Black
+
+.. image:: https://img.shields.io/badge/Ko--fi-donate-blue.svg
+   :target: https://ko-fi.com/shivelight
+   :alt: Ko-fi - Donate
+
+Extra feature for `LINE Messaging API SDK for Python <line-bot-sdk-python_>`_.
+
+
+Installation
+------------
+
+::
+
+   pip install line-bot-sdk-extra
+
+or::
+
+   python setup.py install
+
+To use the package::
+
+>>> import linebotx
+
+
+Features
+--------
+
+Asynchronous API
+^^^^^^^^^^^^^^^^
+
+Allows you to write non-blocking code which makes your bot respond much faster with little changes.
+
+Synchronous:
+
+.. code-block:: python
+
+   from linebot import LineBotApi, WebhookHandler
+   line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
+   handler = WebhookHandler('YOUR_CHANNEL_SECRET')
+
+
+Asynchronous:
+
+.. code-block:: python
+
+   from linebotx import LineBotApiAsync, WebhookHandlerAsync
+   line_bot_api = LineBotApiAsync('YOUR_CHANNEL_ACCESS_TOKEN')
+   handler = WebhookHandlerAsync('YOUR_CHANNEL_SECRET')
+
+
+Equivalent Counterpart
+""""""""""""""""""""""
+
++---------------------+----------------+
+| linebotx            | linebot        |
++=====================+================+
+| LineBotApiAsync     | LineBotApi     |
++---------------------+----------------+
+| AioHttpClient       | HttpClient     |
++---------------------+----------------+
+| AioHttpResponse     | HttpResponse   |
++---------------------+----------------+
+| WebhookHandlerAsync | WebhookHandler |
++---------------------+----------------+
+
+**NOTE:** Every public method is coroutine and should be awaited. For example:
+
+.. code-block:: python
+
+    @app.route("/callback", methods=['POST'])
+    async def callback():
+       ...
+       await handler.handle(body, signature)
+       ...
+
+
+    @handler.add(MessageEvent, message=TextMessage)
+    async def handle_message(event):
+        await line_bot_api.reply_message(
+           event.reply_token,
+           TextSendMessage(text=event.message.text))
+
+
+Additional Methods
+""""""""""""""""""
+
+coroutine :code:`LineBotApiAsync.close()`
+   Close underlying http client.
+
+coroutine :code:`AioHttpClient.close()`
+   See `aiohttp.ClientSession.close() <https://aiohttp.readthedocs.io/en/stable/client_reference.html#aiohttp.ClientSession.close>`_.
+
+
+Timeout
+"""""""
+
+To set a timeout you can pass `aiohttp.ClientTimeout <https://aiohttp.readthedocs.io/en/stable/client_reference.html#aiohttp.ClientTimeout>`_ object instead of numeric value.
+
+
+Examples
+""""""""
+
+- `sanic-echo <https://github.com/Shivelight/line-bot-sdk-python-extra/tree/master/examples/sanic-echo>`_ - Sample echo-bot using sanic_.
+
+
+Contributing
+------------
+
+If you would like to contribute, please check for open issues or open a new issue if you have ideas, changes, or bugs to report.
+
+
+References
+----------
+
+This project is just a small addition to the original SDK, please refer to `line-bot-sdk-python <line-bot-sdk-python_>`_ or the `docs <https://line-bot-sdk-python.readthedocs.io/en/latest/>`_.
+
+.. _sanic: https://github.com/huge-success/sanic
+.. _line-bot-sdk-python: https://github.com/line/line-bot-sdk-python

examples/sanic-echo/README.rst

@@ -0,0 +1,21 @@
+Sanic Echo
+==========
+
+Sample echo-bot using `Sanic <https://github.com/huge-success/sanic>`_
+
+Getting started
+~~~~~~~~~~~~~~~
+
+::
+
+	$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET
+	$ export LINE_CHANNEL_ACCESS_TOKEN=YOUR_LINE_CHANNEL_ACCESS_TOKEN
+	$ pip install -r requirements.txt
+
+Run WebhookParser sample::
+
+	$ python app.py
+
+Run WebhookHandler sample::
+
+	$ python app_with_handler.py

examples/sanic-echo/app.py

@@ -0,0 +1,76 @@
+import os
+import sys
+from argparse import ArgumentParser
+
+from sanic import Sanic, response
+from sanic.log import logger
+from sanic.exceptions import abort
+from linebot import WebhookParser
+from linebot.exceptions import InvalidSignatureError
+from linebot.models import MessageEvent, TextMessage, TextSendMessage
+
+from linebotx import AioHttpClient, LineBotApiAsync
+
+app = Sanic(__name__)
+
+# get channel_secret and channel_access_token from your environment variable
+channel_secret = os.getenv("LINE_CHANNEL_SECRET", None)
+channel_access_token = os.getenv("LINE_CHANNEL_ACCESS_TOKEN", None)
+if channel_secret is None:
+    print("Specify LINE_CHANNEL_SECRET as environment variable.")
+    sys.exit(1)
+if channel_access_token is None:
+    print("Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.")
+    sys.exit(1)
+
+parser = WebhookParser(channel_secret)
+
+
+@app.listener("before_server_start")
+async def setup_bot(app, loop):
+    transport = AioHttpClient(loop=loop)
+    app.bot = LineBotApiAsync(channel_access_token, http_client=transport)
+
+
+@app.listener('after_server_stop')
+async def close_bot(app, loop):
+    await app.bot.close()
+
+
+@app.route("/callback", methods=["POST"])
+async def callback(request):
+    signature = request.headers["X-Line-Signature"]
+
+    # get request body as text
+    body = request.body.decode()
+    logger.info("Request body: " + body)
+
+    # parse webhook body
+    try:
+        events = parser.parse(body, signature)
+    except InvalidSignatureError:
+        abort(400)
+
+    # if event is MessageEvent and message is TextMessage, then echo text
+    for event in events:
+        if not isinstance(event, MessageEvent):
+            continue
+        if not isinstance(event.message, TextMessage):
+            continue
+
+        await app.bot.reply_message(
+            event.reply_token, TextSendMessage(text=event.message.text)
+        )
+
+    return response.text("OK")
+
+
+if __name__ == "__main__":
+    arg_parser = ArgumentParser(
+        usage="Usage: python " + __file__ + " [--port <port>] [--help]"
+    )
+    arg_parser.add_argument("-p", "--port", type=int, default=8000, help="port")
+    arg_parser.add_argument("-d", "--debug", default=False, help="debug")
+    options = arg_parser.parse_args()
+
+    app.run(debug=options.debug, port=options.port)