143 lines
4.4 KiB
Python
143 lines
4.4 KiB
Python
import requests
|
|
|
|
from platypush.message.response import Response
|
|
|
|
from platypush.plugins import Plugin
|
|
|
|
class HttpRequestPlugin(Plugin):
|
|
"""
|
|
Plugin for executing custom HTTP requests.
|
|
|
|
Requires:
|
|
|
|
* **requests** (``pip install requests``)
|
|
|
|
Some example usages::
|
|
|
|
# Execute a GET request on a JSON endpoint
|
|
{
|
|
"type": "request",
|
|
"action": "http.request.get",
|
|
"args": {
|
|
"url": "http://remote-host/api/v1/entity",
|
|
"params": {
|
|
"start": "2000-01-01"
|
|
}
|
|
}
|
|
}
|
|
|
|
# Execute an action on another Platypush host through HTTP interface
|
|
{
|
|
"type": "request",
|
|
"action": "http.request.post",
|
|
"args": {
|
|
"url": "http://remote-host:8008/execute",
|
|
"json": {
|
|
"type": "request",
|
|
"target": "remote-host",
|
|
"action": "music.mpd.play"
|
|
}
|
|
}
|
|
}
|
|
"""
|
|
|
|
def _exec(self, method, url, output='text', **kwargs):
|
|
""" Available output types: text (default), json, binary """
|
|
|
|
method = getattr(requests, method)
|
|
response = method(url, **kwargs)
|
|
response.raise_for_status()
|
|
output = response.text
|
|
|
|
if output == 'json': output = response.json()
|
|
if output == 'binary': output = response.content
|
|
return Response(output=output, errors=[])
|
|
|
|
|
|
def get(self, url, **kwargs):
|
|
"""
|
|
Perform a GET request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='get', url=url, **kwargs)
|
|
|
|
|
|
def post(self, url, **kwargs):
|
|
"""
|
|
Perform a POST request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='post', url=url, **kwargs)
|
|
|
|
|
|
def head(self, url, **kwargs):
|
|
"""
|
|
Perform an HTTP HEAD request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='head', url=url, **kwargs)
|
|
|
|
|
|
def put(self, url, **kwargs):
|
|
"""
|
|
Perform a PUT request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='put', url=url, **kwargs)
|
|
|
|
|
|
def delete(self, url, **kwargs):
|
|
"""
|
|
Perform a DELETE request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='delete', url=url, **kwargs)
|
|
|
|
|
|
def options(self, url, **kwargs):
|
|
"""
|
|
Perform an HTTP OPTIONS request
|
|
|
|
:param url: Target URL
|
|
:type url: str
|
|
|
|
:param kwargs: Additional arguments that will be transparently provided to the ``requests`` object, including but not limited to query params, data, JSON, headers etc. (see http://docs.python-requests.org/en/master/user/quickstart/#make-a-request)
|
|
:type kwargs: dict
|
|
"""
|
|
|
|
return self._exec(method='options', url=url, **kwargs)
|
|
|
|
|
|
# vim:sw=4:ts=4:et:
|
|
|