No Description
Michał Góral c8204f90f9 Release 0.2.1 1 year ago
docs/changelogs Release 0.2.1 1 year ago
reqs Initial commit 1 year ago
src/awh Fixed and improved validator. 1 year ago
tests Fixed and improved validator. 1 year ago
.coveragerc Initial commit 1 year ago
.flake8 Initial commit 1 year ago
.gitignore Added .gitignore. 1 year ago
.pylintrc Fixed and improved validator. 1 year ago
LICENSE Change license to MIT. 1 year ago
MANIFEST.in Initial commit 1 year ago
README.adoc Updated README. 1 year ago
requirements.txt Move requirements to setup.py 1 year ago
setup.py Move requirements to setup.py 1 year ago
tox.ini Fixed and improved validator. 1 year ago

README.adoc

= AnyWebHook

AnyWebhook (*awh*) is Python/WSGI webhook listener and handler. It simplifies
writing and acting upon incoming webhooks.

Awh splits webhook handling into _validating_ and _executing_. You must register
both validator and executor to handle webhooks. These are simple functions which
accept a request parameter containing incoming request data. Additionaly they
receive a dictionary which is filled with arbitrary data by response manipulator
(a function decorated with `@app.app` decorator). Many validators and executors
(for many different webhooks) can be registered. Any validator returning `True`
marks webhook as correct.

You can also affect application's response by registering a separate function
accepting incoming request and to-be-modified response parameter.

Simple application would look like this:

[[example-app]]
[source,python]
----
import json
import subprocess

from awh import Awh
from awh.operate import require, jsonpath

app = Awh()

@app.validator('foo')
def valid(request, data_dict):
payload = request.get_data(as_text=True)
j = json.loads(payload)

# validate incoming json somehow
require(jsonpath(j, 'password')[0].value == 'secretpass')
require(data_dict.get('foo') == 'bar')
return True


@app.executor('foo')
def execute(request, data_dict):
subprocess.call('deploy-app')


@app.app
def myapp(request, response, data_dict):
response.status_code = 404
data_dict['foo'] == 'bar'
----

For additional examples, see link:tests/apps[tests/apps].

== Deployment

In <<example-app>>, `app` is a WSGI application, which implements its interface
(i.e. a function accepting `environ` and `start_response` parameters). You
should point it to your WSGI server.